Nim Lsp Not responding

[RobertGeorgeByrne]

Summary

When using any lsp feature such as goto definition after a few seconds I get the error Async job failed: request 1 timed out

I assume reading the log that this is the cause:
"Shutting down due to an error: Invalid scheme: , only "file" is supported\n"

The language server itself works fine when using it with neovim lsp plugin with default settings

Reproduction Steps

nimlangserver installed with nimble (its version 0.1.0)
using default helix setting, no languages.toml file ( I have tried messing arround adding the language server manually in languages.toml but with no success)

Helix log

2023-07-01T22:54:44.576 helix_lsp::transport [ERROR] err <- "DBG Router: dispatching                        method=initialize id=0\n"
2023-07-01T22:54:44.576 helix_lsp::transport [ERROR] err <- "DBG Initialize received...                    \n"
2023-07-01T22:54:44.576 helix_lsp::transport [ERROR] err <- "DBG Router: sending response                   method=initialize id=0\n"
2023-07-01T22:54:44.578 helix_lsp::transport [ERROR] err <- "DBG Router: dispatching                        method=initialized id=null\n"
2023-07-01T22:54:44.578 helix_lsp::transport [ERROR] err <- "DBG Client initialized.                       \n"
2023-07-01T22:54:44.578 helix_lsp::transport [ERROR] err <- "DBG Requesting configuration from the client  \n"
2023-07-01T22:54:44.579 helix_lsp::transport [ERROR] err <- "DBG Router: dispatching                        method=textDocument/didOpen id=null\n"
2023-07-01T22:54:44.579 helix_lsp::transport [ERROR] err <- "DBG New document opened for URI:               uri=file:///home/bob/code/nimhello/src/nimhello.nim\n"
2023-07-01T22:54:44.579 helix_lsp::transport [ERROR] err <- "Shutting down due to an error: Invalid scheme: , only \"file\" is supported\n"
2023-07-01T22:54:44.579 helix_lsp::transport [ERROR] err <- "utils.nim(87)            uriToPath\n"
2023-07-01T22:54:44.579 helix_lsp::transport [ERROR] err <- "asyncfutures.nim(389)    read\n"
2023-07-01T22:54:44.579 helix_lsp::transport [ERROR] err <- "asyncfutures.nim(389)    read\n"
2023-07-01T22:54:44.579 helix_lsp::transport [ERROR] err <- "asyncfutures.nim(389)    read\n"
2023-07-01T22:54:44.579 helix_lsp::transport [ERROR] err <- "???                      routeIter\n"
2023-07-01T22:54:44.579 helix_lsp::transport [ERROR] err <- "asyncfutures.nim(389)    read\n"
2023-07-01T22:54:44.580 helix_lsp::transport [ERROR] err <- "asyncfutures.nim(389)    read\n"
2023-07-01T22:54:44.580 helix_lsp::transport [ERROR] err <- "\n"
2023-07-01T22:54:44.580 helix_lsp::transport [ERROR] err: <- StreamClosed
2023-07-01T22:54:50.411 helix_lsp::transport [ERROR] err: <- IO(Os { code: 32, kind: BrokenPipe, message: "Broken pipe" })
2023-07-01T22:55:10.412 helix_view::editor [ERROR] editor error: Async job failed: request 1 timed out

Platform

linux -- kenel 6.3.8_1

Terminal Emulator

St (also tested on xfce4-terminal)

Helix Version

23.05

[the-mikedavis]

I can't reproduce this out of the box on the latest master of Helix and nimlangserver. What version are you running of nimlangserver?

Also, what does the log show when running in verbose mode? You can use hx -v --log log.txt to write the verbose log to a log.txt file.

[RobertGeorgeByrne]

packageName = "nimlangserver"
version = "0.1.0"
author = "The core Nim team"

also I am using Nim Compiler Version 1.6.12 [Linux: amd64] and the same version of nim suggest

hx -v --log:

