saku-storage 0.4.0

Shared storage infrastructure for the saku ecosystem
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
use std::cmp::Ordering;
use std::collections::HashMap;

use serde::{Deserialize, Serialize};
use serde_json::Value;

use crate::entity::EntitySchema;

/// On-disk KV store format. Replaces the old array-based StoredStore.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct KvStore {
    pub version: u32,
    pub entries: HashMap<String, Value>,
}

impl KvStore {
    pub fn new(version: u32) -> Self {
        Self {
            version,
            entries: HashMap::new(),
        }
    }
}

/// Compare two JSON values by their `modified_at` hybrid timestamp.
///
/// Extracts `modified_at.{wall_ms, lamport, device_id}` from each value
/// and compares them in order: wall_ms > lamport > device_id.
/// Returns `Ordering::Equal` if either value lacks `modified_at`.
pub fn compare_modified_at(a: &Value, b: &Value) -> Ordering {
    fn extract(v: &Value) -> Option<(i64, u64, &str)> {
        let m = v.get("modified_at")?;
        let wall_ms = m.get("wall_ms")?.as_i64()?;
        let lamport = m.get("lamport")?.as_u64()?;
        let device_id = m.get("device_id")?.as_str()?;
        Some((wall_ms, lamport, device_id))
    }

    match (extract(a), extract(b)) {
        (Some(a_ts), Some(b_ts)) => a_ts.cmp(&b_ts),
        _ => Ordering::Equal,
    }
}

/// Generic last-writer-wins merge on KV entries.
///
/// For each key present in both stores, the entry with the higher
/// `modified_at` timestamp wins. Keys present in only one store
/// are included as-is. Tombstoned entries participate normally —
/// they win if their `modified_at` is higher.
pub fn lww_merge_kv(local: &KvStore, remote: &KvStore) -> KvStore {
    let mut merged = local.entries.clone();

    for (key, remote_value) in &remote.entries {
        match merged.get(key) {
            Some(local_value) => {
                if compare_modified_at(remote_value, local_value) == Ordering::Greater {
                    merged.insert(key.clone(), remote_value.clone());
                }
            }
            None => {
                merged.insert(key.clone(), remote_value.clone());
            }
        }
    }

    KvStore {
        version: local.version.max(remote.version),
        entries: merged,
    }
}

/// Reconcile renames by following `renamed_to` chains.
///
/// When an entry is a tombstone with `renamed_to`, the target entry
/// should exist. If two devices rename the same entity to different
/// names concurrently, the one with the higher `modified_at` on its
/// tombstone wins. The losing rename's target is itself tombstoned
/// and its references redirected to the winner.
///
/// Chain depth is capped at 10 to prevent infinite loops.
pub fn reconcile_renames(store: &mut KvStore) {
    const MAX_CHAIN_DEPTH: usize = 10;

    // Collect all tombstones with renamed_to
    let rename_tombstones: Vec<(String, String, Value)> = store
        .entries
        .iter()
        .filter(|(_, v)| v.get("deleted_at").is_some() && v.get("renamed_to").is_some())
        .map(|(k, v)| {
            let target = v["renamed_to"].as_str().unwrap_or("").to_string();
            (k.clone(), target, v.clone())
        })
        .collect();

    // Group tombstones by their original key (previous_key on the target)
    // to detect concurrent renames of the same entity
    let mut renames_by_source: HashMap<String, Vec<(String, String, Value)>> = HashMap::new();
    for (old_key, new_key, tombstone) in &rename_tombstones {
        // The "source" is the old_key itself — multiple tombstones for
        // the same old_key means concurrent renames
        renames_by_source
            .entry(old_key.clone())
            .or_default()
            .push((old_key.clone(), new_key.clone(), tombstone.clone()));
    }

    // For concurrent renames (same source, different targets), pick winner
    for renames in renames_by_source.values() {
        if renames.len() <= 1 {
            continue;
        }

        // Pick the rename with the highest modified_at on the tombstone
        let winner = renames
            .iter()
            .max_by(|a, b| compare_modified_at(&a.2, &b.2))
            .unwrap();

        // Loser renames: tombstone their targets and redirect to winner's target
        for rename in renames {
            if rename.1 == winner.1 {
                continue;
            }
            let loser_target_key = &rename.1;
            if let Some(loser_target) = store.entries.get_mut(loser_target_key) {
                // Tombstone the loser's target and point it to the winner
                loser_target["deleted_at"] = winner.2["deleted_at"].clone();
                loser_target["renamed_to"] = Value::String(winner.1.clone());
            }
            // Update the loser tombstone to also point to winner's target
            if let Some(loser_tombstone) = store.entries.get_mut(&rename.0) {
                loser_tombstone["renamed_to"] = Value::String(winner.1.clone());
            }
        }
    }

    // Resolve rename chains: follow renamed_to until we reach a live entry
    let keys: Vec<String> = store
        .entries
        .keys()
        .filter(|k| {
            let v = &store.entries[*k];
            v.get("deleted_at").is_some() && v.get("renamed_to").is_some()
        })
        .cloned()
        .collect();

    for key in keys {
        let mut current = key.clone();
        let mut depth = 0;
        let mut final_target = None;

        while depth < MAX_CHAIN_DEPTH {
            if let Some(entry) = store.entries.get(&current) {
                if let Some(target) = entry.get("renamed_to").and_then(|v| v.as_str()) {
                    let target = target.to_string();
                    if target == current {
                        break; // Self-reference, stop
                    }
                    current = target;
                    depth += 1;
                } else {
                    final_target = Some(current.clone());
                    break;
                }
            } else {
                break;
            }
        }

        // If the chain resolved and the final target differs from the
        // immediate renamed_to, update the tombstone to point directly
        // to the final target (shortcut the chain).
        if let Some(final_key) = final_target
            && let Some(entry) = store.entries.get_mut(&key)
            && let Some(renamed_to) = entry.get("renamed_to").and_then(|v| v.as_str())
            && renamed_to != final_key
        {
            entry["renamed_to"] = Value::String(final_key);
        }
    }
}

