strop-lsp 0.34.0

strop lsp: async-lsp client, server registry, diagnostics store
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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
use super::*;

#[test]
fn hover_error_receives_a_terminal_note_with_the_original_stamp() {
    run(async {
        let (client, rx, mut wire) = Wire::new();
        let mut docs = Documents::default();
        let document = docs.try_insert(()).unwrap();
        let path = Path::new("/workspace/a.rs");
        initialize(&client);
        assert!(client.did_open(
            document,
            BufferRevision::new(0),
            path,
            "rust",
            Rope::from_str("x")
        ));
        let _open = wire.next().await;
        let wanted = ask(&client, document, 0);
        let request = wire.next().await;
        assert_eq!(request["method"], "textDocument/hover");
        wire.reply_error(&request, -32603, "boom").await;
        let LspEvent::Note { context, text } = event(&rx).await else {
            panic!("note")
        };
        assert_eq!(context.stamp, wanted);
        assert_eq!(text, "hover failed: boom (jsonrpc error -32603)");
        wire.stop().await;
    });
}

#[test]
fn hover_null_and_empty_results_are_explicit_empties() {
    run(async {
        let (client, rx, mut wire) = Wire::new();
        let mut docs = Documents::default();
        let document = docs.try_insert(()).unwrap();
        let path = Path::new("/workspace/a.rs");
        initialize(&client);
        assert!(client.did_open(
            document,
            BufferRevision::new(0),
            path,
            "rust",
            Rope::from_str("x")
        ));
        let _open = wire.next().await;
        let null_stamp = ask(&client, document, 0);
        let request = wire.next().await;
        wire.reply(&request, Value::Null).await;
        let LspEvent::Note { context, text } = event(&rx).await else {
            panic!("note")
        };
        assert_eq!(context.stamp, null_stamp);
        assert_eq!(text, "no hover information at the cursor");
        // An empty hover payload is the same explicit empty.
        assert!(client.did_change(document, BufferRevision::new(1), path, Rope::from_str("y")));
        let _change = wire.next().await;
        let empty_stamp = client
            .request(RequestInput {
                document,
                revision: BufferRevision::new(1),
                path: path.to_owned(),
                line: LineIndex::new(0),
                byte_col: ByteColumn::new(0),
                line_text: "y".into(),
                kind: RequestKind::Hover,
                rename_to: None,
            })
            .unwrap();
        let request = wire.next().await;
        wire.reply(
            &request,
            json!({ "contents": { "kind": "plaintext", "value": "" } }),
        )
        .await;
        let LspEvent::Note { context, text } = event(&rx).await else {
            panic!("note")
        };
        assert_eq!(context.stamp, empty_stamp);
        assert_eq!(text, "no hover information at the cursor");
        wire.stop().await;
    });
}

#[test]
fn goto_null_is_a_note_and_switch_header_null_is_a_note() {
    run(async {
        let (client, rx, mut wire) = Wire::new();
        let mut docs = Documents::default();
        let document = docs.try_insert(()).unwrap();
        let path = Path::new("/workspace/a.rs");
        initialize(&client);
        assert!(client.did_open(
            document,
            BufferRevision::new(0),
            path,
            "rust",
            Rope::from_str("x")
        ));
        let _open = wire.next().await;
        let goto_stamp = client
            .request(RequestInput {
                document,
                revision: BufferRevision::new(0),
                path: path.to_owned(),
                line: LineIndex::new(0),
                byte_col: ByteColumn::new(0),
                line_text: "x".into(),
                kind: RequestKind::Goto,
                rename_to: None,
            })
            .unwrap();
        let request = wire.next().await;
        assert_eq!(request["method"], "textDocument/definition");
        wire.reply(&request, Value::Null).await;
        let LspEvent::Note { context, text } = event(&rx).await else {
            panic!("note")
        };
        assert_eq!(context.stamp, goto_stamp);
        assert_eq!(text, "no definition found");
        let switch_stamp = client
            .request(RequestInput {
                document,
                revision: BufferRevision::new(0),
                path: path.to_owned(),
                line: LineIndex::new(0),
                byte_col: ByteColumn::new(0),
                line_text: "x".into(),
                kind: RequestKind::SwitchHeader,
                rename_to: None,
            })
            .unwrap();
        let request = wire.next().await;
        assert_eq!(request["method"], "textDocument/switchSourceHeader");
        wire.reply(&request, Value::Null).await;
        let LspEvent::Note { context, text } = event(&rx).await else {
            panic!("note")
        };
        assert_eq!(context.stamp, switch_stamp);
        assert_eq!(text, "no header/source counterpart");
        wire.stop().await;
    });
}

