citadeldb 0.8.1

Citadel: encrypted-first embedded database engine that outperforms unencrypted SQLite
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

use std::thread;

use citadel::{Argon2Profile, DatabaseBuilder};
use citadel_sync::{MemoryTransport, NodeId, SyncConfig, SyncDirection, SyncSession};

fn fast_builder(path: &std::path::Path) -> DatabaseBuilder {
    DatabaseBuilder::new(path)
        .passphrase(b"sync-test")
        .argon2_profile(Argon2Profile::Iot)
}

fn session(node: u64) -> SyncSession {
    SyncSession::new(SyncConfig {
        node_id: NodeId::from_u64(node),
        direction: SyncDirection::Push,
        crdt_aware: false,
    })
}

#[test]
fn sync_identical_tables() {
    let dir_a = tempfile::tempdir().unwrap();
    let dir_b = tempfile::tempdir().unwrap();
    let db_a = fast_builder(&dir_a.path().join("a.db")).create().unwrap();
    let db_b = fast_builder(&dir_b.path().join("b.db")).create().unwrap();

    // Both have same data
    for db in [&db_a, &db_b] {
        let mut wtx = db.begin_write().unwrap();
        wtx.create_table(b"users").unwrap();
        wtx.table_insert(b"users", b"k1", b"v1").unwrap();
        wtx.commit().unwrap();
    }

    let (ta, tb) = MemoryTransport::pair();
    let sess_a = session(1);
    let sess_b = session(2);

    let mgr_a = db_a.manager();
    let mgr_b = db_b.manager();

    thread::scope(|s| {
        let h = s.spawn(|| sess_a.sync_tables_as_initiator(mgr_a, &ta).unwrap());
        sess_b.handle_table_sync_as_responder(mgr_b, &tb).unwrap();
        let results = h.join().unwrap();
        // No changes needed - tables are identical
        assert!(results.is_empty());
    });
}

#[test]
fn sync_one_table_push() {
    let dir_a = tempfile::tempdir().unwrap();
    let dir_b = tempfile::tempdir().unwrap();
    let db_a = fast_builder(&dir_a.path().join("a.db")).create().unwrap();
    let db_b = fast_builder(&dir_b.path().join("b.db")).create().unwrap();

    // A has data, B has empty table
    let mut wtx = db_a.begin_write().unwrap();
    wtx.create_table(b"data").unwrap();
    wtx.table_insert(b"data", b"k1", b"v1").unwrap();
    wtx.table_insert(b"data", b"k2", b"v2").unwrap();
    wtx.commit().unwrap();

    let mut wtx = db_b.begin_write().unwrap();
    wtx.create_table(b"data").unwrap();
    wtx.commit().unwrap();

    let (ta, tb) = MemoryTransport::pair();
    let sess_a = session(1);
    let sess_b = session(2);
    let mgr_a = db_a.manager();
    let mgr_b = db_b.manager();

    thread::scope(|s| {
        let h = s.spawn(|| sess_a.sync_tables_as_initiator(mgr_a, &ta).unwrap());
        sess_b.handle_table_sync_as_responder(mgr_b, &tb).unwrap();
        let results = h.join().unwrap();
        assert_eq!(results.len(), 1);
        assert_eq!(results[0].0, b"data");
        assert_eq!(results[0].1.entries_applied, 2);
    });

    let mut rtx = db_b.begin_read();
    assert_eq!(rtx.table_get(b"data", b"k1").unwrap().unwrap(), b"v1");
    assert_eq!(rtx.table_get(b"data", b"k2").unwrap().unwrap(), b"v2");
}

#[test]
fn sync_multiple_tables() {
    let dir_a = tempfile::tempdir().unwrap();
    let dir_b = tempfile::tempdir().unwrap();
    let db_a = fast_builder(&dir_a.path().join("a.db")).create().unwrap();
    let db_b = fast_builder(&dir_b.path().join("b.db")).create().unwrap();

    let mut wtx = db_a.begin_write().unwrap();
    wtx.create_table(b"alpha").unwrap();
    wtx.create_table(b"beta").unwrap();
    wtx.table_insert(b"alpha", b"a1", b"100").unwrap();
    wtx.table_insert(b"beta", b"b1", b"200").unwrap();
    wtx.commit().unwrap();

    // B has the tables but empty
    let mut wtx = db_b.begin_write().unwrap();
    wtx.create_table(b"alpha").unwrap();
    wtx.create_table(b"beta").unwrap();
    wtx.commit().unwrap();

    let (ta, tb) = MemoryTransport::pair();
    let sess_a = session(1);
    let sess_b = session(2);
    let mgr_a = db_a.manager();
    let mgr_b = db_b.manager();

    thread::scope(|s| {
        let h = s.spawn(|| sess_a.sync_tables_as_initiator(mgr_a, &ta).unwrap());
        sess_b.handle_table_sync_as_responder(mgr_b, &tb).unwrap();
        let results = h.join().unwrap();
        assert_eq!(results.len(), 2);
    });

    let mut rtx = db_b.begin_read();
    assert_eq!(rtx.table_get(b"alpha", b"a1").unwrap().unwrap(), b"100");
    assert_eq!(rtx.table_get(b"beta", b"b1").unwrap().unwrap(), b"200");
}

