php-lsp 0.4.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

//! Goto-definition across the vendored symfony/demo project.
//! Each test uses its own indexed server — we investigated sharing via
//! OnceCell + Mutex, but the shared-server pattern caused state
//! pollution (wrong goto-def targets after a prior query) and
//! BrokenPipe flakiness; the per-test server pattern is deterministic
//! and the extra wall time is acceptable for `--ignored` runs.
//!
//! All `#[ignore]`: run with `cargo test --release -- --ignored`.

mod common;

use common::TestServer;
use serde_json::Value;

fn first_loc(result: &Value) -> Value {
    if result.is_array() {
        result[0].clone()
    } else {
        result.clone()
    }
}

fn uri_of(loc: &Value) -> &str {
    loc["uri"]
        .as_str()
        .or_else(|| loc["targetUri"].as_str())
        .unwrap_or_default()
}

#[tokio::test]
#[ignore = "slow: workspace-scale test, run with --ignored"]
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/Controller/BlogController.php";
    let (text, line, character) = server.locate(path, "Request $request", 0);
    server.open(path, &text).await;

    let resp = server.definition(path, line, character).await;
    assert!(resp["error"].is_null(), "definition error: {:?}", resp);
    let loc = first_loc(&resp["result"]);
    assert!(!loc.is_null(), "expected Request class location");
    assert!(
        uri_of(&loc).ends_with("/vendor/symfony/http-foundation/Request.php"),
        "expected HttpFoundation/Request.php, got: {}",
        uri_of(&loc)
    );
}

#[tokio::test]
#[ignore = "slow: workspace-scale test, run with --ignored"]
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/Controller/BlogController.php";
    let (text, line, character) = server.locate(path, "PostRepository $posts", 0);
    server.open(path, &text).await;

    let resp = server.definition(path, line, character).await;
    assert!(resp["error"].is_null(), "definition error: {:?}", resp);
    let loc = first_loc(&resp["result"]);
    assert!(!loc.is_null(), "expected PostRepository location");
    assert!(
        uri_of(&loc).ends_with("/src/Repository/PostRepository.php"),
        "expected src/Repository/PostRepository.php, got: {}",
        uri_of(&loc)
    );
}

#[tokio::test]
#[ignore = "php-lsp gap: method goto-def on `$this->render` ignores receiver type; jumps to an unrelated render() (observed: BlockQuoteRenderer / Console\\Helper\\Table). Receiver-aware method dispatch is needed"]
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, character) = server.locate(path, "$this->render(", 0);
    let character = character + "$this->".len() as u32 + 1;
    server.open(path, &text).await;

    let resp = server.definition(path, line, character).await;
    assert!(resp["error"].is_null(), "definition error: {:?}", resp);
    let loc = first_loc(&resp["result"]);
    assert!(
        !loc.is_null(),
        "expected a location for $this->render (inherited method)"
    );
    let uri = uri_of(&loc);
    assert!(
        uri.ends_with("/vendor/symfony/framework-bundle/Controller/AbstractController.php"),
        "expected AbstractController.php (defines render()), got: {uri}"
    );
}

#[tokio::test]
#[ignore = "slow: workspace-scale test, run with --ignored"]
async fn goto_definition_attribute_class_route() {
    let mut server = TestServer::with_fixture("symfony-demo").await;
    server.wait_for_index_ready().await;

    let path = "src/Controller/BlogController.php";
    let (text, line, character) = server.locate(path, "#[Route(", 0);
    let character = character + 2;
    server.open(path, &text).await;

    let resp = server.definition(path, line, character).await;
    assert!(resp["error"].is_null(), "definition error: {:?}", resp);
    let loc = first_loc(&resp["result"]);
    assert!(!loc.is_null(), "expected Route attribute class location");
    let uri = uri_of(&loc);
    assert!(
        uri.ends_with("/vendor/symfony/routing/Attribute/Route.php"),
        "expected routing/Attribute/Route.php, got: {uri}"
    );
}