kevy-embedded 7.0.0

Embedded mode for kevy — in-process Redis-compatible KV without the server/runtime.
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
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
use crate::KevyMetric;
use crate::config::{AppendFsync, EvictionPolicy};
use crate::store::*;
use std::path::PathBuf;
use std::time::Duration;

pub(crate) fn tmp_dir(name: &str) -> PathBuf {
    kevy_tmpdir::unique_dir(&format!("embedded-{name}"))
}

#[test]
fn in_memory_roundtrip() {
    let s = Store::open(Config::default().with_ttl_reaper_manual()).unwrap();
    s.set(b"k", b"v").unwrap();
    assert_eq!(s.get(b"k").unwrap(), Some(b"v".to_vec()));
    assert_eq!(s.dbsize(), 1);
    s.del(&[b"k"]).unwrap();
    assert_eq!(s.dbsize(), 0);
}

#[test]
fn persistence_round_trip_via_aof() {
    let dir = tmp_dir("aof-rt");
    {
        let s = Store::open(
            Config::default()
                .with_persist(&dir)
                .with_ttl_reaper_manual()
                .with_appendfsync(AppendFsync::Always),
        )
        .unwrap();
        for i in 0..50 {
            s.set(format!("k{i}").as_bytes(), b"v").unwrap();
        }
        s.incr_by(b"counter", 41).unwrap();
        s.hset(b"h", &[(b"field" as &[u8], b"val" as &[u8])]).unwrap();
    }
    // Reopen: AOF replay should reconstruct exactly the same state.
    let s2 = Store::open(Config::default().with_persist(&dir).with_ttl_reaper_manual()).unwrap();
    assert_eq!(s2.dbsize(), 52); // 50 + counter + h
    assert_eq!(s2.get(b"k0").unwrap(), Some(b"v".to_vec()));
    assert_eq!(s2.get(b"k49").unwrap(), Some(b"v".to_vec()));
    assert_eq!(s2.get(b"counter").unwrap(), Some(b"41".to_vec()));
    assert_eq!(s2.hget(b"h", b"field").unwrap(), Some(b"val".to_vec()));
    drop(s2);
    let _ = std::fs::remove_dir_all(&dir);
}

#[test]
fn eviction_works_under_pressure() {
    // the keyspace tables fifty keys fill, charged whole: the values are
    // held to 800 bytes above them
    let sized = Store::open(Config::default().with_ttl_reaper_manual()).unwrap();
    for i in 0..50 {
        sized.set(format!("k{i:02}").as_bytes(), b"x").unwrap();
    }
    let limit = sized.used_memory() + 800;
    let s = Store::open(
        Config::default()
            .with_ttl_reaper_manual()
            .with_max_memory(limit)
            .with_eviction(EvictionPolicy::AllKeysLru),
    )
    .unwrap();
    for i in 0..50 {
        s.set(format!("k{i:02}").as_bytes(), &[b'x'; 40]).unwrap();
    }
    assert!(s.used_memory() <= limit, "got {}", s.used_memory());
    assert!(s.evictions_total() > 0);
}

#[test]
fn manual_tick_runs_active_reaper() {
    let s = Store::open(Config::default().with_ttl_reaper_manual()).unwrap();
    s.set_with_ttl(b"short", b"v", Duration::from_millis(1)).unwrap();
    s.set(b"perm", b"v").unwrap();
    std::thread::sleep(Duration::from_millis(20));
    // Read path is non-mutating now: an expired key reads as None but is NOT
    // reclaimed by the get itself — the active reaper does that.
    assert_eq!(s.get(b"short").unwrap(), None);
    assert!(s.get(b"perm").unwrap().is_some());
    // tick() runs the active reaper; sampling is probabilistic, so tick until
    // it has reclaimed the expired key (bounded — one key is caught quickly).
    for _ in 0..50 {
        if s.expired_keys_total() >= 1 {
            break;
        }
        s.tick();
    }
    assert!(s.expired_keys_total() >= 1, "active reaper should reclaim the expired key");
    assert!(s.get(b"perm").unwrap().is_some());
}

