mushroomdb 0.5.2

Embedded graph database with Cypher queries, rule triggers, and Arrow export
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
use core_api::{
    AutoFk, Direction, FkSkip, GraphDb, GraphError, IngestOptions, IngestReport, Predicate, Value,
};
use core_storage::fs::{FileId, Fs, RealFs};
use std::collections::BTreeMap;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::Arc;

fn tmp(name: &str) -> std::path::PathBuf {
    let d = std::env::temp_dir().join(format!("graphdb-{}-{}", name, std::process::id()));
    let _ = std::fs::remove_dir_all(&d);
    d
}

fn wal_len(dir: &std::path::Path) -> u64 {
    std::fs::metadata(dir.join("wal.bin"))
        .map(|m| m.len())
        .unwrap_or(0)
}

fn row(pairs: &[(&str, &str)]) -> BTreeMap<String, Value> {
    pairs
        .iter()
        .map(|(k, v)| ((*k).to_string(), Value::Str((*v).into())))
        .collect()
}

fn row_val(pairs: &[(&str, Value)]) -> BTreeMap<String, Value> {
    pairs
        .iter()
        .map(|(k, v)| ((*k).to_string(), v.clone()))
        .collect()
}

/// Binding: org_id rows auto-link to pre-existing Org nodes; rule is a real
/// incremental KeyMatch (`auto_fk_person_org_id`, edge type `ORG`); explain works;
/// a later plain `insert_node` with the same FK also links.
#[test]
fn org_id_auto_links_and_later_insert_fires_rule() {
    let dir = tmp("ingest-org");
    let mut db = GraphDb::open(&dir).unwrap();
    db.insert_node("Org", "acme", vec![]).unwrap();
    db.insert_node("Org", "beta", vec![]).unwrap();

    let report = db
        .ingest(
            "Person",
            vec![
                row(&[("id", "p1"), ("org_id", "acme")]),
                row(&[("id", "p2"), ("org_id", "beta")]),
            ],
            &IngestOptions::default(),
        )
        .unwrap();

    assert_eq!(report.inserted, 2);
    assert!(report.row_errors.is_empty());
    assert_eq!(
        report.rules_created,
        vec!["auto_fk_person_org_id".to_string()]
    );
    assert!(report.skipped_fk_fields.is_empty());

    let rules = db.rules();
    let fk = rules
        .iter()
        .find(|r| r.name == "auto_fk_person_org_id")
        .unwrap();
    assert_eq!(fk.src_label, "Person");
    assert_eq!(fk.dst_label, "Org");
    assert_eq!(fk.edge_type, "ORG");
    assert_eq!(
        fk.predicate,
        Predicate::KeyMatch {
            field: "org_id".into()
        }
    );
    assert_eq!(fk.weight_prop, None);
    assert_eq!(fk.max_edges, Some(1));

    assert_eq!(
        db.neighbors("p1", "ORG", Direction::Out).unwrap(),
        vec!["acme".to_string()]
    );
    assert_eq!(
        db.neighbors("p2", "ORG", Direction::Out).unwrap(),
        vec!["beta".to_string()]
    );
    assert_eq!(
        db.get_prop("p1", "id"),
        Some(Value::Str("p1".into())),
        "key_field is stored as a normal prop"
    );
    assert_eq!(db.get_prop("p1", "org_id"), Some(Value::Str("acme".into())));

    let ex = db.explain("p1", "acme").unwrap();
    assert_eq!(ex.len(), 1);
    assert_eq!(ex[0].rule, "auto_fk_person_org_id");
    assert_eq!(ex[0].edge_type, "ORG");
    assert_eq!(ex[0].src_key, "p1");
    assert_eq!(ex[0].dst_key, "acme");
    // auto-FK stores no weight prop; explain recomputes the KeyMatch score.
    assert_eq!(ex[0].weight, Some(1.0));

    db.insert_node(
        "Person",
        "p3",
        vec![("org_id".into(), Value::Str("acme".into()))],
    )
    .unwrap();
    assert_eq!(
        db.neighbors("p3", "ORG", Direction::Out).unwrap(),
        vec!["acme".to_string()],
        "auto-FK is a real incremental rule, not a one-shot backfill"
    );
    let ex3 = db.explain("p3", "acme").unwrap();
    assert_eq!(ex3.len(), 1);
    assert_eq!(ex3[0].rule, "auto_fk_person_org_id");

    // Same-label re-ingest: name collision on (Person, org_id) skips creating
    // a second rule; new rows still link incrementally.
    let again = db
        .ingest(
            "Person",
            vec![row(&[("id", "p4"), ("org_id", "beta")])],
            &IngestOptions::default(),
        )
        .unwrap();
    assert_eq!(again.inserted, 1);
    assert!(again.rules_created.is_empty());
    assert!(again.skipped_fk_fields.is_empty());
    assert_eq!(
        db.neighbors("p4", "ORG", Direction::Out).unwrap(),
        vec!["beta".to_string()]
    );
}

