first version receiving Yjs messages

Author: dlqqq

jupyter_rtc_core/app.py

@@ -2,7 +2,7 @@
 from traitlets.config import Config
 import asyncio
 
-from .handlers import RouteHandler
+from .handlers import RouteHandler, YRoomSessionHandler
 from .websockets import GlobalAwarenessWebsocket, YRoomWebsocket
 from .rooms import YRoomManager
 
@@ -18,7 +18,9 @@ class RtcExtensionApp(ExtensionApp):
         # global awareness websocket
         # (r"api/collaboration/room/JupyterLab:globalAwareness/?", GlobalAwarenessWebsocket),
         # # ydoc websocket
-        (r"api/collaboration/room/(.*)", YRoomWebsocket)
+        (r"api/collaboration/room/(.*)", YRoomWebsocket),
+        # handler that just adds compatibility with Jupyter Collaboration's frontend
+        (r"api/collaboration/session/(.*)", YRoomSessionHandler)
     ]
 
     def initialize(self):
@@ -30,18 +32,25 @@ def initialize_settings(self):
         # We cannot access the 'file_id_manager' key immediately because server
         # extensions initialize in alphabetical order. 'jupyter_rtc_core' <
         # 'jupyter_server_fileid'.
-        get_fileid_manager = lambda: self.settings["file_id_manager"]
-        contents_manager = self.serverapp.contents_manager
-        loop = asyncio.get_event_loop_policy().get_event_loop()
-        log = self.log
-
-        # Initialize YRoomManager
-        self.settings["yroom_manager"] = YRoomManager(
-            get_fileid_manager=get_fileid_manager,
-            contents_manager=contents_manager,
-            loop=loop,
-            log=log
-        )
+        # def get_fileid_manager():
+        #     self.log.info("IN GETTER")
+        #     for k, v in self.settings.items():
+        #         print(f"{k}: {v}")
+        #     print(len(self.settings.items()))
+        #     print(id(self.settings))
+        #     return self.settings["file_id_manager"]
+        # contents_manager = self.serverapp.contents_manager
+        # loop = asyncio.get_event_loop_policy().get_event_loop()
+        # log = self.log
+
+        # # Initialize YRoomManager
+        # self.settings["yroom_manager"] = YRoomManager(
+        #     get_fileid_manager=get_fileid_manager,
+        #     contents_manager=contents_manager,
+        #     loop=loop,
+        #     log=log
+        # )
+        pass
 
 
     def _link_jupyter_server_extension(self, server_app):

jupyter_rtc_core/handlers.py

@@ -1,4 +1,5 @@
 import json
+import uuid
 
 from jupyter_server.base.handlers import APIHandler
 import tornado
@@ -14,4 +15,33 @@ def get(self):
         }))
 
 
+# TODO: remove this by v1.0.0 if deemed unnecessary. Just adding this for
+# compatibility with the `jupyter_collaboration` frontend.
+class YRoomSessionHandler(APIHandler):
+    SESSION_ID = str(uuid.uuid4())
+
+    @tornado.web.authenticated
+    def put(self, path):
+        body = json.loads(self.request.body)
+        format = body["format"]
+        content_type = body["type"]
+        # self.log.info("IN HANDLER")
+        # for k, v in self.settings.items():
+        #     print(f"{k}: {v}")
+        # print(len(self.settings.items()))
+        # print(id(self.settings))
+
+        file_id_manager = self.settings["file_id_manager"]
+        file_id = file_id_manager.index(path)
+
+        data = json.dumps(
+            {
+                "format": format,
+                "type": content_type,
+                "fileId": file_id,
+                "sessionId": self.SESSION_ID,
+            }
+        )
+        self.set_status(200)
+        self.finish(data)
 

jupyter_rtc_core/rooms/yroom.py

@@ -12,7 +12,7 @@
 from .yroom_file_api import YRoomFileAPI
 
 if TYPE_CHECKING:
-    from typing import Literal, Tuple
+    from typing import Literal, Tuple, Any
     from jupyter_server_fileid.manager import BaseFileIdManager
     from jupyter_server.services.contents.manager import AsyncContentsManager, ContentsManager
 
@@ -22,7 +22,11 @@ class YRoom:
     log: Logger
     """Log object"""
     room_id: str
-    """Room Id"""
+    """
+    The ID of the room. This is a composite ID following the format:
+
+    room_id := "{file_type}:{file_format}
+    """
 
     _jupyter_ydoc: YBaseDoc
     """JupyterYDoc"""