#[test]
fn with_escape_hatch_works() {
    let s = Store::open(Config::default().with_ttl_reaper_manual()).unwrap();
    let zsize = s.with(|store| {
        let _ = store.zadd(b"z", &[(1.0, b"a".as_slice()), (2.0, b"b".as_slice())]);
        store.zcard(b"z").unwrap()
    });
    assert_eq!(zsize, 2);
    // Direct (un-logged) write through `with`: caller may explicitly
    // log if they want it crash-safe. Here we just verify it landed.
    assert_eq!(s.type_of(b"z"), "zset");
}

#[test]
fn background_reaper_thread_drops_expired_keys() {
    let s = Store::open(Config::default().with_reaper_interval(Duration::from_millis(20))).unwrap();
    s.set_with_ttl(b"k", b"v", Duration::from_millis(5)).unwrap();
    // The active reaper (20ms interval) reclaims the expired key on its own —
    // reads no longer reap. Poll for it (bounded) rather than racing a fixed
    // sleep against the reaper thread's scheduling on a loaded CI box.
    for _ in 0..200 {
        if s.dbsize() == 0 {
            break;
        }
        std::thread::sleep(Duration::from_millis(5));
    }
    assert_eq!(s.get(b"k").unwrap(), None); // expired → gone
    assert_eq!(s.dbsize(), 0);
}

#[test]
fn arc_sharing_across_threads() {
    use std::sync::Arc;
    let s = Arc::new(Store::open(Config::default().with_ttl_reaper_manual()).unwrap());
    let mut handles = Vec::new();
    for i in 0..8 {
        let s = Arc::clone(&s);
        handles.push(std::thread::spawn(move || {
            for j in 0..50 {
                s.set(format!("t{i}-{j}").as_bytes(), b"v").unwrap();
            }
        }));
    }
    for h in handles {
        h.join().unwrap();
    }
    assert_eq!(s.dbsize(), 8 * 50);
}

#[test]
fn drop_during_reaper_does_not_deadlock() {
    // Sanity: a Store with a Background reaper must drop cleanly even
    // while the reaper is sleeping. Without the stop-flag + join the
    // drop would either hang or race the reaper holding the mutex.
    for _ in 0..4 {
        let s =
            Store::open(Config::default().with_reaper_interval(Duration::from_millis(5))).unwrap();
        s.set(b"k", b"v").unwrap();
        // Let the reaper actually run a couple of times.
        std::thread::sleep(Duration::from_millis(40));
        drop(s); // must return within a few ms
    }
}

#[test]
fn save_snapshot_then_restart() {
    let dir = tmp_dir("snap-rt");
    {
        let s = Store::open(
            Config::default().with_persist(&dir).without_aof().with_ttl_reaper_manual(),
        )
        .unwrap();
        for i in 0..10 {
            s.set(format!("k{i}").as_bytes(), b"v").unwrap();
        }
        let saved = s.save_snapshot().unwrap();
        assert!(saved);
    }
    let s2 =
        Store::open(Config::default().with_persist(&dir).without_aof().with_ttl_reaper_manual())
            .unwrap();
    assert_eq!(s2.dbsize(), 10);
    let _ = std::fs::remove_dir_all(&dir);
}

#[test]
fn info_and_introspection() {
    let s = Store::open(Config::default().with_ttl_reaper_manual()).unwrap();
    s.set(b"a", b"1").unwrap();
    s.set_with_ttl(b"b", b"2", Duration::from_secs(100)).unwrap();

    let info = s.info();
    assert_eq!(info.keys, 2);
    assert_eq!(info.expire_pending, 1);
    assert_eq!(info.aof_bytes, 0); // pure in-memory
    assert_eq!(s.expire_pending_count(), 1);

    assert!(s.ttl(b"b").unwrap() > Duration::from_secs(90));
    assert_eq!(s.ttl(b"a"), None); // key exists, no TTL
    assert_eq!(s.ttl(b"missing"), None); // no key
}

