cesiumdb 0.2.2

Blazing fast, persistent key-value store for Rust
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
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
// Copyright (c) Sienna Meridian Satterwhite
// SPDX-License-Identifier: GPL-3.0-only WITH Classpath-exception-2.0

//! Unit tests for the public [`Db`] API.

use std::sync::Arc;

use crate::{
    Batch::Put,
    Db,
    DbOptions,
};

const MAX_KEYS: u64 = 10_000;

fn db_builder() -> Arc<Db> {
    Db::open(DbOptions::default()).unwrap()
}

#[test]
fn test_db_put() {
    let db = db_builder();

    // initial insert
    let mut keypair_size = 0;
    for i in 0..MAX_KEYS {
        let key = format!("key-{}", i).into_bytes();
        let val = format!("value-{}", i).into_bytes();
        keypair_size += key.len() + val.len();
        assert!(db.put(key.as_ref(), val.as_ref()).is_ok());
    }

    {
        let guard = db.inner.state.lock();
        assert!(
            guard.current_memtable().size() > keypair_size as u64,
            "the memtable must be bigger than the keypair size to ensure the keys are actually stored"
        );
    }

    // re-insert the same keys but with new versions
    for i in 0..MAX_KEYS {
        let key = format!("key-{}", i).into_bytes();
        let val = format!("value-{}", i).into_bytes();
        keypair_size += key.len() + val.len();
        assert!(db.put(key.as_ref(), val.as_ref()).is_ok());
    }

    {
        let guard = db.inner.state.lock();
        assert!(
            guard.current_memtable().size() > (keypair_size * 2) as u64,
            "the memtable must be at least twice as big as before with the new versions"
        );
    }
}

#[test]
fn db_put_batch() {
    let db = db_builder();

    let mut keypair_size = 0;
    for batch_size in [1, 10, 100].iter() {
        let mut batch = Vec::with_capacity(*batch_size);

        for i in 0..(*batch_size * 100) {
            let key = format!("key-{}", i).into_bytes();
            let val = format!("value-{}", i).into_bytes();
            keypair_size += key.len() + val.len();

            let op = Put(key, val.clone(), db.time());
            batch.push(op)
        }

        assert!(db.batch(&batch).is_ok());

        {
            let guard = db.inner.state.lock();
            assert!(
                guard.current_memtable().size() > keypair_size as u64,
                "the memtable must be bigger than the keypair size to ensure the keys are actually stored"
            );
        }
    }
}

#[test]
fn test_db_get() {
    let db = db_builder();

    // test get on empty db
    let result = db.get(b"nonexistent");
    assert!(result.is_ok());
    assert!(
        result.unwrap().is_none(),
        "get on empty db should return None"
    );

    // insert and retrieve
    let key = b"test-key";
    let val = b"test-value";
    assert!(db.put(key, val).is_ok());

    let result = db.get(key);
    assert!(result.is_ok());
    let retrieved = result.unwrap();
    assert!(
        retrieved.is_some(),
        "get should return Some for existing key"
    );
    assert_eq!(&retrieved.unwrap()[..], val, "retrieved value should match");

    // test get on different key
    let result = db.get(b"different-key");
    assert!(result.is_ok());
    assert!(
        result.unwrap().is_none(),
        "get on non-existent key should return None"
    );
}

#[test]
fn test_db_get_latest_version() {
    let db = db_builder();

    let key = b"versioned-key";
    let val1 = b"value-1";
    let val2 = b"value-2";
    let val3 = b"value-3";

    // insert multiple versions
    assert!(db.put(key, val1).is_ok());
    assert!(db.put(key, val2).is_ok());
    assert!(db.put(key, val3).is_ok());

    // get should return the latest version
    let result = db.get(key);
    assert!(result.is_ok());
    let retrieved = result.unwrap();
    assert!(retrieved.is_some());
    assert_eq!(
        &retrieved.unwrap()[..],
        val3,
        "get should return the latest value"
    );
}

