kevy 6.4.0

kevy — a pure-Rust, zero-dependency, Redis-compatible KV server.
Documentation
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
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
//! Consumer-group dispatch: `XGROUP` / `XREADGROUP` / `XACK` /
//! `XPENDING` / `XCLAIM` / `XAUTOCLAIM` — sprint B of v2-7. Argv-soup
//! parsers translate the legacy Redis shapes into the structured
//! API on `Store` (see `kevy_store::stream::store`); reply emitters
//! match the exact array shapes Redis returns.

use kevy_resp::CmdError;
use kevy_resp::{
    ArgvView, encode_array_len, encode_bulk, encode_error, encode_integer, encode_null_bulk,
    encode_simple_string,
};
use kevy_store::{
    GroupCreateMode, ReadGroupId, Store, StreamId, now_unix_ms, parse_explicit_id, parse_range_end,
    parse_range_start,
};

use crate::cmd::{store_err, wrong_args};

use super::emit_entries;

// ───────────── XGROUP ─────────────

/// `XGROUP CREATE | DESTROY | SETID | CREATECONSUMER | DELCONSUMER`
pub(super) fn cmd_xgroup<A: ArgvView + ?Sized>(store: &mut Store, args: &A, out: &mut Vec<u8>) {
    if args.len() < 2 {
        return wrong_args(out, "xgroup");
    }
    let sub = args[1].to_ascii_uppercase();
    match sub.as_slice() {
        b"CREATE" => xgroup_create(store, args, out),
        b"DESTROY" => xgroup_destroy(store, args, out),
        b"SETID" => xgroup_setid(store, args, out),
        b"CREATECONSUMER" => xgroup_create_consumer(store, args, out),
        b"DELCONSUMER" => xgroup_del_consumer(store, args, out),
        other => encode_error(
            out,
            &format!(
                "ERR Unknown XGROUP subcommand or wrong number of arguments for '{}'",
                String::from_utf8_lossy(other),
            ),
        ),
    }
}

fn xgroup_create<A: ArgvView + ?Sized>(store: &mut Store, args: &A, out: &mut Vec<u8>) {
    // XGROUP CREATE key group <id|$> [MKSTREAM]
    if !(5..=6).contains(&args.len()) {
        return wrong_args(out, "xgroup|create");
    }
    let key = &args[2];
    let group = &args[3];
    let mode = match parse_id_or_dollar(&args[4]) {
        Ok(m) => m,
        Err(msg) => return encode_error(out, msg.as_wire()),
    };
    let mkstream = args.len() == 6 && args[5].eq_ignore_ascii_case(b"MKSTREAM");
    match store.xgroup_create(key, group, mode, mkstream) {
        Ok(true) => encode_simple_string(out, "OK"),
        Ok(false) => encode_error(out, "BUSYGROUP Consumer Group name already exists"),
        Err(kevy_store::StoreError::NoSuchKey) => encode_error(
            out,
            "ERR The XGROUP subcommand requires the key to exist. \
             Note that for CREATE you may want to use the MKSTREAM option to create an empty stream automatically.",
        ),
        Err(e) => store_err(out, e),
    }
}

fn xgroup_destroy<A: ArgvView + ?Sized>(store: &mut Store, args: &A, out: &mut Vec<u8>) {
    if args.len() != 4 {
        return wrong_args(out, "xgroup|destroy");
    }
    match store.xgroup_destroy(&args[2], &args[3]) {
        Ok(true) => encode_integer(out, 1),
        Ok(false) => encode_integer(out, 0),
        Err(e) => store_err(out, e),
    }
}

fn xgroup_setid<A: ArgvView + ?Sized>(store: &mut Store, args: &A, out: &mut Vec<u8>) {
    if args.len() != 5 {
        return wrong_args(out, "xgroup|setid");
    }
    let mode = match parse_id_or_dollar(&args[4]) {
        Ok(m) => m,
        Err(msg) => return encode_error(out, msg.as_wire()),
    };
    match store.xgroup_setid(&args[2], &args[3], mode) {
        Ok(true) => encode_simple_string(out, "OK"),
        Ok(false) => encode_error(out, "NOGROUP No such consumer group"),
        Err(e) => store_err(out, e),
    }
}

