wkv 0.1.1

Single-node hybrid-log storage engine with TTL, GC, checkpoints, range index
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
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
//! 对标 Garnet Tsavorite SpanByteLogCompactionTests 紧缩测试套件
//!
//! 覆盖场景:
//! 1. 基础全量数据推进紧缩(Lookup 与 Scan 模式);
//! 2. 多层冷热分级存储紧缩(Level 1 内存覆写 + Level 2 磁盘冷读);
//! 3. 穿插删除与墓碑清理紧缩;
//! 4. 自定义过期过滤谓词紧缩;
//! 5. 单键多版本覆盖更新紧缩至尾部。

use std::{fmt::Write, sync::Arc};

use aok::{OK, Void};
use compio::runtime::Runtime;
use log::info;
use wcompact::{CompactionType, LogCompactor};

use super::support::{create_test_store, verify_records};

const TOTAL_RECORDS: usize = 2000;
const CUT_OFFSET: usize = 1000;
const OVERWRITE_COUNT: usize = 500;

/// 对标 libs/storage/Tsavorite/cs/test/test.hlog/SpanByteLogCompactionTests.cs:SpanByteLogCompactionTest1 (Lookup 模式)
///
/// 写入 2000 条记录,在 1000 条处记录紧缩点,刷盘并驱逐至磁盘,
/// 执行 Lookup 紧缩后验证 begin_address 推进至截断点,2000 条记录全部完整可读。
#[test]
fn spanbyte_compaction_test1_lookup() -> Void {
  let rt = Runtime::new()?;
  rt.block_on(async {
    let (_dir, store, session) = create_test_store("spanbyte_test1_lookup.db")?;

    let mut compact_until = 0u64;
    let mut k = String::with_capacity(16);
    let mut v = String::with_capacity(24);

    for i in 0..TOTAL_RECORDS {
      if i == CUT_OFFSET {
        compact_until = store.tail_address();
      }
      k.clear();
      let _ = write!(&mut k, "kfield1:{i:05}");
      v.clear();
      let _ = write!(&mut v, "kfield1:{i:05}:payload");
      session.upsert(k.as_bytes(), v.as_bytes()).await?;
    }

    store.flush_and_evict_all().await?;

    let compactor = LogCompactor::new(Arc::clone(&store));
    let stats = compactor
      .compact(compact_until, CompactionType::Lookup)
      .await?;

    assert_eq!(store.begin_address(), stats.new_begin_address);
    assert_eq!(store.begin_address(), compact_until);
    assert_eq!(stats.scanned_records, CUT_OFFSET);
    assert_eq!(stats.live_copied, CUT_OFFSET);
    assert_eq!(stats.dead_dropped, 0);

    verify_records(&session, "kfield1", TOTAL_RECORDS, |_| false).await?;

    info!("SpanByteLogCompactionTest1 (Lookup) 验证通过");
    aok::Result::<()>::Ok(())
  })?;

  OK
}

/// 测试 Scan 模式下的 SpanByteLogCompactionTest1 紧缩推进及全量数据准确性
///
/// 相同 2000 条记录落盘流程,采用 Scan 模式紧缩,验证紧缩推进及全量数据准确性。
#[test]
fn spanbyte_compaction_test1_scan() -> Void {
  let rt = Runtime::new()?;
  rt.block_on(async {
    let (_dir, store, session) = create_test_store("spanbyte_test1_scan.db")?;

    let mut compact_until = 0u64;
    let mut k = String::with_capacity(16);
    let mut v = String::with_capacity(24);

    for i in 0..TOTAL_RECORDS {
      if i == CUT_OFFSET {
        compact_until = store.tail_address();
      }
      k.clear();
      let _ = write!(&mut k, "kfield1:{i:05}");
      v.clear();
      let _ = write!(&mut v, "kfield1:{i:05}:payload");
      session.upsert(k.as_bytes(), v.as_bytes()).await?;
    }

    store.flush_and_evict_all().await?;

    let compactor = LogCompactor::new(Arc::clone(&store));
    let stats = compactor
      .compact(compact_until, CompactionType::Scan)
      .await?;

    assert_eq!(store.begin_address(), stats.new_begin_address);
    assert_eq!(store.begin_address(), compact_until);
    assert_eq!(stats.scanned_records, CUT_OFFSET);
    assert_eq!(stats.live_copied, CUT_OFFSET);
    assert_eq!(stats.dead_dropped, 0);

    verify_records(&session, "kfield1", TOTAL_RECORDS, |_| false).await?;

    info!("SpanByteLogCompactionTest1 (Scan) 验证通过");
    aok::Result::<()>::Ok(())
  })?;

  OK
}

