omnigraph-engine 0.3.1

Runtime engine for the Omnigraph graph database.
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
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
mod helpers;

use std::collections::HashMap;

use arrow_array::{Array, RecordBatch, StringArray, TimestampMicrosecondArray};
use futures::TryStreamExt;
use lance::Dataset;

use omnigraph::db::commit_graph::CommitGraph;
use omnigraph::db::{Omnigraph, ReadTarget, RunStatus};
use omnigraph::error::{ManifestErrorKind, OmniError};
use omnigraph::loader::{LoadMode, load_jsonl};

use helpers::*;

#[derive(Debug, Clone)]
struct PersistedRun {
    run_id: String,
    target_branch: String,
    run_branch: String,
    status: String,
    updated_at: i64,
}

async fn latest_runs(uri: &str) -> Vec<PersistedRun> {
    let runs_uri = format!("{}/_graph_runs.lance", uri);
    let ds = Dataset::open(&runs_uri).await.unwrap();
    let batches: Vec<RecordBatch> = ds
        .scan()
        .try_into_stream()
        .await
        .unwrap()
        .try_collect()
        .await
        .unwrap();

    let mut latest: HashMap<String, PersistedRun> = HashMap::new();
    for batch in batches {
        let run_ids = batch
            .column_by_name("run_id")
            .unwrap()
            .as_any()
            .downcast_ref::<StringArray>()
            .unwrap();
        let target_branches = batch
            .column_by_name("target_branch")
            .unwrap()
            .as_any()
            .downcast_ref::<StringArray>()
            .unwrap();
        let run_branches = batch
            .column_by_name("run_branch")
            .unwrap()
            .as_any()
            .downcast_ref::<StringArray>()
            .unwrap();
        let statuses = batch
            .column_by_name("status")
            .unwrap()
            .as_any()
            .downcast_ref::<StringArray>()
            .unwrap();
        let updated_ats = batch
            .column_by_name("updated_at")
            .unwrap()
            .as_any()
            .downcast_ref::<TimestampMicrosecondArray>()
            .unwrap();

        for row in 0..batch.num_rows() {
            let record = PersistedRun {
                run_id: run_ids.value(row).to_string(),
                target_branch: target_branches.value(row).to_string(),
                run_branch: run_branches.value(row).to_string(),
                status: statuses.value(row).to_string(),
                updated_at: updated_ats.value(row),
            };
            match latest.get(record.run_id.as_str()) {
                Some(existing) if existing.updated_at >= record.updated_at => {}
                _ => {
                    latest.insert(record.run_id.clone(), record);
                }
            }
        }
    }

    let mut records = latest.into_values().collect::<Vec<_>>();
    records.sort_by(|a, b| a.run_id.cmp(&b.run_id));
    records
}

#[tokio::test]
async fn begin_run_creates_hidden_internal_branch_and_isolates_writes() {
    let dir = tempfile::tempdir().unwrap();
    let mut db = init_and_load(&dir).await;
    let base_snapshot = db.resolve_snapshot("main").await.unwrap();

    let run = db.begin_run("main", Some("test-load")).await.unwrap();

    assert!(run.run_branch.starts_with("__run__"));
    assert_eq!(run.target_branch, "main");
    assert_eq!(run.base_snapshot_id, base_snapshot.as_str());
    assert_eq!(run.status, RunStatus::Running);
    assert_eq!(db.branch_list().await.unwrap(), vec!["main"]);

    db.load(
        &run.run_branch,
        r#"{"type":"Person","data":{"name":"Eve","age":22}}"#,
        LoadMode::Append,
    )
    .await
    .unwrap();

    let main_qr = db
        .query(
            ReadTarget::branch("main"),
            TEST_QUERIES,
            "get_person",
            &params(&[("$name", "Eve")]),
        )
        .await
        .unwrap();
    assert_eq!(main_qr.num_rows(), 0);

    let run_qr = db
        .query(
            ReadTarget::branch(run.run_branch.as_str()),
            TEST_QUERIES,
            "get_person",
            &params(&[("$name", "Eve")]),
        )
        .await
        .unwrap();
    assert_eq!(run_qr.num_rows(), 1);
}

