jupyverse 0.10.1__tar.gz → 0.10.3__tar.gz

{jupyverse-0.10.1 → jupyverse-0.10.3}/.pre-commit-config.yaml

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

{jupyverse-0.10.1 → jupyverse-0.10.3}/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Version history
 
+## 0.10.3
+
+- Propagate `yjs` settings.
+
+## 0.10.2
+
+- Rework `test_kernels.py` to use ASGI transport.
+
 ## 0.10.1
 
 - Fix optional dependencies pinning.

{jupyverse-0.10.1 → jupyverse-0.10.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jupyverse
-Version: 0.10.1
+Version: 0.10.3
 Summary: A set of FPS plugins implementing a Jupyter server
 Project-URL: Homepage, https://jupyter.org
 Author-email: Jupyter Development Team <jupyter@googlegroups.com>
@@ -13,11 +13,11 @@ Requires-Dist: fps-contents<0.11.0,>=0.10.0
 Requires-Dist: fps-file-id<0.3.0,>=0.2.0
 Requires-Dist: fps-frontend<0.10.0,>=0.9.0
 Requires-Dist: fps-kernel-subprocess<0.2.0,>=0.1.0
-Requires-Dist: fps-kernels<0.10.0,>=0.9.0
+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.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.0
 Requires-Dist: rich-click<2,>=1.6.1

{jupyverse-0.10.1 → jupyverse-0.10.3}/plugins/kernels/fps_kernels/kernel_server/server.py

@@ -6,7 +6,7 @@ from datetime import datetime, timezone
 
 from anyio import TASK_STATUS_IGNORED, Event, create_task_group, move_on_after
 from anyio.abc import TaskStatus
-from fastapi import WebSocket, WebSocketDisconnect
+from fastapi import WebSocket
 from starlette.websockets import WebSocketState
 
 from jupyverse_api.kernel import DefaultKernelFactory, KernelFactory
@@ -160,7 +160,7 @@ class KernelServer:
     async def listen_web(self, websocket: AcceptedWebSocket, stop_event: Event):
         try:
             await self.send_to_kernel(websocket)
-        except WebSocketDisconnect:
+        except BaseException:
             pass
         finally:
             stop_event.set()

{jupyverse-0.10.1 → jupyverse-0.10.3}/plugins/kernels/pyproject.toml

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

{jupyverse-0.10.1 → jupyverse-0.10.3}/plugins/yjs/fps_yjs/main.py

@@ -27,7 +27,7 @@ class YjsModule(Module):
         file_id = await self.get(FileId)  # type: ignore[type-abstract]
         lifespan = await self.get(Lifespan)
 
-        self.yjs = _Yjs(app, auth, contents, file_id, lifespan)
+        self.yjs = _Yjs(app, auth, contents, file_id, lifespan, self.config)
 
         async with create_task_group() as tg:
             await tg.start(self.yjs.start)

{jupyverse-0.10.1 → jupyverse-0.10.3}/plugins/yjs/fps_yjs/routes.py

@@ -25,7 +25,7 @@ from jupyverse_api.auth import Auth, User
 from jupyverse_api.contents import Contents
 from jupyverse_api.file_id import FileId
 from jupyverse_api.main import Lifespan
-from jupyverse_api.yjs import Yjs
+from jupyverse_api.yjs import Yjs, YjsConfig
 from jupyverse_api.yjs.models import CreateDocumentSession
 
 from .ywebsocket.websocket import Websocket
@@ -51,11 +51,13 @@ class _Yjs(Yjs):
         contents: Contents,
         file_id: FileId,
         lifespan: Lifespan,
+        config: YjsConfig,
     ) -> None:
         super().__init__(app=app, auth=auth)
         self.contents = contents
         self.file_id = file_id
         self.lifespan = lifespan
+        self.config = config
         if Widgets is None:
             self.widgets = None
         else:
@@ -63,7 +65,7 @@ class _Yjs(Yjs):
 
     async def start(self, *, task_status: TaskStatus[None] = TASK_STATUS_IGNORED) -> None:
         async with create_task_group() as tg:
-            self.room_manager = RoomManager(self.contents, self.file_id, self.lifespan)
+            self.room_manager = RoomManager(self.contents, self.file_id, self.lifespan, self.config)
             tg.start_soon(self.room_manager.start)
             task_status.started()
 
@@ -166,7 +168,7 @@ class RoomManager:
     room_write_permissions: dict[str, set[YWebsocket]]
     room_lock: ResourceLock
 