fn xgroup_create_consumer<A: ArgvView + ?Sized>(store: &mut Store, args: &A, out: &mut Vec<u8>) {
    if args.len() != 5 {
        return wrong_args(out, "xgroup|createconsumer");
    }
    match store.xgroup_create_consumer(&args[2], &args[3], &args[4], now_unix_ms()) {
        Ok(true) => encode_integer(out, 1),
        Ok(false) => encode_integer(out, 0),
        Err(e) => store_err(out, e),
    }
}

fn xgroup_del_consumer<A: ArgvView + ?Sized>(store: &mut Store, args: &A, out: &mut Vec<u8>) {
    if args.len() != 5 {
        return wrong_args(out, "xgroup|delconsumer");
    }
    match store.xgroup_del_consumer(&args[2], &args[3], &args[4]) {
        Ok(n) => encode_integer(out, n as i64),
        Err(e) => store_err(out, e),
    }
}

fn parse_id_or_dollar(s: &[u8]) -> Result<GroupCreateMode, CmdError> {
    if s == b"$" {
        return Ok(GroupCreateMode::AtCurrent);
    }
    parse_explicit_id(s, /*end=*/ false)
        .map(GroupCreateMode::AtId)
        .map_err(|_| CmdError::Wire("ERR Invalid stream ID specified as stream command argument"))
}

// ───────────── XREADGROUP ─────────────

/// `XREADGROUP GROUP g c [COUNT n] [BLOCK ms] [NOACK] STREAMS key [...] id [...]`
pub(super) fn cmd_xreadgroup<A: ArgvView + ?Sized>(store: &mut Store, args: &A, out: &mut Vec<u8>) {
    let mut parsed = match parse_xreadgroup_argv(args) {
        Ok(p) => p,
        Err(msg) => return encode_error(out, msg.as_wire()),
    };
    let mut reply: Vec<super::StreamReply> = Vec::new();
    // BLOCK only takes effect when at least one stream is reading new
    // entries (`>`); a replay-from-PEL form (`XREADGROUP … STREAMS s 0`)
    // returns immediately even with BLOCK set, matching Redis. So we
    // remember "any `>`-stream" before iterating, then check both flags
    // before parking.
    let any_new_stream = parsed.streams.iter().any(|(_, id)| id == b">");
    let blocking = parsed.block_ms.is_some() && any_new_stream;
    let streams = std::mem::take(&mut parsed.streams);
    for (key, last_seen_arg) in streams {
        let Ok(entries) = xreadgroup_one_stream(store, &parsed, &key, &last_seen_arg, out) else {
            return;
        };
        if !entries.is_empty() {
            reply.push((key, entries));
        }
    }
    if reply.is_empty() && blocking {
        // BLOCK + new-mode + nothing fresh → leave out untouched so the
        // dispatcher registers the conn as a waiter on the first stream
        // key. Next XADD on that key wakes us and re-runs xreadgroup.
        return;
    }
    if reply.is_empty() {
        encode_array_len(out, -1);
        return;
    }
    encode_array_len(out, reply.len() as i64);
    for (key, entries) in &reply {
        encode_array_len(out, 2);
        encode_bulk(out, key);
        emit_entries(out, entries);
    }
}

/// One stream leg of XREADGROUP: parse the last-seen argument, read
/// via `Store::xreadgroup`, and emit the invalid-ID / NOGROUP / store
/// error replies. `Err(())` = an error was already written to `out`.
fn xreadgroup_one_stream(
    store: &mut Store,
    parsed: &XReadGroupParsed,
    key: &[u8],
    last_seen_arg: &[u8],
    out: &mut Vec<u8>,
) -> Result<kevy_store::EntryBatch, ()> {
    let last_seen = if last_seen_arg == b">" {
        ReadGroupId::New
    } else {
        match parse_explicit_id(last_seen_arg, /*end=*/ false) {
            Ok(id) => ReadGroupId::ReplayAfter(id),
            Err(_) => {
                encode_error(out, "ERR Invalid stream ID specified as stream command argument");
                return Err(());
            }
        }
    };
    match store.xreadgroup(
        key,
        &parsed.group,
        &parsed.consumer,
        last_seen,
        parsed.count,
        parsed.noack,
        now_unix_ms(),
    ) {
        Ok(es) => Ok(es),
        Err(kevy_store::StoreError::NoSuchKey) => {
            encode_error(
                out,
                &format!(
                    "NOGROUP No such key '{}' or consumer group '{}' in XREADGROUP with GROUP option",
                    String::from_utf8_lossy(key),
                    String::from_utf8_lossy(&parsed.group),
                ),
            );
            Err(())
        }
        Err(e) => {
            store_err(out, e);
            Err(())
        }
    }
}

