nodedb 0.3.0-beta.1

Local-first, real-time, edge-to-cloud hybrid database for multi-modal workloads
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
// SPDX-License-Identifier: BUSL-1.1

//! Current-state scan + Ceiling-backed lookups and raw insert (snapshot restore).

use std::collections::{HashMap, HashSet};

use nodedb_types::TenantId;
use redb::ReadableTable;

use super::store::{
    BaseKey, EDGES, Edge, EdgeRecord, EdgeStore, REVERSE_EDGES, TenantBaseKey, redb_err,
};
use super::temporal::{
    EdgeRef, EdgeValuePayload, is_sentinel, parse_versioned_edge_key, versioned_edge_key,
};

impl EdgeStore {
    /// Scan every raw forward record belonging to a tenant
    /// (versioned composite key + raw value bytes). Used by snapshot export.
    pub fn scan_edges_for_tenant(&self, tid: TenantId) -> crate::Result<Vec<(String, Vec<u8>)>> {
        let t = tid.as_u64();
        let read_txn = self
            .db
            .begin_read()
            .map_err(|e| redb_err("begin_read", e))?;
        let table = read_txn
            .open_table(EDGES)
            .map_err(|e| redb_err("open edges", e))?;

        let mut results = Vec::new();
        let range = table
            .range((t, "")..(t + 1, ""))
            .map_err(|e| redb_err("edge range", e))?;
        for entry in range {
            let entry = entry.map_err(|e| redb_err("edge entry", e))?;
            results.push((entry.0.value().1.to_string(), entry.1.value().to_vec()));
        }
        Ok(results)
    }

    /// Scan every forward edge across all tenants in current-state,
    /// yielding `(TenantId, collection, src, label, dst, properties)`.
    /// Tombstoned and erased versions are skipped; only the Ceiling resolution
    /// at `system_as_of` is returned per base. `None` means "current state"
    /// (ordinal = `i64::MAX`).
    pub fn scan_all_edges_decoded(
        &self,
        system_as_of: Option<i64>,
    ) -> crate::Result<Vec<EdgeRecord>> {
        let cutoff = system_as_of.unwrap_or(i64::MAX);
        let read_txn = self
            .db
            .begin_read()
            .map_err(|e| redb_err("begin_read", e))?;
        let table = read_txn
            .open_table(EDGES)
            .map_err(|e| redb_err("open edges", e))?;

        let mut latest: HashMap<TenantBaseKey, (i64, Vec<u8>)> = HashMap::new();
        let mut tombstoned: HashSet<TenantBaseKey> = HashSet::new();

        for entry in table.iter().map_err(|e| redb_err("iter", e))? {
            let (k, v) = entry.map_err(|e| redb_err("iter entry", e))?;
            let (t, composite) = k.value();
            let Some((coll, src, label, dst, sys)) = parse_versioned_edge_key(composite) else {
                continue;
            };
            if sys > cutoff {
                continue;
            }
            let base: TenantBaseKey = (
                t,
                coll.to_string(),
                src.to_string(),
                label.to_string(),
                dst.to_string(),
            );
            let bytes = v.value();
            if is_sentinel(bytes) {
                match latest.get(&base) {
                    Some((cur_sys, _)) if *cur_sys > sys => {}
                    _ => {
                        latest.remove(&base);
                        tombstoned.insert(base);
                    }
                }
                continue;
            }
            if tombstoned.contains(&base) {
                continue;
            }
            match latest.get(&base) {
                Some((cur_sys, _)) if *cur_sys >= sys => {}
                _ => match EdgeValuePayload::decode(bytes) {
                    Ok(payload) => {
                        latest.insert(base, (sys, payload.properties));
                    }
                    Err(_) => continue,
                },
            }
        }

        let mut out = Vec::with_capacity(latest.len());
        for ((t, coll, src, label, dst), (_sys, props)) in latest {
            out.push((TenantId::new(t), coll, src, label, dst, props));
        }
        Ok(out)
    }