@@ -60,9 +64,10 @@ def __init__(
         self._client_group = YjsClientGroup(room_id=room_id, log=self.log, loop=self._loop)
         self._ydoc = pycrdt.Doc()
         self._awareness = pycrdt.Awareness(ydoc=self._ydoc)
+        _, file_type, _ = self.room_id.split(":")
         JupyterYDocClass = cast(
             type[YBaseDoc],
-            jupyter_ydoc_classes.get(self.file_type, jupyter_ydoc_classes["file"])
+            jupyter_ydoc_classes.get(file_type, jupyter_ydoc_classes["file"])
         )
         self.jupyter_ydoc = JupyterYDocClass(ydoc=self._ydoc, awareness=self._awareness)
 
@@ -307,11 +312,11 @@ def write_sync_update(self, message_payload: bytes, client_id: str | None = None
     def handle_awareness_update(self, client_id: str, message: bytes) -> None:
         # Apply the AwarenessUpdate message
         try:
-            message_payload = message[1:]
+            message_payload = pycrdt.read_message(message[1:])
             self._awareness.apply_awareness_update(message_payload, origin=self)
         except Exception as e:
             self.log.error(
-                "An exception occurred when applying an AwarenessUpdate"
+                "An exception occurred when applying an AwarenessUpdate "
                 f"message from client '{client_id}':"
             )
             self.log.exception(e)

jupyter_rtc_core/rooms/yroom_manager.py

@@ -15,13 +15,13 @@ class YRoomManager:
     def __init__(
         self,
         *,
-        get_fileid_manager: Callable[[], BaseFileIdManager],
+        fileid_manager: BaseFileIdManager,
         contents_manager: AsyncContentsManager | ContentsManager,
         loop: asyncio.AbstractEventLoop,
         log: logging.Logger,
     ):
         # Bind instance attributes
-        self._get_fileid_manager = get_fileid_manager
+        self.fileid_manager = fileid_manager
         self.contents_manager = contents_manager
         self.loop = loop
         self.log = log
@@ -30,11 +30,6 @@ def __init__(
         self._rooms_by_id = {}
 
 
-    @property
-    def fileid_manager(self) -> BaseFileIdManager:
-        return self._get_fileid_manager()
-    
-
     def get_room(self, room_id: str) -> YRoom | None:
         """
         Retrieves a YRoom given a room ID. If the YRoom does not exist, this

jupyter_rtc_core/websockets/__init__.py

@@ -1,3 +1,3 @@
 from .global_awareness_ws import GlobalAwarenessWebsocket
-from .yroom_ws import YRoomWebsocket
 from .clients import YjsClient, YjsClientGroup
+from .yroom_ws import YRoomWebsocket

jupyter_rtc_core/websockets/clients.py

@@ -5,8 +5,7 @@
 """
 
 from __future__ import annotations
-from datetime import timedelta, timezone
-import datetime
+from datetime import timedelta, timezone, datetime
 from logging import Logger
 from typing import TYPE_CHECKING
 import uuid
@@ -43,7 +42,7 @@ def synced(self):
 
     @synced.setter
     def synced(self, v: bool):
-        self.synced = v
+        self._synced = v
         self.last_modified = datetime.now(timezone.utc)
 
 class YjsClientGroup:
@@ -67,7 +66,7 @@ class YjsClientGroup:
     """Log object"""
     loop: asyncio.AbstractEventLoop
     """Event loop"""
-    poll_interval_seconds: int
+    _poll_interval_seconds: int
     """The poll time interval used while auto removing desynced clients"""
     desynced_timeout_seconds: int
     """The max time period in seconds that a desynced client does not become synced before get auto removed from desynced dict"""
@@ -79,7 +78,7 @@ def __init__(self, *, room_id: str, log: Logger, loop: asyncio.AbstractEventLoop
         self.log = log
         self.loop = loop
         self.loop.create_task(self._clean_desynced())
-        self.poll_interval_seconds = poll_interval_seconds
+        self._poll_interval_seconds = poll_interval_seconds
         self.desynced_timeout_seconds = desynced_timeout_seconds
 
     def add(self, websocket: WebSocketHandler) -> str:

jupyter_rtc_core/websockets/yroom_ws.py

@@ -2,10 +2,14 @@
 from tornado.httpclient import HTTPError
 from tornado.websocket import WebSocketHandler
 from typing import TYPE_CHECKING
+import asyncio
+from ..rooms import YRoomManager
+import logging
 
 if TYPE_CHECKING:
     from jupyter_server_fileid.manager import BaseFileIdManager
-    from ..rooms import YRoom, YRoomManager
+    from jupyter_server.services.contents.manager import AsyncContentsManager, ContentsManager
+    from ..rooms import YRoom
 
 class YRoomWebsocket(WebSocketHandler):
     yroom: YRoom
@@ -14,12 +18,26 @@ class YRoomWebsocket(WebSocketHandler):
 
     @property
     def yroom_manager(self) -> YRoomManager:
+        if "yroom_manager" not in self.settings:
+            self.settings["yroom_manager"] = YRoomManager(
+                fileid_manager=self.fileid_manager,
+                contents_manager=self.contents_manager,
+                loop=asyncio.get_event_loop_policy().get_event_loop(),
+                # TODO: change this. we should pass `self.log` from our
+                # `ExtensionApp` to log messages w/ "RtcCoreExtension" prefix
+                log=logging.Logger("TEMP")
+
+            )
         return self.settings["yroom_manager"]
-    
 
     @property
     def fileid_manager(self) -> BaseFileIdManager:
         return self.settings["file_id_manager"]
+    
+
+    @property
+    def contents_manager(self) -> AsyncContentsManager | ContentsManager:
+        return self.settings["contents_manager"]
 
 
     def prepare(self):
@@ -38,7 +56,7 @@ def prepare(self):
             raise HTTPError(404, f"No file with ID '{fileid}'.")
 
 
-    def open(self):
+    def open(self, *_, **__):
         # Create the YRoom
         yroom = self.yroom_manager.get_room(self.room_id)
         if not yroom:
@@ -51,6 +69,7 @@ def open(self):
 
     def on_message(self, message: bytes):
         # Route all messages to the YRoom for processing
+        print(message)
         self.yroom.add_message(self.client_id, message)