sim-lib-expr-tree 0.3.0

Loadable, Shape-checked SIM expression-tree runtime 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
use std::sync::Arc;

use sim_citizen::run_registry_conformance_expecting;
use sim_codec::{DecodePosition, DecodedForm, Input, decode_default_with_codec};
use sim_codec_lisp::LispCodecLib;
use sim_kernel::{
    CapabilityName, Cx, DefaultFactory, EagerPolicy, Expr, ReadPolicy, Symbol, Value,
};

use super::*;

// conformance: stable runtime operations, Shapes, Cards, capabilities, Citizens, and recipes.
const CITIZENS: [&str; 2] = ["expr-tree/SourceRecord", "expr-tree/PolicyRecord"];

#[test]
fn identity_names_runtime_and_components() {
    assert_eq!(crate_identity(), "sim-lib-expr-tree");
    assert_eq!(
        component_identities(),
        ["sim-expr-tree-core", "sim-expr-tree-calc"]
    );
}

#[test]
fn manifest_exports_every_stable_operation_shape_card_and_citizen() {
    let mut cx = runtime_cx(&all_capabilities());
    let expected = [
        "open",
        "new-cell",
        "new-dir",
        "mount",
        "unmount",
        "move",
        "rename",
        "delete",
        "set-expr",
        "set-calc-policy",
        "set-codec-policy",
        "ref",
        "list",
        "calculate",
        "recalculate",
        "recalculate-recursive",
        "cancel",
        "refresh",
        "status",
        "explain",
        "watch",
    ];
    assert_eq!(
        expr_tree_operation_symbols()
            .into_iter()
            .map(|symbol| symbol.to_string())
            .collect::<Vec<_>>(),
        expected
            .iter()
            .map(|name| format!("expr-tree/{name}"))
            .collect::<Vec<_>>()
    );
    let cards = operation_cards(&mut cx).unwrap();
    assert_eq!(cards.len(), expected.len());
    for name in expected {
        let symbol = Symbol::qualified("expr-tree", name);
        let function = cx
            .registry()
            .function_by_symbol(&symbol)
            .expect("operation is linked")
            .clone();
        let callable = function.object().as_callable().expect("callable operation");
        assert!(
            callable
                .browse_args_shape(&mut cx)
                .unwrap()
                .expect("args shape")
                .object()
                .as_shape()
                .is_some()
        );
        assert!(
            callable
                .browse_result_shape(&mut cx)
                .unwrap()
                .expect("result shape")
                .object()
                .as_shape()
                .is_some()
        );
    }
}

#[test]
fn stable_lisp_operations_cover_namespace_mounts_paths_calculation_and_reopen() {
    let mut cx = runtime_cx(&all_capabilities());
    let tree = eval_lisp(&mut cx, "(expr-tree/open \"ops\")");
    bind(&mut cx, "tree", tree);

    assert_eq!(
        eval_expr(&mut cx, "(expr-tree/new-dir tree \"/\" nil)",),
        Expr::String("/dir-1".to_owned())
    );
    eval_lisp(
        &mut cx,
        "(expr-tree/new-cell tree \"/dir-1\" \"base\" \"ready\")",
    );
    assert_eq!(
        eval_expr(
            &mut cx,
            "(expr-tree/new-cell tree \"/dir-1\" nil (expr-tree/ref \"base\"))",
        ),
        Expr::String("/dir-1/cell-1".to_owned())
    );
    eval_lisp(&mut cx, "(expr-tree/new-dir tree \"/dir-1\" \"nested\")");

    for form in [
        "(expr-tree/ref tree \"cell-1\" \"/dir-1\")",
        "(expr-tree/ref tree \"../base\" \"/dir-1/nested\")",
        "(expr-tree/ref tree \"/dir-1/base\")",
    ] {
        assert_eq!(eval_expr(&mut cx, form), Expr::String("ready".to_owned()));
    }

    assert_eq!(
        eval_expr(
            &mut cx,
            "(expr-tree/mount tree \"/external\" \"database\" \"dir\" \"7\")",
        ),
        Expr::String("/external".to_owned())
    );
    eval_lisp(
        &mut cx,
        "(expr-tree/new-cell tree \"/external\" \"record\" \"db-value\")",
    );
    eval_lisp(
        &mut cx,
        "(expr-tree/mount tree \"/catalog\" \"read-only\" \"table\" \"3\")",
    );
    let denied = eval_lisp_result(
        &mut cx,
        "(expr-tree/new-cell tree \"/catalog\" \"forbidden\" \"x\")",
    )
    .unwrap_err()
    .to_string();
    assert!(denied.contains("read-only"), "{denied}");
    assert!(denied.len() < 600);
    eval_lisp(&mut cx, "(expr-tree/unmount tree \"/catalog\")");

    assert_eq!(
        eval_expr(
            &mut cx,
            "(expr-tree/rename tree \"/external/record\" \"renamed\")",
        ),
        Expr::String("/external/renamed".to_owned())
    );
    assert_eq!(
        eval_expr(
            &mut cx,
            "(expr-tree/move tree \"/external/renamed\" \"/dir-1/moved\")",
        ),
        Expr::String("/dir-1/moved".to_owned())
    );
    eval_lisp(&mut cx, "(expr-tree/delete tree \"/dir-1/moved\")");
    eval_lisp(&mut cx, "(expr-tree/unmount tree \"/external\")");

    let listing = eval_lisp(&mut cx, "(expr-tree/list tree \"/dir-1\")");
    let listing = listing.object().as_expr(&mut cx).unwrap();
    let Expr::List(rows) = listing else {
        panic!("list operation must return a list")
    };
    assert_eq!(rows.len(), 3);

    let reopened = eval_lisp(&mut cx, "(expr-tree/open \"ops\")");
    bind(&mut cx, "reopened", reopened);
    assert_eq!(
        eval_expr(&mut cx, "(expr-tree/ref reopened \"/dir-1/cell-1\")",),
        Expr::String("ready".to_owned())
    );
}