#[test]
fn metric_sink_receives_rewrite_and_replay() {
    use std::sync::{Arc, Mutex};
    let dir = tmp_dir("metric-sink");
    let seen: Arc<Mutex<Vec<&'static str>>> = Arc::new(Mutex::new(Vec::new()));

    // Run 1: redundant writes + a manual rewrite → a Rewrite event fires.
    {
        let s_seen = seen.clone();
        let s = Store::open(
            Config::default()
                .with_persist(&dir)
                .with_ttl_reaper_manual()
                .with_appendfsync(AppendFsync::Always)
                .with_metric_sink(move |m| {
                    let tag = match m {
                        KevyMetric::Rewrite { .. } => "rewrite",
                        KevyMetric::Replay { .. } => "replay",
                    };
                    s_seen.lock().unwrap().push(tag);
                }),
        )
        .unwrap();
        for i in 0..50 {
            s.set(b"k", format!("v{i}").as_bytes()).unwrap();
        }
        assert!(s.rewrite_aof().unwrap().is_some());
    }
    assert!(
        seen.lock().unwrap().contains(&"rewrite"),
        "manual rewrite_aof should emit a Rewrite metric"
    );

    // Run 2: reopen → AOF replay → a Replay event fires.
    seen.lock().unwrap().clear();
    let r_seen = seen.clone();
    let _s2 = Store::open(
        Config::default().with_persist(&dir).with_ttl_reaper_manual().with_metric_sink(move |m| {
            if matches!(m, KevyMetric::Replay { .. }) {
                r_seen.lock().unwrap().push("replay");
            }
        }),
    )
    .unwrap();
    assert!(seen.lock().unwrap().contains(&"replay"), "reopening should emit a Replay metric");
    let _ = std::fs::remove_dir_all(&dir);
}

#[test]
fn auto_aof_rewrite_compacts_redundant_writes() {
    let dir = tmp_dir("auto-rw");
    let s = Store::open(
        Config::default()
            .with_persist(&dir)
            .with_ttl_reaper_manual()
            .with_appendfsync(AppendFsync::Always)
            // Aggressive thresholds so a couple hundred SETs trip it.
            .with_auto_aof_rewrite(1, 1),
    )
    .unwrap();
    // Same key overwritten many times → the AOF holds 300 redundant SETs.
    for i in 0..300 {
        s.set(b"hot", format!("v{i}").as_bytes()).unwrap();
    }
    let before = s.info().aof_bytes;
    s.tick(); // manual mode: tick drives the auto-rewrite check
    let after = s.info().aof_bytes;

    assert!(
        after < before,
        "auto-rewrite should compact redundant SETs: before={before} after={after}"
    );
    // Latest value preserved, and it survives a real restart.
    assert_eq!(s.get(b"hot").unwrap(), Some(b"v299".to_vec()));
    drop(s);
    let s2 = Store::open(Config::default().with_persist(&dir).with_ttl_reaper_manual()).unwrap();
    assert_eq!(s2.get(b"hot").unwrap(), Some(b"v299".to_vec()));
    assert_eq!(s2.dbsize(), 1);
    let _ = std::fs::remove_dir_all(&dir);
}

/// `save_snapshot` must reset the AOF to post-collect writes (the
/// documented snapshot+log durability contract). Before the fix the AOF
/// kept its full history, so a restart replayed pre-snapshot commands ON
/// TOP of the snapshot — non-idempotent ops (RPUSH) duplicated.
#[test]
fn save_snapshot_resets_aof_no_double_replay() {
    let dir = tmp_dir("save-aof-reset");
    {
        let s = Store::open(Config::default().with_persist(&dir).with_ttl_reaper_manual()).unwrap();
        s.rpush(b"l", &[b"a", b"b"]).unwrap();
        assert!(s.save_snapshot().unwrap());
        // Post-snapshot write: must survive via the (reset) AOF.
        s.rpush(b"l", &[b"c"]).unwrap();
    }
    let s2 = Store::open(Config::default().with_persist(&dir).with_ttl_reaper_manual()).unwrap();
    assert_eq!(
        s2.llen(b"l").unwrap(),
        3,
        "snapshot + replayed AOF must not double-apply pre-snapshot RPUSHes"
    );
    let _ = std::fs::remove_dir_all(&dir);
}

