interstellar 0.2.0

A high-performance graph database with Gremlin-style traversals and GQL query language
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
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
//! Integration tests for side effect steps.
//!
//! These tests verify side effect functionality including:
//! - `store()` - lazy storage of values
//! - `aggregate()` - barrier storage of values
//! - `cap()` - retrieval of side effect data
//! - `side_effect()` - execute sub-traversal for side effects
//! - `profile()` - collect profiling information
//!
//! Tests also verify that side effects work correctly with:
//! - Anonymous traversals using the `__` factory module
//! - Complex traversal pipelines
//! - Path tracking enabled/disabled

use std::collections::HashMap;

use interstellar::storage::Graph;
use interstellar::traversal::__;
use interstellar::value::{Value, VertexId};

// =============================================================================
// Test Graph Setup
// =============================================================================

/// Test graph with vertex IDs for use in tests.
#[allow(dead_code)]
struct TestGraph {
    graph: Graph,
    alice: VertexId,
    bob: VertexId,
    charlie: VertexId,
    graphdb: VertexId,
    redis: VertexId,
}

/// Creates a test graph with:
/// - 5 vertices: Alice (person), Bob (person), Charlie (person), GraphDB (software), Redis (software)
/// - Multiple edges for testing side effects
///
/// Graph structure:
/// ```text
///     Alice ----knows----> Bob ----knows----> Charlie
///       |                   |                   
///       |                   |                   
///     created             created              
///       |                   |                   
///       v                   v                   
///     GraphDB              Redis               
/// ```
fn create_test_graph() -> TestGraph {
    let graph = Graph::new();

    // Add person vertices
    let alice = graph.add_vertex("person", {
        let mut props = HashMap::new();
        props.insert("name".to_string(), Value::String("Alice".to_string()));
        props.insert("age".to_string(), Value::Int(30));
        props
    });

    let bob = graph.add_vertex("person", {
        let mut props = HashMap::new();
        props.insert("name".to_string(), Value::String("Bob".to_string()));
        props.insert("age".to_string(), Value::Int(25));
        props
    });

    let charlie = graph.add_vertex("person", {
        let mut props = HashMap::new();
        props.insert("name".to_string(), Value::String("Charlie".to_string()));
        props.insert("age".to_string(), Value::Int(35));
        props
    });

    // Add software vertices
    let graphdb = graph.add_vertex("software", {
        let mut props = HashMap::new();
        props.insert("name".to_string(), Value::String("GraphDB".to_string()));
        props.insert("version".to_string(), Value::Float(2.0));
        props
    });

    let redis = graph.add_vertex("software", {
        let mut props = HashMap::new();
        props.insert("name".to_string(), Value::String("Redis".to_string()));
        props.insert("version".to_string(), Value::Float(7.0));
        props
    });

    // Add edges
    // Alice knows Bob
    graph
        .add_edge(alice, bob, "knows", {
            let mut props = HashMap::new();
            props.insert("since".to_string(), Value::Int(2020));
            props
        })
        .unwrap();

    // Bob knows Charlie
    graph
        .add_edge(bob, charlie, "knows", {
            let mut props = HashMap::new();
            props.insert("since".to_string(), Value::Int(2021));
            props
        })
        .unwrap();

    // Alice created GraphDB
    graph
        .add_edge(alice, graphdb, "created", {
            let mut props = HashMap::new();
            props.insert("year".to_string(), Value::Int(2019));
            props
        })
        .unwrap();

    // Bob created Redis
    graph
        .add_edge(bob, redis, "created", {
            let mut props = HashMap::new();
            props.insert("year".to_string(), Value::Int(2020));
            props
        })
        .unwrap();

    TestGraph {
        graph,
        alice,
        bob,
        charlie,
        graphdb,
        redis,
    }
}

// =============================================================================
// Store Step Tests
// =============================================================================

#[test]
fn test_store_stores_vertex_values() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    // Store all person vertices
    let results = g
        .v()
        .has_label("person")
        .store("people")
        .cap("people")
        .to_list();

    assert_eq!(results.len(), 1);
    if let Value::List(people) = &results[0] {
        assert_eq!(people.len(), 3);
        // Should contain Alice, Bob, and Charlie vertices
        assert!(people.iter().all(|v| matches!(v, Value::Vertex(_))));
    } else {
        panic!("Expected Value::List");
    }
}