    /// Insert a raw edge record (for snapshot restore). Takes the tenant +
    /// versioned composite key + raw value bytes (payload or sentinel).
    ///
    /// The composite key must already include the `{system_from:020}` suffix.
    /// Reverse-index mirror is maintained with the same suffix.
    pub fn put_edge_raw(
        &self,
        tid: TenantId,
        composite_key: &str,
        value: &[u8],
    ) -> crate::Result<()> {
        let t = tid.as_u64();
        let (collection, src, label, dst, sys) = parse_versioned_edge_key(composite_key)
            .ok_or_else(|| crate::Error::BadRequest {
                detail: format!("put_edge_raw: malformed versioned key {composite_key:?}"),
            })?;
        let rev_key = versioned_edge_key(collection, dst, label, src, sys)?;
        let rev_value: &[u8] = if is_sentinel(value) { value } else { &[] };

        let write_txn = self
            .db
            .begin_write()
            .map_err(|e| redb_err("begin_write", e))?;
        {
            let mut edges = write_txn
                .open_table(EDGES)
                .map_err(|e| redb_err("open edges", e))?;
            edges
                .insert((t, composite_key), value)
                .map_err(|e| redb_err("insert edge", e))?;
            let mut rev_t = write_txn
                .open_table(REVERSE_EDGES)
                .map_err(|e| redb_err("open reverse", e))?;
            rev_t
                .insert((t, rev_key.as_str()), rev_value)
                .map_err(|e| redb_err("insert reverse", e))?;
        }
        write_txn.commit().map_err(|e| redb_err("commit edge", e))?;
        Ok(())
    }

    /// Get an edge's current-state properties. `None` if no live version.
    pub fn get_edge(
        &self,
        tid: TenantId,
        collection: &str,
        src: &str,
        label: &str,
        dst: &str,
    ) -> crate::Result<Option<Vec<u8>>> {
        self.ceiling_resolve_edge(
            EdgeRef::new(tid, collection, src, label, dst),
            i64::MAX,
            None,
        )
    }