/// `save_snapshot` then `rewrite_aof`: the rewritten log is a complete
/// image, so a reopen must not load the snapshot under it. Before the fix
/// every write from before the rewrite was applied twice.
#[test]
fn a_rewrite_after_a_snapshot_reopens_each_write_once() {
    let dir = tmp_dir("save-then-rewrite");
    let config = || Config::default().with_persist(&dir).with_ttl_reaper_manual().with_shards(2);
    let keys: Vec<Vec<u8>> = (0..8).map(|i| format!("k{i}").into_bytes()).collect();
    let write = |s: &Store, tag: &str| {
        for k in &keys {
            s.rpush(k, &[tag.as_bytes()]).unwrap();
            s.append(&[b"s:", k.as_slice()].concat(), tag.as_bytes()).unwrap();
            s.hincrby(&[b"h:", k.as_slice()].concat(), b"f", 5).unwrap();
        }
    };
    // per key: the list, the appended string, the incremented field
    type Read = (Vec<Vec<u8>>, Option<Vec<u8>>, Option<Vec<u8>>);
    let read = |s: &Store| -> Vec<Read> {
        keys.iter()
            .map(|k| {
                let list = s.lrange(k, 0, -1).unwrap();
                let text = s.get(&[b"s:", k.as_slice()].concat()).unwrap();
                let count = s.hget(&[b"h:", k.as_slice()].concat(), b"f").unwrap();
                (list, text, count)
            })
            .collect()
    };
    let before = {
        let s = Store::open(config()).unwrap();
        write(&s, "a");
        assert!(s.save_snapshot().unwrap());
        write(&s, "b");
        assert!(s.rewrite_aof().unwrap().is_some());
        write(&s, "c");
        read(&s)
    };
    assert_eq!(before[0].0, [b"a".to_vec(), b"b".to_vec(), b"c".to_vec()]);
    let s2 = Store::open(config()).unwrap();
    assert_eq!(read(&s2), before);
    let _ = std::fs::remove_dir_all(&dir);
}

/// A snapshot that does not load fails the open, naming the file, rather
/// than opening a store that holds part of it.
#[test]
fn a_snapshot_that_does_not_load_fails_the_open() {
    // without an AOF the loader finds the cut; with one, the log names a
    // snapshot the cut file no longer carries the id of
    for (aof, says) in [(false, "dump-0.rdb does not load"), (true, "carries no snapshot id")] {
        let dir = tmp_dir("snapshot-truncated");
        let config = || {
            let c = Config::default().with_persist(&dir).with_ttl_reaper_manual();
            if aof { c } else { c.without_aof() }
        };
        {
            let s = Store::open(config()).unwrap();
            for i in 0..200 {
                s.rpush(format!("l{i}").as_bytes(), &[b"a", b"b"]).unwrap();
            }
            assert!(s.save_snapshot().unwrap());
        }
        let dump = dir.join("dump-0.rdb");
        let bytes = std::fs::read(&dump).unwrap();
        std::fs::write(&dump, &bytes[..bytes.len() / 2]).unwrap();
        let Err(err) = Store::open(config()) else { panic!("the open succeeded") };
        let err = err.to_string();
        assert!(err.contains(says), "{err}");
        let _ = std::fs::remove_dir_all(&dir);
    }
}