#[test]
fn test_store_stores_property_values() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    // Store all person names
    let results = g
        .v()
        .has_label("person")
        .values("name")
        .store("names")
        .cap("names")
        .to_list();

    assert_eq!(results.len(), 1);
    if let Value::List(names) = &results[0] {
        assert_eq!(names.len(), 3);
        let name_strings: Vec<&str> = names.iter().filter_map(|v| v.as_str()).collect();
        assert!(name_strings.contains(&"Alice"));
        assert!(name_strings.contains(&"Bob"));
        assert!(name_strings.contains(&"Charlie"));
    } else {
        panic!("Expected Value::List");
    }
}

#[test]
fn test_store_is_lazy() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    // Note: Due to the traversal executor's eager collection after each step,
    // store() will process all values from the previous step before limit()
    // takes effect. This test verifies that store passes through values correctly.
    let results = g
        .v()
        .has_label("person")
        .store("x")
        .limit(2)
        .cap("x")
        .to_list();

    assert_eq!(results.len(), 1);
    if let Value::List(stored) = &results[0] {
        // With true lazy evaluation, limit(2) short-circuits the pipeline
        // after 2 values, so store() only sees 2 values. This is the correct
        // lazy evaluation behavior - traversers flow through one at a time,
        // and limit stops pulling after it has enough.
        assert_eq!(stored.len(), 2);
    } else {
        panic!("Expected Value::List");
    }
}

#[test]
fn test_store_preserves_traverser_values() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    // Store should pass through values unchanged
    let results = g
        .v()
        .has_label("person")
        .values("age")
        .store("ages")
        .to_list();

    // Should have all 3 ages pass through
    assert_eq!(results.len(), 3);
    let ages: Vec<i64> = results.iter().filter_map(|v| v.as_i64()).collect();
    assert!(ages.contains(&30)); // Alice
    assert!(ages.contains(&25)); // Bob
    assert!(ages.contains(&35)); // Charlie
}

// =============================================================================
// Aggregate Step Tests
// =============================================================================

#[test]
fn test_aggregate_collects_all_values() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    // Aggregate all person vertices
    let results = g
        .v()
        .has_label("person")
        .aggregate("all_people")
        .cap("all_people")
        .to_list();

    assert_eq!(results.len(), 1);
    if let Value::List(people) = &results[0] {
        assert_eq!(people.len(), 3);
    } else {
        panic!("Expected Value::List");
    }
}

#[test]
fn test_aggregate_is_barrier() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    // Aggregate is a barrier - it collects ALL values before continuing
    // Even with limit after aggregate, all values are collected
    let results = g
        .v()
        .has_label("person")
        .aggregate("x")
        .limit(1)
        .cap("x")
        .to_list();

    assert_eq!(results.len(), 1);
    if let Value::List(stored) = &results[0] {
        // All 3 values should be stored because aggregate is a barrier
        assert_eq!(stored.len(), 3);
    } else {
        panic!("Expected Value::List");
    }
}

#[test]
fn test_aggregate_re_emits_all_values() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    // After aggregate, all values should continue through the pipeline
    let results = g
        .v()
        .has_label("person")
        .aggregate("x")
        .values("name")
        .to_list();

    // All 3 person names should be emitted
    assert_eq!(results.len(), 3);
    let names: Vec<&str> = results.iter().filter_map(|v| v.as_str()).collect();
    assert!(names.contains(&"Alice"));
    assert!(names.contains(&"Bob"));
    assert!(names.contains(&"Charlie"));
}

// =============================================================================
// Cap Step Tests
// =============================================================================

#[test]
fn test_cap_single_key_returns_list() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    let results = g.v().has_label("person").store("x").cap("x").to_list();

    assert_eq!(results.len(), 1);
    assert!(matches!(&results[0], Value::List(_)));
}

#[test]
fn test_cap_multi_returns_map() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    // Store in two different keys
    let results = g
        .v()
        .has_label("person")
        .store("people")
        .values("name")
        .store("names")
        .cap_multi(["people", "names"])
        .to_list();

    assert_eq!(results.len(), 1);
    if let Value::Map(map) = &results[0] {
        assert!(map.contains_key("people"));
        assert!(map.contains_key("names"));
    } else {
        panic!("Expected Value::Map");
    }
}

#[test]
fn test_cap_missing_key_returns_empty_list() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    let results = g
        .v()
        .has_label("person")
        .store("x")
        .cap("nonexistent")
        .to_list();

    assert_eq!(results.len(), 1);
    if let Value::List(list) = &results[0] {
        assert!(list.is_empty());
    } else {
        panic!("Expected Value::List");
    }
}

