uni-query 1.1.0

OpenCypher query parser, planner, and vectorized executor for Uni
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
// SPDX-License-Identifier: Apache-2.0
// Copyright 2024-2026 Dragonscale Team

//! Integration tests for read operations (MATCH, aggregation, OPTIONAL MATCH,
//! DISTINCT, UNION, CASE, window functions).

use std::collections::HashMap;
use std::sync::Arc;
use tempfile::tempdir;
use tokio::sync::RwLock;
use uni_common::Value;
use uni_common::core::schema::{DataType, SchemaManager};
use uni_query::query::executor::Executor;
use uni_query::query::planner::QueryPlanner;
use uni_store::runtime::property_manager::PropertyManager;
use uni_store::runtime::writer::Writer;
use uni_store::storage::manager::StorageManager;

async fn setup_graph_executor(
    path: &std::path::Path,
) -> (
    Executor,
    Arc<PropertyManager>,
    Arc<SchemaManager>,
    QueryPlanner,
) {
    let schema_manager = SchemaManager::load(&path.join("schema.json"))
        .await
        .unwrap();

    schema_manager.add_label("Person").unwrap();
    schema_manager
        .add_property("Person", "name", DataType::String, true)
        .unwrap();
    schema_manager
        .add_property("Person", "age", DataType::Int32, true)
        .unwrap();
    schema_manager.add_label("Company").unwrap();
    schema_manager
        .add_property("Company", "name", DataType::String, true)
        .unwrap();
    schema_manager
        .add_edge_type("KNOWS", vec!["Person".into()], vec!["Person".into()])
        .unwrap();
    schema_manager
        .add_edge_type("WORKS_AT", vec!["Person".into()], vec!["Company".into()])
        .unwrap();
    schema_manager.save().await.unwrap();

    let planner = QueryPlanner::new(schema_manager.schema());
    let schema_manager = Arc::new(schema_manager);
    let storage = Arc::new(
        StorageManager::new(
            path.join("storage").to_str().unwrap(),
            schema_manager.clone(),
        )
        .await
        .unwrap(),
    );

    let writer = Arc::new(RwLock::new(
        Writer::new(storage.clone(), schema_manager.clone(), 0)
            .await
            .unwrap(),
    ));

    let prop_manager = Arc::new(PropertyManager::new(
        storage.clone(),
        schema_manager.clone(),
        100,
    ));
    let executor = Executor::new_with_writer(storage.clone(), writer.clone());

    (executor, prop_manager, schema_manager, planner)
}

async fn execute_cypher(
    executor: &Executor,
    planner: &QueryPlanner,
    prop_manager: &PropertyManager,
    cypher: &str,
) -> Vec<HashMap<String, Value>> {
    let query = uni_cypher::parse(cypher).unwrap();
    let plan = planner.plan(query).unwrap();
    executor
        .execute(plan, prop_manager, &HashMap::new())
        .await
        .unwrap()
}

/// Seed the graph with test data: 3 persons with a KNOWS chain.
async fn seed_test_data(
    executor: &Executor,
    planner: &QueryPlanner,
    prop_manager: &PropertyManager,
) {
    execute_cypher(
        executor,
        planner,
        prop_manager,
        "CREATE (a:Person {name: 'Alice', age: 30})-[:KNOWS]->(b:Person {name: 'Bob', age: 25})-[:KNOWS]->(c:Person {name: 'Charlie', age: 35})",
    )
    .await;
}

// ── Scan tests ───────────────────────────────────────────────────────

#[tokio::test]
async fn test_scan_with_label_filter() {
    let dir = tempdir().unwrap();
    let (executor, prop_manager, _schema, planner) = setup_graph_executor(dir.path()).await;
    seed_test_data(&executor, &planner, &prop_manager).await;

    let rows = execute_cypher(
        &executor,
        &planner,
        &prop_manager,
        "MATCH (n:Person) RETURN n.name AS name",
    )
    .await;

    assert_eq!(rows.len(), 3, "Should find 3 Person vertices");
}