/// 对标 libs/storage/Tsavorite/cs/test/test.hlog/SpanByteLogCompactionTests.cs:SpanByteLogCompactionTest2 (Lookup 多层冷热模式)
///
/// 写入 2000 条后落盘,在内存中覆写前 500 条(Level 1 内存热区 + Level 2 磁盘冷区),
/// 紧缩后验证旧版本安全丢弃,新版本与未修改记录全部准确回读。
#[test]
fn spanbyte_compaction_test2_multilevel_lookup() -> Void {
  let rt = Runtime::new()?;
  rt.block_on(async {
    let (_dir, store, session) = create_test_store("spanbyte_test2_lookup.db")?;

    let mut compact_until = 0u64;
    let mut k = String::with_capacity(16);
    let mut v = String::with_capacity(36);

    for i in 0..TOTAL_RECORDS {
      if i == CUT_OFFSET {
        compact_until = store.tail_address();
      }
      k.clear();
      let _ = write!(&mut k, "kfield1:{i:05}");
      v.clear();
      let _ = write!(&mut v, "vfield1:{i:05}:level2_disk");
      session.upsert(k.as_bytes(), v.as_bytes()).await?;
    }

    store.flush_and_evict_all().await?;

    // 内存覆写前 500 条记录为 Level 1 最新版本
    for i in 0..OVERWRITE_COUNT {
      k.clear();
      let _ = write!(&mut k, "kfield1:{i:05}");
      v.clear();
      let _ = write!(&mut v, "vfield1:{i:05}:level1_memory_fresh");
      session.upsert(k.as_bytes(), v.as_bytes()).await?;
    }

    store.shift_read_only_address(store.tail_address());

    let compactor = LogCompactor::new(Arc::clone(&store));
    let stats = compactor
      .compact(compact_until, CompactionType::Lookup)
      .await?;

    assert_eq!(store.begin_address(), compact_until);
    assert_eq!(stats.scanned_records, CUT_OFFSET);
    assert_eq!(stats.live_copied, OVERWRITE_COUNT);
    assert_eq!(
      stats.superseded, OVERWRITE_COUNT,
      "被内存区新版本取代的旧版计为弃迁"
    );
    assert_eq!(stats.dead_dropped, 0);

    let mut expected = String::with_capacity(36);
    for i in 0..TOTAL_RECORDS {
      k.clear();
      let _ = write!(&mut k, "kfield1:{i:05}");
      let val = session.read(k.as_bytes()).await?;
      expected.clear();
      if i < OVERWRITE_COUNT {
        let _ = write!(&mut expected, "vfield1:{i:05}:level1_memory_fresh");
      } else {
        let _ = write!(&mut expected, "vfield1:{i:05}:level2_disk");
      }
      assert_eq!(val.as_deref(), Some(expected.as_bytes()));
    }

    info!("SpanByteLogCompactionTest2 (Lookup 多层冷热) 验证通过");
    aok::Result::<()>::Ok(())
  })?;

  OK
}

/// 测试 Scan 模式下的 SpanByteLogCompactionTest2 多层冷热数据紧缩推进与全量校验
#[test]
fn spanbyte_compaction_test2_multilevel_scan() -> Void {
  let rt = Runtime::new()?;
  rt.block_on(async {
    let (_dir, store, session) = create_test_store("spanbyte_test2_scan.db")?;

    let mut compact_until = 0u64;
    let mut k = String::with_capacity(16);
    let mut v = String::with_capacity(36);

    for i in 0..TOTAL_RECORDS {
      if i == CUT_OFFSET {
        compact_until = store.tail_address();
      }
      k.clear();
      let _ = write!(&mut k, "kfield1:{i:05}");
      v.clear();
      let _ = write!(&mut v, "vfield1:{i:05}:level2_disk");
      session.upsert(k.as_bytes(), v.as_bytes()).await?;
    }

    store.flush_and_evict_all().await?;

    for i in 0..OVERWRITE_COUNT {
      k.clear();
      let _ = write!(&mut k, "kfield1:{i:05}");
      v.clear();
      let _ = write!(&mut v, "vfield1:{i:05}:level1_memory_fresh");
      session.upsert(k.as_bytes(), v.as_bytes()).await?;
    }

    store.shift_read_only_address(store.tail_address());

    let compactor = LogCompactor::new(Arc::clone(&store));
    let stats = compactor
      .compact(compact_until, CompactionType::Scan)
      .await?;

    assert_eq!(store.begin_address(), compact_until);
    assert_eq!(stats.scanned_records, CUT_OFFSET);
    assert_eq!(stats.live_copied, OVERWRITE_COUNT);
    assert_eq!(
      stats.superseded, OVERWRITE_COUNT,
      "被内存区新版本取代的旧版计为弃迁"
    );
    assert_eq!(stats.dead_dropped, 0);

    let mut expected = String::with_capacity(36);
    for i in 0..TOTAL_RECORDS {
      k.clear();
      let _ = write!(&mut k, "kfield1:{i:05}");
      let val = session.read(k.as_bytes()).await?;
      expected.clear();
      if i < OVERWRITE_COUNT {
        let _ = write!(&mut expected, "vfield1:{i:05}:level1_memory_fresh");
      } else {
        let _ = write!(&mut expected, "vfield1:{i:05}:level2_disk");
      }
      assert_eq!(val.as_deref(), Some(expected.as_bytes()));
    }

    info!("SpanByteLogCompactionTest2 (Scan 多层冷热) 验证通过");
    aok::Result::<()>::Ok(())
  })?;

  OK
}

