jupyter-server-ydoc 1.0.0rc1__tar.gz → 1.0.1__tar.gz

{jupyter_server_ydoc-1.0.0rc1 → jupyter_server_ydoc-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: jupyter-server-ydoc
-Version: 1.0.0rc1
+Version: 1.0.1
 Summary: jupyter-server extension integrating collaborative shared models.
 Author-email: Jupyter Development Team <jupyter@googlegroups.com>
 License: # Licensing terms
@@ -62,7 +62,6 @@ License: # Licensing terms
         
             # Copyright (c) Jupyter Development Team.
             # Distributed under the terms of the Modified BSD License.
-License-File: LICENSE
 Classifier: Framework :: Jupyter
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
@@ -83,13 +82,14 @@ Requires-Dist: jupyter-ydoc<4.0.0,>=2.1.2
 Requires-Dist: pycrdt
 Requires-Dist: pycrdt-websocket<0.16.0,>=0.15.0
 Provides-Extra: test
+Requires-Dist: anyio; extra == 'test'
 Requires-Dist: coverage; extra == 'test'
+Requires-Dist: httpx-ws>=0.5.2; extra == 'test'
 Requires-Dist: importlib-metadata>=4.8.3; (python_version < '3.10') and extra == 'test'
 Requires-Dist: jupyter-server-fileid[test]; extra == 'test'
 Requires-Dist: jupyter-server[test]>=2.4.0; extra == 'test'
 Requires-Dist: pytest-cov; extra == 'test'
 Requires-Dist: pytest>=7.0; extra == 'test'
-Requires-Dist: websockets; extra == 'test'
 Description-Content-Type: text/markdown
 
 # jupyter-server-ydoc

jupyter_server_ydoc-1.0.1/jupyter_server_ydoc/_version.py

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

{jupyter_server_ydoc-1.0.0rc1 → jupyter_server_ydoc-1.0.1}/jupyter_server_ydoc/pytest_plugin.py

@@ -9,14 +9,19 @@ from typing import Any
 
 import nbformat
 import pytest
+from httpx_ws import aconnect_ws
 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 websockets import connect
 
-from .test_utils import FakeContentsManager, FakeEventLogger, FakeFileIDManager
+from .test_utils import (
+    FakeContentsManager,
+    FakeEventLogger,
+    FakeFileIDManager,
+    Websocket,
+)
 
 
 @pytest.fixture
@@ -126,8 +131,8 @@ def rtc_fetch_session(jp_fetch):
 @pytest.fixture
 def rtc_connect_awareness_client(jp_http_port, jp_base_url):
     async def _inner(room_id: str) -> Any:
-        return connect(
-            f"ws://127.0.0.1:{jp_http_port}{jp_base_url}api/collaboration/room/{room_id}"
+        return aconnect_ws(
+            f"http://127.0.0.1:{jp_http_port}{jp_base_url}api/collaboration/room/{room_id}"
         )
 
     return _inner
@@ -138,8 +143,12 @@ def rtc_connect_doc_client(jp_http_port, jp_base_url, rtc_fetch_session):
     async def _inner(format: str, type: str, path: str) -> Any:
         resp = await rtc_fetch_session(format, type, path)
         data = json.loads(resp.body.decode("utf-8"))
-        return connect(
-            f"ws://127.0.0.1:{jp_http_port}{jp_base_url}api/collaboration/room/{data['format']}:{data['type']}:{data['fileId']}?sessionId={data['sessionId']}"
+        room_name = f"{data['format']}:{data['type']}:{data['fileId']}"
+        return (
+            aconnect_ws(
+                f"http://127.0.0.1:{jp_http_port}{jp_base_url}api/collaboration/room/{room_name}?sessionId={data['sessionId']}"
+            ),
+            room_name,
         )
 
     return _inner
@@ -162,9 +171,8 @@ def rtc_add_doc_to_store(rtc_connect_doc_client):
 
         doc.observe(_on_document_change)
 
-        async with await rtc_connect_doc_client(format, type, path) as ws, WebsocketProvider(
-            doc.ydoc, ws
-        ):
+        websocket, room_name = await rtc_connect_doc_client(format, type, path)
+        async with websocket as ws, WebsocketProvider(doc.ydoc, Websocket(ws, room_name)):
             await event.wait()
             await sleep(0.1)
 

{jupyter_server_ydoc-1.0.0rc1 → jupyter_server_ydoc-1.0.1}/jupyter_server_ydoc/test_utils.py

@@ -6,6 +6,7 @@ from __future__ import annotations
 from datetime import datetime
 from typing import Any
 
+from anyio import Lock
 from jupyter_server import _tz as tz
 
 
@@ -55,3 +56,32 @@ 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-1.0.0rc1 → jupyter_server_ydoc-1.0.1}/pyproject.toml

@@ -45,7 +45,8 @@ test = [
     "jupyter_server_fileid[test]",
     "pytest>=7.0",
     "pytest-cov",
-    "websockets",
+    "anyio",
+    "httpx-ws >=0.5.2",
     "importlib_metadata >=4.8.3; python_version<'3.10'",
 ]
 

{jupyter_server_ydoc-1.0.0rc1 → jupyter_server_ydoc-1.0.1}/tests/test_documents.py

@@ -11,6 +11,7 @@ else:
 
 import pytest
 from anyio import create_task_group, sleep
+from jupyter_server_ydoc.test_utils import Websocket
 from pycrdt_websocket import WebsocketProvider
 
 jupyter_ydocs = {ep.name: ep.load() for ep in entry_points(group="jupyter_ydoc")}
@@ -32,12 +33,12 @@ async def test_dirty(
     await rtc_create_file(file_path)
     jupyter_ydoc = jupyter_ydocs[file_type]()
 
-    async with await rtc_connect_doc_client(file_format, file_type, file_path) as ws:
-        async with WebsocketProvider(jupyter_ydoc.ydoc, ws):
-            for _ in range(2):
-                jupyter_ydoc.dirty = True
-                await sleep(rtc_document_save_delay * 1.5)
-                assert not jupyter_ydoc.dirty
+    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)):
+        for _ in range(2):
+            jupyter_ydoc.dirty = True
+            await sleep(rtc_document_save_delay * 1.5)
+            assert not jupyter_ydoc.dirty
 
 
 async def cleanup(jp_serverapp):
@@ -59,7 +60,8 @@ async def test_room_concurrent_initialization(
     await rtc_create_file(file_path)
 
     async def connect(file_format, file_type, file_path):
-        async with await rtc_connect_doc_client(file_format, file_type, file_path) as ws:
+        websocket, room_name = await rtc_connect_doc_client(file_format, file_type, file_path)
+        async with websocket:
             pass
 
     t0 = time()
@@ -84,7 +86,8 @@ async def test_room_sequential_opening(
 
     async def connect(file_format, file_type, file_path):
         t0 = time()
-        async with await rtc_connect_doc_client(file_format, file_type, file_path) as ws:
+        websocket, room_name = await rtc_connect_doc_client(file_format, file_type, file_path)
+        async with websocket:
             pass
         t1 = time()
         return t1 - t0

{jupyter_server_ydoc-1.0.0rc1 → jupyter_server_ydoc-1.0.1}/tests/test_handlers.py

@@ -8,6 +8,7 @@ from asyncio import Event, sleep
 from typing import Any
 
 from jupyter_events.logger import EventLogger
+from jupyter_server_ydoc.test_utils import Websocket
 from jupyter_ydoc import YUnicode
 from pycrdt_websocket import WebsocketProvider
 
@@ -77,9 +78,8 @@ async def test_room_handler_doc_client_should_connect(rtc_create_file, rtc_conne
     doc = YUnicode()
     doc.observe(_on_document_change)
 
-    async with await rtc_connect_doc_client("text", "file", path) as ws, WebsocketProvider(
-        doc.ydoc, ws
-    ):
+    websocket, room_name = await rtc_connect_doc_client("text", "file", path)
+    async with websocket as ws, WebsocketProvider(doc.ydoc, Websocket(ws, room_name)):
         await event.wait()
         await sleep(0.1)
 
@@ -114,9 +114,8 @@ async def test_room_handler_doc_client_should_emit_awareness_event(
         listener=my_listener,
     )
 
-    async with await rtc_connect_doc_client("text", "file", path) as ws, WebsocketProvider(
-        doc.ydoc, ws
-    ):
+    websocket, room_name = await rtc_connect_doc_client("text", "file", path)
+    async with websocket as ws, WebsocketProvider(doc.ydoc, Websocket(ws, room_name)):
         await event.wait()
         await sleep(0.1)
 
@@ -147,9 +146,8 @@ async def test_room_handler_doc_client_should_cleanup_room_file(
     doc = YUnicode()
     doc.observe(_on_document_change)
 
-    async with await rtc_connect_doc_client("text", "file", path) as ws, WebsocketProvider(
-        doc.ydoc, ws
-    ):
+    websocket, room_name = await rtc_connect_doc_client("text", "file", path)
+    async with websocket as ws, WebsocketProvider(doc.ydoc, Websocket(ws, room_name)):
         await event.wait()
         await sleep(0.1)
 
@@ -173,18 +171,16 @@ async def test_room_handler_doc_client_should_cleanup_room_file(
     path2, _ = await rtc_create_file("test2.txt", "test2")
 
     try:
-        async with await rtc_connect_doc_client("text2", "file2", path2) as ws, WebsocketProvider(
-            doc.ydoc, ws
-        ):
+        websocket, room_name = await rtc_connect_doc_client("text2", "file2", path2)
+        async with websocket as ws, WebsocketProvider(doc.ydoc, Websocket(ws, room_name)):
             await event.wait()
             await sleep(0.1)
     except Exception:
         pass
 
     try:
-        async with await rtc_connect_doc_client("text2", "file2", path2) as ws, WebsocketProvider(
-            doc.ydoc, ws
-        ):
+        websocket, room_name = await rtc_connect_doc_client("text2", "file2", path2)
+        async with websocket as ws, WebsocketProvider(doc.ydoc, Websocket(ws, room_name)):
             await event.wait()
             await sleep(0.1)
     except Exception:

jupyter_server_ydoc-1.0.0rc1/jupyter_server_ydoc/_version.py

@@ -1 +0,0 @@
-__version__ = "1.0.0rc1"