WIP: docprovider updates.

Author: 3coins

.gitignore

@@ -123,3 +123,7 @@ dmypy.json
 
 # Yarn cache
 .yarn/
+
+
+.vscode/
+playground/

devenv-jcollab-backend.yml

@@ -0,0 +1,12 @@
+name: rtccore-jcollab-backend
+channels:
+  - conda-forge
+dependencies:
+  - python
+  - nodejs=22
+  - uv
+  - jupyterlab
+  - pip:
+      - jupyter_docprovider>=2.0.2,<3
+      - "jupyter_server_ydoc>=2.0.2,<3"
+      - "jupyterlab>=4.4.0,<5.0.0"

package.json

@@ -59,13 +59,30 @@
         "watch:labextension": "jupyter labextension watch ."
     },
     "dependencies": {
-        "@jupyterlab/application": "^4.0.0",
-        "@jupyterlab/coreutils": "^6.0.0",
-        "@jupyterlab/services": "^7.0.0",
-        "@jupyterlab/settingregistry": "^4.0.0"
+        "@jupyter/collaborative-drive": "^4.0.2",
+        "@jupyter/ydoc": "^2.1.3 || ^3.0.0",
+        "@jupyterlab/application": "^4.4.0",
+        "@jupyterlab/apputils": "^4.4.0",
+        "@jupyterlab/cells": "^4.4.0",
+        "@jupyterlab/coreutils": "^6.4.0",
+        "@jupyterlab/docregistry": "^4.4.0",
+        "@jupyterlab/filebrowser": "^4.4.0",
+        "@jupyterlab/fileeditor": "^4.4.0",
+        "@jupyterlab/logconsole": "^4.4.0",
+        "@jupyterlab/notebook": "^4.4.0",
+        "@jupyterlab/services": "^7.4.0",
+        "@jupyterlab/settingregistry": "^4.4.0",
+        "@jupyterlab/translation": "^4.4.0",
+        "@lumino/coreutils": "^2.2.1",
+        "@lumino/disposable": "^2.1.4",
+        "@lumino/signaling": "^2.1.4",
+        "y-protocols": "^1.0.5",
+        "y-websocket": "^1.3.15",
+        "yjs": "^13.5.40"
     },
     "devDependencies": {
         "@jupyterlab/builder": "^4.0.0",
+        "@jupyterlab/testing": "^4.4.0",
         "@jupyterlab/testutils": "^4.0.0",
         "@types/jest": "^29.2.0",
         "@types/json-schema": "^7.0.11",

src/docprovider/awareness.ts

@@ -0,0 +1,99 @@
+/* -----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+
+import { User } from '@jupyterlab/services';
+
+import { IDisposable } from '@lumino/disposable';
+
+import { IAwareness } from '@jupyter/ydoc';
+
+import { WebsocketProvider } from 'y-websocket';
+
+export interface IContent {
+  type: string;
+  body: string;
+}
+
+/**
+ * A class to provide Yjs synchronization over WebSocket.
+ *
+ * We specify custom messages that the server can interpret. For reference please look in yjs_ws_server.
+ *
+ */
+export class WebSocketAwarenessProvider
+  extends WebsocketProvider
+  implements IDisposable
+{
+  /**
+   * Construct a new WebSocketAwarenessProvider
+   *
+   * @param options The instantiation options for a WebSocketAwarenessProvider
+   */
+  constructor(options: WebSocketAwarenessProvider.IOptions) {
+    super(options.url, options.roomID, options.awareness.doc, {
+      awareness: options.awareness
+    });
+
+    this._awareness = options.awareness;
+
+    this._user = options.user;
+    this._user.ready
+      .then(() => this._onUserChanged(this._user))
+      .catch(e => console.error(e));
+    this._user.userChanged.connect(this._onUserChanged, this);
+  }
+
+  get isDisposed(): boolean {
+    return this._isDisposed;
+  }
+
+  dispose(): void {
+    if (this._isDisposed) {
+      return;
+    }
+
+    this._user.userChanged.disconnect(this._onUserChanged, this);
+    this._isDisposed = true;
+    this.destroy();
+  }
+
+  private _onUserChanged(user: User.IManager): void {
+    this._awareness.setLocalStateField('user', user.identity);
+  }
+
+  private _isDisposed = false;
+  private _user: User.IManager;
+  private _awareness: IAwareness;
+}
+
+/**
+ * A namespace for WebSocketAwarenessProvider statics.
+ */
+export namespace WebSocketAwarenessProvider {
+  /**
+   * The instantiation options for a WebSocketAwarenessProvider.
+   */
+  export interface IOptions {
+    /**
+     * The server URL
+     */
+    url: string;
+
+    /**
+     * The room ID
+     */
+    roomID: string;
+
+    /**
+     * The awareness object
+     */
+    awareness: IAwareness;
+
+    /**
+     * The user data
+     */
+    user: User.IManager;
+  }
+}

src/docprovider/executor.ts

@@ -0,0 +1,31 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+/**
+ * @packageDocumentation
+ * @module docprovider-extension
+ */
+
+import { NotebookCellServerExecutor } from "./notebookCellExecutor"
+import {
+  JupyterFrontEnd,
+  JupyterFrontEndPlugin
+} from '@jupyterlab/application';
+import { PageConfig } from '@jupyterlab/coreutils';
+import { INotebookCellExecutor, runCell } from '@jupyterlab/notebook';
+
+export const notebookCellExecutor: JupyterFrontEndPlugin<INotebookCellExecutor> =
+  {
+    id: '@jupyter/rtc-core/docprovider-extension:notebook-cell-executor',
+    description:
+      'Add notebook cell executor that uses REST API instead of kernel protocol over WebSocket.',
+    autoStart: true,
+    provides: INotebookCellExecutor,
+    activate: (app: JupyterFrontEnd): INotebookCellExecutor => {
+      if (PageConfig.getOption('serverSideExecution') === 'true') {
+        return new NotebookCellServerExecutor({
+          serverSettings: app.serviceManager.serverSettings
+        });
+      }
+      return Object.freeze({ runCell });
+    }
+  };