bitask 0.1.1

Bitask is a Rust implementation of Bitcask, a log-structured key-value store optimized for high-performance reads and writes.
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

use std::{path::Path, sync::Once};
use tempfile::tempdir;

static INIT: Once = Once::new();

fn setup() {
    INIT.call_once(|| {
        env_logger::init();
    });
}

#[test]
fn test_basic_db_operations() -> Result<(), Box<dyn std::error::Error>> {
    setup();
    let temp_dir = tempdir()?;
    let mut db = bitask::db::Bitask::open(temp_dir.path())?;

    // Test put and get
    let key = b"test_key".to_vec();
    let value = b"test_value".to_vec();
    db.put(key.clone(), value.clone())?;

    let retrieved = db.ask(&key)?;
    assert_eq!(retrieved, value);

    // Test remove
    db.remove(key.clone())?;
    assert!(matches!(db.ask(&key), Err(bitask::db::Error::KeyNotFound)));

    Ok(())
}

#[test]
fn test_open_once() -> anyhow::Result<()> {
    setup();
    let temp = tempfile::tempdir().unwrap();
    let _db = bitask::db::Bitask::open(temp.path())?;
    Ok(())
}

#[test]
fn test_open_twice() -> anyhow::Result<()> {
    setup();
    let temp = tempfile::tempdir().unwrap();
    let _db = bitask::db::Bitask::open(temp.path())?;
    match bitask::db::Bitask::open(temp.path()) {
        Err(bitask::db::Error::WriterLock) => Ok(()),
        Ok(_) => panic!("Expected second open to fail with lock error"),
        Err(e) => panic!("Expected WriterLock error, got: {}", e),
    }
}

#[test]
fn test_ask_key_not_found() -> anyhow::Result<()> {
    setup();
    let temp = tempfile::tempdir().unwrap();
    let mut db = bitask::db::Bitask::open(temp.path())?;
    let value = db.ask(b"key");
    assert!(value.is_err());
    assert!(matches!(
        value.err().unwrap(),
        bitask::db::Error::KeyNotFound
    ));
    Ok(())
}

#[test]
fn test_put_get() -> anyhow::Result<()> {
    setup();
    let temp = tempfile::tempdir().unwrap();
    let mut db = bitask::db::Bitask::open(temp.path())?;
    db.put(b"key1".to_vec(), b"value1".to_vec())?;
    db.put(b"key2".to_vec(), b"value2".to_vec())?;

    let value = db.ask(b"key1")?;
    assert_eq!(value, b"value1");

    let value = db.ask(b"key2")?;
    assert_eq!(value, b"value2");
    Ok(())
}

#[test]
fn test_put_overwrite_and_get() -> anyhow::Result<()> {
    setup();
    let temp = tempfile::tempdir().unwrap();
    let mut db = bitask::db::Bitask::open(temp.path())?;
    db.put(b"key1".to_vec(), b"value1".to_vec())?;

    let value = db.ask(b"key1")?;
    assert_eq!(value, b"value1");

    db.put(b"key1".to_vec(), b"value2".to_vec())?;
    let value = db.ask(b"key1")?;
    assert_eq!(value, b"value2");
    Ok(())
}

#[test]
fn test_remove() -> anyhow::Result<()> {
    setup();
    let temp = tempfile::tempdir().unwrap();
    let mut db = bitask::db::Bitask::open(temp.path())?;
    db.put(b"key1".to_vec(), b"value1".to_vec())?;
    db.remove(b"key1".to_vec())?;
    let value = db.ask(b"key1");
    assert!(value.is_err());
    assert!(matches!(
        value.err().unwrap(),
        bitask::db::Error::KeyNotFound
    ));
    Ok(())
}

