implement cancelation of discovering requests

Author: d-biehl

log.ini

@@ -1,11 +1,12 @@
 [loggers]
-keys: root,server,language_server,language_server_parts,jsonrpc2,jsonrpc2_message,robotframework,debugger, debugger_launcher, asyncio, robotcode_utils
+#keys: root,server,language_server,language_server_parts,jsonrpc2,jsonrpc2_message,robotframework,debugger, debugger_launcher, asyncio, robotcode_utils
 #keys: root,server,language_server,language_server_parts,robotframework,debugger, debugger_launcher, asyncio, robotcode_utils
 #keys: root,server,robotframework,language_server,language_server_parts
 #keys: root, asyncio, robotcode_utils
 #keys: root, robotcode_utils
 #keys: root, diagnostics, document, jsonrpc2, jsonrpc2_message
 #keys: root, diagnostics, robot_diagnostics, robocop_diagnostics
+keys: root, discovering
 #keys: root
 
 [formatters]
@@ -125,4 +126,8 @@ level: TRACE
 handlers: 
 qualname: robotcode.language_server.common.text_document
 
+[logger_discovering]
+level: TRACE
+handlers: 
+qualname: robotcode.language_server.robotframework.parts.discovering
 

robotcode/language_server/common/parts/diagnostics.py

@@ -218,54 +218,44 @@ async def start_publish_diagnostics_task(self, document: TextDocument) -> None:
 
     @_logger.call(entering=True, exiting=True, exception=True)
     async def publish_diagnostics(self, document_uri: DocumentUri, cancelation_token: CancelationToken) -> None:
-        self._logger.debug("start publish_diagnostics")
-        try:
-            document = await self.parent.documents.get(document_uri)
-            if document is None:
-                return
+        document = await self.parent.documents.get(document_uri)
+        if document is None:
+            return
 
-            diagnostics: Dict[Any, List[Diagnostic]] = document.get_data(self, {})
+        diagnostics: Dict[Any, List[Diagnostic]] = document.get_data(self, {})
 
-            collected_keys: List[Any] = []
+        collected_keys: List[Any] = []
 
-            async for result_any in self.collect(
-                self,
-                document,
-                cancelation_token,
-                callback_filter=language_id_filter(document),
-                return_exceptions=True,
-            ):
-                await check_canceled()
-
-                result = cast(DiagnosticsResult, result_any)
-
-                if isinstance(result, BaseException):
-                    if not isinstance(result, asyncio.CancelledError):
-                        self._logger.exception(result, exc_info=result)
-                else:
-
-                    diagnostics[result.key] = result.diagnostics if result.diagnostics else []
-                    collected_keys.append(result.key)
-
-                    asyncio.get_event_loop().call_soon(
-                        self.parent.send_notification,
-                        "textDocument/publishDiagnostics",
-                        PublishDiagnosticsParams(
-                            uri=document.document_uri,
-                            version=document._version,
-                            diagnostics=[e for e in itertools.chain(*diagnostics.values())],
-                        ),
-                    )
-
-            for k in set(diagnostics.keys()) - set(collected_keys):
-                diagnostics.pop(k)
-
-            document.set_data(self, diagnostics)
-        except asyncio.CancelledError:
-            self._logger.debug("canceled publish_diagnostics")
-            raise
-        except BaseException as e:
-            self._logger.exception(e)
-            raise
-        finally:
-            self._logger.debug("end publish_diagnostics")
+        async for result_any in self.collect(
+            self,
+            document,
+            cancelation_token,
+            callback_filter=language_id_filter(document),
+            return_exceptions=True,
+        ):
+            await check_canceled()
+
+            result = cast(DiagnosticsResult, result_any)
+
+            if isinstance(result, BaseException):
+                if not isinstance(result, asyncio.CancelledError):
+                    self._logger.exception(result, exc_info=result)
+            else:
+
+                diagnostics[result.key] = result.diagnostics if result.diagnostics else []
+                collected_keys.append(result.key)
+
+                asyncio.get_event_loop().call_soon(
+                    self.parent.send_notification,
+                    "textDocument/publishDiagnostics",
+                    PublishDiagnosticsParams(
+                        uri=document.document_uri,
+                        version=document._version,
+                        diagnostics=[e for e in itertools.chain(*diagnostics.values())],
+                    ),
+                )
+
+        for k in set(diagnostics.keys()) - set(collected_keys):
+            diagnostics.pop(k)
+
+        document.set_data(self, diagnostics)

robotcode/language_server/robotframework/diagnostics/imports_manager.py

@@ -363,7 +363,10 @@ async def get_libdoc(self) -> LibraryDoc:
 
 
 def _shutdown_process_pool(pool: ProcessPoolExecutor) -> None:
-    pool.shutdown(True)
+    try:
+        pool.shutdown(True)
+    except BaseException:  # NOSONAR
+        pass
 
 
 # we need this, because ProcessPoolExecutor is not correctly initialized if asyncio is reading from stdin

vscode-client/languageclientsmanger.ts

@@ -229,30 +229,53 @@ export class LanguageClientsManager {
 
   public async getTestsFromWorkspace(
     workspaceFolder: vscode.WorkspaceFolder,
-    paths?: Array<string>
+    paths?: Array<string>,
+    token?: vscode.CancellationToken
   ): Promise<RobotTestItem[] | undefined> {
     const client = await this.getLanguageClientForResource(workspaceFolder.uri);
 
     if (!client) return;
 
     return (
-      (await client.sendRequest<RobotTestItem[]>("robot/discovering/getTestsFromWorkspace", {
-        workspaceFolder: workspaceFolder.uri.toString(),
-        paths: paths ?? ["."],
-      })) ?? undefined
+      (token
+        ? await client.sendRequest<RobotTestItem[]>(
+            "robot/discovering/getTestsFromWorkspace",
+            {
+              workspaceFolder: workspaceFolder.uri.toString(),
+              paths: paths ?? ["."],
+            },
+            token
+          )
+        : await client.sendRequest<RobotTestItem[]>("robot/discovering/getTestsFromWorkspace", {
+            workspaceFolder: workspaceFolder.uri.toString(),
+            paths: paths ?? ["."],
+          })) ?? undefined
     );
   }
 
-  public async getTestsFromDocument(document: vscode.TextDocument, id?: string): Promise<RobotTestItem[] | undefined> {
+  public async getTestsFromDocument(
+    document: vscode.TextDocument,
+    id?: string,
+    token?: vscode.CancellationToken
+  ): Promise<RobotTestItem[] | undefined> {
     const client = await this.getLanguageClientForResource(document.uri);
 
     if (!client) return;
 
     return (
-      (await client.sendRequest<RobotTestItem[]>("robot/discovering/getTestsFromDocument", {
-        textDocument: { uri: document.uri.toString() },
-        id: id,
-      })) ?? undefined
+      (token
+        ? await client.sendRequest<RobotTestItem[]>(
+            "robot/discovering/getTestsFromDocument",
+            {
+              textDocument: { uri: document.uri.toString() },
+              id: id,
+            },
+            token
+          )
+        : await client.sendRequest<RobotTestItem[]>("robot/discovering/getTestsFromDocument", {
+            textDocument: { uri: document.uri.toString() },
+            id: id,
+          })) ?? undefined
     );
   }
 }