jupyter-webrtc-provider 0.2.0 → 0.2.2

package/lib/provider.js

@@ -8,6 +8,7 @@ import { PageConfig, URLExt } from '@jupyterlab/coreutils';
 import { IWebSocketFactory } from './websocket';
 import { WebRTCAwarenessProvider } from './awareness';
 import { DEFAULT_ROOM_ID_MANAGER, IRoomIdManager } from './roomid';
+const DEFAULT_WEBSOCKET_FACTORY = async (url) => new WebSocket(url);
 const PLUGIN_ID = 'jupyter-webrtc-provider';
 const signalingServerUrls = PageConfig.getOption('signalingServers');
 const signalingServers = signalingServerUrls
@@ -174,10 +175,9 @@ function getAbsoluteUrls(signalingServers, serverSettings) {
  * Document provider factory that creates WebSocket providers.
  */
 class WebRTCDocumentProviderFactory {
-    constructor(trans, webSocketFactory, roomIdManager = undefined) {
+    constructor(trans, webSocketFactory, roomIdManager) {
         this._trans = trans;
-        this._webSocketFactory =
-            webSocketFactory !== null && webSocketFactory !== void 0 ? webSocketFactory : (async (url) => new WebSocket(url));
+        this._webSocketFactory = webSocketFactory !== null && webSocketFactory !== void 0 ? webSocketFactory : DEFAULT_WEBSOCKET_FACTORY;
         this._roomIdManager = roomIdManager !== null && roomIdManager !== void 0 ? roomIdManager : DEFAULT_ROOM_ID_MANAGER;
     }
     create(options) {
@@ -202,8 +202,7 @@ class WebRTCDocumentProviderFactory {
  */
 class WebRTCAwarenessProviderFactory {
     constructor(webSocketFactory, roomIdManager) {
-        this._webSocketFactory =
-            webSocketFactory !== null && webSocketFactory !== void 0 ? webSocketFactory : (async (url) => new WebSocket(url));
+        this._webSocketFactory = webSocketFactory !== null && webSocketFactory !== void 0 ? webSocketFactory : DEFAULT_WEBSOCKET_FACTORY;
         this._roomIdManager = roomIdManager !== null && roomIdManager !== void 0 ? roomIdManager : DEFAULT_ROOM_ID_MANAGER;
     }
     create(options) {
@@ -225,11 +224,11 @@ export const documentProviderFactoryPlugin = {
     id: PLUGIN_ID + '-document-factory',
     description: 'Provides a WebRTC document provider factory.',
     requires: [ITranslator],
-    optional: [IWebSocketFactory],
+    optional: [IWebSocketFactory, IRoomIdManager],
     provides: IDocumentProviderFactory,
-    activate: async (app, translator, webSocketFactory) => {
+    activate: async (app, translator, webSocketFactory, roomIdManager) => {
         const trans = translator.load('jupyter_collaboration');
-        return new WebRTCDocumentProviderFactory(trans, webSocketFactory);
+        return new WebRTCDocumentProviderFactory(trans, webSocketFactory, roomIdManager);
     }
 };
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "jupyter-webrtc-provider",
-    "version": "0.2.0",
+    "version": "0.2.2",
     "description": "A JupyterLab extension for a WebRTC shared document provider.",
     "keywords": [
         "jupyter",
@@ -100,6 +100,16 @@
     "jupyterlab": {
         "extension": true,
         "outputDir": "jupyter_webrtc_provider/labextension",
+        "sharedPackages": {
+            "@jupyter/docprovider": {
+                "bundled": false,
+                "singleton": true
+            },
+            "@jupyter/ydoc": {
+                "bundled": false,
+                "singleton": true
+            }
+        },
         "disabledExtensions": [
             "@jupyter/docprovider-extension:websocket-provider-awareness-factory",
             "@jupyter/docprovider-extension:websocket-provider-document-factory"

package/src/provider.ts

@@ -25,6 +25,8 @@ import { IWebSocket, IWebSocketFactory } from './websocket';
 import { WebRTCAwarenessProvider } from './awareness';
 import { DEFAULT_ROOM_ID_MANAGER, IRoomIdManager } from './roomid';
 
+const DEFAULT_WEBSOCKET_FACTORY = async (url: string) =>
+  new WebSocket(url) as unknown as IWebSocket;
 const PLUGIN_ID = 'jupyter-webrtc-provider';
 const signalingServerUrls = PageConfig.getOption('signalingServers');
 const signalingServers = signalingServerUrls
@@ -303,12 +305,10 @@ class WebRTCDocumentProviderFactory implements IDocumentProviderFactory {
   constructor(
     trans: TranslationBundle,
     webSocketFactory: IWebSocketFactory | undefined,
-    roomIdManager: IRoomIdManager | undefined = undefined
+    roomIdManager: IRoomIdManager | undefined
   ) {
     this._trans = trans;
-    this._webSocketFactory =
-      webSocketFactory ??
-      (async (url: string) => new WebSocket(url) as unknown as IWebSocket);
+    this._webSocketFactory = webSocketFactory ?? DEFAULT_WEBSOCKET_FACTORY;
     this._roomIdManager = roomIdManager ?? DEFAULT_ROOM_ID_MANAGER;
   }
 
@@ -345,9 +345,7 @@ class WebRTCAwarenessProviderFactory implements IAwarenessProviderFactory {
     webSocketFactory: IWebSocketFactory | undefined,
     roomIdManager: IRoomIdManager | undefined
   ) {
-    this._webSocketFactory =
-      webSocketFactory ??
-      (async (url: string) => new WebSocket(url) as unknown as IWebSocket);
+    this._webSocketFactory = webSocketFactory ?? DEFAULT_WEBSOCKET_FACTORY;
     this._roomIdManager = roomIdManager ?? DEFAULT_ROOM_ID_MANAGER;
   }
 
@@ -378,15 +376,20 @@ export const documentProviderFactoryPlugin: JupyterFrontEndPlugin<IDocumentProvi
     id: PLUGIN_ID + '-document-factory',
     description: 'Provides a WebRTC document provider factory.',
     requires: [ITranslator],
-    optional: [IWebSocketFactory],
+    optional: [IWebSocketFactory, IRoomIdManager],
     provides: IDocumentProviderFactory,
     activate: async (
       app: JupyterFrontEnd,
       translator: ITranslator,
-      webSocketFactory?: IWebSocketFactory
+      webSocketFactory?: IWebSocketFactory,
+      roomIdManager?: IRoomIdManager
     ) => {
       const trans = translator.load('jupyter_collaboration');
-      return new WebRTCDocumentProviderFactory(trans, webSocketFactory);
+      return new WebRTCDocumentProviderFactory(
+        trans,
+        webSocketFactory,
+        roomIdManager
+      );
     }
   };