#[test]
fn test_invalid_empty_key_and_empty_value() -> anyhow::Result<()> {
    setup();
    let temp = tempfile::tempdir().unwrap();
    let mut db = bitask::db::Bitask::open(temp.path())?;
    let error = db.put(vec![], vec![]);
    assert!(error.is_err());
    assert!(matches!(
        error.err().unwrap(),
        bitask::db::Error::InvalidEmptyKey
    ));

    let error = db.ask(&[]);
    assert!(error.is_err());
    assert!(matches!(
        error.err().unwrap(),
        bitask::db::Error::InvalidEmptyKey
    ));

    let error = db.remove(vec![]);
    assert!(error.is_err());
    assert!(matches!(
        error.err().unwrap(),
        bitask::db::Error::InvalidEmptyKey
    ));
    Ok(())
}

#[test]
fn test_rebuild_keydir_on_open() -> Result<(), Box<dyn std::error::Error>> {
    setup();
    let temp = tempfile::tempdir()?;
    let mut db = bitask::db::Bitask::open(temp.path())?;

    // Write some data
    db.put(b"key1".to_vec(), b"value1".to_vec())?;
    db.put(b"key2".to_vec(), b"value2".to_vec())?;

    // Drop the database to close it
    drop(db);

    // Reopen and verify data persists
    let mut db = bitask::db::Bitask::open(temp.path())?;
    let value = db.ask(b"key1")?;
    assert_eq!(value, b"value1");

    let value = db.ask(b"key2")?;
    assert_eq!(value, b"value2");

    Ok(())
}

#[test]
fn test_rebuild_keydir_on_open_with_remove() -> anyhow::Result<()> {
    setup();
    let temp = tempfile::tempdir().unwrap();
    let mut db = bitask::db::Bitask::open(temp.path())?;
    db.put(b"key1".to_vec(), b"value1".to_vec())?;
    db.put(b"key2".to_vec(), b"value2".to_vec())?;
    db.remove(b"key1".to_vec())?;
    drop(db);

    let mut db = bitask::db::Bitask::open(temp.path())?;
    let value = db.ask(b"key1");
    assert!(value.is_err());
    assert!(matches!(
        value.err().unwrap(),
        bitask::db::Error::KeyNotFound
    ));

    let value = db.ask(b"key2")?;
    assert_eq!(value, b"value2");
    Ok(())
}

#[test]
fn test_multiple_operations_sequence() -> anyhow::Result<()> {
    setup();
    let temp = tempfile::tempdir().unwrap();
    let mut db = bitask::db::Bitask::open(temp.path())?;

    // Insert multiple key-value pairs
    for i in 0..100 {
        let key = format!("key{}", i).into_bytes();
        let value = format!("value{}", i).into_bytes();
        db.put(key, value)?;
    }

    // Verify all values
    for i in 0..100 {
        let key = format!("key{}", i).into_bytes();
        let expected = format!("value{}", i).into_bytes();
        let value = db.ask(&key)?;
        assert_eq!(value, expected);
    }

    // Remove every other key
    for i in (0..100).step_by(2) {
        let key = format!("key{}", i).into_bytes();
        db.remove(key)?;
    }

    // Verify remaining and removed keys
    for i in 0..100 {
        let key = format!("key{}", i).into_bytes();
        let result = db.ask(&key);
        if i % 2 == 0 {
            assert!(matches!(
                result.err().unwrap(),
                bitask::db::Error::KeyNotFound
            ));
        } else {
            assert_eq!(result?, format!("value{}", i).into_bytes());
        }
    }

    Ok(())
}

