Remove unwanted jupyter collaboration code; use fileID index API to create ID on kernel session creation

Author: Zsailer

jupyter_rtc_core/app.py

@@ -20,8 +20,8 @@ class RtcExtensionApp(ExtensionApp):
         # (r"api/collaboration/room/JupyterLab:globalAwareness/?", GlobalAwarenessWebsocket),
         # # ydoc websocket
         (r"api/collaboration/room/(.*)", YRoomWebsocket),
-        # handler that just adds compatibility with Jupyter Collaboration's frontend
-        (r"api/collaboration/session/(.*)", YRoomSessionHandler),
+        # # handler that just adds compatibility with Jupyter Collaboration's frontend
+        # (r"api/collaboration/session/(.*)", YRoomSessionHandler),
         (r"api/fileid/index", FileIDIndexHandler)
     ]
 

jupyter_rtc_core/kernels/websocket_connection.py

@@ -35,6 +35,9 @@ def handle_incoming_message(self, incoming_msg):
     def handle_outgoing_message(self, channel_name, msg):
         """Handle the ZMQ message."""
         try:
+            # Remove signature from message to be compatible with Jupyter Server.
+            # See here: https://github.com/jupyter-server/jupyter_server/blob/4ee6e1ddc058f87b2c5699cd6b9caf780a013044/jupyter_server/services/kernels/connection/channels.py#L504
+            msg = msg[1:]
             msg = serialize_msg_to_ws_v1(msg, channel_name)
             self.websocket_handler.write_message(msg, binary=True)
         except WebSocketClosedError:

jupyter_rtc_core/session_manager.py

@@ -37,10 +37,13 @@ def get_kernel_client(self, kernel_id) -> DocumentAwareKernelClient:
 
     def get_yroom(self, path) -> YRoom:
         """Get the yroom for a given path."""
