haematite-cli 0.21.1

The haematite command: serve a store, its door and Studio, answer MCP, query with jq, and host the store's assistant seat
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

use crate::serve::query::parser::{Plan, Source, Span, Stage, pipeline, pipeline_with};

type TestResult = Result<(), String>;

fn parsed(text: &str) -> Result<Plan, String> {
    pipeline(text).map_err(|error| error.to_string())
}

#[test]
fn match_source_forms_are_accepted_with_exact_stage_spans() -> TestResult {
    for (text, expected) in [
        ("match (c:patients)", Span { start: 0, end: 18 }),
        (
            "match (c:patients)-[:admitted_to]->(w:wards)",
            Span { start: 0, end: 44 },
        ),
        (
            "match (c:patients)<-[:admitted_to]-(w:wards)",
            Span { start: 0, end: 44 },
        ),
        (
            "match (c:patients)-[:in]->(w:wards)-[:in]->(h:hospitals)",
            Span { start: 0, end: 56 },
        ),
    ] {
        let plan = parsed(text)?;
        assert_eq!(plan.source, Source::All, "{text}");
        assert_eq!(plan.stages.len(), 1, "{text}");
        assert_eq!(plan.stages[0].span, expected, "{text}");
    }
    Ok(())
}

#[test]
fn match_follows_only_its_named_collection() -> TestResult {
    let plan = parsed("patients | match (c:patients)")?;
    assert_eq!(
        plan.source,
        Source::Collection {
            name: "patients".to_owned(),
            arguments: Vec::new(),
        }
    );
    assert_eq!(plan.stages.len(), 1);
    assert_eq!(plan.stages[0].span, Span { start: 11, end: 29 });
    for (text, construct) in [
        ("wards | match (c:patients)", "first node's label"),
        ("patients | limit(1) | match (c:patients)", "immediately"),
        ("'.' | match (c:patients)", "immediately"),
        ("match (c:patients) | match (w:wards)", "immediately"),
    ] {
        let error = pipeline(text).err().ok_or("misplaced match accepted")?;
        assert_eq!(error.code(), "query_stage_not_available", "{text}");
        assert!(error.to_string().contains(construct), "{error}");
    }
    Ok(())
}

#[test]
fn match_refuses_each_unsupported_construct_by_name() -> TestResult {
    for (text, construct) in [
        ("match (c)", "no label"),
        ("match (c:patients)-[:in]->(w)", "no label"),
        ("match (c:patients {id: 1})", "property map"),
        ("match (c:patients) WHERE c.id = 1", "WHERE"),
        ("match (c:patients) where c.id = 1", "WHERE"),
        ("match (C:patients)", "binding name"),
        ("match (c-1:patients)", "binding name"),
        ("match (c:patients)-[r:in]->(w:wards)", "relation binding"),
        ("match (c:patients)-[:in]-(w:wards)", "undirected"),
        ("match (c:patients)<-[:in]->(w:wards)", "bidirectional"),
    ] {
        let error = pipeline(text).err().ok_or("unsupported match accepted")?;
        assert_eq!(error.code(), "query_stage_not_available", "{text}");
        assert!(error.to_string().contains(construct), "{error}");
        assert!(text.get(error.span().start..error.span().end).is_some());
    }
    Ok(())
}

#[test]
fn quoted_match_remains_jq_with_its_exact_span() -> TestResult {
    for (text, span) in [
        ("'match(re)'", Span { start: 0, end: 11 }),
        ("patients | 'match(re)'", Span { start: 11, end: 22 }),
    ] {
        let plan = parsed(text)?;
        assert_eq!(plan.stages.len(), 1);
        assert_eq!(plan.stages[0].value, Stage::Jq("match(re)".to_owned()));
        assert_eq!(plan.stages[0].span, span);
    }
    Ok(())
}

#[test]
fn match_pipeline_preserves_following_stages_and_collection_arguments() -> TestResult {
    let plan = parsed("patients(ward: \"4B\") | match (c:patients) | count")?;
    let Source::Collection { name, arguments } = plan.source else {
        return Err("match lost its collection source".to_owned());
    };
    assert_eq!(name, "patients");
    assert_eq!(arguments.len(), 1);
    assert_eq!(arguments[0].field, "ward");
    assert_eq!(arguments[0].value, serde_json::json!("4B"));
    assert_eq!(plan.stages.len(), 2);
    let mut words = Vec::new();
    pipeline_with(
        "patients(ward: \"4B\") | match (c:patients) | count",
        |word, _| {
            words.push(word.to_owned());
        },
    )
    .map_err(|error| error.to_string())?;
    assert_eq!(words, vec!["patients", "match", "count"]);
    assert_eq!(plan.stages[0].span, Span { start: 23, end: 41 });
    assert_eq!(plan.stages[1].value, Stage::Count);
    assert_eq!(plan.stages[1].span, Span { start: 44, end: 49 });
    Ok(())
}

#[test]
fn match_query_check_reports_the_stage_and_construct_byte_ranges() -> TestResult {
    use crate::serve::query::check::{CheckRequest, check};
    use serde_json::json;

    let checked = check(&CheckRequest {
        query: "match (c:patients) | count".to_owned(),
    });
    assert_eq!(
        checked,
        json!({
            "stages": [
                {"word": "match", "span": {"start": 0, "end": 18}},
                {"word": "count", "span": {"start": 21, "end": 26}},
            ],
            "refusal": null,
        })
    );
    let query = "patients | match (c:patients) WHERE c.id = 1";
    let refused = pipeline(query).err().ok_or("WHERE was accepted")?;
    let checked = check(&CheckRequest {
        query: query.to_owned(),
    });
    assert_eq!(
        checked["stages"],
        json!([{"word": "patients", "span": {"start": 0, "end": 8}}])
    );
    assert_eq!(checked["refusal"]["code"], "query_stage_not_available");
    assert_eq!(checked["refusal"]["message"], refused.to_string());
    assert_eq!(checked["refusal"]["span"], json!({"start": 30, "end": 35}));
    Ok(())
}