-    def __init__(self, contents: Contents, file_id: FileId, lifespan: Lifespan):
+    def __init__(self, contents: Contents, file_id: FileId, lifespan: Lifespan, config: YjsConfig):
         self.contents = contents
         self.file_id = file_id
         self.lifespan = lifespan
@@ -178,6 +180,7 @@ class RoomManager:
         self.room_write_permissions = {}  # a dictionary of room_name:websockets that can write
         self.websocket_server = JupyterWebsocketServer(rooms_ready=False, auto_clean_rooms=False)
         self.room_lock = ResourceLock()
+        self.config = config
 
     async def start(self):
         async with create_task_group() as self.task_group:
@@ -364,8 +367,8 @@ class RoomManager:
     async def maybe_save_document(
         self, file_id: str, file_type: str, file_format: str, document: YBaseDoc
     ) -> None:
-        # save after 1 second of inactivity to prevent too frequent saving
-        await sleep(1)  # FIXME: pass in config
+        # save after configured delay to prevent too frequent saving
+        await sleep(self.config.document_save_delay)
         # if the room cannot be found, don't save
         try:
             file_path = await self.get_file_path(file_id, document)
@@ -401,7 +404,7 @@ class RoomManager:
     async def maybe_clean_room(self, room, ws_path: str) -> None:
         file_id = ws_path.split(":", 2)[2]
         # keep the document for a while in case someone reconnects
-        await sleep(60)  # FIXME: pass in config
+        await sleep(self.config.document_cleanup_delay)
         document = self.documents[ws_path]
         document.unobserve()
         del self.documents[ws_path]

{jupyverse-0.10.1 → jupyverse-0.10.3}/plugins/yjs/pyproject.toml

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

