jupyter-server-ydoc 2.0.2__tar.gz → 2.1.0b0__tar.gz

{jupyter_server_ydoc-2.0.2 → jupyter_server_ydoc-2.1.0b0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jupyter-server-ydoc
-Version: 2.0.2
+Version: 2.1.0b0
 Summary: jupyter-server extension integrating collaborative shared models.
 Author-email: Jupyter Development Team <jupyter@googlegroups.com>
 License: # Licensing terms

jupyter_server_ydoc-2.1.0b0/jupyter_server_ydoc/_version.py

@@ -0,0 +1 @@
+__version__ = "2.1.0b0"

{jupyter_server_ydoc-2.0.2 → jupyter_server_ydoc-2.1.0b0}/jupyter_server_ydoc/handlers.py

@@ -9,6 +9,7 @@ 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
@@ -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"]
 
@@ -291,6 +294,18 @@ 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":
+                try:
+                    room = cast(DocumentRoom, self.room)
+                    room._save_to_disc()
+                except Exception:
+                    self.log.error("Couldn't save content from room: %s", self._room_id)
+            return
+
         self._message_queue.put_nowait(message)
         self._websocket_server.ypatch_nb += 1
 

{jupyter_server_ydoc-2.0.2 → jupyter_server_ydoc-2.1.0b0}/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-2.0.2 → jupyter_server_ydoc-2.1.0b0}/jupyter_server_ydoc/rooms.py

@@ -247,6 +247,33 @@ 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
 
@@ -265,7 +292,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-2.0.2 → jupyter_server_ydoc-2.1.0b0}/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 → jupyter_server_ydoc-2.1.0b0}/tests/test_rooms.py

@@ -51,9 +51,7 @@ async def test_defined_save_delay_should_save_content_after_document_change(
     rtc_create_mock_document_room,
 ):
     content = "test"
-    cm, _, room = rtc_create_mock_document_room(
-        "test-id", "test.txt", content, save_delay=0.01, writable=True
-    )
+    cm, _, room = rtc_create_mock_document_room("test-id", "test.txt", content, save_delay=0.01)
 
     await room.initialize()
     room._document.source = "Test 2"
@@ -79,6 +77,50 @@ async def test_undefined_save_delay_should_not_save_content_after_document_chang
     assert "save" not in cm.actions
 
 
+async def test_should_not_save_content_when_all_clients_have_autosave_disabled(
+    rtc_create_mock_document_room,
+):
+    content = "test"
+    cm, _, room = rtc_create_mock_document_room("test-id", "test.txt", content, save_delay=0.01)
+
+    # Disable autosave for all existing clients
+    for state in room.awareness._states.values():
+        if state is not None:
+            state["autosave"] = False
+
+    # Inject a dummy client with autosave disabled
+    room.awareness._states[9999] = {"autosave": False}
+
+    await room.initialize()
+    room._document.source = "Test 2"
+
+    await asyncio.sleep(0.15)
+
+    assert "save" not in cm.actions
+
+
+async def test_should_save_content_when_at_least_one_client_has_autosave_enabled(
+    rtc_create_mock_document_room,
+):
+    content = "test"
+    cm, _, room = rtc_create_mock_document_room("test-id", "test.txt", content, save_delay=0.01)
+
+    # Disable autosave for all existing clients
+    for state in room.awareness._states.values():
+        if state is not None:
+            state["autosave"] = False
+
+    # Inject a dummy client with autosave enabled
+    room.awareness._states[10000] = {"autosave": True}
+
+    await room.initialize()
+    room._document.source = "Test 2"
+
+    await asyncio.sleep(0.15)
+
+    assert "save" in cm.actions
+
+
 # The following test should be restored when package versions are fixed.
 
 # async def test_document_path(rtc_create_mock_document_room):

jupyter_server_ydoc-2.0.2/jupyter_server_ydoc/_version.py

@@ -1 +0,0 @@
-__version__ = "2.0.2"