#[test]
fn document_symbols_flatten_both_reply_shapes() {
    run(async {
        let (client, rx, mut wire) = Wire::new();
        let mut docs = Documents::default();
        let document = docs.try_insert(()).unwrap();
        let path = Path::new("/workspace/a.rs");
        client.caps.set(lt::ServerCapabilities {
            document_symbol_provider: Some(lt::OneOf::Left(true)),
            position_encoding: Some(lt::PositionEncodingKind::UTF8),
            ..Default::default()
        });
        client.finish_initialize().unwrap();
        assert!(client.did_open(
            document,
            BufferRevision::new(0),
            path,
            "rust",
            Rope::from_str("struct Foo; impl Foo { fn bar() {} }")
        ));
        let _open = wire.next().await;
        let ask = |kind| {
            client
                .request(RequestInput {
                    document,
                    revision: BufferRevision::new(0),
                    path: path.to_owned(),
                    line: LineIndex::new(0),
                    byte_col: ByteColumn::new(0),
                    line_text: "x".into(),
                    kind,
                    rename_to: None,
                })
                .unwrap()
        };
        // Hierarchical reply: children flatten with the ancestor path,
        // and the jump position is the selection range's start.
        let _nested_stamp = ask(RequestKind::DocumentSymbols);
        let request = wire.next().await;
        assert_eq!(request["method"], "textDocument/documentSymbol");
        wire.reply(
            &request,
            serde_json::json!([{
                "name": "Foo", "kind": 23,
                "range": {"start": {"line": 0, "character": 0}, "end": {"line": 0, "character": 30}},
                "selectionRange": {"start": {"line": 0, "character": 7}, "end": {"line": 0, "character": 10}},
                "children": [{
                    "name": "bar", "kind": 6,
                    "range": {"start": {"line": 0, "character": 12}, "end": {"line": 0, "character": 29}},
                    "selectionRange": {"start": {"line": 0, "character": 25}, "end": {"line": 0, "character": 28}}
                }]
            }]),
        )
        .await;
        let LspEvent::Symbols { symbols, .. } = event(&rx).await else {
            panic!("symbols event")
        };
        assert_eq!(symbols.len(), 2);
        assert_eq!(symbols[0].name, "Foo");
        assert_eq!(symbols[0].kind, "Struct");
        assert_eq!(symbols[0].container, "");
        assert_eq!(symbols[0].location.position.column.get(), 7);
        assert_eq!(symbols[1].name, "bar");
        assert_eq!(symbols[1].container, "Foo");
        assert_eq!(symbols[1].kind, "Method");
        // Legacy flat reply: containerName carries, location decodes
        // through the workspace like any other location.
        let _flat_stamp = ask(RequestKind::DocumentSymbols);
        let request = wire.next().await;
        wire.reply(
            &request,
            serde_json::json!([{
                "name": "main", "kind": 12, "containerName": "crate",
                "location": {
                    "uri": "file:///workspace/a.rs",
                    "range": {"start": {"line": 3, "character": 4}, "end": {"line": 3, "character": 8}}
                }
            }]),
        )
        .await;
        let LspEvent::Symbols { symbols, .. } = event(&rx).await else {
            panic!("symbols event")
        };
        assert_eq!(symbols.len(), 1);
        assert_eq!(symbols[0].name, "main");
        assert_eq!(symbols[0].kind, "Function");
        assert_eq!(symbols[0].container, "crate");
        assert_eq!(symbols[0].location.position.line.get(), 3);
        assert_eq!(
            symbols[0].location.doc.path,
            PathBuf::from("/workspace/a.rs")
        );
        wire.stop().await;
    });
}

#[test]
fn locations_null_is_an_empty_list_and_errors_are_notes() {
    run(async {
        let (client, rx, mut wire) = Wire::new();
        let mut docs = Documents::default();
        let document = docs.try_insert(()).unwrap();
        let path = Path::new("/workspace/a.rs");
        initialize(&client);
        assert!(client.did_open(
            document,
            BufferRevision::new(0),
            path,
            "rust",
            Rope::from_str("x")
        ));
        let _open = wire.next().await;
        let null_stamp = client
            .request(RequestInput {
                document,
                revision: BufferRevision::new(0),
                path: path.to_owned(),
                line: LineIndex::new(0),
                byte_col: ByteColumn::new(0),
                line_text: "x".into(),
                kind: RequestKind::Locations(LocKind::References),
                rename_to: None,
            })
            .unwrap();
        let request = wire.next().await;
        assert_eq!(request["method"], "textDocument/references");
        wire.reply(&request, Value::Null).await;
        let LspEvent::Locations {
            context,
            kind,
            items,
        } = event(&rx).await
        else {
            panic!("locations")
        };
        assert_eq!(context.stamp, null_stamp);
        assert_eq!(kind, LocKind::References);
        assert!(items.is_empty(), "null result is an explicit empty list");
        assert!(client.did_change(document, BufferRevision::new(1), path, Rope::from_str("y")));
        let _change = wire.next().await;
        let error_stamp = client
            .request(RequestInput {
                document,
                revision: BufferRevision::new(1),
                path: path.to_owned(),
                line: LineIndex::new(0),
                byte_col: ByteColumn::new(0),
                line_text: "y".into(),
                kind: RequestKind::Locations(LocKind::References),
                rename_to: None,
            })
            .unwrap();
        let request = wire.next().await;
        wire.reply_error(&request, -32603, "index gone").await;
        let LspEvent::Note { context, text } = event(&rx).await else {
            panic!("note")
        };
        assert_eq!(context.stamp, error_stamp);
        assert_eq!(text, "references failed: index gone (jsonrpc error -32603)");
        wire.stop().await;
    });
}