#[test]
fn auto_fk_keymatch_is_top_1() {
    // existing ingest fixture; after ingest, rule auto_fk_person_org_id
    let dir = tmp("ingest-auto-fk-topk");
    let mut db = GraphDb::open(&dir).unwrap();
    db.insert_node("Org", "acme", vec![]).unwrap();
    db.insert_node("Org", "beta", vec![]).unwrap();
    db.ingest(
        "Person",
        vec![
            row(&[("id", "p1"), ("org_id", "acme")]),
            row(&[("id", "p2"), ("org_id", "beta")]),
        ],
        &IngestOptions::default(),
    )
    .unwrap();
    let r = db
        .rules()
        .into_iter()
        .find(|r| r.name == "auto_fk_person_org_id")
        .unwrap();
    assert_eq!(r.max_edges, Some(1));
}

/// Binding: matching keys under more than one label → no rule, reason reported.
/// Keys are globally unique, so ambiguity is distinct FK values resolving to
/// different labels (not one key living under two labels).
#[test]
fn ambiguous_fk_targets_are_skipped() {
    let dir = tmp("ingest-ambig");
    let mut db = GraphDb::open(&dir).unwrap();
    db.insert_node("Org", "acme", vec![]).unwrap();
    db.insert_node("Team", "eng", vec![]).unwrap();

    let report = db
        .ingest(
            "Person",
            vec![
                row(&[("id", "p1"), ("org_id", "acme")]),
                row(&[("id", "p2"), ("org_id", "eng")]),
            ],
            &IngestOptions::default(),
        )
        .unwrap();

    assert_eq!(report.inserted, 2);
    assert!(report.rules_created.is_empty());
    assert_eq!(
        report.skipped_fk_fields,
        vec![FkSkip {
            field: "org_id".into(),
            reason: "ambiguous target labels: Org, Team".into(),
        }]
    );
    assert!(db.rules().is_empty());
    assert!(db
        .neighbors("p1", "ORG", Direction::Out)
        .unwrap()
        .is_empty());
}

/// Binding: FK field whose Str values match no live (or intra-ingest) key.
#[test]
fn unmatched_fk_field_is_skipped() {
    let dir = tmp("ingest-nomatch");
    let mut db = GraphDb::open(&dir).unwrap();

    let report = db
        .ingest(
            "Person",
            vec![row(&[("id", "p1"), ("dept_id", "ghost")])],
            &IngestOptions::default(),
        )
        .unwrap();

    assert_eq!(report.inserted, 1);
    assert!(report.rules_created.is_empty());
    assert_eq!(
        report.skipped_fk_fields,
        vec![FkSkip {
            field: "dept_id".into(),
            reason: "no matching target keys".into(),
        }]
    );
    assert!(db.rules().is_empty());
    assert!(db.has_node("p1"));
}

