wedb_embed 0.1.13

Embedded database engine providing Redis-like APIs, built on fjall / 嵌入式数据库引擎,提供类似 Redis 的接口,底层基于 fjall 开发
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
use aok::Void;
use tempfile::tempdir;
use wedb_embed::{
  CfInsert, CfReserve, CuckooChainMeta, CuckooFilterHelper, CuckooFilterInfo, Fjall, WeDb,
};

#[ctor::ctor(unsafe)]
fn _log_init() {
  log_init::init();
}

#[test]
fn test_cuckoo_filter_helper_and_meta_math() -> Void {
  // 桶计算与容量限制测试(对标 Kvrocks CalculateRequiredBuckets)
  let req_buckets = CuckooFilterHelper::calculate_required_buckets(1000, 2)?;
  assert!(req_buckets.is_power_of_two());
  assert!(req_buckets >= 512);

  // 边界条件:无效 bucket_size
  assert!(CuckooFilterHelper::calculate_required_buckets(1000, 0).is_err());

  // 规范化扩容因子测试(对标 Kvrocks NormalizeExpansion)
  assert_eq!(CuckooFilterHelper::normalize_expansion(0), 0);
  assert_eq!(CuckooFilterHelper::normalize_expansion(1), 1);
  assert_eq!(CuckooFilterHelper::normalize_expansion(2), 2);
  assert_eq!(CuckooFilterHelper::normalize_expansion(3), 4);
  assert_eq!(CuckooFilterHelper::normalize_expansion(7), 8);
  assert_eq!(CuckooFilterHelper::normalize_expansion(32768), 32768);
  assert_eq!(CuckooFilterHelper::normalize_expansion(40000), 32768);

  // 指纹生成与异或备选哈希测试(对标 Kvrocks GenerateFingerprint / GetAltHash / GetAltBucketIndex)
  let hash = CuckooFilterHelper::hash(b"test_cuckoo_item");
  let fp = CuckooFilterHelper::generate_fingerprint(hash);
  assert_ne!(fp, 0); // 指纹绝对不为 0 (1..=255)

  let alt_hash = CuckooFilterHelper::get_alt_hash(fp, hash);
  let original_hash = CuckooFilterHelper::get_alt_hash(fp, alt_hash);
  assert_eq!(hash, original_hash); // 异或对称性

  let num_buckets = 128u32;
  let b1 = (hash % (num_buckets as u64)) as u32;
  let b2 = CuckooFilterHelper::get_alt_bucket_index(b1, fp, num_buckets);
  let b1_recovered = CuckooFilterHelper::get_alt_bucket_index(b2, fp, num_buckets);
  assert_eq!(b1, b1_recovered);

  // 元数据编码/解码测试(53 字节二进制对齐)
  let meta = CuckooChainMeta::new(1024, 2, 20, 1, 2048, 1, 0);
  assert_eq!(meta.get_total_capacity(), 1024);
  assert!(meta.is_scaling());

  let encoded = meta.encode();
  assert_eq!(encoded.len(), CuckooChainMeta::ENCODED_SIZE);

  let decoded = CuckooChainMeta::decode(&encoded).expect("cuckoo decode failed");
  assert_eq!(decoded.base_capacity, 1024);
  assert_eq!(decoded.bucket_size, 2);
  assert_eq!(decoded.max_iterations, 20);
  assert_eq!(decoded.expansion, 1);
  assert_eq!(decoded.page_size, 2048);
  assert_eq!(decoded.n_filters, 1);
  assert_eq!(decoded.num_deleted_items, 0);

  // 非扩容元数据容量测试
  let non_scaling_meta = CuckooChainMeta::new(512, 4, 10, 0, 2048, 1, 0);
  assert!(!non_scaling_meta.is_scaling());
  assert_eq!(non_scaling_meta.get_total_capacity(), 512);

  Ok(())
}

