wedb_embed 0.1.0

Embedded Kvrocks-compatible storage engine for WeDb
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
use aok::Void;
use tempfile::tempdir;
use wedb_embed::WeDb;
use wedb_embed::string::{
    DelEx, GetEx, Set, StringLCSArgs, StringLCSMatchedRange, StringLCSResult, StringLCSType,
    StringSetArgs, StringSetType, compute_lcs, normalize_range, string_digest,
};

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

#[test]
fn test_string_get_and_set() -> Void {
    let dir = tempdir()?;
    let db = WeDb::open(dir.path())?;

    let pairs = [
        ("test-string-key1", "test-strings-value1"),
        ("test-string-key2", "test-strings-value2"),
        ("test-string-key3", "test-strings-value3"),
        ("test-string-key4", "test-strings-value4"),
        ("test-string-key5", "test-strings-value5"),
        ("test-string-key6", "test-strings-value6"),
    ];

    for (k, v) in pairs {
        db.set(k, v, &[])?;
    }
    for (k, v) in pairs {
        let val = db.get(k)?;
        assert_eq!(val, Some(v.as_bytes().to_vec()));
    }
    for (k, _) in pairs {
        assert_eq!(db.del(&[k])?, 1);
        assert_eq!(db.get(k)?, None);
    }

    Ok(())
}

#[test]
fn test_string_set_options() -> Void {
    let dir = tempdir()?;
    let db = WeDb::open(dir.path())?;

    // NX 选项
    let res = db.set("k1", "v1", &[Set::Nx])?;
    assert_eq!(res, Some(Vec::new()));
    assert_eq!(db.get("k1")?, Some(b"v1".to_vec()));

    let res_nx_fail = db.set("k1", "v2", &[Set::Nx])?;
    assert_eq!(res_nx_fail, None);
    assert_eq!(db.get("k1")?, Some(b"v1".to_vec()));

    // XX 选项
    let res_xx_fail = db.set("k_nonexist", "v", &[Set::Xx])?;
    assert_eq!(res_xx_fail, None);
    assert_eq!(db.get("k_nonexist")?, None);

    let res_xx_ok = db.set("k1", "v_updated", &[Set::Xx])?;
    assert_eq!(res_xx_ok, Some(Vec::new()));
    assert_eq!(db.get("k1")?, Some(b"v_updated".to_vec()));

    // GET 选项
    let old = db.set("k1", "v_new", &[Set::Get])?;
    assert_eq!(old, Some(b"v_updated".to_vec()));
    assert_eq!(db.get("k1")?, Some(b"v_new".to_vec()));

    // IfEq 选项
    let if_eq_fail = db.set("k1", "v_fail", &[Set::IfEq(b"wrong")])?;
    assert_eq!(if_eq_fail, None);
    assert_eq!(db.get("k1")?, Some(b"v_new".to_vec()));

    let if_eq_ok = db.set("k1", "v_pass", &[Set::IfEq(b"v_new")])?;
    assert_eq!(if_eq_ok, Some(Vec::new()));
    assert_eq!(db.get("k1")?, Some(b"v_pass".to_vec()));

    // IfNe 选项
    let if_ne_fail = db.set("k1", "v_ne_fail", &[Set::IfNe(b"v_pass")])?;
    assert_eq!(if_ne_fail, None);

    let if_ne_ok = db.set("k1", "v_ne_ok", &[Set::IfNe(b"other")])?;
    assert_eq!(if_ne_ok, Some(Vec::new()));
    assert_eq!(db.get("k1")?, Some(b"v_ne_ok".to_vec()));

    Ok(())
}

#[test]
fn test_string_append_and_strlen() -> Void {
    let dir = tempdir()?;
    let db = WeDb::open(dir.path())?;

    for i in 0..32 {
        let ret = db.append("test_append_k", "a")?;
        assert_eq!(ret, i + 1);
    }
    assert_eq!(db.strlen("test_append_k")?, 32);
    assert_eq!(db.del(&["test_append_k"])?, 1);
    assert_eq!(db.strlen("test_append_k")?, 0);

    Ok(())
}

