Astro LSP broken because of inlay hints

[dsaghliani]

Summary

The Astro LSP responds with the error, Method workspace/inlayHint/refresh not found in request, and closes the stream.

Worth noting that I have inlay hints disabled.

Reproduction Steps

1. Install Astro LSP via npm install -G @astrojs/language-server.
2. Configure ~/.config/helix/languages.toml as follows:

[[language]]
name = "astro"
scope = "source.astro"
injection-regex = "astro"
file-types = ["astro"]
roots = ["package.json", "astro.config.mjs"]
language-server = { command = "astro-ls", args = ["--stdio"] }

4. Create a new Astro project.
5. cd into the project directory and create a local Helix languages.toml.

mkdir .helix
touch .helix/languages.toml

6. Configure it as follows (replacing the PATH/TO/THIS/PROJECT accordingly):

[[language]]
name = "astro"

[[language.config]]
environment = "node"

[[language.config.typescript]]
sdk = "${config.home.homeDirectory}/PATH/TO/THIS/PROJECT/node_modules/typescript/lib"

7. Create or navigate to an existing Astro file (ending with .astro) and run :lsp-restart.

Helix log

~/.cache/helix/helix.log

2023-06-29T09:37:14.034 helix_term::application [WARN] Ignoring a client/registerCapability request because dynamic capability registration is not enabled. Please report this upstream to the language server
2023-06-29T09:37:14.353 helix_term::application [ERROR] Language Server: Method workspace/inlayHint/refresh not found in request 3
2023-06-29T09:37:14.356 helix_lsp::transport [ERROR] err <- "/home/demna/.nvm/versions/node/v20.2.0/lib/node_modules/@astrojs/language-server/node_modules/vscode-jsonrpc/lib/common/connection.js:565\n"
2023-06-29T09:37:14.356 helix_lsp::transport [ERROR] err <- "                        responsePromise.reject(new messages_1.ResponseError(error.code, error.message, error.data));\n"
2023-06-29T09:37:14.356 helix_lsp::transport [ERROR] err <- "                                               ^\n"
2023-06-29T09:37:14.356 helix_lsp::transport [ERROR] err <- "\n"
2023-06-29T09:37:14.356 helix_lsp::transport [ERROR] err <- "ResponseError: Method not found: workspace/inlayHint/refresh\n"
2023-06-29T09:37:14.356 helix_lsp::transport [ERROR] err <- "    at handleResponse (/home/demna/.nvm/versions/node/v20.2.0/lib/node_modules/@astrojs/language-server/node_modules/vscode-jsonrpc/lib/common/connection.js:565:48)\n"
2023-06-29T09:37:14.357 helix_lsp::transport [ERROR] err <- "    at handleMessage (/home/demna/.nvm/versions/node/v20.2.0/lib/node_modules/@astrojs/language-server/node_modules/vscode-jsonrpc/lib/common/connection.js:345:13)\n"
2023-06-29T09:37:14.357 helix_lsp::transport [ERROR] err <- "    at processMessageQueue (/home/demna/.nvm/versions/node/v20.2.0/lib/node_modules/@astrojs/language-server/node_modules/vscode-jsonrpc/lib/common/connection.js:362:17)\n"
2023-06-29T09:37:14.357 helix_lsp::transport [ERROR] err <- "    at Immediate.<anonymous> (/home/demna/.nvm/versions/node/v20.2.0/lib/node_modules/@astrojs/language-server/node_modules/vscode-jsonrpc/lib/common/connection.js:334:13)\n"
2023-06-29T09:37:14.357 helix_lsp::transport [ERROR] err <- "    at process.processImmediate (node:internal/timers:478:21) {\n"
2023-06-29T09:37:14.357 helix_lsp::transport [ERROR] err <- "  code: -32601,\n"
2023-06-29T09:37:14.357 helix_lsp::transport [ERROR] err <- "  data: undefined\n"
2023-06-29T09:37:14.357 helix_lsp::transport [ERROR] err <- "}\n"
2023-06-29T09:37:14.357 helix_lsp::transport [ERROR] err <- "\n"
2023-06-29T09:37:14.357 helix_lsp::transport [ERROR] err <- "Node.js v20.2.0\n"
2023-06-29T09:37:14.363 helix_lsp::transport [ERROR] err: <- StreamClosed

Platform

Linux

Terminal Emulator

xterm-256color

Helix Version

helix 23.05 (7f5940b)

[the-mikedavis]

We tell the language server that we don't support the refresh method:

helix/helix-lsp/src/client.rs

Lines 532 to 534 in e0bb032

	inlay_hint: Some(lsp::InlayHintWorkspaceClientCapabilities {
	refresh_support: Some(false),
	}),

So astro-ls should not be sending this request. We're sending a JSONRPC error saying that we don't implement the workspace/inlayHint/refresh method as a response when it sends that request. It looks like the server isn't handling the rejected promise, so that promise kills the whole server. These are both astro-ls issues rather than Helix issues.

[dsaghliani]

Thanks for the quick response. Yes, it seems like an upstream issue that has already been fixed: volarjs/volar.js@eb8f8d9.

I guess we just have to wait for the commit to make its way into a new release.