    /// Scan forward edges under a tenant with a base-key prefix, applying
    /// current-state semantics: yields exactly one `Edge` per base that has
    /// a live latest version. Used by `neighbors_out` and friends.
    pub(super) fn scan_edges_with_prefix<F>(
        &self,
        tid: TenantId,
        prefix: &str,
        mut make_edge: F,
    ) -> crate::Result<Vec<Edge>>
    where
        F: FnMut(&str, &str, &str, &str) -> Edge,
    {
        let t = tid.as_u64();
        let read_txn = self
            .db
            .begin_read()
            .map_err(|e| redb_err("begin_read", e))?;
        let table = read_txn
            .open_table(EDGES)
            .map_err(|e| redb_err("open edges", e))?;

        let mut latest: HashMap<BaseKey, (i64, Vec<u8>)> = HashMap::new();

        let range = table
            .range((t, prefix)..)
            .map_err(|e| redb_err("range", e))?;

        for entry in range {
            let (key, val) = entry.map_err(|e| redb_err("iter", e))?;
            let (kt, composite) = key.value();
            if kt != t || !composite.starts_with(prefix) {
                break;
            }
            let Some((coll, src, label, dst, sys)) = parse_versioned_edge_key(composite) else {
                continue;
            };
            let base = (
                coll.to_string(),
                src.to_string(),
                label.to_string(),
                dst.to_string(),
            );
            let bytes = val.value().to_vec();
            latest
                .entry(base)
                .and_modify(|(cur_sys, cur_val)| {
                    if sys > *cur_sys {
                        *cur_sys = sys;
                        *cur_val = bytes.clone();
                    }
                })
                .or_insert((sys, bytes));
        }

        let mut edges = Vec::with_capacity(latest.len());
        for ((coll, src, label, dst), (_sys, bytes)) in latest {
            if is_sentinel(&bytes) {
                continue;
            }
            let Ok(payload) = EdgeValuePayload::decode(&bytes) else {
                continue;
            };
            let mut edge = make_edge(&coll, &src, &label, &dst);
            edge.properties = payload.properties;
            edges.push(edge);
        }
        Ok(edges)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::engine::graph::edge_store::temporal::TOMBSTONE_SENTINEL;
    use nodedb_types::OrdinalClock;

    const T: TenantId = TenantId::new(1);
    const COLL: &str = "people";

    fn make_store() -> (EdgeStore, tempfile::TempDir) {
        let dir = tempfile::tempdir().unwrap();
        let store = EdgeStore::open(&dir.path().join("graph.redb")).unwrap();
        (store, dir)
    }

    fn e<'a>(src: &'a str, label: &'a str, dst: &'a str) -> EdgeRef<'a> {
        EdgeRef::new(T, COLL, src, label, dst)
    }

    fn put(store: &EdgeStore, clock: &OrdinalClock, src: &str, label: &str, dst: &str, p: &[u8]) {
        let ord = clock.next_ordinal();
        store
            .put_edge_versioned(e(src, label, dst), p, ord, ord, i64::MAX)
            .unwrap();
    }

    fn soft_delete(store: &EdgeStore, clock: &OrdinalClock, src: &str, label: &str, dst: &str) {
        let ord = clock.next_ordinal();
        store.soft_delete_edge(e(src, label, dst), ord).unwrap();
    }

    #[test]
    fn put_and_get_edge_current_state() {
        let (store, _dir) = make_store();
        let clock = OrdinalClock::new();
        put(&store, &clock, "alice", "KNOWS", "bob", b"props");

        let result = store.get_edge(T, COLL, "alice", "KNOWS", "bob").unwrap();
        assert_eq!(result, Some(b"props".to_vec()));
    }

    #[test]
    fn get_nonexistent_edge_returns_none() {
        let (store, _dir) = make_store();
        let result = store.get_edge(T, COLL, "alice", "KNOWS", "bob").unwrap();
        assert!(result.is_none());
    }

    #[test]
    fn soft_deleted_edge_is_invisible_to_current_state() {
        let (store, _dir) = make_store();
        let clock = OrdinalClock::new();
        put(&store, &clock, "alice", "KNOWS", "bob", b"v1");
        soft_delete(&store, &clock, "alice", "KNOWS", "bob");
        assert!(
            store
                .get_edge(T, COLL, "alice", "KNOWS", "bob")
                .unwrap()
                .is_none()
        );
    }

    #[test]
    fn put_after_soft_delete_resurrects_edge() {
        let (store, _dir) = make_store();
        let clock = OrdinalClock::new();
        put(&store, &clock, "alice", "KNOWS", "bob", b"v1");
        soft_delete(&store, &clock, "alice", "KNOWS", "bob");
        put(&store, &clock, "alice", "KNOWS", "bob", b"v2");
        assert_eq!(
            store.get_edge(T, COLL, "alice", "KNOWS", "bob").unwrap(),
            Some(b"v2".to_vec())
        );
    }

    #[test]
    fn scan_with_prefix_yields_current_state_only() {
        let (store, _dir) = make_store();
        let clock = OrdinalClock::new();
        put(&store, &clock, "a", "L", "b", b"v1");
        put(&store, &clock, "a", "L", "b", b"v2");
        put(&store, &clock, "a", "L", "c", b"x");
        soft_delete(&store, &clock, "a", "L", "c");

        let edges = store
            .scan_edges_with_prefix(T, &format!("{COLL}\x00a\x00L\x00"), |c, s, l, d| Edge {
                collection: c.to_string(),
                src_id: s.to_string(),
                label: l.to_string(),
                dst_id: d.to_string(),
                properties: Vec::new(),
            })
            .unwrap();
        assert_eq!(edges.len(), 1);
        assert_eq!(edges[0].dst_id, "b");
        assert_eq!(edges[0].properties, b"v2");
    }

    #[test]
    fn scan_all_edges_decoded_current_state() {
        let (store, _dir) = make_store();
        let clock = OrdinalClock::new();
        put(&store, &clock, "a", "L", "b", b"v1");
        put(&store, &clock, "a", "L", "b", b"v2");
        put(&store, &clock, "c", "L", "d", b"live");
        soft_delete(&store, &clock, "c", "L", "d");

        let out = store.scan_all_edges_decoded(None).unwrap();
        assert_eq!(out.len(), 1);
        assert_eq!(out[0].5, b"v2".to_vec());
    }

    #[test]
    fn scan_all_edges_decoded_as_of_earlier_ordinal() {
        let (store, _dir) = make_store();
        store
            .put_edge_versioned(e("a", "L", "b"), b"v1", 100, 100, i64::MAX)
            .unwrap();
        store
            .put_edge_versioned(e("a", "L", "b"), b"v2", 200, 200, i64::MAX)
            .unwrap();
        store.soft_delete_edge(e("a", "L", "b"), 300).unwrap();

        let at_150 = store.scan_all_edges_decoded(Some(150)).unwrap();
        assert_eq!(at_150.len(), 1);
        assert_eq!(at_150[0].5, b"v1".to_vec());

        let at_250 = store.scan_all_edges_decoded(Some(250)).unwrap();
        assert_eq!(at_250[0].5, b"v2".to_vec());

        let at_350 = store.scan_all_edges_decoded(Some(350)).unwrap();
        assert!(
            at_350.is_empty(),
            "tombstoned at 300 — must be empty at 350"
        );
    }

    #[test]
    fn tenants_are_isolated() {
        let (store, _dir) = make_store();
        let t1 = TenantId::new(1);
        let t2 = TenantId::new(2);
        store
            .put_edge_versioned(
                EdgeRef::new(t1, COLL, "a", "L", "b"),
                b"t1",
                10,
                10,
                i64::MAX,
            )
            .unwrap();
        store
            .put_edge_versioned(
                EdgeRef::new(t2, COLL, "a", "L", "b"),
                b"t2",
                20,
                20,
                i64::MAX,
            )
            .unwrap();
        assert_eq!(
            store.get_edge(t1, COLL, "a", "L", "b").unwrap(),
            Some(b"t1".to_vec())
        );
        assert_eq!(
            store.get_edge(t2, COLL, "a", "L", "b").unwrap(),
            Some(b"t2".to_vec())
        );
    }

    #[test]
    fn put_edge_raw_preserves_versioned_key_and_mirrors_reverse() {
        let (store, _dir) = make_store();
        let key = versioned_edge_key(COLL, "a", "L", "b", 123).unwrap();
        let payload = EdgeValuePayload::new(0, i64::MAX, b"hello".to_vec())
            .encode()
            .unwrap();
        store.put_edge_raw(T, &key, &payload).unwrap();
        assert_eq!(
            store.get_edge(T, COLL, "a", "L", "b").unwrap(),
            Some(b"hello".to_vec())
        );

        let tkey = versioned_edge_key(COLL, "a", "L", "b", 200).unwrap();
        store.put_edge_raw(T, &tkey, TOMBSTONE_SENTINEL).unwrap();
        assert!(store.get_edge(T, COLL, "a", "L", "b").unwrap().is_none());
    }

    #[test]
    fn put_edge_raw_rejects_unversioned_key() {
        let (store, _dir) = make_store();
        let err = store.put_edge_raw(T, "c\x00a\x00L\x00b", b"x").unwrap_err();
        match err {
            crate::Error::BadRequest { detail } => {
                assert!(detail.contains("malformed versioned key"));
            }
            other => panic!("unexpected error: {other:?}"),
        }
    }
}