jupyter-server-ydoc 1.0.0b8__py3-none-any.whl → 1.0.0rc1__py3-none-any.whl

jupyter_server_ydoc/_version.py

@@ -1 +1 @@
-__version__ = "1.0.0b8"
+__version__ = "1.0.0rc1"

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/rooms.py

@@ -41,7 +41,7 @@ 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

{jupyter_server_ydoc-1.0.0b8.dist-info → jupyter_server_ydoc-1.0.0rc1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: jupyter-server-ydoc
-Version: 1.0.0b8
+Version: 1.0.0rc1
 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.0b8.dist-info → jupyter_server_ydoc-1.0.0rc1.dist-info}/RECORD

@@ -1,18 +1,18 @@
 jupyter_server_ydoc/__init__.py,sha256=B8H7XLhzgrTCQD8304Lx91FYXslwabsnV9OuYu4M4Hw,346
-jupyter_server_ydoc/_version.py,sha256=FINJxficj37iURkarZ-YupPPH4azy-E4XBpiEqZ9uDU,24
+jupyter_server_ydoc/_version.py,sha256=iwDi0TUz45SMYIlshEAh-UPerqIe7nxUavbLYwEgSR8,25
 jupyter_server_ydoc/app.py,sha256=8vOKWLYa4OKu8Pw24TLWtbgs2SfH0_R64dPrErdWyQM,7739
-jupyter_server_ydoc/handlers.py,sha256=delGUrN9pslVmkxgDEolbemLvOGHW4Sb8m41IOuQBZA,23816
+jupyter_server_ydoc/handlers.py,sha256=xfcTzrOV08wJVIwxHhp9DdVH3ogEY5E_ktLpzBXV5qE,24016
 jupyter_server_ydoc/loaders.py,sha256=TijilImdgYk9K91cXEIP_DzkOr6phSddwQFpLI5l_RA,10564
 jupyter_server_ydoc/pytest_plugin.py,sha256=pSw5KGHid4qRgu1PqQ-GiNOH7IBSWudXQX21J43cB3o,6805
-jupyter_server_ydoc/rooms.py,sha256=lv1VIIOv26_K1lMEHB3ocyjLWP4Pk05-h3mO97uYiS4,12238
+jupyter_server_ydoc/rooms.py,sha256=szOAfMldhQIrmVpqoF75O0_KXY54X_TrzJz6vpjR6kE,12254
 jupyter_server_ydoc/stores.py,sha256=_5J6eNs3R5Tv88PCc-GGuszxQstfvNoBCYABqzBzJXA,1004
 jupyter_server_ydoc/test_utils.py,sha256=IFXUPf1efHd4DgC1GT7ZMJMhKryKlB0Lx4vU2-mhz4Q,1540
 jupyter_server_ydoc/utils.py,sha256=yQC-uRdLyFDYbt2Zms_hA1HyjlwznMK4yQ3_FUwTlnQ,2013
 jupyter_server_ydoc/websocketserver.py,sha256=7fLPJcWczD-4R_-LXtfvNxM_pUXFasZWDmT4RIrOQHE,5150
 jupyter_server_ydoc/events/awareness.yaml,sha256=9isoK58uue7lqMnlHqyfQt29z16Otkh14oRe1k5vbKM,753
 jupyter_server_ydoc/events/session.yaml,sha256=A7Wt7czyx38MXp5fpDbH7HLS0QNkeOqaEhHdP2x-0Mo,1594
-jupyter_server_ydoc-1.0.0b8.data/data/etc/jupyter/jupyter_server_config.d/jupyter_collaboration.json,sha256=0thh2hJUxAKkZSmneJMG0U6QJRjdM6zGlwrTedEt-Jk,94
-jupyter_server_ydoc-1.0.0b8.dist-info/METADATA,sha256=fae7vmqLAiIHfFyMxv0DMQkh1cyN1HcmkI1LkIZCFmk,5012
-jupyter_server_ydoc-1.0.0b8.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-jupyter_server_ydoc-1.0.0b8.dist-info/licenses/LICENSE,sha256=mhO0ZW9EiWOPg0dUgB-lNbJ0CGwRmTdbeAg_se1SOnY,2833
-jupyter_server_ydoc-1.0.0b8.dist-info/RECORD,,
+jupyter_server_ydoc-1.0.0rc1.data/data/etc/jupyter/jupyter_server_config.d/jupyter_collaboration.json,sha256=0thh2hJUxAKkZSmneJMG0U6QJRjdM6zGlwrTedEt-Jk,94
+jupyter_server_ydoc-1.0.0rc1.dist-info/METADATA,sha256=8MBKlcFq26cR8DCRI2rNc4ENZLCLoT-SR6ktn9FpbX0,5013
+jupyter_server_ydoc-1.0.0rc1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+jupyter_server_ydoc-1.0.0rc1.dist-info/licenses/LICENSE,sha256=mhO0ZW9EiWOPg0dUgB-lNbJ0CGwRmTdbeAg_se1SOnY,2833
+jupyter_server_ydoc-1.0.0rc1.dist-info/RECORD,,