jupyter-server-ydoc 2.0.2__py3-none-any.whl → 2.1.0__py3-none-any.whl

jupyter_server_ydoc/_version.py

@@ -1 +1 @@
-__version__ = "2.0.2"
+__version__ = "2.1.0"

jupyter_server_ydoc/handlers.py

@@ -9,12 +9,13 @@ import uuid
 from logging import Logger
 from typing import Any
 from uuid import uuid4
+from typing import cast
 
 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
+from pycrdt import Doc, Encoder, UndoManager
 from pycrdt_websocket.yroom import YRoom
 from pycrdt_websocket.ystore import BaseYStore
 from tornado import web
@@ -32,6 +33,8 @@ from .utils import (
     room_id_from_encoded_path,
 )
 from .websocketserver import JupyterWebsocketServer, RoomNotFound
+from .utils import MessageType
+from pycrdt import Decoder
 
 YFILE = YDOCS["file"]
 
@@ -270,7 +273,7 @@ class YDocWebSocketHandler(WebSocketHandler, JupyterHandler):
             if self._room_id != "JupyterLab:globalAwareness":
                 self._emit_awareness_event(self.current_user.username, "join")
 
-    async def send(self, message):
+    async def send(self, message: bytes) -> None:
         """
         Send a message to the client.
         """
@@ -291,9 +294,43 @@ class YDocWebSocketHandler(WebSocketHandler, JupyterHandler):
         """
         On message receive.
         """
+        decoder = Decoder(message)
+        header = decoder.read_var_uint()
+        if header == MessageType.RAW:
+            msg = decoder.read_var_string()
+            if msg == "save":
+                save_id = decoder.read_var_uint()
+                save_reply = {
+                    "type": "save",
+                    "responseTo": save_id,
+                }
+                try:
+                    room = cast(DocumentRoom, self.room)
+                    save_task = room._save_to_disc()
+                    # task may be missing if save was already in progress
+                    if save_task:
+                        await save_task
+                        await self.send(
+                            self._encode_json_message({**save_reply, "status": "success"})
+                        )
+                    else:
+                        await self.send(
+                            self._encode_json_message({**save_reply, "status": "skipped"})
+                        )
+                except Exception:
+                    self.log.error("Couldn't save content from room: %s", self._room_id)
+                    await self.send(self._encode_json_message({**save_reply, "status": "failed"}))
+            return
+
         self._message_queue.put_nowait(message)
         self._websocket_server.ypatch_nb += 1
 
+    def _encode_json_message(self, message: dict) -> bytes:
+        encoder = Encoder()
+        encoder.write_var_uint(MessageType.RAW)
+        encoder.write_var_string(json.dumps(message))
+        return encoder.to_bytes()
+
     def on_close(self) -> None:
         """
         On connection close.

jupyter_server_ydoc/pytest_plugin.py

@@ -276,7 +276,7 @@ def rtc_create_mock_document_room():
         last_modified: datetime | None = None,
         save_delay: float | None = None,
         store: SQLiteYStore | None = None,
-        writable: bool = False,
+        writable: bool = True,
     ) -> tuple[FakeContentsManager, FileLoader, DocumentRoom]:
         paths = {id: path}
 

jupyter_server_ydoc/rooms.py

@@ -247,12 +247,40 @@ class DocumentRoom(YRoom):
             document. This tasks are debounced (60 seconds by default) so we
             need to cancel previous tasks before creating a new one.
         """
+        # Collect autosave values from all clients
+        autosave_states = [
+            state.get("autosave", True)
+            for state in self.awareness.states.values()
+            if state  # skip empty states
+        ]
+
+        # If no states exist (e.g., during tests), force autosave to be True
+        if not autosave_states:
+            autosave_states = [True]
+
+        # Enable autosave if at least one client has it turned on
+        autosave = any(autosave_states)
+
+        if not autosave:
+            return
+        if self._update_lock.locked():
+            return
+
+        self._saving_document = asyncio.create_task(
+            self._maybe_save_document(self._saving_document)
+        )
+
+    def _save_to_disc(self):
+        """
+        Called when manual save is triggered. Helpful when autosave is turned off.
+        """
         if self._update_lock.locked():
             return
 
         self._saving_document = asyncio.create_task(
             self._maybe_save_document(self._saving_document)
         )
+        return self._saving_document
 
     async def _maybe_save_document(self, saving_document: asyncio.Task | None) -> None:
         """
@@ -265,7 +293,6 @@ class DocumentRoom(YRoom):
         """
         if self._save_delay is None:
             return
-
         if saving_document is not None and not saving_document.done():
             # the document is being saved, cancel that
             saving_document.cancel()

jupyter_server_ydoc/utils.py

@@ -19,6 +19,7 @@ FORK_EVENTS_SCHEMA_PATH = EVENTS_FOLDER_PATH / "fork.yaml"
 class MessageType(IntEnum):
     SYNC = 0
     AWARENESS = 1
+    RAW = 2
     CHAT = 125
 
 

{jupyter_server_ydoc-2.0.2.dist-info → jupyter_server_ydoc-2.1.0.dist-info}/METADATA

@@ -1,7 +1,12 @@
 Metadata-Version: 2.4
 Name: jupyter-server-ydoc
-Version: 2.0.2
+Version: 2.1.0
 Summary: jupyter-server extension integrating collaborative shared models.
