wavekv 1.0.0

An embeddable, eventually consistent, distributed key-value store with peer-to-peer architecture
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
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
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
use crate::node::Node;
use crate::sync::SyncManager;
use crate::types::{compare_entries, Entry, Metadata};
use std::sync::Arc;
use tokio::time::{sleep, Duration};

#[tokio::test]
async fn test_dynamic_membership() {
    let store = Node::new(1, vec![2, 3]);

    // Initial peers (excluding self)
    let peers = store.read().get_peers();
    assert_eq!(peers.len(), 2);
    assert!(peers.contains(&2));
    assert!(peers.contains(&3));

    // All nodes should include self
    let all_nodes = store.read().get_all_nodes();
    assert_eq!(all_nodes.len(), 3); // self + 2 peers
    assert!(all_nodes.contains(&1));

    // Check peer state
    let peer2_state = store.read().get_peer_state(2).unwrap();
    assert_eq!(peer2_state.local_ack, 0);
    assert_eq!(peer2_state.peer_ack, 0);

    // Add a new peer
    assert!(store.write().add_peer(4).unwrap());
    let peers = store.read().get_peers();
    assert_eq!(peers.len(), 3);
    assert!(peers.contains(&4));

    // Try to add duplicate peer (should fail)
    assert!(!store.write().add_peer(4).unwrap());
    assert_eq!(store.read().get_peers().len(), 3);

    // Try to add self as peer (should fail)
    assert!(!store.write().add_peer(1).unwrap());
    assert_eq!(store.read().get_peers().len(), 3);

    // Remove a peer
    assert!(store.write().remove_peer(3).unwrap());
    let peers = store.read().get_peers();
    assert_eq!(peers.len(), 2);
    assert!(!peers.contains(&3));

    // Try to remove self (should fail)
    assert!(!store.write().remove_peer(1).unwrap());

    // Try to remove non-existent peer (should fail)
    assert!(!store.write().remove_peer(99).unwrap());

    // Get all nodes (should include self)
    let all_nodes = store.read().get_all_nodes();
    assert_eq!(all_nodes.len(), 3); // node 1, 2, 4
    assert!(all_nodes.contains(&1));
    assert!(all_nodes.contains(&2));
    assert!(all_nodes.contains(&4));
}

#[tokio::test]
async fn test_prefix_scan() {
    let store = Node::new(1, vec![]);

    // Insert test data with different prefixes
    store
        .write()
        .put("user:1001:name".to_string(), b"Alice".to_vec())
        .unwrap();
    store
        .write()
        .put("user:1001:age".to_string(), b"25".to_vec())
        .unwrap();
    store
        .write()
        .put("user:1002:name".to_string(), b"Bob".to_vec())
        .unwrap();
    store
        .write()
        .put("user:1002:age".to_string(), b"30".to_vec())
        .unwrap();
    store
        .write()
        .put("product:2001:name".to_string(), b"Laptop".to_vec())
        .unwrap();
    store
        .write()
        .put("product:2001:price".to_string(), b"1000".to_vec())
        .unwrap();

    // Test prefix scan for user:1001
    let user_1001 = store.read().get_by_prefix("user:1001:");
    assert_eq!(user_1001.len(), 2);
    assert_eq!(
        user_1001.get("user:1001:name").unwrap().value,
        Some(b"Alice".to_vec())
    );

    // Test prefix scan for all users
    let all_users = store.read().get_by_prefix("user:");
    assert_eq!(all_users.len(), 4);

    // Test prefix scan for products
    let products = store.read().get_by_prefix("product:");
    assert_eq!(products.len(), 2);

    // Test non-existent prefix
    let empty = store.read().get_by_prefix("order:");
    assert_eq!(empty.len(), 0);
}

#[tokio::test]
async fn test_basic_put_get() {
    let store = Node::new(1, vec![]);

    // Test put
    let item = store
        .write()
        .put("key1".to_string(), b"value1".to_vec())
        .unwrap();
    assert_eq!(item.key, "key1");
    assert_eq!(item.value, Some(b"value1".to_vec()));

    // Test get
    let retrieved = store.read().get("key1");
    assert!(retrieved.is_some());
    let retrieved = retrieved.unwrap();
    assert_eq!(retrieved.key, "key1");
    assert_eq!(retrieved.value, Some(b"value1".to_vec()));

    // Test non-existent key
    let missing = store.read().get("nonexistent");
    assert!(missing.is_none());
}