#[test]
fn test_cap_consumes_input_stream() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    // Cap should consume input, then emit the side effect data
    let results = g.v().has_label("person").store("x").cap("x").to_list();

    // Cap emits one list
    assert_eq!(results.len(), 1);
}

// =============================================================================
// SideEffect Step Tests
// =============================================================================

#[test]
fn test_side_effect_executes_sub_traversal() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    // Execute side effect that stores neighbors
    let results = g
        .v_ids([test.alice])
        .side_effect(__.out().store("neighbors"))
        .cap("neighbors")
        .to_list();

    assert_eq!(results.len(), 1);
    if let Value::List(neighbors) = &results[0] {
        // Alice has 2 outgoing neighbors (Bob via knows, GraphDB via created)
        assert_eq!(neighbors.len(), 2);
    } else {
        panic!("Expected Value::List");
    }
}

#[test]
fn test_side_effect_preserves_original_traverser() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    // Side effect should pass through original traverser
    let results = g
        .v_ids([test.alice])
        .side_effect(__.out().store("neighbors"))
        .values("name")
        .to_list();

    // Should have Alice's name
    assert_eq!(results.len(), 1);
    assert_eq!(results[0], Value::String("Alice".to_string()));
}

#[test]
fn test_side_effect_with_complex_sub_traversal() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    // Side effect with filtering in sub-traversal
    let count = g
        .v()
        .has_label("person")
        .side_effect(__.out_labels(&["knows"]).store("friends"))
        .count();

    // Count of input traversers (3 people)
    assert_eq!(count, 3);
}

// =============================================================================
// Profile Step Tests
// =============================================================================

#[test]
fn test_profile_records_count() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    let results = g.v().has_label("person").profile().cap("profile").to_list();

    assert_eq!(results.len(), 1);
    // Cap returns a list, profile data is the first (and only) element
    if let Value::List(list) = &results[0] {
        assert_eq!(list.len(), 1);
        if let Value::Map(profile) = &list[0] {
            let count = profile.get("count");
            assert_eq!(count, Some(&Value::Int(3)));
        } else {
            panic!("Expected Value::Map inside list, got {:?}", list[0]);
        }
    } else {
        panic!("Expected Value::List, got {:?}", results[0]);
    }
}

#[test]
fn test_profile_records_time() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    let results = g.v().has_label("person").profile().cap("profile").to_list();

    assert_eq!(results.len(), 1);
    // Cap returns a list, profile data is the first element
    if let Value::List(list) = &results[0] {
        assert_eq!(list.len(), 1);
        if let Value::Map(profile) = &list[0] {
            let time = profile.get("time_ms");
            assert!(matches!(time, Some(Value::Float(_))));
        } else {
            panic!("Expected Value::Map inside list");
        }
    } else {
        panic!("Expected Value::List");
    }
}

#[test]
fn test_profile_with_custom_key() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    let results = g
        .v()
        .has_label("person")
        .profile_as("my_profile")
        .cap("my_profile")
        .to_list();

    assert_eq!(results.len(), 1);
    // Cap returns a list, profile data is the first element
    if let Value::List(list) = &results[0] {
        assert_eq!(list.len(), 1);
        if let Value::Map(profile) = &list[0] {
            assert!(profile.contains_key("count"));
            assert!(profile.contains_key("time_ms"));
        } else {
            panic!("Expected Value::Map inside list");
        }
    } else {
        panic!("Expected Value::List");
    }
}

#[test]
fn test_profile_passes_through_values() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    // Profile should not change the traversal output
    let results = g.v().has_label("person").profile().values("name").to_list();

    // Should have all 3 person names
    assert_eq!(results.len(), 3);
    let names: Vec<&str> = results.iter().filter_map(|v| v.as_str()).collect();
    assert!(names.contains(&"Alice"));
    assert!(names.contains(&"Bob"));
    assert!(names.contains(&"Charlie"));
}

// =============================================================================
// Anonymous Traversal Factory Tests
// =============================================================================

#[test]
fn test_anonymous_store() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    // Use anonymous traversal with store
    let results = g
        .v()
        .has_label("person")
        .append(__.store("x").values("name"))
        .to_list();

    // Should get names
    assert_eq!(results.len(), 3);
}

#[test]
fn test_anonymous_aggregate() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    // Use anonymous traversal with aggregate - aggregate is barrier then emits all
    let count = g.v().has_label("person").append(__.aggregate("x")).count();

    // After aggregate (barrier), count of 3 items emitted
    assert_eq!(count, 3);
}