#[test]
fn test_db_delete() {
    let db = db_builder();

    let key = b"key-to-delete";
    let val = b"value";

    // insert key
    assert!(db.put(key, val).is_ok());

    // verify it exists
    let result = db.get(key);
    assert!(result.is_ok());
    assert!(result.unwrap().is_some());

    // delete the key
    assert!(db.delete(key).is_ok());

    // verify the key no longer exists (tombstone filters it out)
    let result = db.get(key);
    assert!(result.is_ok());
    assert!(result.unwrap().is_none(), "deleted key should return None");
}

#[test]
fn test_db_put_ns() {
    let db = db_builder();

    let ns1: u64 = 1;
    let ns2: u64 = 2;
    let key = b"same-key";
    let val1 = b"value-in-ns1";
    let val2 = b"value-in-ns2";

    // put same key in different namespaces
    assert!(db.put_ns(ns1, key, val1).is_ok());
    assert!(db.put_ns(ns2, key, val2).is_ok());

    // retrieve from each namespace
    let result1 = db.get_ns(ns1, key);
    assert!(result1.is_ok());
    let value1 = result1.unwrap();
    assert!(value1.is_some());
    assert_eq!(&value1.unwrap()[..], val1);

    let result2 = db.get_ns(ns2, key);
    assert!(result2.is_ok());
    let value2 = result2.unwrap();
    assert!(value2.is_some());
    assert_eq!(&value2.unwrap()[..], val2);
}

#[test]
fn test_db_get_ns() {
    let db = db_builder();

    let ns: u64 = 42;
    let key = b"namespaced-key";
    let val = b"namespaced-value";

    // get on empty namespace
    let result = db.get_ns(ns, key);
    assert!(result.is_ok());
    assert!(result.unwrap().is_none());

    // insert into namespace
    assert!(db.put_ns(ns, key, val).is_ok());

    // retrieve from namespace
    let result = db.get_ns(ns, key);
    assert!(result.is_ok());
    let retrieved = result.unwrap();
    assert!(retrieved.is_some());
    assert_eq!(&retrieved.unwrap()[..], val);

    // verify key doesn't exist in default namespace
    let result = db.get(key);
    assert!(result.is_ok());
    assert!(
        result.unwrap().is_none(),
        "key should not exist in default namespace"
    );
}

#[test]
fn test_db_delete_ns() {
    let db = db_builder();

    let ns: u64 = 10;
    let key = b"key-to-delete";
    let val = b"value";

    // insert into namespace
    assert!(db.put_ns(ns, key, val).is_ok());

    // verify it exists
    let result = db.get_ns(ns, key);
    assert!(result.is_ok());
    assert!(result.unwrap().is_some());

    // delete from namespace
    assert!(db.delete_ns(ns, key).is_ok());

    // verify the key no longer exists (tombstone filters it out)
    let result = db.get_ns(ns, key);
    assert!(result.is_ok());
    assert!(
        result.unwrap().is_none(),
        "deleted key in namespace should return None"
    );
}

#[test]
fn test_db_options_default() {
    let opts = DbOptions::default();
    let db = Db::open(opts).unwrap();

    // basic operation to ensure default options work
    assert!(db.put(b"test", b"value").is_ok());
    let result = db.get(b"test");
    assert!(result.is_ok());
    assert!(result.unwrap().is_some());
}

#[test]
fn test_db_time() {
    let db = db_builder();

    let time1 = db.time();
    let time2 = db.time();

    // time should be monotonically increasing
    assert!(
        time2 >= time1,
        "clock should return monotonically increasing values"
    );
}

