sqlitegraph 2.0.7

Embedded graph database with full ACID transactions, HNSW vector search, dual backend support, and comprehensive graph algorithms library
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
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
//! Comprehensive test suite for graph operations

use super::super::{EdgeStore, NodeStore};
use super::*;
use crate::backend::native::adjacency::Direction;
use crate::backend::native::clear_node_cache;
use crate::backend::{BackendDirection, ChainStep, EdgeSpec, NodeSpec};
use tempfile::NamedTempFile;

fn create_test_graph_file() -> (GraphFile, NamedTempFile) {
    let temp_file = NamedTempFile::new().unwrap();
    let path = temp_file.path();
    let graph_file = GraphFile::create(path).unwrap();
    (graph_file, temp_file)
}

#[test]
fn test_native_bfs_simple() {
    // Clear cache to ensure test isolation
    clear_node_cache();

    let (mut graph_file, _temp_file) = create_test_graph_file();

    // Create nodes
    let node1 = NodeRecord::new(
        1,
        "Test".to_string(),
        "node1".to_string(),
        serde_json::json!({}),
    );
    let node2 = NodeRecord::new(
        2,
        "Test".to_string(),
        "node2".to_string(),
        serde_json::json!({}),
    );
    let node3 = NodeRecord::new(
        3,
        "Test".to_string(),
        "node3".to_string(),
        serde_json::json!({}),
    );

    {
        let mut node_store = NodeStore::new(&mut graph_file);
        node_store.write_node(&node1).unwrap();
        node_store.write_node(&node2).unwrap();
        node_store.write_node(&node3).unwrap();
    }

    // Create edges: 1 -> 2 -> 3
    let edge1 = EdgeRecord::new(1, 1, 2, "test".to_string(), serde_json::json!({}));
    let edge2 = EdgeRecord::new(2, 2, 3, "test".to_string(), serde_json::json!({}));

    {
        let mut edge_store = EdgeStore::new(&mut graph_file);
        edge_store.write_edge(&edge1).unwrap();
        edge_store.write_edge(&edge2).unwrap();
    }

    let result = native_bfs(&mut graph_file, 1, 2).unwrap();
    assert!(
        result.contains(&2),
        "Expected to find node 2 in BFS result: {:?}",
        result
    );
    assert!(
        result.contains(&3),
        "Expected to find node 3 in BFS result: {:?}",
        result
    );
}

#[test]
fn test_native_shortest_path() {
    // Clear cache to ensure test isolation
    clear_node_cache();

    let (mut graph_file, _temp_file) = create_test_graph_file();

    // Create nodes
    let node1 = NodeRecord::new(
        1,
        "Test".to_string(),
        "node1".to_string(),
        serde_json::json!({}),
    );
    let node2 = NodeRecord::new(
        2,
        "Test".to_string(),
        "node2".to_string(),
        serde_json::json!({}),
    );
    let node3 = NodeRecord::new(
        3,
        "Test".to_string(),
        "node3".to_string(),
        serde_json::json!({}),
    );

    {
        let mut node_store = NodeStore::new(&mut graph_file);
        node_store.write_node(&node1).unwrap();
        node_store.write_node(&node2).unwrap();
        node_store.write_node(&node3).unwrap();
    }

    // Create edge: 1 -> 2 -> 3
    let edge1 = EdgeRecord::new(1, 1, 2, "test".to_string(), serde_json::json!({}));
    let edge2 = EdgeRecord::new(2, 2, 3, "test".to_string(), serde_json::json!({}));

    {
        let mut edge_store = EdgeStore::new(&mut graph_file);
        edge_store.write_edge(&edge1).unwrap();
        edge_store.write_edge(&edge2).unwrap();
    }

    let result = native_shortest_path(&mut graph_file, 1, 3).unwrap();
    assert!(result.is_some());
    let path = result.unwrap();
    assert_eq!(path, vec![1, 2, 3]);
}