#[tokio::test]
async fn test_multiple_puts_same_key() {
    let store = Node::new(1, vec![]);

    // First put
    store
        .write()
        .put("key1".to_string(), b"value1".to_vec())
        .unwrap();

    // Second put (should overwrite)
    store
        .write()
        .put("key1".to_string(), b"value2".to_vec())
        .unwrap();

    let retrieved = store.read().get("key1").unwrap();
    assert_eq!(retrieved.value, Some(b"value2".to_vec()));
}

#[tokio::test]
async fn test_delete() {
    let store = Node::new(1, vec![]);

    // Put then delete
    store
        .write()
        .put("key1".to_string(), "value1".to_string())
        .unwrap();
    store.write().delete("key1".to_string()).unwrap();

    // Should return None after delete
    let result = store.read().get("key1");
    assert!(result.is_none());
}

#[tokio::test]
async fn test_item_comparison() {
    let entry1 = Entry::new_put(
        Metadata::new(1, 1, 1000),
        "key1".to_string(),
        b"value1".to_vec(),
    );
    let entry2 = Entry::new_put(
        Metadata::new(2, 2, 2000),
        "key1".to_string(),
        b"value2".to_vec(),
    );

    // entry2 has later timestamp, should be Greater
    assert_eq!(compare_entries(&entry1, &entry2), std::cmp::Ordering::Less);
    assert_eq!(
        compare_entries(&entry2, &entry1),
        std::cmp::Ordering::Greater
    );
}

#[tokio::test]
async fn test_sync_between_stores() {
    let store1 = Arc::new(Node::new(1, vec![2]));
    let store2 = Arc::new(Node::new(2, vec![1]));

    // Store1 creates an item
    let item1 = store1
        .write()
        .put("key1".to_string(), "value1".to_string())
        .unwrap();

    // Sync to store2
    let updated = store2.write().sync(item1.clone()).unwrap();
    assert!(updated);

    // Verify store2 has the item
    let retrieved = store2.read().get("key1");
    assert!(retrieved.is_some());
    assert_eq!(retrieved.unwrap().value, Some(b"value1".to_vec()));
}

#[tokio::test]
async fn test_delete_propagation() {
    let store1 = Arc::new(Node::new(1, vec![2]));
    let store2 = Arc::new(Node::new(2, vec![1]));

    // Both stores have the same key initially
    store1
        .write()
        .put("key1".to_string(), "value1".to_string())
        .unwrap();
    store2
        .write()
        .put("key1".to_string(), "value1".to_string())
        .unwrap();

    // Small delay to ensure different timestamp
    sleep(Duration::from_millis(2)).await;

    // Store1 deletes the key
    store1.write().delete("key1".to_string()).unwrap();

    // Get the tombstone from store1
    let tombstone = store1.read().get_including_tombstones("key1").unwrap();
    assert!(tombstone.value.is_none());

    // Sync tombstone to store2
    store2.write().sync(tombstone).unwrap();

    // Verify store2 also shows the key as deleted
    let result = store2.read().get("key1");
    assert!(result.is_none());
}

#[tokio::test]
async fn test_concurrent_writes_resolution() {
    let store1 = Arc::new(Node::new(1, vec![]));
    let store2 = Arc::new(Node::new(2, vec![]));

    // Simulate concurrent writes with different timestamps
    sleep(Duration::from_millis(10)).await;
    let _item1 = store1
        .write()
        .put("key1".to_string(), "value1".to_string())
        .unwrap();

    sleep(Duration::from_millis(10)).await;
    let item2 = store2
        .write()
        .put("key1".to_string(), "value2".to_string())
        .unwrap();

    // item2 has later timestamp, should win
    store1.write().sync(item2.clone()).unwrap();

    let final_value = store1.read().get("key1").unwrap();
    assert_eq!(final_value.value, Some(b"value2".to_vec()));
}

#[tokio::test]
async fn test_lww_equal_timestamp_tombstone_wins_compare() {
    // Two entries with the same timestamp; tombstone should win
    let put = Entry::new_put(Metadata::new(1, 1, 1234), "k".into(), b"v".to_vec());
    let del = Entry::new_delete(Metadata::new(2, 2, 1234), "k".into());
    assert_eq!(compare_entries(&put, &del), std::cmp::Ordering::Less);
    assert_eq!(compare_entries(&del, &put), std::cmp::Ordering::Greater);
}

