refactor(langserver): remove async code from document_highlight and document_symbols, add regression tests for document_symbols

Author: d-biehl

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

@@ -1,9 +1,7 @@
-from __future__ import annotations
-
-from asyncio import CancelledError
+from concurrent.futures import CancelledError
 from typing import TYPE_CHECKING, Any, Final, List, Optional
 
-from robotcode.core.async_tools import async_tasking_event
+from robotcode.core.event import event
 from robotcode.core.lsp.types import (
     DocumentHighlight,
     DocumentHighlightOptions,
@@ -26,22 +24,20 @@
 class DocumentHighlightProtocolPart(LanguageServerProtocolPart):
     _logger: Final = LoggingDescriptor()
 
-    def __init__(self, parent: LanguageServerProtocol) -> None:
+    def __init__(self, parent: "LanguageServerProtocol") -> None:
         super().__init__(parent)
 
     def extend_capabilities(self, capabilities: ServerCapabilities) -> None:
         if len(self.collect):
             capabilities.document_highlight_provider = DocumentHighlightOptions(work_done_progress=True)
 
-    @async_tasking_event
-    async def collect(
-        sender, document: TextDocument, position: Position  # NOSONAR
-    ) -> Optional[List[DocumentHighlight]]:
+    @event
+    def collect(sender, document: TextDocument, position: Position) -> Optional[List[DocumentHighlight]]:  # NOSONAR
         ...
 
     @rpc_method(name="textDocument/documentHighlight", param_type=DocumentHighlightParams)
     @threaded
-    async def _text_document_document_highlight(
+    def _text_document_document_highlight(
         self,
         text_document: TextDocumentIdentifier,
         position: Position,
@@ -54,7 +50,7 @@ async def _text_document_document_highlight(
         if document is None:
             return None
 
-        for result in await self.collect(
+        for result in self.collect(
             self, document, document.position_from_utf16(position), callback_filter=language_id_filter(document)
         ):
             if isinstance(result, BaseException):

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

@@ -1,11 +1,10 @@
-from __future__ import annotations
-
-from asyncio import CancelledError
+from concurrent.futures import CancelledError
 from typing import (
     TYPE_CHECKING,
     Any,
     Callable,
     Final,
+    Iterable,
     List,
     Optional,
     Protocol,
@@ -15,7 +14,7 @@
     runtime_checkable,
 )
 
-from robotcode.core.async_tools import async_tasking_event
+from robotcode.core.event import event
 from robotcode.core.lsp.types import (
     DocumentSymbol,
     DocumentSymbolClientCapabilitiesSymbolKindType,
@@ -56,14 +55,14 @@ def decorator(func: _F) -> _F:
 class DocumentSymbolsProtocolPart(LanguageServerProtocolPart):
     _logger: Final = LoggingDescriptor()
 
-    def __init__(self, parent: LanguageServerProtocol) -> None:
+    def __init__(self, parent: "LanguageServerProtocol") -> None:
         super().__init__(parent)
         self.hierarchical_document_symbol_support = False
         self.symbol_kind: Optional[DocumentSymbolClientCapabilitiesSymbolKindType] = None
         self.tag_support: Optional[DocumentSymbolClientCapabilitiesTagSupportType] = None
 
-    @async_tasking_event
-    async def collect(
+    @event
+    def collect(
         sender, document: TextDocument  # NOSONAR
     ) -> Optional[Union[List[DocumentSymbol], List[SymbolInformation], None]]:
         ...
@@ -97,7 +96,7 @@ def extend_capabilities(self, capabilities: ServerCapabilities) -> None:
 
     @rpc_method(name="textDocument/documentSymbol", param_type=DocumentSymbolParams)
     @threaded
-    async def _text_document_symbol(
+    def _text_document_symbol(
         self, text_document: TextDocumentIdentifier, *args: Any, **kwargs: Any
     ) -> Optional[Union[List[DocumentSymbol], List[SymbolInformation], None]]:
         document_symbols: List[DocumentSymbol] = []
@@ -107,16 +106,16 @@ async def _text_document_symbol(
         if document is None:
             return None
 
-        for result in await self.collect(self, document, callback_filter=language_id_filter(document)):
+        for result in self.collect(self, document, callback_filter=language_id_filter(document)):
             if isinstance(result, BaseException):
                 if not isinstance(result, CancelledError):
                     self._logger.exception(result, exc_info=result)
             else:
                 if result is not None:
                     if all(isinstance(e, DocumentSymbol) for e in result):
-                        document_symbols.extend(result)
+                        document_symbols.extend(cast(Iterable[DocumentSymbol], result))
                     elif all(isinstance(e, SymbolInformation) for e in result):
-                        symbol_informations.extend(result)
+                        symbol_informations.extend(cast(Iterable[SymbolInformation], result))
                     else:
                         self._logger.warning(
                             "Result contains DocumentSymbol and SymbolInformation results, result is skipped."

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

@@ -1,9 +1,8 @@
-from __future__ import annotations
-
 from typing import TYPE_CHECKING, Any, List, Optional, cast
 
 from robotcode.core.lsp.types import DocumentHighlight, DocumentHighlightKind, Position, Range
 from robotcode.core.utils.logging import LoggingDescriptor
+from robotcode.core.utils.threading import check_thread_canceled
 from robotcode.language_server.common.decorators import language_id
 from robotcode.language_server.common.text_document import TextDocument
 
@@ -16,14 +15,14 @@
 class RobotDocumentHighlightProtocolPart(RobotLanguageServerProtocolPart):
     _logger = LoggingDescriptor()
 
-    def __init__(self, parent: RobotLanguageServerProtocol) -> None:
+    def __init__(self, parent: "RobotLanguageServerProtocol") -> None:
         super().__init__(parent)
 
         parent.document_highlight.collect.add(self.collect)
 
     @language_id("robotframework")
     @_logger.call
-    async def collect(
+    def collect(
         self,
         sender: Any,
         document: TextDocument,
@@ -34,6 +33,8 @@ async def collect(
         all_variable_refs = namespace.get_variable_references()
         if all_variable_refs:
             for var, var_refs in all_variable_refs.items():
+                check_thread_canceled()
+
                 for r in var_refs:
                     if (var.source == namespace.source and position in var.name_range) or position in r.range:
                         return [
@@ -48,6 +49,8 @@ async def collect(
         all_kw_refs = namespace.get_keyword_references()
         if all_kw_refs:
             for kw, kw_refs in all_kw_refs.items():
+                check_thread_canceled()
+
                 for r in kw_refs:
                     if (kw.source == namespace.source and position in kw.range) or position in r.range:
                         return [
@@ -62,6 +65,7 @@ async def collect(
         all_namespace_refs = namespace.get_namespace_references()
         if all_namespace_refs:
             for ns, ns_refs in all_namespace_refs.items():
+                check_thread_canceled()
                 found_range = (
                     ns.import_range
                     if ns.import_source == namespace.source

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

@@ -1,5 +1,3 @@
-from __future__ import annotations
-
 import ast
 import itertools
 from typing import TYPE_CHECKING, Any, List, Optional, Union, cast
@@ -18,6 +16,22 @@
     from ..protocol import RobotLanguageServerProtocol
 
 
+class RobotDocumentSymbolsProtocolPart(RobotLanguageServerProtocolPart):
+    _logger = LoggingDescriptor()
+
+    def __init__(self, parent: "RobotLanguageServerProtocol") -> None:
+        super().__init__(parent)
+
+        parent.document_symbols.collect.add(self.collect)
+
+    @language_id("robotframework")
+    @_logger.call
+    def collect(
+        self, sender: Any, document: TextDocument
+    ) -> Optional[Union[List[DocumentSymbol], List[SymbolInformation], None]]:
+        return _Visitor.find_from(self.parent.documents_cache.get_model(document), self)
+
+
 class _Visitor(Visitor):
     def __init__(self, parent: RobotDocumentSymbolsProtocolPart) -> None:
         super().__init__()
@@ -179,6 +193,42 @@ def visit_ForHeader(self, node: ast.AST) -> None:  # noqa: N802
                     if symbol.name not in map(lambda v: v.name, self.current_symbol.children):
                         self.current_symbol.children.append(symbol)
 
+    def visit_ExceptHeader(self, node: ast.AST) -> None:  # noqa: N802
+        from robot.parsing.lexer.tokens import Token as RobotToken
+        from robot.parsing.model.statements import ExceptHeader
+
+        n = cast(ExceptHeader, node)
+        variables = n.get_tokens(RobotToken.VARIABLE)
+
+        if self.current_symbol is not None and self.current_symbol.children is not None:
+            for variable in variables:
+                variable_token = self.get_variable_token(variable)
+                if variable_token is not None:
+                    r = range_from_token(variable_token)
+                    symbol = DocumentSymbol(
+                        name=variable_token.value, kind=SymbolKind.VARIABLE, range=r, selection_range=r
+                    )
+                    if symbol.name not in map(lambda v: v.name, self.current_symbol.children):
+                        self.current_symbol.children.append(symbol)
+
+    def visit_Var(self, node: ast.AST) -> None:  # noqa: N802
+        from robot.parsing.lexer.tokens import Token as RobotToken
+        from robot.parsing.model.statements import Var
+
+        n = cast(Var, node)
+        variables = n.get_tokens(RobotToken.VARIABLE)
+
+        if self.current_symbol is not None and self.current_symbol.children is not None:
+            for variable in variables:
+                variable_token = self.get_variable_token(variable)
+                if variable_token is not None:
+                    r = range_from_token(variable_token)
+                    symbol = DocumentSymbol(
+                        name=variable_token.value, kind=SymbolKind.VARIABLE, range=r, selection_range=r
+                    )
+                    if symbol.name not in map(lambda v: v.name, self.current_symbol.children):
+                        self.current_symbol.children.append(symbol)
+
     def visit_KeywordName(self, node: ast.AST) -> None:  # noqa: N802
         from robot.parsing.lexer.tokens import Token as RobotToken
         from robot.parsing.model.statements import KeywordName
@@ -226,19 +276,3 @@ def visit_Variable(self, node: ast.AST) -> None:  # noqa: N802
             r = range_from_node(variable)
             symbol = DocumentSymbol(name=name, kind=SymbolKind.VARIABLE, range=r, selection_range=r)
             self.current_symbol.children.append(symbol)
-
-
-class RobotDocumentSymbolsProtocolPart(RobotLanguageServerProtocolPart):
-    _logger = LoggingDescriptor()
-
-    def __init__(self, parent: RobotLanguageServerProtocol) -> None:
-        super().__init__(parent)
-
-        parent.document_symbols.collect.add(self.collect)
-
-    @language_id("robotframework")
-    @_logger.call
-    async def collect(
-        self, sender: Any, document: TextDocument
-    ) -> Optional[Union[List[DocumentSymbol], List[SymbolInformation], None]]:
-        return _Visitor.find_from(self.parent.documents_cache.get_model(document), self)

tests/robotcode/language_server/robotframework/parts/_regtest_outputs/rf41/test_document_symbols.test[symbols.robot-000-001-settings_section].out

@@ -0,0 +1,25 @@
+data: !GeneratedTestData
+  character: 1
+  line: 0
+  name: settings section
+result: !DocumentSymbol
+  children: []
+  deprecated: null
+  detail: null
+  kind: 3
+  name: Settings
+  range:
+    end:
+      character: 22
+      line: 2
+    start:
+      character: 0
+      line: 0
+  selection_range:
+    end:
+      character: 22
+      line: 2
+    start:
+      character: 0
+      line: 0
+  tags: null

tests/robotcode/language_server/robotframework/parts/_regtest_outputs/rf41/test_document_symbols.test[symbols.robot-000-008-settings_section].out

@@ -0,0 +1,25 @@
+data: !GeneratedTestData
+  character: 8
+  line: 0
+  name: settings section
+result: !DocumentSymbol
+  children: []
+  deprecated: null
+  detail: null
+  kind: 3
+  name: Settings
+  range:
+    end:
+      character: 22
+      line: 2
+    start:
+      character: 0
+      line: 0
+  selection_range:
+    end:
+      character: 22
+      line: 2
+    start:
+      character: 0
+      line: 0
+  tags: null

tests/robotcode/language_server/robotframework/parts/_regtest_outputs/rf41/test_document_symbols.test[symbols.robot-000-015-settings_section].out

@@ -0,0 +1,25 @@
+data: !GeneratedTestData
+  character: 15
+  line: 0
+  name: settings section
+result: !DocumentSymbol
+  children: []
+  deprecated: null
+  detail: null
+  kind: 3
+  name: Settings
+  range:
+    end:
+      character: 22
+      line: 2
+    start:
+      character: 0
+      line: 0
+  selection_range:
+    end:
+      character: 22
+      line: 2
+    start:
+      character: 0
+      line: 0
+  tags: null

tests/robotcode/language_server/robotframework/parts/_regtest_outputs/rf41/test_document_symbols.test[symbols.robot-004-001-variables_section].out

@@ -0,0 +1,25 @@
+data: !GeneratedTestData
+  character: 1
+  line: 4
+  name: variables section
+result: !DocumentSymbol
+  children: []
+  deprecated: null
+  detail: null
+  kind: 3
+  name: Variables
+  range:
+    end:
+      character: 13
+      line: 6
+    start:
+      character: 0
+      line: 4
+  selection_range:
+    end:
+      character: 13
+      line: 6
+    start:
+      character: 0
+      line: 4
+  tags: null

tests/robotcode/language_server/robotframework/parts/_regtest_outputs/rf41/test_document_symbols.test[symbols.robot-004-008-variables_section].out

@@ -0,0 +1,25 @@
+data: !GeneratedTestData
+  character: 8
+  line: 4
+  name: variables section
+result: !DocumentSymbol
+  children: []
+  deprecated: null
+  detail: null
+  kind: 3
+  name: Variables
+  range:
+    end:
+      character: 13
+      line: 6
+    start:
+      character: 0
+      line: 4
+  selection_range:
+    end:
+      character: 13
+      line: 6
+    start:
+      character: 0
+      line: 4
+  tags: null