#[test]
fn test_bfs_cache_evaporates() {
    clear_node_cache();

    let (mut graph_file, _temp_file) = create_test_graph_file();

    // Create chain: 1 -> 2 -> 3 -> 4 -> 5
    for i in 1..=5 {
        let node = NodeRecord::new(
            i,
            "Test".to_string(),
            format!("node{}", i),
            serde_json::json!({}),
        );
        let mut node_store = NodeStore::new(&mut graph_file);
        node_store.write_node(&node).unwrap();
    }

    // Create edges
    for i in 1..4 {
        let edge = EdgeRecord::new(i, i, i + 1, "test".to_string(), serde_json::json!({}));
        let mut edge_store = EdgeStore::new(&mut graph_file);
        edge_store.write_edge(&edge).unwrap();
    }

    // First BFS
    let result1 = native_bfs(&mut graph_file, 1, 2).unwrap();
    let expected: Vec<NativeNodeId> = vec![2, 3];
    assert_eq!(result1, expected, "First BFS should return nodes 2, 3");

    // Second BFS with same parameters
    let result2 = native_bfs(&mut graph_file, 1, 2).unwrap();
    assert_eq!(result2, expected, "Second BFS should return same result");

    // Third BFS from different start node
    let result3 = native_bfs(&mut graph_file, 3, 1).unwrap();
    let expected3: Vec<NativeNodeId> = vec![4];
    assert_eq!(
        result3, expected3,
        "Third BFS from node 3 should return node 4"
    );

    // All BFS calls produce correct results, proving cache doesn't cause cross-call pollution
}

#[test]
fn test_bfs_cache_cycles() {
    clear_node_cache();

    let (mut graph_file, _temp_file) = create_test_graph_file();

    // Create diamond + cycle graph: 1->2, 1->3, 2->4, 3->4, 4->2
    for i in 1..=4 {
        let node = NodeRecord::new(
            i,
            "Test".to_string(),
            format!("node{}", i),
            serde_json::json!({}),
        );
        let mut node_store = NodeStore::new(&mut graph_file);
        node_store.write_node(&node).unwrap();
    }

    // Diamond edges: 1->2, 1->3, 2->4, 3->4
    let edges = [(1, 2), (1, 3), (2, 4), (3, 4)];
    for (i, (from, to)) in edges.iter().enumerate() {
        let edge = EdgeRecord::new(
            i as NativeNodeId + 1,
            *from,
            *to,
            "test".to_string(),
            serde_json::json!({}),
        );
        let mut edge_store = EdgeStore::new(&mut graph_file);
        edge_store.write_edge(&edge).unwrap();
    }

    // Cycle edge: 4->2
    let cycle_edge = EdgeRecord::new(5, 4, 2, "test".to_string(), serde_json::json!({}));
    let mut edge_store = EdgeStore::new(&mut graph_file);
    edge_store.write_edge(&cycle_edge).unwrap();

    // BFS from node 1, depth 3
    let result = native_bfs(&mut graph_file, 1, 3).unwrap();

    // Should find nodes 2, 3, 4 (node 4 discovered twice but visited once)
    assert!(result.contains(&2), "Should contain node 2");
    assert!(result.contains(&3), "Should contain node 3");
    assert!(result.contains(&4), "Should contain node 4");

    // Node 4 should appear only once in result (BFS deduplication via visited set)
    let count_4 = result.iter().filter(|&&n| n == 4).count();
    assert_eq!(
        count_4, 1,
        "Node 4 should appear exactly once despite two paths"
    );
}

#[test]
fn test_bfs_unchanged_behavior() {
    clear_node_cache();

    let (mut graph_file, _temp_file) = create_test_graph_file();

    // Create star graph: 1 -> 2, 1 -> 3, 1 -> 4, 1 -> 5
    for i in 1..=5 {
        let node = NodeRecord::new(
            i,
            "Test".to_string(),
            format!("node{}", i),
            serde_json::json!({}),
        );
        let mut node_store = NodeStore::new(&mut graph_file);
        node_store.write_node(&node).unwrap();
    }

    // Star edges from center node 1
    for i in 2..=5 {
        let edge = EdgeRecord::new(i, 1, i, "test".to_string(), serde_json::json!({}));
        let mut edge_store = EdgeStore::new(&mut graph_file);
        edge_store.write_edge(&edge).unwrap();
    }

    // BFS depth 1 should return all neighbors of node 1
    let result = native_bfs(&mut graph_file, 1, 1).unwrap();
    let mut expected = vec![2, 3, 4, 5];
    expected.sort();
    let mut result_sorted = result.clone();
    result_sorted.sort();
    assert_eq!(
        result_sorted, expected,
        "BFS depth 1 should return all direct neighbors"
    );

    // BFS depth 0 should return just start node
    let result_zero = native_bfs(&mut graph_file, 1, 0).unwrap();
    assert_eq!(
        result_zero,
        vec![1],
        "BFS depth 0 should return start node only"
    );

    // BFS from leaf node (no outgoing edges) should return empty
    let result_leaf = native_bfs(&mut graph_file, 2, 2).unwrap();
    assert!(
        result_leaf.is_empty(),
        "BFS from leaf node should return empty"
    );
}