#[tokio::test]
async fn test_lww_equal_timestamp_node_id_tie_non_tombstone() {
    // Two non-tombstone entries with equal timestamp; higher node_id wins
    let a = Entry::new_put(Metadata::new(1, 1, 2000), "k".into(), b"a".to_vec());
    let b = Entry::new_put(Metadata::new(2, 2, 2000), "k".into(), b"b".to_vec());
    assert_eq!(compare_entries(&a, &b), std::cmp::Ordering::Less);
    assert_eq!(compare_entries(&b, &a), std::cmp::Ordering::Greater);
}

#[tokio::test]
async fn test_sync_equal_timestamp_tombstone_wins() {
    let store = Node::new(1, vec![]);

    // Start with a put
    let put = Entry::new_put(Metadata::new(1, 1, 1000), "k".into(), b"v".to_vec());
    store.write().sync(put).unwrap();

    // Sync a tombstone with the same timestamp but higher node_id
    let del = Entry::new_delete(Metadata::new(2, 2, 1000), "k".into());
    let updated = store.write().sync(del).unwrap();
    assert!(updated);

    // The tombstone should win
    assert!(store.read().get("k").is_none());
}

#[tokio::test]
async fn test_wal_recovery_equal_timestamp_tombstone_wins() {
    use tempfile::TempDir;

    let temp_dir = TempDir::new().unwrap();
    let wal_path = temp_dir.path();

    // Create store with WAL
    let store = Node::new_with_persistence(1, vec![], wal_path).unwrap();

    // Write some data
    store
        .write()
        .put("key1".to_string(), "value1".to_string())
        .unwrap();
    drop(store);

    // Recover from WAL
    let recovered = Node::new_with_persistence(1, vec![], wal_path).unwrap();
    let item = recovered.read().get("key1").unwrap();
    assert_eq!(item.value, Some(b"value1".to_vec()));
}

#[tokio::test]
async fn test_tombstone_cleanup() {
    let store = Node::new(1, vec![]);

    // Put and delete a key to create a tombstone
    store
        .write()
        .put("key1".to_string(), "value1".to_string())
        .unwrap();
    store.write().delete("key1".to_string()).unwrap();

    // Verify tombstone exists
    assert!(store.read().get_including_tombstones("key1").is_some());
    assert!(store
        .read()
        .get_including_tombstones("key1")
        .unwrap()
        .value
        .is_none());

    // Sleep longer than tombstone TTL
    sleep(Duration::from_secs(2)).await;

    // Clean up expired tombstones
    let removed = store
        .write()
        .cleanup_expired_tombstones(Duration::from_secs(100))
        .unwrap();
    assert_eq!(removed, 0);
    let removed = store
        .write()
        .cleanup_expired_tombstones(Duration::from_secs(0))
        .unwrap();
    assert_eq!(removed, 1);
}

#[tokio::test]
async fn test_log_exchange() {
    use crate::sync::{ExchangeInterface, SyncMessage, SyncResponse};
    use anyhow::Result;

    // Create a simple mock network handler

    #[derive(Clone)]
    struct TestNetworkHandler {
        target_store: Node,
    }

    impl ExchangeInterface for TestNetworkHandler {
        async fn sync_to(
            &self,
            _node: &Node,
            _peer: u32,
            msg: SyncMessage,
        ) -> Result<SyncResponse> {
            let store = self.target_store.clone();
            store.write().apply_pushed_entries(msg.clone())?;
            // Determine what to send back
            let (entries, is_snapshot) = match store.read().get_peer_missing_logs(&msg.sender_ack) {
                Some(entries) => (entries, false),
                None => (store.read().kv_to_log_entries(), true),
            };
            let progress = store.read().get_local_ack();
            let peer_id = store.read().id;
            Ok(SyncResponse {
                entries,
                is_snapshot,
                progress,
                peer_id,
            })
        }
    }

    let store1 = Node::new(1, vec![2]);
    let store2 = Node::new(2, vec![1]);

    // Store1 writes some data
    store1
        .write()
        .put("key1".to_string(), "value1".to_string())
        .unwrap();
    store1
        .write()
        .put("key2".to_string(), b"value2".to_vec())
        .unwrap();

    // Create sync managers
    let network1 = TestNetworkHandler {
        target_store: store2.clone(),
    };
    let sync1 = SyncManager::new(store1.clone(), network1);

    // Manually trigger log exchange
    let msg = SyncMessage {
        sender_id: store1.read().id,
        sender_uuid: vec![],
        sender_ack: store1.read().get_local_ack(),
        entries: vec![], // Store1 has entries but we're testing the response
    };
    let response = sync1.handle_sync(msg).unwrap();

    // Verify response contains entries
    match response {
        SyncResponse {
            entries,
            is_snapshot,
            progress,
            peer_id: _,
        } => {
            // Store1 has progress (itself), so this should be incremental
            assert!(!is_snapshot);
            assert_eq!(entries.len(), 0); // Store2 has no data to send back
            assert!(progress.contains_key(&2)); // Store2 should report its progress
        }
    }
}