2023-07-02T16:02:06.493 helix_vcs [INFO] Error {
    context: "failed to open git repo",
    source: Discover(
        NoGitRepository {
            path: "/home/bob/code/nimhello/src",
        },
    ),
}
2023-07-02T16:02:06.493 helix_vcs [INFO] failed to open diff base for /home/bob/code/nimhello/src/nimhello.nim
2023-07-02T16:02:06.493 helix_vcs [INFO] Error {
    context: "failed to open git repo",
    source: Discover(
        NoGitRepository {
            path: "/home/bob/code/nimhello/src",
        },
    ),
}
2023-07-02T16:02:06.493 helix_vcs [INFO] failed to obtain current head name for /home/bob/code/nimhello/src/nimhello.nim
2023-07-02T16:02:06.494 helix_lsp::transport [INFO] -> {"jsonrpc":"2.0","method":"initialize","params":{"capabilities":{"general":{"positionEncodings":["utf-8","utf-32","utf-16"]},"textDocument":{"codeAction":{"codeActionLiteralSupport":{"codeActionKind":{"valueSet":["","quickfix","refactor","refactor.extract","refactor.inline","refactor.rewrite","source","source.organizeImports"]}}},"completion":{"completionItem":{"deprecatedSupport":true,"insertReplaceSupport":true,"resolveSupport":{"properties":["documentation","detail","additionalTextEdits"]},"snippetSupport":true,"tagSupport":{"valueSet":[1]}},"completionItemKind":{}},"hover":{"contentFormat":["markdown"]},"inlayHint":{"dynamicRegistration":false},"publishDiagnostics":{"versionSupport":true},"rename":{"dynamicRegistration":false,"honorsChangeAnnotations":false,"prepareSupport":true},"signatureHelp":{"signatureInformation":{"activeParameterSupport":true,"documentationFormat":["markdown"],"parameterInformation":{"labelOffsetSupport":true}}}},"window":{"workDoneProgress":true},"workspace":{"applyEdit":true,"configuration":true,"didChangeConfiguration":{"dynamicRegistration":false},"executeCommand":{"dynamicRegistration":false},"inlayHint":{"refreshSupport":false},"symbol":{"dynamicRegistration":false},"workspaceEdit":{"documentChanges":true,"failureHandling":"abort","normalizesLineEndings":false,"resourceOperations":["create","rename","delete"]},"workspaceFolders":true}},"clientInfo":{"name":"helix","version":"23.05"},"processId":4379,"rootPath":"/home/bob/code/nimhello/src","rootUri":null,"workspaceFolders":[]},"id":0}
2023-07-02T16:02:06.504 helix_lsp::transport [INFO] <- {"jsonrpc":"2.0","id":0,"result":{"capabilities":{"textDocumentSync":{"openClose":true,"change":1,"willSave":false,"willSaveWaitUntil":false,"save":{"includeText":true}},"hoverProvider":true,"completionProvider":{"resolveProvider":false,"triggerCharacters":["."]},"signatureHelpProvider":null,"definitionProvider":true,"declarationProvider":true,"typeDefinitionProvider":true,"implementationProvider":null,"referencesProvider":true,"documentHighlightProvider":true,"documentSymbolProvider":true,"workspaceSymbolProvider":true,"codeActionProvider":true,"codeLensProvider":null,"documentFormattingProvider":null,"documentRangeFormattingProvider":null,"documentOnTypeFormattingProvider":null,"renameProvider":{"prepareProvider":true},"documentLinkProvider":null,"colorProvider":null,"executeCommandProvider":{"commands":["nimlangserver.restart","nimlangserver.recompile","nimlangserver.checkProject"]},"workspace":{"workspaceFolders":{"supported":null,"changeNotifications":null}},"experimental":null}}}

