Use nim track for goto definition and find usages

.github/workflows/ci.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Setup Nimble
         uses: nim-lang/setup-nimble-action@v1
         with:
-          nimble-version: "0.20.1"
+          nimble-version: "latest"
           repo-token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Restore nimble dependencies from cache
@@ -35,6 +35,10 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-${{ env.cache_nonce }}-
 
+      - name: Install Nimble fork with the nim#head fix
+        shell: bash
+        run: nimble install https://github.com/moigagoo/nimble@#bugfix/nimble_dump_with_nim_head
+
       - name: Install dependencies
         shell: bash
         run: nimble -y install -l

ls.nim

@@ -96,6 +96,7 @@ type
     nimExpandMacro*: Option[bool]
     maxNimsuggestProcesses*: Option[int]
       #max number of nimsuggest processes to keep alive. zero means unlimited
+    useNimTrack*: Option[bool]
 
   NlsFileInfo* = ref object of RootObj
     projectFile*: Future[string]
@@ -279,7 +280,8 @@ proc getNimbleDumpInfo*(
   try:
     process = await startProcess(
       "nimble",
-      arguments = @["dump", nimbleFile],
+      workingDir = nimbleFile.parentDir(),
+      arguments = @["dump"],
       options = {UsePath},
       stderrHandle = AsyncProcess.Pipe,
       stdoutHandle = AsyncProcess.Pipe,
@@ -508,10 +510,15 @@ proc getNimVersion(nimDir: string): string =
 proc getNimSuggestPathAndVersion(
     ls: LanguageServer, conf: NlsConfig, workingDir: string
 ): Future[(string, string)] {.async.} =
-  #Attempting to see if the project is using a custom Nim version, if it's the case this will be slower than usual
-  let nimbleDumpInfo = await ls.getNimbleDumpInfo("")
-  let nimDir = nimbleDumpInfo.nimDir.get ""
+  let nimbleFiles = walkFiles(workingDir / "*.nimble").toSeq
+
+  let nimbleDumpInfo =
+    if nimbleFiles.len > 0:
+      await ls.getNimbleDumpInfo(nimbleFiles[0])
+    else:
+      await ls.getNimbleDumpInfo("")
 
+  let nimDir = nimbleDumpInfo.nimDir.get ""
   var nimsuggestPath = expandTilde(conf.nimsuggestPath.get(""))
   var nimVersion = ""
   if nimsuggestPath == "":
@@ -527,11 +534,19 @@ proc getNimSuggestPathAndVersion(
   debug "Using {nimVersion}", nimVersion = nimVersion
   (nimsuggestPath, nimVersion)
 
-proc getNimPath*(conf: NlsConfig): Option[string] =
+proc getNimPath*(
+    ls: LanguageServer, conf: NlsConfig, workingDir = ""
+): Future[Option[string]] {.async.} =
   if conf.nimSuggestPath.isSome and conf.nimsuggestPath.get().fileExists():
     some(conf.nimSuggestPath.get.parentDir / "nim")
   else:
-    let path = findExe "nim"
+    let (nimsuggestPath, _) = await ls.getNimSuggestPathAndVersion(conf, workingDir)
+    let path =
+      if nimsuggestPath.fileExists():
+        nimsuggestPath.parentDir / "nim"
+      else:
+        findExe "nim"
+
     if path != "":
       some(path)
     else:
@@ -597,7 +612,7 @@ proc getRootPath*(ip: LspInitializeParams): string =
 proc getRootPath*(ip: McpInitializeParams): string =
   getCurrentDir().pathToUri.uriToPath
 
-proc getWorkingDir(ls: LanguageServer, path: string): Future[string] {.async.} =
+proc getWorkingDir*(ls: LanguageServer, path: string): Future[string] {.async.} =
   let rootPath =
     case ls.serverMode
     of lsp: ls.lspInitializeParams.getRootPath
@@ -607,7 +622,7 @@ proc getWorkingDir(ls: LanguageServer, path: string): Future[string] {.async.} =
     pathRelativeToRoot = path.tryRelativeTo(rootPath)
     mapping = ls.getWorkspaceConfiguration.await().workingDirectoryMapping.get(@[])
 
-  result = getCurrentDir()
+  result = rootPath
 
   for m in mapping:
     if pathRelativeToRoot.isSome and m.projectFile == pathRelativeToRoot.get():
@@ -945,7 +960,7 @@ proc checkProject*(ls: LanguageServer, uri: string): Future[void] {.async.} =
   let conf = await ls.getAndWaitForWorkspaceConfiguration()
   let useNimCheck = conf.useNimCheck.get(USE_NIM_CHECK_BY_DEFAULT)
 
-  let nimPath = getNimPath(conf)
+  let nimPath = await ls.getNimPath(conf)
 
   if useNimCheck and nimPath.isSome:
     proc getFilePath(c: CheckResult): string =
@@ -1097,7 +1112,7 @@ proc createOrRestartNimsuggest*(
       project.stop()
     ls.projectFiles[projectFile] = projectNext
 
-    projectNext.ns.addCallback do(fut: Future[Nimsuggest]):
+    projectNext.ns.addCallback do(fut: Future[Nimsuggest]) {.gcsafe.}:
       if fut.failed:
         let msg = fut.error.msg
         error "Nimsuggest initialization failed", projectFile = projectFile, error = msg
@@ -1140,7 +1155,7 @@ proc maybeRegisterCapabilityDidChangeConfiguration*(ls: LanguageServer) =
       gcsafe
     .}:
       debug "Got response for the didChangeConfiguration registration:",
-        res = res.read()
+        res = $res.read()
 
 proc handleConfigurationChanges*(
     ls: LanguageServer, oldConfiguration, newConfiguration: NlsConfig
@@ -1164,10 +1179,12 @@ proc maybeRequestConfigurationFromClient*(ls: LanguageServer) =
     ls.prevWorkspaceConfiguration = ls.workspaceConfiguration
 
     ls.workspaceConfiguration = ls.call("workspace/configuration", %configurationParams)
-    ls.workspaceConfiguration.addCallback do(futConfiguration: Future[JsonNode]):
+    ls.workspaceConfiguration.addCallback do(futConfiguration: Future[JsonNode]) {.
+      gcsafe
+    .}:
       if futConfiguration.error.isNil:
         debug "Received the following configuration",
-          configuration = futConfiguration.read()
+          configuration = $futConfiguration.read()
         if not isNil(ls.prevWorkspaceConfiguration) and
             ls.prevWorkspaceConfiguration.finished:
           let
@@ -1258,7 +1275,7 @@ proc getProjectFile*(fileUri: string, ls: LanguageServer): Future[string] {.asyn
 proc checkFile*(ls: LanguageServer, uri: string): Future[void] {.async.} =
   let conf = await ls.getAndWaitForWorkspaceConfiguration()
   let useNimCheck = conf.useNimCheck.get(USE_NIM_CHECK_BY_DEFAULT)
-  let nimPath = conf.getNimPath()
+  let nimPath = await ls.getNimPath(conf)
   let token = fmt "Checking file {uri}"
   ls.workDoneProgressCreate(token)
   ls.progress(token, "begin", fmt "Checking {uri.uriToPath}")

lstransports.nim

@@ -212,7 +212,7 @@ proc runRpc(ls: LanguageServer, req: RequestRx, rpc: RpcProc): Future[void] {.as
     json["result"] = parseJson(res.string)
     ls.writeOutput(json)
   except CancelledError as ex:
-    debug "[RunRPC]Request cancelled", meth = req.meth
+    debug "[RunRPC]Request cancelled", meth = req.method.get("")
   except CatchableError as ex:
     error "[RunRPC] ", msg = ex.msg, req = req.`method`
     writeStackTrace(ex = ex)
@@ -223,9 +223,16 @@ proc processMessage(ls: LanguageServer, message: string) {.raises: [].} =
       #OPT oportunity reuse the same JSON already parsed
     let isReq = "method" in contentJson
     if isReq:
-      debug "[Processing Message]", request = contentJson["method"]
+      debug "[Processing Message]", request = contentJson["method"].getStr()
       var fut = Future[JsonString]()
-      var req = JrpcSys.decode(message, RequestRx)
+      # LSP allows null or absent params; json_rpc 0.6+ decoder requires array/object
+      if contentJson.getOrDefault("params").kind == JNull:
+        contentJson["params"] = newJObject()
+      # Notifications have no id; RequestRx.id is non-optional so inject null
+      # to avoid raiseIncompleteObject during decode.
+      if "id" notin contentJson:
+        contentJson["id"] = newJNull()
+      var req = JrpcSys.decode($contentJson, RequestRx)
       if req.params.kind == rpNamed and req.id.kind == riNumber:
         #Some requests have no id but for others we need to pass the id to the wrapRpc as the id information is lost in the rpc proc
         req.params.named.add ParamDescNamed(
@@ -234,9 +241,9 @@ proc processMessage(ls: LanguageServer, message: string) {.raises: [].} =
         req.params.named.add ParamDescNamed(
           name: "method", value: JsonString($(contentJson["method"]))
         )
-      let rpc = ls.srv.router.procs.getOrDefault(req.meth.get)
+      let rpc = ls.srv.router.procs.getOrDefault(req.method.get(""))
       if rpc.isNil:
-        error "[Processing Message] rpc method not found: ", msg = req.meth.get
+        error "[Processing Message] rpc method not found: ", msg = req.method.get("")
         return
       asyncSpawn ls.runRpc(req, rpc)
     else: #Response

nim.cfg

@@ -2,7 +2,7 @@
 --define:"async_backend=asyncdispatch"
 --define:"chronicles_default_output_device=stderr"
 --define:"chronicles_colors=None"
---define:"chronicles_disable_thread_id"
+--define:"chronicles_thread_ids=no"
 --define:"debugLogging"
 #--define:"chronicles_log_level=TRACE"
 --define:"chronicles_log_level=DEBUG"