jupyter-server-ydoc 1.0.0b6__tar.gz → 1.0.0rc0__tar.gz

{jupyter_server_ydoc-1.0.0b6 → jupyter_server_ydoc-1.0.0rc0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: jupyter-server-ydoc
-Version: 1.0.0b6
+Version: 1.0.0rc0
 Summary: jupyter-server extension integrating collaborative shared models.
 Author-email: Jupyter Development Team <jupyter@googlegroups.com>
 License: # Licensing terms
@@ -79,9 +79,9 @@ Requires-Dist: jsonschema>=4.18.0
 Requires-Dist: jupyter-events>=0.10.0
 Requires-Dist: jupyter-server-fileid<1,>=0.7.0
 Requires-Dist: jupyter-server<3.0.0,>=2.11.1
-Requires-Dist: jupyter-ydoc<4.0.0,>=2.0.0
+Requires-Dist: jupyter-ydoc<4.0.0,>=2.1.2
 Requires-Dist: pycrdt
-Requires-Dist: pycrdt-websocket<0.15.0,>=0.14.2
+Requires-Dist: pycrdt-websocket<0.16.0,>=0.15.0
 Provides-Extra: test
 Requires-Dist: coverage; extra == 'test'
 Requires-Dist: importlib-metadata>=4.8.3; (python_version < '3.10') and extra == 'test'

jupyter_server_ydoc-1.0.0rc0/jupyter_server_ydoc/_version.py

@@ -0,0 +1 @@
+__version__ = "1.0.0rc0"

{jupyter_server_ydoc-1.0.0b6 → jupyter_server_ydoc-1.0.0rc0}/jupyter_server_ydoc/handlers.py

@@ -8,14 +8,14 @@ import json
 import time
 import uuid
 from logging import Logger
-from typing import Any
+from typing import Any, Literal
 from uuid import uuid4
 
 from jupyter_server.auth import authorized
 from jupyter_server.base.handlers import APIHandler, JupyterHandler
 from jupyter_server.utils import ensure_async
 from jupyter_ydoc import ydocs as YDOCS
-from pycrdt import Doc, UndoManager, YMessageType, write_var_uint
+from pycrdt import Doc, UndoManager, write_var_uint
 from pycrdt_websocket.websocket_server import YRoom
 from pycrdt_websocket.ystore import BaseYStore
 from tornado import web
@@ -137,6 +137,10 @@ class YDocWebSocketHandler(WebSocketHandler, JupyterHandler):
                         exception_handler=exception_logger,
                     )
 
+                    if self._room_id == "JupyterLab:globalAwareness":
+                        # Listen for the changes in GlobalAwareness to update users
+                        self.room.awareness.observe(self._on_global_awareness_event)
+
             try:
                 await self._websocket_server.start_room(self.room)
             except Exception as e:
@@ -286,31 +290,6 @@ class YDocWebSocketHandler(WebSocketHandler, JupyterHandler):
         """
         message_type = message[0]
 
-        if message_type == YMessageType.AWARENESS:
-            # awareness
-            skip = False
-            changes = self.room.awareness.get_changes(message[1:])
-            added_users = changes["added"]
-            removed_users = changes["removed"]
-            for i, user in enumerate(added_users):
-                u = changes["states"][i]
-                if "user" in u:
-                    name = u["user"]["name"]
-                    self._websocket_server.connected_users[user] = name
-                    self.log.debug("Y user joined: %s", name)
-            for user in removed_users:
-                if user in self._websocket_server.connected_users:
-                    name = self._websocket_server.connected_users[user]
-                    del self._websocket_server.connected_users[user]
-                    self.log.debug("Y user left: %s", name)
-            # filter out message depending on changes
-            if skip:
-                self.log.debug(
-                    "Filtered out Y message of type: %s",
-                    YMessageType(message_type).name,
-                )
-                return skip
-
         if message_type == MessageType.CHAT:
             msg = message[2:].decode("utf-8")
 
@@ -405,6 +384,31 @@ class YDocWebSocketHandler(WebSocketHandler, JupyterHandler):
                 self._emit(LogLevel.INFO, "clean", "Loader deleted.")
             del self._room_locks[self._room_id]
 
+    def _on_global_awareness_event(
+        self, topic: Literal["change", "update"], changes: tuple[dict[str, Any], Any]
+    ) -> None:
+        """
+        Update the users when the global awareness changes.
+
+            Parameters:
+                topic (str): `"update"` or `"change"` (`"change"` is triggered only if the states are modified).
+                changes (tuple[dict[str, Any], Any]): The changes and the origin of the changes.
+        """
+        if topic != "change":
+            return
+        added_users = changes[0]["added"]
+        removed_users = changes[0]["removed"]
+        for user in added_users:
+            u = self.room.awareness.states[user]
+            if "user" in u:
+                name = u["user"]["name"]
+                self._websocket_server.connected_users[user] = name
+                self.log.debug("Y user joined: %s", name)
+        for user in removed_users:
+            if user in self._websocket_server.connected_users:
+                name = self._websocket_server.connected_users.pop(user)
+                self.log.debug("Y user left: %s", name)
+
     def check_origin(self, origin):
         """
         Check origin

{jupyter_server_ydoc-1.0.0b6 → jupyter_server_ydoc-1.0.0rc0}/jupyter_server_ydoc/loaders.py

@@ -39,9 +39,11 @@ class FileLoader:
 
         self._log = log or getLogger(__name__)
         self._subscriptions: dict[str, Callable[[], Coroutine[Any, Any, None]]] = {}
+        self._filepath_subscriptions: dict[str, Callable[[], Coroutine[Any, Any, None] | None]] = {}
 
         self._watcher = asyncio.create_task(self._watch_file()) if self._poll_interval else None
         self.last_modified = None
+        self._current_path = self.path
 
     @property
     def file_id(self) -> str:
@@ -79,7 +81,12 @@ class FileLoader:
             except asyncio.CancelledError:
                 self._log.info(f"file watcher for '{self.file_id}' is cancelled now")
 
-    def observe(self, id: str, callback: Callable[[], Coroutine[Any, Any, None]]) -> None:
+    def observe(
+        self,
+        id: str,
+        callback: Callable[[], Coroutine[Any, Any, None]],
+        filepath_callback: Callable[[], Coroutine[Any, Any, None] | None] | None = None,
+    ) -> None:
         """
         Subscribe to the file to get notified about out-of-band file changes.
 
@@ -88,6 +95,8 @@ class FileLoader:
                     callback (Callable): Callback for notifying the room.
         """
         self._subscriptions[id] = callback
+        if filepath_callback is not None:
+            self._filepath_subscriptions[id] = filepath_callback
 
     def unobserve(self, id: str) -> None:
         """
@@ -97,6 +106,8 @@ class FileLoader:
                 id (str): Room ID
         """
         del self._subscriptions[id]
+        if id in self._filepath_subscriptions.keys():
+            del self._filepath_subscriptions[id]
 
     async def load_content(self, format: str, file_type: str) -> dict[str, Any]:
         """
@@ -204,15 +215,26 @@ class FileLoader:
         Notifies subscribed rooms about out-of-band file changes.
         """
         do_notify = False
+        filepath_change = False
         async with self._lock:
+            path = self.path
+            if self._current_path != path:
+                self._current_path = path
+                filepath_change = True
+
             # Get model metadata; format and type are not need
-            model = await ensure_async(self._contents_manager.get(self.path, content=False))
+            model = await ensure_async(self._contents_manager.get(path, content=False))
 
             if self.last_modified is not None and self.last_modified < model["last_modified"]:
                 do_notify = True
 
             self.last_modified = model["last_modified"]
 
