Move RTC packages to an extension (jupyterlab#13907)

* Removes packages

* Removes collaborative flag

* Use collaborative flag to check whether the RTC extension is installed

* Fixes IDrives

* Removes jupyter_server_ydoc as dependency

* Restore staging

* Adds rtc extension import and restores staging

* Review

* Rebase and fix yarn.lock

* Improves the collaborative flag per document

---------

Co-authored-by: Frédéric Collonval <[email protected]>

Author: hbcarlos

.github/labeler.yml

@@ -66,12 +66,6 @@ pkg:codeeditor:
   - packages/codeeditor/**/*
   - packages/codeeditor/*
 
-pkg:collaboration:
-  - packages/collaboration/**/*
-  - packages/collaboration/*
-  - packages/collaboration-extension/**/*
-  - packages/collaboration-extension/*
-
 pkg:codemirror:
   - packages/codemirror/**/*
   - packages/codemirror/*
@@ -112,10 +106,6 @@ pkg:docmanager:
   - packages/docmanager-extension/**/*
   - packages/docmanager-extension/*
 
-pkg:docprovider:
-  - packages/docprovider/**/*
-  - packages/docprovider/*
-
 pkg:docregistry:
   - packages/docregistry/**/*
   - packages/docregistry/*

.github/workflows/linuxjs-tests.yml

@@ -31,7 +31,6 @@ jobs:
             js-csvviewer,
             js-debugger,
             js-docmanager,
-            js-docprovider,
             js-docregistry,
             js-documentsearch,
             js-filebrowser,

buildutils/src/ensure-repo.ts

@@ -203,7 +203,6 @@ const SKIP_CSS: Dict<string[]> = {
     '@jupyterlab/console-extension',
     '@jupyterlab/csvviewer',
     '@jupyterlab/documentsearch',
-    '@jupyterlab/docprovider',
     '@jupyterlab/csvviewer-extension',
     '@jupyterlab/debugger',
     '@jupyterlab/debugger-extension',
@@ -256,8 +255,6 @@ const SKIP_CSS: Dict<string[]> = {
     '@jupyterlab/tooltip-extension',
     '@jupyterlab/translation-extension',
     '@jupyterlab/ui-components-extension',
-    '@jupyterlab/collaboration',
-    '@jupyterlab/collaboration-extension',
     '@jupyterlab/vega5-extension'
   ],
   '@jupyterlab/notebook': ['@jupyterlab/application'],

dev_mode/package.json

@@ -30,8 +30,6 @@
     "@jupyterlab/codeeditor": "~4.0.0-alpha.18",
     "@jupyterlab/codemirror": "~4.0.0-alpha.18",
     "@jupyterlab/codemirror-extension": "~4.0.0-alpha.18",
-    "@jupyterlab/collaboration": "~4.0.0-alpha.18",
-    "@jupyterlab/collaboration-extension": "~4.0.0-alpha.18",
     "@jupyterlab/completer": "~4.0.0-alpha.18",
     "@jupyterlab/completer-extension": "~4.0.0-alpha.18",
     "@jupyterlab/console": "~4.0.0-alpha.18",
@@ -43,7 +41,6 @@
     "@jupyterlab/debugger-extension": "~4.0.0-alpha.18",
     "@jupyterlab/docmanager": "~4.0.0-alpha.18",
     "@jupyterlab/docmanager-extension": "~4.0.0-alpha.18",
-    "@jupyterlab/docprovider": "~4.0.0-alpha.18",
     "@jupyterlab/docregistry": "~4.0.0-alpha.18",
     "@jupyterlab/documentsearch": "~4.0.0-alpha.18",
     "@jupyterlab/documentsearch-extension": "~4.0.0-alpha.18",
@@ -136,7 +133,6 @@
     "@jupyterlab/cell-toolbar-extension": "~4.0.0-alpha.18",
     "@jupyterlab/celltags-extension": "~4.0.0-alpha.18",
     "@jupyterlab/codemirror-extension": "~4.0.0-alpha.18",
-    "@jupyterlab/collaboration-extension": "~4.0.0-alpha.18",
     "@jupyterlab/completer-extension": "~4.0.0-alpha.18",
     "@jupyterlab/console-extension": "~4.0.0-alpha.18",
     "@jupyterlab/coreutils": "~6.0.0-alpha.18",
@@ -217,7 +213,6 @@
       "@jupyterlab/cell-toolbar-extension": "",
       "@jupyterlab/celltags-extension": "",
       "@jupyterlab/codemirror-extension": "",
-      "@jupyterlab/collaboration-extension": "",
       "@jupyterlab/completer-extension": "",
       "@jupyterlab/console-extension": "",
       "@jupyterlab/csvviewer-extension": "",
@@ -269,13 +264,11 @@
       "@jupyterlab/cell-toolbar",
       "@jupyterlab/codeeditor",
       "@jupyterlab/codemirror",
-      "@jupyterlab/collaboration",
       "@jupyterlab/completer",
       "@jupyterlab/console",
       "@jupyterlab/coreutils",
       "@jupyterlab/debugger",
       "@jupyterlab/docmanager",
-      "@jupyterlab/docprovider",
       "@jupyterlab/documentsearch",
       "@jupyterlab/extensionmanager",
       "@jupyterlab/filebrowser",
@@ -331,8 +324,6 @@
       "@jupyterlab/codeeditor": "../packages/codeeditor",
       "@jupyterlab/codemirror": "../packages/codemirror",
       "@jupyterlab/codemirror-extension": "../packages/codemirror-extension",
-      "@jupyterlab/collaboration": "../packages/collaboration",
-      "@jupyterlab/collaboration-extension": "../packages/collaboration-extension",
       "@jupyterlab/completer": "../packages/completer",
       "@jupyterlab/completer-extension": "../packages/completer-extension",
       "@jupyterlab/console": "../packages/console",
@@ -344,7 +335,6 @@
       "@jupyterlab/debugger-extension": "../packages/debugger-extension",
       "@jupyterlab/docmanager": "../packages/docmanager",
       "@jupyterlab/docmanager-extension": "../packages/docmanager-extension",
-      "@jupyterlab/docprovider": "../packages/docprovider",
       "@jupyterlab/docregistry": "../packages/docregistry",
       "@jupyterlab/documentsearch": "../packages/documentsearch",
       "@jupyterlab/documentsearch-extension": "../packages/documentsearch-extension",

dev_mode/style.js

@@ -6,7 +6,6 @@ import '@jupyterlab/apputils-extension/style/index.js';
 import '@jupyterlab/cell-toolbar-extension/style/index.js';
 import '@jupyterlab/celltags-extension/style/index.js';
 import '@jupyterlab/codemirror-extension/style/index.js';
-import '@jupyterlab/collaboration-extension/style/index.js';
 import '@jupyterlab/completer-extension/style/index.js';
 import '@jupyterlab/console-extension/style/index.js';
 import '@jupyterlab/csvviewer-extension/style/index.js';

examples/federated/core_package/package.json

@@ -18,8 +18,6 @@
     "@jupyterlab/celltags-extension": "~4.0.0-alpha.18",
     "@jupyterlab/codeeditor": "^4.0.0-alpha.15",
     "@jupyterlab/codemirror-extension": "~4.0.0-alpha.18",
-    "@jupyterlab/collaboration": "^4.0.0-alpha.11",
-    "@jupyterlab/collaboration-extension": "~4.0.0-alpha.11",
     "@jupyterlab/completer": "^4.0.0-alpha.15",
     "@jupyterlab/completer-extension": "~4.0.0-alpha.18",
     "@jupyterlab/console": "^4.0.0-alpha.15",
@@ -164,7 +162,6 @@
       "@jupyterlab/apputils",
       "@jupyterlab/attachments",
       "@jupyterlab/codeeditor",
-      "@jupyterlab/collaboration",
       "@jupyterlab/completer",
       "@jupyterlab/console",
       "@jupyterlab/coreutils",

jupyterlab/labapp.py

@@ -6,6 +6,7 @@
 import dataclasses
 import json
 import os
+import sys
 
 from jupyter_core.application import JupyterApp, NoStart, base_aliases, base_flags
 from jupyter_server._version import version_info as jpserver_version_info
@@ -688,7 +689,6 @@ def initialize_handlers(self):  # noqa
         page_config["token"] = self.serverapp.token
         page_config["exposeAppInBrowser"] = self.expose_app_in_browser
         page_config["quitButton"] = self.serverapp.quit_button
-        page_config["collaborative"] = self.collaborative
         page_config["allow_hidden_files"] = self.serverapp.contents_manager.allow_hidden
 
         # Client-side code assumes notebookVersion is a JSON-encoded string
@@ -840,6 +840,19 @@ def initialize_handlers(self):  # noqa
     def initialize(self, argv=None):
         """Subclass because the ExtensionApp.initialize() method does not take arguments"""
         super().initialize()
+        if self.collaborative:
+            try:
+                import jupyterlab_rtc  # noqa
+            except ImportError:
+                self.log.critical(
+                    """
+To enable real-time collaboration, you must install the extension `jupyterlab_rtc`.
+You can install it using pip for example:
+
+  python -m pip install jupyterlab_rtc
+"""
+                )
+                sys.exit(1)
 
 
 # -----------------------------------------------------------------------------