struct XReadGroupParsed {
    group: Vec<u8>,
    consumer: Vec<u8>,
    count: Option<usize>,
    /// `Some(ms)` if `BLOCK ms` was present; v2-7d.4 uses this together
    /// with the "at least one stream reads `>`" check to decide whether
    /// to park the conn when every requested stream is empty.
    block_ms: Option<u64>,
    noack: bool,
    streams: Vec<(Vec<u8>, Vec<u8>)>,
}

fn parse_xreadgroup_argv<A: ArgvView + ?Sized>(args: &A) -> Result<XReadGroupParsed, CmdError> {
    if args.len() < 7 {
        return Err(CmdError::Wire("ERR wrong number of arguments for 'xreadgroup' command"));
    }
    if !args[1].eq_ignore_ascii_case(b"GROUP") {
        return Err(CmdError::Wire("ERR syntax error"));
    }
    let group = args[2].to_vec();
    let consumer = args[3].to_vec();
    let mut i = 4;
    let mut count = None;
    let mut block_ms: Option<u64> = None;
    let mut noack = false;
    while i < args.len() {
        let tok = args[i].to_ascii_uppercase();
        match tok.as_slice() {
            b"COUNT" => {
                count =
                    Some(parse_kv_u64(args, i + 1, "ERR value is not an integer or out of range")?
                        as usize);
                i += 2;
            }
            b"BLOCK" => {
                block_ms = Some(parse_kv_u64(
                    args,
                    i + 1,
                    "ERR timeout is not an integer or out of range",
                )?);
                i += 2;
            }
            b"NOACK" => {
                noack = true;
                i += 1;
            }
            b"STREAMS" => {
                let streams = parse_xreadgroup_streams(args, i + 1)?;
                return Ok(XReadGroupParsed { group, consumer, count, block_ms, noack, streams });
            }
            _ => return Err(CmdError::Wire("ERR syntax error")),
        }
    }
    Err(CmdError::Wire("ERR syntax error"))
}

fn parse_kv_u64<A: ArgvView + ?Sized>(
    args: &A,
    idx: usize,
    bad: &'static str,
) -> Result<u64, CmdError> {
    let n = args.get(idx).ok_or("ERR syntax error")?;
    std::str::from_utf8(n).ok().and_then(|s| s.parse().ok()).ok_or(CmdError::Wire(bad))
}

/// `(key, last-seen-arg)` pairs as parsed from the `STREAMS …` tail.
type StreamKeyLastSeen = (Vec<u8>, Vec<u8>);

fn parse_xreadgroup_streams<A: ArgvView + ?Sized>(
    args: &A,
    start: usize,
) -> Result<Vec<StreamKeyLastSeen>, CmdError> {
    let rest = args.len() - start;
    if rest == 0 || !rest.is_multiple_of(2) {
        return Err(CmdError::Wire(
            "ERR Unbalanced XREADGROUP list of streams: for each stream key an ID or '>' must be specified.",
        ));
    }
    let n = rest / 2;
    let mut streams = Vec::with_capacity(n);
    for k in 0..n {
        streams.push((args[start + k].to_vec(), args[start + n + k].to_vec()));
    }
    Ok(streams)
}

// ───────────── XACK ─────────────

pub(super) fn cmd_xack<A: ArgvView + ?Sized>(store: &mut Store, args: &A, out: &mut Vec<u8>) {
    if args.len() < 4 {
        return wrong_args(out, "xack");
    }
    let mut ids = Vec::with_capacity(args.len() - 3);
    for i in 3..args.len() {
        match parse_explicit_id(&args[i], /*end=*/ false) {
            Ok(id) => ids.push(id),
            Err(_) => {
                return encode_error(
                    out,
                    "ERR Invalid stream ID specified as stream command argument",
                );
            }
        }
    }
    match store.xack(&args[1], &args[2], &ids) {
        Ok(n) => encode_integer(out, n as i64),
        Err(e) => store_err(out, e),
    }
}

