php-lsp 0.13.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
use super::*;
use expect_test::expect;

// ── Fast tests (no-vendor fixture, run by default) ─────────────────────

mod symbols {
    use super::*;

    #[tokio::test]
    async fn workspace_symbols_finds_controller_by_exact_name() {
        let mut server = TestServer::with_fixture_no_vendor("symfony-demo").await;
        server.wait_for_index_ready().await;

        let resp = server.workspace_symbols("BlogController").await;
        assert!(
            resp["error"].is_null(),
            "workspace/symbol error: {:?}",
            resp
        );
        let out = render_workspace_symbols(&resp, &server.uri(""));
        expect![[r#"
            Class       BlogController @ src/Controller/Admin/BlogController.php:42
            Class       BlogController @ src/Controller/BlogController.php:39
            Class       BlogControllerTest @ tests/Controller/Admin/BlogControllerTest.php:36
            Class       BlogControllerTest @ tests/Controller/BlogControllerTest.php:28"#]]
        .assert_eq(&out);
    }

    #[tokio::test]
    async fn workspace_symbols_fuzzy_prefix() {
        let mut server = TestServer::with_fixture_no_vendor("symfony-demo").await;
        server.wait_for_index_ready().await;

        let resp = server.workspace_symbols("Blog").await;
        assert!(resp["error"].is_null());
        let out = render_workspace_symbols(&resp, &server.uri(""));
        // Prefix query "Blog" must surface the Blog* family (BlogController, BlogSearchComponent, etc.)
        expect![[r#"
            Class       BlogController @ src/Controller/Admin/BlogController.php:42
            Class       BlogController @ src/Controller/BlogController.php:39
            Class       BlogControllerTest @ tests/Controller/Admin/BlogControllerTest.php:36
            Class       BlogControllerTest @ tests/Controller/BlogControllerTest.php:28
            Class       BlogSearchComponent @ src/Twig/Components/BlogSearchComponent.php:27
            Method      testPublicBlogPost @ tests/Controller/DefaultControllerTest.php:55"#]]
        .assert_eq(&out);
    }

    #[tokio::test]
    async fn document_symbols_lists_blog_controller_methods() {
        let mut server = TestServer::with_fixture_no_vendor("symfony-demo").await;
        server.wait_for_index_ready().await;

        let (text, _, _) = server.locate("src/Controller/BlogController.php", "<?php", 0);
        server
            .open("src/Controller/BlogController.php", &text)
            .await;

        let resp = server
            .document_symbols("src/Controller/BlogController.php")
            .await;
        let out = render_document_symbols(&resp);
        // Must include class BlogController and its index method.
        expect![[r#"
            Class BlogController @L39
              Method index @L47
              Method postShow @L80
              Method commentNew @L107
              Method commentForm @L150
              Method search @L160"#]]
        .assert_eq(&out);
    }
}

mod semantic_tokens {
    use super::*;

    #[tokio::test]
    async fn semantic_tokens_full_on_blog_controller_is_nonempty_and_well_formed() {
        let mut server = TestServer::with_fixture_no_vendor("symfony-demo").await;
        server.wait_for_index_ready().await;

        let (text, _, _) = server.locate("src/Controller/BlogController.php", "<?php", 0);
        server
            .open("src/Controller/BlogController.php", &text)
            .await;

        let resp = server
            .semantic_tokens_full("src/Controller/BlogController.php")
            .await;
        assert!(resp["error"].is_null());
        assert!(
            !resp["result"]["data"]
                .as_array()
                .unwrap_or(&vec![])
                .is_empty(),
            "expected semantic tokens"
        );
    }
}

mod perf_measure {
    use super::*;

    /// Manual benchmark to verify lazy-vendor `indexReady` latency on symfony-demo.
    /// Run with `cargo test --test frameworks measure_indexready -- --ignored --nocapture`.
    #[tokio::test]
    #[ignore = "manual benchmark; run with --nocapture to see timings"]
    async fn measure_indexready_symfony_demo_lazy() {
        let t0 = std::time::Instant::now();
        let mut server = TestServer::with_fixture("symfony-demo").await;
        let t_init = t0.elapsed();
        server.wait_for_index_ready().await;
        let t_ready = t0.elapsed();
        println!(
            "MEASURE lazy-vendor symfony-demo: init={:?}, indexReady={:?}",
            t_init, t_ready
        );
    }

    #[tokio::test]
    #[ignore = "manual benchmark; run with --nocapture to see timings"]
    async fn measure_indexready_symfony_demo_eager() {
        let t0 = std::time::Instant::now();
        let mut server = TestServer::with_fixture_and_options(
            "symfony-demo",
            serde_json::json!({ "diagnostics": { "enabled": true }, "indexVendor": true }),
        )
        .await;
        let t_init = t0.elapsed();
        server.wait_for_index_ready().await;
        let t_ready = t0.elapsed();
        println!(
            "MEASURE eager-vendor symfony-demo: init={:?}, indexReady={:?}",
            t_init, t_ready
        );
    }
}

mod call_hierarchy {
    use super::*;

    #[serial_test::serial]
    #[tokio::test]
    async fn incoming_calls_to_post_repository_find_latest() {
        let mut server = TestServer::with_fixture_no_vendor("symfony-demo").await;
        server.wait_for_index_ready().await;

        let (text, line, character) =
            server.locate("src/Repository/PostRepository.php", "findLatest", 0);
        server
            .open("src/Repository/PostRepository.php", &text)
            .await;

        let prep_resp = server
            .prepare_call_hierarchy("src/Repository/PostRepository.php", line, character)
            .await;
        assert!(prep_resp["error"].is_null());
        let item = prep_resp["result"]
            .as_array()
            .and_then(|a| a.first().cloned())
            .unwrap_or_default();

        let resp = server.incoming_calls(item).await;
        assert!(resp["error"].is_null());
        let out = render_call_hierarchy(&resp, "from", &server.uri(""));
        expect!["index @ src/Controller/BlogController.php:47"].assert_eq(&out);
    }
}

// ── Full-fixture tests (vendor present, indexed lazily by default) ───

mod navigation {
    use super::*;

    #[tokio::test]
    async fn goto_definition_parameter_type_in_vendor() {
        let mut server = TestServer::with_fixture("symfony-demo").await;
        server.wait_for_index_ready().await;

        let path = "src/Entity/Post.php";
        let (text, line, ch) = server.locate(path, "User $author", 1);
        server.open(path, &text).await;

        let resp = server.definition(path, line, ch).await;
        let out = render_locations(&resp, &server.uri(""));
        expect!["src/Entity/User.php:32:6-32:10"].assert_eq(&out);
    }

    #[tokio::test]
    async fn goto_definition_app_class_from_use_import() {
        let mut server = TestServer::with_fixture("symfony-demo").await;
        server.wait_for_index_ready().await;

        let path = "src/Repository/PostRepository.php";
        let (text, line, ch) = server.locate(path, "Post;", 0);
        server.open(path, &text).await;

        let resp = server.definition(path, line, ch).await;
        let out = render_locations(&resp, &server.uri(""));
        expect!["src/Entity/Post.php:36:6-36:10"].assert_eq(&out);
    }

    #[tokio::test]
    async fn goto_definition_inherited_method_this_render() {
        let mut server = TestServer::with_fixture("symfony-demo").await;
        server.wait_for_index_ready().await;

        let path = "src/Controller/BlogController.php";
        let (text, line, ch) = server.locate(path, "render('", 0);
        server.open(path, &text).await;

        let resp = server.definition(path, line, ch).await;
        let out = render_locations(&resp, &server.uri(""));
        expect!["vendor/symfony/framework-bundle/Controller/AbstractController.php:275:23-275:29"]
            .assert_eq(&out);
    }

    #[serial_test::serial]
    #[tokio::test]
    async fn goto_definition_attribute_class_route() {
        let fixture = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR"))
            .join("tests/fixtures/symfony-demo");
        let mut server = TestServer::with_root(&fixture).await;
        server.wait_for_index_ready().await;

        let path = "src/Controller/BlogController.php";
        let (text, line, ch) = server.locate(path, "Route", 0);
        server.open(path, &text).await;

        let resp = server.definition(path, line, ch).await;
        assert!(resp["error"].is_null());
    }
}

mod hover {
    use super::*;

    #[serial_test::serial]
    #[tokio::test]
    async fn hover_on_class_in_extends_clause() {
        let fixture = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR"))
            .join("tests/fixtures/symfony-demo");
        let mut server = TestServer::with_root(&fixture).await;
        server.wait_for_index_ready().await;

        let path = "src/Controller/BlogController.php";
        let (text, line, ch) = server.locate(path, "AbstractController", 0);
        server.open(path, &text).await;

        let resp = server.hover(path, line, ch).await;
        assert!(resp["error"].is_null());
        assert!(!resp["result"].is_null());
    }

    #[tokio::test]
    async fn hover_on_app_entity_type_in_signature() {
        let mut server = TestServer::with_fixture("symfony-demo").await;
        server.wait_for_index_ready().await;

        let path = "src/Repository/PostRepository.php";
        let (text, line, ch) = server.locate(path, "Tag $tag", 0);
        server.open(path, &text).await;

        let resp = server.hover(path, line, ch).await;
        let out = render_hover(&resp);
        expect![[r#"
            ```php
            class Tag implements \JsonSerializable
            ```"#]]
        .assert_eq(&out);
    }
}

mod implementation {
    use super::*;

    /// `User implements UserInterface` — cursor on the `implements` clause
    /// (occurrence=1) should return at least `App\Entity\User`.
    #[tokio::test]
    async fn implementations_of_user_interface_include_app_user() {
        let mut server = TestServer::with_fixture("symfony-demo").await;
        server.wait_for_index_ready().await;

        let path = "src/Entity/User.php";
        // occurrence=1: the `implements UserInterface` clause, not the `use` import.
        let (text, line, ch) = server.locate(path, "UserInterface", 1);
        server.open(path, &text).await;

        let resp = server.implementation(path, line, ch).await;
        assert!(resp["error"].is_null());
        let out = render_locations(&resp, &server.uri(""));
        expect!["src/Entity/User.php:32:6-32:10"].assert_eq(&out);
    }

    /// Cursor on the `use` import line (`use A\B\Foo`) must also work — the
    /// handler splits on `\` to recover the short name for the index lookup.
    #[tokio::test]
    async fn implementations_via_use_statement_cursor() {
        let mut server = TestServer::with_fixture("symfony-demo").await;
        server.wait_for_index_ready().await;

        let path = "src/Entity/User.php";
        // occurrence=0: the `use …\UserInterface` line.
        let (text, line, ch) = server.locate(path, "UserInterface", 0);
        server.open(path, &text).await;

        let resp = server.implementation(path, line, ch).await;
        assert!(resp["error"].is_null());
        let out = render_locations(&resp, &server.uri(""));
        expect!["src/Entity/User.php:32:6-32:10"].assert_eq(&out);
    }
}

mod references {
    use super::*;

    #[serial_test::serial]
    #[tokio::test]
    async fn references_to_post_entity_span_multiple_files() {
        let fixture = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR"))
            .join("tests/fixtures/symfony-demo");
        let mut server = TestServer::with_root(&fixture).await;
        server.wait_for_index_ready().await;

        let path = "src/Entity/Post.php";
        let (text, line, character) = server.locate(path, "class Post", 0);
        let character = character + "class ".len() as u32;
        server.open(path, &text).await;

        let resp = server.references(path, line, character, false).await;
        assert!(resp["error"].is_null(), "references error: {:?}", resp);
        let out = render_locations(&resp, &server.uri(""));
        // Must span ≥4 files including PostRepository.php
        expect![[r#"
            src/Controller/Admin/BlogController.php:122:25-122:29
            src/Controller/Admin/BlogController.php:138:43-138:47
            src/Controller/Admin/BlogController.php:161:45-161:49
            src/Controller/Admin/BlogController.php:79:20-79:24
            src/Controller/BlogController.php:110:54-110:58
            src/Controller/BlogController.php:150:32-150:36
            src/Controller/BlogController.php:80:29-80:33
            src/DataFixtures/AppFixtures.php:73:24-73:28
            src/Entity/Comment.php:101:32-101:36
            src/Entity/Comment.php:106:28-106:32
            src/Entity/Comment.php:37:34-37:38
            src/Entity/Comment.php:39:13-39:17
            src/Form/PostType.php:88:28-88:32
            src/Repository/PostRepository.php:38:39-38:43
            src/Security/PostVoter.php:40:35-40:39
            tests/Controller/DefaultControllerTest.php:64:45-64:49"#]]
        .assert_eq(&out);
    }
}

mod type_hierarchy {
    use super::*;

    /// `BlogController extends AbstractController` — supertypes of BlogController
    /// must include AbstractController (a vendor class), verifying that the
    /// PSR-4 pre-load pass makes vendor parents visible in the workspace index.
    #[serial_test::serial]
    #[tokio::test]
    async fn supertypes_of_blog_controller_include_abstract_controller() {
        let mut server = TestServer::with_fixture("symfony-demo").await;
        server.wait_for_index_ready().await;

        let path = "src/Controller/BlogController.php";
        let (text, line, ch) = server.locate(path, "BlogController", 0);
        server.open(path, &text).await;

        let prep = server.prepare_type_hierarchy(path, line, ch).await;
        let item = prep["result"]
            .as_array()
            .and_then(|a| a.first().cloned())
            .unwrap_or_default();
        assert_eq!(item["name"].as_str(), Some("BlogController"));

        let resp = server.supertypes(item).await;
        assert!(resp["error"].is_null());
        let names: Vec<&str> = resp["result"]
            .as_array()
            .map(|a| a.iter().filter_map(|i| i["name"].as_str()).collect())
            .unwrap_or_default();
        // Supertypes must include AbstractController (vendor class via PSR-4 pre-load)
        expect!["AbstractController, AbstractController"].assert_eq(&names.join(", "));
    }

    /// `BlogController extends AbstractController` — subtypes of AbstractController
    /// (a vendor class) must include BlogController once AbstractController has
    /// been pre-loaded into the workspace index.
    #[serial_test::serial]
    #[tokio::test]
    async fn subtypes_of_abstract_controller_include_blog_controller() {
        let mut server = TestServer::with_fixture("symfony-demo").await;
        server.wait_for_index_ready().await;

        // First open BlogController so the workspace knows about the relationship.
        let path = "src/Controller/BlogController.php";
        let (text, _, _) = server.locate(path, "BlogController", 0);
        server.open(path, &text).await;

        // Prepare on AbstractController (in vendor) — needs PSR-4 resolution.
        // Use the use-statement line in BlogController to locate it.
        let (_, ac_line, ac_ch) = server.locate(path, "AbstractController", 0);
        let prep = server.prepare_type_hierarchy(path, ac_line, ac_ch).await;
        // prepare_type_hierarchy may return null for vendor classes not yet in the
        // workspace index; in that case subtypes is undefined and we just pass.
        let Some(item) = prep["result"].as_array().and_then(|a| a.first().cloned()) else {
            return;
        };

        let resp = server.subtypes(item).await;
        assert!(resp["error"].is_null());
        let items = resp["result"].as_array().cloned().unwrap_or_default();
        let names: Vec<&str> = items.iter().filter_map(|i| i["name"].as_str()).collect();
        assert!(
            names.contains(&"BlogController"),
            "expected BlogController in subtypes of AbstractController; got {names:?}"
        );
    }
}

mod smoke {
    use super::*;

    #[serial_test::serial]
    #[tokio::test]
    async fn smoke_goto_definition_abstract_controller() {
        let fixture = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR"))
            .join("tests/fixtures/symfony-demo");
        let mut server = TestServer::with_root(&fixture).await;
        server.wait_for_index_ready().await;

        let path = "src/Controller/BlogController.php";
        let (text, line, ch) = server.locate(path, "AbstractController", 0);
        server.open(path, &text).await;

        let resp = server.definition(path, line, ch).await;
        assert!(resp["error"].is_null());
    }
}