jupyverse 0.10.5__tar.gz → 0.10.7__tar.gz

{jupyverse-0.10.5 → jupyverse-0.10.7}/.github/workflows/test.yml

@@ -29,12 +29,7 @@ jobs:
         python3 -m pip install hatch
     - name: Check types
       run: |
-        hatch run dev.jupyterlab-noauth:typecheck
-        hatch run dev.jupyterlab-auth:typecheck
-        hatch run dev.jupyterlab-auth_fief:typecheck
-        hatch run dev.notebook-noauth:typecheck
-        hatch run dev.notebook-auth:typecheck
-        hatch run dev.notebook-auth_fief:typecheck
+        hatch run dev:typecheck
 
   test:
     name: Tests
@@ -59,8 +54,5 @@ jobs:
         python3 -m pip install --upgrade pip
         python3 -m pip install hatch
 
-    - name: Create jupyterlab-auth dev environment
-      run: hatch env create dev.jupyterlab-auth
-
     - name: Run tests
-      run: hatch run dev.jupyterlab-auth:test
+      run: hatch run dev:test

{jupyverse-0.10.5 → jupyverse-0.10.7}/.pre-commit-config.yaml

@@ -16,7 +16,7 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.12.4
+    rev: v0.12.5
     hooks:
       - id: ruff
         args: ["--fix"]

{jupyverse-0.10.5 → jupyverse-0.10.7}/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Version history
 
+## 0.10.7
+
+- Lock on collaboration room cleanup.
+- Move `ASGIWebSocketTransport` to `jupyverse_api`.
+
+## 0.10.6
+
+- Bump `fps >=0.5.1`.
+- Support stopping `fps-kernel-web-worker`.
+
 ## 0.10.5
 
 - Add `fps-kernel-web-worker` plugin.