#[test]
fn sync_disjoint_tables() {
    let dir_a = tempfile::tempdir().unwrap();
    let dir_b = tempfile::tempdir().unwrap();
    let db_a = fast_builder(&dir_a.path().join("a.db")).create().unwrap();
    let db_b = fast_builder(&dir_b.path().join("b.db")).create().unwrap();

    // A has "only_a" table
    let mut wtx = db_a.begin_write().unwrap();
    wtx.create_table(b"only_a").unwrap();
    wtx.table_insert(b"only_a", b"k", b"v").unwrap();
    wtx.commit().unwrap();

    // B has "only_b" table
    let mut wtx = db_b.begin_write().unwrap();
    wtx.create_table(b"only_b").unwrap();
    wtx.table_insert(b"only_b", b"k", b"v").unwrap();
    wtx.commit().unwrap();

    let (ta, tb) = MemoryTransport::pair();
    let sess_a = session(1);
    let sess_b = session(2);
    let mgr_a = db_a.manager();
    let mgr_b = db_b.manager();

    thread::scope(|s| {
        let h = s.spawn(|| sess_a.sync_tables_as_initiator(mgr_a, &ta).unwrap());
        sess_b.handle_table_sync_as_responder(mgr_b, &tb).unwrap();
        let results = h.join().unwrap();
        // A has "only_a" which B doesn't - should push it
        assert!(results.iter().any(|(name, _)| name == b"only_a"));
    });

    // B should now have "only_a" data
    let mut rtx = db_b.begin_read();
    assert_eq!(rtx.table_get(b"only_a", b"k").unwrap().unwrap(), b"v");
}

#[test]
fn sync_empty_tables_no_crash() {
    let dir_a = tempfile::tempdir().unwrap();
    let dir_b = tempfile::tempdir().unwrap();
    let db_a = fast_builder(&dir_a.path().join("a.db")).create().unwrap();
    let db_b = fast_builder(&dir_b.path().join("b.db")).create().unwrap();

    // Neither has tables
    let (ta, tb) = MemoryTransport::pair();
    let sess_a = session(1);
    let sess_b = session(2);
    let mgr_a = db_a.manager();
    let mgr_b = db_b.manager();

    thread::scope(|s| {
        let h = s.spawn(|| sess_a.sync_tables_as_initiator(mgr_a, &ta).unwrap());
        sess_b.handle_table_sync_as_responder(mgr_b, &tb).unwrap();
        let results = h.join().unwrap();
        assert!(results.is_empty());
    });
}

#[test]
fn sync_skips_index_tables() {
    let dir_a = tempfile::tempdir().unwrap();
    let dir_b = tempfile::tempdir().unwrap();
    let db_a = fast_builder(&dir_a.path().join("a.db")).create().unwrap();
    let db_b = fast_builder(&dir_b.path().join("b.db")).create().unwrap();

    let mut wtx = db_a.begin_write().unwrap();
    wtx.create_table(b"data").unwrap();
    wtx.create_table(b"__idx_data_name").unwrap();
    wtx.table_insert(b"data", b"k", b"v").unwrap();
    wtx.table_insert(b"__idx_data_name", b"idx_k", b"idx_v")
        .unwrap();
    wtx.commit().unwrap();

    let mut wtx = db_b.begin_write().unwrap();
    wtx.create_table(b"data").unwrap();
    wtx.commit().unwrap();

    let (ta, tb) = MemoryTransport::pair();
    let sess_a = session(1);
    let sess_b = session(2);
    let mgr_a = db_a.manager();
    let mgr_b = db_b.manager();

    thread::scope(|s| {
        let h = s.spawn(|| sess_a.sync_tables_as_initiator(mgr_a, &ta).unwrap());
        sess_b.handle_table_sync_as_responder(mgr_b, &tb).unwrap();
        let results = h.join().unwrap();
        // Should sync "data" but NOT "__idx_data_name"
        assert!(results.iter().any(|(name, _)| name == b"data"));
        assert!(!results.iter().any(|(name, _)| name.starts_with(b"__idx_")));
    });
}

#[test]
fn sync_preserves_unshared_data() {
    let dir_a = tempfile::tempdir().unwrap();
    let dir_b = tempfile::tempdir().unwrap();
    let db_a = fast_builder(&dir_a.path().join("a.db")).create().unwrap();
    let db_b = fast_builder(&dir_b.path().join("b.db")).create().unwrap();

    let mut wtx = db_a.begin_write().unwrap();
    wtx.create_table(b"shared").unwrap();
    wtx.table_insert(b"shared", b"from_a", b"val_a").unwrap();
    wtx.commit().unwrap();

    let mut wtx = db_b.begin_write().unwrap();
    wtx.create_table(b"shared").unwrap();
    wtx.table_insert(b"shared", b"from_b", b"val_b").unwrap();
    wtx.commit().unwrap();

    let mut wtx = db_b.begin_write().unwrap();
    wtx.insert(b"default_key", b"default_val").unwrap();
    wtx.commit().unwrap();

    let (ta, tb) = MemoryTransport::pair();
    let sess_a = session(1);
    let sess_b = session(2);
    let mgr_a = db_a.manager();
    let mgr_b = db_b.manager();

    thread::scope(|s| {
        let h = s.spawn(|| sess_a.sync_tables_as_initiator(mgr_a, &ta).unwrap());
        sess_b.handle_table_sync_as_responder(mgr_b, &tb).unwrap();
        h.join().unwrap();
    });

    // B should have A's data AND keep its own
    let mut rtx = db_b.begin_read();
    assert_eq!(
        rtx.table_get(b"shared", b"from_a").unwrap().unwrap(),
        b"val_a"
    );
    assert_eq!(
        rtx.table_get(b"shared", b"from_b").unwrap().unwrap(),
        b"val_b"
    );
    // Default tree untouched
    assert_eq!(rtx.get(b"default_key").unwrap().unwrap(), b"default_val");
}