#[tokio::test]
async fn publish_run_merges_internal_branch_into_target_and_marks_record() {
    let dir = tempfile::tempdir().unwrap();
    let mut db = init_and_load(&dir).await;
    let run = db.begin_run("main", Some("publish-test")).await.unwrap();

    db.load(
        &run.run_branch,
        r#"{"type":"Person","data":{"name":"Eve","age":22}}"#,
        LoadMode::Append,
    )
    .await
    .unwrap();

    let published_snapshot = db.publish_run(&run.run_id).await.unwrap();
    let record = db.get_run(&run.run_id).await.unwrap();

    assert_eq!(record.status, RunStatus::Published);
    assert_eq!(
        record.published_snapshot_id.as_deref(),
        Some(published_snapshot.as_str())
    );

    let main_qr = db
        .query(
            ReadTarget::branch("main"),
            TEST_QUERIES,
            "get_person",
            &params(&[("$name", "Eve")]),
        )
        .await
        .unwrap();
    assert_eq!(main_qr.num_rows(), 1);
}

#[tokio::test]
async fn abort_run_leaves_target_unchanged_and_deletes_run_branch() {
    let dir = tempfile::tempdir().unwrap();
    let mut db = init_and_load(&dir).await;
    let run = db.begin_run("main", Some("abort-test")).await.unwrap();

    db.load(
        &run.run_branch,
        r#"{"type":"Person","data":{"name":"Eve","age":22}}"#,
        LoadMode::Append,
    )
    .await
    .unwrap();

    let aborted = db.abort_run(&run.run_id).await.unwrap();
    assert_eq!(aborted.status, RunStatus::Aborted);

    let main_qr = db
        .query(
            ReadTarget::branch("main"),
            TEST_QUERIES,
            "get_person",
            &params(&[("$name", "Eve")]),
        )
        .await
        .unwrap();
    assert_eq!(main_qr.num_rows(), 0);

    let err = db
        .query(
            ReadTarget::branch(run.run_branch.as_str()),
            TEST_QUERIES,
            "get_person",
            &params(&[("$name", "Eve")]),
        )
        .await
        .unwrap_err();
    assert!(
        matches!(err, OmniError::Manifest(ref e) if e.kind == ManifestErrorKind::NotFound)
            || matches!(err, OmniError::Lance(_)),
        "run branch should be gone after abort, got: {}",
        err
    );
}

#[tokio::test]
async fn public_branch_apis_reject_internal_run_refs() {
    let dir = tempfile::tempdir().unwrap();
    let mut db = init_and_load(&dir).await;
    let run = db.begin_run("main", Some("guard-test")).await.unwrap();

    let merge_err = db.branch_merge(&run.run_branch, "main").await.unwrap_err();
    match merge_err {
        OmniError::Manifest(message) => assert!(message.message.contains("internal run refs")),
        other => panic!("unexpected error: {}", other),
    }

    let create_err = db.branch_create(&run.run_branch).await.unwrap_err();
    match create_err {
        OmniError::Manifest(message) => assert!(message.message.contains("internal run ref")),
        other => panic!("unexpected error: {}", other),
    }

    let delete_err = db.branch_delete(&run.run_branch).await.unwrap_err();
    match delete_err {
        OmniError::Manifest(message) => assert!(message.message.contains("internal run ref")),
        other => panic!("unexpected error: {}", other),
    }

    let fork_err = db
        .branch_create_from(ReadTarget::branch(run.run_branch.as_str()), "child")
        .await
        .unwrap_err();
    match fork_err {
        OmniError::Manifest(message) => assert!(message.message.contains("internal run ref")),
        other => panic!("unexpected error: {}", other),
    }
}

