aeternusdb 1.0.1

An embeddable, persistent key-value store built on an LSM-tree architecture.
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
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
//! Memtable edge-case and boundary-condition tests.
//!
//! These tests cover behaviors not exercised by the basic / frozen / scan
//! test suites — specifically LSN injection, empty and reversed range
//! deletes, write-buffer overflow during a write, and concurrent access.
//!
//! Coverage:
//! - `inject_max_lsn()` sets the LSN counter so subsequent writes
//!   continue from the injected value
//! - Reversed range-delete (`start > end`) — returns `MemtableError::InvalidArgument`
//! - Empty-key range-delete — returns `MemtableError::InvalidArgument`
//! - Concurrent put / get from multiple threads
//!
//! ## See also
//! - [`tests_basic`]  — core memtable API tests
//! - [`tests_frozen`] — FrozenMemtable correctness
//! - [`tests_scan`]   — raw multi-version scan output

#[cfg(test)]
mod tests {
    use crate::memtable::{Memtable, MemtableError, MemtableGetResult};
    use std::sync::Arc;
    use std::thread;
    use tempfile::TempDir;

    // ----------------------------------------------------------------
    // inject_max_lsn sets the LSN counter
    // ----------------------------------------------------------------

    /// # Scenario
    /// After calling `inject_max_lsn(100)`, the next write must receive
    /// LSN 101 (i.e. the counter is set to `lsn + 1`).
    ///
    /// # Starting environment
    /// Fresh memtable with default LSN counter (starts at 1).
    ///
    /// # Actions
    /// 1. `inject_max_lsn(100)`.
    /// 2. Verify `max_lsn() == Some(100)`.
    /// 3. Put one key.
    /// 4. Check `max_lsn()` advanced to `Some(101)`.
    ///
    /// # Expected behavior
    /// `max_lsn()` reflects the injected value before any write and
    /// increments normally after a write.
    #[test]
    fn inject_max_lsn_sets_counter() {
        let tmp = TempDir::new().unwrap();
        let path = tmp.path().join("000000.log");
        let memtable = Memtable::new(&path, None, 1024 * 1024).unwrap();

        // Default counter starts at None (no writes yet)
        assert_eq!(memtable.max_lsn(), None);

        // Inject recovered LSN
        memtable.inject_max_lsn(100);
        assert_eq!(memtable.max_lsn(), Some(100));

        // Next write gets LSN 101
        memtable.put(b"key1".to_vec(), b"val1".to_vec()).unwrap();
        assert_eq!(memtable.max_lsn(), Some(101));
    }

    // ----------------------------------------------------------------
    // Empty-key range-delete rejected
    // ----------------------------------------------------------------

    /// # Scenario
    /// A range-delete with an empty start or end key is invalid and
    /// must be rejected.
    ///
    /// # Starting environment
    /// Fresh memtable.
    ///
    /// # Actions
    /// 1. `delete_range(b"", b"z")` — empty start key.
    /// 2. `delete_range(b"a", b"")` — empty end key.
    ///
    /// # Expected behavior
    /// Both calls return `MemtableError::InvalidArgument`.
    #[test]
    fn empty_key_range_delete_rejected() {
        let tmp = TempDir::new().unwrap();
        let path = tmp.path().join("000000.log");
        let memtable = Memtable::new(&path, None, 1024 * 1024).unwrap();

        // Empty start key
        let err = memtable
            .delete_range(b"".to_vec(), b"z".to_vec())
            .unwrap_err();
        assert!(
            matches!(err, MemtableError::InvalidArgument(_)),
            "Expected InvalidArgument error for empty start key, got: {:?}",
            err
        );

        // Empty end key
        let err = memtable
            .delete_range(b"a".to_vec(), b"".to_vec())
            .unwrap_err();
        assert!(
            matches!(err, MemtableError::InvalidArgument(_)),
            "Expected InvalidArgument error for empty end key, got: {:?}",
            err
        );
    }

    // ----------------------------------------------------------------
    // Reversed range-delete (start > end)
    // ----------------------------------------------------------------

