Upgrade to Jupyter Collaboration 4 (#227)

* upgrade to Jupyter Collaboration 4

Co-authored-by: David L. Qiu <[email protected]>

* add EOL

* deduplicate yarn via `jlpm dlx yarn-berry-deduplicate`

* remove unnecessary token casting

* Update packages/jupyterlab-chat/src/widget.tsx

Co-authored-by: Nicolas Brichet <[email protected]>

* bump jupyterlab packages to 4.4+, notebook package to 7.4, ts to 5.5.4, lumino packages to latest versions used in JupyterLab 4.4

* fix jest tests by adding IntersectionObserver mock

---------

Co-authored-by: Andrii Ieroshenko <[email protected]>
Co-authored-by: Nicolas Brichet <[email protected]>

Author: 3 people

packages/jupyter-chat/jest.config.js

@@ -32,6 +32,7 @@ module.exports = {
     '!src/**/.ipynb_checkpoints/*'
   ],
   coverageReporters: ['lcov', 'text'],
+  setupFilesAfterEnv: ['<rootDir>/jest.setup.js'],
   testRegex: 'src/.*/.*.spec.ts[x]?$',
   transformIgnorePatterns: [`/node_modules/(?!${esModules}).+`]
 };

packages/jupyter-chat/jest.setup.js

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
+/*
+ * Mock IntersectionObserver used by @jupyterlab/notebook for windowing.
+ * We use a simple mock here instead of @jupyterlab/testutils/lib/jest-shim
+ * to avoid extra dependencies. This lightweight mock is sufficient for our tests.
+ */
+global.IntersectionObserver = class IntersectionObserver {
+  constructor() {}
+  disconnect() {}
+  observe() {}
+  unobserve() {}
+};

packages/jupyterlab-chat-extension/package.json

@@ -47,25 +47,25 @@
     "watch:labextension": "jupyter labextension watch ."
   },
   "dependencies": {
-    "@jupyter-notebook/application": "^7.2.0",
-    "@jupyter/collaborative-drive": "^3.0.0",
-    "@jupyter/ydoc": "^2.0.0 || ^3.0.0",
-    "@jupyterlab/application": "^4.2.0",
-    "@jupyterlab/apputils": "^4.3.0",
-    "@jupyterlab/coreutils": "^6.2.0",
-    "@jupyterlab/docregistry": "^4.2.0",
-    "@jupyterlab/filebrowser": "^4.2.0",
-    "@jupyterlab/launcher": "^4.2.0",
-    "@jupyterlab/notebook": "^4.2.0",
-    "@jupyterlab/rendermime": "^4.2.0",
-    "@jupyterlab/services": "^7.2.0",
-    "@jupyterlab/settingregistry": "^4.2.0",
-    "@jupyterlab/translation": "^4.2.0",
-    "@jupyterlab/ui-components": "^4.2.0",
-    "@lumino/commands": "^2.0.0",
-    "@lumino/coreutils": "^2.0.0",
-    "@lumino/signaling": "^2.0.0",
-    "@lumino/widgets": "^2.0.0",
+    "@jupyter-notebook/application": "^7.4.0",
+    "@jupyter/collaborative-drive": "^4.0.2",
+    "@jupyter/ydoc": "^3.0.0",
+    "@jupyterlab/application": "^4.4.0",
+    "@jupyterlab/apputils": "^4.5.0",
+    "@jupyterlab/coreutils": "^6.4.0",
+    "@jupyterlab/docregistry": "^4.4.0",
+    "@jupyterlab/filebrowser": "^4.4.0",
+    "@jupyterlab/launcher": "^4.4.0",
+    "@jupyterlab/notebook": "^4.4.0",
+    "@jupyterlab/rendermime": "^4.4.0",
+    "@jupyterlab/services": "^7.4.0",
+    "@jupyterlab/settingregistry": "^4.4.0",
+    "@jupyterlab/translation": "^4.4.0",
+    "@jupyterlab/ui-components": "^4.4.0",
+    "@lumino/commands": "^2.3.2",
+    "@lumino/coreutils": "^2.2.1",
+    "@lumino/signaling": "^2.1.4",
+    "@lumino/widgets": "^2.7.0",
     "jupyterlab-chat": "^0.12.0",
     "react": "^18.2.0",
     "y-protocols": "^1.0.5",
@@ -82,7 +82,7 @@
     "rimraf": "^5.0.1",
     "source-map-loader": "^1.0.2",
     "style-loader": "^3.3.1",
-    "typescript": "~5.0.2",
+    "typescript": "~5.5.4",
     "yjs": "^13.5.0"
   },
   "sideEffects": [

packages/jupyterlab-chat-extension/src/index.ts

@@ -20,10 +20,7 @@ import {
   chatIcon,
   readIcon
 } from '@jupyter/chat';
-import {
-  ICollaborativeDrive,
-  SharedDocumentFactory
-} from '@jupyter/collaborative-drive';
+import { ICollaborativeContentProvider } from '@jupyter/collaborative-drive';
 import {
   ILayoutRestorer,
   JupyterFrontEnd,
@@ -114,7 +111,7 @@ const docFactories: JupyterFrontEndPlugin<IChatFactory> = {
     IActiveCellManagerToken,
     IAttachmentOpenerRegistry,
     IChatCommandRegistry,
-    ICollaborativeDrive,
+    ICollaborativeContentProvider,
     IDefaultFileBrowser,
     IInputToolbarRegistryFactory,
     ILayoutRestorer,
@@ -133,7 +130,7 @@ const docFactories: JupyterFrontEndPlugin<IChatFactory> = {
     activeCellManager: IActiveCellManager | null,
     attachmentOpenerRegistry: IAttachmentOpenerRegistry,
     chatCommandRegistry: IChatCommandRegistry,
-    drive: ICollaborativeDrive | null,
+    drive: ICollaborativeContentProvider | null,
     filebrowser: IDefaultFileBrowser | null,
     inputToolbarFactory: IInputToolbarRegistryFactory,
     restorer: ILayoutRestorer | null,
@@ -175,11 +172,11 @@ const docFactories: JupyterFrontEndPlugin<IChatFactory> = {
         previousDirectory &&
         previousDirectory !== currentDirectory
       ) {
-        drive
+        app.serviceManager.contents
           .get(previousDirectory)
           .then(contentModel => {
             if (contentModel.content.length === 0) {
-              drive.delete(previousDirectory).catch(e => {
+              app.serviceManager.contents.delete(previousDirectory).catch(e => {
                 // no-op, the directory might not be empty
               });
             }
@@ -194,18 +191,18 @@ const docFactories: JupyterFrontEndPlugin<IChatFactory> = {
         Promise.resolve(null);
 
       if (drive && currentDirectory && previousDirectory !== currentDirectory) {
-        directoryCreation = drive
+        directoryCreation = app.serviceManager.contents
           .get(currentDirectory, { content: false })
           .catch(async () => {
-            return drive
+            return app.serviceManager.contents
               .newUntitled({
                 type: 'directory'
               })
               .then(async contentModel => {
-                return drive
+                return app.serviceManager.contents
                   .rename(contentModel.path, currentDirectory)
                   .catch(e => {
-                    drive.delete(contentModel.path);
+                    app.serviceManager.contents.delete(contentModel.path);
                     throw new Error(e);
                   });
               })
@@ -270,9 +267,7 @@ const docFactories: JupyterFrontEndPlugin<IChatFactory> = {
     app.docRegistry.addFileType(chatFileType);
 
     if (drive) {
-      const chatFactory: SharedDocumentFactory = () => {
-        return YChat.create();
-      };
+      const chatFactory = () => YChat.create();
       drive.sharedModelFactory.registerDocumentFactory('chat', chatFactory);
     }
 
@@ -364,7 +359,7 @@ const chatCommands: JupyterFrontEndPlugin<void> = {
   id: pluginIds.chatCommands,
   description: 'The commands to create or open a chat.',
   autoStart: true,
-  requires: [ICollaborativeDrive, IChatFactory],
+  requires: [ICollaborativeContentProvider, IChatFactory],
   optional: [
     IActiveCellManagerToken,
     IChatPanel,
@@ -375,7 +370,7 @@ const chatCommands: JupyterFrontEndPlugin<void> = {
   ],
   activate: (
     app: JupyterFrontEnd,
-    drive: ICollaborativeDrive,
+    drive: ICollaborativeContentProvider,
     factory: IChatFactory,
     activeCellManager: IActiveCellManager | null,
     chatPanel: ChatPanel | null,
@@ -434,23 +429,29 @@ const chatCommands: JupyterFrontEndPlugin<void> = {
 
         let fileExist = true;
         if (filepath) {
-          await drive.get(filepath, { content: false }).catch(() => {
-            fileExist = false;
-          });
+          await app.serviceManager.contents
+            .get(filepath, { content: false })
+            .catch(() => {
+              fileExist = false;
+            });
         } else {
           fileExist = false;
         }
 
         // Create a new file if it does not exists
         if (!fileExist) {
           // Create a new untitled chat.
-          let model: Contents.IModel | null = await drive.newUntitled({
-            type: 'file',
-            ext: chatFileType.extensions[0]
-          });
+          let model: Contents.IModel | null =
+            await app.serviceManager.contents.newUntitled({
+              type: 'file',
+              ext: chatFileType.extensions[0]
+            });
           // Rename it if a name has been provided.
           if (filepath) {
-            model = await drive.rename(model.path, filepath);
+            model = await app.serviceManager.contents.rename(
+              model.path,
+              filepath
+            );
           }
 
           if (!model) {
@@ -470,7 +471,8 @@ const chatCommands: JupyterFrontEndPlugin<void> = {
           });
         } else {
           commands.execute('docmanager:open', {
-            path: `RTC:${filepath}`,
+            // TODO: support JCollab v3 by optionally prefixing 'RTC:'
+            path: `${filepath}`,
             factory: FACTORY
           });
         }
@@ -553,9 +555,11 @@ const chatCommands: JupyterFrontEndPlugin<void> = {
             }
 
             let fileExist = true;
-            await drive.get(filepath, { content: false }).catch(() => {
-              fileExist = false;
-            });
+            await app.serviceManager.contents
+              .get(filepath, { content: false })
+              .catch(() => {
+                fileExist = false;
+              });
 
             if (!fileExist) {
               showErrorMessage(
@@ -589,7 +593,7 @@ const chatCommands: JupyterFrontEndPlugin<void> = {
                 return;
               }
 
-              const model = await drive.get(filepath);
+              const model = await app.serviceManager.contents.get(filepath);
 
               // Create a share model from the chat file
               const sharedModel = drive.sharedModelFactory.createNew({
@@ -618,8 +622,9 @@ const chatCommands: JupyterFrontEndPlugin<void> = {
               factory.tracker.add(widget);
             } else {
               // The chat is opened in the main area
+              // TODO: support JCollab v3 by optionally prefixing 'RTC:'
               commands.execute('docmanager:open', {
-                path: `RTC:${filepath}`,
+                path: `${filepath}`,
                 factory: FACTORY
               });
             }
@@ -668,7 +673,7 @@ const chatPanel: JupyterFrontEndPlugin<ChatPanel> = {
   description: 'The chat panel widget.',
   autoStart: true,
   provides: IChatPanel,
-  requires: [IChatFactory, ICollaborativeDrive, IRenderMimeRegistry],
+  requires: [IChatFactory, ICollaborativeContentProvider, IRenderMimeRegistry],
   optional: [
     IAttachmentOpenerRegistry,
     IChatCommandRegistry,
@@ -681,7 +686,7 @@ const chatPanel: JupyterFrontEndPlugin<ChatPanel> = {
   activate: (
     app: JupyterFrontEnd,
     factory: IChatFactory,
-    drive: ICollaborativeDrive,
+    drive: ICollaborativeContentProvider,
     rmRegistry: IRenderMimeRegistry,
     attachmentOpenerRegistry: IAttachmentOpenerRegistry,
     chatCommandRegistry: IChatCommandRegistry,
@@ -700,7 +705,7 @@ const chatPanel: JupyterFrontEndPlugin<ChatPanel> = {
      */
     const chatPanel = new ChatPanel({
       commands,
-      drive,
+      contentsManager: app.serviceManager.contents,
       rmRegistry,
       themeManager,
       defaultDirectory,

packages/jupyterlab-chat/package.json

@@ -43,7 +43,7 @@
   },
   "dependencies": {
     "@jupyter/chat": "^0.12.0",
-    "@jupyter/collaborative-drive": "^3.0.0",
+    "@jupyter/collaborative-drive": "^4.0.2",
     "@jupyter/ydoc": "^2.0.0 || ^3.0.0",
     "@jupyterlab/application": "^4.2.0",
     "@jupyterlab/apputils": "^4.3.0",

packages/jupyterlab-chat/src/factory.ts

@@ -111,6 +111,16 @@ export class ChatWidgetFactory extends ABCWidgetFactory<
     });
   }
 
+  /**
+   * IMPORTANT: this property must be defined to use the `RtcContentProvider`
+   * registered by `jupyter_collaboration`. Without this, the chat document
+   * widgets will not connect.
+   */
+  get contentProviderId(): string {
+    return 'rtc';
+  }
+  // Must override both getter and setter from ABCFactory for type compatibility.
+  set contentProviderId(_value: string | undefined) {}
   private _themeManager: IThemeManager | null;
   private _rmRegistry: IRenderMimeRegistry;
   private _chatCommandRegistry?: IChatCommandRegistry;

packages/jupyterlab-chat/src/widget.tsx

@@ -12,7 +12,7 @@ import {
   IMessageFooterRegistry,
   readIcon
 } from '@jupyter/chat';
-import { ICollaborativeDrive } from '@jupyter/collaborative-drive';
+import { Contents } from '@jupyterlab/services';
 import { IThemeManager } from '@jupyterlab/apputils';
 import { PathExt } from '@jupyterlab/coreutils';
 import { DocumentWidget } from '@jupyterlab/docregistry';
@@ -105,7 +105,7 @@ export class ChatPanel extends SidePanel {
     super(options);
     this.addClass(SIDEPANEL_CLASS);
     this._commands = options.commands;
-    this._drive = options.drive;
+    this._contentsManager = options.contentsManager;
     this._rmRegistry = options.rmRegistry;
     this._themeManager = options.themeManager;
     this._defaultDirectory = options.defaultDirectory;
@@ -205,9 +205,9 @@ export class ChatPanel extends SidePanel {
    */
   updateChatList = async (): Promise<void> => {
     const extension = chatFileType.extensions[0];
-    this._drive
+    this._contentsManager
       .get(this._defaultDirectory)
-      .then(contentModel => {
+      .then((contentModel: Contents.IModel) => {
         const chatsNames: { [name: string]: string } = {};
         (contentModel.content as any[])
           .filter(f => f.type === 'file' && f.name.endsWith(extension))
@@ -300,7 +300,7 @@ export class ChatPanel extends SidePanel {
   );
   private _commands: CommandRegistry;
   private _defaultDirectory: string;
-  private _drive: ICollaborativeDrive;
+  private _contentsManager: Contents.IManager;
   private _openChat: ReactWidget;
   private _rmRegistry: IRenderMimeRegistry;
   private _themeManager: IThemeManager | null;
@@ -320,7 +320,7 @@ export namespace ChatPanel {
    */
   export interface IOptions extends SidePanel.IOptions {
     commands: CommandRegistry;
-    drive: ICollaborativeDrive;
+    contentsManager: Contents.IManager;
     rmRegistry: IRenderMimeRegistry;
     themeManager: IThemeManager | null;
     defaultDirectory: string;

python/jupyterlab-chat/pyproject.toml

@@ -27,19 +27,14 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
 ]
 dependencies = [
-    "jupyterlab~=4.0",
-    "jupyter_collaboration>=3,<4",
+    "jupyter_collaboration>=4,<5",
     "jupyter_server>=2.0.1,<3",
-    "jupyter_ydoc",
-    "pycrdt"
-]
-keywords = [
-    "jupyter",
-    "jupyterlab",
-    "jupyterlab-extension"
+    "jupyter_ydoc>=3.0.0,<4.0.0",
+    "pycrdt>=0.12.0,<0.13.0",
 ]
+keywords = ["jupyter", "jupyterlab", "jupyterlab-extension"]
 authors = [
-    { name = "Jupyter Development Team", email = "[email protected]" }
+    { name = "Jupyter Development Team", email = "[email protected]" },
 ]
 dynamic = ["version"]
 
@@ -50,7 +45,7 @@ test = [
     "pytest",
     "pytest-asyncio",
     "pytest-cov",
-    "pytest-jupyter[server]>=0.6.0"
+    "pytest-jupyter[server]>=0.6.0",
 ]
 
 [project.urls]