#[test]
fn test_cuckoo_filter_crud_and_kickout() -> Void {
  let dir = tempdir()?;
  let db = WeDb::new(Fjall::open(dir.path())?).ns(0)?.db(0)?;

  // CF.RESERVE
  db.cf_reserve(
    "cfkey",
    1000,
    [
      CfReserve::BucketSize(2),
      CfReserve::MaxIterations(20),
      CfReserve::Expansion(1),
    ],
  )?;
  // 重复 RESERVE 报错
  assert!(
    db.cf_reserve(
      "cfkey",
      1000,
      [
        CfReserve::BucketSize(2),
        CfReserve::MaxIterations(20),
        CfReserve::Expansion(1)
      ]
    )
    .is_err()
  );

  // CF.ADD & CF.EXISTS
  assert!(db.cf_add("cfkey", "alpha")?);
  assert!(db.cf_add("cfkey", "beta")?);
  assert!(db.cf_exists("cfkey", "alpha")?);
  assert!(db.cf_exists("cfkey", "beta")?);
  assert!(!db.cf_exists("cfkey", "gamma")?);

  // CF.ADDNX
  assert!(!db.cf_addnx("cfkey", "alpha")?);
  assert!(db.cf_addnx("cfkey", "gamma")?);
  assert!(db.cf_exists("cfkey", "gamma")?);

  // CF.COUNT & 重复项
  assert_eq!(db.cf_count("cfkey", "alpha")?, 1);
  assert!(db.cf_add("cfkey", "alpha")?);
  assert_eq!(db.cf_count("cfkey", "alpha")?, 2);

  // CF.DEL
  assert!(db.cf_del("cfkey", "alpha")?);
  assert_eq!(db.cf_count("cfkey", "alpha")?, 1);
  assert!(db.cf_del("cfkey", "alpha")?);
  assert_eq!(db.cf_count("cfkey", "alpha")?, 0);
  assert!(!db.cf_exists("cfkey", "alpha")?);
  assert!(!db.cf_del("cfkey", "alpha")?);

  // CF.MEXISTS
  let mex = db.cf_mexists("cfkey", &["alpha", "beta", "gamma", "delta"])?;
  assert_eq!(mex, vec![false, true, true, false]);

  // CF.INFO
  let info: CuckooFilterInfo = db.cf_info("cfkey")?;
  assert_eq!(info.bucket_size, 2);
  assert_eq!(info.num_filters, 1);
  assert_eq!(info.num_items_deleted, 2);
  assert_eq!(info.size, 2); // beta, gamma

  // 踢出算法与扩容测试
  let dir_dense = tempdir()?;
  let db_dense = WeDb::new(Fjall::open(dir_dense.path())?).ns(0)?.db(0)?;
  db_dense.cf_reserve(
    "cf_dense",
    16,
    [
      CfReserve::BucketSize(2),
      CfReserve::MaxIterations(20),
      CfReserve::Expansion(2),
    ],
  )?;

  for i in 0..50 {
    let item = format!("dense_item_{i}");
    assert!(db_dense.cf_add("cf_dense", item)?);
  }

  for i in 0..50 {
    let item = format!("dense_item_{i}");
    assert!(db_dense.cf_exists("cf_dense", item)?);
  }

  let dense_info = db_dense.cf_info("cf_dense")?;
  assert!(dense_info.num_filters > 1);
  assert_eq!(dense_info.size, 50);

  // CF.INSERT & CF.INSERT (with nx = true) 测试
  let ins_res = db_dense.cf_insert("cf_ins", &["one", "two"], [])?;
  assert_eq!(ins_res, vec![true, true]);

  let nx_res = db_dense.cf_insert("cf_ins", &["one", "three"], [CfInsert::Nx])?;
  assert_eq!(nx_res, vec![false, true]);

  Ok(())
}