// K-hop cache tests

#[test]
fn test_k_hop_cache_evaporation() {
    clear_node_cache();

    let (mut graph_file, _temp_file) = create_test_graph_file();

    // Create triangle graph: 1 -> 2 -> 3 -> 1
    for i in 1..=3 {
        let node = NodeRecord::new(
            i,
            "Test".to_string(),
            format!("node{}", i),
            serde_json::json!({}),
        );
        let mut node_store = NodeStore::new(&mut graph_file);
        node_store.write_node(&node).unwrap();
    }

    // Triangle edges: 1->2, 2->3, 3->1
    let edges = [(1, 2), (2, 3), (3, 1)];
    for (i, (from, to)) in edges.iter().enumerate() {
        let edge = EdgeRecord::new(
            i as NativeNodeId + 1,
            *from,
            *to,
            "test".to_string(),
            serde_json::json!({}),
        );
        let mut edge_store = EdgeStore::new(&mut graph_file);
        edge_store.write_edge(&edge).unwrap();
    }

    // First k-hop call (depth=1 from node 1)
    let result1 = native_k_hop(&mut graph_file, 1, 1, Direction::Outgoing).unwrap();
    let mut expected1 = vec![2];
    expected1.sort();
    let mut result1_sorted = result1.clone();
    result1_sorted.sort();
    assert_eq!(
        result1_sorted, expected1,
        "First k-hop should return node 2"
    );

    // Second k-hop call with same parameters
    let result2 = native_k_hop(&mut graph_file, 1, 1, Direction::Outgoing).unwrap();
    let mut result2_sorted = result2.clone();
    result2_sorted.sort();
    assert_eq!(
        result2_sorted, expected1,
        "Second k-hop should return same result"
    );

    // Third k-hop call with different parameters
    let result3 = native_k_hop(&mut graph_file, 2, 1, Direction::Outgoing).unwrap();
    let mut expected3 = vec![3];
    expected3.sort();
    let mut result3_sorted = result3.clone();
    result3_sorted.sort();
    assert_eq!(
        result3_sorted, expected3,
        "Third k-hop from node 2 should return node 3"
    );

    // All k-hop calls produce correct results, proving cache doesn't cause cross-call pollution
}

#[test]
fn test_k_hop_cache_effectiveness() {
    clear_node_cache();

    let (mut graph_file, _temp_file) = create_test_graph_file();

    // Create diamond graph: 1 -> 2, 1 -> 3, 2 -> 4, 3 -> 4
    for i in 1..=4 {
        let node = NodeRecord::new(
            i,
            "Test".to_string(),
            format!("node{}", i),
            serde_json::json!({}),
        );
        let mut node_store = NodeStore::new(&mut graph_file);
        node_store.write_node(&node).unwrap();
    }

    // Diamond edges
    let edges = [(1, 2), (1, 3), (2, 4), (3, 4)];
    for (i, (from, to)) in edges.iter().enumerate() {
        let edge = EdgeRecord::new(
            i as NativeNodeId + 1,
            *from,
            *to,
            "test".to_string(),
            serde_json::json!({}),
        );
        let mut edge_store = EdgeStore::new(&mut graph_file);
        edge_store.write_edge(&edge).unwrap();
    }

    // K-hop depth=2 from node 1 should reach node 4 via two paths
    let result = native_k_hop(&mut graph_file, 1, 2, Direction::Outgoing).unwrap();

    // Node 4 should be in results (reached via 1->2->4 and 1->3->4)
    assert!(result.contains(&4), "Should contain node 4 at depth 2");

    // Nodes 2 and 3 should be in results (depth 1)
    assert!(result.contains(&2), "Should contain node 2 at depth 1");
    assert!(result.contains(&3), "Should contain node 3 at depth 1");

    // Node 4 should appear only once (k-hop deduplicates via visited set)
    let count_4 = result.iter().filter(|&&n| n == 4).count();
    assert_eq!(
        count_4, 1,
        "Node 4 should appear exactly once despite two paths"
    );

    // Result correctness proves cache doesn't break k-hop semantics
}

// Shortest path cache tests