#[test]
fn test_string_mget_and_mset() -> Void {
    let dir = tempdir()?;
    let db = WeDb::open(dir.path())?;

    let pairs = [
        ("m_k1", "m_v1"),
        ("m_k2", "m_v2"),
        ("m_k3", "m_v3"),
        ("m_k4", "m_v4"),
    ];

    db.mset(&pairs)?;

    let keys: Vec<&str> = pairs.iter().map(|(k, _)| *k).collect();
    let values = db.mget(&keys)?;
    for (i, (_, v)) in pairs.iter().enumerate() {
        assert_eq!(values[i], Some(v.as_bytes().to_vec()));
    }

    let mixed = db.mget(&["m_k1", "nonexistent_k", "m_k3"])?;
    assert_eq!(
        mixed,
        vec![Some(b"m_v1".to_vec()), None, Some(b"m_v3".to_vec())]
    );

    Ok(())
}

#[test]
fn test_string_incr_and_decr() -> Void {
    let dir = tempdir()?;
    let db = WeDb::open(dir.path())?;

    assert_eq!(db.incr("counter")?, 1);
    assert_eq!(db.incr("counter")?, 2);
    assert_eq!(db.incrby("counter", 10)?, 12);
    assert_eq!(db.decr("counter")?, 11);
    assert_eq!(db.decrby("counter", 5)?, 6);
    assert_eq!(db.incrby("counter", -6)?, 0);

    // 溢出与边界条件测试(对标 Kvrocks IncrBy)
    assert_eq!(db.incrby("counter", i64::MAX)?, i64::MAX);
    assert!(db.incrby("counter", 1).is_err());
    assert_eq!(db.incrby("counter", i64::MIN + 1)?, 0);
    assert_eq!(db.incrby("counter", i64::MIN)?, i64::MIN);
    assert!(db.incrby("counter", -1).is_err());

    // 非数值测试
    db.set("str_k", "abc", &[])?;
    assert!(db.incr("str_k").is_err());
    assert!(db.incrby("str_k", 5).is_err());
    assert!(db.decr("str_k").is_err());

    // 前导空白符测试
    db.set("ws_k", " 123", &[])?;
    assert!(db.incr("ws_k").is_err());
    db.set("ws_k2", "123 ", &[])?;
    assert!(db.incr("ws_k2").is_err());

    Ok(())
}

#[test]
fn test_string_incrbyfloat_stored_format() -> Void {
    let dir = tempdir()?;
    let db = WeDb::open(dir.path())?;

    // 紧凑格式,无末尾多余零
    let f1 = db.incrbyfloat("float_k", 10.5)?;
    assert!((f1 - 10.5).abs() < 1e-9);
    assert_eq!(db.get("float_k")?, Some(b"10.5".to_vec()));

    db.del(&["float_k"])?;

    // 整数形式的浮点不带小数点
    let f2 = db.incrbyfloat("float_k", 3.0)?;
    assert!((f2 - 3.0).abs() < 1e-9);
    assert_eq!(db.get("float_k")?, Some(b"3".to_vec()));

    // 累加
    let f3 = db.incrbyfloat("float_k", 1.5)?;
    assert!((f3 - 4.5).abs() < 1e-9);
    assert_eq!(db.get("float_k")?, Some(b"4.5".to_vec()));

    // 负数与零
    let f4 = db.incrbyfloat("float_k", -4.5)?;
    assert!((f4 - 0.0).abs() < 1e-9);
    assert_eq!(db.get("float_k")?, Some(b"0".to_vec()));

    // NaN / Inf 校验
    assert!(db.incrbyfloat("float_k", f64::NAN).is_err());
    assert!(db.incrbyfloat("float_k", f64::INFINITY).is_err());

    Ok(())
}

#[test]
fn test_string_getrange_and_setrange() -> Void {
    let dir = tempdir()?;
    let db = WeDb::open(dir.path())?;

    db.set("range_k", "Hello World", &[])?;

    assert_eq!(db.getrange("range_k", 0, 4)?, b"Hello");
    assert_eq!(db.getrange("range_k", -5, -1)?, b"World");
    assert_eq!(db.getrange("range_k", 0, -1)?, b"Hello World");
    assert_eq!(db.getrange("range_k", 100, 200)?, b"");
    assert_eq!(db.getrange("range_k", -100, 2)?, b"Hel");
    // 边界条件:负数区间超出字符串头部(如 -20 到 -15),返回空字节
    assert_eq!(db.getrange("range_k", -20, -15)?, b"");
    // 边界条件:start > end,返回空字节
    assert_eq!(db.getrange("range_k", 5, 2)?, b"");

    let new_len = db.setrange("range_k", 6, "Redis")?;
    assert_eq!(new_len, 11);
    assert_eq!(db.get("range_k")?, Some(b"Hello Redis".to_vec()));

    let ext_len = db.setrange("range_k", 12, "Extension")?;
    assert_eq!(ext_len, 21);
    assert_eq!(db.strlen("range_k")?, 21);

    // 不存在 key 时 setrange 空值应直接返回 0 且不写入
    let zero_len = db.setrange("nonexist_range", 0, "")?;
    assert_eq!(zero_len, 0);
    assert_eq!(db.get("nonexist_range")?, None);

    // setrange 偏移量超过 512MB 应当报错
    assert!(
        db.setrange("range_k", 600 * 1024 * 1024, "overflow")
            .is_err()
    );

    Ok(())
}