/// Repair dangling references by following `renamed_to` chains in tombstones.
///
/// For each entity type in the schemas, scan all entries for reference
/// fields that point to tombstoned keys. Follow the `renamed_to` chain
/// to find the live target and update the reference.
pub fn repair_references(store: &mut KvStore, schemas: &[EntitySchema]) {
    const MAX_CHAIN_DEPTH: usize = 10;

    // Build a map of old_key → final_target for all rename tombstones
    let mut rename_map: HashMap<String, String> = HashMap::new();
    for (key, value) in &store.entries {
        if value.get("deleted_at").is_some()
            && let Some(target) = value.get("renamed_to").and_then(|v| v.as_str())
        {
            rename_map.insert(key.clone(), target.to_string());
        }
    }

    // Resolve chains in the rename map
    let keys: Vec<String> = rename_map.keys().cloned().collect();
    for key in keys {
        let mut current = rename_map[&key].clone();
        let mut depth = 0;
        while depth < MAX_CHAIN_DEPTH {
            if let Some(next) = rename_map.get(&current) {
                if *next == current {
                    break;
                }
                current = next.clone();
                depth += 1;
            } else {
                break;
            }
        }
        rename_map.insert(key, current);
    }

    if rename_map.is_empty() {
        return;
    }

    // For each schema, check all entries of that type for dangling references
    for schema in schemas {
        let prefix = format!("{}/", schema.entity_type);
        let entry_keys: Vec<String> = store
            .entries
            .keys()
            .filter(|k| k.starts_with(&prefix))
            .cloned()
            .collect();

        for entry_key in entry_keys {
            let mut changed = false;
            let mut entry = store.entries[&entry_key].clone();

            for (field_name, _target_type) in &schema.references {
                // Handle single-value references
                if let Some(ref_value) = entry.get(*field_name).and_then(|v| v.as_str()) {
                    if let Some(new_target) = rename_map.get(ref_value) {
                        entry[*field_name] = Value::String(new_target.clone());
                        changed = true;
                    }
                }
                // Handle array references (e.g., depends_on)
                else if let Some(arr) = entry.get(*field_name).and_then(|v| v.as_array()) {
                    let mut new_arr = arr.clone();
                    let mut arr_changed = false;
                    for item in &mut new_arr {
                        if let Some(ref_str) = item.as_str()
                            && let Some(new_target) = rename_map.get(ref_str)
                        {
                            *item = Value::String(new_target.clone());
                            arr_changed = true;
                        }
                    }
                    if arr_changed {
                        entry[*field_name] = Value::Array(new_arr);
                        changed = true;
                    }
                }
            }

            if changed {
                store.entries.insert(entry_key, entry);
            }
        }
    }
}