#[test]
fn test_shortest_path_cache_evaporation() {
    clear_node_cache();

    let (mut graph_file, _temp_file) = create_test_graph_file();

    // Create linear graph: 1 -> 2 -> 3 -> 4
    for i in 1..=4 {
        let node = NodeRecord::new(
            i,
            "Test".to_string(),
            format!("node{}", i),
            serde_json::json!({}),
        );
        let mut node_store = NodeStore::new(&mut graph_file);
        node_store.write_node(&node).unwrap();
    }

    // Linear edges: 1->2, 2->3, 3->4
    let edges = [(1, 2), (2, 3), (3, 4)];
    for (i, (from, to)) in edges.iter().enumerate() {
        let edge = EdgeRecord::new(
            i as NativeNodeId + 1,
            *from,
            *to,
            "test".to_string(),
            serde_json::json!({}),
        );
        let mut edge_store = EdgeStore::new(&mut graph_file);
        edge_store.write_edge(&edge).unwrap();
    }

    // First shortest path call
    let result1 = native_shortest_path(&mut graph_file, 1, 4).unwrap();
    assert!(result1.is_some(), "Should find a path from 1 to 4");
    assert_eq!(
        result1.unwrap(),
        vec![1, 2, 3, 4],
        "First shortest path should be [1,2,3,4]"
    );

    // Second shortest path call with same parameters
    let result2 = native_shortest_path(&mut graph_file, 1, 4).unwrap();
    assert!(result2.is_some(), "Should find a path from 1 to 4");
    assert_eq!(
        result2.unwrap(),
        vec![1, 2, 3, 4],
        "Second shortest path should be [1,2,3,4]"
    );

    // Third shortest path call with different parameters
    let result3 = native_shortest_path(&mut graph_file, 2, 4).unwrap();
    assert!(result3.is_some(), "Should find a path from 2 to 4");
    assert_eq!(
        result3.unwrap(),
        vec![2, 3, 4],
        "Third shortest path from 2 to 4 should be [2,3,4]"
    );

    // All shortest path calls produce correct results, proving cache doesn't cause cross-call pollution
}

#[test]
fn test_shortest_path_cache_effectiveness() {
    clear_node_cache();

    let (mut graph_file, _temp_file) = create_test_graph_file();

    // Create diamond graph with branching paths: 1 -> 2 -> 4, 1 -> 3 -> 4
    for i in 1..=4 {
        let node = NodeRecord::new(
            i,
            "Test".to_string(),
            format!("node{}", i),
            serde_json::json!({}),
        );
        let mut node_store = NodeStore::new(&mut graph_file);
        node_store.write_node(&node).unwrap();
    }

    // Diamond edges: 1->2, 1->3, 2->4, 3->4
    let edges = [(1, 2), (1, 3), (2, 4), (3, 4)];
    for (i, (from, to)) in edges.iter().enumerate() {
        let edge = EdgeRecord::new(
            i as NativeNodeId + 1,
            *from,
            *to,
            "test".to_string(),
            serde_json::json!({}),
        );
        let mut edge_store = EdgeStore::new(&mut graph_file);
        edge_store.write_edge(&edge).unwrap();
    }

    // Shortest path from 1 to 4
    let result = native_shortest_path(&mut graph_file, 1, 4).unwrap();

    assert!(result.is_some(), "Should find a path from 1 to 4");
    let path = result.unwrap();

    // Either path [1,2,4] or [1,3,4] is valid (both are shortest paths of length 3)
    let valid_path = path == vec![1, 2, 4] || path == vec![1, 3, 4];
    assert!(
        valid_path,
        "Path should be [1,2,4] or [1,3,4], got {:?}",
        path
    );

    // Path length should be 3
    assert_eq!(path.len(), 3, "Shortest path should have length 3");

    // Path should start at 1 and end at 4
    assert_eq!(path[0], 1, "Path should start at node 1");
    assert_eq!(path[2], 4, "Path should end at node 4");

    // Result correctness proves cache doesn't break shortest path semantics
    // The BFS explores both paths; cache prevents re-reading node 1's neighbors when dequeuing 2 and 3
}

// Chain query cache tests

