implement cancel progress received from client

Author: d-biehl

robotcode/language_server/common/parts/window.py

@@ -1,5 +1,7 @@
 import uuid
-from typing import List, Optional
+from typing import Any, Dict, List, Optional
+
+from robotcode.jsonrpc2.protocol import rpc_method
 
 from ..lsp_types import (
     URI,
@@ -54,6 +56,8 @@ async def show_document(
             )
         ).success
 
+    __progress_tokens: Dict[ProgressToken, bool] = {}
+
     async def create_progress(self) -> Optional[ProgressToken]:
 
         if (
@@ -63,10 +67,28 @@ async def create_progress(self) -> Optional[ProgressToken]:
         ):
             token = str(uuid.uuid4())
             await self.parent.send_request_async("window/workDoneProgress/create", WorkDoneProgressCreateParams(token))
+            self.__progress_tokens[token] = False
             return token
 
         return None
 
+    @rpc_method(name="window/workDoneProgress/cancel", param_type=WorkDoneProgressCancelParams)
+    async def _window_work_done_progress_cancel(
+        self,
+        token: ProgressToken,
+        *args: Any,
+        **kwargs: Any,
+    ) -> None:
+
+        if token in self.__progress_tokens:
+            self.__progress_tokens[token] = True
+
+    def progress_is_canceled(self, token: Optional[ProgressToken]) -> bool:
+        if token is None:
+            return False
+
+        return token in self.__progress_tokens and self.__progress_tokens.get(token, False)
+
     def progress_cancel(self, token: Optional[ProgressToken]) -> None:
         if (
             token is not None
@@ -104,7 +126,10 @@ def progress_begin(
             self._progress(
                 token,
                 WorkDoneProgressBegin(
-                    title or self.parent.name or self._default_title, message, percentage, cancellable
+                    title or self.parent.short_name or self.parent.name or self._default_title,
+                    message,
+                    percentage,
+                    cancellable,
                 ),
             )
 
@@ -125,7 +150,10 @@ def progress_report(
             self._progress(
                 token,
                 WorkDoneProgressReport(
-                    title or self.parent.name or self._default_title, message, percentage, cancellable
+                    title or self.parent.short_name or self.parent.name or self._default_title,
+                    message,
+                    percentage,
+                    cancellable,
                 ),
             )
 
@@ -140,4 +168,8 @@ def progress_end(
             and self.parent.client_capabilities.window
             and self.parent.client_capabilities.window.work_done_progress
         ):
-            self._progress(token, WorkDoneProgressEnd(message))
+            try:
+                self._progress(token, WorkDoneProgressEnd(message))
+            finally:
+                if token in self.__progress_tokens:
+                    self.__progress_tokens.pop(token)

robotcode/language_server/common/protocol.py

@@ -90,6 +90,7 @@ class LanguageServerProtocol(JsonRPCProtocol):
     rename = ProtocolPartDescriptor(RenameProtocolPart)
 
     name: Optional[str] = None
+    short_name: Optional[str] = None
     version: Optional[str] = None
 
     file_extensions: Set[str] = set()

robotcode/language_server/robotframework/parts/robot_workspace.py

@@ -56,7 +56,7 @@ async def _on_change_configuration(self, sender: Any, settings: Dict[str, Any])
         async def run() -> None:
             token = await self.parent.window.create_progress()
 
-            self.parent.window.progress_begin(token, "Analyze files")
+            self.parent.window.progress_begin(token, "Analyze...", cancellable=True)
             try:
                 for folder in self.parent.workspace.workspace_folders:
                     config = (
@@ -69,8 +69,12 @@ async def run() -> None:
                         ignore_patterns=config.exclude_patterns or [],  # type: ignore
                         absolute=True,
                     ):
+                        if self.parent.window.progress_is_canceled(token):
+                            break
 
-                        self.parent.window.progress_report(token, "analyze " + str(f.relative_to(folder.uri.to_path())))
+                        self.parent.window.progress_report(
+                            token, "analyze " + str(f.relative_to(folder.uri.to_path())), cancellable=True
+                        )
                         try:
                             document = await self.get_or_open_document(f, "robotframework")
 
@@ -89,3 +93,4 @@ async def run() -> None:
                 self.parent.window.progress_end(token)
 
         await run()
+        # await run()

robotcode/language_server/robotframework/protocol.py

@@ -95,6 +95,7 @@ class RobotLanguageServerProtocol(LanguageServerProtocol):
     robot_debugging_utils = ProtocolPartDescriptor(RobotDebuggingUtilsProtocolPart)
 
     name = "RobotCode Language Server"
+    short_name = "RobotCode"
     version = __version__
 
     file_extensions = {"robot", "resource", "py"}