#[tokio::test]
async fn test_wal_persistence() {
    use tempfile::TempDir;

    // Create a temporary directory for WAL files
    let temp_dir = TempDir::new().unwrap();
    let wal_path = temp_dir.path();

    // Create store with persistence
    {
        let store = Node::new_with_persistence(1, vec![], wal_path).unwrap();

        // Write some data
        store
            .write()
            .put("key1".to_string(), "value1".to_string())
            .unwrap();
        store
            .write()
            .put("key2".to_string(), b"value2".to_vec())
            .unwrap();
        store.write().delete("key1".to_string()).unwrap();
    } // Drop store to close WAL

    // Recreate store from same WAL path
    {
        let recovered_store = Node::new_with_persistence(1, vec![], wal_path).unwrap();

        // Verify data
        let key1 = recovered_store.read().get("key1");
        assert!(key1.is_none()); // Was deleted

        let key2 = recovered_store.read().get("key2");
        assert!(key2.is_some());
        assert_eq!(key2.unwrap().value, Some(b"value2".to_vec()));
    }
}

#[tokio::test]
async fn test_origin_seq_preservation() {
    // Test that seq and node_id are preserved end-to-end through sync
    let store1 = Arc::new(Node::new(1, vec![2]));
    let store2 = Arc::new(Node::new(2, vec![1]));

    // Store1 creates entries
    let entry1 = store1
        .write()
        .put("key1".to_string(), "value1".to_string())
        .unwrap();
    assert_eq!(entry1.meta.seq, 1);

    let entry2 = store1
        .write()
        .put("key2".to_string(), "value2".to_string())
        .unwrap();
    assert_eq!(entry2.meta.seq, 2);

    // Sync to store2
    store2.write().sync(entry1.clone()).unwrap();
    store2.write().sync(entry2.clone()).unwrap();

    // Verify seq and node_id preserved
    let retrieved1 = store2.read().get_including_tombstones("key1").unwrap();
    assert_eq!(retrieved1.meta.seq, 1);
    assert_eq!(retrieved1.meta.node, 1);

    let retrieved2 = store2.read().get_including_tombstones("key2").unwrap();
    assert_eq!(retrieved2.meta.seq, 2);
    assert_eq!(retrieved2.meta.node, 1);
}

#[tokio::test]
async fn test_wal_recovery_lww() {
    use tempfile::TempDir;

    // Create a temporary directory for WAL files
    let temp_dir = TempDir::new().unwrap();
    let wal_path = temp_dir.path();

    {
        let store = Node::new_with_persistence(1, vec![], wal_path).unwrap();

        // Simply write two values - second write should persist
        store
            .write()
            .put("key1".to_string(), "value1".to_string())
            .unwrap();
        sleep(Duration::from_millis(10)).await; // Ensure different timestamps
        store
            .write()
            .put("key1".to_string(), "value2".to_string())
            .unwrap();
    }

    // Recover - should get the last written value
    let recovered_store = Node::new_with_persistence(1, vec![], wal_path).unwrap();

    let item = recovered_store.read().get("key1").unwrap();
    assert_eq!(item.value, Some(b"value2".to_vec()));
}

#[tokio::test]
async fn test_get_missing_log_entries() {
    let store = Node::new(1, vec![2]);

    // Add some entries
    store
        .write()
        .put("key1".to_string(), "value1".to_string())
        .unwrap();
    store
        .write()
        .put("key2".to_string(), "value2".to_string())
        .unwrap();
    store
        .write()
        .put("key3".to_string(), b"value3".to_vec())
        .unwrap();

    // Simulate peer progress
    let mut peer_progress = std::collections::HashMap::new();
    peer_progress.insert(1, 1_u64); // Peer has up to seq 1 from node 1

    // Get missing entries
    let missing = store.read().get_peer_missing_logs(&peer_progress).unwrap();

    // Should have 2 missing entries (seq 2 and 3)
    assert_eq!(missing.len(), 2);
}

