php-lsp 0.5.0

A PHP Language Server Protocol implementation
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
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
use super::*;

use expect_test::expect;
use serde_json::{Value, json};

fn render_resolved_lens(resp: &Value) -> String {
    if let Some(err) = resp.get("error").filter(|e| !e.is_null()) {
        return format!("error: {err}");
    }
    let l = &resp["result"];
    let sl = l["range"]["start"]["line"].as_u64().unwrap_or(0);
    let title = l["command"]["title"].as_str().unwrap_or("<unresolved>");
    let cmd = l["command"]["command"].as_str().unwrap_or("");
    format!("L{sl}: {title} [{cmd}]")
}

#[tokio::test]
async fn lens_for_method_ref_count() {
    let mut s = TestServer::new().await;
    let out = s
        .check_code_lens(
            r#"<?php
class Service {
    public function run(): void {}
}
$s = new Service();
$s->run();
$s->run();
"#,
        )
        .await;
    expect![[r#"
        L1:6-L1:13: 1 reference [editor.action.showReferences]
        L2:20-L2:23: 2 references [editor.action.showReferences]"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn lens_for_phpunit_named_test_method() {
    let mut s = TestServer::new().await;
    let out = s
        .check_code_lens(
            r#"<?php
class FooTest {
    public function testItWorks(): void {}
}
"#,
        )
        .await;
    expect![[r#"
        L1:6-L1:13: 0 references [editor.action.showReferences]
        L2:20-L2:31: 0 references [editor.action.showReferences]
        L2:20-L2:31: ▶ Run test [php-lsp.runTest]"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn lens_for_test_attribute() {
    let mut s = TestServer::new().await;
    let out = s
        .check_code_lens(
            r#"<?php
class FooTest {
    #[Test]
    public function it_works(): void {}
}
"#,
        )
        .await;
    expect![[r#"
        L1:6-L1:13: 0 references [editor.action.showReferences]
        L3:20-L3:28: 0 references [editor.action.showReferences]
        L3:20-L3:28: ▶ Run test [php-lsp.runTest]"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn lens_for_fqn_test_attribute() {
    let mut s = TestServer::new().await;
    let out = s
        .check_code_lens(
            r#"<?php
class FooTest {
    #[PHPUnit\Framework\Attributes\Test]
    public function it_works(): void {}
}
"#,
        )
        .await;
    expect![[r#"
        L1:6-L1:13: 0 references [editor.action.showReferences]
        L3:20-L3:28: 0 references [editor.action.showReferences]
        L3:20-L3:28: ▶ Run test [php-lsp.runTest]"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn lens_for_at_test_docblock() {
    let mut s = TestServer::new().await;
    let out = s
        .check_code_lens(
            r#"<?php
class FooTest {
    /** @test */
    public function it_works(): void {}
}
"#,
        )
        .await;
    expect![[r#"
        L1:6-L1:13: 0 references [editor.action.showReferences]
        L3:20-L3:28: 0 references [editor.action.showReferences]
        L3:20-L3:28: ▶ Run test [php-lsp.runTest]"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn lens_for_interface_with_implementations() {
    let mut s = TestServer::new().await;
    let out = s
        .check_code_lens(
            r#"<?php
interface Animal {}
class Dog implements Animal {}
class Cat implements Animal {}
"#,
        )
        .await;
    expect![[r#"
        L1:10-L1:16: 0 references [editor.action.showReferences]
        L1:10-L1:16: 2 implementations [editor.action.showReferences]
        L2:6-L2:9: 0 references [editor.action.showReferences]
        L3:6-L3:9: 0 references [editor.action.showReferences]"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn lens_for_abstract_class_with_subclass() {
    let mut s = TestServer::new().await;
    let out = s
        .check_code_lens(
            r#"<?php
abstract class Shape {}
class Circle extends Shape {}
"#,
        )
        .await;
    expect![[r#"
        L1:15-L1:20: 0 references [editor.action.showReferences]
        L1:15-L1:20: 1 implementation [editor.action.showReferences]
        L2:6-L2:12: 0 references [editor.action.showReferences]"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn lens_for_trait_with_usages() {
    let mut s = TestServer::new().await;
    let out = s
        .check_code_lens(
            r#"<?php
trait Loggable {
    public function log(): void {}
}
class A { use Loggable; }
class B { use Loggable; }
"#,
        )
        .await;
    expect![[r#"
        L1:6-L1:14: 0 references [editor.action.showReferences]
        L1:6-L1:14: 2 implementations [editor.action.showReferences]
        L2:20-L2:23: 0 references [editor.action.showReferences]
        L4:6-L4:7: 0 references [editor.action.showReferences]
        L5:6-L5:7: 0 references [editor.action.showReferences]"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn lens_for_overriding_method() {
    let mut s = TestServer::new().await;
    let out = s
        .check_code_lens(
            r#"<?php
class Base {
    public function greet(): string { return 'hi'; }
}
class Child extends Base {
    public function greet(): string { return 'hello'; }
}
"#,
        )
        .await;
    expect![[r#"
        L1:6-L1:10: 0 references [editor.action.showReferences]
        L2:20-L2:25: 0 references [editor.action.showReferences]
        L4:6-L4:11: 0 references [editor.action.showReferences]
        L5:20-L5:25: 0 references [editor.action.showReferences]
        L5:20-L5:25: overrides Base::greet [editor.action.showReferences]"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn lens_for_enum_with_method() {
    let mut s = TestServer::new().await;
    let out = s
        .check_code_lens(
            r#"<?php
enum Suit {
    case Hearts;
    public function label(): string { return 'h'; }
}
"#,
        )
        .await;
    expect![[r#"
        L1:5-L1:9: 0 references [editor.action.showReferences]
        L2:9-L2:15: 0 references [editor.action.showReferences]
        L3:20-L3:25: 0 references [editor.action.showReferences]"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn lens_counts_enum_case_usages() {
    let mut s = TestServer::new().await;
    let out = s
        .check_code_lens(
            r#"<?php
enum Suit {
    case Hearts;
    case Spades;
}
$a = Suit::Hearts;
$b = Suit::Hearts;
"#,
        )
        .await;
    expect![[r#"
        L1:5-L1:9: 2 references [editor.action.showReferences]
        L2:9-L2:15: 2 references [editor.action.showReferences]
        L3:9-L3:15: 0 references [editor.action.showReferences]"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn lens_for_method_overriding_used_trait() {
    let mut s = TestServer::new().await;
    let out = s
        .check_code_lens(
            r#"<?php
trait Loggable {
    public function log(): void {}
}
class Service {
    use Loggable;
    public function log(): void {}
}
"#,
        )
        .await;
    expect![[r#"
        L1:6-L1:14: 0 references [editor.action.showReferences]
        L1:6-L1:14: 1 implementation [editor.action.showReferences]
        L2:20-L2:23: 0 references [editor.action.showReferences]
        L4:6-L4:13: 0 references [editor.action.showReferences]
        L6:20-L6:23: 0 references [editor.action.showReferences]
        L6:20-L6:23: overrides Loggable::log [editor.action.showReferences]"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn lens_for_class_property() {
    let mut s = TestServer::new().await;
    let out = s
        .check_code_lens(
            r#"<?php
class User {
    public string $name = '';
    public function rename(string $new): void { $this->name = $new; }
    public function who(): string { return $this->name; }
}
"#,
        )
        .await;
    expect![[r#"
        L1:6-L1:10: 0 references [editor.action.showReferences]
        L2:19-L2:23: 2 references [editor.action.showReferences]
        L3:20-L3:26: 0 references [editor.action.showReferences]
        L4:20-L4:23: 0 references [editor.action.showReferences]"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn lens_for_promoted_constructor_property() {
    let mut s = TestServer::new().await;
    let out = s
        .check_code_lens(
            r#"<?php
class Dog {
    public function __construct(public int $age) {}
    public function birthday(): void { $this->age++; }
    public function years(): int { return $this->age; }
}
"#,
        )
        .await;
    expect![[r#"
        L1:6-L1:9: 0 references [editor.action.showReferences]
        L2:20-L2:31: 0 references [editor.action.showReferences]
        L2:44-L2:47: 2 references [editor.action.showReferences]
        L3:20-L3:28: 0 references [editor.action.showReferences]
        L4:20-L4:25: 0 references [editor.action.showReferences]"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn lens_counts_references_across_files() {
    let mut s = TestServer::new().await;
    let out = s
        .check_code_lens(
            r#"//- /lib.php
<?php
function shared(): void {}
//- /a.php
<?php
shared();
//- /b.php
<?php
shared();
shared();
"#,
        )
        .await;
    expect!["L1:9-L1:15: 3 references [editor.action.showReferences]"].assert_eq(&out);
}

#[tokio::test]
async fn code_lens_resolve_roundtrips_run_test_lens() {
    let mut server = TestServer::new().await;
    server
        .open(
            "test.php",
            "<?php\nclass FooTest { public function testItWorks(): void {} }\n",
        )
        .await;

    let lenses = server.code_lens("test.php").await["result"]
        .as_array()
        .cloned()
        .expect("expected code lens array");
    let run_test_lens = lenses
        .iter()
        .find(|l| l["command"]["command"] == "php-lsp.runTest")
        .cloned()
        .expect("expected a php-lsp.runTest lens");

    let resp = server
        .client()
        .request("codeLens/resolve", run_test_lens)
        .await;
    expect!["L1: ▶ Run test [php-lsp.runTest]"].assert_eq(&render_resolved_lens(&resp));
}

#[tokio::test]
async fn code_lens_resolve_bare_lens_roundtrips() {
    let mut server = TestServer::new().await;
    server.open("bare.php", "<?php\nfunction test() {}\n").await;

    let bare_lens = json!({
        "range": {
            "start": { "line": 1, "character": 0 },
            "end":   { "line": 1, "character": 8 }
        }
    });

    let resp = server
        .client()
        .request("codeLens/resolve", bare_lens.clone())
        .await;

    assert!(resp["error"].is_null(), "error: {resp:?}");
    // Snapshot the rendered lens — establishes regression baseline for the resolve path.
    expect!["L1: <unresolved> []"].assert_eq(&render_resolved_lens(&resp));
    // Range must survive unchanged (render_resolved_lens only shows line, not full range).
    assert_eq!(
        resp["result"]["range"], bare_lens["range"],
        "range must roundtrip"
    );
}

#[tokio::test]
async fn code_lens_resolve_all_lenses_preserve_structure() {
    let mut server = TestServer::new().await;
    server
        .open(
            "test.php",
            "<?php\nclass TestClass { \n  public function test1(): void {} \n  public function test2(): void {} \n}\n",
        )
        .await;

    let lenses = server.code_lens("test.php").await["result"]
        .as_array()
        .cloned()
        .expect("expected code lens array");
    assert!(!lenses.is_empty(), "expected code lenses");

    let mut rendered = Vec::new();
    for lens in &lenses {
        let resp = server
            .client()
            .request("codeLens/resolve", lens.clone())
            .await;
        assert!(resp["error"].is_null(), "resolve error for lens: {lens:?}");
        assert!(
            resp["result"]["range"].is_object(),
            "range must be preserved"
        );
        rendered.push(render_resolved_lens(&resp));
    }
    let out = rendered.join("\n");
    expect![[r#"
        L1: 0 references [editor.action.showReferences]
        L2: 0 references [editor.action.showReferences]
        L2: ▶ Run test [php-lsp.runTest]
        L3: 0 references [editor.action.showReferences]
        L3: ▶ Run test [php-lsp.runTest]"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn code_lens_resolve_with_null_command() {
    let mut server = TestServer::new().await;
    server.open("null_cmd.php", "<?php").await;

    let lens = json!({
        "range": {
            "start": { "line": 0, "character": 0 },
            "end": { "line": 0, "character": 5 }
        },
        "command": null
    });

    let resp = server
        .client()
        .request("codeLens/resolve", lens.clone())
        .await;
    assert!(resp["error"].is_null());
    // Spec requires the server not to inject a command when `null` was sent.
    expect!["L0: <unresolved> []"].assert_eq(&render_resolved_lens(&resp));
}

#[tokio::test]
async fn code_lens_resolve_preserves_data_field() {
    let mut server = TestServer::new().await;
    server.open("data.php", "<?php").await;

    let lens = json!({
        "range": {
            "start": { "line": 0, "character": 0 },
            "end": { "line": 0, "character": 5 }
        },
        "command": {
            "title": "Test",
            "command": "test.run"
        },
        "data": { "testId": "123", "nested": { "value": "data" } }
    });

    let resp = server
        .client()
        .request("codeLens/resolve", lens.clone())
        .await;
    assert!(resp["error"].is_null());
    let result = &resp["result"];
    assert_eq!(
        result["data"], lens["data"],
        "data field must be preserved exactly"
    );
}

#[tokio::test]
async fn code_lens_resolve_is_idempotent() {
    let mut server = TestServer::new().await;
    server
        .open(
            "test.php",
            "<?php\nclass FooTest { public function testIt(): void {} }\n",
        )
        .await;

    let lenses = server.code_lens("test.php").await["result"]
        .as_array()
        .cloned()
        .expect("expected lenses");
    let first_lens = lenses[0].clone();

    let resolved_once = server
        .client()
        .request("codeLens/resolve", first_lens.clone())
        .await;
    let resolved_twice = server
        .client()
        .request("codeLens/resolve", resolved_once["result"].clone())
        .await;

    // Snapshot the result after first resolve — establishes regression baseline.
    expect!["L1: 0 references [editor.action.showReferences]"]
        .assert_eq(&render_resolved_lens(&resolved_once));
    assert_eq!(
        resolved_once["result"], resolved_twice["result"],
        "calling resolve twice must return identical results (idempotent)"
    );
}