#[test]
fn test_string_getdel() -> Void {
    let dir = tempdir()?;
    let db = WeDb::open(dir.path())?;

    db.set("gd_k", "gd_v", &[])?;
    assert_eq!(db.getdel("gd_k")?, Some(b"gd_v".to_vec()));
    assert_eq!(db.get("gd_k")?, None);
    assert_eq!(db.getdel("gd_k")?, None);

    Ok(())
}

#[test]
fn test_string_lcs_comprehensive() {
    let (s, e) = normalize_range(0, 5, 10);
    assert_eq!((s, e), (0, 5));
    let (s, e) = normalize_range(-5, -1, 10);
    assert_eq!((s, e), (5, 9));
    let (s, e) = normalize_range(0, -1, 0);
    assert_eq!((s, e), (0, -1));

    // Kvrocks 对标 LCS 测试集:abcdef vs acdf
    let res_str = compute_lcs(
        b"abcdef",
        b"acdf",
        StringLCSArgs {
            lcs_type: StringLCSType::None,
            min_match_len: 0,
        },
    )
    .expect("lcs str failed");
    assert_eq!(res_str, StringLCSResult::Str("acdf".to_string()));

    let res_len = compute_lcs(
        b"abcdef",
        b"acdf",
        StringLCSArgs {
            lcs_type: StringLCSType::Len,
            min_match_len: 0,
        },
    )
    .expect("lcs len failed");
    assert_eq!(res_len, StringLCSResult::Len(4));

    let res_idx = compute_lcs(
        b"abcdef",
        b"acdf",
        StringLCSArgs {
            lcs_type: StringLCSType::Idx,
            min_match_len: 0,
        },
    )
    .expect("lcs idx failed");
    if let StringLCSResult::Idx(idx_res) = res_idx {
        assert_eq!(idx_res.len, 4);
        assert_eq!(idx_res.matches.len(), 3);
        assert_eq!(
            idx_res.matches[0],
            StringLCSMatchedRange::new(5, 5, 3, 3, 1)
        );
        assert_eq!(
            idx_res.matches[1],
            StringLCSMatchedRange::new(2, 3, 1, 2, 2)
        );
        assert_eq!(
            idx_res.matches[2],
            StringLCSMatchedRange::new(0, 0, 0, 0, 1)
        );
    } else {
        panic!("expected Idx result");
    }

    // MinMatchLen 过滤
    let res_idx_min = compute_lcs(
        b"abcdef",
        b"acdf",
        StringLCSArgs {
            lcs_type: StringLCSType::Idx,
            min_match_len: 2,
        },
    )
    .expect("lcs idx min failed");
    if let StringLCSResult::Idx(idx_res) = res_idx_min {
        assert_eq!(idx_res.len, 4);
        assert_eq!(idx_res.matches.len(), 1);
        assert_eq!(
            idx_res.matches[0],
            StringLCSMatchedRange::new(2, 3, 1, 2, 2)
        );
    } else {
        panic!("expected Idx result with min_match_len");
    }
}

