seerdb 0.0.10

Research-grade storage engine with learned data structures
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

//! Differential testing: Compare seerdb behavior against RocksDB
//!
//! Runs identical operations against both databases and verifies results match.
//! Catches semantic bugs that single-implementation tests miss.
//!
//! Run with: `cargo test --features baseline-benchmarks differential`

#![cfg(feature = "baseline-benchmarks")]

use rand::rngs::StdRng;
use rand::{Rng, SeedableRng};
use rocksdb::{Options, DB as RocksDB};
use seerdb::{DBOptions, DB as SeerDB};
use std::collections::BTreeMap;
use tempfile::TempDir;

/// Operation types for differential testing
#[derive(Debug, Clone)]
enum Op {
    Put { key: Vec<u8>, value: Vec<u8> },
    Get { key: Vec<u8> },
    Delete { key: Vec<u8> },
}

/// Generate random operations with a given seed for reproducibility
fn generate_ops(seed: u64, count: usize, key_space: usize) -> Vec<Op> {
    let mut rng = StdRng::seed_from_u64(seed);
    let mut ops = Vec::with_capacity(count);

    for _ in 0..count {
        let key_num = rng.gen_range(0..key_space);
        let key = format!("key_{:08}", key_num).into_bytes();

        let op_type: u8 = rng.gen_range(0..10);
        let op = match op_type {
            0..=5 => {
                // 60% puts
                let value_len = rng.gen_range(10..200);
                let value: Vec<u8> = (0..value_len).map(|_| rng.gen()).collect();
                Op::Put { key, value }
            }
            6..=8 => {
                // 30% gets
                Op::Get { key }
            }
            _ => {
                // 10% deletes
                Op::Delete { key }
            }
        };
        ops.push(op);
    }

    ops
}

/// Run operations against seerdb, return final state
fn run_seerdb(ops: &[Op], temp_dir: &TempDir) -> BTreeMap<Vec<u8>, Option<Vec<u8>>> {
    let db = DBOptions::default()
        .background_compaction(false)
        .background_flush(false)
        .open(temp_dir.path())
        .expect("Failed to open seerdb");

    let mut results = BTreeMap::new();

    for op in ops {
        match op {
            Op::Put { key, value } => {
                db.put(key, value).expect("seerdb put failed");
            }
            Op::Get { key } => {
                let result = db.get(key).expect("seerdb get failed");
                results.insert(key.clone(), result.map(|b| b.to_vec()));
            }
            Op::Delete { key } => {
                db.delete(key).expect("seerdb delete failed");
            }
        }
    }

    // Flush to ensure data is persisted
    db.flush().expect("seerdb flush failed");

    results
}

/// Run operations against RocksDB, return final state
fn run_rocksdb(ops: &[Op], temp_dir: &TempDir) -> BTreeMap<Vec<u8>, Option<Vec<u8>>> {
    let mut opts = Options::default();
    opts.create_if_missing(true);

    let db = RocksDB::open(&opts, temp_dir.path()).expect("Failed to open RocksDB");

    let mut results = BTreeMap::new();

    for op in ops {
        match op {
            Op::Put { key, value } => {
                db.put(key, value).expect("RocksDB put failed");
            }
            Op::Get { key } => {
                let result = db.get(key).expect("RocksDB get failed");
                results.insert(key.clone(), result);
            }
            Op::Delete { key } => {
                db.delete(key).expect("RocksDB delete failed");
            }
        }
    }

    results
}

/// Compare final state of both databases
fn compare_final_state(seerdb_dir: &TempDir, rocksdb_dir: &TempDir, keys: &[Vec<u8>]) {
    // Reopen seerdb
    let seerdb = DBOptions::default()
        .background_compaction(false)
        .background_flush(false)
        .open(seerdb_dir.path())
        .expect("Failed to reopen seerdb");

    // Reopen RocksDB (database must already exist from prior run)
    let rocks_opts = Options::default();
    let rocksdb = RocksDB::open(&rocks_opts, rocksdb_dir.path()).expect("Failed to reopen RocksDB");

    // Compare all keys
    for key in keys {
        let seer_val = seerdb.get(key).expect("seerdb get failed");
        let rocks_val = rocksdb.get(key).expect("RocksDB get failed");

        assert_eq!(
            seer_val.as_ref().map(|b| b.as_ref()),
            rocks_val.as_deref(),
            "Mismatch for key {:?}: seerdb={:?}, rocksdb={:?}",
            String::from_utf8_lossy(key),
            seer_val,
            rocks_val
        );
    }
}

/// Basic differential test with random operations
#[test]
fn test_differential_random_ops() {
    let seed = 12345u64;
    let ops = generate_ops(seed, 1000, 100); // 1000 ops, 100 unique keys

    let seerdb_dir = TempDir::new().unwrap();
    let rocksdb_dir = TempDir::new().unwrap();

    // Run same ops against both
    let seer_results = run_seerdb(&ops, &seerdb_dir);
    let rocks_results = run_rocksdb(&ops, &rocksdb_dir);

    // Compare intermediate get results
    assert_eq!(
        seer_results, rocks_results,
        "Intermediate results differ between seerdb and RocksDB"
    );

    // Compare final state
    let keys: Vec<Vec<u8>> = (0..100)
        .map(|i| format!("key_{:08}", i).into_bytes())
        .collect();
    compare_final_state(&seerdb_dir, &rocksdb_dir, &keys);
}