+        if filepath_change:
+            # Notify filepath change
+            for callback in self._filepath_subscriptions.values():
+                await ensure_async(callback())
+
         if do_notify:
             # Notify out-of-band change
             # callbacks will load the file content, thus release the lock before calling them

{jupyter_server_ydoc-1.0.0b6 → jupyter_server_ydoc-1.0.0rc0}/jupyter_server_ydoc/rooms.py

@@ -41,7 +41,8 @@ class DocumentRoom(YRoom):
         self._file_format: str = file_format
         self._file_type: str = file_type
         self._file: FileLoader = file
-        self._document = YDOCS.get(self._file_type, YFILE)(self.ydoc)
+        self._document = YDOCS.get(self._file_type, YFILE)(self.ydoc, self.awareness)
+        self._document.path = self._file.path
 
         self._logger = logger
         self._save_delay = save_delay
@@ -54,7 +55,7 @@ class DocumentRoom(YRoom):
 
         # Listen for document changes
         self._document.observe(self._on_document_change)
-        self._file.observe(self.room_id, self._on_outofband_change)
+        self._file.observe(self.room_id, self._on_outofband_change, self._on_filepath_change)
 
     @property
     def file_format(self) -> str:
@@ -225,6 +226,12 @@ class DocumentRoom(YRoom):
             self._document.source = model["content"]
             self._document.dirty = False
 
+    def _on_filepath_change(self) -> None:
+        """
+        Update the document path property.
+        """
+        self._document.path = self._file.path
+
     def _on_document_change(self, target: str, event: Any) -> None:
         """
         Called when the shared document changes.

{jupyter_server_ydoc-1.0.0b6 → jupyter_server_ydoc-1.0.0rc0}/jupyter_server_ydoc/test_utils.py

@@ -16,6 +16,9 @@ class FakeFileIDManager:
     def get_path(self, id: str) -> str:
         return self.mapping[id]
 
+    def move(self, id: str, new_path: str) -> None:
+        self.mapping[id] = new_path
+
 
 class FakeContentsManager:
     def __init__(self, model: dict):

{jupyter_server_ydoc-1.0.0b6 → jupyter_server_ydoc-1.0.0rc0}/pyproject.toml

@@ -29,9 +29,9 @@ authors = [
 ]
 dependencies = [
     "jupyter_server>=2.11.1,<3.0.0",
-    "jupyter_ydoc>=2.0.0,<4.0.0",
+    "jupyter_ydoc>=2.1.2,<4.0.0",
     "pycrdt",
-    "pycrdt-websocket>=0.14.2,<0.15.0",
+    "pycrdt-websocket>=0.15.0,<0.16.0",
     "jupyter_events>=0.10.0",
     "jupyter_server_fileid>=0.7.0,<1",
     "jsonschema>=4.18.0"

{jupyter_server_ydoc-1.0.0b6 → jupyter_server_ydoc-1.0.0rc0}/tests/test_rooms.py

@@ -75,3 +75,24 @@ async def test_undefined_save_delay_should_not_save_content_after_document_chang
     await asyncio.sleep(0.15)
 
     assert "save" not in cm.actions
+
+
+# The following test should be restored when package versions are fixed.
+
+# async def test_document_path(rtc_create_mock_document_room):
+#     id = "test-id"
+#     path = "test.txt"
+#     new_path = "test2.txt"
+
+#     _, loader, room = rtc_create_mock_document_room(id, path, "")
+
+#     await room.initialize()
+#     assert room._document.path == path
+
+#     # Update the path
+#     loader._file_id_manager.move(id, new_path)
+
+#     # Wait for a bit more than the poll_interval
+#     await asyncio.sleep(0.15)
+
+#     assert room._document.path == new_path

jupyter_server_ydoc-1.0.0b6/jupyter_server_ydoc/_version.py

@@ -1 +0,0 @@
-__version__ = "1.0.0b6"