#[tokio::test]
async fn test_scan_with_where_filter() {
    let dir = tempdir().unwrap();
    let (executor, prop_manager, _schema, planner) = setup_graph_executor(dir.path()).await;
    seed_test_data(&executor, &planner, &prop_manager).await;

    let rows = execute_cypher(
        &executor,
        &planner,
        &prop_manager,
        "MATCH (n:Person) WHERE n.age > 28 RETURN n.name AS name ORDER BY name",
    )
    .await;

    assert_eq!(rows.len(), 2, "Alice(30) and Charlie(35) match age > 28");
}

// ── Traversal tests ──────────────────────────────────────────────────

#[tokio::test]
async fn test_traverse_outgoing() {
    let dir = tempdir().unwrap();
    let (executor, prop_manager, _schema, planner) = setup_graph_executor(dir.path()).await;
    seed_test_data(&executor, &planner, &prop_manager).await;

    let rows = execute_cypher(
        &executor,
        &planner,
        &prop_manager,
        "MATCH (a:Person)-[:KNOWS]->(b:Person) RETURN a.name AS src, b.name AS dst ORDER BY src",
    )
    .await;

    assert_eq!(rows.len(), 2, "Alice->Bob and Bob->Charlie");
}

// ── Variable-length path test ────────────────────────────────────────

#[tokio::test]
async fn test_traverse_variable_length() {
    let dir = tempdir().unwrap();
    let (executor, prop_manager, _schema, planner) = setup_graph_executor(dir.path()).await;
    seed_test_data(&executor, &planner, &prop_manager).await;

    // Alice->Bob->Charlie: variable-length 1..2 from Alice should reach both Bob and Charlie
    let rows = execute_cypher(
        &executor,
        &planner,
        &prop_manager,
        "MATCH (a:Person {name: 'Alice'})-[:KNOWS*1..2]->(b:Person) RETURN b.name AS name ORDER BY name",
    )
    .await;

    assert!(
        rows.len() >= 2,
        "Variable-length path should reach at least Bob and Charlie, got {} rows",
        rows.len()
    );
}

// ── Aggregation tests ────────────────────────────────────────────────

#[tokio::test]
async fn test_aggregation_count() {
    let dir = tempdir().unwrap();
    let (executor, prop_manager, _schema, planner) = setup_graph_executor(dir.path()).await;
    seed_test_data(&executor, &planner, &prop_manager).await;

    let rows = execute_cypher(
        &executor,
        &planner,
        &prop_manager,
        "MATCH (n:Person) RETURN count(n) AS cnt",
    )
    .await;

    assert_eq!(rows.len(), 1);
    assert_eq!(rows[0].get("cnt"), Some(&Value::Int(3)));
}

#[tokio::test]
async fn test_aggregation_sum_avg() {
    let dir = tempdir().unwrap();
    let (executor, prop_manager, _schema, planner) = setup_graph_executor(dir.path()).await;
    seed_test_data(&executor, &planner, &prop_manager).await;

    let rows = execute_cypher(
        &executor,
        &planner,
        &prop_manager,
        "MATCH (n:Person) RETURN sum(n.age) AS total, avg(n.age) AS average",
    )
    .await;

    assert_eq!(rows.len(), 1);
    // 30 + 25 + 35 = 90
    let total = rows[0].get("total").unwrap();
    assert!(
        total == &Value::Int(90) || total == &Value::Float(90.0),
        "Sum should be 90, got {:?}",
        total
    );
    // Average = 30.0
    let avg = rows[0].get("average").unwrap();
    if let Value::Float(f) = avg {
        assert!((f - 30.0).abs() < 0.01, "Average should be 30.0, got {}", f);
    } else {
        panic!("Average should be Float, got {:?}", avg);
    }
}

#[tokio::test]
async fn test_aggregation_collect() {
    let dir = tempdir().unwrap();
    let (executor, prop_manager, _schema, planner) = setup_graph_executor(dir.path()).await;
    seed_test_data(&executor, &planner, &prop_manager).await;

    let rows = execute_cypher(
        &executor,
        &planner,
        &prop_manager,
        "MATCH (n:Person) RETURN collect(n.name) AS names",
    )
    .await;

    assert_eq!(rows.len(), 1);
    if let Some(Value::List(names)) = rows[0].get("names") {
        assert_eq!(names.len(), 3, "Should collect 3 names");
    } else {
        panic!(
            "Expected list for collect(), got {:?}",
            rows[0].get("names")
        );
    }
}