#[test]
fn automatic_directed_cycle_receipts_policies_and_streams_share_one_engine() {
    let mut cx = runtime_cx(&all_capabilities());
    let tree = eval_lisp(&mut cx, "(expr-tree/open \"calculation\")");
    bind(&mut cx, "tree", tree);
    eval_lisp(
        &mut cx,
        "(expr-tree/new-cell tree \"/\" \"a\" (expr-tree/ref \"/b\"))",
    );
    eval_lisp(
        &mut cx,
        "(expr-tree/new-cell tree \"/\" \"b\" (expr-tree/ref \"/a\"))",
    );
    let cycle = eval_lisp_result(&mut cx, "(expr-tree/recalculate-recursive tree \"/a\")")
        .unwrap_err()
        .to_string();
    assert!(cycle.contains("cycle"), "{cycle}");
    assert!(cycle.len() < 600);

    eval_lisp(&mut cx, "(expr-tree/set-expr tree \"/b\" \"recovered\")");
    assert_eq!(
        eval_expr(&mut cx, "(expr-tree/recalculate tree \"/a\")"),
        Expr::String("recovered".to_owned())
    );
    let policy = eval_lisp(
        &mut cx,
        "(expr-tree/set-calc-policy tree \"/a\" \"manual\")",
    );
    assert_eq!(
        policy
            .object()
            .downcast_ref::<DurablePolicyRecord>()
            .expect("durable policy")
            .calc_trigger,
        "manual"
    );
    eval_lisp(
        &mut cx,
        "(expr-tree/set-codec-policy tree \"/a\" \"codec/lisp\")",
    );
    eval_lisp(&mut cx, "(expr-tree/calculate tree \"/a\")");

    let explanation = eval_lisp(&mut cx, "(expr-tree/explain tree \"/a\")");
    let source_record = table_value(&mut cx, &explanation, "source-record");
    let source_record = source_record
        .object()
        .downcast_ref::<DurableSourceRecord>()
        .expect("durable source record");
    assert_eq!(source_record.path, "/a");
    assert!(
        table_value(&mut cx, &explanation, "receipt")
            .object()
            .as_table_impl()
            .is_some()
    );

    let watch = eval_lisp(&mut cx, "(expr-tree/watch tree)");
    assert!(watch.object().as_sequence().is_some());
    let status = eval_lisp(&mut cx, "(expr-tree/status tree \"/a\")");
    assert_eq!(
        table_value(&mut cx, &status, "status")
            .object()
            .as_expr(&mut cx)
            .unwrap(),
        Expr::Symbol(Symbol::qualified("expr-tree/status", "fresh"))
    );
    eval_lisp(&mut cx, "(expr-tree/refresh tree)");
}

#[test]
fn capabilities_fail_closed_and_errors_are_bounded() {
    let mut cx = runtime_cx(&[expr_tree_read_capability()]);
    let tree = eval_lisp(&mut cx, "(expr-tree/open \"denied\")");
    bind(&mut cx, "tree", tree);
    let error =
        eval_lisp_result(&mut cx, "(expr-tree/new-cell tree \"/\" \"blocked\" \"x\")").unwrap_err();
    assert!(matches!(
        error,
        sim_kernel::Error::CapabilityDenied { capability }
            if capability == expr_tree_write_capability()
    ));
}