#[test]
fn test_cuckoo_filter_edge_cases_and_multi_item_batch() -> Void {
  let dir = tempdir()?;
  let db = WeDb::new(Fjall::open(dir.path())?).ns(0)?.db(0)?;

  // 边界参数校验
  assert!(
    db.cf_reserve(
      "cf_err",
      1,
      [
        CfReserve::BucketSize(2),
        CfReserve::MaxIterations(20),
        CfReserve::Expansion(1)
      ]
    )
    .is_err()
  ); // capacity < 2
  assert!(
    db.cf_reserve(
      "cf_err",
      100,
      [
        CfReserve::BucketSize(0),
        CfReserve::MaxIterations(20),
        CfReserve::Expansion(1)
      ]
    )
    .is_err()
  ); // bucket_size == 0
  assert!(
    db.cf_reserve(
      "cf_err",
      100,
      [
        CfReserve::BucketSize(2),
        CfReserve::MaxIterations(0),
        CfReserve::Expansion(1)
      ]
    )
    .is_err()
  ); // max_iterations == 0
  assert!(
    db.cf_reserve(
      "cf_err",
      100,
      [
        CfReserve::BucketSize(2),
        CfReserve::MaxIterations(20),
        CfReserve::Expansion(40000)
      ]
    )
    .is_err()
  ); // expansion > 32768

  // cf_reserve 自定义 page_size 校验
  assert!(
    db.cf_reserve(
      "cf_err_page",
      100,
      [
        CfReserve::BucketSize(4),
        CfReserve::MaxIterations(20),
        CfReserve::Expansion(1),
        CfReserve::PageSize(2)
      ]
    )
    .is_err()
  ); // page_size < bucket_size
  assert!(
    db.cf_reserve(
      "cf_err_page0",
      100,
      [
        CfReserve::BucketSize(4),
        CfReserve::MaxIterations(20),
        CfReserve::Expansion(1),
        CfReserve::PageSize(0)
      ]
    )
    .is_err()
  ); // page_size == 0
  assert!(
    db.cf_reserve(
      "cf_custom_page",
      100,
      [
        CfReserve::BucketSize(4),
        CfReserve::MaxIterations(20),
        CfReserve::Expansion(1),
        CfReserve::PageSize(1024)
      ]
    )
    .is_ok()
  );

  // 空 items 测试
  let empty_items: &[&str] = &[];
  let empty_res = db.cf_insert("cf_empty", empty_items, [])?;
  assert!(empty_res.is_empty());

  // CF.INSERT NOCREATE 对不存在的 key 应报错
  assert!(
    db.cf_insert("cf_nocreate", &["item1"], [CfInsert::NoCreate])
      .is_err()
  );

  // CF.INSERT 自动创建时无效参数报错
  assert!(
    db.cf_insert("cf_inv_cap", &["item1"], [CfInsert::Capacity(1)])
      .is_err()
  );
  assert!(
    db.cf_insert("cf_inv_bs", &["item1"], [CfInsert::BucketSize(0)])
      .is_err()
  );
  assert!(
    db.cf_insert("cf_inv_page", &["item1"], [CfInsert::PageSize(1)])
      .is_err()
  );

  // CF.COUNT 和 CF.DEL 对不存在的 key
  assert_eq!(db.cf_count("non_existent_cf", "foo")?, 0);
  assert!(!db.cf_del("non_existent_cf", "foo")?);
  assert!(!db.cf_exists("non_existent_cf", "foo")?);
  let mex_none = db.cf_mexists("non_existent_cf", &["a", "b"])?;
  assert_eq!(mex_none, vec![false, false]);

  // CF.INFO 对不存在的 key 报错
  assert!(db.cf_info("non_existent_cf").is_err());

  // 多元素批量插入并发扩容事务一致性测试
  let mut items = Vec::new();
  for i in 0..100 {
    items.push(format!("batch_item_{i}"));
  }

  let insert_res = db.cf_insert(
    "cf_batch",
    &items,
    [
      CfInsert::Capacity(8),
      CfInsert::BucketSize(2),
      CfInsert::MaxIterations(10),
      CfInsert::Expansion(2),
      CfInsert::PageSize(2048),
    ],
  )?;
  assert_eq!(insert_res.len(), 100);
  assert!(insert_res.iter().all(|&ok| ok));

  // 验证所有 100 个元素均可查到
  for item in &items {
    assert!(db.cf_exists("cf_batch", item)?);
  }

  let info = db.cf_info("cf_batch")?;
  assert_eq!(info.size, 100);
  assert!(info.num_filters > 1);

  // 非扩容满过滤器测试(expansion = 0)
  db.cf_reserve(
    "cf_fixed",
    4,
    [
      CfReserve::BucketSize(2),
      CfReserve::MaxIterations(5),
      CfReserve::Expansion(0),
    ],
  )?;
  let mut count = 0;
  for i in 0..100 {
    let it = format!("fixed_{i}");
    if db.cf_add("cf_fixed", it).is_ok() {
      count += 1;
    } else {
      break;
    }
  }
  // 达到容量上限后应报错
  assert!(count > 0 && count < 100);

  Ok(())
}

