kanban-persistence 0.7.0

Persistence traits and shared types for the kanban project management tool
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

use super::helpers::fully_populated_snapshot;
use super::StoreFactory;
use crate::{PersistenceError, PersistenceMetadata, StoreSnapshot};
use kanban_domain::Snapshot;
use tempfile::TempDir;

fn to_snapshot_bytes(snapshot: &Snapshot) -> Vec<u8> {
    serde_json::to_vec(snapshot).expect("snapshot must serialize")
}

pub async fn test_roundtrip_empty_snapshot(factory: &StoreFactory) {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("test.store");
    let store = factory(&path);

    let original = Snapshot::default();
    store
        .save(StoreSnapshot {
            data: to_snapshot_bytes(&original),
            metadata: PersistenceMetadata::new(store.instance_id()),
        })
        .await
        .unwrap();

    let (loaded_snap, _) = store.load().await.unwrap();
    let loaded: Snapshot = serde_json::from_slice(&loaded_snap.data).unwrap();
    assert_eq!(original, loaded);
}

pub async fn test_roundtrip_fully_populated_snapshot(factory: &StoreFactory) {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("test.store");
    let store = factory(&path);

    let original = fully_populated_snapshot();
    store
        .save(StoreSnapshot {
            data: to_snapshot_bytes(&original),
            metadata: PersistenceMetadata::new(store.instance_id()),
        })
        .await
        .unwrap();

    let (loaded_snap, _) = store.load().await.unwrap();
    let loaded: Snapshot = serde_json::from_slice(&loaded_snap.data).unwrap();
    assert_eq!(original, loaded);
}

pub async fn test_save_then_exists_returns_true(factory: &StoreFactory) {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("test.store");
    let store = factory(&path);

    store
        .save(StoreSnapshot {
            data: to_snapshot_bytes(&Snapshot::default()),
            metadata: PersistenceMetadata::new(store.instance_id()),
        })
        .await
        .unwrap();
    assert!(store.exists().await);
}

pub async fn test_exists_is_false_before_first_save(factory: &StoreFactory) {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("test.store");
    let store = factory(&path);
    assert!(!store.exists().await);
}

pub async fn test_load_returns_metadata_increment_after_save(factory: &StoreFactory) {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("test.store");
    let store = factory(&path);

    let before = chrono::Utc::now();
    // Some filesystems have coarse mtime granularity; sleep to force a
    // measurable gap between `before` and the saved_at timestamp.
    tokio::time::sleep(std::time::Duration::from_millis(10)).await;

    store
        .save(StoreSnapshot {
            data: to_snapshot_bytes(&Snapshot::default()),
            metadata: PersistenceMetadata::new(store.instance_id()),
        })
        .await
        .unwrap();

    let (_, metadata) = store.load().await.unwrap();
    assert!(
        metadata.saved_at >= before,
        "expected saved_at ({}) >= before ({})",
        metadata.saved_at,
        before
    );
}

pub async fn test_save_with_stale_metadata_returns_conflict(factory: &StoreFactory) {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("test.store");

    let store_a = factory(&path);
    store_a
        .save(StoreSnapshot {
            data: to_snapshot_bytes(&Snapshot::default()),
            metadata: PersistenceMetadata::new(store_a.instance_id()),
        })
        .await
        .unwrap();

    tokio::time::sleep(std::time::Duration::from_millis(20)).await;

    // Separate handle loads, then saves — becomes the new authoritative writer.
    let store_b = factory(&path);
    let (snap_b, _) = store_b.load().await.unwrap();
    store_b.save(snap_b).await.unwrap();

    tokio::time::sleep(std::time::Duration::from_millis(20)).await;

    // Store A's last-known metadata is now stale; save must conflict.
    let result = store_a
        .save(StoreSnapshot {
            data: to_snapshot_bytes(&Snapshot::default()),
            metadata: PersistenceMetadata::new(store_a.instance_id()),
        })
        .await;

    match result {
        Err(PersistenceError::ConflictDetected { .. }) => {}
        other => panic!("expected ConflictDetected, got: {other:?}"),
    }
}

pub async fn test_instance_id_is_idempotent_within_handle(factory: &StoreFactory) {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("test.store");
    let store = factory(&path);
    let id1 = store.instance_id();
    let id2 = store.instance_id();
    assert_eq!(
        id1, id2,
        "instance_id must return the same value on repeated calls within the same handle"
    );
}

pub async fn test_path_matches_locator(factory: &StoreFactory) {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("test.store");
    let store = factory(&path);
    assert_eq!(store.path(), path.as_path());
}