Clojure-lsp go to definition not working for dependencies/core library functions

[tknawara]

Summary

Hey,

Thanks for the great editor, I've been using it for some time and really enjoy it. I'm facing an issue with clojure-lsp, in particular when trying to go to definitions for dependency functions or functions in the standard library (like println).

Reproduction Steps

I tried this:

1. hx for clojure file (clojure lsp is installed in the path).
2. I'm getting errors/warnings/autocompletion correctly, but trying to do go to definition on a symbol that is defined outside of my project (like external jar) doesn't work.
3. the editor opens the file, but doesn't attach and I see an empty file opened instead.

I'm doing this on nixos, I have the flake.nix file that I created for the project

I expected this to happen:
I expected code in the external dependency to show up

Instead, this happened:
helix shows an empty buffer instead, I can see the path of the dependency resolved correctly, something like

~/.m2/repository/http-kit/http-kit/2.8.0/http-kit-2.8.0.jar::org/httpkit/client.clj

Helix log

~/.cache/helix/helix.log

2024-08-13T21:13:01.048 helix_lsp::util [WARN] LSP position Position { line: 999999, character: 999999 } out of range assuming EOF

Platform

linux

Terminal Emulator

wezterm (commit 0ac1e94)

Installation Method

nixpkgs

Helix Version

helix 24.7 (079f544)

[the-mikedavis]

What does the log say in verbose mode when opening one of these references (hx -v --log log.txt)? From the path it looks like the language server is sending a path that it expects us to parse and read out of the jar archive (which would need language-specific support)

[tknawara]

and this is the log when trying to go to definition of a function in the standard library (println)

