TextDocument now uses threading.Locks to prioritize document change notifications

Author: d-biehl

robotcode/language_server/common/parts/documents.py

@@ -258,7 +258,7 @@ async def _text_document_did_open(self, text_document: TextDocumentItem, *args:
 
                 self._documents[uri] = document
             else:
-                text_changed = await document.text() != normalized_text
+                text_changed = document.text != normalized_text
                 if text_changed:
                     await document.apply_full_change(text_document.version, normalized_text)
 
@@ -326,7 +326,7 @@ async def _text_document_did_save(
             if text is not None:
                 normalized_text = self._normalize_line_endings(text)
 
-                text_changed = await document.text() != normalized_text
+                text_changed = document.text != normalized_text
                 if text_changed:
                     await document.save(None, text)
                     create_sub_task(

robotcode/language_server/common/text_document.py

@@ -3,6 +3,7 @@
 import collections
 import inspect
 import io
+import threading
 import weakref
 from typing import Any, Awaitable, Callable, Dict, List, Optional, TypeVar, Union, cast
 
@@ -38,7 +39,7 @@ def __init__(
     ) -> None:
         super().__init__()
 
-        self._lock = Lock()
+        self._lock = threading.RLock()
         self.document_uri = document_uri
         self.uri = Uri(self.document_uri).normalized()
         self.language_id = language_id
@@ -70,11 +71,9 @@ def __repr__(self) -> str:  # pragma: no cover
             f")"
         )
 
-    def text_sync(self) -> str:
-        return self._text
-
-    async def text(self) -> str:
-        async with self._lock:
+    @property
+    def text(self) -> str:
+        with self._lock:
             return self._text
 
     async def save(self, version: Optional[int], text: Optional[str]) -> None:
@@ -88,13 +87,13 @@ async def revert(self, version: Optional[int]) -> bool:
 
     @_logger.call
     async def apply_none_change(self) -> None:
-        async with self._lock:
+        with self._lock:
             self._lines = None
             await self._invalidate_cache()
 
     @_logger.call
     async def apply_full_change(self, version: Optional[int], text: Optional[str], *, save: bool = False) -> None:
-        async with self._lock:
+        with self._lock:
             if version is not None:
                 self._version = version
             if text is not None:
@@ -106,7 +105,7 @@ async def apply_full_change(self, version: Optional[int], text: Optional[str], *
 
     @_logger.call
     async def apply_incremental_change(self, version: Optional[int], range: Range, text: str) -> None:
-        async with self._lock:
+        with self._lock:
             try:
                 if version is not None:
                     self._version = version
@@ -148,7 +147,7 @@ def __get_lines(self) -> List[str]:
 
     async def get_lines(self) -> List[str]:
         if self._lines is None:
-            async with self._lock:
+            with self._lock:
                 return self.__get_lines()
         return self._lines
 
@@ -167,19 +166,19 @@ async def _invalidate_cache(self) -> None:
 
     @_logger.call
     async def invalidate_cache(self) -> None:
-        async with self._lock:
+        with self._lock:
             await self._invalidate_cache()
 
     async def _invalidate_data(self) -> None:
         self._data.clear()
 
     @_logger.call
     async def invalidate_data(self) -> None:
-        async with self._lock:
+        with self._lock:
             await self._invalidate_data()
 
     async def __remove_cache_entry_safe(self, _ref: Any) -> None:
-        async with self._lock:
+        with self._lock:
             if _ref in self._cache:
                 self._cache.pop(_ref)
 
@@ -217,8 +216,8 @@ async def get_cache(
 
         reference = self.__get_cache_reference(entry)
 
-        # async with self._lock:
-        e = self._cache[reference]
+        with self._lock:
+            e = self._cache[reference]
 
         async with e.lock:
             if not e.has_data:
@@ -252,5 +251,5 @@ async def _clear(self) -> None:
 
     @_logger.call
     async def clear(self) -> None:
-        async with self._lock:
+        with self._lock:
             await self._clear()

robotcode/language_server/robotframework/parts/code_action.py

@@ -359,6 +359,6 @@ async def _convert_uri(self, uri: str, *args: Any, **kwargs: Any) -> Optional[st
         if folder:
             path = real_uri.to_path().relative_to(folder.uri.to_path())
 
-            return f"http://localhost:{self._documentation_server_port}/{path}"
+            return f"http://localhost:{self._documentation_server_port}/{path.as_posix()}"
 
         return None

robotcode/language_server/robotframework/parts/discovering.py

@@ -139,7 +139,7 @@ def get_document_text(source: str) -> str:
             if self.parent._loop:
                 doc = self.parent.documents.get_sync(Uri.from_path(source).normalized())
                 if doc is not None and doc.opened_in_editor:
-                    return doc.text_sync()
+                    return doc.text
 
             return source
 

robotcode/language_server/robotframework/parts/documents_cache.py

@@ -222,7 +222,7 @@ async def __get_tokens_internal(
         get: Callable[[str], List[Token]],
     ) -> List[Token]:
 
-        return get(await document.text())
+        return get(document.text)
 
     async def get_resource_tokens(self, document: TextDocument, data_only: bool = False) -> List[Token]:
         if data_only:

tests/robotcode/language_server/common/test_text_document.py

@@ -13,25 +13,25 @@ async def test_apply_full_change_should_work() -> None:
     text = """first"""
     new_text = """changed"""
     document = TextDocument(document_uri="file://test.robot", language_id="robotframework", version=1, text=text)
-    assert await document.text() == text
+    assert document.text == text
 
     await document.apply_full_change(1, new_text)
 
-    assert await document.text() == new_text
+    assert document.text == new_text
 
 
 @pytest.mark.asyncio
 async def test_apply_apply_incremental_change_at_begining_should_work() -> None:
     text = """first"""
     new_text = """changed"""
     document = TextDocument(document_uri="file://test.robot", language_id="robotframework", version=1, text=text)
-    assert await document.text() == text
+    assert document.text == text
 
     await document.apply_incremental_change(
         1, Range(start=Position(line=0, character=0), end=Position(line=0, character=0)), new_text
     )
 
-    assert await document.text() == new_text + text
+    assert document.text == new_text + text
 
 
 @pytest.mark.asyncio
@@ -40,13 +40,13 @@ async def test_apply_apply_incremental_change_at_end_should_work() -> None:
     new_text = """changed"""
 
     document = TextDocument(document_uri="file://test.robot", language_id="robotframework", version=1, text=text)
-    assert await document.text() == text
+    assert document.text == text
 
     await document.apply_incremental_change(
         1, Range(start=Position(line=0, character=len(text)), end=Position(line=0, character=len(text))), new_text
     )
 
-    assert await document.text() == text + new_text
+    assert document.text == text + new_text
 
 
 @pytest.mark.asyncio
@@ -55,21 +55,21 @@ async def test_save_and_revert_should_work() -> None:
     new_text = """changed"""
 
     document = TextDocument(document_uri="file://test.robot", language_id="robotframework", version=1, text=text)
-    assert await document.text() == text
+    assert document.text == text
 
     assert not await document.revert(None)
 
     await document.apply_incremental_change(
         2, Range(start=Position(line=0, character=len(text)), end=Position(line=0, character=len(text))), new_text
     )
 
-    assert await document.text() == text + new_text
+    assert document.text == text + new_text
     assert document.version == 2
 
     assert await document.revert(None)
     assert not await document.revert(None)
 
-    assert await document.text() == text
+    assert document.text == text
     assert document.version == 1
 
     await document.apply_incremental_change(
@@ -78,7 +78,7 @@ async def test_save_and_revert_should_work() -> None:
 
     await document.save(None, None)
 
-    assert await document.text() == text + new_text
+    assert document.text == text + new_text
     assert document.version == 2
 
 
@@ -95,13 +95,13 @@ async def test_apply_apply_incremental_change_in_the_middle_should_work() -> Non
 third"""
 
     document = TextDocument(document_uri="file://test.robot", language_id="robotframework", version=1, text=text)
-    assert await document.text() == text
+    assert document.text == text
 
     await document.apply_incremental_change(
         1, Range(start=Position(line=1, character=7), end=Position(line=1, character=7)), new_text
     )
 
-    assert await document.text() == expected
+    assert document.text == expected
 
 
 @pytest.mark.asyncio
@@ -113,13 +113,13 @@ async def test_apply_apply_incremental_change_with_start_line_eq_len_lines_shoul
     new_text = """changed """
 
     document = TextDocument(document_uri="file://test.robot", language_id="robotframework", version=1, text=text)
-    assert await document.text() == text
+    assert document.text == text
 
     await document.apply_incremental_change(
         1, Range(start=Position(line=3, character=7), end=Position(line=3, character=8)), new_text
     )
 
-    assert await document.text() == text + new_text
+    assert document.text == text + new_text
 
 
 @pytest.mark.asyncio
@@ -128,7 +128,7 @@ async def test_apply_apply_incremental_change_with_wrong_range_should_raise_inva
     new_text = """changed"""
 
     document = TextDocument(document_uri="file://test.robot", language_id="robotframework", version=1, text=text)
-    assert await document.text() == text
+    assert document.text == text
 
     with pytest.raises(InvalidRangeError):
         await document.apply_incremental_change(
@@ -141,11 +141,11 @@ async def test_apply_none_change_should_work() -> None:
     text = """first"""
 
     document = TextDocument(document_uri="file://test.robot", language_id="robotframework", version=1, text=text)
-    assert await document.text() == text
+    assert document.text == text
 
     await document.apply_none_change()
 
-    assert await document.text() == text
+    assert document.text == text
 
 
 @pytest.mark.asyncio
@@ -157,7 +157,7 @@ async def test_lines_should_give_the_lines_of_the_document() -> None:
 """
 
     document = TextDocument(document_uri="file://test.robot", language_id="robotframework", version=1, text=text)
-    assert await document.text() == text
+    assert document.text == text
 
     await document.apply_none_change()