/// Remove tombstones older than `max_age_days`.
///
/// A tombstone is an entry with `deleted_at` set. If `modified_at.wall_ms`
/// is older than `now_ms - max_age_days * 86400000`, it is removed.
pub fn gc_tombstones(store: &mut KvStore, max_age_days: u32, now_ms: i64) {
    let cutoff_ms = now_ms - (max_age_days as i64) * 86_400_000;

    store.entries.retain(|_key, value| {
        // Keep non-tombstones
        if value.get("deleted_at").is_none() {
            return true;
        }
        // Keep tombstones that are recent enough
        if let Some(modified_at) = value.get("modified_at")
            && let Some(wall_ms) = modified_at.get("wall_ms").and_then(|v| v.as_i64())
        {
            return wall_ms >= cutoff_ms;
        }
        // No modified_at → keep (can't determine age)
        true
    });
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;

    fn make_entry(wall_ms: i64, lamport: u64, device_id: &str) -> Value {
        json!({
            "name": "test",
            "modified_at": {
                "wall_ms": wall_ms,
                "lamport": lamport,
                "device_id": device_id
            }
        })
    }

    fn make_tombstone(wall_ms: i64, lamport: u64, device_id: &str) -> Value {
        json!({
            "name": "test",
            "deleted_at": "2026-01-01T00:00:00Z",
            "modified_at": {
                "wall_ms": wall_ms,
                "lamport": lamport,
                "device_id": device_id
            }
        })
    }

    fn make_rename_tombstone(
        wall_ms: i64,
        lamport: u64,
        device_id: &str,
        renamed_to: &str,
    ) -> Value {
        json!({
            "name": "test",
            "deleted_at": "2026-01-01T00:00:00Z",
            "renamed_to": renamed_to,
            "modified_at": {
                "wall_ms": wall_ms,
                "lamport": lamport,
                "device_id": device_id
            }
        })
    }

    // ── compare_modified_at ──

    #[test]
    fn compare_modified_at_higher_wall_ms_wins() {
        let a = make_entry(2000, 1, "dev-a");
        let b = make_entry(1000, 1, "dev-a");
        assert_eq!(compare_modified_at(&a, &b), Ordering::Greater);
    }

    #[test]
    fn compare_modified_at_equal_timestamps() {
        let a = make_entry(1000, 1, "dev-a");
        let b = make_entry(1000, 1, "dev-a");
        assert_eq!(compare_modified_at(&a, &b), Ordering::Equal);
    }

    #[test]
    fn compare_modified_at_missing_field_returns_equal() {
        let a = json!({"name": "test"});
        let b = make_entry(1000, 1, "dev-a");
        assert_eq!(compare_modified_at(&a, &b), Ordering::Equal);
    }

    // ── lww_merge_kv ──

    #[test]
    fn lww_merge_kv_same_key_higher_wins() {
        let local = KvStore {
            version: 9,
            entries: HashMap::from([("project/website".into(), make_entry(1000, 1, "dev-a"))]),
        };
        let remote = KvStore {
            version: 9,
            entries: HashMap::from([("project/website".into(), make_entry(2000, 1, "dev-b"))]),
        };

        let merged = lww_merge_kv(&local, &remote);
        let entry = &merged.entries["project/website"];
        assert_eq!(
            entry["modified_at"]["wall_ms"].as_i64().unwrap(),
            2000,
            "remote with higher wall_ms should win"
        );
    }

    #[test]
    fn lww_merge_kv_same_key_local_wins_when_newer() {
        let local = KvStore {
            version: 9,
            entries: HashMap::from([("project/website".into(), make_entry(3000, 1, "dev-a"))]),
        };
        let remote = KvStore {
            version: 9,
            entries: HashMap::from([("project/website".into(), make_entry(2000, 1, "dev-b"))]),
        };

        let merged = lww_merge_kv(&local, &remote);
        let entry = &merged.entries["project/website"];
        assert_eq!(entry["modified_at"]["wall_ms"].as_i64().unwrap(), 3000);
    }

    #[test]
    fn lww_merge_kv_new_keys_from_both_sides() {
        let local = KvStore {
            version: 9,
            entries: HashMap::from([("project/alpha".into(), make_entry(1000, 1, "dev-a"))]),
        };
        let remote = KvStore {
            version: 9,
            entries: HashMap::from([("project/beta".into(), make_entry(1000, 1, "dev-b"))]),
        };

        let merged = lww_merge_kv(&local, &remote);
        assert!(merged.entries.contains_key("project/alpha"));
        assert!(merged.entries.contains_key("project/beta"));
        assert_eq!(merged.entries.len(), 2);
    }

    #[test]
    fn lww_merge_kv_tombstone_wins_over_live_when_newer() {
        let local = KvStore {
            version: 9,
            entries: HashMap::from([("project/old".into(), make_entry(1000, 1, "dev-a"))]),
        };
        let remote = KvStore {
            version: 9,
            entries: HashMap::from([("project/old".into(), make_tombstone(2000, 1, "dev-a"))]),
        };

        let merged = lww_merge_kv(&local, &remote);
        let entry = &merged.entries["project/old"];
        assert!(entry.get("deleted_at").is_some(), "tombstone should win");
    }

    #[test]
    fn lww_merge_kv_live_wins_over_tombstone_when_newer() {
        let local = KvStore {
            version: 9,
            entries: HashMap::from([("project/old".into(), make_entry(3000, 1, "dev-a"))]),
        };
        let remote = KvStore {
            version: 9,
            entries: HashMap::from([("project/old".into(), make_tombstone(2000, 1, "dev-a"))]),
        };

        let merged = lww_merge_kv(&local, &remote);
        let entry = &merged.entries["project/old"];
        assert!(
            entry.get("deleted_at").is_none(),
            "live entry should win when newer"
        );
    }

    #[test]
    fn lww_merge_kv_picks_higher_version() {
        let local = KvStore {
            version: 8,
            entries: HashMap::new(),
        };
        let remote = KvStore {
            version: 9,
            entries: HashMap::new(),
        };
        let merged = lww_merge_kv(&local, &remote);
        assert_eq!(merged.version, 9);
    }

    // ── reconcile_renames ──

    #[test]
    fn reconcile_renames_single_rename_is_noop() {
        let mut store = KvStore {
            version: 9,
            entries: HashMap::from([
                (
                    "project/website".into(),
                    make_rename_tombstone(2000, 1, "dev-a", "project/blog"),
                ),
                ("project/blog".into(), make_entry(2000, 2, "dev-a")),
            ]),
        };

        reconcile_renames(&mut store);

        // Single rename: no changes needed
        assert_eq!(
            store.entries["project/website"]["renamed_to"]
                .as_str()
                .unwrap(),
            "project/blog"
        );
        assert!(store.entries["project/blog"]
            .get("deleted_at")
            .is_none());
    }

    #[test]
    fn reconcile_renames_chain_gets_shortcut() {
        let mut store = KvStore {
            version: 9,
            entries: HashMap::from([
                (
                    "project/a".into(),
                    make_rename_tombstone(1000, 1, "dev-a", "project/b"),
                ),
                (
                    "project/b".into(),
                    make_rename_tombstone(2000, 1, "dev-a", "project/c"),
                ),
                ("project/c".into(), make_entry(3000, 1, "dev-a")),
            ]),
        };

        reconcile_renames(&mut store);

        // project/a should now point directly to project/c
        assert_eq!(
            store.entries["project/a"]["renamed_to"]
                .as_str()
                .unwrap(),
            "project/c"
        );
    }

    // ── repair_references ──

    #[test]
    fn repair_references_fixes_dangling_single_ref() {
        let mut store = KvStore {
            version: 9,
            entries: HashMap::from([
                (
                    "project/old".into(),
                    make_rename_tombstone(2000, 1, "dev-a", "project/new"),
                ),
                ("project/new".into(), make_entry(2000, 2, "dev-a")),
                (
                    "task/abc123".into(),
                    json!({
                        "title": "Fix bug",
                        "project_key": "project/old",
                        "modified_at": { "wall_ms": 1500, "lamport": 1, "device_id": "dev-b" }
                    }),
                ),
            ]),
        };

        let schemas = vec![EntitySchema {
            entity_type: "task",
            references: vec![("project_key", "project")],
        }];

        repair_references(&mut store, &schemas);

        assert_eq!(
            store.entries["task/abc123"]["project_key"]
                .as_str()
                .unwrap(),
            "project/new"
        );
    }

    #[test]
    fn repair_references_fixes_array_refs() {
        let mut store = KvStore {
            version: 9,
            entries: HashMap::from([
                (
                    "task/old1".into(),
                    make_rename_tombstone(2000, 1, "dev-a", "task/new1"),
                ),
                ("task/new1".into(), make_entry(2000, 2, "dev-a")),
                (
                    "task/abc".into(),
                    json!({
                        "title": "Depends on old",
                        "depends_on": ["task/old1", "task/other"],
                        "modified_at": { "wall_ms": 1500, "lamport": 1, "device_id": "dev-b" }
                    }),
                ),
            ]),
        };

        let schemas = vec![EntitySchema {
            entity_type: "task",
            references: vec![("depends_on", "task")],
        }];

        repair_references(&mut store, &schemas);

        let deps = store.entries["task/abc"]["depends_on"]
            .as_array()
            .unwrap();
        assert_eq!(deps[0].as_str().unwrap(), "task/new1");
        assert_eq!(deps[1].as_str().unwrap(), "task/other");
    }

    #[test]
    fn repair_references_follows_chain() {
        let mut store = KvStore {
            version: 9,
            entries: HashMap::from([
                (
                    "project/a".into(),
                    make_rename_tombstone(1000, 1, "dev-a", "project/b"),
                ),
                (
                    "project/b".into(),
                    make_rename_tombstone(2000, 1, "dev-a", "project/c"),
                ),
                ("project/c".into(), make_entry(3000, 1, "dev-a")),
                (
                    "task/t1".into(),
                    json!({
                        "title": "Old ref",
                        "project_key": "project/a",
                        "modified_at": { "wall_ms": 500, "lamport": 1, "device_id": "dev-b" }
                    }),
                ),
            ]),
        };

        let schemas = vec![EntitySchema {
            entity_type: "task",
            references: vec![("project_key", "project")],
        }];

        repair_references(&mut store, &schemas);

        assert_eq!(
            store.entries["task/t1"]["project_key"].as_str().unwrap(),
            "project/c"
        );
    }

    #[test]
    fn repair_references_no_renames_is_noop() {
        let mut store = KvStore {
            version: 9,
            entries: HashMap::from([
                ("project/web".into(), make_entry(1000, 1, "dev-a")),
                (
                    "task/t1".into(),
                    json!({
                        "title": "Valid ref",
                        "project_key": "project/web",
                        "modified_at": { "wall_ms": 500, "lamport": 1, "device_id": "dev-a" }
                    }),
                ),
            ]),
        };

        let schemas = vec![EntitySchema {
            entity_type: "task",
            references: vec![("project_key", "project")],
        }];

        repair_references(&mut store, &schemas);

        assert_eq!(
            store.entries["task/t1"]["project_key"].as_str().unwrap(),
            "project/web"
        );
    }

    // ── gc_tombstones ──

    #[test]
    fn gc_tombstones_removes_old_tombstones() {
        let now_ms = 1_000_000_000_000i64; // some timestamp
        let old_ms = now_ms - 31 * 86_400_000; // 31 days ago
        let recent_ms = now_ms - 5 * 86_400_000; // 5 days ago

        let mut store = KvStore {
            version: 9,
            entries: HashMap::from([
                ("project/old".into(), make_tombstone(old_ms, 1, "dev-a")),
                (
                    "project/recent".into(),
                    make_tombstone(recent_ms, 1, "dev-a"),
                ),
                ("project/live".into(), make_entry(1000, 1, "dev-a")),
            ]),
        };

        gc_tombstones(&mut store, 30, now_ms);

        assert!(
            !store.entries.contains_key("project/old"),
            "old tombstone should be removed"
        );
        assert!(
            store.entries.contains_key("project/recent"),
            "recent tombstone should be kept"
        );
        assert!(
            store.entries.contains_key("project/live"),
            "live entry should be kept"
        );
    }

    #[test]
    fn gc_tombstones_keeps_all_when_young() {
        let now_ms = 1_000_000_000_000i64;
        let recent_ms = now_ms - 1 * 86_400_000; // 1 day ago

        let mut store = KvStore {
            version: 9,
            entries: HashMap::from([(
                "project/deleted".into(),
                make_tombstone(recent_ms, 1, "dev-a"),
            )]),
        };

        gc_tombstones(&mut store, 30, now_ms);

        assert!(store.entries.contains_key("project/deleted"));
    }
}