2024-08-14T17:54:00.992 helix_lsp::transport [INFO] clojure-lsp -> {"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"]}},"dataSupport":true,"disabledSupport":true,"isPreferredSupport":true,"resolveSupport":{"properties":["edit","command"]}},"completion":{"completionItem":{"deprecatedSupport":true,"insertReplaceSupport":true,"resolveSupport":{"properties":["documentation","detail","additionalTextEdits"]},"snippetSupport":true,"tagSupport":{"valueSet":[1]}},"completionItemKind":{}},"formatting":{"dynamicRegistration":false},"hover":{"contentFormat":["markdown"]},"inlayHint":{"dynamicRegistration":false},"publishDiagnostics":{"tagSupport":{"valueSet":[1,2]},"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},"didChangeWatchedFiles":{"dynamicRegistration":true,"relativePatternSupport":false},"executeCommand":{"dynamicRegistration":false},"fileOperations":{"didRename":true,"willRename":true},"inlayHint":{"refreshSupport":false},"symbol":{"dynamicRegistration":false},"workspaceEdit":{"documentChanges":true,"failureHandling":"abort","normalizesLineEndings":false,"resourceOperations":["create","rename","delete"]},"workspaceFolders":true}},"clientInfo":{"name":"helix","version":"24.7 (079f5442)"},"processId":8411,"rootPath":"/home/tarek/workspace/clojure/ps","rootUri":"file:///home/tarek/workspace/clojure/ps","workspaceFolders":[{"name":"ps","uri":"file:///home/tarek/workspace/clojure/ps"}]},"id":0}
2024-08-14T17:54:01.169 helix_lsp::transport [INFO] clojure-lsp <- {"jsonrpc":"2.0","id":0,"result":{"capabilities":{"documentSymbolProvider":true,"textDocumentSync":{"openClose":true,"change":1,"save":{"includeText":true}},"declarationProvider":true,"semanticTokensProvider":{"legend":{"tokenTypes":["namespace","type","function","macro","keyword","class","variable","method","event","interface"],"tokenModifiers":["definition","defaultLibrary","implementation"]},"range":true,"full":true},"linkedEditingRangeProvider":true,"workspaceSymbolProvider":true,"experimental":{"testTree":true,"projectTree":true,"cursorInfo":true,"serverInfo":true,"clojuredocs":true},"codeActionProvider":{"codeActionKinds":["quickfix","refactor","refactor.extract","refactor.inline","refactor.rewrite","source","source.organizeImports"]},"documentHighlightProvider":true,"completionProvider":{"resolveProvider":true,"triggerCharacters":[":","/"]},"workspace":{"fileOperations":{"willRename":{"filters":[{"scheme":"file","pattern":{"glob":"**/*.{clj,cljs,cljc,cljd,edn,bb,clj_kondo}","matches":"file"}}]},"didRename":{"filters":[{"scheme":"file","pattern":{"glob":"**/*.{clj,cljs,cljc,cljd,edn,bb,clj_kondo}","matches":"file"}}]}}},"implementationProvider":true,"signatureHelpProvider":{"triggerCharacters":[]},"documentRangeFormattingProvider":true,"executeCommandProvider":{"commands":["add-import-to-namespace","add-missing-import","add-missing-libspec","add-require-suggestion","backward-barf","backward-slurp","change-coll","clean-ns","create-function","create-test","cursor-info","cycle-coll","cycle-keyword-auto-resolve","cycle-privacy","demote-fn","destructure-keys","drag-backward","drag-forward","drag-param-backward","drag-param-forward","expand-let","extract-function","extract-to-def","forward-barf","forward-slurp","get-in-all","get-in-less","get-in-more","get-in-none","inline-symbol","introduce-let","kill-sexp","move-coll-entry-down","move-coll-entry-up","move-form","move-to-let","promote-fn","raise-sexp","replace-refer-all-with-alias","replace-refer-all-with-refer","resolve-macro-as","restructure-keys","server-info","sort-clauses","sort-map","suppress-diagnostic","thread-first","thread-first-all","thread-last","thread-last-all","unwind-all","unwind-thread"]},"referencesProvider":true,"codeLensProvider":{"resolveProvider":true},"foldingRangeProvider":true,"callHierarchyProvider":true,"documentFormattingProvider":true,"renameProvider":{"prepareProvider":true},"definitionProvider":true,"hoverProvider":true}}}
2024-08-14T17:54:01.170 helix_lsp::transport [INFO] clojure-lsp <- {"capabilities":{"callHierarchyProvider":true,"codeActionProvider":{"codeActionKinds":["quickfix","refactor","refactor.extract","refactor.inline","refactor.rewrite","source","source.organizeImports"]},"codeLensProvider":{"resolveProvider":true},"completionProvider":{"resolveProvider":true,"triggerCharacters":[":","/"]},"declarationProvider":true,"definitionProvider":true,"documentFormattingProvider":true,"documentHighlightProvider":true,"documentRangeFormattingProvider":true,"documentSymbolProvider":true,"executeCommandProvider":{"commands":["add-import-to-namespace","add-missing-import","add-missing-libspec","add-require-suggestion","backward-barf","backward-slurp","change-coll","clean-ns","create-function","create-test","cursor-info","cycle-coll","cycle-keyword-auto-resolve","cycle-privacy","demote-fn","destructure-keys","drag-backward","drag-forward","drag-param-backward","drag-param-forward","expand-let","extract-function","extract-to-def","forward-barf","forward-slurp","get-in-all","get-in-less","get-in-more","get-in-none","inline-symbol","introduce-let","kill-sexp","move-coll-entry-down","move-coll-entry-up","move-form","move-to-let","promote-fn","raise-sexp","replace-refer-all-with-alias","replace-refer-all-with-refer","resolve-macro-as","restructure-keys","server-info","sort-clauses","sort-map","suppress-diagnostic","thread-first","thread-first-all","thread-last","thread-last-all","unwind-all","unwind-thread"]},"experimental":{"clojuredocs":true,"cursorInfo":true,"projectTree":true,"serverInfo":true,"testTree":true},"foldingRangeProvider":true,"hoverProvider":true,"implementationProvider":true,"linkedEditingRangeProvider":true,"referencesProvider":true,"renameProvider":{"prepareProvider":true},"semanticTokensProvider":{"full":true,"legend":{"tokenModifiers":["definition","defaultLibrary","implementation"],"tokenTypes":["namespace","type","function","macro","keyword","class","variable","method","event","interface"]},"range":true},"signatureHelpProvider":{"triggerCharacters":[]},"textDocumentSync":{"change":1,"openClose":true,"save":{"includeText":true}},"workspace":{"fileOperations":{"didRename":{"filters":[{"pattern":{"glob":"**/*.{clj,cljs,cljc,cljd,edn,bb,clj_kondo}","matches":"file"},"scheme":"file"}]},"willRename":{"filters":[{"pattern":{"glob":"**/*.{clj,cljs,cljc,cljd,edn,bb,clj_kondo}","matches":"file"},"scheme":"file"}]}}},"workspaceSymbolProvider":true}}
2024-08-14T17:54:01.170 helix_lsp::transport [INFO] clojure-lsp -> {"jsonrpc":"2.0","method":"initialized","params":{}}
2024-08-14T17:54:01.170 helix_lsp::transport [INFO] clojure-lsp -> {"jsonrpc":"2.0","method":"textDocument/didOpen","params":{"textDocument":{"languageId":"clojure","text":"(ns ps.core\n  (:gen-class)\n  (:require [org.httpkit.client :as hk-client]))\n\n(defn -main\n  \"I don't do a whole lot ... yet.\"\n  [& args]\n  (println \"Hello, World!\"))\n\n(let [resp1 (hk-client/get \"http://http-kit.org/\")\n      resp2 (hk-client/get \"http://clojure.org/\")]\n  (println \"Response 1's status: \" (:status @resp1))\n  (println \"Response 2's status: \" (:status @resp2)))\n\n(defn error-message\n  [severity]\n  (str \"OH GOD! IT'S A DISASTER! WE'RE \"\n       (if (= severity :mild)\n         \"MILDLY INCONVENIENCED!\"\n         \"DOOOOOOOOMED!\")))\n","uri":"file:///home/tarek/workspace/clojure/ps/src/ps/core.clj","version":0}}}
2024-08-14T17:54:01.170 helix_lsp::transport [INFO] clojure-lsp <- {"jsonrpc":"2.0","method":"textDocument/publishDiagnostics","params":{"uri":"file:///home/tarek/workspace/clojure/ps/src/ps/core.clj","diagnostics":[{"range":{"start":{"line":6,"character":5},"end":{"line":6,"character":9}},"tags":[1],"message":"unused binding args","code":"unused-binding","langs":[],"severity":2,"source":"clj-kondo"},{"range":{"start":{"line":9,"character":13},"end":{"line":9,"character":26}},"tags":[],"message":"Unresolved var: hk-client/get","code":"unresolved-var","langs":[],"severity":2,"source":"clj-kondo"},{"range":{"start":{"line":10,"character":13},"end":{"line":10,"character":26}},"tags":[],"message":"Unresolved var: hk-client/get","code":"unresolved-var","langs":[],"severity":2,"source":"clj-kondo"},{"range":{"start":{"line":14,"character":6},"end":{"line":14,"character":19}},"tags":[1],"message":"Unused public var 'ps.core/error-message'","code":"clojure-lsp/unused-public-var","langs":[],"severity":3,"source":"clojure-lsp"}]}}
2024-08-14T17:54:01.170 helix_lsp::transport [INFO] clojure-lsp <- {"jsonrpc":"2.0","method":"textDocument/publishDiagnostics","params":{"uri":"file:///home/tarek/workspace/clojure/ps/test/ps/core_test.clj","diagnostics":[{"range":{"start":{"line":1,"character":33},"end":{"line":1,"character":37}},"tags":[],"message":"use alias or :refer [deftest is testing]","code":"refer-all","langs":[],"severity":2,"source":"clj-kondo","data":{"refers":["deftest","is","testing"]}},{"range":{"start":{"line":2,"character":28},"end":{"line":2,"character":32}},"tags":[],"message":"use alias or :refer","code":"refer-all","langs":[],"severity":2,"source":"clj-kondo","data":{"refers":[]}}]}}
2024-08-14T17:54:01.170 helix_lsp::transport [INFO] clojure-lsp <- {"jsonrpc":"2.0","method":"client/registerCapability","params":{"registrations":[{"id":"id","method":"workspace/didChangeWatchedFiles","registerOptions":{"watchers":[{"globPattern":"**/*.{clj,cljs,cljc,cljd,edn,bb,clj_kondo}"}]}}]},"id":1}
2024-08-14T17:54:01.170 helix_lsp::transport [INFO] clojure-lsp -> {"jsonrpc":"2.0","result":null,"id":1}
2024-08-14T17:54:01.212 helix_lsp::transport [INFO] clojure-lsp <- {"jsonrpc":"2.0","method":"textDocument/publishDiagnostics","params":{"uri":"file:///home/tarek/workspace/clojure/ps/src/ps/core.clj","diagnostics":[{"range":{"start":{"line":6,"character":5},"end":{"line":6,"character":9}},"tags":[1],"message":"unused binding args","code":"unused-binding","langs":[],"severity":2,"source":"clj-kondo"},{"range":{"start":{"line":9,"character":13},"end":{"line":9,"character":26}},"tags":[],"message":"Unresolved var: hk-client/get","code":"unresolved-var","langs":[],"severity":2,"source":"clj-kondo"},{"range":{"start":{"line":10,"character":13},"end":{"line":10,"character":26}},"tags":[],"message":"Unresolved var: hk-client/get","code":"unresolved-var","langs":[],"severity":2,"source":"clj-kondo"},{"range":{"start":{"line":14,"character":6},"end":{"line":14,"character":19}},"tags":[1],"message":"Unused public var 'ps.core/error-message'","code":"clojure-lsp/unused-public-var","langs":[],"severity":3,"source":"clojure-lsp"}]}}
2024-08-14T17:54:03.710 helix_lsp::transport [INFO] clojure-lsp -> {"jsonrpc":"2.0","method":"textDocument/definition","params":{"position":{"character":4,"line":7},"textDocument":{"uri":"file:///home/tarek/workspace/clojure/ps/src/ps/core.clj"}},"id":1}
2024-08-14T17:54:03.713 helix_lsp::transport [INFO] clojure-lsp <- {"jsonrpc":"2.0","id":1,"result":{"uri":"zipfile:///home/tarek/.m2/repository/org/clojure/clojure/1.11.1/clojure-1.11.1.jar::clojure/core.clj","range":{"start":{"line":3733,"character":6},"end":{"line":3733,"character":13}}}}
2024-08-14T17:54:03.713 helix_lsp::transport [INFO] clojure-lsp <- {"range":{"end":{"character":13,"line":3733},"start":{"character":6,"line":3733}},"uri":"zipfile:///home/tarek/.m2/repository/org/clojure/clojure/1.11.1/clojure-1.11.1.jar::clojure/core.clj"}
2024-08-14T17:54:03.713 helix_lsp::transport [INFO] clojure-lsp -> {"jsonrpc":"2.0","method":"textDocument/didOpen","params":{"textDocument":{"languageId":"clojure","text":"\n","uri":"file:///home/tarek/.m2/repository/org/clojure/clojure/1.11.1/clojure-1.11.1.jar::clojure/core.clj","version":0}}}
2024-08-14T17:54:03.713 helix_lsp::util [WARN] LSP position Position { line: 3733, character: 6 } out of range assuming EOF
2024-08-14T17:54:03.713 helix_lsp::util [WARN] LSP position Position { line: 3733, character: 13 } out of range assuming EOF
2024-08-14T17:54:03.746 helix_lsp::transport [INFO] clojure-lsp <- {"jsonrpc":"2.0","method":"textDocument/publishDiagnostics","params":{"uri":"file:///home/tarek/.m2/repository/org/clojure/clojure/1.11.1/clojure-1.11.1.jar::clojure/core.clj","diagnostics":[]}}
2024-08-14T17:54:05.865 helix_lsp::transport [INFO] clojure-lsp -> {"jsonrpc":"2.0","method":"shutdown","id":2}
2024-08-14T17:54:05.866 helix_lsp::transport [INFO] clojure-lsp <- {"jsonrpc":"2.0","id":2,"result":null}
2024-08-14T17:54:05.866 helix_lsp::transport [INFO] clojure-lsp <- null
2024-08-14T17:54:05.866 helix_lsp::transport [INFO] clojure-lsp -> {"jsonrpc":"2.0","method":"exit"}

while in neovim it goes to the function definition correctly

[the-mikedavis]

Yeah the response that we get from the language server is:

2024-08-14T17:44:27.113 helix_lsp::transport [INFO] clojure-lsp <- {"jsonrpc":"2.0","id":1,"result":{"uri":"zipfile:///home/tarek/.m2/repository/http-kit/http-kit/2.8.0/http-kit-2.8.0.jar::org/httpkit/client.clj","range":{"start":{"line":0,"character":4},"end":{"line":0,"character":22}}}}

Note the zipfile:// scheme in the URI. We shouldn't be trying to open a file with a scheme we can't understand (anything other than file:// currently). I have some changes locally that fix that behavior that I'll submit (edit: #11486). We can't open zipfiles or files within zipfiles anyways though so the best we can do in this scenario is error out.

I'm not sure how standard the zipfile:// syntax is there - specifically the path within the zipfile separated by ::. From neovim/nvim-lspconfig#1687 though it seems like multiple language servers might be using that syntax. In order to open those files we would need to support opening (within) zipfiles - I'm not sure if we have an issue for that yet - on top of accepting that style of URI.

[tknawara]

Thanks @the-mikedavis , should I create an issue to add support for opening files within zipfiles/tarfiles? I can link the neovim PR as a reference, the languages I know of that might benefit from this are JVM based, although in neovim PR I also see mentions to TypeScript for Yarn PnP support

[the-mikedavis]

Yep go ahead, I couldn't find an existing issue

[tknawara]

Created #11500