// ───────────── XPENDING ─────────────

pub(super) fn cmd_xpending<A: ArgvView + ?Sized>(store: &mut Store, args: &A, out: &mut Vec<u8>) {
    // Below three arguments there is neither a summary call nor an extended
    // one, and the extended parse starts by reading args[3] unchecked — so
    // `XPENDING k` panicked the shard thread. Every sibling here (XGROUP,
    // XACK, XCLAIM) already refuses short calls in Redis's words; this one
    // did not, and nothing drove it until the arity sweep did.
    if args.len() < 3 {
        return wrong_args(out, "xpending");
    }
    if args.len() == 3 {
        match store.xpending_summary(&args[1], &args[2]) {
            Ok(Some(s)) => emit_pending_summary(out, &s),
            Ok(None) => encode_error(out, "NOGROUP No such consumer group"),
            Err(e) => store_err(out, e),
        }
        return;
    }
    let parsed = match parse_xpending_extended(args) {
        Ok(p) => p,
        Err(msg) => return encode_error(out, msg.as_wire()),
    };
    match store.xpending_extended(
        &args[1],
        &args[2],
        parsed.idle_min_ms,
        parsed.start,
        parsed.end,
        parsed.count,
        parsed.consumer.as_deref(),
        now_unix_ms(),
    ) {
        Ok(Some(rows)) => emit_pending_extended(out, &rows.rows),
        Ok(None) => encode_error(out, "NOGROUP No such consumer group"),
        Err(e) => store_err(out, e),
    }
}

struct XPendingExtendedArgs {
    idle_min_ms: Option<u64>,
    start: StreamId,
    end: StreamId,
    count: usize,
    consumer: Option<Vec<u8>>,
}

fn parse_xpending_extended<A: ArgvView + ?Sized>(
    args: &A,
) -> Result<XPendingExtendedArgs, CmdError> {
    let mut i = 3;
    let mut idle_min_ms = None;
    if args[i].eq_ignore_ascii_case(b"IDLE") {
        let v = args.get(i + 1).ok_or("ERR syntax error")?;
        idle_min_ms = Some(
            std::str::from_utf8(v)
                .ok()
                .and_then(|s| s.parse().ok())
                .ok_or("ERR value is not an integer or out of range")?,
        );
        i += 2;
    }
    if args.len() < i + 3 {
        return Err(CmdError::Wire("ERR syntax error"));
    }
    let start = parse_range_start(&args[i]).map_err(|_| {
        CmdError::Wire("ERR Invalid stream ID specified as stream command argument")
    })?;
    let end = parse_range_end(&args[i + 1]).map_err(|_| {
        CmdError::Wire("ERR Invalid stream ID specified as stream command argument")
    })?;
    let count: usize = std::str::from_utf8(&args[i + 2])
        .ok()
        .and_then(|s| s.parse().ok())
        .ok_or("ERR value is not an integer or out of range")?;
    i += 3;
    let consumer = if i < args.len() { Some(args[i].to_vec()) } else { None };
    Ok(XPendingExtendedArgs { idle_min_ms, start, end, count, consumer })
}

fn emit_pending_summary(out: &mut Vec<u8>, s: &kevy_store::PendingSummary) {
    encode_array_len(out, 4);
    encode_integer(out, s.total as i64);
    if let Some((lo, hi)) = s.id_range {
        encode_bulk(out, &lo.encode());
        encode_bulk(out, &hi.encode());
    } else {
        encode_null_bulk(out);
        encode_null_bulk(out);
    }
    if s.by_consumer.is_empty() {
        encode_array_len(out, -1);
        return;
    }
    encode_array_len(out, s.by_consumer.len() as i64);
    for (name, n) in &s.by_consumer {
        encode_array_len(out, 2);
        encode_bulk(out, name);
        encode_bulk(out, n.to_string().as_bytes());
    }
}

fn emit_pending_extended(out: &mut Vec<u8>, rows: &[kevy_store::PendingExtendedRow]) {
    encode_array_len(out, rows.len() as i64);
    for r in rows {
        encode_array_len(out, 4);
        encode_bulk(out, &r.id.encode());
        encode_bulk(out, &r.consumer);
        encode_integer(out, r.idle_ms as i64);
        encode_integer(out, i64::from(r.delivery_count));
    }
}