{jupyverse-0.10.5 → jupyverse-0.10.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jupyverse
-Version: 0.10.5
+Version: 0.10.7
 Summary: A set of FPS plugins implementing a Jupyter server
 Project-URL: Homepage, https://jupyter.org
 Author-email: Jupyter Development Team <jupyter@googlegroups.com>
@@ -10,16 +10,16 @@ Keywords: fastapi,jupyter,plugins,server
 Requires-Python: >=3.9
 Requires-Dist: eval-type-backport; python_version < '3.10'
 Requires-Dist: fps-contents<0.11.0,>=0.10.0
-Requires-Dist: fps-file-id<0.3.0,>=0.2.0
+Requires-Dist: fps-file-id<0.3.0,>=0.2.1
 Requires-Dist: fps-frontend<0.10.0,>=0.9.0
 Requires-Dist: fps-kernel-subprocess<0.2.0,>=0.1.1
 Requires-Dist: fps-kernels<0.10.0,>=0.9.1
 Requires-Dist: fps-lab<0.10.0,>=0.9.0
 Requires-Dist: fps-nbconvert<0.10.0,>=0.9.0
 Requires-Dist: fps-terminals<0.10.0,>=0.9.0
-Requires-Dist: fps-yjs<0.11.0,>=0.10.1
-Requires-Dist: fps[anycorn,click,fastapi]<0.5.0,>=0.4.0
-Requires-Dist: jupyverse-api<0.11.0,>=0.10.1
+Requires-Dist: fps-yjs<0.11.0,>=0.10.2
+Requires-Dist: fps[anycorn,click,fastapi]<0.6.0,>=0.5.1
+Requires-Dist: jupyverse-api<0.11.0,>=0.10.3
 Requires-Dist: rich-click<2,>=1.6.1
 Provides-Extra: auth
 Requires-Dist: fps-auth<0.10.0,>=0.9.0; extra == 'auth'
@@ -27,14 +27,14 @@ Requires-Dist: fps-login<0.10.0,>=0.9.0; extra == 'auth'
 Provides-Extra: auth-fief
 Requires-Dist: fps-auth-fief<0.10.0,>=0.9.0; extra == 'auth-fief'
 Provides-Extra: auth-jupyterhub
-Requires-Dist: fps-auth-jupyterhub<0.10.0,>=0.9.0; extra == 'auth-jupyterhub'
+Requires-Dist: fps-auth-jupyterhub<0.10.0,>=0.9.1; extra == 'auth-jupyterhub'
 Provides-Extra: docs
 Requires-Dist: mkdocs; extra == 'docs'
 Requires-Dist: mkdocs-material; extra == 'docs'
 Provides-Extra: jupyterlab
 Requires-Dist: fps-jupyterlab<0.10.0,>=0.9.0; extra == 'jupyterlab'
 Provides-Extra: noauth
-Requires-Dist: fps-noauth<0.10.0,>=0.9.0; extra == 'noauth'
+Requires-Dist: fps-noauth<0.10.0,>=0.9.1; extra == 'noauth'
 Provides-Extra: notebook
 Requires-Dist: fps-notebook<0.10.0,>=0.9.0; extra == 'notebook'
 Provides-Extra: test
@@ -44,7 +44,6 @@ Requires-Dist: ipykernel; extra == 'test'
 Requires-Dist: mypy; extra == 'test'
 Requires-Dist: pytest; extra == 'test'
 Requires-Dist: pytest-env; extra == 'test'
-Requires-Dist: pytest-rerunfailures; extra == 'test'
 Requires-Dist: pytest-timeout; extra == 'test'
 Requires-Dist: requests; extra == 'test'
 Requires-Dist: ruff>=0.1.2; extra == 'test'

jupyverse-0.10.5/tests/utils.py → jupyverse-0.10.7/jupyverse_api/jupyverse_api/asgi_websocket_transport.py

@@ -2,155 +2,14 @@ import contextlib
 import queue
 import typing
 from types import TracebackType
-from typing import Optional
-from uuid import uuid4
 
 import anyio
 import wsproto
-from anyio import Lock
 from httpcore import AsyncNetworkStream
 from httpx import ASGITransport, AsyncByteStream, Request, Response
 from httpx_ws._exceptions import WebSocketDisconnect
 from wsproto.frame_protocol import CloseReason
 
-
-async def authenticate_client(http, port, permissions={}):
-    # create a new user
-    username = uuid4().hex
-    # if logged in, log out
-    first_time = True
-    while True:
-        response = await http.get(f"http://127.0.0.1:{port}/api/me")
-        if response.status_code == 403:
-            break
-        assert first_time
-        response = await http.post(f"http://127.0.0.1:{port}/auth/logout")
-        assert response.status_code == 200
-        first_time = False
-
-    # register user
-    register_body = {
-        "email": f"{username}@example.com",
-        "password": username,
-        "username": username,
-        "permissions": permissions,
-    }
-    response = await http.post(f"http://127.0.0.1:{port}/auth/register", json=register_body)
-    # check that we cannot register if not logged in
-    assert response.status_code == 403
-    # log in as admin
-    login_body = {"username": "admin@jupyter.com", "password": "jupyverse"}
-    response = await http.post(f"http://127.0.0.1:{port}/auth/login", data=login_body)
-    assert response.status_code == 204
-    # register user
-    response = await http.post(f"http://127.0.0.1:{port}/auth/register", json=register_body)
-    assert response.status_code == 201
-
-    # log out
-    response = await http.post(f"http://127.0.0.1:{port}/auth/logout")
-    assert response.status_code == 204
-    # check that we can't get our identity, since we're not logged in
-    response = await http.get(f"http://127.0.0.1:{port}/api/me")
-    assert response.status_code == 403
-
-    # log in with registered user
-    login_body = {"username": f"{username}@example.com", "password": username}
-    response = await http.post(f"http://127.0.0.1:{port}/auth/login", data=login_body)
-    assert response.status_code == 204
-    # we should now have a cookie
-    assert "fastapiusersauth" in http.cookies
-    # check our identity, since we're logged in
-    response = await http.get(
-        f"http://127.0.0.1:{port}/api/me", params={"permissions": permissions}
-    )
-    assert response.status_code == 200
-    me = response.json()
-    assert me["identity"]["username"] == username
-    # check our permissions
-    assert me["permissions"] == permissions
-
-
-def create_content(
-    content: Optional[list],
-    type: str,
-    size: Optional[int],
-    mimetype: Optional[str],
-    name: str,
-    path: str,
-    format: Optional[str],
-) -> dict:
-    return {
-        "content": content,
-        "created": None,
-        "format": format,
-        "last_modified": None,
-        "mimetype": mimetype,
-        "name": name,
-        "path": path,
-        "size": size,
-        "type": type,
-        "writable": True,
-    }
-
-
-def clear_content_values(content: dict, keys: list[str] = []):
-    for k in content:
-        if k in keys:
-            content[k] = None
-        if k == "content" and isinstance(content[k], list):
-            for c in content[k]:
-                clear_content_values(c, keys)
-    return content
-
-
-def sort_content_by_name(content: dict):
-    for k in content:
-        if k == "content" and isinstance(content[k], list):
-            # FIXME: this sorting algorithm is terrible!
-            names = [c["name"] for c in content[k]]
-            names.sort()
-            new_content = []
-            for name in names:
-                for i, c in enumerate(content[k]):
-                    if c["name"] == name:
-                        break
-                content[k].pop(i)
-                new_content.append(c)
-            content[k] = new_content
-            for c in content[k]:
-                sort_content_by_name(c)
-    return content
-
-
-class Websocket:
-    def __init__(self, websocket, 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):
-        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)
-
-
 Scope = dict[str, typing.Any]
 Message = dict[str, typing.Any]
 Receive = typing.Callable[[], typing.Awaitable[Message]]