#[test]
fn test_db_batch_mixed_operations() {
    use crate::Batch::PutNs;

    let db = db_builder();

    let ns: u64 = 5;
    let batch = vec![
        Put(b"key1".to_vec(), b"val1".to_vec(), db.time()),
        PutNs(ns, b"key2".to_vec(), b"val2".to_vec(), db.time()),
        Put(b"key3".to_vec(), b"val3".to_vec(), db.time()),
    ];

    assert!(db.batch(&batch).is_ok());

    // verify all operations succeeded
    assert!(db.get(b"key1").unwrap().is_some());
    assert!(db.get_ns(ns, b"key2").unwrap().is_some());
    assert!(db.get(b"key3").unwrap().is_some());
}

#[test]
fn test_db_empty_key() {
    let db = db_builder();

    let key = b"";
    let val = b"empty-key-value";

    assert!(db.put(key, val).is_ok());
    let result = db.get(key);
    assert!(result.is_ok());
    assert!(result.unwrap().is_some());
}

#[test]
fn test_db_empty_value() {
    let db = db_builder();

    let key = b"key-with-empty-value";
    let val = b"";

    assert!(db.put(key, val).is_ok());
    let result = db.get(key);
    assert!(result.is_ok());
    let retrieved = result.unwrap();
    assert!(retrieved.is_some());
    assert_eq!(retrieved.unwrap().len(), 0);
}

#[test]
fn test_db_large_key_value() {
    let db = db_builder();

    let key = vec![b'k'; 1000];
    let val = vec![b'v'; 10000];

    assert!(db.put(&key, &val).is_ok());
    let result = db.get(&key);
    assert!(result.is_ok());
    let retrieved = result.unwrap();
    assert!(retrieved.is_some());
    assert_eq!(retrieved.unwrap().len(), val.len());
}

// ===== Scan API Tests =====

#[test]
fn test_scan_empty_db() {
    use std::ops::Bound;
    let db = db_builder();
    let results: Vec<_> = db
        .scan(Bound::Unbounded, Bound::Unbounded)
        .unwrap()
        .collect();
    assert_eq!(results.len(), 0);
}

#[test]
fn test_scan_single_memtable() {
    use std::ops::Bound;
    let db = db_builder();

    db.put(b"a", b"1").unwrap();
    db.put(b"b", b"2").unwrap();
    db.put(b"c", b"3").unwrap();

    let results: Vec<_> = db
        .scan(Bound::Unbounded, Bound::Unbounded)
        .unwrap()
        .collect();
    assert_eq!(results.len(), 3);
    assert_eq!(&results[0].0[..], b"a");
    assert_eq!(&results[0].1[..], b"1");
    assert_eq!(&results[1].0[..], b"b");
    assert_eq!(&results[1].1[..], b"2");
    assert_eq!(&results[2].0[..], b"c");
    assert_eq!(&results[2].1[..], b"3");
}

#[test]
fn test_scan_with_tombstones() {
    use std::ops::Bound;
    let db = db_builder();

    db.put(b"a", b"1").unwrap();
    db.put(b"b", b"2").unwrap();
    db.put(b"c", b"3").unwrap();
    db.delete(b"b").unwrap();

    let results: Vec<_> = db
        .scan(Bound::Unbounded, Bound::Unbounded)
        .unwrap()
        .collect();
    assert_eq!(results.len(), 2, "Should filter out tombstone for 'b'");
    assert_eq!(&results[0].0[..], b"a");
    assert_eq!(&results[1].0[..], b"c");
}

#[test]
fn test_scan_unbounded() {
    use std::ops::Bound;
    let db = db_builder();

    for i in 0..10 {
        let key = format!("key-{:02}", i);
        let val = format!("val-{:02}", i);
        db.put(key.as_bytes(), val.as_bytes()).unwrap();
    }

    let results: Vec<_> = db
        .scan(Bound::Unbounded, Bound::Unbounded)
        .unwrap()
        .collect();
    assert_eq!(results.len(), 10);
}