+Project-URL: Documentation, https://jupyterlab-realtime-collaboration.readthedocs.io/
+Project-URL: Repository, https://github.com/jupyterlab/jupyter-collaboration
+Project-URL: Changelog, https://jupyterlab-realtime-collaboration.readthedocs.io/en/latest/changelog.html
+Project-URL: Source, https://github.com/jupyterlab/jupyter-collaboration/tree/main/projects/jupyter-server-ydoc
+Project-URL: Issues, https://github.com/jupyterlab/jupyter-collaboration/issues/new/choose
 Author-email: Jupyter Development Team <jupyter@googlegroups.com>
 License: # Licensing terms
         

{jupyter_server_ydoc-2.0.2.dist-info → jupyter_server_ydoc-2.1.0.dist-info}/RECORD

@@ -1,19 +1,19 @@
 jupyter_server_ydoc/__init__.py,sha256=B8H7XLhzgrTCQD8304Lx91FYXslwabsnV9OuYu4M4Hw,346
-jupyter_server_ydoc/_version.py,sha256=tATvJM5shAzfspHYjdVwpV2w3-gDA119NlEYi5X2lFY,22
+jupyter_server_ydoc/_version.py,sha256=Xybt2skBZamGMNlLuOX1IG-h4uIxqUDGAO8MIGWrJac,22
 jupyter_server_ydoc/app.py,sha256=6Zca0acaEFCKyUbXdmcPmVk1Dgu91Y-DFjYR16WKFlg,8161
-jupyter_server_ydoc/handlers.py,sha256=Prsi_IlJa9wl9VszRr-2qKZ8z224u-o7lRYI5SNJBaE,27276
+jupyter_server_ydoc/handlers.py,sha256=x3R5VluXWFN460AiC7xNbipSpCR7SQSjqrcwjBorgpw,28836
 jupyter_server_ydoc/loaders.py,sha256=XUQqg2EbfQUYlQVjHY183gYKeVZ6x92VHy4EsOQz4fA,11303
-jupyter_server_ydoc/pytest_plugin.py,sha256=MfFqL5xJLGeIuLG8GF1kr2TumRjIIQfxoeNLGjvQjY8,8742
-jupyter_server_ydoc/rooms.py,sha256=u4umGLsudteR6oJvw4pcszzrZTDgzOZkVXZEOfBPk8M,12221
+jupyter_server_ydoc/pytest_plugin.py,sha256=yMVlk7fvHXiM7g6ua0Ophc96cFwC0bmTWVDbbUeu2DE,8741
+jupyter_server_ydoc/rooms.py,sha256=O0dYKeDRMUPFRraFJf8irqnFaSD80hirrtAYBXKTgrM,13103
 jupyter_server_ydoc/stores.py,sha256=_5J6eNs3R5Tv88PCc-GGuszxQstfvNoBCYABqzBzJXA,1004
 jupyter_server_ydoc/test_utils.py,sha256=utUwB5FThc_SCQshhUbLNih9GUa5qBcmMgU6-jx0ZnA,2275
-jupyter_server_ydoc/utils.py,sha256=EgKC15js8VOS8-5jGMs4pfHQfV9drnNT2Gew5UlyXZc,2171
+jupyter_server_ydoc/utils.py,sha256=_wI4CFOEZK4MSMYCZe2moSbggUTRdGxY4qTzSDEFzdE,2183
 jupyter_server_ydoc/websocketserver.py,sha256=h1yTgJcsCK17_97Ne5x-lbgIFsxylwnltxagcuAlTJY,5185
 jupyter_server_ydoc/events/awareness.yaml,sha256=2FrCci5rZIaU4rn8pIPZJkd132YAZdzKjSNSwjOY7Dk,755
 jupyter_server_ydoc/events/fork.yaml,sha256=3OrhQjhVyLjlBJWMiffbnZodL3GzFafLwEmSBFrK33o,1303
 jupyter_server_ydoc/events/session.yaml,sha256=PS0MxowpRwY5QFYm-LJvHUxKHnsictV8_6VEwfhYxcQ,1596
-jupyter_server_ydoc-2.0.2.data/data/etc/jupyter/jupyter_server_config.d/jupyter_collaboration.json,sha256=0thh2hJUxAKkZSmneJMG0U6QJRjdM6zGlwrTedEt-Jk,94
-jupyter_server_ydoc-2.0.2.dist-info/METADATA,sha256=Wcc5iSM2ZdOp74R__1pRnFDoPYvNK0lm-y9WkQJjBX0,5115
-jupyter_server_ydoc-2.0.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-jupyter_server_ydoc-2.0.2.dist-info/licenses/LICENSE,sha256=mhO0ZW9EiWOPg0dUgB-lNbJ0CGwRmTdbeAg_se1SOnY,2833
-jupyter_server_ydoc-2.0.2.dist-info/RECORD,,
+jupyter_server_ydoc-2.1.0.data/data/etc/jupyter/jupyter_server_config.d/jupyter_collaboration.json,sha256=0thh2hJUxAKkZSmneJMG0U6QJRjdM6zGlwrTedEt-Jk,94
+jupyter_server_ydoc-2.1.0.dist-info/METADATA,sha256=Rfb1XEPiOQTYrI0JZ8ZFpiYvWIhmxCalR0-OmFPVwT8,5587
+jupyter_server_ydoc-2.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+jupyter_server_ydoc-2.1.0.dist-info/licenses/LICENSE,sha256=mhO0ZW9EiWOPg0dUgB-lNbJ0CGwRmTdbeAg_se1SOnY,2833
+jupyter_server_ydoc-2.1.0.dist-info/RECORD,,