/// 对标 libs/storage/Tsavorite/cs/test/test.hlog/SpanByteLogCompactionTests.cs:SpanByteLogCompactionTest3 (Lookup 穿插删除模式)
///
/// 写入过程中穿插删除键,紧缩后验证被删除键读空,其余记录完整存活。
#[test]
fn spanbyte_compaction_test3_with_deletions_lookup() -> Void {
  let rt = Runtime::new()?;
  rt.block_on(async {
    let (_dir, store, session) = create_test_store("spanbyte_test3_lookup.db")?;

    let mut compact_until = 0u64;
    let mut k = String::with_capacity(16);
    let mut v = String::with_capacity(16);
    let mut del_k = String::with_capacity(16);

    for i in 0..TOTAL_RECORDS {
      if i == CUT_OFFSET {
        compact_until = store.tail_address();
      }
      k.clear();
      let _ = write!(&mut k, "key:{i:04}");
      v.clear();
      let _ = write!(&mut v, "val:{i:04}");
      session.upsert(k.as_bytes(), v.as_bytes()).await?;

      if i % 8 == 0 {
        let del_j = i / 4;
        del_k.clear();
        let _ = write!(&mut del_k, "key:{del_j:04}");
        session.delete(del_k.as_bytes()).await?;
      }
    }

    store.flush_and_evict_all().await?;

    let compactor = LogCompactor::new(Arc::clone(&store));
    let stats = compactor
      .compact(compact_until, CompactionType::Lookup)
      .await?;

    assert_eq!(store.begin_address(), compact_until);

    let mut expected = String::with_capacity(16);
    for i in 0..TOTAL_RECORDS {
      k.clear();
      let _ = write!(&mut k, "key:{i:04}");
      let val = session.read(k.as_bytes()).await?;
      let is_deleted = (i < TOTAL_RECORDS / 4) && (i % 2 == 0);
      if is_deleted {
        assert!(val.is_none(), "已被删除的键必须返回 None: {k}");
      } else {
        expected.clear();
        let _ = write!(&mut expected, "val:{i:04}");
        assert_eq!(val.as_deref(), Some(expected.as_bytes()));
      }
    }

    info!(
      "SpanByteLogCompactionTest3 (Lookup 穿插删除) 验证通过, 丢弃数={}",
      stats.dead_dropped
    );
    aok::Result::<()>::Ok(())
  })?;

  OK
}