#[test]
fn test_scan_bounded() {
    use std::ops::Bound;
    let db = db_builder();

    db.put(b"a", b"1").unwrap();
    db.put(b"b", b"2").unwrap();
    db.put(b"c", b"3").unwrap();
    db.put(b"d", b"4").unwrap();
    db.put(b"e", b"5").unwrap();

    // Scan [b, d) should return b and c
    let results: Vec<_> = db
        .scan(Bound::Included(b"b"), Bound::Excluded(b"d"))
        .unwrap()
        .collect();

    assert_eq!(results.len(), 2);
    assert_eq!(&results[0].0[..], b"b");
    assert_eq!(&results[0].1[..], b"2");
    assert_eq!(&results[1].0[..], b"c");
    assert_eq!(&results[1].1[..], b"3");
}

#[test]
fn test_scan_namespace_isolation() {
    use std::ops::Bound;
    let db = db_builder();

    db.put_ns(1, b"key", b"ns1-value").unwrap();
    db.put_ns(2, b"key", b"ns2-value").unwrap();
    db.put_ns(1, b"key2", b"ns1-value2").unwrap();

    let results_ns1: Vec<_> = db
        .scan_ns(1, Bound::Unbounded, Bound::Unbounded)
        .unwrap()
        .collect();
    let results_ns2: Vec<_> = db
        .scan_ns(2, Bound::Unbounded, Bound::Unbounded)
        .unwrap()
        .collect();

    assert_eq!(results_ns1.len(), 2);
    assert_eq!(results_ns2.len(), 1);
    assert_eq!(&results_ns2[0].1[..], b"ns2-value");
}

#[test]
fn test_scan_across_frozen_memtables() {
    use std::ops::Bound;
    let db = db_builder();

    // Write some data
    db.put(b"a", b"1").unwrap();
    db.put(b"b", b"2").unwrap();

    // Force sync to freeze memtable
    db.sync().unwrap();

    // Write more data to new memtable
    db.put(b"c", b"3").unwrap();
    db.put(b"d", b"4").unwrap();

    let results: Vec<_> = db
        .scan(Bound::Unbounded, Bound::Unbounded)
        .unwrap()
        .collect();
    assert_eq!(
        results.len(),
        4,
        "Should scan across both frozen and current memtable"
    );
    assert_eq!(&results[0].0[..], b"a");
    assert_eq!(&results[1].0[..], b"b");
    assert_eq!(&results[2].0[..], b"c");
    assert_eq!(&results[3].0[..], b"d");
}

#[test]
fn test_scan_mvcc_ordering() {
    // Simplified test to check iteration order
    use std::ops::Bound;
    let db = db_builder();

    // Write in explicit order to track timestamps
    std::thread::sleep(std::time::Duration::from_millis(1));
    db.put(b"key1", b"FIRST").unwrap();

    std::thread::sleep(std::time::Duration::from_millis(1));
    db.put(b"key1", b"SECOND").unwrap();

    std::thread::sleep(std::time::Duration::from_millis(1));
    db.put(b"key1", b"THIRD_NEWEST").unwrap();

    // Scan should return only the newest version
    let results: Vec<_> = db
        .scan(Bound::Unbounded, Bound::Unbounded)
        .unwrap()
        .collect();
    assert_eq!(results.len(), 1, "Should have 1 unique key");
    assert_eq!(
        &results[0].1[..],
        b"THIRD_NEWEST",
        "Should return the newest version"
    );
}

#[test]
fn test_scan_with_mvcc() {
    use std::ops::Bound;
    let db = db_builder();

    // Write initial values
    db.put(b"key1", b"v1").unwrap();
    db.put(b"key2", b"v2").unwrap();

    // Update values (creates new versions)
    db.put(b"key1", b"v1-updated").unwrap();

    let results: Vec<_> = db
        .scan(Bound::Unbounded, Bound::Unbounded)
        .unwrap()
        .collect();
    assert_eq!(results.len(), 2);

    // Should see newest version
    assert_eq!(&results[0].0[..], b"key1");
    assert_eq!(&results[0].1[..], b"v1-updated");
    assert_eq!(&results[1].0[..], b"key2");
    assert_eq!(&results[1].1[..], b"v2");
}