oino-cli 1.0.0

The Oino command-line binary: interactive (TUI), print, JSON, RPC and ACP modes
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

//! The `_oino/*` frontend command surface over `oino --mode rpc` (modes.md ยง4): completions,
//! panel actions, shortcuts, editor intents, extension and core settings, service calls and
//! provider sign-in, driven against `builtin:ui-probe` and the faux provider.

#![allow(
    clippy::unwrap_used,
    clippy::expect_used,
    clippy::panic,
    reason = "tests assert by unwrapping"
)]

mod support;

use serde_json::{Value, json};
use support::Sandbox;

fn hello(rpc: &mut support::Rpc) {
    rpc.ok(
        json!({"type": "_oino/hello", "client": {"name": "test", "version": "1"}, "protocol": 1}),
    );
}

/// The next `notify` message.
fn notified(rpc: &mut support::Rpc) -> String {
    let (value, _) = rpc.until(|v| v["type"] == "extension_ui_request" && v["method"] == "notify");
    value["message"].as_str().unwrap().to_owned()
}

fn values(group: &Value) -> Vec<String> {
    group["items"]
        .as_array()
        .unwrap()
        .iter()
        .map(|i| i["value"].as_str().unwrap().to_owned())
        .collect()
}

fn group<'a>(groups: &'a Value, source: &str) -> &'a Value {
    groups["groups"]
        .as_array()
        .unwrap()
        .iter()
        .find(|g| g["source"] == source)
        .unwrap_or_else(|| panic!("no {source} group in {groups:#}"))
}

#[test]
fn completions_cover_commands_arguments_paths_and_contributors() {
    let sandbox = Sandbox::new();
    std::fs::create_dir(sandbox.cwd().join("src")).unwrap();
    std::fs::write(sandbox.cwd().join("src/main.rs"), "").unwrap();
    let mut rpc = sandbox.rpc(&json!([]), &["--no-session", "-e", "builtin:ui-probe"]);

    let commands = rpc.ok(json!({"type": "_oino/get_completions", "text": "/pro", "cursor": 4}));
    let names = group(&commands, "commands");
    assert_eq!(names["from"], 0);
    assert!(values(names).contains(&"/probe".to_owned()), "{names}");

    let args = rpc.ok(json!({"type": "_oino/get_completions", "text": "/probe se", "cursor": 9}));
    let args = group(&args, "command:probe");
    assert_eq!(args["from"], 7);
    assert_eq!(
        values(args),
        [
            "select",
            "setStatus",
            "setWidget",
            "setTitle",
            "set_editor_text",
            "setFrame"
        ]
    );

    let paths =
        rpc.ok(json!({"type": "_oino/get_completions", "text": "see @src/ma", "cursor": 11}));
    let files = group(&paths, "files");
    assert_eq!(files["from"], 4);
    assert_eq!(values(files)[0], "@src/main.rs");

    let tags = rpc.ok(json!({"type": "_oino/get_completions", "text": "x #p", "cursor": 4}));
    let probe = group(&tags, "probe");
    assert_eq!(probe["from"], 2);
    assert_eq!(values(probe), ["#probe"]);

    let none = rpc.ok(json!({"type": "_oino/get_completions", "text": "plain", "cursor": 5}));
    assert_eq!(none, json!({"groups": []}));
    assert_eq!(rpc.close(), Some(0));
}

