jupyter-server-ydoc 2.1.0rc0__tar.gz → 2.1.1__tar.gz

{jupyter_server_ydoc-2.1.0rc0 → jupyter_server_ydoc-2.1.1}/PKG-INFO

@@ -1,7 +1,12 @@
 Metadata-Version: 2.4
 Name: jupyter-server-ydoc
-Version: 2.1.0rc0
+Version: 2.1.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
+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
         
@@ -79,9 +84,9 @@ Requires-Dist: jsonschema>=4.18.0
 Requires-Dist: jupyter-events>=0.11.0
 Requires-Dist: jupyter-server-fileid<1,>=0.7.0
 Requires-Dist: jupyter-server<3.0.0,>=2.15.0
-Requires-Dist: jupyter-ydoc!=3.0.0,!=3.0.1,<4.0.0,>=2.1.2
+Requires-Dist: jupyter-ydoc<4.0.0,>=3.0.3
 Requires-Dist: pycrdt
-Requires-Dist: pycrdt-websocket<0.16.0,>=0.15.0
+Requires-Dist: pycrdt-websocket<0.17.0,>=0.16.0
 Provides-Extra: test
 Requires-Dist: anyio; extra == 'test'
 Requires-Dist: coverage; extra == 'test'

jupyter_server_ydoc-2.1.1/jupyter_server_ydoc/_version.py

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

{jupyter_server_ydoc-2.1.0rc0 → jupyter_server_ydoc-2.1.1}/jupyter_server_ydoc/app.py

@@ -10,7 +10,7 @@ from jupyter_server.extension.application import ExtensionApp
 from jupyter_ydoc import ydocs as YDOCS
 from jupyter_ydoc.ybasedoc import YBaseDoc
 from pycrdt import Doc
