Merge branch 'main' into output-integration

Author: 3coins

jupyter_rtc_core/app.py

@@ -3,7 +3,7 @@
 import asyncio
 
 from traitlets import Instance, Type
-from .handlers import RouteHandler, YRoomSessionHandler, FileIDIndexHandler
+from .handlers import RouteHandler, FileIDIndexHandler
 from .websockets import GlobalAwarenessWebsocket, YRoomWebsocket
 from .rooms.yroom_manager import YRoomManager
 from .outputs import OutputsManager, outputs_handlers

jupyter_rtc_core/handlers.py

@@ -41,36 +41,4 @@ class RouteHandler(APIHandler):
     def get(self):
         self.finish(json.dumps({
             "data": "This is /jupyter-rtc-core/get-example endpoint!"
-        }))
-
-
-# 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/kernels/kernel_client.py

@@ -85,7 +85,7 @@ async def stop_listening(self):
         # Log any exceptions that were raised.
         except Exception as err:
             self.log.error(err)
-               
+
     _listening_task: t.Optional[t.Awaitable] = Any(allow_none=True)
 
     def handle_incoming_message(self, channel_name: str, msg: list[bytes]):
@@ -181,7 +181,7 @@ async def handle_outgoing_message(self, channel_name: str, msg: list[bytes]):
                 return
 
         # Update the last activity.
-        #self.last_activity = self.session.msg_time
+        # self.last_activity = self.session.msg_time
 
         await self.send_message_to_listeners(channel_name, msg)
 
@@ -229,6 +229,32 @@ async def handle_iopub_message(self, msg: list[bytes]) -> t.Optional[list[bytes]
         else:
             return msg
 
+        # NOTE: Inject display data into ydoc.
+        if dmsg["msg_type"] == "display_data":
+            # Forward to all yrooms.
+            for yroom in self._yrooms:
+                update_document_message = b""
+                # yroom.add_message(update_document_message)
+
+        # TODO: returning message temporarily to not break UI
+        # If the message isn't handled above, return it and it will
+        # be forwarded to all listeners
+        return msg
+
+    def send_kernel_awareness(self, kernel_status: dict):
+        """
+        Send kernel status awareness messages to all yrooms
+        """
+        for yroom in self._yrooms:
+            awareness = yroom.get_awareness()
+            if awareness is None:
+                self.log.error(f"awareness cannot be None. room_id: {yroom.room_id}")
+                continue
+            self.log.debug(f"current state: {awareness.get_local_state()} room_id: {yroom.room_id}. kernel status: {kernel_status}")
+            awareness.set_local_state_field("kernel", kernel_status)    
+            self.log.debug(f"current state: {awareness.get_local_state()} room_id: {yroom.room_id}")
+
+
     async def add_yroom(self, yroom: YRoom):
         """
         Register a YRoom with this kernel client. YRooms will

jupyter_rtc_core/kernels/kernel_manager.py

@@ -107,7 +107,6 @@ def set_state(
 
         if broadcast:
             # Broadcast this state change to all listeners
-            # Turn off state broadcasting temporarily to avoid
             self._state_observers = None
             self.broadcast_state()
 
@@ -202,4 +201,14 @@ def execution_state_listener(self, channel_name: str, msg: list[bytes]):
                 if parent_channel and parent_channel == "shell":
                     # Don't broadcast, since this message is already going out.
                     self.set_state(LifecycleStates.CONNECTED, ExecutionStates(execution_state), broadcast=False)
+
+            kernel_status = {
+                "execution_state": self.execution_state,
+                "lifecycle_state": self.lifecycle_state
+            }
+            self.log.debug(f"Sending kernel status awareness {kernel_status}")
+            self.main_client.send_kernel_awareness(kernel_status)
+            self.log.debug(f"Sent kernel status awareness {kernel_status}")
+
+
 

jupyter_rtc_core/session_manager.py

@@ -1,3 +1,4 @@
+import os
 from typing import Optional, Any
 from jupyter_server.services.sessions.sessionmanager import SessionManager, KernelName, ModelName
 from jupyter_server.serverapp import ServerApp
@@ -8,7 +9,7 @@
 
 
 class YDocSessionManager(SessionManager): 
-    """A Jupyter Server Session Manager that's connects YDocuments
+    """A Jupyter Server Session Manager that connects YDocuments
     to Kernel Clients.
     """
 
@@ -65,10 +66,23 @@ async def create_session(
         )
         if kernel_id is None:
             kernel_id = output["kernel"]["id"]
-        
+
         # Connect this session's yroom to the kernel.
-        if type == "notebook": 
-            yroom = self.get_yroom(path, type)
+        if type == "notebook":
+            # If name or path is None, we cannot map to a yroom,
+            # so just move on.
+            if name is None or path is None:
+                self.log.debug("`name` or `path` was not given, so a yroom was not set up for this session.")
+                return output
+            # When JupyterLab creates a session, it uses a fake path
+            # which is the relative path + UUID, i.e. the notebook
+            # name is incorrect temporarily. It later makes multiple
+            # updates to the session to correct the path.
+            # 
+            # Here, we create the true path to store in the fileID service
+            # by dropping the UUID and appending the file name.
+            real_path = os.path.join(os.path.split(path)[0], name)
+            yroom = self.get_yroom(real_path, type)
             # TODO: we likely have a race condition here... need to 
             # think about it more. Currently, the kernel client gets
             # created after the kernel starts fully. We need the