#[tokio::test]
async fn branch_delete_rejects_target_branches_with_active_runs() {
    let dir = tempfile::tempdir().unwrap();
    let mut db = init_and_load(&dir).await;
    db.branch_create("feature").await.unwrap();
    let run = db.begin_run("feature", Some("delete-guard")).await.unwrap();

    let err = db.branch_delete("feature").await.unwrap_err();
    assert!(err.to_string().contains(run.run_id.as_str()));
    assert!(err.to_string().contains("targeting it is running"));
}

#[tokio::test]
async fn public_load_uses_hidden_transactional_run_and_publishes_it() {
    let dir = tempfile::tempdir().unwrap();
    let uri = dir.path().to_str().unwrap();
    let mut db = Omnigraph::init(uri, TEST_SCHEMA).await.unwrap();

    let result = load_jsonl(&mut db, TEST_DATA, LoadMode::Overwrite)
        .await
        .unwrap();
    assert_eq!(result.nodes_loaded.len(), 2);
    assert_eq!(result.edges_loaded.len(), 2);
    assert_eq!(db.branch_list().await.unwrap(), vec!["main"]);

    let runs = latest_runs(uri).await;
    assert_eq!(runs.len(), 1);
    assert_eq!(runs[0].target_branch, "main");
    assert_eq!(runs[0].status, "published");
    assert!(runs[0].run_branch.starts_with("__run__"));

    let qr = db
        .query(
            ReadTarget::branch("main"),
            TEST_QUERIES,
            "get_person",
            &params(&[("$name", "Alice")]),
        )
        .await
        .unwrap();
    assert_eq!(qr.num_rows(), 1);
}

#[tokio::test]
async fn public_load_preserves_staged_edge_ids_on_publish() {
    let dir = tempfile::tempdir().unwrap();
    let uri = dir.path().to_str().unwrap();
    let mut db = Omnigraph::init(uri, TEST_SCHEMA).await.unwrap();

    let run = db.begin_run("main", Some("preserve-ids-load")).await.unwrap();
    db.load(&run.run_branch, TEST_DATA, LoadMode::Overwrite)
        .await
        .unwrap();

    let mut staged_ids = collect_column_strings(
        &read_table_branch(&db, run.run_branch.as_str(), "edge:Knows").await,
        "id",
    );
    staged_ids.sort();

    db.publish_run(&run.run_id).await.unwrap();

    let mut main_ids = collect_column_strings(&read_table(&db, "edge:Knows").await, "id");
    main_ids.sort();
    assert_eq!(main_ids, staged_ids);
}

#[tokio::test]
async fn failed_public_load_marks_run_failed_and_leaves_target_unchanged() {
    let dir = tempfile::tempdir().unwrap();
    let uri = dir.path().to_str().unwrap();
    let mut db = Omnigraph::init(uri, TEST_SCHEMA).await.unwrap();

    let bad = r#"{"type":"Person","data":{"name":"Alice","age":30}}
{"edge":"Knows","from":"Alice","to":"Missing"}"#;
    let err = load_jsonl(&mut db, bad, LoadMode::Overwrite)
        .await
        .unwrap_err();
    match err {
        OmniError::Manifest(message) => assert!(message.message.contains("not found in Person")),
        other => panic!("unexpected error: {}", other),
    }

    let runs = latest_runs(uri).await;
    assert_eq!(runs.len(), 1);
    assert_eq!(runs[0].status, "failed");
    assert!(runs[0].run_branch.starts_with("__run__"));

    let snap = snapshot_main(&db).await.unwrap();
    let person_count = snap
        .open("node:Person")
        .await
        .unwrap()
        .count_rows(None)
        .await
        .unwrap();
    assert_eq!(person_count, 0);
}