#[test]
fn test_log_rotation() -> anyhow::Result<()> {
    setup();
    let temp = tempfile::tempdir().unwrap();
    let mut db = bitask::db::Bitask::open(temp.path())?;

    // Create a 4MiB value (just over the MAX_ACTIVE_FILE_SIZE)
    let key = b"large_key".to_vec();
    let value = vec![42u8; 4 * 1024 * 1024];

    // First write should create initial file
    db.put(key.clone(), value.clone())?;

    // Second write should trigger rotation
    let key2 = b"large_key2".to_vec();
    db.put(key2.clone(), value.clone())?;

    // Verify both values are readable
    assert_eq!(db.ask(&key)?, value);
    assert_eq!(db.ask(&key2)?, value);

    // Verify we have two files in the directory
    let file_count = std::fs::read_dir(temp.path())?
        .filter_map(Result::ok)
        .filter(|entry| {
            entry
                .path()
                .extension()
                .and_then(|ext| ext.to_str())
                .map(|ext| ext == "log")
                .unwrap_or(false)
        })
        .count();

    assert_eq!(file_count, 2);

    Ok(())
}

#[test]
fn test_compaction() -> anyhow::Result<()> {
    setup();

    let temp = tempdir()?;
    let mut db = bitask::db::Bitask::open(temp.path())?;

    // Write initial data to first file
    for i in 0..3000 {
        // Changed: More entries to ensure multiple files
        let key = format!("key{}", i).into_bytes();
        let value = vec![42u8; 4 * 1024]; // 4KB value
        db.put(key, value)?;
    }

    // Update keys to create obsolete entries
    for i in 0..1000 {
        let key = format!("key{}", i).into_bytes();
        let value = vec![43u8; 4 * 1024];
        db.put(key, value)?;
    }

    // Delete some keys to create tombstones
    for i in 0..400 {
        let key = format!("key{}", i).into_bytes();
        db.remove(key)?;
    }

    // Force compaction
    db.compact()?;

    // Verify data integrity
    // Keys 0-399 should be deleted (tombstones)
    for i in 0..400 {
        let key = format!("key{}", i).into_bytes();
        assert!(matches!(db.ask(&key), Err(bitask::db::Error::KeyNotFound)));
    }

    // Keys 400-999 should have updated values (43)
    for i in 400..1000 {
        let key = format!("key{}", i).into_bytes();
        let value = db.ask(&key)?;
        assert_eq!(value, vec![43u8; 4 * 1024]);
    }

    // Keys 1000-2999 should have original values (42)
    for i in 1000..3000 {
        // Changed: Check all remaining keys
        let key = format!("key{}", i).into_bytes();
        let value = db.ask(&key)?;
        assert_eq!(value, vec![42u8; 4 * 1024]);
    }

    Ok(())
}

#[test]
fn test_automatic_compaction_trigger() -> anyhow::Result<()> {
    setup();
    let temp = tempdir()?;
    let mut db = bitask::db::Bitask::open(temp.path())?;

    // Phase 1: Create initial data and get size
    for i in 0..3000 {
        let key = format!("key{}", i).into_bytes();
        let value = vec![42u8; 4 * 1024]; // 4KB value
        db.put(key, value)?;
    }

    // Phase 2: Remove all keys
    for i in 0..3000 {
        let key = format!("key{}", i).into_bytes();
        db.remove(key)?;
    }

    // Force a compaction to ensure all tombstones are processed
    db.compact()?;

    // Get final size - should be near zero since all data is removed
    let final_size = get_dir_size(temp.path())?;
    log::info!(
        "Final size after all removals and compaction: {} bytes",
        final_size
    );

    // Should be less than our max file size (since we should only have active file)
    assert!(
        final_size < bitask::db::MAX_ACTIVE_FILE_SIZE,
        "Expected size less than MAX_ACTIVE_FILE_SIZE, got {} bytes",
        final_size
    );

    // Verify all keys are gone
    for i in 0..1000 {
        let key = format!("key{}", i).into_bytes();
        assert!(matches!(db.ask(&key), Err(bitask::db::Error::KeyNotFound)));
    }

    Ok(())
}

fn get_dir_size(path: impl AsRef<Path>) -> anyhow::Result<u64> {
    let mut total_size = 0;
    for entry in std::fs::read_dir(path)? {
        let entry = entry?;
        if entry.file_type()?.is_file() {
            total_size += entry.metadata()?.len();
        }
    }
    Ok(total_size)
}