#[test]
fn durable_records_are_conformant_citizens_but_live_handles_are_opaque() {
    let registry = expr_tree_citizen_registry().unwrap();
    registry.ensure_contains_symbols(&CITIZENS).unwrap();
    let mut conformance_cx = Cx::new(
        Arc::new(EagerPolicy),
        Arc::new(DefaultFactory),
        sim_kernel::HandleSeed::new(0x1cec_f798_0129_b762),
    );
    run_registry_conformance_expecting(&mut conformance_cx, &registry, &CITIZENS).unwrap();

    let mut cx = runtime_cx(&all_capabilities());
    let tree = eval_lisp(&mut cx, "(expr-tree/open \"opaque\")");
    let Expr::Extension { tag, .. } = tree.object().as_expr(&mut cx).unwrap() else {
        panic!("live handle must remain opaque")
    };
    assert_eq!(tag, Symbol::qualified("core", "opaque-object"));
}

#[test]
fn recipe_finite_tree_runs_checked_lisp_surface() {
    let mut cx = recipe_cx();
    let result = eval_lisp(
        &mut cx,
        include_str!("../recipes/01-basics/finite-tree/setup.siml"),
    );
    let Expr::List(root_entries) = result.object().as_expr(&mut cx).unwrap() else {
        panic!("finite-tree recipe must return the bounded root listing")
    };
    assert_eq!(root_entries.len(), 3);

    let tree = eval_lisp(&mut cx, "(expr-tree/open \"recipe-finite-tree\")");
    bind(&mut cx, "finite-tree", tree);
    assert_eq!(
        eval_expr(&mut cx, "(expr-tree/ref finite-tree \"/dir-1/cell-1\")",),
        Expr::String("ordinary-value".to_owned())
    );
    assert_eq!(
        eval_expr(
            &mut cx,
            "(expr-tree/ref finite-tree \"/measurements/trial-0001\")",
        ),
        Expr::String("measured-value".to_owned())
    );
}

#[test]
fn recipe_automatic_and_directed_runs_checked_lisp_surface() {
    let mut cx = recipe_cx();
    let explanation = eval_lisp(
        &mut cx,
        include_str!("../recipes/02-calculation/automatic-and-directed/setup.siml"),
    );
    assert_eq!(
        table_value(&mut cx, &explanation, "status")
            .object()
            .as_expr(&mut cx)
            .unwrap(),
        Expr::Symbol(Symbol::qualified("expr-tree/status", "fresh"))
    );
    assert!(
        table_value(&mut cx, &explanation, "receipt")
            .object()
            .as_table_impl()
            .is_some()
    );

    let tree = eval_lisp(
        &mut cx,
        "(expr-tree/open \"recipe-automatic-and-directed\")",
    );
    bind(&mut cx, "calculation-tree", tree);
    assert_eq!(
        eval_expr(&mut cx, "(expr-tree/ref calculation-tree \"/manual\")",),
        Expr::String("automatic-value".to_owned())
    );
    assert_eq!(
        eval_expr(&mut cx, "(expr-tree/ref calculation-tree \"/cycle-a\")",),
        Expr::String("recovered".to_owned())
    );
}

fn runtime_cx(capabilities: &[CapabilityName]) -> Cx {
    let mut cx = Cx::new(
        Arc::new(EagerPolicy),
        Arc::new(DefaultFactory),
        sim_kernel::HandleSeed::new(0x2ce5_cf14_9757_33d2),
    );
    let codec = LispCodecLib::new(cx.registry_mut().fresh_codec_id()).unwrap();
    cx.load_lib(&codec).unwrap();
    install_expr_tree_lib(&mut cx, sim_kernel::HandleSeed::new(0x4558_5401)).unwrap();
    for capability in capabilities {
        cx.grant(capability.clone());
    }
    cx
}

fn recipe_cx() -> Cx {
    runtime_cx(&all_capabilities())
}

fn all_capabilities() -> [CapabilityName; 4] {
    [
        expr_tree_read_capability(),
        expr_tree_write_capability(),
        expr_tree_calculate_capability(),
        expr_tree_mount_capability(),
    ]
}

fn eval_lisp(cx: &mut Cx, source: &str) -> Value {
    eval_lisp_result(cx, source).unwrap()
}

fn eval_lisp_result(cx: &mut Cx, source: &str) -> sim_kernel::Result<Value> {
    let decoded = decode_default_with_codec(
        cx,
        &Symbol::qualified("codec", "lisp"),
        Input::Text(source.to_owned()),
        ReadPolicy::default(),
        DecodePosition::Eval,
    )?;
    let expression = match decoded {
        DecodedForm::Term(term) => Expr::from(term),
        DecodedForm::Datum(datum) => Expr::from(datum),
    };
    cx.eval_expr(expression)
}

fn eval_expr(cx: &mut Cx, source: &str) -> Expr {
    eval_lisp(cx, source).object().as_expr(cx).unwrap()
}

fn bind(cx: &mut Cx, name: &str, value: Value) {
    cx.env_mut().define(Symbol::new(name), value);
}

fn table_value(cx: &mut Cx, table: &Value, name: &str) -> Value {
    table
        .object()
        .as_table_impl()
        .expect("expected table value")
        .get(cx, Symbol::new(name))
        .unwrap()
}