#[test]
fn test_cuckoo_filter_duplicates_and_binary_items() -> Void {
  let dir = tempdir()?;
  let db = WeDb::new(Fjall::open(dir.path())?).ns(0)?.db(0)?;

  // 1. 重复添加同一元素计数与逐个删除测试
  db.cf_reserve(
    "cf_dup",
    64,
    [
      CfReserve::BucketSize(4),
      CfReserve::MaxIterations(20),
      CfReserve::Expansion(2),
    ],
  )?;
  let dup_target = "same_key_item";

  for count in 1..=5 {
    assert!(db.cf_add("cf_dup", dup_target)?);
    assert_eq!(db.cf_count("cf_dup", dup_target)?, count);
  }

  for expected_left in (0..5).rev() {
    assert!(db.cf_del("cf_dup", dup_target)?);
    assert_eq!(db.cf_count("cf_dup", dup_target)?, expected_left as u64);
  }
  // 全部删除后应不再存在
  assert!(!db.cf_del("cf_dup", dup_target)?);
  assert!(!db.cf_exists("cf_dup", dup_target)?);

  // 2. 二进制项测试
  db.cf_reserve(
    "cf_bin",
    128,
    [
      CfReserve::BucketSize(4),
      CfReserve::MaxIterations(20),
      CfReserve::Expansion(2),
    ],
  )?;
  let bin_items: Vec<Vec<u8>> = vec![
    vec![],
    vec![0u8],
    vec![0u8, 1, 2, 3, 255, 254],
    b"binary_payload_test".to_vec(),
    vec![b'c'; 512],
  ];

  for item in &bin_items {
    assert!(!db.cf_exists("cf_bin", item)?);
    assert!(db.cf_add("cf_bin", item)?);
    assert!(db.cf_exists("cf_bin", item)?);
  }

  let bin_info = db.cf_info("cf_bin")?;
  assert_eq!(bin_info.size, bin_items.len() as u64);

  Ok(())
}

#[test]
fn test_cuckoo_filter_kickout_deep_scaling_and_saturation() -> Void {
  let dir = tempdir()?;
  let db = WeDb::new(Fjall::open(dir.path())?).ns(0)?.db(0)?;

  // 1. 测试容量较小、扩容因子为 2 的连续扩展
  db.cf_reserve(
    "cf_scale_chain",
    4,
    [
      CfReserve::BucketSize(1),
      CfReserve::MaxIterations(1),
      CfReserve::Expansion(2),
    ],
  )?;
  let mut added = 0;
  for i in 0..50 {
    let it = format!("scale_chain_item_{i}");
    if db.cf_add("cf_scale_chain", it).is_ok() {
      added += 1;
    }
  }
  assert_eq!(added, 50);

  let info = db.cf_info("cf_scale_chain")?;
  assert!(info.num_filters > 2);
  assert_eq!(info.size, 50);

  for i in 0..50 {
    let it = format!("scale_chain_item_{i}");
    assert!(db.cf_exists("cf_scale_chain", it)?);
  }

  // 2. 测试非扩容模式(expansion = 0)满载后明确报错
  db.cf_reserve(
    "cf_strict_fixed",
    4,
    [
      CfReserve::BucketSize(1),
      CfReserve::MaxIterations(1),
      CfReserve::Expansion(0),
    ],
  )?;
  let mut full_reached = false;
  for i in 0..50 {
    let it = format!("fixed_item_{i}");
    let res = db.cf_add("cf_strict_fixed", it);
    if res.is_err() {
      full_reached = true;
      break;
    }
  }
  assert!(full_reached, "Non-scaling filter must reject when full");

  Ok(())
}

#[test]
fn test_cuckoo_expired_meta() -> Void {
  let mut meta = CuckooChainMeta::new(1024, 2, 20, 1, 2048, 1, 1000);
  assert!(!meta.is_expired(500));
  assert!(meta.is_expired(1500));

  meta.base.expire_at = 500;
  assert!(meta.is_expired(600));

  Ok(())
}

#[test]
fn test_cuckoo_card_and_point_lookups() -> Void {
  let dir = tempdir()?;
  let db = WeDb::new(Fjall::open(dir.path())?).ns(0)?.db(0)?;

  // Key 不存在时 cf_card 返回 0
  assert_eq!(db.cf_card("cf_card_test")?, 0);
  assert!(!db.cf_exists("cf_card_test", "elem1")?);

  assert!(db.cf_add("cf_card_test", "elem1")?);
  assert!(db.cf_add("cf_card_test", "elem2")?);
  assert_eq!(db.cf_card("cf_card_test")?, 2);

  // 验证 cf_exists 单点探测快路径
  assert!(db.cf_exists("cf_card_test", "elem1")?);
  assert!(db.cf_exists("cf_card_test", "elem2")?);
  assert!(!db.cf_exists("cf_card_test", "non_exist")?);

  // 删除元素后基数更新
  assert!(db.cf_del("cf_card_test", "elem1")?);
  assert_eq!(db.cf_card("cf_card_test")?, 1);
  assert!(!db.cf_exists("cf_card_test", "elem1")?);

  Ok(())
}