    /// # Scenario
    /// A range-delete where `start > end` (e.g. `"z".."a"`) is rejected
    /// with `InvalidArgument` — the caller supplied an invalid range.
    ///
    /// # Starting environment
    /// Memtable with 5 keys (`key0`–`key4`).
    ///
    /// # Actions
    /// 1. `delete_range(b"key4", b"key0")` — reversed bounds.
    /// 2. Query all 5 keys.
    ///
    /// # Expected behavior
    /// The delete_range call returns `InvalidArgument`; all 5 keys
    /// remain visible.
    #[test]
    fn reversed_range_delete_is_rejected() {
        let tmp = TempDir::new().unwrap();
        let path = tmp.path().join("000000.log");
        let memtable = Memtable::new(&path, None, 1024 * 1024).unwrap();

        for i in 0..5 {
            let key = format!("key{}", i).into_bytes();
            let value = format!("value{}", i).into_bytes();
            memtable.put(key, value).unwrap();
        }

        // Reversed range — start > end → InvalidArgument
        let err = memtable
            .delete_range(b"key4".to_vec(), b"key0".to_vec())
            .unwrap_err();
        assert!(
            matches!(err, MemtableError::InvalidArgument(_)),
            "Expected InvalidArgument for reversed range, got: {:?}",
            err
        );

        // All keys should still be visible
        for i in 0..5 {
            let key = format!("key{}", i).into_bytes();
            let result = memtable.get(&key).unwrap();
            assert!(
                matches!(result, MemtableGetResult::Put(_)),
                "key{} should still be visible, got {:?}",
                i,
                result
            );
        }
    }

    // ----------------------------------------------------------------
    // Write-buffer overflow mid-put
    // ----------------------------------------------------------------

    /// # Scenario
    /// A put that would push `approximate_size` beyond the configured
    /// `write_buffer_size` must be rejected with `FlushRequired`.
    ///
    /// # Starting environment
    /// Memtable with a tiny 128-byte write buffer.
    ///
    /// # Actions
    /// 1. Keep writing small records until `FlushRequired` is returned.
    ///
    /// # Expected behavior
    /// At least one write succeeds; the write that overflows returns
    /// `MemtableError::FlushRequired`.
    #[test]
    fn write_buffer_overflow_returns_flush_required() {
        let tmp = TempDir::new().unwrap();
        let path = tmp.path().join("000000.log");
        let memtable = Memtable::new(&path, None, 128).unwrap();

        let mut succeeded = 0;
        for i in 0..1000 {
            let key = format!("key_{:04}", i).into_bytes();
            let value = format!("val_{:04}", i).into_bytes();
            match memtable.put(key, value) {
                Ok(()) => succeeded += 1,
                Err(MemtableError::FlushRequired) => break,
                Err(other) => panic!("Unexpected error: {:?}", other),
            }
        }

        assert!(succeeded > 0, "At least one write should succeed");
        assert!(
            succeeded < 1000,
            "Buffer should overflow before 1000 writes"
        );
    }

    // ----------------------------------------------------------------
    // Concurrent put / get safety
    // ----------------------------------------------------------------

    /// # Scenario
    /// Multiple writer and reader threads operate on the same memtable
    /// concurrently. No panics, data races, or poisoned locks should occur.
    ///
    /// # Starting environment
    /// Fresh memtable wrapped in an `Arc`.
    ///
    /// # Actions
    /// 1. Spawn 4 writer threads, each performing 100 puts.
    /// 2. Spawn 2 reader threads, each performing 200 gets on random keys.
    /// 3. Join all threads.
    ///
    /// # Expected behavior
    /// All threads complete without panic. After joining, every key
    /// written is retrievable.
    #[test]
    fn concurrent_put_get_no_data_race() {
        let tmp = TempDir::new().unwrap();
        let path = tmp.path().join("000000.log");
        let memtable = Arc::new(Memtable::new(&path, None, 1024 * 1024).unwrap());

        let num_writers = 4;
        let writes_per_thread = 100;

        // Writer threads
        let writer_handles: Vec<_> = (0..num_writers)
            .map(|t| {
                let mt = Arc::clone(&memtable);
                thread::spawn(move || {
                    for i in 0..writes_per_thread {
                        let key = format!("t{}_k{:04}", t, i).into_bytes();
                        let val = format!("t{}_v{:04}", t, i).into_bytes();
                        mt.put(key, val).unwrap();
                    }
                })
            })
            .collect();

        // Reader threads (read while writes may still be happening)
        let reader_handles: Vec<_> = (0..2)
            .map(|_| {
                let mt = Arc::clone(&memtable);
                thread::spawn(move || {
                    for i in 0..200 {
                        let key = format!("t0_k{:04}", i % writes_per_thread).into_bytes();
                        let _ = mt.get(&key); // may or may not find key yet
                    }
                })
            })
            .collect();

        for h in writer_handles {
            h.join().unwrap();
        }
        for h in reader_handles {
            h.join().unwrap();
        }

        // After all writers finish, every key should be present
        for t in 0..num_writers {
            for i in 0..writes_per_thread {
                let key = format!("t{}_k{:04}", t, i).into_bytes();
                let result = memtable.get(&key).unwrap();
                assert!(
                    matches!(result, MemtableGetResult::Put(_)),
                    "t{}_k{:04} should exist after all writers join",
                    t,
                    i
                );
            }
        }
    }

