Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[ty] Improve LSP test server logging #21432

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
MichaReiser merged 1 commit into from
Nov 13, 2025
Merged

[ty] Improve LSP test server logging #21432

MichaReiser merged 1 commit into from
Nov 13, 2025

Conversation

@MichaReiser
Copy link
Member

@MichaReiser MichaReiser commented Nov 13, 2025 •
edited
Loading

Summary

Improve the test server logging to get to the root cause of why ty_server::e2e pull_diagnostics::on_did_open flakes (it seems to take the dynamic registration path but it's unclear to me WHY?).

Test Plan

2025-11-13 18:09:51.614252000 DEBUG Starting test client with capabilities ClientCapabilities {
    workspace: Some(
        WorkspaceClientCapabilities {
            apply_edit: None,
            workspace_edit: None,
            did_change_configuration: None,
            did_change_watched_files: None,
            symbol: None,
            execute_command: None,
            workspace_folders: None,
            configuration: Some(
                true,
            ),
            semantic_tokens: None,
            code_lens: None,
            file_operations: None,
            inline_value: None,
            inlay_hint: None,
            diagnostics: None,
        },
    ),
    text_document: Some(
        TextDocumentClientCapabilities {
            synchronization: None,
            completion: None,
            hover: None,
            signature_help: None,
            references: None,
            document_highlight: None,
            document_symbol: None,
            formatting: None,
            range_formatting: None,
            on_type_formatting: None,
            declaration: None,
            definition: None,
            type_definition: None,
            implementation: None,
            code_action: None,
            code_lens: None,
            document_link: None,
            color_provider: None,
            rename: None,
            publish_diagnostics: Some(
                PublishDiagnosticsClientCapabilities {
                    related_information: None,
                    tag_support: None,
                    version_support: None,
                    code_description_support: None,
                    data_support: None,
                },
            ),
            folding_range: None,
            selection_range: None,
            linked_editing_range: None,
            call_hierarchy: None,
            semantic_tokens: None,
            moniker: None,
            type_hierarchy: None,
            inline_value: None,
            inlay_hint: None,
            diagnostic: Some(
                DiagnosticClientCapabilities {
                    dynamic_registration: None,
                    related_document_support: None,
                },
            ),
            inline_completion: None,
        },
    ),
    notebook_document: None,
    window: None,
    general: None,
    offset_encoding: None,
    experimental: None,
}
2025-11-13 18:09:51.614536000 DEBUG Architecture: aarch64, OS: macos, case-sensitive: case-insensitive
2025-11-13 18:09:51.614655000 DEBUG Client sends request `initialize` with ID 1
2025-11-13 18:09:51.614964000 DEBUG Initialization options: InitializationOptions {
    log_level: None,
    log_file: None,
    options: ClientOptions {
        global: GlobalOptions {
            diagnostic_mode: None,
            experimental: None,
        },
        workspace: WorkspaceOptions {
            disable_language_services: None,
            inlay_hints: None,
            python_extension: None,
        },
        unknown: {},
    },
}
2025-11-13 18:09:51.615064000 DEBUG Resolved client capabilities: ["PULL_DIAGNOSTICS", "WORKSPACE_CONFIGURATION"]
2025-11-13 18:09:51.615123000  INFO Version: Unknown
2025-11-13 18:09:51.615214000 DEBUG Received server response for request 1
2025-11-13 18:09:51.615424000 DEBUG Client sends notification `initialized`
2025-11-13 18:09:51.615536000 DEBUG Requesting workspace configuration for workspaces
2025-11-13 18:09:51.615608000 DEBUG Received server request `workspace/configuration`
2025-11-13 18:09:51.615618000  INFO Retrying to receive `workspace/configuration` request
2025-11-13 18:09:51.615640000 DEBUG No workspace configuration provided for file:///private/var/folders/7s/n00zmc2d0qgchs1ns43xq47h0000gn/T/.tmpdi61VF/src
2025-11-13 18:09:51.615674000 DEBUG Client sends notification `textDocument/didOpen`
2025-11-13 18:09:51.615685000 DEBUG Client sends request `textDocument/diagnostic` with ID 2
2025-11-13 18:09:51.615762000 DEBUG client_response{id=0 method="workspace/configuration"}: Received workspace configurations, initializing workspaces
2025-11-13 18:09:51.615778000 DEBUG client_response{id=0 method="workspace/configuration"}: No workspace options provided for file:///private/var/folders/7s/n00zmc2d0qgchs1ns43xq47h0000gn/T/.tmpdi61VF/src, using default options
2025-11-13 18:09:51.615800000 DEBUG Deferring `textDocument/didOpen` notification until all workspaces are initialized
2025-11-13 18:09:51.615809000 DEBUG Initializing workspace `file:///private/var/folders/7s/n00zmc2d0qgchs1ns43xq47h0000gn/T/.tmpdi61VF/src`
2025-11-13 18:09:51.615857000 DEBUG Searching for a project in '/private/var/folders/7s/n00zmc2d0qgchs1ns43xq47h0000gn/T/.tmpdi61VF/src'
2025-11-13 18:09:51.615927000 DEBUG The ancestor directories contain no `pyproject.toml`. Falling back to a virtual project.
2025-11-13 18:09:51.615947000 DEBUG Searching for a user-level configuration at `/Users/micha/.config/ty/ty.toml`
2025-11-13 18:09:51.618682000  INFO Defaulting to python-platform `darwin`
2025-11-13 18:09:51.618712000 DEBUG Discovering virtual environment in `/private/var/folders/7s/n00zmc2d0qgchs1ns43xq47h0000gn/T/.tmpdi61VF/src`
2025-11-13 18:09:51.618799000 DEBUG Failed to discover ty's environment: Invalid ty environment `/Users/micha/astral/ruff/target/debug/deps/e2e-99930d2b8b0885b2`: does not point to a Python executable or a directory on disk
2025-11-13 18:09:51.618829000 DEBUG No virtual environment found
2025-11-13 18:09:51.618867000 DEBUG Including `.` in `environment.root`
2025-11-13 18:09:51.618914000 DEBUG Adding first-party search path `/private/var/folders/7s/n00zmc2d0qgchs1ns43xq47h0000gn/T/.tmpdi61VF/src`
2025-11-13 18:09:51.618933000 DEBUG Using vendored stdlib
2025-11-13 18:09:51.619642000  INFO Python version: Python 3.14, platform: darwin
2025-11-13 18:09:51.620239000 DEBUG Adding new file root '/private/var/folders/7s/n00zmc2d0qgchs1ns43xq47h0000gn/T/.tmpdi61VF/src' of kind Project
2025-11-13 18:09:51.620319000  WARN Your LSP client doesn't support file watching: You may see stale results when files change outside the editor
2025-11-13 18:09:51.620328000 DEBUG Processing deferred notification `textDocument/didOpen`
2025-11-13 18:09:51.628174000 DEBUG notification{method="textDocument/didOpen"}:apply_changes: Adding file `/private/var/folders/7s/n00zmc2d0qgchs1ns43xq47h0000gn/T/.tmpdi61VF/src/foo.py` to project `src`
2025-11-13 18:09:51.628209000 DEBUG notification{method="textDocument/didOpen"}: Opening file `/private/var/folders/7s/n00zmc2d0qgchs1ns43xq47h0000gn/T/.tmpdi61VF/src/foo.py`
2025-11-13 18:09:51.628219000 DEBUG notification{method="textDocument/didOpen"}: Take open project files
2025-11-13 18:09:51.628255000 DEBUG notification{method="textDocument/didOpen"}:set_open_files{open_files={file(Id(c00))}}: Set open project files (count: 1)
2025-11-13 18:09:51.628411000 DEBUG request{id=2 method="textDocument/diagnostic"}: source text: def foo() -> str:
    return 42

2025-11-13 18:09:51.631450000  INFO request{id=2 method="textDocument/diagnostic"}:check_file{file=file(Id(c00))}:Project::index_files{project=src}: Indexed 1 file(s) in 0.003s
2025-11-13 18:09:51.631640000 DEBUG request{id=2 method="textDocument/diagnostic"}:check_file{file=file(Id(c00))}: Checking file '/private/var/folders/7s/n00zmc2d0qgchs1ns43xq47h0000gn/T/.tmpdi61VF/src/foo.py'
2025-11-13 18:09:51.716922000 DEBUG Received server response for request 2
2025-11-13 18:09:51.754282000 DEBUG Client sends request `shutdown` with ID 3
2025-11-13 18:09:51.754405000 DEBUG request{id=3 method="shutdown"}: Received shutdown request, waiting for exit notification
2025-11-13 18:09:51.754460000 DEBUG Received server response for request 3
2025-11-13 18:09:51.754474000 DEBUG Client sends notification `exit`
2025-11-13 18:09:51.754491000 DEBUG Received exit notification, exiting
test pull_diagnostics::on_did_open ... ok

@MichaReiser MichaReiser added testing Related to testing Ruff itself ty Multi-file analysis & type inference labels Nov 13, 2025
@MichaReiser MichaReiser force-pushed the micha/test-server-logging branch from 8fb6735 to f21fcc4 Compare November 13, 2025 17:11
@astral-sh-bot
Copy link

astral-sh-bot bot commented Nov 13, 2025 •
edited
Loading

Diagnostic diff on typing conformance tests

No changes detected when running ty on typing conformance tests ✅

@astral-sh-bot
Copy link

astral-sh-bot bot commented Nov 13, 2025 •
edited
Loading

mypy_primer results

No ecosystem changes detected ✅

No memory usage changes detected ✅

@MichaReiser MichaReiser force-pushed the micha/test-server-logging branch from f21fcc4 to 1a14ddf Compare November 13, 2025 17:17
@MichaReiser MichaReiser merged commit e70fccb into main Nov 13, 2025
40 checks passed
@MichaReiser MichaReiser deleted the micha/test-server-logging branch November 13, 2025 17:29
@dhruvmanila
Copy link
Member

dhruvmanila commented Nov 14, 2025

(it seems to take the dynamic registration path but it's unclear to me WHY?).

Where do you see that it's taking the dynamic registration path? I don't see the relevant logs in https://github.com/astral-sh/ruff/actions/runs/19290646588/job/55160349507?pr=21363#step:7:5873

@MichaReiser
Copy link
Member Author

MichaReiser commented Nov 14, 2025

I can't say for certain but looking at the unclaimed response

    Unclaimed responses: {
        RequestId(
            I32(
                2,
            ),
        ): Response {
            id: RequestId(
                I32(
                    2,
                ),
            ),
            result: Some(
                Object {
                    "items": Array [],
                    "kind": String("full"),
                },
            ),
            error: None,
        },
    }

I assumed that it is the register capability request for diagnostics. But taking a second look today I think this isn't the case because a) that would be a request and b) it would include the capability name.

I guess I don't know what it is but the new logging should help us to understand what the request with id 2 was.

@dhruvmanila
Copy link
Member

dhruvmanila commented Nov 14, 2025

I guess I don't know what it is but the new logging should help us to understand what the request with id 2 was.

It was textDocument/diagnostic as per the logs (request id 2):

2025-11-12 08:18:28.294415000  INFO request{id=2 method="textDocument/diagnostic"}:check_file{file=file(Id(c00))}:Project::index_files{project=src}: Indexed 1 file(s) in 0.011s

@MichaReiser
Copy link
Member Author

MichaReiser commented Nov 14, 2025 •
edited
Loading

That's even weirder... Because we explicitly await that response. Unless the response takes too long, in which case we should panic?

Edit: Oh no, we don't. We return an error, but that means that std::thread::panicking won't be set, meaning we swallow the real error - the response taking too long

@MichaReiser
Copy link
Member Author

MichaReiser commented Nov 14, 2025

I think this is a more general issue with how we use Result in the TestServer because it's almost guaranteed that we have unprocessed responses if any test exits early because of a receive error.

I think we should remove the assertion that all messages were consumed in the drop handler and instead expose a method so that test can perform this assertion when they want to.

The one assertion that we probably want to keep is that the server never sends a response after exit

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@carljm carljm Awaiting requested review from carljm carljm is a code owner

@sharkdp sharkdp Awaiting requested review from sharkdp sharkdp is a code owner

@dcreager dcreager Awaiting requested review from dcreager dcreager is a code owner

@dhruvmanila dhruvmanila Awaiting requested review from dhruvmanila

Assignees

No one assigned

Labels

testing Related to testing Ruff itself ty Multi-file analysis & type inference

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@MichaReiser @dhruvmanila