/// 测试 Scan 模式下的 SpanByteLogCompactionTest3 穿插删除数据紧缩推进与全量校验
#[test]
fn spanbyte_compaction_test3_with_deletions_scan() -> Void {
  let rt = Runtime::new()?;
  rt.block_on(async {
    let (_dir, store, session) = create_test_store("spanbyte_test3_scan.db")?;

    let mut compact_until = 0u64;
    let mut k = String::with_capacity(16);
    let mut v = String::with_capacity(16);
    let mut del_k = String::with_capacity(16);

    for i in 0..TOTAL_RECORDS {
      if i == CUT_OFFSET {
        compact_until = store.tail_address();
      }
      k.clear();
      let _ = write!(&mut k, "key:{i:04}");
      v.clear();
      let _ = write!(&mut v, "val:{i:04}");
      session.upsert(k.as_bytes(), v.as_bytes()).await?;

      if i % 8 == 0 {
        let del_j = i / 4;
        del_k.clear();
        let _ = write!(&mut del_k, "key:{del_j:04}");
        session.delete(del_k.as_bytes()).await?;
      }
    }

    store.flush_and_evict_all().await?;

    let compactor = LogCompactor::new(Arc::clone(&store));
    let stats = compactor
      .compact(compact_until, CompactionType::Scan)
      .await?;

    assert_eq!(store.begin_address(), compact_until);

    let mut expected = String::with_capacity(16);
    for i in 0..TOTAL_RECORDS {
      k.clear();
      let _ = write!(&mut k, "key:{i:04}");
      let val = session.read(k.as_bytes()).await?;
      let is_deleted = (i < TOTAL_RECORDS / 4) && (i % 2 == 0);
      if is_deleted {
        assert!(val.is_none(), "已被删除的键必须返回 None: {k}");
      } else {
        expected.clear();
        let _ = write!(&mut expected, "val:{i:04}");
        assert_eq!(val.as_deref(), Some(expected.as_bytes()));
      }
    }

    info!(
      "SpanByteLogCompactionTest3 (Scan 穿插删除) 验证通过, 丢弃数={}",
      stats.dead_dropped
    );
    aok::Result::<()>::Ok(())
  })?;

  OK
}

/// 对标 libs/storage/Tsavorite/cs/test/test.hlog/SpanByteLogCompactionTests.cs:SpanByteLogCompactionCustomFunctionsTest1 (Lookup 模式)
///
/// 自定义谓词:奇数值记录判定为已删除。紧缩后奇数项清除,偶数项存活迁移,紧缩区外不受影响。
#[test]
fn spanbyte_compaction_custom_filter_test1_lookup() -> Void {
  let rt = Runtime::new()?;
  rt.block_on(async {
    let (_dir, store, session) = create_test_store("spanbyte_custom1_lookup.db")?;

    let mut compact_until = 0u64;
    let mut k = String::with_capacity(16);
    let mut v = String::with_capacity(16);

    for i in 0..TOTAL_RECORDS {
      if i == CUT_OFFSET {
        compact_until = store.tail_address();
      }
      k.clear();
      let _ = write!(&mut k, "k:{i:05}");
      v.clear();
      let _ = write!(&mut v, "{i}");
      session.upsert(k.as_bytes(), v.as_bytes()).await?;
    }

    store.flush_and_evict_all().await?;

    let compactor = LogCompactor::new(Arc::clone(&store));
    let stats = compactor
      .compact_with_filter(compact_until, CompactionType::Lookup, |_key, val| {
        val
          .last()
          .is_some_and(|&b| b.is_ascii_digit() && b % 2 != 0)
      })
      .await?;

    assert_eq!(store.begin_address(), compact_until);
    assert_eq!(stats.scanned_records, CUT_OFFSET);
    assert_eq!(stats.live_copied, 500);
    assert_eq!(stats.dead_dropped, 500);

    let mut expected = String::with_capacity(16);
    for i in 0..TOTAL_RECORDS {
      k.clear();
      let _ = write!(&mut k, "k:{i:05}");
      let val = session.read(k.as_bytes()).await?;
      if i < CUT_OFFSET && i % 2 != 0 {
        assert!(val.is_none(), "紧缩区奇数记录应被自定义过滤删除: {k}");
      } else {
        expected.clear();
        let _ = write!(&mut expected, "{i}");
        assert_eq!(val.as_deref(), Some(expected.as_bytes()));
      }
    }

    info!("SpanByteLogCompactionCustomFunctionsTest1 (Lookup) 验证通过");
    aok::Result::<()>::Ok(())
  })?;

  OK
}

