Register RTC content provider

jupyterlab · Sep 5, 2024 · fbbdf9e · fbbdf9e
1 parent 2ca6b0f
commit fbbdf9e
Show file tree

Hide file tree

Showing 4 changed files with 138 additions and 187 deletions.
diff --git a/packages/docprovider-extension/src/filebrowser.ts b/packages/docprovider-extension/src/filebrowser.ts
@@ -3,97 +3,50 @@
  * Distributed under the terms of the Modified BSD License.
  */
 
+import { Drive } from '@jupyterlab/services';
 import {
-  ILabShell,
-  IRouter,
   JupyterFrontEnd,
   JupyterFrontEndPlugin
 } from '@jupyterlab/application';
 import { Dialog, showDialog } from '@jupyterlab/apputils';
 import { IDocumentWidget } from '@jupyterlab/docregistry';
-import {
-  FileBrowser,
-  IDefaultFileBrowser,
-  IFileBrowserFactory
-} from '@jupyterlab/filebrowser';
 import { IEditorTracker } from '@jupyterlab/fileeditor';
 import { ILogger, ILoggerRegistry } from '@jupyterlab/logconsole';
 import { INotebookTracker } from '@jupyterlab/notebook';
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
 import { ITranslator, nullTranslator } from '@jupyterlab/translation';
 
-import { CommandRegistry } from '@lumino/commands';
-
 import { YFile, YNotebook } from '@jupyter/ydoc';
 
 import {
-  ICollaborativeDrive,
   IGlobalAwareness,
-  YDrive
+  RtcContentProvider
 } from '@jupyter/docprovider';
 import { Awareness } from 'y-protocols/awareness';
 
 /**
- * The command IDs used by the file browser plugin.
- */
-namespace CommandIDs {
-  export const openPath = 'filebrowser:open-path';
-}
-
-/**
- * The default collaborative drive provider.
+ * The RTC content provider.
  */
-export const drive: JupyterFrontEndPlugin<ICollaborativeDrive> = {
-  id: '@jupyter/docprovider-extension:drive',
-  description: 'The default collaborative drive provider',
-  provides: ICollaborativeDrive,
+export const rtcContentProvider: JupyterFrontEndPlugin<void> = {
+  id: '@jupyter/docprovider-extension:content',
+  description: 'The RTC content provider',
+  autoStart: true,
   requires: [ITranslator],
-  optional: [IGlobalAwareness],
+  optional: [IGlobalAwareness, ISettingRegistry],
   activate: (
     app: JupyterFrontEnd,
     translator: ITranslator,
-    globalAwareness: Awareness | null
-  ): ICollaborativeDrive => {
+    globalAwareness: Awareness | null,
+    settingRegistry: ISettingRegistry | null
+  ): void => {
     const trans = translator.load('jupyter_collaboration');
-    const drive = new YDrive(app.serviceManager.user, trans, globalAwareness);
-    app.serviceManager.contents.addDrive(drive);
-    return drive;
-  }
-};
+    const rtcContentProvider = new RtcContentProvider(app.serviceManager.user, trans, globalAwareness);
 
-/**
- * Plugin to register the shared model factory for the content type 'file'.
- */
-export const yfile: JupyterFrontEndPlugin<void> = {
-  id: '@jupyter/docprovider-extension:yfile',
-  description:
-    "Plugin to register the shared model factory for the content type 'file'",
-  autoStart: true,
-  requires: [ICollaborativeDrive],
-  optional: [],
-  activate: (app: JupyterFrontEnd, drive: ICollaborativeDrive): void => {
     const yFileFactory = () => {
       return new YFile();
     };
-    drive.sharedModelFactory.registerDocumentFactory('file', yFileFactory);
-  }
-};
+    rtcContentProvider.sharedModelFactory.registerDocumentFactory('file', yFileFactory);
 
-/**
- * Plugin to register the shared model factory for the content type 'notebook'.
- */
-export const ynotebook: JupyterFrontEndPlugin<void> = {
-  id: '@jupyter/docprovider-extension:ynotebook',
-  description:
-    "Plugin to register the shared model factory for the content type 'notebook'",
-  autoStart: true,
-  requires: [ICollaborativeDrive],
-  optional: [ISettingRegistry],
-  activate: (
-    app: JupyterFrontEnd,
-    drive: ICollaborativeDrive,
-    settingRegistry: ISettingRegistry | null
-  ): void => {
     let disableDocumentWideUndoRedo = true;
 
     // Fetch settings if possible.
@@ -121,54 +74,12 @@ export const ynotebook: JupyterFrontEndPlugin<void> = {
         disableDocumentWideUndoRedo
       });
     };
-    drive.sharedModelFactory.registerDocumentFactory(
+    rtcContentProvider.sharedModelFactory.registerDocumentFactory(
       'notebook',
       yNotebookFactory
     );
-  }
-};
-
-/**
- * The default file browser factory provider.
- */
-export const defaultFileBrowser: JupyterFrontEndPlugin<IDefaultFileBrowser> = {
-  id: '@jupyter/docprovider-extension:defaultFileBrowser',
-  description: 'The default file browser factory provider',
-  provides: IDefaultFileBrowser,
-  requires: [ICollaborativeDrive, IFileBrowserFactory],
-  optional: [
-    IRouter,
-    JupyterFrontEnd.ITreeResolver,
-    ILabShell,
-    ISettingRegistry
-  ],
-  activate: async (
-    app: JupyterFrontEnd,
-    drive: ICollaborativeDrive,
-    fileBrowserFactory: IFileBrowserFactory,
-    router: IRouter | null,
-    tree: JupyterFrontEnd.ITreeResolver | null,
-    labShell: ILabShell | null
-  ): Promise<IDefaultFileBrowser> => {
-    const { commands } = app;
-
-    app.serviceManager.contents.addDrive(drive);
-
-    // Manually restore and load the default file browser.
-    const defaultBrowser = fileBrowserFactory.createFileBrowser('filebrowser', {
-      auto: false,
-      restore: false,
-      driveName: drive.name
-    });
-    void Private.restoreBrowser(
-      defaultBrowser,
-      commands,
-      router,
-      tree,
-      labShell
-    );
 
-    return defaultBrowser;
+    Drive.getContentProviderRegistry().register(rtcContentProvider);
   }
 };
 