    // ----------------------------------------------------------------
    // Stats
    // ----------------------------------------------------------------

    /// # Scenario
    /// `stats()` on a fresh, empty memtable returns all zeros.
    ///
    /// # Starting environment
    /// Fresh memtable — no writes.
    ///
    /// # Expected behavior
    /// All counters are zero.
    #[test]
    fn stats_empty_memtable() {
        let tmp = TempDir::new().unwrap();
        let path = tmp.path().join("000000.log");
        let memtable = Memtable::new(&path, None, 1024 * 1024).unwrap();

        let stats = memtable.stats().unwrap();
        assert_eq!(stats.size_bytes, 0);
        assert_eq!(stats.key_count, 0);
        assert_eq!(stats.entry_count, 0);
        assert_eq!(stats.tombstone_count, 0);
        assert_eq!(stats.range_tombstone_count, 0);
    }

    /// # Scenario
    /// After several puts, `stats()` reflects correct key/entry counts
    /// and a non-zero size.
    ///
    /// # Starting environment
    /// Fresh memtable.
    ///
    /// # Actions
    /// 1. Put 5 distinct keys.
    ///
    /// # Expected behavior
    /// - `key_count == 5`, `entry_count == 5`, `tombstone_count == 0`.
    /// - `size_bytes > 0`.
    #[test]
    fn stats_after_puts() {
        let tmp = TempDir::new().unwrap();
        let path = tmp.path().join("000000.log");
        let memtable = Memtable::new(&path, None, 1024 * 1024).unwrap();

        for i in 0..5 {
            let key = format!("key_{:04}", i).into_bytes();
            let val = format!("val_{:04}", i).into_bytes();
            memtable.put(key, val).unwrap();
        }

        let stats = memtable.stats().unwrap();
        assert_eq!(stats.key_count, 5);
        assert_eq!(stats.entry_count, 5);
        assert_eq!(stats.tombstone_count, 0);
        assert_eq!(stats.range_tombstone_count, 0);
        assert!(stats.size_bytes > 0, "size should be non-zero after puts");
    }

    /// # Scenario
    /// Overwriting a key adds a new version; `key_count` stays the same
    /// but `entry_count` increases.
    ///
    /// # Starting environment
    /// Fresh memtable.
    ///
    /// # Actions
    /// 1. Put key "a" twice (two versions).
    ///
    /// # Expected behavior
    /// - `key_count == 1` (one distinct key).
    /// - `entry_count == 2` (two versions).
    #[test]
    fn stats_overwrite_increases_entry_count() {
        let tmp = TempDir::new().unwrap();
        let path = tmp.path().join("000000.log");
        let memtable = Memtable::new(&path, None, 1024 * 1024).unwrap();

        memtable.put(b"a".to_vec(), b"v1".to_vec()).unwrap();
        memtable.put(b"a".to_vec(), b"v2".to_vec()).unwrap();

        let stats = memtable.stats().unwrap();
        assert_eq!(stats.key_count, 1);
        assert_eq!(stats.entry_count, 2);
        assert_eq!(stats.tombstone_count, 0);
    }

    /// # Scenario
    /// Point deletes are counted as tombstones in `stats()`.
    ///
    /// # Starting environment
    /// Fresh memtable.
    ///
    /// # Actions
    /// 1. Put 3 keys.
    /// 2. Delete 2 of them.
    ///
    /// # Expected behavior
    /// - `key_count == 3`, `entry_count == 5` (3 puts + 2 deletes).
    /// - `tombstone_count == 2`.
    #[test]
    fn stats_counts_point_tombstones() {
        let tmp = TempDir::new().unwrap();
        let path = tmp.path().join("000000.log");
        let memtable = Memtable::new(&path, None, 1024 * 1024).unwrap();

        memtable.put(b"a".to_vec(), b"v1".to_vec()).unwrap();
        memtable.put(b"b".to_vec(), b"v2".to_vec()).unwrap();
        memtable.put(b"c".to_vec(), b"v3".to_vec()).unwrap();

        memtable.delete(b"a".to_vec()).unwrap();
        memtable.delete(b"b".to_vec()).unwrap();

        let stats = memtable.stats().unwrap();
        assert_eq!(stats.key_count, 3);
        assert_eq!(stats.entry_count, 5);
        assert_eq!(stats.tombstone_count, 2);
        assert_eq!(stats.range_tombstone_count, 0);
    }