/// 测试 Scan 模式下的 SpanByteLogCompactionCustomFunctionsTest1 自定义过滤紧缩推进与全量校验
#[test]
fn spanbyte_compaction_custom_filter_test1_scan() -> Void {
  let rt = Runtime::new()?;
  rt.block_on(async {
    let (_dir, store, session) = create_test_store("spanbyte_custom1_scan.db")?;

    let mut compact_until = 0u64;
    let mut k = String::with_capacity(16);
    let mut v = String::with_capacity(16);

    for i in 0..TOTAL_RECORDS {
      if i == CUT_OFFSET {
        compact_until = store.tail_address();
      }
      k.clear();
      let _ = write!(&mut k, "k:{i:05}");
      v.clear();
      let _ = write!(&mut v, "{i}");
      session.upsert(k.as_bytes(), v.as_bytes()).await?;
    }

    store.flush_and_evict_all().await?;

    let compactor = LogCompactor::new(Arc::clone(&store));
    let stats = compactor
      .compact_with_filter(compact_until, CompactionType::Scan, |_key, val| {
        val
          .last()
          .is_some_and(|&b| b.is_ascii_digit() && b % 2 != 0)
      })
      .await?;

    assert_eq!(store.begin_address(), compact_until);
    assert_eq!(stats.scanned_records, CUT_OFFSET);
    assert_eq!(stats.live_copied, 500);
    assert_eq!(stats.dead_dropped, 500);

    let mut expected = String::with_capacity(16);
    for i in 0..TOTAL_RECORDS {
      k.clear();
      let _ = write!(&mut k, "k:{i:05}");
      let val = session.read(k.as_bytes()).await?;
      if i < CUT_OFFSET && i % 2 != 0 {
        assert!(val.is_none(), "紧缩区奇数记录应被自定义过滤删除: {k}");
      } else {
        expected.clear();
        let _ = write!(&mut expected, "{i}");
        assert_eq!(val.as_deref(), Some(expected.as_bytes()));
      }
    }

    info!("SpanByteLogCompactionCustomFunctionsTest1 (Scan) 验证通过");
    aok::Result::<()>::Ok(())
  })?;

  OK
}

/// 对标 libs/storage/Tsavorite/cs/test/test.hlog/SpanByteLogCompactionTests.cs:SpanByteLogCompactionCustomFunctionsTest2 (Lookup 模式)
///
/// 写入同一 Key 的多个版本并刷盘落盘,紧缩至 TailAddress,确保最终读取到的是最新版本值。
#[test]
fn spanbyte_compaction_custom_functions_test2_lookup() -> Void {
  let rt = Runtime::new()?;
  rt.block_on(async {
    let (_dir, store, session) = create_test_store("spanbyte_custom2_lookup.db")?;

    let k = b"key:custom:test2";
    let v_old = b"vfield1=10,vfield2=20";
    session.upsert(k, v_old).await?;
    store.flush_all().await?;
    store.shift_read_only_address(store.tail_address());

    let v_new = b"vfield1=11,vfield2=21";
    session.upsert(k, v_new).await?;
    store.flush_and_evict_all().await?;

    let tail = store.tail_address();
    let compactor = LogCompactor::new(Arc::clone(&store));
    let stats = compactor.compact(tail, CompactionType::Lookup).await?;

    assert_eq!(store.begin_address(), tail);
    assert_eq!(stats.scanned_records, 2);
    assert_eq!(stats.live_copied, 1);
    assert_eq!(stats.superseded, 1, "v_old 被区间内 v_new 取代计为弃迁");
    assert_eq!(stats.dead_dropped, 0);

    let val = session.read(k).await?;
    assert_eq!(
      val.as_deref(),
      Some(v_new.as_slice()),
      "紧缩后必须正确读取到最新版本值"
    );

    info!("SpanByteLogCompactionCustomFunctionsTest2 (Lookup) 验证通过");
    aok::Result::<()>::Ok(())
  })?;

  OK
}

/// 测试 Scan 模式下的 SpanByteLogCompactionCustomFunctionsTest2 自定义函数紧缩推进与全量校验
#[test]
fn spanbyte_compaction_custom_functions_test2_scan() -> Void {
  let rt = Runtime::new()?;
  rt.block_on(async {
    let (_dir, store, session) = create_test_store("spanbyte_custom2_scan.db")?;

    let k = b"key:custom:test2";
    let v_old = b"vfield1=10,vfield2=20";
    session.upsert(k, v_old).await?;
    store.flush_all().await?;
    store.shift_read_only_address(store.tail_address());

    let v_new = b"vfield1=11,vfield2=21";
    session.upsert(k, v_new).await?;
    store.flush_and_evict_all().await?;

    let tail = store.tail_address();
    let compactor = LogCompactor::new(Arc::clone(&store));
    let stats = compactor.compact(tail, CompactionType::Scan).await?;

    assert_eq!(store.begin_address(), tail);
    assert_eq!(stats.scanned_records, 2);
    assert_eq!(stats.live_copied, 1);
    assert_eq!(stats.superseded, 1, "v_old 被区间内 v_new 取代计为弃迁");
    assert_eq!(stats.dead_dropped, 0);

    let val = session.read(k).await?;
    assert_eq!(
      val.as_deref(),
      Some(v_new.as_slice()),
      "紧缩后必须正确读取到最新版本值"
    );

    info!("SpanByteLogCompactionCustomFunctionsTest2 (Scan) 验证通过");
    aok::Result::<()>::Ok(())
  })?;

  OK
}