lernie 0.1.23

lernie: the operator seat — the window and wire client for a yog server
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

//! The three things a seat has to understand about an envelope, and the
//! discipline that they are read from one table.

use super::{OP, WORKSPACE, op, parse, succeeded, with_workspace, workspace};
use serde_json::json;

/// A gesture is a JSON object with an `op`. Everything short of that refuses
/// here rather than spending a connection on it.
#[test]
fn parse_takes_a_gesture_and_refuses_everything_that_is_not_one() {
    assert_eq!(
        parse(r#"{"op":"workspaces"}"#).expect("a gesture"),
        json!({"op": "workspaces"})
    );
    for (text, said) in [
        ("{", "not JSON"),
        ("[1,2]", "a gesture is a JSON object"),
        (r#""workspaces""#, "a gesture is a JSON object"),
        (r#"{"workspace":"home"}"#, "missing field"),
        (r#"{"op":7}"#, "is not a string"),
    ] {
        let refusal = parse(text).expect_err("refused");
        assert!(refusal.contains(said), "{text}: {refusal}");
    }
}

/// The discriminant's name is the wire's, and the seat never interprets it: an
/// `op` this build has never heard of parses and crosses.
#[test]
fn an_unknown_op_is_carried_rather_than_judged() {
    let envelope = parse(&format!(r#"{{"{OP}":"a-verb-from-the-future"}}"#)).expect("a gesture");
    assert_eq!(workspace(&envelope), None);
}

/// **The top-level slot**: read and written through the same table.
#[test]
fn a_top_level_workspace_is_the_slot() {
    let envelope = json!({"op": "conversations", "workspace": "home"});
    assert_eq!(workspace(&envelope), Some("home".to_owned()));
    assert_eq!(
        with_workspace(&envelope, "personal"),
        json!({"op": "conversations", "workspace": "personal"})
    );
}

/// **The nested slot**, and it is load-bearing rather than an oddity: the name
/// inside a prepared body is handed straight back out as the next act's
/// address, so a prepared left in the host's spelling routes its own follow-up
/// to a name no entry claims.
#[test]
fn a_prepared_body_carries_the_slot_one_level_down() {
    let envelope = json!({
        "op": "prompt",
        "prepared": {"workspace": "home", "goal": "do the thing"},
        "goal": "do the thing",
    });
    assert_eq!(workspace(&envelope), Some("home".to_owned()));
    let written = with_workspace(&envelope, "personal");
    assert_eq!(written["prepared"]["workspace"], json!("personal"));
    assert_eq!(
        written["prepared"]["goal"], envelope["prepared"]["goal"],
        "the rewrite touched something other than the name"
    );
}

/// An envelope naming no workspace comes back byte for byte — the general path
/// with nothing to rewrite, not a case of its own. Every shape reaches that one
/// branch: no field at all, a nested body that is not an object, a nested body
/// with no name in it, and a name that is not a string.
#[test]
fn an_envelope_naming_no_workspace_crosses_unchanged() {
    for envelope in [
        json!({"op": "workspaces"}),
        json!({"op": "prompt", "prepared": "not an object"}),
        json!({"op": "prompt", "prepared": {"goal": "unaddressed"}}),
        json!({"op": "conversations", "workspace": 7}),
        json!({"op": "prompt", "prepared": {"workspace": 7}}),
        json!({"op": "config", "target": "not an object"}),
        json!({"op": "config", "target": {"file": "cadence"}}),
        json!({"op": "config", "target": {"file": "brazen", "workspace": 7}}),
    ] {
        assert_eq!(workspace(&envelope), None, "{envelope}");
        assert_eq!(
            with_workspace(&envelope, "personal"),
            envelope,
            "{envelope}"
        );
    }
}

/// **The config family's slot**, one level down inside its destination: the
/// wall whose file the act edits *is* the gesture's address, so a config act
/// aimed at an entry under a §8.2 rename is rewritten into the host's spelling
/// and routed to that entry — rather than resolving to no entry, falling
/// through to this box's own engine, and writing the wrong wall's file
/// (bl-4a36; yog's twin bl-523f is the same row in the typed table).
#[test]
fn a_config_destination_carries_the_slot_one_level_down() {
    let envelope = json!({
        "op": "config",
        "target": {"file": "brazen", "workspace": "clientleaf"},
        "text": "",
    });
    assert_eq!(workspace(&envelope), Some("clientleaf".to_owned()));
    let written = with_workspace(&envelope, "hostname");
    assert_eq!(written["target"]["workspace"], json!("hostname"));
    assert_eq!(
        written["target"]["file"], envelope["target"]["file"],
        "the rewrite touched something other than the name"
    );
    assert_eq!(written["text"], envelope["text"]);
}

/// The §9.3 lineage destination is the family's other addressed shape, and it
/// answers through the same slot — nothing here is keyed on which `file` a
/// destination names.
#[test]
fn a_lineage_destination_is_addressed_the_same_way() {
    let envelope = json!({
        "op": "config",
        "target": {
            "file": "branch",
            "lineage": "default",
            "origin": "advance",
            "path": "providers.yaml",
            "workspace": "clientleaf",
        },
    });
    assert_eq!(workspace(&envelope), Some("clientleaf".to_owned()));
    assert_eq!(
        with_workspace(&envelope, "hostname")["target"]["workspace"],
        json!("hostname")
    );
}

/// **What is still deliberately not a slot**: a `workspace` nested somewhere
/// neither table reads as the gesture's address. Two holders are named and a
/// third nesting is not one of them.
#[test]
fn a_workspace_nested_anywhere_else_is_not_the_address() {
    let envelope = json!({
        "op": "message",
        "body": {"workspace": "home"},
    });
    assert_eq!(workspace(&envelope), None);
    assert_eq!(with_workspace(&envelope, "personal"), envelope);
}

/// A top-level name wins over a nested one. No envelope in the vocabulary
/// carries two; reading the outer one first is what keeps that true if one
/// ever does.
#[test]
fn the_outer_name_is_read_before_a_nested_one() {
    let envelope = json!({
        "op": "config",
        "workspace": "outer",
        "target": {"file": "brazen", "workspace": "inner"},
    });
    assert_eq!(workspace(&envelope), Some("outer".to_owned()));
    let written = with_workspace(&envelope, "personal");
    assert_eq!(written["workspace"], json!("personal"));
    assert_eq!(written["target"]["workspace"], json!("inner"));
}

/// A value that is not an object at all has no slot, which is the same branch
/// as an envelope without one.
#[test]
fn a_value_that_is_not_an_object_has_no_slot() {
    let envelope = json!([1, 2, 3]);
    assert_eq!(workspace(&envelope), None);
    assert_eq!(with_workspace(&envelope, "personal"), envelope);
}

/// The rewrite's key is the wire's `workspace`, spelled once.
#[test]
fn the_slot_is_the_wire_s_own_field_name() {
    let envelope = json!({"op": "scan", WORKSPACE: "home"});
    assert_eq!(workspace(&envelope), Some("home".to_owned()));
}

/// **The last frame decides**, an empty stream is not ok, and a frame with no
/// verdict is not ok either — a seat does not read a missing `ok` as a good
/// one.
#[test]
fn the_verdict_is_the_last_frame_s_and_silence_is_never_yes() {
    assert!(succeeded(&[json!({"ok": true})]));
    assert!(succeeded(&[json!({"ok": false}), json!({"ok": true})]));
    assert!(!succeeded(&[json!({"ok": true}), json!({"ok": false})]));
    assert!(!succeeded(&[]));
    assert!(!succeeded(&[json!({"kind": "rows"})]));
    assert!(!succeeded(&[json!({"ok": "yes"})]));
}

/// **The word an envelope is, said back and never read.** Its one caller is the
/// sentence that tells an operator WHICH act is in doubt (REMOTE §3), so what
/// matters is that it names the gesture and that it is total: `?` is
/// unreachable through [`parse`] and through `crate::verbs`, both of which
/// refuse an envelope with no string `op`, and an arm with no input is an arm
/// no assertion covers.
#[test]
fn the_op_is_said_back_and_a_gesture_without_one_is_a_question_mark() {
    assert_eq!(op(&json!({"op": "nudge", "workspace": "home"})), "nudge");
    assert_eq!(op(&json!({"op": 7})), "?");
    assert_eq!(op(&json!({})), "?");
    assert_eq!(op(&json!("not an object")), "?");
}