// open_report(): the machine-readable twin of the boot WARN line. A clean
// open reports zero drops; an open over a damaged AOF reports the dropped
// bytes, the corrupt flag, and the quarantine file the repair wrote — the
// signal a host turns into a startup health check (the 3-day silent-loss
// incident was this exact signal living only in stderr).
#[test]
fn open_report_surfaces_drops_corruption_and_quarantine() {
    let dir = tmp_dir("open-report");
    {
        let s = Store::open(
            Config::default()
                .with_persist(&dir)
                .with_ttl_reaper_manual()
                .with_appendfsync(AppendFsync::Always),
        )
        .unwrap();
        for i in 0..20 {
            s.set(format!("k{i}").as_bytes(), b"v").unwrap();
        }
        let clean = s.open_report();
        assert_eq!(clean.dropped_bytes, 0);
        assert!(!clean.corrupt);
        assert!(clean.quarantine_paths.is_empty());
    }
    // Damage the AOF at a record boundary: a v2 record whose length is
    // plausible but whose checksum lies (the bit-rot shape), followed by
    // more bytes that the stop drops — the v2 walk classifies it corrupt
    // and the open must quarantine everything from there.
    let aof = dir.join("aof-0.aof");
    {
        use std::io::Write;
        let mut f = std::fs::OpenOptions::new().append(true).open(&aof).unwrap();
        f.write_all(&4u32.to_le_bytes()).unwrap(); // len 4
        f.write_all(&0u32.to_le_bytes()).unwrap(); // wrong crc
        f.write_all(b"abcd").unwrap();
        f.write_all(b"trailing-good-bytes-lost-with-the-bad-record").unwrap();
    }
    let s = Store::open(Config::default().with_persist(&dir).with_ttl_reaper_manual()).unwrap();
    let r = s.open_report();
    assert!(r.dropped_bytes > 0, "damage must be reported: {r:?}");
    assert!(r.corrupt, "parser-failing damage must set corrupt: {r:?}");
    assert_eq!(r.quarantine_paths.len(), 1, "repair must quarantine: {r:?}");
    assert!(r.quarantine_paths[0].exists());
    let _ = std::fs::remove_dir_all(&dir);
}

// shutdown(): the two-line signal-handler contract. After it returns, every
// pre-shutdown write is on disk (a real fsync, not the EverySec window) and
// every later write is refused with Closed — while reads stay available and
// any clone's shutdown gates all clones.
#[test]
fn shutdown_fsyncs_refuses_writes_and_survives_reopen() {
    let dir = tmp_dir("shutdown");
    {
        let s = Store::open(Config::default().with_persist(&dir).with_ttl_reaper_manual()).unwrap();
        let clone = s.clone();
        for i in 0..50 {
            s.set(format!("k{i}").as_bytes(), b"v").unwrap();
        }
        s.shutdown().unwrap();
        // Writes refused — on the clone too (the flag is shared).
        assert!(matches!(s.set(b"late", b"x"), Err(crate::KevyError::Closed)));
        assert!(matches!(clone.set(b"late", b"x"), Err(crate::KevyError::Closed)));
        assert!(matches!(s.incr_by(b"n", 1), Err(crate::KevyError::Closed)));
        // Reads stay available.
        assert_eq!(s.get(b"k0").unwrap(), Some(b"v".to_vec()));
        // Idempotent.
        s.shutdown().unwrap();
    }
    // Everything written before shutdown survived the (clean) teardown.
    let s = Store::open(Config::default().with_persist(&dir).with_ttl_reaper_manual()).unwrap();
    assert_eq!(s.get(b"k49").unwrap(), Some(b"v".to_vec()));
    assert_eq!(s.get(b"late").unwrap(), None, "refused write must not exist");
    let _ = std::fs::remove_dir_all(&dir);
}

/// A live persist dir refuses a second engine (this process or another
/// — flock catches both); the claim releases with the last clone, so
/// the sequential reopen every other test does keeps working.
#[test]
fn second_open_of_a_live_dir_is_refused() {
    let dir = tmp_dir("second-open-refused");
    let s = Store::open(Config::default().with_persist(&dir).with_ttl_reaper_manual()).unwrap();
    s.set(b"k", b"v").unwrap();
    let err = match Store::open(Config::default().with_persist(&dir).with_ttl_reaper_manual()) {
        Ok(_) => panic!("a second engine on a live dir must refuse, not co-write the AOF"),
        Err(e) => e,
    };
    assert!(err.to_string().contains("already open"), "unexpected error: {err}");
    drop(s);
    let s2 = Store::open(Config::default().with_persist(&dir).with_ttl_reaper_manual()).unwrap();
    assert_eq!(s2.get(b"k").unwrap(), Some(b"v".to_vec()));
    drop(s2);
    let _ = std::fs::remove_dir_all(&dir);
}