Force analysis of pycrdt_websocket imports, fix types (#476)

* Force analysis of `pycrdt_websocket` imports

* Add `pycrdt-websocket` to mypy deps?

* Upgrade mypy to latest (1.14.0 required for `follow_untyped_imports`)

* Try without overides

* Fix a number of typing issues

* More fixes

* More fixes

* Fix partial issue

* Fix type of `ystore_class`

Co-authored-by: David Brochart <[email protected]>

---------

Co-authored-by: David Brochart <[email protected]>

Author: krassowski

.pre-commit-config.yaml

@@ -39,12 +39,12 @@ repos:
         stages: [manual]
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.991
+    rev: v1.15.0
     hooks:
       - id: mypy
         exclude: "(^binder/jupyter_config\\.py$)|(^scripts/bump_version\\.py$)|(/setup\\.py$)"
         args: ["--config-file", "pyproject.toml"]
-        additional_dependencies: [tornado, pytest]
+        additional_dependencies: [tornado, pytest, pycrdt-websocket]
         stages: [manual]
 
   - repo: https://github.com/sirosen/check-jsonschema

projects/jupyter-server-ydoc/jupyter_server_ydoc/app.py

@@ -105,7 +105,7 @@ def initialize_handlers(self):
         page_config.setdefault("serverSideExecution", self.server_side_execution)
 
         # Set configurable parameters to YStore class
-        ystore_class = partial(self.ystore_class, config=self.config)
+        ystore_class: type[BaseYStore] = partial(self.ystore_class, config=self.config)  # type:ignore[assignment]
 
         self.ywebsocket_server = JupyterWebsocketServer(
             rooms_ready=False,
@@ -205,7 +205,7 @@ async def get_document(
             if copy:
                 update = room.ydoc.get_update()
 
-                fork_ydoc = Doc()
+                fork_ydoc: Doc = Doc()
                 fork_ydoc.apply_update(update)
 
                 return YDOCS.get(room.file_type, YDOCS["file"])(fork_ydoc)

projects/jupyter-server-ydoc/jupyter_server_ydoc/handlers.py

@@ -7,15 +7,15 @@
 import json
 import uuid
 from logging import Logger
-from typing import Any, Literal
+from typing import Any
 from uuid import uuid4
 
 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.websocket_server import YRoom
+from pycrdt_websocket.yroom import YRoom
 from pycrdt_websocket.ystore import BaseYStore
 from tornado import web
 from tornado.websocket import WebSocketHandler
@@ -115,7 +115,10 @@ def exception_logger(exception: Exception, log: Logger) -> bool:
 
                     file = self._file_loaders[file_id]
                     updates_file_path = f".{file_type}:{file_id}.y"
-                    ystore = self._ystore_class(path=updates_file_path, log=self.log)
+                    ystore = self._ystore_class(
+                        path=updates_file_path,
+                        log=self.log,  # type:ignore[call-arg]
+                    )
                     self.room = DocumentRoom(
                         self._room_id,
                         file_format,
@@ -180,7 +183,7 @@ def initialize(
         self._websocket_server = ywebsocket_server
         self._message_queue = asyncio.Queue()
         self._room_id = ""
-        self.room = None
+        self.room = None  # type:ignore
 
     @property
     def path(self):
@@ -217,7 +220,7 @@ async def get(self, *args, **kwargs):
             raise web.HTTPError(403)
         return await super().get(*args, **kwargs)
 
-    async def open(self, room_id):
+    async def open(self, room_id: str) -> None:  # type:ignore[override]
         """
         On connection open.
         """
@@ -362,9 +365,7 @@ async def _clean_room(self) -> None:
                 self._emit(LogLevel.INFO, "clean", "Loader deleted.")
             del self._room_locks[self._room_id]
 
-    def _on_global_awareness_event(
-        self, topic: Literal["change", "update"], changes: tuple[dict[str, Any], Any]
-    ) -> None:
+    def _on_global_awareness_event(self, topic: str, changes: tuple[dict[str, Any], Any]) -> None:
         """
         Update the users when the global awareness changes.
 
@@ -465,7 +466,7 @@ async def get(self, path: str) -> None:
         try:
             room_id = room_id_from_encoded_path(encoded_path)
             room: YRoom = await self.ywebsocket_server.get_room(room_id)
-            fork_ydoc = Doc()
+            fork_ydoc: Doc = Doc()
 
             ydoc_factory = YDOCS.get(content_type)
             if ydoc_factory is None:
@@ -481,7 +482,9 @@ async def get(self, path: str) -> None:
             FORK_DOCUMENTS[idx] = ydoc_factory(fork_ydoc)
             undo_manager: UndoManager = FORK_DOCUMENTS[idx].undo_manager
 
-            updates_and_timestamps = [(item[0], item[-1]) async for item in room.ystore.read()]
+            ystore = room.ystore
+            assert ystore
+            updates_and_timestamps = [(item[0], item[-1]) async for item in ystore.read()]
 
             result_timestamps = []
 
@@ -625,7 +628,7 @@ async def put(self, root_roomid):
             return self.finish({"code": 404, "error": "Root room not found"})
 
         update = root_room.ydoc.get_update()
-        fork_ydoc = Doc()
+        fork_ydoc: Doc = Doc()
         fork_ydoc.apply_update(update)
         model = self.get_json_body()
         synchronize = model.get("synchronize", False)

projects/jupyter-server-ydoc/jupyter_server_ydoc/pytest_plugin.py

@@ -240,7 +240,12 @@ def _on_document_change(target: str, e: Any) -> None:
 
 def rtc_create_SQLite_store_factory(jp_serverapp):
     async def _inner(type: str, path: str, content: str) -> DocumentRoom:
-        db = SQLiteYStore(path=f"{type}:{path}", config=jp_serverapp.config)
+        db = SQLiteYStore(
+            path=f"{type}:{path}",
+            # `SQLiteYStore` here is a subclass of booth `LoggingConfigurable`
+            # and `pycrdt_websocket.ystore.SQLiteYStore`, but mypy gets lost:
+            config=jp_serverapp.config,  # type:ignore[call-arg]
+        )
         _ = create_task(db.start())
         await db.started.wait()
 

projects/jupyter-server-ydoc/jupyter_server_ydoc/rooms.py

@@ -9,7 +9,7 @@
 
 from jupyter_events import EventLogger
 from jupyter_ydoc import ydocs as YDOCS
-from pycrdt_websocket.websocket_server import YRoom
+from pycrdt_websocket.yroom import YRoom
 from pycrdt_websocket.ystore import BaseYStore, YDocNotFound
 
 from .loaders import FileLoader
@@ -103,7 +103,7 @@ async def initialize(self) -> None:
             It is important to set the ready property in the parent class (`self.ready = True`),
             this setter will subscribe for updates on the shared document.
         """
-        if self.ready:  # type: ignore[has-type]
+        if self.ready:
             return
 
         self.log.info("Initializing room %s", self._room_id)

projects/jupyter-server-ydoc/jupyter_server_ydoc/websocketserver.py

@@ -7,9 +7,10 @@
 from logging import Logger
 from typing import Any, Callable
 
-from pycrdt_websocket.websocket_server import WebsocketServer, YRoom
+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 tornado.websocket import WebSocketHandler
 
 
 class RoomNotFound(LookupError):
@@ -38,7 +39,7 @@ class JupyterWebsocketServer(WebsocketServer):
 
     def __init__(
         self,
-        ystore_class: BaseYStore,
+        ystore_class: type[BaseYStore],
         rooms_ready: bool = True,
         auto_clean_rooms: bool = True,
         exception_handler: Callable[[Exception, Logger], bool] | None = None,
@@ -132,7 +133,7 @@ async def get_room(self, path: str) -> YRoom:
         await self.start_room(room)
         return room
 
-    async def serve(self, websocket: WebSocketHandler) -> None:
+    async def serve(self, websocket: Websocket) -> 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())