// ── GROUP BY test ────────────────────────────────────────────────────

#[tokio::test]
async fn test_aggregation_group_by() {
    let dir = tempdir().unwrap();
    let (executor, prop_manager, _schema, planner) = setup_graph_executor(dir.path()).await;

    // Create persons with overlapping ages
    execute_cypher(
        &executor,
        &planner,
        &prop_manager,
        "CREATE (:Person {name: 'A', age: 30}), (:Person {name: 'B', age: 25}), (:Person {name: 'C', age: 30})",
    )
    .await;

    let rows = execute_cypher(
        &executor,
        &planner,
        &prop_manager,
        "MATCH (n:Person) RETURN n.age AS age, count(n) AS cnt ORDER BY age",
    )
    .await;

    assert_eq!(rows.len(), 2, "Two distinct age groups");
    // age 25: 1 person, age 30: 2 persons
    assert_eq!(rows[0].get("age"), Some(&Value::Int(25)));
    assert_eq!(rows[0].get("cnt"), Some(&Value::Int(1)));
    assert_eq!(rows[1].get("age"), Some(&Value::Int(30)));
    assert_eq!(rows[1].get("cnt"), Some(&Value::Int(2)));
}

// ── OPTIONAL MATCH tests ─────────────────────────────────────────────

#[tokio::test]
async fn test_optional_match_null() {
    let dir = tempdir().unwrap();
    let (executor, prop_manager, _schema, planner) = setup_graph_executor(dir.path()).await;
    seed_test_data(&executor, &planner, &prop_manager).await;

    let rows = execute_cypher(
        &executor,
        &planner,
        &prop_manager,
        "MATCH (n:Person {name: 'Charlie'}) OPTIONAL MATCH (n)-[:KNOWS]->(m:Person) RETURN n.name AS n, m.name AS m",
    )
    .await;

    assert_eq!(rows.len(), 1);
    assert_eq!(rows[0].get("n"), Some(&Value::String("Charlie".into())));
    // Charlie has no outgoing KNOWS → m should be null
    let m_val = rows[0].get("m");
    assert!(
        m_val == Some(&Value::Null) || m_val.is_none(),
        "OPTIONAL MATCH with no match should produce null"
    );
}

// ── DISTINCT test ────────────────────────────────────────────────────

#[tokio::test]
async fn test_distinct() {
    let dir = tempdir().unwrap();
    let (executor, prop_manager, _schema, planner) = setup_graph_executor(dir.path()).await;

    // Create two persons with same age
    execute_cypher(
        &executor,
        &planner,
        &prop_manager,
        "CREATE (:Person {name: 'A', age: 30}), (:Person {name: 'B', age: 30}), (:Person {name: 'C', age: 25})",
    )
    .await;

    let rows = execute_cypher(
        &executor,
        &planner,
        &prop_manager,
        "MATCH (n:Person) RETURN DISTINCT n.age AS age ORDER BY age",
    )
    .await;

    assert_eq!(rows.len(), 2, "DISTINCT should collapse duplicate ages");
}

// ── UNION tests ──────────────────────────────────────────────────────

#[tokio::test]
async fn test_union_all() {
    let dir = tempdir().unwrap();
    let (executor, prop_manager, _schema, planner) = setup_graph_executor(dir.path()).await;

    let rows = execute_cypher(
        &executor,
        &planner,
        &prop_manager,
        "RETURN 1 AS x UNION ALL RETURN 1 AS x",
    )
    .await;

    assert_eq!(rows.len(), 2, "UNION ALL should keep duplicates");
}

#[tokio::test]
async fn test_union_dedup() {
    let dir = tempdir().unwrap();
    let (executor, prop_manager, _schema, planner) = setup_graph_executor(dir.path()).await;

    let rows = execute_cypher(
        &executor,
        &planner,
        &prop_manager,
        "RETURN 1 AS x UNION RETURN 1 AS x",
    )
    .await;

    assert_eq!(rows.len(), 1, "UNION should deduplicate");
}

// ── CASE expression test ─────────────────────────────────────────────

