fix(langserver): speedup diagnostics, unused references and codelenses updates

Author: d-biehl

packages/language_server/src/robotcode/language_server/common/parts/diagnostics.py

@@ -1,3 +1,4 @@
+import functools
 import itertools
 import time
 import uuid
@@ -75,6 +76,7 @@ class DiagnosticsData:
     version: Optional[int] = None
     future: Optional[Task[Any]] = None
     force: bool = False
+    single: bool = False
 
 
 class DiagnosticsProtocolPart(LanguageServerProtocolPart):
@@ -174,6 +176,10 @@ def on_workspace_diagnostics_collect(sender: Any) -> None:
     def on_workspace_diagnostics_end(sender: Any) -> None:
         ...
 
+    @event
+    def on_workspace_diagnostics_break(sender: Any) -> None:
+        ...
+
     def ensure_workspace_loaded(self) -> None:
         with self._workspace_load_lock:
             if not self._workspace_loaded and not self.workspace_loaded_event.is_set():
@@ -246,9 +252,12 @@ def run_workspace_diagnostics(self) -> None:
                         doc
                         for doc in self.parent.documents.documents
                         if (
-                            (data := self.get_diagnostics_data(doc)).force
-                            or doc.version != data.version
-                            or data.future is None
+                            (
+                                (data := self.get_diagnostics_data(doc)).force
+                                or doc.version != data.version
+                                or data.future is None
+                            )
+                            and not data.single
                         )
                     ],
                     key=lambda d: not d.opened_in_editor,
@@ -276,6 +285,7 @@ def run_workspace_diagnostics(self) -> None:
                         check_current_task_canceled()
 
                         if self._break_diagnostics_loop_event.is_set():
+                            self.on_workspace_diagnostics_break(self)
                             break
 
                         done_something = True
@@ -333,6 +343,7 @@ def run_workspace_diagnostics(self) -> None:
                         check_current_task_canceled()
 
                         if self._break_diagnostics_loop_event.is_set():
+                            self.on_workspace_diagnostics_break(self)
                             break
 
                         mode = self.get_diagnostics_mode(document.uri)
@@ -393,23 +404,28 @@ def run_workspace_diagnostics(self) -> None:
             finally:
                 self.on_workspace_diagnostics_end(self)
 
+    def _diagnostics_task_done(self, document: TextDocument, data: DiagnosticsData, t: Task[Any]) -> None:
+        self._logger.debug(lambda: f"diagnostics for {document} task {'canceled' if t.cancelled() else 'ended'}")
+
+        data.force = data.single
+        data.single = False
+        if data.force:
+            self.break_workspace_diagnostics_loop()
+
     def create_document_diagnostics_task(
         self,
         document: TextDocument,
         single: bool,
         debounce: bool = True,
         send_diagnostics: bool = True,
     ) -> Task[Any]:
-        def done(t: Task[Any]) -> None:
-            self._logger.debug(lambda: f"diagnostics for {document} {'canceled' if t.cancelled() else 'ended'}")
-
         data = self.get_diagnostics_data(document)
 
         if data.force or document.version != data.version or data.future is None:
             future = data.future
 
             data.force = False
-
+            data.single = single
             if future is not None and not future.done():
                 self._logger.debug(lambda: f"try to cancel diagnostics for {document}")
 
@@ -424,7 +440,7 @@ def done(t: Task[Any]) -> None:
                 send_diagnostics,
             )
 
-            data.future.add_done_callback(done)
+            data.future.add_done_callback(functools.partial(self._diagnostics_task_done, document, data))
 
         return data.future
 

packages/language_server/src/robotcode/language_server/robotframework/diagnostics/imports_manager.py

@@ -20,6 +20,7 @@
     List,
     Mapping,
     Optional,
+    Set,
     Tuple,
     final,
 )