@@ -265,58 +176,3 @@ export const logger: JupyterFrontEndPlugin<void> = {
     })();
   }
 };
-
-namespace Private {
-  /**
-   * Restores file browser state and overrides state if tree resolver resolves.
-   */
-  export async function restoreBrowser(
-    browser: FileBrowser,
-    commands: CommandRegistry,
-    router: IRouter | null,
-    tree: JupyterFrontEnd.ITreeResolver | null,
-    labShell: ILabShell | null
-  ): Promise<void> {
-    const restoring = 'jp-mod-restoring';
-
-    browser.addClass(restoring);
-
-    if (!router) {
-      await browser.model.restore(browser.id);
-      await browser.model.refresh();
-      browser.removeClass(restoring);
-      return;
-    }
-
-    const listener = async () => {
-      router.routed.disconnect(listener);
-
-      const paths = await tree?.paths;
-      if (paths?.file || paths?.browser) {
-        // Restore the model without populating it.
-        await browser.model.restore(browser.id, false);
-        if (paths.file) {
-          await commands.execute(CommandIDs.openPath, {
-            path: paths.file,
-            dontShowBrowser: true
-          });
-        }
-        if (paths.browser) {
-          await commands.execute(CommandIDs.openPath, {
-            path: paths.browser,
-            dontShowBrowser: true
-          });
-        }
-      } else {
-        await browser.model.restore(browser.id);
-        await browser.model.refresh();
-      }
-      browser.removeClass(restoring);
-
-      if (labShell?.isEmpty('main')) {
-        void commands.execute('launcher:create');
-      }
-    };
-    router.routed.connect(listener);
-  }
-}
diff --git a/packages/docprovider-extension/src/index.ts b/packages/docprovider-extension/src/index.ts
@@ -8,10 +8,7 @@
 import { JupyterFrontEndPlugin } from '@jupyterlab/application';
 
 import {
-  drive,
-  yfile,
-  ynotebook,
-  defaultFileBrowser,
+  rtcContentProvider,
   logger
 } from './filebrowser';
 import { notebookCellExecutor } from './executor';
@@ -20,10 +17,7 @@ import { notebookCellExecutor } from './executor';
  * Export the plugins as default.
  */
 const plugins: JupyterFrontEndPlugin<any>[] = [
-  drive,
-  yfile,
-  ynotebook,
-  defaultFileBrowser,
+  rtcContentProvider,
   logger,
   notebookCellExecutor
 ];

diff --git a/packages/docprovider/src/tokens.ts b/packages/docprovider/src/tokens.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
 
-import { DocumentChange, IAwareness, YDocument } from '@jupyter/ydoc';
+import { IAwareness } from '@jupyter/ydoc';
 import { Contents } from '@jupyterlab/services';
 
 import { Token } from '@lumino/coreutils';
@@ -23,13 +23,6 @@ export const IGlobalAwareness = new Token<IAwareness>(
   '@jupyter/collaboration:IGlobalAwareness'
 );
 
-/**
- * A document factory for registering shared models
- */
-export type SharedDocumentFactory = (
-  options: Contents.ISharedFactoryOptions
-) => YDocument<DocumentChange>;
-
 /**
  * A Collaborative implementation for an `IDrive`, talking to the
  * server using the Jupyter REST API and a WebSocket connection.
@@ -45,16 +38,6 @@ export interface ICollaborativeDrive extends Contents.IDrive {
  * Yjs sharedModel factory for real-time collaboration.
  */
 export interface ISharedModelFactory extends Contents.ISharedFactory {
-  /**
-   * Register a SharedDocumentFactory.
-   *
-   * @param type Document type
-   * @param factory Document factory
-   */
-  registerDocumentFactory(
-    type: Contents.ContentType,
-    factory: SharedDocumentFactory
-  ): void;
 }
 
 /**