{jupyverse-0.10.1 → jupyverse-0.10.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "jupyverse"
-version = "0.10.1"
+version = "0.10.3"
 description = "A set of FPS plugins implementing a Jupyter server"
 keywords = ["jupyter", "server", "fastapi", "plugins"]
 requires-python = ">=3.9"
@@ -13,10 +13,10 @@ dependencies = [
     "fps-contents >=0.10.0,<0.11.0",
     "fps-file-id >=0.2.0,<0.3.0",
     "fps-kernel-subprocess >=0.1.0,<0.2.0",
-    "fps-kernels >=0.9.0,<0.10.0",
+    "fps-kernels >=0.9.1,<0.10.0",
     "fps-terminals >=0.9.0,<0.10.0",
     "fps-nbconvert >=0.9.0,<0.10.0",
-    "fps-yjs >=0.10.0,<0.11.0",
+    "fps-yjs >=0.10.1,<0.11.0",
     "fps-lab >=0.9.0,<0.10.0",
     "fps-frontend >=0.9.0,<0.10.0",
     "jupyverse-api >=0.10.0,<0.11.0",

{jupyverse-0.10.1 → jupyverse-0.10.3}/tests/test_kernels.py

@@ -8,6 +8,7 @@ from fps import get_root_module, merge_config
 from fps_kernels.kernel_server.server import KernelServer, kernels
 from httpx import AsyncClient
 from httpx_ws import aconnect_ws
+from utils import ASGIWebSocketTransport
 
 from jupyverse_api.kernel import Kernel
 
@@ -16,6 +17,9 @@ os.environ["PYDEVD_DISABLE_FILE_VALIDATION"] = "1"
 CONFIG = {
     "jupyverse": {
         "type": "jupyverse",
+            "config": {
+                "start_server": False,
+            },
         "modules": {
             "app": {
                 "type": "app",
@@ -29,9 +33,6 @@ CONFIG = {
             "contents": {
                 "type": "contents",
             },
-            "file_id": {
-                "type": "file_id",
-            },
             "frontend": {
                 "type": "frontend",
             },
@@ -47,9 +48,6 @@ CONFIG = {
             "kernels": {
                 "type": "kernels",
             },
-            "yjs": {
-                "type": "yjs",
-            },
         },
     }
 }
@@ -57,87 +55,96 @@ CONFIG = {
 
 @pytest.mark.anyio
 @pytest.mark.parametrize("auth_mode", ("noauth",))
-async def test_kernel_messages(auth_mode, capfd, unused_tcp_port):
+async def test_kernel_messages(auth_mode, capfd):
     kernel_id = "kernel_id_0"
     kernel_name = "python3"
     kernelspec_path = (
         Path(sys.prefix) / "share" / "jupyter" / "kernels" / kernel_name / "kernel.json"
     )
     assert kernelspec_path.exists()
-    async with create_task_group() as tg:
-        msg = {
-            "channel": "shell",
-            "parent_header": None,
-            "content": None,
-            "metadata": None,
-            "header": {
-                "msg_type": "msg_type_0",
-                "msg_id": "0",
-            },
-        }
-
-        config = merge_config(
-            CONFIG,
-            {
-                "jupyverse": {
-                    "config": {"port": unused_tcp_port},
-                    "modules": {
-                        "auth": {
-                            "config": {
-                                "mode": auth_mode,
-                            }
+    msg = {
+        "channel": "shell",
+        "parent_header": None,
+        "content": None,
+        "metadata": None,
+        "header": {
+            "msg_type": "msg_type_0",
+            "msg_id": "0",
+        },
+    }
+
+    config = merge_config(
+        CONFIG,
+        {
+            "jupyverse": {
+                "modules": {
+                    "auth": {
+                        "config": {
+                            "mode": auth_mode,
                         }
-                    },
-                }
-            },
-        )
-        async with get_root_module(config), AsyncClient():
+                    }
+                },
+            }
+        },
+    )
+    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:
             kernel_server = KernelServer(
                 kernelspec_path=kernelspec_path,
                 capture_kernel_output=False,
                 default_kernel_factory=KernelFactory(),
             )
-            await tg.start(kernel_server.start)
-            kernels[kernel_id] = {"server": kernel_server, "driver": None}
-            # block msg_type_0
-            kernel_server.block_messages("msg_type_0")
-            async with aconnect_ws(
-                f"http://127.0.0.1:{unused_tcp_port}/api/kernels/{kernel_id}/channels?session_id=session_id_0",
-            ) as websocket:
-                await websocket.send_json(msg)
-            await sleep(0.1)
-            out, err = capfd.readouterr()
-            assert not err
-
-            # allow only msg_type_0
-            kernel_server.allow_messages("msg_type_0")
-            async with aconnect_ws(
-                f"http://127.0.0.1:{unused_tcp_port}/api/kernels/{kernel_id}/channels?session_id=session_id_0",
-            ) as websocket:
-                await websocket.send_json(msg)
-            await sleep(0.1)
-            out, err = capfd.readouterr()
-            assert err.count("msg_type_0") == 1
-
-            # block all messages
-            kernel_server.allow_messages([])
-            async with aconnect_ws(
-                f"http://127.0.0.1:{unused_tcp_port}/api/kernels/{kernel_id}/channels?session_id=session_id_0",
-            ) as websocket:
-                await websocket.send_json(msg)
-            await sleep(0.1)
-            out, err = capfd.readouterr()
-            assert not err
-
-            # allow all messages
-            kernel_server.allow_messages()
-            async with aconnect_ws(
-                f"http://127.0.0.1:{unused_tcp_port}/api/kernels/{kernel_id}/channels?session_id=session_id_0",
-            ) as websocket:
-                await websocket.send_json(msg)
-            await sleep(0.1)
-            out, err = capfd.readouterr()
-            assert err.count("msg_type_0") >= 1
+            async with create_task_group() as tg:
+                await tg.start(kernel_server.start)
+                kernels[kernel_id] = {"server": kernel_server, "driver": None}
+
+                # block msg_type_0
+                kernel_server.block_messages("msg_type_0")
+                async with aconnect_ws(
+                    f"http://testserver/api/kernels/{kernel_id}/channels?session_id=session_id_0",
+                    client,
+                ) as websocket:
+                    await websocket.send_json(msg)
+                await sleep(0.1)
+                out, err = capfd.readouterr()
+                assert not err
+
+                # allow only msg_type_0
+                kernel_server.allow_messages("msg_type_0")
+                async with aconnect_ws(
+                    f"http://testserver/api/kernels/{kernel_id}/channels?session_id=session_id_0",
+                    client,
+                ) as websocket:
+                    await websocket.send_json(msg)
+                    await sleep(0.1)
+                out, err = capfd.readouterr()
+                assert err.count("msg_type_0") == 1
+
+                # block all messages
+                kernel_server.allow_messages([])
+                async with aconnect_ws(
+                    f"http://testserver/api/kernels/{kernel_id}/channels?session_id=session_id_0",
+                    client,
+                ) as websocket:
+                    await websocket.send_json(msg)
+                await sleep(0.1)
+                out, err = capfd.readouterr()
+                assert not err
+
+                # allow all messages
+                kernel_server.allow_messages()
+                async with aconnect_ws(
+                    f"http://testserver/api/kernels/{kernel_id}/channels?session_id=session_id_0",
+                    client,
+                ) as websocket:
+                    await websocket.send_json(msg)
+                await sleep(0.1)
+                out, err = capfd.readouterr()
+                assert err.count("msg_type_0") >= 1
+
+                await kernel_server.stop()
 
 
 class KernelFactory: