mushroomdb 0.6.9

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
//! Tests for `GraphDb::apply_schema` — idempotent schema-as-code.
//!
//! Covers: first-apply creates all items; second-apply with identical schema is
//! all-unchanged AND emits zero new WAL commits; updating a rule definition
//! triggers an update entry.

use core_api::schema::Schema;
use core_api::{Direction, GraphDb, Predicate, RuleDef, ViewDef, ViewSource};

fn tmp(name: &str) -> std::path::PathBuf {
    let nanos = std::time::SystemTime::now()
        .duration_since(std::time::UNIX_EPOCH)
        .expect("clock")
        .as_nanos();
    let d = std::env::temp_dir().join(format!(
        "graphdb-schema-{}-{}-{}",
        name,
        std::process::id(),
        nanos
    ));
    let _ = std::fs::remove_dir_all(&d);
    d
}

fn sample_rule(name: &str) -> RuleDef {
    RuleDef {
        name: name.into(),
        src_label: "A".into(),
        dst_label: "B".into(),
        predicate: Predicate::FieldEqual {
            field: "key".into(),
        },
        edge_type: "REL".into(),
        weight_prop: None,
        max_edges: None,
        approximate: false,
        via_label: None,
        via_edge: None,
        via_dir: None,
        namespace: None,
    }
}

fn sample_view(name: &str) -> ViewDef {
    ViewDef {
        name: name.into(),
        label: "A".into(),
        view_prop: format!("{name}_prop"),
        source: ViewSource::Degree {
            edge_type: "REL".into(),
            direction: Direction::Out,
        },
    }
}

#[test]
fn apply_schema_is_idempotent_and_diffs() {
    let dir = tmp("idempotent");
    let mut db = GraphDb::open(&dir).unwrap();

    // Schema: 1 fulltext pair, 1 rule, 1 view.
    let schema = Schema {
        fulltext: vec![("A".into(), "body".into())],
        indexes: vec![],
        rules: vec![sample_rule("rel_rule")],
        views: vec![sample_view("deg_view")],
        roles: vec![],
    };

    // First apply: everything is created.
    let d1 = db.apply_schema(&schema).unwrap();
    assert_eq!(
        d1.created.len(),
        3,
        "first apply must create 3 items: {d1:?}"
    );
    assert!(d1.updated.is_empty(), "no updates on first apply: {d1:?}");
    assert!(
        d1.unchanged.is_empty(),
        "no unchanged on first apply: {d1:?}"
    );

    // Entry names must follow the spec.
    assert!(
        d1.created.contains(&"fulltext:A.body".to_string()),
        "fulltext entry: {d1:?}"
    );
    assert!(
        d1.created.contains(&"view:deg_view".to_string()),
        "view entry: {d1:?}"
    );
    assert!(
        d1.created.contains(&"rule:rel_rule".to_string()),
        "rule entry: {d1:?}"
    );

    // Record WAL commits before second apply. Drop and reopen to flush.
    drop(db);
    let commits_before = core_api::wal_commit_count_at(&dir).unwrap();

    let mut db = GraphDb::open(&dir).unwrap();

    // Second apply with identical schema: all unchanged, zero new WAL commits.
    let d2 = db.apply_schema(&schema).unwrap();
    assert_eq!(
        d2.unchanged.len(),
        3,
        "second apply must be all-unchanged: {d2:?}"
    );
    assert!(d2.created.is_empty(), "no creates on re-apply: {d2:?}");
    assert!(d2.updated.is_empty(), "no updates on re-apply: {d2:?}");

    // Zero WAL writes: drop and reopen to flush, then count.
    drop(db);
    let commits_after = core_api::wal_commit_count_at(&dir).unwrap();
    assert_eq!(
        commits_after, commits_before,
        "unchanged apply must emit zero WAL commits (before={commits_before}, after={commits_after})"
    );
}

#[test]
fn apply_schema_update_replaces_changed_rule() {
    let dir = tmp("update_rule");
    let mut db = GraphDb::open(&dir).unwrap();

    let schema_v1 = Schema {
        fulltext: vec![],
        indexes: vec![],
        rules: vec![sample_rule("link")],
        views: vec![sample_view("outdeg")],
        roles: vec![],
    };
    let d1 = db.apply_schema(&schema_v1).unwrap();
    assert_eq!(d1.created.len(), 2);

    // Change the rule's edge_type — this should trigger an update.
    let mut changed_rule = sample_rule("link");
    changed_rule.edge_type = "CHANGED".into();

    let schema_v2 = Schema {
        fulltext: vec![],
        indexes: vec![],
        rules: vec![changed_rule],
        views: vec![sample_view("outdeg")], // view unchanged
        roles: vec![],
    };
    let d2 = db.apply_schema(&schema_v2).unwrap();
    assert!(
        d2.updated.contains(&"rule:link".to_string()),
        "changed rule must be in updated: {d2:?}"
    );
    assert!(
        d2.unchanged.contains(&"view:outdeg".to_string()),
        "unchanged view stays unchanged: {d2:?}"
    );
    assert!(d2.created.is_empty(), "nothing new created: {d2:?}");

    // The new edge_type must be live.
    assert!(
        db.rules()
            .iter()
            .any(|r| r.name == "link" && r.edge_type == "CHANGED"),
        "updated rule must reflect new edge_type"
    );
}

#[test]
fn apply_schema_no_pruning() {
    // Items in the DB but absent from the schema are left untouched.
    let dir = tmp("no_prune");
    let mut db = GraphDb::open(&dir).unwrap();

    // Manually create a rule outside the schema.
    db.create_rule(sample_rule("orphan")).unwrap();

    let schema = Schema {
        fulltext: vec![],
        indexes: vec![],
        rules: vec![],
        views: vec![],
        roles: vec![],
    };
    let d = db.apply_schema(&schema).unwrap();
    assert!(d.created.is_empty());
    assert!(d.updated.is_empty());
    assert!(d.unchanged.is_empty());

    // Orphan rule must still exist.
    assert!(
        db.rules().iter().any(|r| r.name == "orphan"),
        "orphan rule must not be pruned"
    );
}

#[test]
fn apply_schema_view_update() {
    // Changing a view's source triggers an update.
    let dir = tmp("update_view");
    let mut db = GraphDb::open(&dir).unwrap();

    let schema_v1 = Schema {
        fulltext: vec![],
        indexes: vec![],
        rules: vec![],
        views: vec![sample_view("degview")],
        roles: vec![],
    };
    db.apply_schema(&schema_v1).unwrap();

    // Change the direction.
    let changed_view = ViewDef {
        name: "degview".into(),
        label: "A".into(),
        view_prop: "degview_prop".into(),
        source: ViewSource::Degree {
            edge_type: "REL".into(),
            direction: Direction::In,
        },
    };
    let schema_v2 = Schema {
        fulltext: vec![],
        indexes: vec![],
        rules: vec![],
        views: vec![changed_view],
        roles: vec![],
    };
    let d = db.apply_schema(&schema_v2).unwrap();
    assert!(
        d.updated.contains(&"view:degview".to_string()),
        "changed view must be updated: {d:?}"
    );
}

#[test]
fn apply_schema_invalid_rule_update_is_rejected_before_mutation() {
    // A changed rule whose new definition fails validate() must: (a) return Err,
    // (b) leave the original rule alive and unchanged, (c) emit zero new WAL commits.
    let dir = tmp("invalid_rule_update");
    let mut db = GraphDb::open(&dir).unwrap();

    // Seed with a valid rule.
    let schema_v1 = Schema {
        fulltext: vec![],
        indexes: vec![],
        rules: vec![sample_rule("link")],
        views: vec![],
        roles: vec![],
    };
    db.apply_schema(&schema_v1).unwrap();

    drop(db);
    let commits_before = core_api::wal_commit_count_at(&dir).unwrap();
    let mut db = GraphDb::open(&dir).unwrap();

    // Build a changed rule with an invalid definition (empty edge_type fails validate()).
    let mut bad_rule = sample_rule("link");
    bad_rule.edge_type = String::new(); // validate() rejects empty edge_type

    let schema_bad = Schema {
        fulltext: vec![],
        indexes: vec![],
        rules: vec![bad_rule],
        views: vec![],
        roles: vec![],
    };
    let result = db.apply_schema(&schema_bad);
    assert!(result.is_err(), "invalid update must return Err");

    // Original rule must still be live and unchanged.
    let rules = db.rules();
    let live = rules
        .iter()
        .find(|r| r.name == "link")
        .expect("original rule must still exist");
    assert_eq!(
        live.edge_type, "REL",
        "original rule edge_type must be unchanged"
    );

    // Zero new WAL commits — no mutation was made.
    drop(db);
    let commits_after = core_api::wal_commit_count_at(&dir).unwrap();
    assert_eq!(
        commits_after, commits_before,
        "invalid update must not emit any WAL commits (before={commits_before}, after={commits_after})"
    );
}

#[test]
fn apply_schema_invalid_view_update_is_rejected_before_mutation() {
    // A changed view whose new definition fails validate() must: (a) return Err,
    // (b) leave the original view alive and unchanged, (c) emit zero new WAL commits.
    let dir = tmp("invalid_view_update");
    let mut db = GraphDb::open(&dir).unwrap();

    // Seed with a valid view.
    let schema_v1 = Schema {
        fulltext: vec![],
        indexes: vec![],
        rules: vec![],
        views: vec![sample_view("degview")],
        roles: vec![],
    };
    db.apply_schema(&schema_v1).unwrap();

    drop(db);
    let commits_before = core_api::wal_commit_count_at(&dir).unwrap();
    let mut db = GraphDb::open(&dir).unwrap();

    // Build a changed view with an invalid definition (empty name fails validate()).
    let bad_view = ViewDef {
        name: "degview".into(),
        label: String::new(), // validate() rejects empty label
        view_prop: "degview_prop".into(),
        source: ViewSource::Degree {
            edge_type: "REL".into(),
            direction: Direction::Out,
        },
    };
    let schema_bad = Schema {
        fulltext: vec![],
        indexes: vec![],
        rules: vec![],
        views: vec![bad_view],
        roles: vec![],
    };
    let result = db.apply_schema(&schema_bad);
    assert!(result.is_err(), "invalid view update must return Err");

    // Original view must still be live.
    let views = db.views();
    let live = views
        .iter()
        .find(|v| v.name == "degview")
        .expect("original view must still exist");
    assert_eq!(live.label, "A", "original view label must be unchanged");

    // Zero new WAL commits.
    drop(db);
    let commits_after = core_api::wal_commit_count_at(&dir).unwrap();
    assert_eq!(
        commits_after, commits_before,
        "invalid view update must not emit any WAL commits (before={commits_before}, after={commits_after})"
    );
}

#[test]
fn schema_json_round_trips() {
    // Schema is serde-JSON round-trippable.
    let schema = Schema {
        fulltext: vec![("Label".into(), "field".into())],
        indexes: vec![],
        rules: vec![sample_rule("r")],
        views: vec![sample_view("v")],
        roles: vec![],
    };
    let json = serde_json::to_string(&schema).unwrap();
    let back: Schema = serde_json::from_str(&json).unwrap();
    assert_eq!(back.fulltext, schema.fulltext);
    assert_eq!(back.rules.len(), 1);
    assert_eq!(back.views.len(), 1);
}

// ---------------------------------------------------------------------------
// Item 16: duplicate names within one schema are rejected pre-validation
// ---------------------------------------------------------------------------

#[test]
fn apply_schema_rejects_duplicate_rule_names() {
    let dir = tmp("schema-dup-rules");
    let mut db = GraphDb::open(&dir).unwrap();

    let schema = Schema {
        fulltext: vec![],
        indexes: vec![],
        rules: vec![sample_rule("my_rule"), sample_rule("my_rule")],
        views: vec![],
        roles: vec![],
    };
    let result = db.apply_schema(&schema);
    assert!(
        result.is_err(),
        "duplicate rule names within one schema must be rejected"
    );
    // Database must not have been mutated (no rule created).
    assert!(db.rules().is_empty(), "no rule created on error");
}

#[test]
fn apply_schema_rejects_duplicate_view_names() {
    let dir = tmp("schema-dup-views");
    let mut db = GraphDb::open(&dir).unwrap();

    let schema = Schema {
        fulltext: vec![],
        indexes: vec![],
        rules: vec![],
        views: vec![sample_view("my_view"), sample_view("my_view")],
        roles: vec![],
    };
    let result = db.apply_schema(&schema);
    assert!(
        result.is_err(),
        "duplicate view names within one schema must be rejected"
    );
    assert!(db.views().is_empty(), "no view created on error");
}