{jupyverse-0.10.5 → jupyverse-0.10.7}/jupyverse_api/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "jupyverse_api"
-version = "0.10.1"
+version = "0.10.3"
 description = "The public API for Jupyverse"
 readme = "README.md"
 requires-python = ">=3.9"
@@ -29,7 +29,7 @@ dependencies = [
   "importlib_metadata >=3.6; python_version<'3.10'",
   "pydantic >=2,<3",
   "fastapi >=0.95.0,<1",
-  "fps >=0.4.0,<0.5.0",
+  "fps >=0.5.1,<0.6.0",
   "anyio >=3.6.2,<5",
 ]
 

{jupyverse-0.10.5 → jupyverse-0.10.7}/jupyverse_api/tests/test_resource_lock.py

@@ -10,7 +10,7 @@ async def do_op(operation, resource_lock, operations):
     op, path = operation
     async with resource_lock(path):
         operations.append(operation + ["start"])
-        await sleep(0.1)
+        await sleep(0.5)
         operations.append(operation + ["done"])
 
 
@@ -22,7 +22,7 @@ async def test_resource_lock():
     operations = []
     async with create_task_group() as tg:
         tg.start_soon(do_op, [0, idx], resource_lock, operations)
-        await sleep(0.01)
+        await sleep(0.05)
         tg.start_soon(do_op, [1, idx], resource_lock, operations)
 
     assert operations == [
@@ -38,11 +38,11 @@ async def test_resource_lock():
     operations = []
     async with create_task_group() as tg:
         tg.start_soon(do_op, [0, idx0], resource_lock, operations)
-        await sleep(0.01)
+        await sleep(0.05)
         tg.start_soon(do_op, [1, idx1], resource_lock, operations)
-        await sleep(0.01)
+        await sleep(0.05)
         tg.start_soon(do_op, [2, idx0], resource_lock, operations)
-        await sleep(0.01)
+        await sleep(0.05)
         tg.start_soon(do_op, [3, idx1], resource_lock, operations)
 
     assert operations == [

{jupyverse-0.10.5 → jupyverse-0.10.7}/plugins/auth_jupyterhub/fps_auth_jupyterhub/routes.py

@@ -12,8 +12,8 @@ from anyio.abc import TaskStatus
 from fastapi import APIRouter, Cookie, Depends, HTTPException, Request, WebSocket, status
 from fastapi.responses import RedirectResponse
 from httpx import AsyncClient
-from jupyterhub.services.auth import HubOAuth
-from jupyterhub.utils import isoformat
+from jupyterhub.services.auth import HubOAuth  # type: ignore[import-untyped]
+from jupyterhub.utils import isoformat  # type: ignore[import-untyped]
 from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
 from sqlalchemy.future import select
 

{jupyverse-0.10.5 → jupyverse-0.10.7}/plugins/auth_jupyterhub/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "fps_auth_jupyterhub"
-version = "0.9.0"
+version = "0.9.1"
 description = "An FPS plugin for the authentication API, using JupyterHbu"
 keywords = ["jupyter", "server", "fastapi", "plugins"]
 requires-python = ">=3.9"

{jupyverse-0.10.5 → jupyverse-0.10.7}/plugins/file_id/README.md

@@ -1,3 +1,3 @@
-# fps-contents
+# fps-file-id
 
 An FPS plugin for the file ID API.

{jupyverse-0.10.5 → jupyverse-0.10.7}/plugins/file_id/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "fps_file_id"
-version = "0.2.0"
+version = "0.2.1"
 description = "An FPS plugin for the file ID API"
 keywords = ["jupyter", "server", "fastapi", "plugins"]
 requires-python = ">=3.9"

{jupyverse-0.10.5 → jupyverse-0.10.7}/plugins/kernel_web_worker/fps_kernel_web_worker/kernel_web_worker.py

@@ -33,25 +33,26 @@ class KernelWebWorker(Kernel):
             kernel_ready = Event()
 
             def callback(msg):
-                if msg["type"] == "started":
+                msg_type = msg["type"]
+                if msg_type == "started":
                     kernel_ready.set()
                 else:
                     msg = [bytes(pyjs.to_py(m)) for m in msg["msg"]]
-                    if msg["type"] == "shell":
+                    if msg_type == "shell":
                         self.task_group.start_soon(self._from_shell_send_stream.send, msg)
-                    elif msg["type"] == "control":
+                    elif msg_type == "control":
                         self.task_group.start_soon(self._from_control_send_stream.send, msg)
-                    elif msg["type"] == "stdin":
+                    elif msg_type == "stdin":
                         self.task_group.start_soon(self._from_stdin_send_stream.send, msg)
-                    elif msg["type"] == "iopub":
+                    elif msg_type == "iopub":
                         self.task_group.start_soon(self._from_iopub_send_stream.send, msg)
 
-            js_callable, self.js_py_object = pyjs.create_callable(callback)
-            higher_order_function = pyjs.js.Function(
+            self.js_callable, self.js_py_object = pyjs.create_callable(callback)
+            self.higher_order_function = pyjs.js.Function(
                 "callback", "action", "kernel_id",
                 "kernel_web_worker(action, kernel_id, 0, callback);"
             )
-            higher_order_function(js_callable, "start", self.kernel_id)
+            self.higher_order_function(self.js_callable, "start", self.kernel_id)
             await kernel_ready.wait()
 
             self.task_group.start_soon(self.forward_messages_to_shell)
@@ -62,6 +63,7 @@ class KernelWebWorker(Kernel):
             self.started.set()
 
     async def stop(self) -> None:
+        self.higher_order_function(self.js_callable, "stop", self.kernel_id)
         self.js_py_object.delete()
         self.task_group.cancel_scope.cancel()
 

{jupyverse-0.10.5 → jupyverse-0.10.7}/plugins/kernel_web_worker/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "fps_kernel_web_worker"
-version = "0.1.1"
+version = "0.1.3"
 description = "An FPS plugin for the kernel web worker API"
 keywords = ["jupyter", "server", "fastapi", "plugins"]
 requires-python = ">=3.9"

{jupyverse-0.10.5 → jupyverse-0.10.7}/plugins/noauth/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "fps_noauth"
-version = "0.9.0"
+version = "0.9.1"
 description = "An FPS plugin for an unprotected API"
 keywords = ["jupyter", "server", "fastapi", "plugins"]
 requires-python = ">=3.9"
@@ -27,8 +27,8 @@ text = "BSD 3-Clause License"
 Homepage = "https://jupyter.org"
 
 [project.entry-points]
-"fps.modules"       = {auth = "fps_noauth.main:NoAuthModule"}
-"jupyverse.modules" = {auth = "fps_noauth.main:NoAuthModule"}
+"fps.modules"       = {noauth = "fps_noauth.main:NoAuthModule"}
+"jupyverse.modules" = {noauth = "fps_noauth.main:NoAuthModule"}
 
 [tool.check-manifest]
 ignore = [ ".*",]

{jupyverse-0.10.5 → jupyverse-0.10.7}/plugins/yjs/fps_yjs/routes.py

@@ -268,15 +268,22 @@ class RoomManager:
 
         await self.websocket_server.serve(websocket, self.lifespan.shutdown_request)
 
-        if websocket in self.room_write_permissions.get(websocket.path, set()):
-            self.room_write_permissions[websocket.path].remove(websocket)
-
-        if not self.lifespan.shutdown_request.is_set() and is_stored_document and not room.clients:
-            # no client in this room after we disconnect
-            self.cleaners[room] = create_task(
-                self.maybe_clean_room(room, websocket.path),
-                self.task_group,
-            )
+        # Obtain lock for cleanup to prevent race conditions when multiple clients disconnect
+        async with self.room_lock(websocket.path):
+            if websocket in self.room_write_permissions.get(websocket.path, set()):
+                self.room_write_permissions[websocket.path].remove(websocket)
+
+            if (
+                not self.lifespan.shutdown_request.is_set()
+                and is_stored_document
+                and not room.clients
+                and room not in self.cleaners
+            ):
+                # no client in this room after we disconnect
+                self.cleaners[room] = create_task(
+                    self.maybe_clean_room(room, websocket.path),
+                    self.task_group,
+                )
 
     async def filter_message(self, message: bytes, websocket: Websocket) -> bool:
         """
@@ -405,25 +412,27 @@ class RoomManager:
         file_id = ws_path.split(":", 2)[2]
         # keep the document for a while in case someone reconnects
         await sleep(self.config.document_cleanup_delay)
-        document = self.documents[ws_path]
-        document.unobserve()
-        del self.documents[ws_path]
-        documents = [v for k, v in self.documents.items() if k.split(":", 2)[2] == file_id]
-        if not documents:
-            self.watchers[file_id].cancel(raise_exception=False)
-            await self.watchers[file_id].wait()
-            if file_id in self.watchers:
-                del self.watchers[file_id]
-        room_name = self.websocket_server.get_room_name(room)
-        self.websocket_server.delete_room(room=room)
-
-        if ws_path in self.room_write_permissions:
-            del self.room_write_permissions[ws_path]
 
-        file_path = await self.get_file_path(file_id, document)
-        logger.info("Closing collaboration room", room_id=room_name, file_path=file_path)
-        if room in self.cleaners:
-            del self.cleaners[room]
+        async with self.room_lock(ws_path):
+            document = self.documents[ws_path]
+            document.unobserve()
+            del self.documents[ws_path]
+            documents = [v for k, v in self.documents.items() if k.split(":", 2)[2] == file_id]
+            if not documents:
+                self.watchers[file_id].cancel(raise_exception=False)
+                await self.watchers[file_id].wait()
+                if file_id in self.watchers:
+                    del self.watchers[file_id]
+            room_name = self.websocket_server.get_room_name(room)
+            self.websocket_server.delete_room(room=room)
+
+            if ws_path in self.room_write_permissions:
+                del self.room_write_permissions[ws_path]
+
+            file_path = await self.get_file_path(file_id, document)
+            logger.info("Closing collaboration room", room_id=room_name, file_path=file_path)
+            if room in self.cleaners:
+                del self.cleaners[room]
 
 
 class JupyterWebsocketServer(WebsocketServer):

{jupyverse-0.10.5 → jupyverse-0.10.7}/plugins/yjs/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "fps_yjs"
-version = "0.10.1"
+version = "0.10.2"
 description = "An FPS plugin for the Yjs API"
 keywords = [ "jupyter", "server", "fastapi", "plugins" ]
 requires-python = ">=3.9"

jupyverse-0.10.7/plugins/yjs/tests/test_yjs.py

@@ -0,0 +1,75 @@
+import pytest
+from anyio import create_task_group
+from fps import get_root_module
+from httpx import AsyncClient
+from httpx_ws import aconnect_ws
+from structlog.testing import capture_logs
+
+from jupyverse_api.asgi_websocket_transport import ASGIWebSocketTransport
+from jupyverse_api.yjs.models import CreateDocumentSession
+
+
+@pytest.mark.anyio
+async def test_concurrent_disconnect(tmp_path):
+    config = {
+        "jupyverse": {
+            "type": "jupyverse",
+                "config": {
+                    "start_server": False,
+                },
+            "modules": {
+                "app": {
+                    "type": "app",
+                },
+                "yjs": {
+                    "type": "yjs",
+                    "config": {
+                        "document_cleanup_delay": 0,
+                    },
+                },
+                "auth": {
+                    "type": "noauth",
+                },
+                "contents": {
+                    "type": "contents",
+                },
+                "file_id": {
+                    "type": "file_id",
+                },
+                "frontend": {
+                    "type": "frontend",
+                },
+            },
+        }
+    }
+
+    with capture_logs() as cap_logs:
+        async with get_root_module(config) as root_module:
+            app = root_module.app
+            transport = ASGIWebSocketTransport(app=app)
+            async with AsyncClient(transport=transport, base_url="http://testserver") as client:
+                data = CreateDocumentSession(format="text", type="file")
+                p = tmp_path / "hello.txt"
+                p.write_text("hello")
+                response = await client.put(
+                    f"http://testserver/api/collaboration/session/{p}",
+                    json=dict(data),
+                )
+                data = response.json()
+                file_id = data["fileId"]
+
+                async def connect_ws():
+                    async with aconnect_ws(
+                        f"http://testserver/api/collaboration/room/text:file:{file_id}",
+                        client,
+                    ):
+                        pass
+
+                async with create_task_group() as tg:
+                    tg.start_soon(connect_ws)
+                    tg.start_soon(connect_ws)
+
+    assert {
+        "event": "Application failed",
+        "log_level": "critical",
+    } not in cap_logs