#[tokio::test]
async fn test_kv_to_log_entries() {
    let store = Node::new(1, vec![]);

    // Add some data
    store
        .write()
        .put("key1".to_string(), "value1".to_string())
        .unwrap();
    store
        .write()
        .put("key2".to_string(), "value2".to_string())
        .unwrap();
    store.write().delete("key3".to_string()).unwrap();

    // Convert to log entries
    let entries = store.read().kv_to_log_entries();

    // Should have 3 entries
    assert_eq!(entries.len(), 3);
}

#[tokio::test]
async fn test_sync_config_defaults() {
    use crate::sync::SyncConfig;

    let config = SyncConfig::default();
    assert_eq!(config.interval, Duration::from_secs(30));
    assert_eq!(config.timeout, Duration::from_secs(10));
}

#[tokio::test]
async fn test_sync_manager_with_config() {
    use crate::sync::{ExchangeInterface, SyncConfig, SyncMessage, SyncResponse};
    use anyhow::Result;

    #[derive(Clone)]
    struct TestNetwork {
        target: Node,
    }

    impl ExchangeInterface for TestNetwork {
        async fn sync_to(
            &self,
            _node: &Node,
            _peer: u32,
            msg: SyncMessage,
        ) -> Result<SyncResponse> {
            self.target.write().apply_pushed_entries(msg.clone())?;
            let (entries, is_snapshot) =
                match self.target.read().get_peer_missing_logs(&msg.sender_ack) {
                    Some(e) => (e, false),
                    None => (self.target.read().kv_to_log_entries(), true),
                };
            Ok(SyncResponse {
                peer_id: self.target.read().id,
                entries,
                progress: self.target.read().get_local_ack(),
                is_snapshot,
            })
        }
    }

    let store1 = Node::new(1, vec![2]);
    let store2 = Node::new(2, vec![1]);

    let config = SyncConfig {
        interval: Duration::from_millis(100),
        timeout: Duration::from_secs(5),
    };

    let network = TestNetwork {
        target: store2.clone(),
    };
    let sync = SyncManager::with_config(store1.clone(), network, config);

    // Write data and verify sync works
    store1
        .write()
        .put("key".to_string(), "value".to_string())
        .unwrap();

    let msg = SyncMessage {
        sender_id: 1,
        sender_uuid: vec![],
        sender_ack: store1.read().get_local_ack(),
        entries: vec![],
    };
    let response = sync.handle_sync(msg).unwrap();
    assert!(!response.is_snapshot);
}

#[tokio::test]
async fn test_sync_timeout() {
    use crate::sync::{ExchangeInterface, SyncConfig, SyncMessage, SyncResponse};
    use anyhow::Result;
    use std::sync::Arc;

    #[derive(Clone)]
    struct SlowNetwork {
        delay: Duration,
        target: Node,
    }

    impl ExchangeInterface for SlowNetwork {
        async fn sync_to(
            &self,
            _node: &Node,
            _peer: u32,
            msg: SyncMessage,
        ) -> Result<SyncResponse> {
            sleep(self.delay).await;
            self.target.write().apply_pushed_entries(msg.clone())?;
            Ok(SyncResponse {
                peer_id: self.target.read().id,
                entries: vec![],
                progress: self.target.read().get_local_ack(),
                is_snapshot: false,
            })
        }
    }

    let store1 = Node::new(1, vec![2]);
    let store2 = Node::new(2, vec![1]);

    // Set a very short timeout
    let config = SyncConfig {
        interval: Duration::from_secs(30),
        timeout: Duration::from_millis(50),
    };

    // Network delays longer than timeout
    let network = SlowNetwork {
        delay: Duration::from_millis(200),
        target: store2.clone(),
    };

    let sync = Arc::new(SyncManager::with_config(store1.clone(), network, config));

    // Write some data so there's something to sync
    store1
        .write()
        .put("key".to_string(), "value".to_string())
        .unwrap();

    // Bootstrap should fail due to timeout (but not panic)
    let result = sync.bootstrap().await;
    // Bootstrap doesn't propagate individual peer errors as Result::Err,
    // it just logs warnings and continues
    assert!(result.is_ok());
}