@@ -564,6 +565,11 @@ def __init__(
         self._executor_lock = threading.RLock()
         self._executor: Optional[ProcessPoolExecutor] = None
 
+        self._resource_document_changed_timer_lock = threading.RLock()
+        self._resource_document_changed_timer: Optional[threading.Timer] = None
+        self._resource_document_changed_timer_interval = 1
+        self._resource_document_changed_documents: Set[TextDocument] = set()
+
     def __del__(self) -> None:
         try:
             if self._executor is not None:
@@ -684,9 +690,32 @@ def _do_imports_changed(self, sender: Any, uri: DocumentUri) -> None:
 
     @language_id("robotframework")
     def resource_document_changed(self, sender: Any, document: TextDocument) -> None:
-        run_as_task(self._resource_document_changed, document)
+        with self._resource_document_changed_timer_lock:
+            if document in self._resource_document_changed_documents:
+                return
+
+            if self._resource_document_changed_timer is not None:
+                self._resource_document_changed_timer.cancel()
+                self._resource_document_changed_timer = None
+
+            self._resource_document_changed_documents.add(document)
+
+            self._resource_document_changed_timer = threading.Timer(
+                self._resource_document_changed_timer_interval, self.__resource_documents_changed
+            )
+            self._resource_document_changed_timer.start()
+
+    def __resource_documents_changed(self) -> None:
+        with self._resource_document_changed_timer_lock:
+            self._resource_document_changed_timer = None
+
+            documents = self._resource_document_changed_documents
+            self._resource_document_changed_documents = set()
+
+        for document in documents:
+            run_as_task(self.__resource_document_changed, document).result()
 
-    def _resource_document_changed(self, document: TextDocument) -> None:
+    def __resource_document_changed(self, document: TextDocument) -> None:
         resource_changed: List[LibraryDoc] = []
 
         with self._resources_lock:

packages/language_server/src/robotcode/language_server/robotframework/parts/references.py

@@ -41,6 +41,7 @@
 from ...common.decorators import language_id
 from ...common.text_document import TextDocument
 from ..diagnostics.model_helper import ModelHelper
+from ..diagnostics.namespace import Namespace
 from .protocol_part import RobotLanguageServerProtocolPart
 
 if TYPE_CHECKING:
@@ -65,6 +66,8 @@ def __init__(self, parent: "RobotLanguageServerProtocol") -> None:
 
         parent.references.collect.add(self.collect)
         parent.documents.did_change.add(self.document_did_change)
+        parent.documents_cache.namespace_invalidated(self.namespace_invalidated)
+        parent.diagnostics.on_workspace_diagnostics_break.add(self.on_workspace_diagnostics_break)
 
     @event
     def cache_cleared(sender) -> None:
@@ -84,6 +87,12 @@ def do_on_file_changed(self, sender: Any, files: List[FileEvent]) -> None:
     def document_did_change(self, sender: Any, document: TextDocument) -> None:
         self.clear_cache()
 
+    def namespace_invalidated(self, sender: Any, namespace: Namespace) -> None:
+        self.clear_cache()
+
+    def on_workspace_diagnostics_break(self, sender: Any) -> None:
+        self.clear_cache()
+
     def clear_cache(self) -> None:
         self._keyword_reference_cache.clear()
         self._variable_reference_cache.clear()

tests/robotcode/language_server/robotframework/parts/data/.vscode/settings.json

@@ -18,7 +18,7 @@
         // "--log",
         // "--log-level", "TRACE",
     ],
-    "robotcode.robocop.enabled": false,
+    "robotcode.robocop.enabled": true,
     // "robotcode.debug.groupOutput": false,
     // "robotcode.robot.args": [
     //     "-L", "TRACE"
@@ -28,9 +28,9 @@
     //"python.analysis.diagnosticMode": "workspace"
     //"robotcode.robot.paths": ["./tests", "./tests1"]
     "robotcode.analysis.referencesCodeLens": true,
-    "robotcode.analysis.diagnosticMode": "workspace",
-    "robotcode.analysis.progressMode": "simple",
-    "robotcode.analysis.findUnusedReferences": true,
+    "robotcode.analysis.diagnosticMode": "openFilesOnly",
+    "robotcode.analysis.progressMode": "off",
+    "robotcode.analysis.findUnusedReferences": false,
     "robotcode.analysis.cache.saveLocation": "workspaceFolder",
     "robotcode.analysis.cache.ignoredLibraries": [
         //"robot.libraries.Remote",