jupyter-server-ydoc 2.2.0a0__py3-none-any.whl → 2.2.1__py3-none-any.whl

jupyter_server_ydoc/_version.py

@@ -1 +1 @@
-__version__ = "2.2.0.a0"
+__version__ = "2.2.1"

jupyter_server_ydoc/loaders.py

@@ -86,7 +86,7 @@ class FileLoader:
             try:
                 await self._watcher
             except asyncio.CancelledError:
-                self._log.info(f"file watcher for '{self.file_id}' is cancelled now")
+                self._log.info(f"File watcher for '{self.file_id}' was cancelled")
 
     def observe(
         self,

jupyter_server_ydoc/pytest_plugin.py

@@ -30,7 +30,14 @@ def rtc_document_save_delay():
 
 
 @pytest.fixture
-def jp_server_config(jp_root_dir, jp_server_config, rtc_document_save_delay):
+def rtc_document_cleanup_delay():
+    return 60
+
+
+@pytest.fixture
+def jp_server_config(
+    jp_root_dir, jp_server_config, rtc_document_save_delay, rtc_document_cleanup_delay
+):
     return {
         "ServerApp": {
             "jpserver_extensions": {
@@ -47,7 +54,10 @@ def jp_server_config(jp_root_dir, jp_server_config, rtc_document_save_delay):
             "db_path": str(jp_root_dir.joinpath(".fid_test.db")),
             "db_journal_mode": "OFF",
         },
-        "YDocExtension": {"document_save_delay": rtc_document_save_delay},
+        "YDocExtension": {
+            "document_save_delay": rtc_document_save_delay,
+            "document_cleanup_delay": rtc_document_cleanup_delay,
+        },
     }
 
 

jupyter_server_ydoc/rooms.py

@@ -278,20 +278,28 @@ class DocumentRoom(YRoom):
             return
 
         self._saving_document = asyncio.create_task(
-            self._maybe_save_document(self._saving_document)
+            self._maybe_save_document(self._saving_document, save_now=True)
         )
         return self._saving_document
 
-    async def _maybe_save_document(self, saving_document: asyncio.Task | None) -> None:
+    async def _maybe_save_document(
+        self, saving_document: asyncio.Task | None, save_now: bool = False
+    ) -> None:
         """
         Saves the content of the document to disk.
 
         ### Note:
             There is a save delay to debounce the save since we could receive a high
             amount of changes in a short period of time. This way we can cancel the
-            previous save.
+            previous save. When save_now is True, the delay is skipped and the save
+            executes immediately.
+
+            Parameters:
+                saving_document: The previous saving task to cancel if needed.
+                save_now: If True, skip the debounce delay, and save immediately.
+                          This is used when manually saving.
         """
-        if self._save_delay is None:
+        if self._save_delay is None and not save_now:
             return
         if saving_document is not None and not saving_document.done():
             # the document is being saved, cancel that
@@ -301,8 +309,10 @@ class DocumentRoom(YRoom):
         # because this coroutine is run in a cancellable task and cancellation is handled here
 
         try:
-            # save after X seconds of inactivity
-            await asyncio.sleep(self._save_delay)
+            # When save_now is False, wait X seconds of inactivity before saving (auto-save).
+            # When save_now is True, save immediately without debounce delay (manual save).
+            if not save_now and self._save_delay is not None:
+                await asyncio.sleep(self._save_delay)
 
             self.log.info("Saving the content from room %s", self._room_id)
             saved_model = await self._file.maybe_save_content(

jupyter_server_ydoc/stores.py

@@ -27,10 +27,17 @@ class SQLiteYStore(LoggingConfigurable, _SQLiteYStore, metaclass=SQLiteYStoreMet
         directory.""",
     )
 
-    document_ttl = Int(
+    squash_after_inactivity_of = Int(
         None,
         allow_none=True,
         config=True,
         help="""The document time-to-live in seconds. Defaults to None (document history is never
         cleared).""",
     )
+    document_ttl = Int(
+        None,
+        allow_none=True,
+        config=True,
+        help="""The document time-to-live in seconds. Deprecated in favor of 'squash_after_inactivity_of'.
+        Defaults to None (document history is never cleared).""",
+    )

jupyter_server_ydoc/test_utils.py

@@ -33,13 +33,19 @@ class FakeContentsManager:
             "mimetype": None,
             "size": 0,
             "writable": False,
+            "hash": "fake_hash",
         }
         self.model.update(model)
 
         self.actions: list[str] = []
 
     def get(
-        self, path: str, content: bool = True, format: str | None = None, type: str | None = None
+        self,
+        path: str,
+        content: bool = True,
+        format: str | None = None,
+        type: str | None = None,
+        require_hash: bool | None = None,
     ) -> dict:
         if not self.model:
             raise HTTPError(404, f"File not found: {path}")

{jupyter_server_ydoc-2.2.0a0.dist-info → jupyter_server_ydoc-2.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jupyter-server-ydoc
-Version: 2.2.0a0
+Version: 2.2.1
 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

jupyter_server_ydoc-2.2.1.dist-info/RECORD

@@ -0,0 +1,19 @@
+jupyter_server_ydoc/__init__.py,sha256=B8H7XLhzgrTCQD8304Lx91FYXslwabsnV9OuYu4M4Hw,346
+jupyter_server_ydoc/_version.py,sha256=4dqvKTDgbqeyzbWj6hYiNdzxsI8j1YOKSLM8vF6a0j4,22
+jupyter_server_ydoc/app.py,sha256=hDqOeb-CBr48ck0WGlJvjzUH_5JvKFw0Eu5FTcW_IqU,8543
+jupyter_server_ydoc/handlers.py,sha256=1ZCdwtrlqY2Q9d_A-HV2RL7-bmzcgKvF4H_6PoYoOpQ,28794
+jupyter_server_ydoc/loaders.py,sha256=M4QBLwC3RadPiVO582jNmYSspoXulEP-QjAw8fYJ358,13606
+jupyter_server_ydoc/pytest_plugin.py,sha256=cg8J0sDsJ4sfQDl_Uh73zz2sNecSY67udifXGtjYVt0,8935
+jupyter_server_ydoc/rooms.py,sha256=s8ydZk5GaCQE9tQI37mURbgqWSimbMGESwNwLhIni_0,13697
+jupyter_server_ydoc/stores.py,sha256=XW4U_8bDVjT_5ZLEtcTuINLusUeJmTTl4IuhUXDshEM,1423
+jupyter_server_ydoc/test_utils.py,sha256=fcBtZdIQ2apBh85iC1tX9dXHJkfid5-7j9xGc-BzVQQ,1769
+jupyter_server_ydoc/utils.py,sha256=_wI4CFOEZK4MSMYCZe2moSbggUTRdGxY4qTzSDEFzdE,2183
+jupyter_server_ydoc/websocketserver.py,sha256=4Pxl4EIVIz5TxzNWlSDF6KNzZVkzy5SsgvwJx0PoGtY,5099
+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.2.1.data/data/etc/jupyter/jupyter_server_config.d/jupyter_collaboration.json,sha256=0thh2hJUxAKkZSmneJMG0U6QJRjdM6zGlwrTedEt-Jk,94
+jupyter_server_ydoc-2.2.1.dist-info/METADATA,sha256=Sli3YMDmuSY-D3G1WcQp10sKTY9uab7PzBLQbq1nZqc,5571
+jupyter_server_ydoc-2.2.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+jupyter_server_ydoc-2.2.1.dist-info/licenses/LICENSE,sha256=mhO0ZW9EiWOPg0dUgB-lNbJ0CGwRmTdbeAg_se1SOnY,2833
+jupyter_server_ydoc-2.2.1.dist-info/RECORD,,

jupyter_server_ydoc-2.2.0a0.dist-info/RECORD

@@ -1,19 +0,0 @@
-jupyter_server_ydoc/__init__.py,sha256=B8H7XLhzgrTCQD8304Lx91FYXslwabsnV9OuYu4M4Hw,346
-jupyter_server_ydoc/_version.py,sha256=28LaRmloQfDtv6jpyB8JFhGWnl0P7q_winpQ_MJXoTw,25
-jupyter_server_ydoc/app.py,sha256=hDqOeb-CBr48ck0WGlJvjzUH_5JvKFw0Eu5FTcW_IqU,8543
-jupyter_server_ydoc/handlers.py,sha256=1ZCdwtrlqY2Q9d_A-HV2RL7-bmzcgKvF4H_6PoYoOpQ,28794
-jupyter_server_ydoc/loaders.py,sha256=fnlxbj-TowKUsB0zAwgnz3S999pjuy-K-Au5u9oespM,13609
-jupyter_server_ydoc/pytest_plugin.py,sha256=wpRsCss-TxgCeo8zqJru-YsKflfCGG-T2dbhcfQtMeY,8746
-jupyter_server_ydoc/rooms.py,sha256=dKronZ09LeXS7B5zLQwT6JMbsat75C22-MTg1tjbIq4,13086
-jupyter_server_ydoc/stores.py,sha256=9gI37OttJT17waClyDWssm7jtxCAXIcUHY7rc154OTk,1146
-jupyter_server_ydoc/test_utils.py,sha256=pD4gP44O7le-PSis7qQoVAKRJvutDOmav-wHRiHs4_U,1661
-jupyter_server_ydoc/utils.py,sha256=_wI4CFOEZK4MSMYCZe2moSbggUTRdGxY4qTzSDEFzdE,2183
-jupyter_server_ydoc/websocketserver.py,sha256=4Pxl4EIVIz5TxzNWlSDF6KNzZVkzy5SsgvwJx0PoGtY,5099
-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.2.0a0.data/data/etc/jupyter/jupyter_server_config.d/jupyter_collaboration.json,sha256=0thh2hJUxAKkZSmneJMG0U6QJRjdM6zGlwrTedEt-Jk,94
-jupyter_server_ydoc-2.2.0a0.dist-info/METADATA,sha256=wUgQm7OktX0JPiLodZ4OVK_IbU3ka-wROip6ddSyMuE,5573
-jupyter_server_ydoc-2.2.0a0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-jupyter_server_ydoc-2.2.0a0.dist-info/licenses/LICENSE,sha256=mhO0ZW9EiWOPg0dUgB-lNbJ0CGwRmTdbeAg_se1SOnY,2833
-jupyter_server_ydoc-2.2.0a0.dist-info/RECORD,,