#[test]
fn test_anonymous_cap() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    // Store then cap using anonymous traversal
    let results = g
        .v()
        .has_label("person")
        .store("x")
        .append(__.cap("x"))
        .to_list();

    assert_eq!(results.len(), 1);
    assert!(matches!(&results[0], Value::List(_)));
}

#[test]
fn test_anonymous_side_effect() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    // Anonymous side effect that stores outgoing neighbors
    let results = g
        .v_ids([test.alice])
        .append(__.side_effect(__.out().store("neighbors")))
        .cap("neighbors")
        .to_list();

    assert_eq!(results.len(), 1);
    if let Value::List(neighbors) = &results[0] {
        assert_eq!(neighbors.len(), 2);
    } else {
        panic!("Expected Value::List");
    }
}

#[test]
fn test_anonymous_profile() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    // Anonymous profile step
    let results = g
        .v()
        .has_label("person")
        .append(__.profile())
        .cap("profile")
        .to_list();

    assert_eq!(results.len(), 1);
    // Cap returns a list containing the profile map
    if let Value::List(list) = &results[0] {
        assert_eq!(list.len(), 1);
        assert!(matches!(&list[0], Value::Map(_)));
    } else {
        panic!("Expected Value::List");
    }
}

// =============================================================================
// Complex Pipeline Tests
// =============================================================================

#[test]
fn test_store_and_aggregate_combined() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    // Store lazily, then aggregate (barrier)
    let results = g
        .v()
        .has_label("person")
        .store("lazy")
        .aggregate("barrier")
        .cap_multi(["lazy", "barrier"])
        .to_list();

    assert_eq!(results.len(), 1);
    if let Value::Map(map) = &results[0] {
        let lazy = map.get("lazy");
        let barrier = map.get("barrier");

        // Both should have 3 items
        if let (Some(Value::List(lazy_list)), Some(Value::List(barrier_list))) = (lazy, barrier) {
            assert_eq!(lazy_list.len(), 3);
            assert_eq!(barrier_list.len(), 3);
        } else {
            panic!("Expected lists");
        }
    } else {
        panic!("Expected Value::Map");
    }
}

#[test]
fn test_multiple_profile_steps() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    // Multiple profile steps with different keys
    let results = g
        .v()
        .profile_as("v_profile")
        .has_label("person")
        .profile_as("filter_profile")
        .out()
        .profile_as("out_profile")
        .cap_multi(["v_profile", "filter_profile", "out_profile"])
        .to_list();

    assert_eq!(results.len(), 1);
    if let Value::Map(map) = &results[0] {
        // All three profile keys should exist
        assert!(map.contains_key("v_profile"));
        assert!(map.contains_key("filter_profile"));
        assert!(map.contains_key("out_profile"));
    } else {
        panic!("Expected Value::Map");
    }
}

#[test]
fn test_side_effect_in_union() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    // Side effects in union branches
    let results = g
        .v_ids([test.alice])
        .union(vec![
            __.out_labels(&["knows"]).store("friends"),
            __.out_labels(&["created"]).store("creations"),
        ])
        .cap_multi(["friends", "creations"])
        .to_list();

    assert_eq!(results.len(), 1);
    if let Value::Map(map) = &results[0] {
        let friends = map.get("friends");
        let creations = map.get("creations");

        if let (Some(Value::List(friends_list)), Some(Value::List(creations_list))) =
            (friends, creations)
        {
            assert_eq!(friends_list.len(), 1); // Bob
            assert_eq!(creations_list.len(), 1); // GraphDB
        } else {
            panic!("Expected lists");
        }
    } else {
        panic!("Expected Value::Map");
    }
}

#[test]
fn test_empty_traversal_side_effects() {
    let test = create_test_graph();
    let snapshot = test.graph.snapshot();
    let g = snapshot.gremlin();

    // Side effects on empty traversal
    let results = g
        .v()
        .has_label("nonexistent")
        .store("x")
        .aggregate("y")
        .cap_multi(["x", "y"])
        .to_list();

    assert_eq!(results.len(), 1);
    if let Value::Map(map) = &results[0] {
        let x = map.get("x");
        let y = map.get("y");

        // Both should be empty lists
        if let (Some(Value::List(x_list)), Some(Value::List(y_list))) = (x, y) {
            assert!(x_list.is_empty());
            assert!(y_list.is_empty());
        } else {
            panic!("Expected lists");
        }
    } else {
        panic!("Expected Value::Map");
    }
}