#[test]
fn test_string_advanced_kvrocks_features() -> Void {
    let dir = tempdir()?;
    let db = WeDb::open(dir.path())?;

    // GETEX
    db.set("gex", "val", &[])?;
    assert_eq!(db.getex("gex", Some(GetEx::Ex(10)))?, Some(b"val".to_vec()));
    let (_, exp) = db.get_with_expire("gex")?;
    assert!(exp > 0);

    assert_eq!(
        db.getex("gex", Some(GetEx::Persist))?,
        Some(b"val".to_vec())
    );
    let (_, exp_p) = db.get_with_expire("gex")?;
    assert_eq!(exp_p, 0);

    // CAS & CAD
    db.set("cas_k", "v1", &[])?;
    assert_eq!(db.cas("cas_k", "v_wrong", "v2", 0)?, 0);
    assert_eq!(db.cas("cas_k", "v1", "v2", 0)?, 1);
    assert_eq!(db.get("cas_k")?, Some(b"v2".to_vec()));
    assert_eq!(db.cas("cas_missing", "v1", "v2", 0)?, -1);

    assert_eq!(db.cad("cas_k", "v_wrong")?, 0);
    assert_eq!(db.cad("cas_k", "v2")?, 1);
    assert_eq!(db.get("cas_k")?, None);
    assert_eq!(db.cad("cas_missing", "v1")?, -1);

    // DELEX
    db.set("del_k", "secret", &[])?;
    let dig = db.digest("del_k")?.expect("digest failed");
    assert!(!db.delex("del_k", DelEx::IfEq(b"wrong"))?);
    assert!(db.delex("del_k", DelEx::IfDeq(dig.as_bytes()))?);
    assert_eq!(db.get("del_k")?, None);

    // SET IFDEQ / IFDNE
    let d_hello = string_digest(b"hello");
    let set_ifdeq_fail = db.set_args(
        "ifdeq_k",
        "new",
        &StringSetArgs {
            expire: 0,
            set_type: StringSetType::IfDeq,
            get: false,
            keep_ttl: false,
            cmp_value: Some(d_hello.as_bytes()),
        },
    )?;
    assert_eq!(set_ifdeq_fail, None);
    assert_eq!(db.get("ifdeq_k")?, None);

    db.set("ifdeq_k", "hello", &[])?;
    let set_ifdeq_ok = db.set_args(
        "ifdeq_k",
        "new",
        &StringSetArgs {
            expire: 0,
            set_type: StringSetType::IfDeq,
            get: false,
            keep_ttl: false,
            cmp_value: Some(d_hello.as_bytes()),
        },
    )?;
    assert_eq!(set_ifdeq_ok, Some(Vec::new()));
    assert_eq!(db.get("ifdeq_k")?, Some(b"new".to_vec()));

    // MSETNX / MSETEX
    let pairs = [("k_m1", "v_m1"), ("k_m2", "v_m2")];
    assert!(db.msetnx(&pairs)?);
    assert_eq!(db.get("k_m1")?, Some(b"v_m1".to_vec()));

    // MSETNX 存在已有 key 应返回 false 并不执行写入
    let pairs_conflict = [("k_m1", "v_m1_new"), ("k_m3", "v_m3")];
    assert!(!db.msetnx(&pairs_conflict)?);
    assert_eq!(db.get("k_m3")?, None);

    // DELEX 各分支全覆盖
    db.set("del_opt_k", "abc", &[])?;
    assert!(!db.delex("del_opt_k", DelEx::IfEq(b"def"))?);
    assert!(!db.delex("del_opt_k", DelEx::IfNe(b"abc"))?);
    assert!(db.delex("del_opt_k", DelEx::IfNe(b"xyz"))?);
    assert_eq!(db.get("del_opt_k")?, None);

    // MSET_ARGS with keep_ttl
    let now_ms = coarsetime::Clock::now_since_epoch().as_millis();
    db.setex("keep_ttl_1", "v1", now_ms + 60_000)?;
    db.setex("keep_ttl_2", "v2", now_ms + 120_000)?;
    let (_, exp1_before) = db.get_with_expire("keep_ttl_1")?;
    let (_, exp2_before) = db.get_with_expire("keep_ttl_2")?;
    assert!(exp1_before > 0 && exp2_before > 0);

    db.mset_args(
        &[("keep_ttl_1", "v1_updated"), ("keep_ttl_2", "v2_updated")],
        wedb_embed::string::StringMSetArgs {
            expire: 0,
            set_type: StringSetType::None,
            keep_ttl: true,
        },
    )?;
    let (v1_new, exp1_after) = db.get_with_expire("keep_ttl_1")?;
    let (v2_new, exp2_after) = db.get_with_expire("keep_ttl_2")?;
    assert_eq!(v1_new, Some(b"v1_updated".to_vec()));
    assert_eq!(v2_new, Some(b"v2_updated".to_vec()));
    assert_eq!(exp1_after, exp1_before);
    assert_eq!(exp2_after, exp2_before);

    // 二进制安全性测试
    let bin_key = b"\x00\x01\xfe\xff_bin_key";
    let bin_val = b"\xde\xad\xbe\xef";
    db.set(bin_key, bin_val, &[])?;
    assert_eq!(db.get(bin_key)?, Some(bin_val.to_vec()));
    assert_eq!(db.del(&[bin_key])?, 1);
    assert_eq!(db.get(bin_key)?, None);

    Ok(())
}