lernie 0.1.65

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

//! The watch: the state read that opens it, the reads it holds, and the ways
//! it ends.
//!
//! The two answers bl-87ab found wrong — what a rest IS, and what `--json`
//! says at the end of one — are [`waiting`]'s, split at the 300-line cap on
//! the seam the ball itself draws: this file is the LOOP, that one is what the
//! loop says and when it is entitled to stop.

use super::follow;
use crate::cli::Stream;
use crate::render::Form;
use crate::test_support::Scratch;
use crate::test_support::wire::{flat, wired};
use serde_json::{Value, json};

/// A conversation's own row, as thin as the reader allows, in the state named.
fn agent(state: &str) -> Value {
    json!({"ok": true, "kind": "agent", "agent": "c-1", "root": "c-1",
           "display": "PelicanQuiet", "display_only": false, "tip": "abc",
           "state": state, "refused": false, "present": true,
           "nudgeable": true, "stoppable": false, "stop_children": false,
           "spend": {"tokens": {"input": 0, "output": 0, "cache_read": 0,
                                "cache_write": 0, "total": 0},
                     "attribution": {"kind": "own"}}})
}

/// The inbox read's answer: as much undelivered mail as asked for.
fn inbox(deposits: usize) -> Value {
    let rows: Vec<Value> = (0..deposits)
        .map(|n| {
            json!({"name": format!("{n}.md"), "raw": "body",
                   "deposit": {"body": "body"}})
        })
        .collect();
    json!({"ok": true, "kind": "inbox", "rows": rows})
}

/// One frame of a live tail.
fn tail(text: &str) -> Value {
    json!({"ok": true, "kind": "follow", "tools": [], "stream": {"delta": "text", "text": text}})
}

/// The gestures an engine was asked, without the version preface each
/// connection opens with.
fn asked(engine: &crate::test_support::engine::Engine) -> Vec<Value> {
    engine
        .heard()
        .into_iter()
        .filter(|frame| frame.get("op").is_some())
        .collect()
}

/// Run a watch and hand back its verdict beside everything it printed.
fn watched(scratch: &Scratch) -> (crate::cli::Verdict, Vec<String>) {
    formed(scratch, Form::Rendered)
}

/// The same, in the form the caller names.
fn formed(scratch: &Scratch, form: Form) -> (crate::cli::Verdict, Vec<String>) {
    let mut said: Vec<String> = Vec::new();
    let verdict = follow(scratch.path(), "home", "PelicanQuiet", form, &mut |line| {
        said.push(line.to_owned());
    });
    (verdict, said)
}

/// **A conversation already at rest is told so at once, and exits 0**
/// (bl-3dca). It opens no held connection at all, so the half-minute of
/// silence is not shortened — it never happens — and the failure code that was
/// indistinguishable from a dead engine is gone with it.
#[test]
fn a_quiescent_conversation_answers_at_once_and_succeeds() {
    let scratch = Scratch::new();
    let engine = wired(
        &scratch,
        &flat(),
        vec![vec![agent("quiescent")], vec![inbox(0)]],
    );
    let (verdict, said) = watched(&scratch);
    assert_eq!(verdict.code, 0);
    assert_eq!(verdict.stream, Stream::Out);
    assert!(
        verdict.text.contains("is at rest (quiescent)"),
        "{}",
        verdict.text
    );
    assert!(
        verdict.text.contains("nudged or messaged"),
        "{}",
        verdict.text
    );
    // **The closing line is the seat's own, so it wears the gutter and
    // carries how long the watch held** (bl-293d) — a watch that answers no
    // duration leaves "what did that take" a question nobody can answer.
    assert!(verdict.text.starts_with("┊ "), "{}", verdict.text);
    // Whole seconds, whatever the count: on a loaded box two reads can take
    // one, and "at once" is the two reads and no tail below, not the clock.
    let held = verdict
        .text
        .split(" after ")
        .nth(1)
        .and_then(|rest| rest.split("s — ").next())
        .and_then(|secs| secs.parse::<u64>().ok());
    assert!(held.is_some(), "{}", verdict.text);
    assert!(said.is_empty(), "no tail was held: {said:?}");
    // **Two reads and no held connection.** The state read says at rest and the
    // inbox read is what makes that sentence TRUE rather than true-as-of-an-
    // instant (bl-87ab); neither opens a follow, so the half-minute of silence
    // bl-3dca removed stays removed.
    assert_eq!(
        asked(&engine),
        vec![
            json!({"op": "agent", "workspace": "home", "agent": "PelicanQuiet"}),
            json!({"op": "inbox", "workspace": "home", "agent": "PelicanQuiet"}),
        ],
        "it asked what the conversation was doing, and whether anything was waiting"
    );
}