#[tokio::test]
async fn test_case_expression() {
    let dir = tempdir().unwrap();
    let (executor, prop_manager, _schema, planner) = setup_graph_executor(dir.path()).await;
    seed_test_data(&executor, &planner, &prop_manager).await;

    let rows = execute_cypher(
        &executor,
        &planner,
        &prop_manager,
        "MATCH (n:Person) RETURN n.name AS name, CASE WHEN n.age >= 30 THEN 'senior' ELSE 'junior' END AS category ORDER BY name",
    )
    .await;

    assert_eq!(rows.len(), 3);
    // Alice(30) = senior, Bob(25) = junior, Charlie(35) = senior
    for row in &rows {
        let name = row.get("name").unwrap().as_str().unwrap();
        let cat = row.get("category").unwrap().as_str().unwrap();
        match name {
            "Alice" | "Charlie" => assert_eq!(cat, "senior"),
            "Bob" => assert_eq!(cat, "junior"),
            _ => panic!("Unexpected name: {}", name),
        }
    }
}

// ── Recursive CTE test ───────────────────────────────────────────────

#[tokio::test]
async fn test_recursive_cte_execution() {
    let dir = tempdir().unwrap();
    let (executor, prop_manager, _schema, planner) = setup_graph_executor(dir.path()).await;
    seed_test_data(&executor, &planner, &prop_manager).await;

    // WITH RECURSIVE to find all reachable nodes from Alice via KNOWS
    let rows = execute_cypher(
        &executor,
        &planner,
        &prop_manager,
        r#"
        WITH RECURSIVE reachable AS (
            MATCH (n:Person {name: 'Alice'}) RETURN n AS node
            UNION
            MATCH (prev:Person)-[:KNOWS]->(next:Person)
            WHERE prev IN reachable
            RETURN next AS node
        )
        MATCH (n) WHERE n IN reachable RETURN n.name AS name ORDER BY name
        "#,
    )
    .await;

    // Should reach Alice, Bob, Charlie
    assert!(
        !rows.is_empty(),
        "Recursive CTE should return reachable nodes"
    );
}

// ── EXISTS subquery test ─────────────────────────────────────────────

#[tokio::test]
async fn test_exists_subquery() {
    let dir = tempdir().unwrap();
    let (executor, prop_manager, _schema, planner) = setup_graph_executor(dir.path()).await;
    seed_test_data(&executor, &planner, &prop_manager).await;

    // Alice and Bob have outgoing KNOWS edges, Charlie does not
    let rows = execute_cypher(
        &executor,
        &planner,
        &prop_manager,
        "MATCH (n:Person) WHERE EXISTS { MATCH (n)-[:KNOWS]->() } RETURN n.name AS name ORDER BY name",
    )
    .await;

    // Alice->Bob and Bob->Charlie, so Alice and Bob have outgoing KNOWS
    assert_eq!(
        rows.len(),
        2,
        "Only persons with outgoing KNOWS should match"
    );
    let names: Vec<&str> = rows
        .iter()
        .filter_map(|r| r.get("name").and_then(|v| v.as_str()))
        .collect();
    assert!(names.contains(&"Alice"));
    assert!(names.contains(&"Bob"));
}

// ── Time-travel read-only enforcement test ───────────────────────────

#[tokio::test]
async fn test_time_travel_read_only_enforcement() {
    // validate_read_only works on the AST (Query), rejecting write clauses
    let write_query = uni_cypher::parse("CREATE (:Person {name: 'Bob'})").unwrap();
    let result = uni_query::validate_read_only(&write_query);
    assert!(
        result.is_err(),
        "CREATE should be rejected as non-read-only"
    );

    let read_query = uni_cypher::parse("MATCH (n:Person) RETURN n").unwrap();
    let result = uni_query::validate_read_only(&read_query);
    assert!(
        result.is_ok(),
        "MATCH RETURN should be considered read-only"
    );

    // SET is a mutation too
    let set_query = uni_cypher::parse("MATCH (n:Person) SET n.age = 30 RETURN n").unwrap();
    let result = uni_query::validate_read_only(&set_query);
    assert!(result.is_err(), "SET should be rejected as non-read-only");
}

// ── Advanced execution tests ─────────────────────────────────────────
// NOTE: Procedure calls (CALL db.labels()) require a ProcedureRegistry
// the basic executor setup. These are covered by the TCK test suite.