#[tokio::test]
async fn public_mutation_uses_hidden_transactional_run_and_publishes_it() {
    let dir = tempfile::tempdir().unwrap();
    let uri = dir.path().to_str().unwrap();
    let mut db = init_and_load(&dir).await;

    let result = db
        .mutate(
            "main",
            MUTATION_QUERIES,
            "insert_person",
            &mixed_params(&[("$name", "Eve")], &[("$age", 22)]),
        )
        .await
        .unwrap();
    assert_eq!(result.affected_nodes, 1);
    assert_eq!(result.affected_edges, 0);

    let runs = latest_runs(uri).await;
    assert!(!runs.is_empty());
    let latest = runs.last().unwrap();
    assert_eq!(latest.target_branch, "main");
    assert_eq!(latest.status, "published");
    assert!(latest.run_branch.starts_with("__run__"));

    let qr = db
        .query(
            ReadTarget::branch("main"),
            TEST_QUERIES,
            "get_person",
            &params(&[("$name", "Eve")]),
        )
        .await
        .unwrap();
    assert_eq!(qr.num_rows(), 1);
}

#[tokio::test]
async fn public_mutation_preserves_staged_edge_ids_on_publish() {
    let dir = tempfile::tempdir().unwrap();
    let mut db = init_and_load(&dir).await;

    let run = db
        .begin_run("main", Some("preserve-ids-mutation"))
        .await
        .unwrap();
    db.mutate(
        run.run_branch.as_str(),
        MUTATION_QUERIES,
        "add_friend",
        &params(&[("$from", "Alice"), ("$to", "Diana")]),
    )
    .await
    .unwrap();

    let mut staged_ids = collect_column_strings(
        &read_table_branch(&db, run.run_branch.as_str(), "edge:Knows").await,
        "id",
    );
    staged_ids.sort();

    db.publish_run(&run.run_id).await.unwrap();

    let mut main_ids = collect_column_strings(&read_table(&db, "edge:Knows").await, "id");
    main_ids.sort();
    assert_eq!(main_ids, staged_ids);
}

#[tokio::test]
async fn failed_public_mutation_marks_run_failed_and_leaves_target_unchanged() {
    let dir = tempfile::tempdir().unwrap();
    let uri = dir.path().to_str().unwrap();
    let mut db = init_and_load(&dir).await;

    let err = db
        .mutate(
            "main",
            MUTATION_QUERIES,
            "add_friend",
            &params(&[("$from", "Alice"), ("$to", "Missing")]),
        )
        .await
        .unwrap_err();
    match err {
        OmniError::Manifest(message) => assert!(message.message.contains("not found")),
        other => panic!("unexpected error: {}", other),
    }

    let runs = latest_runs(uri).await;
    assert!(!runs.is_empty());
    let latest = runs.last().unwrap();
    assert_eq!(latest.status, "failed");
    assert!(latest.run_branch.starts_with("__run__"));

    let qr = db
        .query(
            ReadTarget::branch("main"),
            TEST_QUERIES,
            "friends_of",
            &params(&[("$name", "Alice")]),
        )
        .await
        .unwrap();
    assert_eq!(qr.num_rows(), 2);
}

#[tokio::test]
async fn concurrent_conflicting_run_publish_fails_cleanly() {
    let dir = tempfile::tempdir().unwrap();
    let mut db = init_and_load(&dir).await;

    let run_a = db.begin_run("main", Some("conflict-a")).await.unwrap();
    let run_b = db.begin_run("main", Some("conflict-b")).await.unwrap();

    db.mutate(
        run_a.run_branch.as_str(),
        MUTATION_QUERIES,
        "set_age",
        &mixed_params(&[("$name", "Alice")], &[("$age", 31)]),
    )
    .await
    .unwrap();
    db.mutate(
        run_b.run_branch.as_str(),
        MUTATION_QUERIES,
        "set_age",
        &mixed_params(&[("$name", "Alice")], &[("$age", 32)]),
    )
    .await
    .unwrap();

    db.publish_run(&run_a.run_id).await.unwrap();
    let publish_b = db.publish_run(&run_b.run_id).await;
    assert!(publish_b.is_err(), "second conflicting publish should fail");
    let err = publish_b.unwrap_err().to_string();
    assert!(
        err.contains("conflict") || err.contains("divergent") || err.contains("Alice"),
        "unexpected conflict error: {}",
        err
    );

    let alice = db
        .query(
            ReadTarget::branch("main"),
            TEST_QUERIES,
            "get_person",
            &params(&[("$name", "Alice")]),
        )
        .await
        .unwrap();
    let rows = alice.to_rust_json();
    assert_eq!(alice.num_rows(), 1);
    assert_eq!(rows[0]["p.age"], serde_json::json!(31));

    let run_a_record = db.get_run(&run_a.run_id).await.unwrap();
    assert_eq!(run_a_record.status, RunStatus::Published);
    let run_b_record = db.get_run(&run_b.run_id).await.unwrap();
    assert_eq!(run_b_record.status, RunStatus::Running);
}