#[test]
fn panel_actions_shortcuts_and_editor_events_reach_the_extension() {
    let sandbox = Sandbox::new();
    let mut rpc = sandbox.rpc(&json!([]), &["--no-session", "-e", "builtin:ui-probe"]);
    hello(&mut rpc);
    let id = rpc.send(json!({"type": "prompt", "message": "/probe panel Board"}));
    let (_, panel) = rpc.response_and(&id, |v| v["method"] == "openPanel");
    assert_eq!(panel["panelId"], "ui-probe/panel-0");

    rpc.ok(json!({"type": "_oino/ui_action", "panelId": "ui-probe/panel-0", "actionId": "go", "value": "x"}));
    assert_eq!(notified(&mut rpc), r#"probe:action:go:"x""#);
    assert_eq!(
        rpc.err(json!({"type": "_oino/ui_action", "panelId": "nope", "actionId": "go"})),
        "Unknown panel: nope"
    );

    let shortcuts = rpc.ok(json!({"type": "_oino/get_shortcuts"}));
    assert_eq!(
        shortcuts,
        json!({"shortcuts": [{"id": "probe.ping", "defaultKeys": ["ctrl+alt+p"], "description": "Ping the probe", "extensionId": "ui-probe"}]})
    );
    rpc.ok(json!({"type": "_oino/invoke_shortcut", "shortcutId": "probe.ping"}));
    assert_eq!(notified(&mut rpc), "probe:shortcut:probe.ping");
    assert_eq!(
        rpc.err(json!({"type": "_oino/invoke_shortcut", "shortcutId": "nope"})),
        "Unknown shortcut: nope"
    );

    let consumed = rpc.ok(json!({"type": "_oino/editor_event", "eventId": "e1", "intent": "emptyArrowDown", "text": ""}));
    assert_eq!(consumed, json!({"consumed": true}));
    let changed = rpc.ok(json!({"type": "_oino/editor_event", "eventId": "e2", "intent": "changed", "text": "draft"}));
    assert_eq!(changed, json!({"consumed": false}));
    let id = rpc.send(json!({"type": "prompt", "message": "/probe editor-text"}));
    let (_, report) = rpc.response_and(&id, |v| v["method"] == "notify");
    assert_eq!(report["message"], r#"probe:editor-text:"draft""#);
    rpc.ok(
        json!({"type": "_oino/editor_event", "eventId": "e3", "intent": "submit", "text": "go"}),
    );
    assert_eq!(notified(&mut rpc), "probe:editor:submit:go");
    assert!(
        rpc.err(
            json!({"type": "_oino/editor_event", "eventId": "e4", "intent": "nope", "text": ""})
        )
        .contains("unknown variant")
    );
    assert_eq!(rpc.close(), Some(0));
}

#[test]
fn extension_and_core_settings_round_trip() {
    let sandbox = Sandbox::new();
    let mut rpc = sandbox.rpc(&json!([]), &["--no-session", "-e", "builtin:ui-probe"]);
    let schema = rpc.ok(json!({"type": "_oino/get_settings_schema"}));
    let probe = schema["namespaces"]
        .as_array()
        .unwrap()
        .iter()
        .find(|n| n["namespace"] == "probe")
        .unwrap();
    assert_eq!(probe["extensionId"], "ui-probe");

    let defaults = rpc.ok(json!({"type": "_oino/get_extension_settings", "namespace": "probe"}));
    assert_eq!(defaults["values"]["enabled"], true);
    assert_eq!(defaults["values"]["mode"], "a");

    rpc.ok(json!({"type": "_oino/set_extension_setting", "namespace": "probe", "key": "mode", "value": "b", "scope": "global"}));
    rpc.ok(json!({"type": "_oino/set_extension_setting", "namespace": "probe", "key": "token", "value": "s3cret", "scope": "global"}));
    let global = rpc.ok(
        json!({"type": "_oino/get_extension_settings", "namespace": "probe", "scope": "global"}),
    );
    assert_eq!(global["values"]["mode"], "b");
    assert_ne!(global["values"]["token"], "s3cret", "secrets are masked");
    let file: Value = serde_json::from_str(
        &std::fs::read_to_string(sandbox.agent().join("settings.json")).unwrap(),
    )
    .unwrap();
    assert_eq!(file["extensionSettings"]["probe"]["mode"], "b", "{file:#}");
    assert!(!file.to_string().contains("s3cret"));

    rpc.ok(json!({"type": "_oino/unset_extension_setting", "namespace": "probe", "key": "mode", "scope": "global"}));
    let reset = rpc.ok(json!({"type": "_oino/get_extension_settings", "namespace": "probe"}));
    assert_eq!(reset["values"]["mode"], "a");
    assert_eq!(
        rpc.err(json!({"type": "_oino/get_extension_settings", "namespace": "nope"})),
        "Unknown settings namespace: nope"
    );

    rpc.ok(
        json!({"type": "_oino/set_setting", "key": "tui.inline", "value": true, "scope": "global"}),
    );
    let value = rpc.ok(json!({"type": "_oino/get_settings", "key": "tui.inline"}));
    assert_eq!(value, json!({"value": true}));
    let all = rpc.ok(json!({"type": "_oino/get_settings"}));
    assert_eq!(all["settings"]["tui"]["inline"], true);

    // Core `oino.*` namespaces (settings groups, ui-protocol ยง7) ride the same commands.
    let compaction = schema["namespaces"]
        .as_array()
        .unwrap()
        .iter()
        .find(|n| n["namespace"] == "oino.compaction")
        .expect("core namespaces are in the schema");
    assert_eq!(compaction["extensionId"], "oino");
    assert_eq!(compaction["order"], 20);
    let defaults =
        rpc.ok(json!({"type": "_oino/get_extension_settings", "namespace": "oino.compaction"}));
    assert_eq!(defaults["values"]["enabled"], true);
    assert_eq!(defaults["values"]["reserveTokens"], 16_384);
    assert_eq!(defaults["diagnostics"], json!([]));
    rpc.ok(json!({"type": "_oino/set_extension_setting", "namespace": "oino.compaction", "key": "enabled", "value": false, "scope": "global"}));
    let stored: Value = serde_json::from_str(
        &std::fs::read_to_string(sandbox.agent().join("settings.json")).unwrap(),
    )
    .unwrap();
    assert_eq!(
        stored["compaction"]["enabled"], false,
        "core namespace writes are top-level settings: {stored:#}"
    );
    assert!(stored["extensionSettings"].get("oino.compaction").is_none());
    let values =
        rpc.ok(json!({"type": "_oino/get_extension_settings", "namespace": "oino.compaction"}));
    assert_eq!(values["values"]["enabled"], false);
    // Writing the default back unsets the key (OSS-2 simplify, ยง7.2).
    rpc.ok(json!({"type": "_oino/set_extension_setting", "namespace": "oino.compaction", "key": "enabled", "value": true, "scope": "global"}));
    let stored: Value = serde_json::from_str(
        &std::fs::read_to_string(sandbox.agent().join("settings.json")).unwrap(),
    )
    .unwrap();
    assert!(
        stored["compaction"].get("enabled").is_none(),
        "a default write unsets: {stored:#}"
    );
    // An invalid stored value resolves to the layer below and is reported.
    rpc.ok(
        json!({"type": "_oino/set_setting", "key": "compaction.reserveTokens", "value": "lots", "scope": "global"}),
    );
    let values =
        rpc.ok(json!({"type": "_oino/get_extension_settings", "namespace": "oino.compaction"}));
    assert_eq!(values["values"]["reserveTokens"], 16_384);
    assert_eq!(values["diagnostics"][0]["key"], "reserveTokens");
    assert_eq!(rpc.close(), Some(0));
}

#[test]
fn service_calls_and_provider_sign_in() {
    let sandbox = Sandbox::new();
    let mut rpc = sandbox.rpc(&json!([]), &["--no-session", "-e", "builtin:ui-probe"]);
    hello(&mut rpc);
    let echo =
        rpc.ok(json!({"type": "_oino/service_call", "name": "probe.echo", "payload": {"n": 1}}));
    assert_eq!(echo, json!({"echo": {"n": 1}, "caller": "oino.frontend"}));
    assert_eq!(
        rpc.err(json!({"type": "_oino/service_call", "target": "faux", "name": "probe.echo"})),
        "Unknown service: faux/probe.echo"
    );

    let providers = rpc.ok(json!({"type": "_oino/auth_providers"}));
    let oauth = providers["providers"]
        .as_array()
        .unwrap()
        .iter()
        .find(|p| p["id"] == "faux-oauth")
        .cloned()
        .unwrap();
    assert_eq!(oauth["oauth"], true);
    assert_eq!(oauth["configured"], false);
    assert_eq!(
        rpc.err(json!({"type": "_oino/login", "provider": "faux"})),
        "Faux does not support OAuth sign-in; set an API key instead"
    );

    let id = rpc.send(json!({"type": "_oino/login", "provider": "faux-oauth"}));
    let dialog = rpc.event("extension_ui_request");
    assert_eq!(dialog["method"], "input");
    assert_eq!(dialog["title"], "Sign in to faux-oauth");
    rpc.write_raw(&format!(
        "{}\n",
        json!({"type": "extension_ui_response", "id": dialog["id"], "value": "code-123"})
    ));
    let response = rpc.response(&id);
    assert_eq!(response["success"], true, "{response:#}");
    let auth: Value =
        serde_json::from_str(&std::fs::read_to_string(sandbox.agent().join("auth.json")).unwrap())
            .unwrap();
    assert_eq!(auth["faux-oauth"]["type"], "oauth");
    assert_eq!(auth["faux-oauth"]["access"], "code-123");
    let models = rpc.ok(json!({"type": "get_available_models"}));
    assert!(
        models["models"]
            .as_array()
            .unwrap()
            .iter()
            .any(|m| m["provider"] == "faux-oauth"),
        "{models:#}"
    );

    rpc.ok(json!({"type": "_oino/logout", "provider": "faux-oauth"}));
    let auth: Value =
        serde_json::from_str(&std::fs::read_to_string(sandbox.agent().join("auth.json")).unwrap())
            .unwrap();
    assert!(auth.get("faux-oauth").is_none());
    rpc.ok(json!({"type": "_oino/set_api_key", "provider": "faux", "key": "k2"}));
    let auth: Value =
        serde_json::from_str(&std::fs::read_to_string(sandbox.agent().join("auth.json")).unwrap())
            .unwrap();
    assert_eq!(auth["faux"], json!({"type": "api_key", "key": "k2"}));
    assert_eq!(rpc.close(), Some(0));
}