1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
|
import functools
from typing import List, Union, Tuple, Callable, Optional, Any
import fakeredis._msgs as msgs
from fakeredis._command_args_parsing import extract_args
from fakeredis._commands import Key, command, CommandItem, Int
from fakeredis._helpers import SimpleError, casematch, OK, current_time, Database, SimpleString
from fakeredis.model import XStream, StreamRangeTest, StreamGroup, StreamEntryKey
class StreamsCommandsMixin:
_blocking: Callable[[Optional[Union[float, int]], Callable[[bool], Any]], Any]
def __init__(self, *args: Any, **kwargs: Any) -> None:
super(StreamsCommandsMixin, self).__init__(*args, **kwargs)
self._db: Database
self.version: Tuple[int]
@command(name="XADD", fixed=(Key(),), repeat=(bytes,))
def xadd(self, key: CommandItem, *args: bytes) -> Optional[bytes]:
(nomkstream, limit, maxlen, minid), left_args = extract_args(
args,
("nomkstream", "+limit", "~+maxlen", "~minid"),
error_on_unexpected=False,
)
if nomkstream and key.value is None:
return None
entry_key = left_args[0]
elements = left_args[1:]
if not elements or len(elements) % 2 != 0:
raise SimpleError(msgs.WRONG_ARGS_MSG6.format("XADD"))
stream = key.value if key.value is not None else XStream()
if self.version < (7,) and entry_key != b"*" and not StreamRangeTest.valid_key(entry_key):
raise SimpleError(msgs.XADD_INVALID_ID)
res: Optional[bytes] = stream.add(elements, entry_key=entry_key)
if res is None:
if not StreamRangeTest.valid_key(left_args[0]):
raise SimpleError(msgs.XADD_INVALID_ID)
raise SimpleError(msgs.XADD_ID_LOWER_THAN_LAST)
if maxlen is not None or minid is not None:
stream.trim(max_length=maxlen, start_entry_key=minid, limit=limit)
key.update(stream)
return res
@command(name="XTRIM", fixed=(Key(XStream),), repeat=(bytes,), flags=msgs.FLAG_LEAVE_EMPTY_VAL)
def xtrim(self, key: CommandItem, *args: bytes) -> int:
(limit, maxlen, minid), _ = extract_args(args, ("+limit", "~+maxlen", "~minid"))
if maxlen is not None and minid is not None:
raise SimpleError(msgs.SYNTAX_ERROR_MSG)
if maxlen is None and minid is None:
raise SimpleError(msgs.SYNTAX_ERROR_MSG)
stream = key.value or XStream()
res = stream.trim(max_length=maxlen, start_entry_key=minid, limit=limit)
key.update(stream)
return res
@command(name="XLEN", fixed=(Key(XStream),))
def xlen(self, key: CommandItem) -> int:
return len(key.value)
@command(name="XRANGE", fixed=(Key(XStream), StreamRangeTest, StreamRangeTest), repeat=(bytes,))
def xrange(self, key: CommandItem, _min: StreamRangeTest, _max: StreamRangeTest, *args: bytes) -> List[bytes]:
(count,), _ = extract_args(args, ("+count",))
return self._xrange(key.value, _min, _max, False, count)
@command(name="XREVRANGE", fixed=(Key(XStream), StreamRangeTest, StreamRangeTest), repeat=(bytes,))
def xrevrange(self, key: CommandItem, _min: StreamRangeTest, _max: StreamRangeTest, *args: bytes) -> List[bytes]:
(count,), _ = extract_args(args, ("+count",))
return self._xrange(key.value, _max, _min, True, count)
@command(name="XREAD", fixed=(bytes,), repeat=(bytes,))
def xread(self, *args: bytes) -> Optional[List[List[Union[bytes, List[Tuple[bytes, List[bytes]]]]]]]:
(
(
count,
timeout,
),
left_args,
) = extract_args(
args,
(
"+count",
"+block",
),
error_on_unexpected=False,
)
if len(left_args) < 3 or not casematch(left_args[0], b"STREAMS") or len(left_args) % 2 != 1:
raise SimpleError(msgs.SYNTAX_ERROR_MSG)
left_args = left_args[1:]
num_streams = int(len(left_args) / 2)
stream_start_id_list: List[Tuple[bytes, StreamRangeTest]] = list() # (name, start_id)
for i in range(num_streams):
item = CommandItem(left_args[i], self._db, item=self._db.get(left_args[i]), default=None)
start_id = self._parse_start_id(item, left_args[i + num_streams])
stream_start_id_list.append((left_args[i], start_id))
if timeout is None:
return self._xread(stream_start_id_list, count, blocking=False, first_pass=False)
else:
return self._blocking( # type: ignore
timeout / 1000.0,
functools.partial(self._xread, stream_start_id_list, count, True),
)
@command(name="XREADGROUP", fixed=(bytes, bytes, bytes), repeat=(bytes,))
def xreadgroup(
self, group_const: bytes, group_name: bytes, consumer_name: bytes, *args: bytes
) -> Optional[List[List[Union[bytes, List[Tuple[bytes, List[bytes]]]]]]]:
if not casematch(b"GROUP", group_const):
raise SimpleError(msgs.SYNTAX_ERROR_MSG)
(count, timeout, noack), left_args = extract_args(
args, ("+count", "+block", "noack"), error_on_unexpected=False
)
if len(left_args) < 3 or not casematch(left_args[0], b"STREAMS") or len(left_args) % 2 != 1:
raise SimpleError(msgs.SYNTAX_ERROR_MSG)
left_args = left_args[1:]
num_streams = int(len(left_args) / 2)
# List of (group, stream_name, stream start-id)
group_params: List[Tuple[StreamGroup, bytes, bytes]] = list()
for i in range(num_streams):
item = CommandItem(left_args[i], self._db, item=self._db.get(left_args[i]), default=None)
if item.value is None:
raise SimpleError(msgs.XGROUP_KEY_NOT_FOUND_MSG)
group: StreamGroup = item.value.group_get(group_name)
if not group:
raise SimpleError(
msgs.XREADGROUP_KEY_OR_GROUP_NOT_FOUND_MSG.format(left_args[i].decode(), group_name.decode())
)
group_params.append(
(
group,
left_args[i],
left_args[i + num_streams],
)
)
if timeout is None:
return self._xreadgroup(consumer_name, group_params, count, noack, False)
else:
return self._blocking( # type: ignore
timeout / 1000.0,
functools.partial(self._xreadgroup, consumer_name, group_params, count, noack),
)
@command(name="XDEL", fixed=(Key(XStream),), repeat=(bytes,))
def xdel(self, key: CommandItem, *args: bytes) -> int:
if len(args) == 0:
raise SimpleError(msgs.WRONG_ARGS_MSG6.format("xdel"))
res: int = key.value.delete(args)
return res
@command(
name="XACK",
fixed=(Key(XStream), bytes),
repeat=(bytes,),
)
def xack(self, key: CommandItem, group_name: bytes, *args: bytes) -> int:
if len(args) == 0:
raise SimpleError(msgs.WRONG_ARGS_MSG6.format("xack"))
if key.value is None:
return 0
group: StreamGroup = key.value.group_get(group_name)
if not group:
return 0
return group.ack(args) # type: ignore
@command(name="XPENDING", fixed=(Key(XStream), bytes), repeat=(bytes,))
def xpending(self, key: CommandItem, group_name: bytes, *args: bytes) -> Union[int, List[List[bytes]]]:
if key.value is None:
return 0
idle, start, end, count, consumer = None, None, None, None, None
if len(args) > 4 and casematch(b"idle", args[0]): # Idle
idle = Int.decode(args[1])
args = args[2:]
if 0 < len(args) < 3:
raise SimpleError(msgs.SYNTAX_ERROR_MSG)
elif len(args) >= 3:
start, end, count = (
StreamRangeTest.decode(args[0]),
StreamRangeTest.decode(args[1]),
Int.decode(args[2]),
)
if len(args) > 3:
consumer = args[3]
group: StreamGroup = key.value.group_get(group_name)
if not group:
return 0 if start is not None else []
if start is not None:
return group.pending(idle, start, end, count, consumer)
else:
return group.pending_summary()
@command(name="XGROUP CREATE", fixed=(Key(XStream), bytes, bytes), repeat=(bytes,), flags=msgs.FLAG_LEAVE_EMPTY_VAL)
def xgroup_create(self, key: CommandItem, group_name: bytes, start_key: bytes, *args: bytes) -> SimpleString:
(mkstream, entries_read), _ = extract_args(args, ("mkstream", "+entriesread"))
if key.value is None and not mkstream:
raise SimpleError(msgs.XGROUP_KEY_NOT_FOUND_MSG)
if key.value.group_get(group_name) is not None:
raise SimpleError(msgs.XGROUP_BUSYGROUP)
key.value.group_add(group_name, start_key, entries_read)
key.updated()
return OK
@command(name="XGROUP SETID", fixed=(Key(XStream), bytes, bytes), repeat=(bytes,))
def xgroup_setid(self, key: CommandItem, group_name: bytes, start_key: bytes, *args: bytes) -> SimpleString:
(entries_read,), _ = extract_args(args, ("+entriesread",))
if key.value is None:
raise SimpleError(msgs.XGROUP_KEY_NOT_FOUND_MSG)
group = key.value.group_get(group_name)
if not group:
raise SimpleError(msgs.XGROUP_GROUP_NOT_FOUND_MSG.format(group_name.decode(), key))
group.set_id(start_key, entries_read)
return OK
@command(name="XGROUP DESTROY", fixed=(Key(XStream), bytes), repeat=())
def xgroup_destroy(self, key: CommandItem, group_name: bytes) -> int:
if key.value is None:
raise SimpleError(msgs.XGROUP_KEY_NOT_FOUND_MSG)
res: int = key.value.group_delete(group_name)
return res
@command(name="XGROUP CREATECONSUMER", fixed=(Key(XStream), bytes, bytes), repeat=())
def xgroup_createconsumer(self, key: CommandItem, group_name: bytes, consumer_name: bytes) -> int:
if key.value is None:
raise SimpleError(msgs.XGROUP_KEY_NOT_FOUND_MSG)
group: StreamGroup = key.value.group_get(group_name)
if not group:
raise SimpleError(msgs.XGROUP_GROUP_NOT_FOUND_MSG.format(group_name.decode(), key))
return group.add_consumer(consumer_name)
@command(name="XGROUP DELCONSUMER", fixed=(Key(XStream), bytes, bytes), repeat=())
def xgroup_delconsumer(self, key: CommandItem, group_name: bytes, consumer_name: bytes) -> int:
if key.value is None:
raise SimpleError(msgs.XGROUP_KEY_NOT_FOUND_MSG)
group: StreamGroup = key.value.group_get(group_name)
if not group:
raise SimpleError(msgs.XGROUP_GROUP_NOT_FOUND_MSG.format(group_name.decode(), key))
return group.del_consumer(consumer_name)
@command(name="XINFO GROUPS", fixed=(Key(XStream),), repeat=())
def xinfo_groups(self, key: CommandItem) -> List[List[bytes]]:
if key.value is None:
raise SimpleError(msgs.NO_KEY_MSG)
res: List[List[bytes]] = key.value.groups_info()
return res
@command(name="XINFO STREAM", fixed=(Key(XStream),), repeat=(bytes,), flags=msgs.FLAG_DO_NOT_CREATE)
def xinfo_stream(self, key: CommandItem, *args: bytes) -> List[bytes]:
(full,), _ = extract_args(args, ("full",))
if key.value is None:
raise SimpleError(msgs.NO_KEY_MSG)
res: List[bytes] = key.value.stream_info(full)
return res
@command(name="XINFO CONSUMERS", fixed=(Key(XStream), bytes), repeat=())
def xinfo_consumers(self, key: CommandItem, group_name: bytes) -> List[List[Union[bytes, int]]]:
if key.value is None:
raise SimpleError(msgs.XGROUP_KEY_NOT_FOUND_MSG)
group: StreamGroup = key.value.group_get(group_name)
if not group:
raise SimpleError(msgs.XGROUP_GROUP_NOT_FOUND_MSG.format(group_name.decode(), key))
res: List[List[Union[bytes, int]]] = group.consumers_info()
return res
@command(name="XCLAIM", fixed=(Key(XStream), bytes, bytes, Int, bytes), repeat=(bytes,))
def xclaim(
self, key: CommandItem, group_name: bytes, consumer_name: bytes, min_idle_ms: int, *args: bytes
) -> Union[List[bytes], List[List[Union[bytes, List[bytes]]]]]:
stream = key.value
if stream is None:
raise SimpleError(msgs.XGROUP_KEY_NOT_FOUND_MSG)
group: StreamGroup = stream.group_get(group_name)
if not group:
raise SimpleError(msgs.XGROUP_GROUP_NOT_FOUND_MSG.format(group_name.decode(), key))
(idle, _time, retry, force, justid), msg_ids = extract_args(
args,
("+idle", "+time", "+retrycount", "force", "justid"),
error_on_unexpected=False,
left_from_first_unexpected=False,
)
if idle is not None and idle > 0 and _time is None:
_time = current_time() - idle
msgs_claimed, _ = group.claim(min_idle_ms, msg_ids, consumer_name, _time, force)
if justid:
return [msg.encode() for msg in msgs_claimed]
return [stream.format_record(msg) for msg in msgs_claimed]
@command(name="XAUTOCLAIM", fixed=(Key(XStream), bytes, bytes, Int, bytes), repeat=(bytes,))
def xautoclaim(
self, key: CommandItem, group_name: bytes, consumer_name: bytes, min_idle_ms: int, start: bytes, *args: bytes
) -> List[Union[bytes, List[Union[bytes, List[Tuple[bytes, List[bytes]]]]]]]:
(count, justid), _ = extract_args(args, ("+count", "justid"))
count = count or 100
stream = key.value
if stream is None:
raise SimpleError(msgs.XGROUP_KEY_NOT_FOUND_MSG)
group: StreamGroup = stream.group_get(group_name)
if not group:
raise SimpleError(msgs.XGROUP_GROUP_NOT_FOUND_MSG.format(group_name.decode(), key))
keys: List[StreamEntryKey] = group.read_pel_msgs(min_idle_ms, start, count)
msgs_claimed, msgs_removed = group.claim(min_idle_ms, keys, consumer_name, None, False)
res: List[Union[bytes, List[Union[bytes, List[Tuple[bytes, List[bytes]]]]]]] = [
max(msgs_claimed).encode() if len(msgs_claimed) > 0 else start,
[msg.encode() for msg in msgs_claimed] if justid else [stream.format_record(msg) for msg in msgs_claimed],
]
if self.version >= (7,):
res.append([msg.encode() for msg in msgs_removed])
return res
@staticmethod
def _xrange(
stream: XStream,
_min: StreamRangeTest,
_max: StreamRangeTest,
reverse: bool,
count: Union[int, None],
) -> List[bytes]:
if stream is None:
return []
if count is None:
count = len(stream)
res = stream.irange(_min, _max, reverse=reverse)
return res[:count]
def _xreadgroup(
self,
consumer_name: bytes,
group_params: List[Tuple[StreamGroup, bytes, bytes]],
count: int,
noack: bool,
first_pass: bool,
) -> Optional[List[Any]]:
res: List[Any] = list()
for group, stream_name, start_id in group_params:
stream_results = group.group_read(consumer_name, start_id, count, noack)
if first_pass and (count is None):
return None
if len(stream_results) > 0 or start_id != b">":
res.append([stream_name, stream_results])
return res
def _xread(
self, stream_start_id_list: List[Tuple[bytes, StreamRangeTest]], count: int, blocking: bool, first_pass: bool
) -> Optional[List[List[Union[bytes, List[Tuple[bytes, List[bytes]]]]]]]:
max_inf = StreamRangeTest.decode(b"+")
res: List[Any] = list()
for stream_name, start_id in stream_start_id_list:
item = CommandItem(stream_name, self._db, item=self._db.get(stream_name), default=None)
stream_results = self._xrange(item.value, start_id, max_inf, False, count)
if len(stream_results) > 0:
res.append([item.key, stream_results])
# On blocking read, when count is not None, and there are no results, return None (instead of an empty list)
if blocking and count and len(res) == 0:
return None
return res
@staticmethod
def _parse_start_id(key: CommandItem, s: bytes) -> StreamRangeTest:
if s == b"$":
if key.value is None:
return StreamRangeTest.decode(b"0-0")
return StreamRangeTest.decode(key.value.last_item_key(), exclusive=True)
return StreamRangeTest.decode(s, exclusive=True)
|