#[tokio::test]
async fn public_mutation_records_actor_on_run_and_published_commit() {
    let dir = tempfile::tempdir().unwrap();
    let uri = dir.path().to_str().unwrap();
    let mut db = init_and_load(&dir).await;

    db.mutate_as(
        "main",
        MUTATION_QUERIES,
        "set_age",
        &mixed_params(&[("$name", "Alice")], &[("$age", 31)]),
        Some("act-andrew"),
    )
    .await
    .unwrap();

    let runs = db.list_runs().await.unwrap();
    let run = runs
        .iter()
        .find(|run| run.operation_hash.as_deref() == Some("mutation:set_age:branch=main"))
        .expect("published mutation run should exist");
    assert_eq!(run.actor_id.as_deref(), Some("act-andrew"));
    assert_eq!(run.status, RunStatus::Published);

    let head = CommitGraph::open(uri)
        .await
        .unwrap()
        .head_commit()
        .await
        .unwrap()
        .unwrap();
    assert_eq!(head.actor_id.as_deref(), Some("act-andrew"));
}

#[tokio::test]
async fn run_branches_do_not_accumulate_across_repeated_loads() {
    // MR-674: run branches are transactional scaffolding. Every terminal
    // state (Published, Aborted, Failed) deletes the branch. Verifying the
    // invariant end-to-end: after 10 publishes and one abort, only main
    // should remain.
    let dir = tempfile::tempdir().unwrap();
    let uri = dir.path().to_str().unwrap();
    let mut db = Omnigraph::init(uri, TEST_SCHEMA).await.unwrap();

    for i in 0..10 {
        let payload = format!(
            r#"{{"type":"Person","data":{{"name":"p{}","age":{}}}}}"#,
            i, i
        );
        load_jsonl(&mut db, &payload, LoadMode::Append)
            .await
            .unwrap();
    }

    let aborted_run = db.begin_run("main", Some("abort-me")).await.unwrap();
    db.abort_run(&aborted_run.run_id).await.unwrap();

    assert_eq!(db.branch_list().await.unwrap(), vec!["main".to_string()]);
    let all_branches = Omnigraph::open(uri)
        .await
        .unwrap()
        .branch_list()
        .await
        .unwrap();
    assert_eq!(all_branches, vec!["main".to_string()]);
}

#[tokio::test]
async fn failed_load_deletes_run_branch() {
    let dir = tempfile::tempdir().unwrap();
    let uri = dir.path().to_str().unwrap();
    let mut db = Omnigraph::init(uri, TEST_SCHEMA).await.unwrap();

    let bad = r#"{"type":"Person","data":{"name":"Alice","age":30}}
{"edge":"Knows","from":"Alice","to":"Missing"}"#;
    let _ = load_jsonl(&mut db, bad, LoadMode::Overwrite).await;

    let runs = latest_runs(uri).await;
    assert_eq!(runs.len(), 1);
    assert_eq!(runs[0].status, "failed");

    let err = db
        .snapshot_of(ReadTarget::branch(runs[0].run_branch.as_str()))
        .await
        .unwrap_err();
    assert!(
        matches!(err, OmniError::Manifest(ref e) if e.kind == ManifestErrorKind::NotFound)
            || matches!(err, OmniError::Lance(_)),
        "failed run's branch should be gone, got: {}",
        err
    );
}