-        file_id = self.file_id_manager.get_id(path)
-        yroom = self.yroom_manager.get_room(file_id)
-        return yroom 
-    
+        print("DO WE SEE THIS?")
+        print(path)
+        file_id = self.file_id_manager.index(path)
+        room_id = f"json:notebook:{file_id}"
+        yroom = self.yroom_manager.get_room(room_id)
+        return yroom
+
     async def create_session(
         self,
         path: Optional[str] = None,
@@ -53,27 +56,27 @@ async def create_session(
         After creating a session, connects the yroom to the kernel client.
         """
         output = await super().create_session(
-            path, 
+            path,
             name,
             type,
-            kernel_name, 
+            kernel_name,
             kernel_id
         )
         if kernel_id is None:
             kernel_id = output["kernel"]["id"]
 
-        
         # NOTE: Question - is room_id equivalent to file ID? 
         # Connect this session's yroom to the kernel.
-        yroom = self.get_yroom(path)
-        # 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 
-        # kernel client instantiated _before_ trying to connect
-        # the yroom.
-        kernel_client = self.get_kernel_client(kernel_id)
-        await kernel_client.add_yroom(yroom)
-        self.log.info(f"Connected yroom {yroom.room_id} to kernel {kernel_id}. yroom: {yroom}")
+        if type == "notebook": 
+            yroom = self.get_yroom(path)
+            # 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 
+            # kernel client instantiated _before_ trying to connect
+            # the yroom.
+            kernel_client = self.get_kernel_client(kernel_id)
+            await kernel_client.add_yroom(yroom)
+            self.log.info(f"Connected yroom {yroom.room_id} to kernel {kernel_id}. yroom: {yroom}")
         return output
 
     async def delete_session(self, session_id):

src/docprovider/executor.ts

@@ -2,5 +2,3 @@
 // Distributed under the terms of the Modified BSD License.
 
 export * from './filebrowser'
-export * from './executor'
-

src/docprovider/index.ts

@@ -10,7 +10,7 @@ import { ServerConnection, Contents } from '@jupyterlab/services';
  * Document session endpoint provided by `jupyter_collaboration`
  * See https://github.com/jupyterlab/jupyter_collaboration
  */
-const DOC_SESSION_URL = 'api/collaboration/session';
+// const DOC_SESSION_URL = 'api/collaboration/session';
 
 /**
  * Document session model
@@ -71,44 +71,4 @@ export async function requestAPI<T = any>(
   }
 
   return data;
-}
-
-export async function requestDocSession(
-  format: string,
-  type: string,
-  path: string
-): Promise<ISessionModel> {
-  const settings = ServerConnection.makeSettings();
-  const url = URLExt.join(
-    settings.baseUrl,
-    DOC_SESSION_URL,
-    encodeURIComponent(path)
-  );
-  const body = {
-    method: 'PUT',
-    body: JSON.stringify({ format, type })
-  };
-
-  let response: Response;
-  try {
-    response = await ServerConnection.makeRequest(url, body, settings);
-  } catch (error) {
-    throw new ServerConnection.NetworkError(error as Error);
-  }
-
-  let data: any = await response.text();
-
-  if (data.length > 0) {
-    try {
-      data = JSON.parse(data);
-    } catch (error) {
-      console.log('Not a JSON response body.', response);
-    }
-  }
-
-  if (!response.ok) {
-    throw new ServerConnection.ResponseError(response, data.message || data);
-  }
-
-  return data;
-}
+}

src/docprovider/notebookCellExecutor.ts

@@ -143,6 +143,8 @@ export class RtcContentProvider
     if (typeof options.format !== 'string') {
       return;
     }
+    
+
     try {
       const provider = new WebSocketProvider({
         url: URLExt.join(this._serverSettings.wsUrl, DOCUMENT_PROVIDER_URL),

src/docprovider/requests.ts

@@ -7,16 +7,14 @@ import { IDocumentProvider } from '@jupyter/collaborative-drive';
 import { showErrorMessage, Dialog } from '@jupyterlab/apputils';
 import { User } from '@jupyterlab/services';
 import { TranslationBundle } from '@jupyterlab/translation';
-
 import { PromiseDelegate } from '@lumino/coreutils';
 import { Signal } from '@lumino/signaling';
 
 import { DocumentChange, YDocument } from '@jupyter/ydoc';
 
 import { Awareness } from 'y-protocols/awareness';
 import { WebsocketProvider as YWebsocketProvider } from 'y-websocket';
-
-import { requestDocSession } from './requests';
+import { requestAPI } from './requests';
 
 /**
  * A class to provide Yjs synchronization over WebSocket.
@@ -95,19 +93,37 @@ export class WebSocketProvider implements IDocumentProvider {
   }
 
   private async _connect(): Promise<void> {
-    const session = await requestDocSession(
-      this._format,
-      this._contentType,
-      this._path
-    );
+    let resp = await requestAPI(
+      "api/fileid/index?path=" + this._path, 
+      {
+        method: "POST"
+      }
+    )
+    // let resp: any; 
+    // console.log(this._path);
+    // while (true) {
+    //   try { 
+    //     resp = await requestAPI(
+    //       "api/fileid/id?path=" + this._path
+    //     )
+    //     console.log(resp)
+    //     break;
+    //   } catch {
+    //     console.log("Didn't see a file ID; trying again.")
+    //   }
+    //   // Wait 1 second to try again
+    //   await new Promise(f => setTimeout(f, 5000));
+    // }
+
+    const fileId = resp["id"];
 
     this._yWebsocketProvider = new YWebsocketProvider(
       this._serverUrl,
-      `${session.format}:${session.type}:${session.fileId}`,
+      `${this._format}:${this._contentType}:${fileId}`,
       this._sharedModel.ydoc,
       {
         disableBc: true,
-        params: { sessionId: session.sessionId },
+        // params: { sessionId: session.sessionId },
         awareness: this._awareness
       }
     );