#[test]
fn workspace_symbols_are_document_free_and_map_both_shapes() {
    run(async {
        let (client, rx, mut wire) = Wire::new();
        client.caps.set(lt::ServerCapabilities {
            workspace_symbol_provider: Some(lt::OneOf::Left(true)),
            position_encoding: Some(lt::PositionEncodingKind::UTF8),
            ..Default::default()
        });
        client.finish_initialize().unwrap();
        // No document is ever opened: admission is warm + capability.
        client.workspace_symbols(7, "dispatch").unwrap();
        let request = wire.next().await;
        assert_eq!(request["method"], "workspace/symbol");
        assert_eq!(request["params"]["query"], "dispatch");
        // Flat SymbolInformation reply decodes through the workspace.
        wire.reply(
            &request,
            serde_json::json!([{
                "name": "dispatch", "kind": 12, "containerName": "render",
                "location": {
                    "uri": "file:///workspace/src/lib.rs",
                    "range": {"start": {"line": 41, "character": 3},
                              "end": {"line": 41, "character": 11}}
                }
            }]),
        )
        .await;
        let LspEvent::WorkspaceSymbols {
            generation,
            symbols,
            ..
        } = event(&rx).await
        else {
            panic!("workspace symbols event")
        };
        assert_eq!(generation, 7);
        assert_eq!(symbols.len(), 1);
        assert_eq!(symbols[0].name, "dispatch");
        assert_eq!(symbols[0].kind, "Function");
        assert_eq!(symbols[0].container, "render");
        assert_eq!(symbols[0].location.position.line.get(), 41);
        // Nested replies drop uri-only locations: the resolve-support
        // contract is never advertised, so they have no jump position.
        client.workspace_symbols(8, "").unwrap();
        let request = wire.next().await;
        assert_eq!(request["params"]["query"], "");
        wire.reply(
            &request,
            serde_json::json!([{
                "name": "unresolved", "kind": 12,
                "location": { "uri": "file:///workspace/src/lib.rs" }
            }]),
        )
        .await;
        let LspEvent::WorkspaceSymbols {
            generation,
            symbols,
            ..
        } = event(&rx).await
        else {
            panic!("second workspace symbols event")
        };
        assert_eq!(generation, 8);
        assert!(symbols.is_empty());
        // A request error is a terminal failure carrying the
        // generation (R9: exactly one terminal event).
        client.workspace_symbols(9, "x").unwrap();
        let request = wire.next().await;
        wire.reply_error(&request, -32601, "no symbols here").await;
        let LspEvent::WorkspaceSymbolsFailed {
            generation, reason, ..
        } = event(&rx).await
        else {
            panic!("failure event")
        };
        assert_eq!(generation, 9);
        assert!(reason.contains("no symbols here"));
        wire.stop().await;
    });
}

#[test]
fn workspace_symbols_crosses_the_engine_probe_verbatim() {
    run(async {
        // 0063 §4: the engine sends only the bare content probe (the
        // positive content atoms' literal text, or empty); qualifiers
        // and operators are stripped before this API. The client must
        // cross that string untouched — never re-parse, never decorate.
        let (client, rx, mut wire) = Wire::new();
        client.caps.set(lt::ServerCapabilities {
            workspace_symbol_provider: Some(lt::OneOf::Left(true)),
            ..Default::default()
        });
        client.finish_initialize().unwrap();
        for (generation, probe) in [(1, "foo bar"), (2, ""), (3, "wrap")] {
            client.workspace_symbols(generation, probe).unwrap();
            let request = wire.next().await;
            assert_eq!(request["method"], "workspace/symbol");
            assert_eq!(
                request["params"]["query"], probe,
                "the engine's probe crosses verbatim"
            );
            wire.reply(&request, serde_json::json!([])).await;
            let LspEvent::WorkspaceSymbols { .. } = event(&rx).await else {
                panic!("workspace symbols event")
            };
        }
        wire.stop().await;
    });
}

#[test]
fn workspace_symbols_refuse_unready_and_uncapable_servers() {
    run(async {
        let (cold, _rx, _wire) = Wire::new();
        // Not initialized: NotReady, nothing on the wire.
        assert!(matches!(
            cold.workspace_symbols(1, "x"),
            Err(crate::protocol::RequestRefusal::NotReady)
        ));
        let (capless, _rx, wire) = Wire::new();
        capless.finish_initialize().unwrap();
        // No provider advertised: Unsupported.
        assert!(matches!(
            capless.workspace_symbols(1, "x"),
            Err(crate::protocol::RequestRefusal::Unsupported)
        ));
        wire.stop().await;
    });
}