-from pycrdt_websocket.ystore import BaseYStore
+from pycrdt.store import BaseYStore
 from traitlets import Bool, Float, Type
 
 from .handlers import (

{jupyter_server_ydoc-2.1.0rc0 → jupyter_server_ydoc-2.1.1}/jupyter_server_ydoc/handlers.py

@@ -15,9 +15,9 @@ 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_websocket.yroom import YRoom
-from pycrdt_websocket.ystore import BaseYStore
+from pycrdt import Doc, Encoder, UndoManager
+from pycrdt.store import BaseYStore
+from pycrdt.websocket import YRoom
 from tornado import web
 from tornado.websocket import WebSocketHandler
 
@@ -120,7 +120,7 @@ class YDocWebSocketHandler(WebSocketHandler, JupyterHandler):
                     updates_file_path = f".{file_type}:{file_id}.y"
                     ystore = self._ystore_class(
                         path=updates_file_path,
-                        log=self.log,  # type:ignore[call-arg]
+                        log=self.log,
                     )
                     self.room = DocumentRoom(
                         self._room_id,
@@ -273,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.
         """
@@ -299,16 +299,38 @@ class YDocWebSocketHandler(WebSocketHandler, JupyterHandler):
         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)
-                    room._save_to_disc()
+                    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-2.1.0rc0 → jupyter_server_ydoc-2.1.1}/jupyter_server_ydoc/pytest_plugin.py

@@ -14,13 +14,13 @@ from jupyter_server_ydoc.loaders import FileLoader
 from jupyter_server_ydoc.rooms import DocumentRoom
 from jupyter_server_ydoc.stores import SQLiteYStore
 from jupyter_ydoc import YNotebook, YUnicode
-from pycrdt_websocket import WebsocketProvider
+from pycrdt import Provider
+from pycrdt.websocket.websocket import HttpxWebsocket
 
 from .test_utils import (
     FakeContentsManager,
     FakeEventLogger,
     FakeFileIDManager,
-    Websocket,
 )
 
 
@@ -231,7 +231,7 @@ def rtc_add_doc_to_store(rtc_connect_doc_client):
         doc.observe(_on_document_change)
 
         websocket, room_name = await rtc_connect_doc_client(format, type, path)
-        async with websocket as ws, WebsocketProvider(doc.ydoc, Websocket(ws, room_name)):
+        async with websocket as ws, Provider(doc.ydoc, HttpxWebsocket(ws, room_name)):
             await event.wait()
             await sleep(0.1)
 
@@ -243,7 +243,7 @@ def rtc_create_SQLite_store_factory(jp_serverapp):
         db = SQLiteYStore(
             path=f"{type}:{path}",
             # `SQLiteYStore` here is a subclass of booth `LoggingConfigurable`
-            # and `pycrdt_websocket.ystore.SQLiteYStore`, but mypy gets lost:
+            # and `pycrdt.store.SQLiteYStore`, but mypy gets lost:
             config=jp_serverapp.config,  # type:ignore[call-arg]
         )
         _ = create_task(db.start())

{jupyter_server_ydoc-2.1.0rc0 → jupyter_server_ydoc-2.1.1}/jupyter_server_ydoc/rooms.py

@@ -9,8 +9,8 @@ from typing import Any, Callable
 
 from jupyter_events import EventLogger
 from jupyter_ydoc import ydocs as YDOCS
-from pycrdt_websocket.yroom import YRoom
-from pycrdt_websocket.ystore import BaseYStore, YDocNotFound
+from pycrdt.websocket import YRoom
+from pycrdt.store import BaseYStore, YDocNotFound
 
 from .loaders import FileLoader
 from .utils import JUPYTER_COLLABORATION_EVENTS_URI, LogLevel, OutOfBandChanges
@@ -280,6 +280,7 @@ class DocumentRoom(YRoom):
         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:
         """

{jupyter_server_ydoc-2.1.0rc0 → jupyter_server_ydoc-2.1.1}/jupyter_server_ydoc/stores.py

@@ -1,8 +1,8 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
-from pycrdt_websocket.ystore import SQLiteYStore as _SQLiteYStore
-from pycrdt_websocket.ystore import TempFileYStore as _TempFileYStore
+from pycrdt.store import SQLiteYStore as _SQLiteYStore
+from pycrdt.store import TempFileYStore as _TempFileYStore
 from traitlets import Int, Unicode
 from traitlets.config import LoggingConfigurable
 

{jupyter_server_ydoc-2.1.0rc0 → jupyter_server_ydoc-2.1.1}/jupyter_server_ydoc/test_utils.py

@@ -6,7 +6,6 @@ from __future__ import annotations
 from datetime import datetime
 from typing import Any
 
-from anyio import Lock
 from jupyter_server import _tz as tz
 
 
@@ -56,32 +55,3 @@ class FakeContentsManager:
 class FakeEventLogger:
     def emit(self, schema_id: str, data: dict) -> None:
         print(data)
-
-
-class Websocket:
-    def __init__(self, websocket: Any, path: str):
-        self._websocket = websocket
-        self._path = path
-        self._send_lock = Lock()
-
-    @property
-    def path(self) -> str:
-        return self._path
-
-    def __aiter__(self):
-        return self
-
-    async def __anext__(self) -> bytes:
-        try:
-            message = await self.recv()
-        except Exception:
-            raise StopAsyncIteration()
-        return message
-
-    async def send(self, message: bytes) -> None:
-        async with self._send_lock:
-            await self._websocket.send_bytes(message)
-
-    async def recv(self) -> bytes:
-        b = await self._websocket.receive_bytes()
-        return bytes(b)

{jupyter_server_ydoc-2.1.0rc0 → jupyter_server_ydoc-2.1.1}/jupyter_server_ydoc/websocketserver.py

@@ -7,10 +7,9 @@ import asyncio
 from logging import Logger
 from typing import Any, Callable
 
-from pycrdt_websocket.websocket import Websocket
-from pycrdt_websocket.websocket_server import WebsocketServer
-from pycrdt_websocket.yroom import YRoom
-from pycrdt_websocket.ystore import BaseYStore
+from pycrdt import Channel
+from pycrdt.store import BaseYStore
+from pycrdt.websocket import WebsocketServer, YRoom
 
 
 class RoomNotFound(LookupError):
@@ -133,7 +132,7 @@ class JupyterWebsocketServer(WebsocketServer):
         await self.start_room(room)
         return room
 
-    async def serve(self, websocket: Websocket) -> None:
+    async def serve(self, websocket: Channel) -> None:
         # start monitoring here as the event loop is not yet available when initializing the object
         if self.monitor_task is None:
             self.monitor_task = asyncio.create_task(self._monitor())

{jupyter_server_ydoc-2.1.0rc0 → jupyter_server_ydoc-2.1.1}/pyproject.toml

@@ -29,15 +29,22 @@ authors = [
 ]
 dependencies = [
     "jupyter_server>=2.15.0,<3.0.0",
-    "jupyter_ydoc>=2.1.2,<4.0.0,!=3.0.0,!=3.0.1",
+    "jupyter_ydoc>=3.0.3,<4.0.0",
     "pycrdt",
-    "pycrdt-websocket>=0.15.0,<0.16.0",
+    "pycrdt-websocket>=0.16.0,<0.17.0",
     "jupyter_events>=0.11.0",
     "jupyter_server_fileid>=0.7.0,<1",
     "jsonschema>=4.18.0"
 ]
 dynamic = ["version"]
 
+[project.urls]
+Documentation = "https://jupyterlab-realtime-collaboration.readthedocs.io/"
+Repository = "https://github.com/jupyterlab/jupyter-collaboration"
+Changelog = "https://jupyterlab-realtime-collaboration.readthedocs.io/en/latest/changelog.html"
+Source = "https://github.com/jupyterlab/jupyter-collaboration/tree/main/projects/jupyter-server-ydoc"
+Issues = "https://github.com/jupyterlab/jupyter-collaboration/issues/new/choose"
+
 [project.optional-dependencies]
 test = [
     "coverage",

{jupyter_server_ydoc-2.1.0rc0 → jupyter_server_ydoc-2.1.1}/tests/test_documents.py

@@ -11,8 +11,8 @@ else:
 
 import pytest
 from anyio import create_task_group, sleep
-from jupyter_server_ydoc.test_utils import Websocket
-from pycrdt_websocket import WebsocketProvider
+from pycrdt import Provider
+from pycrdt.websocket.websocket import HttpxWebsocket
 
 jupyter_ydocs = {ep.name: ep.load() for ep in entry_points(group="jupyter_ydoc")}
 
@@ -34,7 +34,7 @@ async def test_dirty(
     jupyter_ydoc = jupyter_ydocs[file_type]()
 
     websocket, room_name = await rtc_connect_doc_client(file_format, file_type, file_path)
-    async with websocket as ws, WebsocketProvider(jupyter_ydoc.ydoc, Websocket(ws, room_name)):
+    async with websocket as ws, Provider(jupyter_ydoc.ydoc, HttpxWebsocket(ws, room_name)):
         for _ in range(2):
             jupyter_ydoc.dirty = True
             await sleep(rtc_document_save_delay * 1.5)

{jupyter_server_ydoc-2.1.0rc0 → jupyter_server_ydoc-2.1.1}/tests/test_handlers.py

@@ -9,10 +9,9 @@ from typing import Any
 
 from dirty_equals import IsStr
 from jupyter_events.logger import EventLogger
-from jupyter_server_ydoc.test_utils import Websocket
 from jupyter_ydoc import YUnicode
-from pycrdt import Text
-from pycrdt_websocket import WebsocketProvider
+from pycrdt import Text, Provider
+from pycrdt.websocket.websocket import HttpxWebsocket
 
 
 async def test_session_handler_should_create_session_id(
@@ -81,7 +80,7 @@ async def test_room_handler_doc_client_should_connect(rtc_create_file, rtc_conne
     doc.observe(_on_document_change)
 
     websocket, room_name = await rtc_connect_doc_client("text", "file", path)
-    async with websocket as ws, WebsocketProvider(doc.ydoc, Websocket(ws, room_name)):
+    async with websocket as ws, Provider(doc.ydoc, HttpxWebsocket(ws, room_name)):
         await event.wait()
         await sleep(0.1)
 
@@ -117,7 +116,7 @@ async def test_room_handler_doc_client_should_emit_awareness_event(
     )
 
     websocket, room_name = await rtc_connect_doc_client("text", "file", path)
-    async with websocket as ws, WebsocketProvider(doc.ydoc, Websocket(ws, room_name)):
+    async with websocket as ws, Provider(doc.ydoc, HttpxWebsocket(ws, room_name)):
         await event.wait()
         await sleep(0.1)
 
@@ -149,7 +148,7 @@ async def test_room_handler_doc_client_should_cleanup_room_file(
     doc.observe(_on_document_change)
 
     websocket, room_name = await rtc_connect_doc_client("text", "file", path)
-    async with websocket as ws, WebsocketProvider(doc.ydoc, Websocket(ws, room_name)):
+    async with websocket as ws, Provider(doc.ydoc, HttpxWebsocket(ws, room_name)):
         await event.wait()
         await sleep(0.1)
 
@@ -174,7 +173,7 @@ async def test_room_handler_doc_client_should_cleanup_room_file(
 
     try:
         websocket, room_name = await rtc_connect_doc_client("text2", "file2", path2)
-        async with websocket as ws, WebsocketProvider(doc.ydoc, Websocket(ws, room_name)):
+        async with websocket as ws, Provider(doc.ydoc, HttpxWebsocket(ws, room_name)):
             await event.wait()
             await sleep(0.1)
     except Exception:
@@ -182,7 +181,7 @@ async def test_room_handler_doc_client_should_cleanup_room_file(
 
     try:
         websocket, room_name = await rtc_connect_doc_client("text2", "file2", path2)
-        async with websocket as ws, WebsocketProvider(doc.ydoc, Websocket(ws, room_name)):
+        async with websocket as ws, Provider(doc.ydoc, HttpxWebsocket(ws, room_name)):
             await event.wait()
             await sleep(0.1)
     except Exception:
@@ -253,7 +252,7 @@ async def test_fork_handler(
     root_roomid = f"text:file:{file_id}"
 
     websocket, room_name = await rtc_connect_doc_client("text", "file", path)
-    async with websocket as ws, WebsocketProvider(root_ydoc.ydoc, Websocket(ws, room_name)):
+    async with websocket as ws, Provider(root_ydoc.ydoc, HttpxWebsocket(ws, room_name)):
         await root_connect_event.wait()
 
         resp = await rtc_create_fork_client(root_roomid, False, "my fork0", "is awesome0")
@@ -316,8 +315,8 @@ async def test_fork_handler(
         fork_ydoc.observe(_on_fork_change)
         fork_text = fork_ydoc.ydoc.get("source", type=Text)
 
-        async with await rtc_connect_fork_client(fork_roomid1) as ws, WebsocketProvider(
-            fork_ydoc.ydoc, Websocket(ws, fork_roomid1)
+        async with await rtc_connect_fork_client(fork_roomid1) as ws, Provider(
+            fork_ydoc.ydoc, HttpxWebsocket(ws, fork_roomid1)
         ):
             await fork_connect_event.wait()
             root_text = root_ydoc.ydoc.get("source", type=Text)

jupyter_server_ydoc-2.1.0rc0/jupyter_server_ydoc/_version.py

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