/// Test with many overwrites to same keys
#[test]
fn test_differential_overwrite_heavy() {
    let seed = 67890u64;
    let mut rng = StdRng::seed_from_u64(seed);

    // Generate ops that heavily overwrite the same keys
    let mut ops = Vec::new();
    for _ in 0..500 {
        let key_num = rng.gen_range(0..10); // Only 10 keys
        let key = format!("key_{:08}", key_num).into_bytes();
        let value_len = rng.gen_range(10..100);
        let value: Vec<u8> = (0..value_len).map(|_| rng.gen()).collect();
        ops.push(Op::Put { key, value });
    }

    let seerdb_dir = TempDir::new().unwrap();
    let rocksdb_dir = TempDir::new().unwrap();

    run_seerdb(&ops, &seerdb_dir);
    run_rocksdb(&ops, &rocksdb_dir);

    let keys: Vec<Vec<u8>> = (0..10)
        .map(|i| format!("key_{:08}", i).into_bytes())
        .collect();
    compare_final_state(&seerdb_dir, &rocksdb_dir, &keys);
}

/// Test with delete-heavy workload
#[test]
fn test_differential_delete_heavy() {
    let seed = 11111u64;
    let mut rng = StdRng::seed_from_u64(seed);

    let mut ops = Vec::new();

    // First, insert all keys
    for i in 0..50 {
        let key = format!("key_{:08}", i).into_bytes();
        let value = format!("value_{}", i).into_bytes();
        ops.push(Op::Put { key, value });
    }

    // Then randomly delete and re-insert
    for _ in 0..200 {
        let key_num = rng.gen_range(0..50);
        let key = format!("key_{:08}", key_num).into_bytes();

        if rng.gen_bool(0.5) {
            ops.push(Op::Delete { key });
        } else {
            let value = format!("updated_{}", rng.gen::<u32>()).into_bytes();
            ops.push(Op::Put { key, value });
        }
    }

    let seerdb_dir = TempDir::new().unwrap();
    let rocksdb_dir = TempDir::new().unwrap();

    run_seerdb(&ops, &seerdb_dir);
    run_rocksdb(&ops, &rocksdb_dir);

    let keys: Vec<Vec<u8>> = (0..50)
        .map(|i| format!("key_{:08}", i).into_bytes())
        .collect();
    compare_final_state(&seerdb_dir, &rocksdb_dir, &keys);
}

/// Test with empty values
#[test]
fn test_differential_empty_values() {
    let ops = vec![
        Op::Put {
            key: b"key1".to_vec(),
            value: vec![],
        },
        Op::Put {
            key: b"key2".to_vec(),
            value: b"nonempty".to_vec(),
        },
        Op::Put {
            key: b"key3".to_vec(),
            value: vec![],
        },
        Op::Get {
            key: b"key1".to_vec(),
        },
        Op::Get {
            key: b"key2".to_vec(),
        },
        Op::Get {
            key: b"key3".to_vec(),
        },
    ];

    let seerdb_dir = TempDir::new().unwrap();
    let rocksdb_dir = TempDir::new().unwrap();

    let seer_results = run_seerdb(&ops, &seerdb_dir);
    let rocks_results = run_rocksdb(&ops, &rocksdb_dir);

    assert_eq!(seer_results, rocks_results);
}

/// Test with binary keys (non-UTF8)
#[test]
fn test_differential_binary_keys() {
    let ops = vec![
        Op::Put {
            key: vec![0x00, 0x01, 0x02],
            value: b"value1".to_vec(),
        },
        Op::Put {
            key: vec![0xFF, 0xFE, 0xFD],
            value: b"value2".to_vec(),
        },
        Op::Put {
            key: vec![0x00, 0x00, 0x00],
            value: b"value3".to_vec(),
        },
        Op::Get {
            key: vec![0x00, 0x01, 0x02],
        },
        Op::Get {
            key: vec![0xFF, 0xFE, 0xFD],
        },
        Op::Get {
            key: vec![0x00, 0x00, 0x00],
        },
        Op::Get {
            key: vec![0x01, 0x02, 0x03],
        }, // Non-existent
    ];

    let seerdb_dir = TempDir::new().unwrap();
    let rocksdb_dir = TempDir::new().unwrap();

    let seer_results = run_seerdb(&ops, &seerdb_dir);
    let rocks_results = run_rocksdb(&ops, &rocksdb_dir);

    assert_eq!(seer_results, rocks_results);
}

/// Test persistence: write, close, reopen, verify
#[test]
fn test_differential_persistence() {
    let seed = 99999u64;
    let ops = generate_ops(seed, 200, 50);

    let seerdb_dir = TempDir::new().unwrap();
    let rocksdb_dir = TempDir::new().unwrap();

    // Phase 1: Write data
    {
        run_seerdb(&ops, &seerdb_dir);
        run_rocksdb(&ops, &rocksdb_dir);
    }

    // Phase 2: Reopen and compare
    let keys: Vec<Vec<u8>> = (0..50)
        .map(|i| format!("key_{:08}", i).into_bytes())
        .collect();
    compare_final_state(&seerdb_dir, &rocksdb_dir, &keys);
}

/// Longer random test for more coverage
#[test]
fn test_differential_extended() {
    let seed = 42424242u64;
    let ops = generate_ops(seed, 5000, 500); // 5000 ops, 500 unique keys

    let seerdb_dir = TempDir::new().unwrap();
    let rocksdb_dir = TempDir::new().unwrap();

    let seer_results = run_seerdb(&ops, &seerdb_dir);
    let rocks_results = run_rocksdb(&ops, &rocksdb_dir);

    assert_eq!(
        seer_results, rocks_results,
        "Extended test: intermediate results differ"
    );

    let keys: Vec<Vec<u8>> = (0..500)
        .map(|i| format!("key_{:08}", i).into_bytes())
        .collect();
    compare_final_state(&seerdb_dir, &rocksdb_dir, &keys);
}