2023-07-02T16:02:06.504 helix_lsp::transport [INFO] <- {"capabilities":{"codeActionProvider":true,"codeLensProvider":null,"colorProvider":null,"completionProvider":{"resolveProvider":false,"triggerCharacters":["."]},"declarationProvider":true,"definitionProvider":true,"documentFormattingProvider":null,"documentHighlightProvider":true,"documentLinkProvider":null,"documentOnTypeFormattingProvider":null,"documentRangeFormattingProvider":null,"documentSymbolProvider":true,"executeCommandProvider":{"commands":["nimlangserver.restart","nimlangserver.recompile","nimlangserver.checkProject"]},"experimental":null,"hoverProvider":true,"implementationProvider":null,"referencesProvider":true,"renameProvider":{"prepareProvider":true},"signatureHelpProvider":null,"textDocumentSync":{"change":1,"openClose":true,"save":{"includeText":true},"willSave":false,"willSaveWaitUntil":false},"typeDefinitionProvider":true,"workspace":{"workspaceFolders":{"changeNotifications":null,"supported":null}},"workspaceSymbolProvider":true}}
2023-07-02T16:02:06.504 helix_lsp::transport [INFO] -> {"jsonrpc":"2.0","method":"initialized","params":{}}
2023-07-02T16:02:06.504 helix_lsp::transport [ERROR] err <- "DBG Router: dispatching                        method=initialize id=0\n"
2023-07-02T16:02:06.504 helix_lsp::transport [ERROR] err <- "DBG Initialize received...                    \n"
2023-07-02T16:02:06.504 helix_lsp::transport [ERROR] err <- "DBG Router: sending response                   method=initialize id=0\n"
2023-07-02T16:02:06.504 helix_lsp::transport [INFO] -> {"jsonrpc":"2.0","method":"textDocument/didOpen","params":{"textDocument":{"languageId":"nim","text":"echo \"Hello World\"\n\n\nproc te(x: bool): bool =  \n    x\n\n\necho( te true )\n","uri":"file:///home/bob/code/nimhello/src/nimhello.nim","version":0}}}
2023-07-02T16:02:06.505 helix_lsp::transport [ERROR] err <- "DBG Router: dispatching                        method=initialized id=null\n"
2023-07-02T16:02:06.505 helix_lsp::transport [ERROR] err <- "DBG Client initialized.                       \n"
2023-07-02T16:02:06.505 helix_lsp::transport [ERROR] err <- "DBG Requesting configuration from the client  \n"
2023-07-02T16:02:06.505 helix_lsp::transport [INFO] <- {"jsonrpc":"2.0","method":"workspace/configuration","params":{"items":[{"scopeUri":null,"section":"nim"}]},"id":1}
2023-07-02T16:02:06.506 helix_lsp::transport [INFO] -> {"jsonrpc":"2.0","result":[null],"id":1}
2023-07-02T16:02:06.506 helix_lsp::transport [ERROR] err <- "DBG Router: dispatching                        method=textDocument/didOpen id=null\n"
2023-07-02T16:02:06.506 helix_lsp::transport [ERROR] err <- "DBG New document opened for URI:               uri=file:///home/bob/code/nimhello/src/nimhello.nim\n"
2023-07-02T16:02:06.506 helix_lsp::transport [ERROR] err <- "Shutting down due to an error: Invalid scheme: , only \"file\" is supported\n"
2023-07-02T16:02:06.506 helix_lsp::transport [ERROR] err <- "utils.nim(87)            uriToPath\n"
2023-07-02T16:02:06.506 helix_lsp::transport [ERROR] err <- "asyncfutures.nim(389)    read\n"
2023-07-02T16:02:06.506 helix_lsp::transport [ERROR] err <- "asyncfutures.nim(389)    read\n"
2023-07-02T16:02:06.506 helix_lsp::transport [ERROR] err <- "asyncfutures.nim(389)    read\n"
2023-07-02T16:02:06.506 helix_lsp::transport [ERROR] err <- "???                      routeIter\n"
2023-07-02T16:02:06.506 helix_lsp::transport [ERROR] err <- "asyncfutures.nim(389)    read\n"
2023-07-02T16:02:06.506 helix_lsp::transport [ERROR] err <- "asyncfutures.nim(389)    read\n"
2023-07-02T16:02:06.506 helix_lsp::transport [ERROR] err <- "\n"
2023-07-02T16:02:06.507 helix_lsp::transport [ERROR] err: <- StreamClosed
2023-07-02T16:02:22.324 helix_lsp::transport [INFO] -> {"jsonrpc":"2.0","method":"textDocument/definition","params":{"position":{"character":6,"line":7},"textDocument":{"uri":"file:///home/bob/code/nimhello/src/nimhello.nim"}},"id":1}
2023-07-02T16:02:22.324 helix_lsp::transport [ERROR] err: <- IO(Os { code: 32, kind: BrokenPipe, message: "Broken pipe" })
2023-07-02T16:02:42.325 helix_view::editor [ERROR] editor error: Async job failed: request 1 timed out

I also just tried the latest appimage binary of helix and I get the same errors

[the-mikedavis]

Ah ok, I can reproduce. The problem is this line upstream https://github.com/nim-lang/langserver/blob/b243a4c076bde0876052dff7d7a65ab43d2bd33b/nimlangserver.nim#L122

The server isn't handling the case that rootUri can be null (relevant part of the spec: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#initialize). When we pass it as null it fails saying that file is the only scheme supported by the scheme on a null URI is also null. This should be fixed upstream but as a workaround you can create a .helix/languages.toml file in your Nim project root directory so that we send the rootUri as that directory rather than null.