/// **The watch outlives the engine's step boundary** (bl-f076). A held read
/// ends when a step commits; the conversation is still working, so the line is
/// taken up again — and the operator sees one continuous tail rather than
/// having to invent a loop.
#[test]
fn a_read_that_ends_at_a_step_boundary_is_taken_up_again() {
    let scratch = Scratch::new();
    let engine = wired(
        &scratch,
        &flat(),
        vec![
            vec![agent("in-flight")],
            vec![tail("The"), tail(" answer")],
            vec![agent("in-flight")],
            vec![tail(" is 391.")],
            vec![agent("quiescent")],
        ],
    );
    let (verdict, said) = watched(&scratch);
    assert_eq!(verdict.code, 0);
    assert!(
        verdict.text.contains("is at rest (quiescent)"),
        "{}",
        verdict.text
    );
    assert_eq!(said.len(), 3, "one printing per frame: {said:?}");
    assert!(said.concat().contains(" is 391."), "{said:?}");
    assert_eq!(
        asked(&engine).len(),
        5,
        "three state reads and two held reads: {:?}",
        asked(&engine)
    );
}

/// **A read that brought nothing settles before asking again.** The engine
/// paces this loop on its own, so the pause is insurance against one that
/// closes an empty read at once — the alternative being a busy loop on
/// somebody else's socket.
#[test]
fn a_read_that_brought_nothing_waits_before_asking_again() {
    let scratch = Scratch::new();
    wired(
        &scratch,
        &flat(),
        vec![vec![agent("live")], Vec::new(), vec![agent("stopped")]],
    );
    let began = std::time::Instant::now();
    let (verdict, said) = watched(&scratch);
    assert!(began.elapsed() >= super::SETTLE, "it did not settle");
    assert_eq!(verdict.code, 0);
    assert!(
        verdict.text.contains("is at rest (stopped)"),
        "{}",
        verdict.text
    );
    assert!(said.is_empty(), "{said:?}");
}

/// **A state this build has no word for ends the watch rather than looping on
/// it.** The reply vocabulary paints an unknown token as itself (DESIGN §4.9
/// rung 3), and the safe reading is *this seat cannot say that it is working*.
#[test]
fn a_state_this_seat_does_not_know_ends_the_watch_and_says_the_word() {
    let scratch = Scratch::new();
    wired(&scratch, &flat(), vec![vec![agent("hibernating")]]);
    let (verdict, _) = watched(&scratch);
    assert_eq!(verdict.code, 0);
    assert!(verdict.text.contains("(hibernating)"), "{}", verdict.text);
}

/// **An answer no state can be read out of is the product**, and the exit code
/// says the watch never started: a refusal about a workspace that is not there
/// must not read as a conversation that came to rest.
#[test]
fn an_answer_with_no_state_in_it_is_printed_and_fails() {
    let scratch = Scratch::new();
    wired(
        &scratch,
        &flat(),
        vec![vec![
            json!({"ok": false, "error": "unknown workspace \"hoem\""}),
        ]],
    );
    let (verdict, said) = watched(&scratch);
    assert_eq!(verdict.code, 1);
    assert_eq!(verdict.stream, Stream::Out);
    assert!(
        verdict.text.contains("unknown workspace"),
        "{}",
        verdict.text
    );
    assert!(said.is_empty(), "{said:?}");
}

/// **A channel that will not answer is this box's fact, not the
/// conversation's**, and it earns the sentence alone — on either of the two
/// reads the watch makes.
#[test]
fn a_channel_that_will_not_answer_says_so_on_either_read() {
    let scratch = Scratch::new();
    let (verdict, _) = watched(&scratch);
    assert_eq!(verdict.code, 1);
    assert_eq!(verdict.stream, Stream::Err);
    assert!(
        verdict.text.contains("no wire provisioned"),
        "{}",
        verdict.text
    );

    let held = Scratch::new();
    wired(
        &held,
        &flat(),
        vec![
            crate::test_support::engine::Answer::Frames(vec![agent("in-flight")]),
            crate::test_support::engine::Answer::Hangup,
        ],
    );
    let (verdict, _) = watched(&held);
    assert_eq!(verdict.code, 1);
    assert_eq!(verdict.stream, Stream::Err);
}

/// What a rest is, and what `--json` says about the end of one.
mod waiting;