/// Binding: missing / non-Str key_field is a per-row error; remaining rows insert.
#[test]
fn missing_key_field_rows_are_counted_not_fatal() {
    let dir = tmp("ingest-missing-key");
    let mut db = GraphDb::open(&dir).unwrap();

    let report = db
        .ingest(
            "Person",
            vec![
                row(&[("name", "anon")]),
                row(&[("id", "p1"), ("name", "ada")]),
                row_val(&[("id", Value::Int(7)), ("name", Value::Str("num".into()))]),
                row(&[("id", "p2")]),
            ],
            &IngestOptions::default(),
        )
        .unwrap();

    assert_eq!(report.inserted, 2);
    assert_eq!(
        report.row_errors,
        vec![
            (0, "missing key field id".into()),
            (2, "key field id is not a string".into()),
        ]
    );
    assert!(db.has_node("p1"));
    assert!(db.has_node("p2"));
    assert!(!db.has_node("anon"));
    assert_eq!(db.get_prop("p1", "name"), Some(Value::Str("ada".into())));
}

/// Binding: duplicate vs existing db and vs an earlier accepted row → row errors.
#[test]
fn duplicate_keys_are_row_errors() {
    let dir = tmp("ingest-dups");
    let mut db = GraphDb::open(&dir).unwrap();
    db.insert_node("Person", "p1", vec![]).unwrap();

    let report = db
        .ingest(
            "Person",
            vec![
                row(&[("id", "p1")]),
                row(&[("id", "p2")]),
                row(&[("id", "p2")]),
                row(&[("id", "p3")]),
            ],
            &IngestOptions::default(),
        )
        .unwrap();

    assert_eq!(report.inserted, 2);
    assert_eq!(
        report.row_errors,
        vec![
            (0, "duplicate key p1".into()),
            (2, "duplicate key p2".into()),
        ]
    );
    assert!(db.has_node("p2"));
    assert!(db.has_node("p3"));
}

/// Binding: commit-level Err applies nothing; WAL bytes unchanged.
#[test]
fn commit_failure_applies_nothing() {
    let dir = tmp("ingest-atomic");
    let fail = Arc::new(AtomicBool::new(false));
    let fs = FailWalAppend {
        inner: RealFs::new(&dir).unwrap(),
        fail: fail.clone(),
    };
    let mut db = GraphDb::open_with(fs).unwrap();
    db.insert_node("Org", "acme", vec![]).unwrap();

    let before_wal = wal_len(&dir);
    let before_nodes = db.stats().nodes_live;
    fail.store(true, Ordering::SeqCst);

    let err = db
        .ingest(
            "Person",
            vec![row(&[("id", "p1"), ("org_id", "acme")])],
            &IngestOptions::default(),
        )
        .unwrap_err();
    assert!(matches!(err, GraphError::Io(_)), "got {err:?}");

    assert_eq!(wal_len(&dir), before_wal);
    assert_eq!(db.stats().nodes_live, before_nodes);
    assert!(!db.has_node("p1"));
    assert!(db.rules().is_empty());
    assert!(db.has_node("acme"));
}

/// Binding: AutoFk::Off inserts rows and does not declare rules or edges.
#[test]
fn auto_fk_off_disables_inference() {
    let dir = tmp("ingest-off");
    let mut db = GraphDb::open(&dir).unwrap();
    db.insert_node("Org", "acme", vec![]).unwrap();

    let report = db
        .ingest(
            "Person",
            vec![row(&[("id", "p1"), ("org_id", "acme")])],
            &IngestOptions {
                auto_fk: AutoFk::Off,
                ..IngestOptions::default()
            },
        )
        .unwrap();

    assert_eq!(
        report,
        IngestReport {
            inserted: 1,
            row_errors: vec![],
            rules_created: vec![],
            skipped_fk_fields: vec![],
            edges_inserted: 0,
        }
    );
    assert!(db.rules().is_empty());
    assert!(db.has_node("p1"));
    assert!(db
        .neighbors("p1", "ORG", Direction::Out)
        .unwrap()
        .is_empty());
}

/// Binding: rows may FK other rows in the same ingest (self-label rule + edges).
#[test]
fn intra_ingest_fk_builds_self_label_rule() {
    let dir = tmp("ingest-intra");
    let mut db = GraphDb::open(&dir).unwrap();

    // Child first so the dest-side KeyMatch path has to fire when p1 arrives.
    let report = db
        .ingest(
            "Person",
            vec![
                row(&[("id", "p2"), ("manager_id", "p1")]),
                row(&[("id", "p1")]),
            ],
            &IngestOptions::default(),
        )
        .unwrap();

    assert_eq!(report.inserted, 2);
    assert_eq!(
        report.rules_created,
        vec!["auto_fk_person_manager_id".to_string()]
    );
    assert!(report.skipped_fk_fields.is_empty());

    let fk = db
        .rules()
        .into_iter()
        .find(|r| r.name == "auto_fk_person_manager_id")
        .unwrap();
    assert_eq!(fk.src_label, "Person");
    assert_eq!(fk.dst_label, "Person");
    assert_eq!(fk.edge_type, "MANAGER");
    assert_eq!(
        fk.predicate,
        Predicate::KeyMatch {
            field: "manager_id".into()
        }
    );

    assert_eq!(
        db.neighbors("p2", "MANAGER", Direction::Out).unwrap(),
        vec!["p1".to_string()]
    );
    let ex = db.explain("p2", "p1").unwrap();
    assert_eq!(ex.len(), 1);
    assert_eq!(ex[0].rule, "auto_fk_person_manager_id");
    assert_eq!(ex[0].edge_type, "MANAGER");
}

/// Spec amendment: rule names are `auto_fk_<src_label_lowercase>_<field>`, so
/// Person.org_id and Device.org_id each get their own rule. Before this,
/// the second ingest silently skipped (name collision) and Devices did not link.
#[test]
fn second_src_label_same_fk_field_creates_own_rule_and_links() {
    let dir = tmp("ingest-two-src");
    let mut db = GraphDb::open(&dir).unwrap();
    db.insert_node("Org", "acme", vec![]).unwrap();

    let people = db
        .ingest(
            "Person",
            vec![row(&[("id", "p1"), ("org_id", "acme")])],
            &IngestOptions::default(),
        )
        .unwrap();
    assert_eq!(
        people.rules_created,
        vec!["auto_fk_person_org_id".to_string()]
    );
    assert_eq!(
        db.neighbors("p1", "ORG", Direction::Out).unwrap(),
        vec!["acme".to_string()]
    );

    let devices = db
        .ingest(
            "Device",
            vec![row(&[("id", "d1"), ("org_id", "acme")])],
            &IngestOptions::default(),
        )
        .unwrap();
    assert_eq!(devices.inserted, 1);
    assert_eq!(
        devices.rules_created,
        vec!["auto_fk_device_org_id".to_string()]
    );
    assert!(devices.skipped_fk_fields.is_empty());

    let names: Vec<String> = db.rules().into_iter().map(|r| r.name).collect();
    assert_eq!(
        names,
        vec![
            "auto_fk_device_org_id".to_string(),
            "auto_fk_person_org_id".to_string(),
        ]
    );

    let device_fk = db
        .rules()
        .into_iter()
        .find(|r| r.name == "auto_fk_device_org_id")
        .unwrap();
    assert_eq!(device_fk.src_label, "Device");
    assert_eq!(device_fk.dst_label, "Org");
    assert_eq!(device_fk.edge_type, "ORG");

    assert_eq!(
        db.neighbors("d1", "ORG", Direction::Out).unwrap(),
        vec!["acme".to_string()],
        "Device.org_id must link; must not silently collide with Person.org_id"
    );
    let ex = db.explain("d1", "acme").unwrap();
    assert_eq!(ex.len(), 1);
    assert_eq!(ex[0].rule, "auto_fk_device_org_id");
}

/// WAL append that can be flipped to fail so ingest's single batch commit errors.
struct FailWalAppend {
    inner: RealFs,
    fail: Arc<AtomicBool>,
}

impl Fs for FailWalAppend {
    fn append(&mut self, file: FileId, data: &[u8]) -> std::io::Result<()> {
        if self.fail.load(Ordering::SeqCst) {
            return Err(std::io::Error::other("forced ingest commit failure"));
        }
        self.inner.append(file, data)
    }

    fn sync(&mut self, file: FileId) -> std::io::Result<()> {
        self.inner.sync(file)
    }

    fn read(&self, file: FileId) -> std::io::Result<Vec<u8>> {
        self.inner.read(file)
    }

    fn write_atomic(&mut self, file: FileId, data: &[u8]) -> std::io::Result<()> {
        self.inner.write_atomic(file, data)
    }
}