    /// # Scenario
    /// Range tombstones are tracked separately in `stats()`.
    ///
    /// # Starting environment
    /// Fresh memtable.
    ///
    /// # Actions
    /// 1. Put 3 keys.
    /// 2. Delete range `[a, c)`.
    ///
    /// # Expected behavior
    /// - `range_tombstone_count == 1`.
    /// - Point entry counts are unaffected by the range tombstone.
    #[test]
    fn stats_counts_range_tombstones() {
        let tmp = TempDir::new().unwrap();
        let path = tmp.path().join("000000.log");
        let memtable = Memtable::new(&path, None, 1024 * 1024).unwrap();

        memtable.put(b"a".to_vec(), b"v1".to_vec()).unwrap();
        memtable.put(b"b".to_vec(), b"v2".to_vec()).unwrap();
        memtable.put(b"c".to_vec(), b"v3".to_vec()).unwrap();

        memtable.delete_range(b"a".to_vec(), b"c".to_vec()).unwrap();

        let stats = memtable.stats().unwrap();
        assert_eq!(stats.key_count, 3);
        assert_eq!(stats.entry_count, 3);
        assert_eq!(stats.tombstone_count, 0);
        assert_eq!(stats.range_tombstone_count, 1);
        assert!(stats.size_bytes > 0);
    }

    /// # Scenario
    /// Mixed operations: puts, overwrites, point-deletes, and range-deletes
    /// all correctly reflected in stats.
    ///
    /// # Starting environment
    /// Fresh memtable.
    ///
    /// # Actions
    /// 1. Put keys a, b, c, d, e.
    /// 2. Overwrite a.
    /// 3. Delete b and c.
    /// 4. Range-delete [d, f).
    ///
    /// # Expected behavior
    /// - `key_count == 5` (a, b, c, d, e).
    /// - `entry_count == 9` (6 puts + 1 overwrite-put skipped — actually
    ///   2 versions of "a" = 6 total puts, + 2 point deletes = 8).
    /// - Wait — 5 original puts + 1 overwrite of "a" + 2 deletes = 8.
    /// - `tombstone_count == 2` (point deletes only).
    /// - `range_tombstone_count == 1`.
    #[test]
    fn stats_mixed_operations() {
        let tmp = TempDir::new().unwrap();
        let path = tmp.path().join("000000.log");
        let memtable = Memtable::new(&path, None, 1024 * 1024).unwrap();

        // 5 initial puts
        for key in [b"a", b"b", b"c", b"d", b"e"] {
            memtable.put(key.to_vec(), b"val".to_vec()).unwrap();
        }
        // Overwrite "a"
        memtable.put(b"a".to_vec(), b"val2".to_vec()).unwrap();
        // Point-delete b, c
        memtable.delete(b"b".to_vec()).unwrap();
        memtable.delete(b"c".to_vec()).unwrap();
        // Range-delete [d, f)
        memtable.delete_range(b"d".to_vec(), b"f".to_vec()).unwrap();

        let stats = memtable.stats().unwrap();
        // 5 distinct keys
        assert_eq!(stats.key_count, 5);
        // 5 original puts + 1 overwrite + 2 point-deletes = 8
        assert_eq!(stats.entry_count, 8);
        assert_eq!(stats.tombstone_count, 2);
        assert_eq!(stats.range_tombstone_count, 1);
    }

    /// # Scenario
    /// `size_bytes` grows monotonically with each write.
    ///
    /// # Starting environment
    /// Fresh memtable.
    ///
    /// # Actions
    /// 1. Record `size_bytes` after each of 3 puts.
    ///
    /// # Expected behavior
    /// Each successive `size_bytes` is strictly larger than the previous.
    #[test]
    fn stats_size_grows_monotonically() {
        let tmp = TempDir::new().unwrap();
        let path = tmp.path().join("000000.log");
        let memtable = Memtable::new(&path, None, 1024 * 1024).unwrap();

        let mut prev_size = 0;
        for i in 0..3 {
            let key = format!("key_{:04}", i).into_bytes();
            memtable.put(key, b"value".to_vec()).unwrap();

            let size = memtable.stats().unwrap().size_bytes;
            assert!(
                size > prev_size,
                "size_bytes should grow: was {}, now {}",
                prev_size,
                size
            );
            prev_size = size;
        }
    }
}