From c28a4b52f0011d6cd4f1b8ffd0c5c53766bd13f0 Mon Sep 17 00:00:00 2001
From: Nikolay Nikolov <nickysn@gmail.com>
Date: Mon, 20 Nov 2023 01:47:15 +0200
Subject: [PATCH] Nimsuggest version detection (#60)

* Added nimsuggest version detection via the new --info:protocolVer command line option

* Check protocol version and only issue the inlayHints command to nimsuggest if it uses protocol version 4 or later.
---
 nimlangserver.nim |  3 +++
 suggestapi.nim    | 25 ++++++++++++++++++++++++-
 2 files changed, 27 insertions(+), 1 deletion(-)

diff --git a/nimlangserver.nim b/nimlangserver.nim
index f1f6e8f..945e154 100644
--- a/nimlangserver.nim
+++ b/nimlangserver.nim
@@ -791,6 +791,9 @@ proc inlayHint(ls: LanguageServer, params: InlayHintParams, id: int): Future[seq
   with (params.range, params.textDocument):
     let
       nimsuggest = await ls.getNimsuggest(uri)
+    if nimsuggest.protocolVersion < 4:
+      return @[]
+    let
       suggestions = await nimsuggest
         .inlayHints(uriToPath(uri),
                     ls.uriToStash(uri),
diff --git a/suggestapi.nim b/suggestapi.nim
index 1edd3ff..398d5ca 100644
--- a/suggestapi.nim
+++ b/suggestapi.nim
@@ -19,6 +19,7 @@ import osproc,
   chronicles
 
 const REQUEST_TIMEOUT* = 120000
+const HighestSupportedNimSuggestProtocolVersion = 4
 
 # coppied from Nim repo
 type
@@ -87,6 +88,7 @@ type
     processing: bool
     timeout: int
     timeoutCallback: NimsuggestCallback
+    protocolVersion*: int
 
 template benchmark(benchmarkName: string, code: untyped) =
   block:
@@ -255,6 +257,24 @@ proc doWithTimeout*[T](fut: Future[T], timeout: int, s: string): owned(Future[bo
 
   return retFuture
 
+proc detectNimsuggestVersion(root: string,
+                             nimsuggestPath: string,
+                             workingDir: string): int {.gcsafe.} =
+  var process = startProcess(command = nimsuggestPath,
+                             workingDir = workingDir,
+                             args = @[root, "--info:protocolVer"],
+                             options = {poUsePath})
+  var l: string
+  if not process.outputStream.readLine(l):
+    l = ""
+  var exitCode = process.waitForExit()
+  if exitCode != 0 or l == "":
+    # older versions of NimSuggest don't support the --info:protocolVer option
+    # use protocol version 3 with them
+    return 3
+  else:
+    return parseInt(l)
+
 proc createNimsuggest*(root: string,
                        nimsuggestPath: string,
                        timeout: int,
@@ -279,9 +299,12 @@ proc createNimsuggest*(root: string,
   result.errorCallback = errorCallback
 
   if fullPath != "":
+    result.protocolVersion = detectNimsuggestVersion(root, nimsuggestPath, workingDir)
+    if result.protocolVersion > HighestSupportedNimSuggestProtocolVersion:
+      result.protocolVersion = HighestSupportedNimSuggestProtocolVersion
     result.process = startProcess(command = nimsuggestPath,
                                   workingDir = workingDir,
-                                  args = @[root, "--v3", "--autobind"],
+                                  args = @[root, "--v" & $result.protocolVersion, "--autobind"],
                                   options = {poUsePath})
 
     # all this is needed to avoid the need to block on the main thread.