adds a tick function and adds more information into PendingRequests (#237)

* adds a tick function and adds more information into PendingRequests

* only tick ls when in main module

Author: jmgomez

ls.nim

@@ -88,12 +88,17 @@ type
     onMainReadSignal*: ThreadSignalPtr #used by the main thread to notify it read the value from the signal
     value*: cstring
 
+  PendingRequestState* = enum
+    prsOnGoing = "OnGoing", prsCancelled = "Cancelled", prsComplete = "Complete"
+
   PendingRequest* = object
     id*: uint
     name*: string
     request*: Future[JsonString]
     projectFile*: Option[string]     
-    time*: DateTime
+    startTime*: DateTime
+    endTime*: DateTime
+    state*: PendingRequestState
 
   LanguageServer* = ref object
     clientCapabilities*: ClientCapabilities
@@ -271,6 +276,16 @@ proc showMessage*(ls: LanguageServer, message: string, typ: MessageType) {.raise
   except CatchableError:
     discard
 
+proc toPendingRequestStatus(pr: PendingRequest): PendingRequestStatus = 
+  result.time = case pr.state:
+    of prsOnGoing:
+      $(now() - pr.startTime)
+    else:
+      $(pr.endTime - pr.startTime)
+  result.name = pr.name
+  result.projectFile = pr.projectFile.get("")
+  result.state = $pr.state
+
 proc getLspStatus*(ls: LanguageServer): NimLangServerStatus {.raises: [].} =
   result.version = LSPVersion
   result.extensionCapabilities = ls.extensionCapabilities.toSeq
@@ -295,14 +310,7 @@ proc getLspStatus*(ls: LanguageServer): NimLangServerStatus {.raises: [].} =
     let openFilePath = openFile.uriToPath
     result.openFiles.add openFilePath
 
-  result.pendingRequests = ls.pendingRequests.values.toSeq
-    .mapIt(
-      PendingRequestStatus(
-        name: it.name, 
-        projectFile: it.projectFile.get(""),
-        time: $(now() - it.time)
-        )
-    )
+  result.pendingRequests = ls.pendingRequests.values.toSeq.map(toPendingRequestStatus)
 
 proc sendStatusChanged*(ls: LanguageServer) {.raises: [].}  =
   let status: NimLangServerStatus = ls.getLspStatus()
@@ -794,4 +802,19 @@ proc checkFile*(ls: LanguageServer, uri: string): Future[void] {.async.} =
     ls.sendDiagnostics(diagnostics, path)
   else:
     ls.progress(token, "end")
-  
+  
+proc removeCompletedPendingRequests(ls: LanguageServer, maxTimeAfterRequestWasCompleted = initDuration(seconds = 10)) = 
+  var toRemove = newSeq[uint]()
+  for id, pr in ls.pendingRequests:
+    if pr.state != prsOnGoing:
+      let passedTime = now() - pr.endTime
+      if passedTime > maxTimeAfterRequestWasCompleted:
+        toRemove.add id
+  
+  for id in toRemove:
+    ls.pendingRequests.del id  
+  
+proc tick*(ls: LanguageServer): Future[void] {.async.} = 
+  # debug "Ticking at ", now = now(), prs = ls.pendingRequests.len
+  ls.removeCompletedPendingRequests()
+  ls.sendStatusChanged

lstransports.nim

@@ -70,13 +70,17 @@ proc addRpcToCancellable*(ls: LanguageServer, rpc: Rpc): Rpc =
     try:
       let idRequest = get[uint](params, "idRequest")
       let name = get[string](params, "method")
-      ls.pendingRequests[idRequest] = PendingRequest(id: idRequest, name: name, time: now())
+      ls.pendingRequests[idRequest] = PendingRequest(id: idRequest, name: name, startTime: now(), state: prsOnGoing)
       ls.sendStatusChanged
       var fut = rpc(params)
       ls.pendingRequests[idRequest].request = fut #we need to add it before because the rpc may access to the pendingRequest to set the projectFile
       fut.addCallback proc (d: pointer) = 
-        ls.pendingRequests.del idRequest
-        ls.sendStatusChanged
+        try:
+          ls.pendingRequests[idRequest].state = prsComplete
+          ls.pendingRequests[idRequest].endTime = now()
+          ls.sendStatusChanged
+        except KeyError:
+          error "Error completing pending requests. Id not found in pending requests" 
       return fut
     except KeyError as ex:
       error "IdRequest not found in the request params"

nimlangserver.nim

@@ -100,6 +100,12 @@ proc registerProcMonitor(ls: LanguageServer) =
 
     hookAsyncProcMonitor(ls.cmdLineClientProcessId.get, onCmdLineClientProcessExit)
 
+
+proc tickLs(ls: LanguageServer, time = 1.seconds) {.async.} = 
+  await ls.tick()
+  await sleepAsync(time)
+  await ls.tickLs()
+
 proc main*(cmdLineParams: CommandLineParams): LanguageServer =
   debug "Starting nimlangserver", version = LSPVersion, params = cmdLineParams
   #[
@@ -119,6 +125,8 @@ proc main*(cmdLineParams: CommandLineParams): LanguageServer =
 when isMainModule: 
   try:
     let ls = main(handleParams())
+    asyncSpawn ls.tickLs()
+
     when defined(posix):
       onSignal(SIGINT, SIGTERM, SIGHUP, SIGQUIT, SIGPIPE):
         debug "Terminated via signal", sig

protocol/types.nim

@@ -981,6 +981,7 @@ type
     name*: string
     projectFile*: string
     time*: string 
+    state*: string
 
   NimSuggestStatus* = object
     projectFile*: string

routes.nim

@@ -2,8 +2,8 @@ import macros, strformat, chronos,
   json_rpc/server, os, sugar, sequtils,
   suggestapi, protocol/enums, protocol/types, with, tables, strutils,
   ./utils, chronicles,
-  asyncprocmonitor, std/strscans, json_serialization,
-  std/json, std/parseutils, ls
+  asyncprocmonitor, json_serialization,
+  std/[strscans, times, json, parseutils], ls
 
 #routes
 proc initialize*(p: tuple[ls: LanguageServer, onExit: OnExitCallback], params: InitializeParams):
@@ -322,7 +322,6 @@ proc scheduleFileCheck(ls: LanguageServer, uri: string) {.gcsafe, raises: [].} =
         # except Exception:
         #   discard
 
-
 proc toMarkedStrings(suggest: Suggest): seq[MarkedStringOption] =
   var label = suggest.qualifiedPath.join(".")
   if suggest.forth != "":
@@ -672,11 +671,11 @@ proc cancelRequest*(ls: LanguageServer, params: CancelParams):
     let id = params.id.get.getInt.uint
     if id notin ls.pendingRequests: return
     let pendingRequest = ls.pendingRequests[id]
-    if pendingRequest.request != nil:
+    if ls.pendingRequests[id].request != nil:
       debug "Cancelling: ", id = id    
-      await pendingRequest.request.cancelAndWait() 
-      ls.pendingRequests.del id
-      ls.sendStatusChanged
+      await ls.pendingRequests[id].request.cancelAndWait() 
+      ls.pendingRequests[id].state = prsCancelled
+      ls.pendingRequests[id].endTime = now()
 
 proc setTrace*(ls: LanguageServer, params: SetTraceParams) {.async.} =
   debug "setTrace", value = params.value