#[test]
fn test_chain_query_cache_evaporation() {
    clear_node_cache();

    let (mut graph_file, _temp_file) = create_test_graph_file();

    // Create graph: 1 -> 2 -> 3 -> 4, 1 -> 5 -> 6
    for i in 1..=6 {
        let node = NodeRecord::new(
            i,
            "Test".to_string(),
            format!("node{}", i),
            serde_json::json!({}),
        );
        let mut node_store = NodeStore::new(&mut graph_file);
        node_store.write_node(&node).unwrap();
    }

    // Edges: 1->2, 2->3, 3->4, 1->5, 5->6
    let edges = [(1, 2), (2, 3), (3, 4), (1, 5), (5, 6)];
    for (i, (from, to)) in edges.iter().enumerate() {
        let edge = EdgeRecord::new(
            i as NativeNodeId + 1,
            *from,
            *to,
            "test".to_string(),
            serde_json::json!({}),
        );
        let mut edge_store = EdgeStore::new(&mut graph_file);
        edge_store.write_edge(&edge).unwrap();
    }

    // Define chain: [outgoing, outgoing]
    let chain = vec![
        ChainStep {
            direction: BackendDirection::Outgoing,
            edge_type: None,
        },
        ChainStep {
            direction: BackendDirection::Outgoing,
            edge_type: None,
        },
    ];

    // First chain query call from node 1
    let result1 = native_chain_query(&mut graph_file, 1, &chain).unwrap();
    let mut expected1 = vec![1, 2, 3, 5, 6];
    expected1.sort();
    let mut result1_sorted = result1.clone();
    result1_sorted.sort();
    assert_eq!(
        result1_sorted, expected1,
        "First chain query should return nodes [1,2,3,5,6], got {:?}",
        result1_sorted
    );

    // Second chain query call with same parameters
    let result2 = native_chain_query(&mut graph_file, 1, &chain).unwrap();
    let mut result2_sorted = result2.clone();
    result2_sorted.sort();
    assert_eq!(
        result2_sorted, expected1,
        "Second chain query should return same result"
    );

    // Third chain query call from node 2 (single path chain)
    let result3 = native_chain_query(&mut graph_file, 2, &chain).unwrap();
    let mut expected3 = vec![2, 3, 4];
    expected3.sort();
    let mut result3_sorted = result3.clone();
    result3_sorted.sort();
    assert_eq!(
        result3_sorted, expected3,
        "Third chain query from node 2 should return [2,3,4], got {:?}",
        result3_sorted
    );

    // All chain query calls produce correct results, proving cache doesn't cause cross-call pollution
}

#[test]
fn test_chain_query_cache_effectiveness() {
    clear_node_cache();

    let (mut graph_file, _temp_file) = create_test_graph_file();

    // Create diamond-like chain graph: 1 -> 2, 1 -> 3, 2 -> 4, 3 -> 4
    for i in 1..=4 {
        let node = NodeRecord::new(
            i,
            "Test".to_string(),
            format!("node{}", i),
            serde_json::json!({}),
        );
        let mut node_store = NodeStore::new(&mut graph_file);
        node_store.write_node(&node).unwrap();
    }

    // Diamond edges: 1->2, 1->3, 2->4, 3->4
    let edges = [(1, 2), (1, 3), (2, 4), (3, 4)];
    for (i, (from, to)) in edges.iter().enumerate() {
        let edge = EdgeRecord::new(
            i as NativeNodeId + 1,
            *from,
            *to,
            "test".to_string(),
            serde_json::json!({}),
        );
        let mut edge_store = EdgeStore::new(&mut graph_file);
        edge_store.write_edge(&edge).unwrap();
    }

    // Define chain: [outgoing, outgoing]
    let chain = vec![
        ChainStep {
            direction: BackendDirection::Outgoing,
            edge_type: None,
        },
        ChainStep {
            direction: BackendDirection::Outgoing,
            edge_type: None,
        },
    ];

    // Chain query from node 1
    let result = native_chain_query(&mut graph_file, 1, &chain).unwrap();

    // Result should contain start node (1), first hop (2, 3), and second hop (4)
    assert!(result.contains(&1), "Should contain start node 1");
    assert!(result.contains(&2), "Should contain node 2 (first hop)");
    assert!(result.contains(&3), "Should contain node 3 (first hop)");
    assert!(
        result.contains(&4),
        "Should contain node 4 (second hop via 1->2->4 or 1->3->4)"
    );

    // Node 4 appears twice because both paths (1->2->4 and 1->3->4) reach it
    // and chain query uses extend() without deduplication
    let count_4 = result.iter().filter(|&&n| n == 4).count();
    assert_eq!(count_4, 2, "Node 4 appears twice (once per path)");

    // Result length should be 5 (nodes 1, 2, 3, 4, 4)
    assert_eq!(
        result.len(),
        5,
        "Chain query should return 5 nodes (with 4 duplicated)"
    );

    // Result correctness proves cache works for multi-step traversals
    // The cache prevents re-reading outgoing neighbors of node 1 when processing both paths
}