@jupyter/docprovider 5.0.0-alpha.0 → 5.0.0-rc.0

package/lib/yprovider.d.ts

@@ -1,4 +1,5 @@
 import { WebsocketProvider as YWebsocketProvider } from 'y-websocket';
+import { JSONValue } from '@lumino/coreutils';
 import { DocumentChange, YDocument } from '@jupyter/ydoc';
 import { IDocumentProvider } from '@jupyter/collaborative-drive';
 import { ServerConnection, User } from '@jupyterlab/services';
@@ -35,6 +36,20 @@ export declare class WebSocketProvider implements IDocumentProvider, IForkProvid
     save(): Promise<void>;
     private get _serverUrl();
     private _connect;
+    /**
+     * Start the load timeout that shows a retry dialog if the document
+     * hasn't synced within LOAD_TIMEOUT milliseconds.
+     */
+    private _startLoadTimeout;
+    /**
+     * Clear the load timeout.
+     */
+    private _clearLoadTimeout;
+    /**
+     * Callback when the load timeout fires.
+     * Shows a dialog asking the user if they want to retry loading.
+     */
+    private _onLoadTimeout;
     connectToForkDoc(forkRoomId: string, sessionId: string): Promise<void>;
     get wsProvider(): YWebsocketProvider | null;
     private _disconnect;
@@ -61,6 +76,9 @@ export declare class WebSocketProvider implements IDocumentProvider, IForkProvid
     private _conflictWs;
     private _onConflictSaveAs?;
     private _onConflictRevert?;
+    private _loadTimeoutId;
+    private _isShowingDialog;
+    private _onConflictShowDiff?;
 }
 /**
  * A namespace for WebSocketProvider statics.
@@ -110,5 +128,10 @@ export declare namespace WebSocketProvider {
          * Called when the user chooses "Revert" from the conflict dialog.
          */
         onConflictRevert?: () => Promise<void>;
+        /**
+         * Called when the user chooses "Show Diff" from the conflict dialog.
+         * Receives the current local document content as JSON.
+         */
+        onConflictShowDiff?: (localContent: JSONValue) => Promise<void>;
     }
 }

package/lib/yprovider.js

@@ -15,6 +15,11 @@ import { requestDocSession } from './requests';
  * The url for the default drive service.
  */
 const DOCUMENT_PROVIDER_URL = 'api/collaboration/room';
+/**
+ * Timeout in milliseconds after which a loading dialog is shown
+ * if the shared document has not yet been synchronized.
+ */
+const LOAD_TIMEOUT = 5000;
 /**
  * The raw message type.
  */
@@ -33,6 +38,48 @@ export class WebSocketProvider {
      */
     constructor(options) {
         var _a;
+        /**
+         * Callback when the load timeout fires.
+         * Shows a dialog asking the user if they want to retry loading.
+         */
+        this._onLoadTimeout = async () => {
+            if (this._isDisposed || this._hasSynced || this._isShowingDialog) {
+                return;
+            }
+            this._isShowingDialog = true;
+            const result = await showDialog({
+                title: this._trans.__('Loading'),
+                body: this._trans.__('The document is taking some time to load. What would you like to do?'),
+                buttons: [
+                    Dialog.cancelButton({ label: this._trans.__('Cancel') }),
+                    Dialog.okButton({
+                        label: this._trans.__('Continue waiting'),
+                        actions: ['continue']
+                    }),
+                    Dialog.warnButton({
+                        label: this._trans.__('Retry'),
+                        actions: ['retry']
+                    })
+                ]
+            });
+            this._isShowingDialog = false;
+            if (this._isDisposed || this._hasSynced) {
+                return;
+            }
+            if (result.button.actions.includes('continue')) {
+                this._startLoadTimeout();
+            }
+            else if (result.button.actions.includes('retry')) {
+                await this.reconnect();
+            }
+            else {
+                this._disconnect();
+                const msg = this._trans.__('The document failed to load. Please try opening it again.');
+                this._ready.reject(msg);
+                this._ready.promise.catch(() => undefined);
+                this._sharedModel.dispose();
+            }
+        };
         this._onConnectionClosed = async (event) => {
             if ([4400, 4404, 4500].includes(event.code)) {
                 if (!this._hasSynced) {
@@ -79,7 +126,7 @@ export class WebSocketProvider {
             }
         };
         this._handleConflictMessage = async (event) => {
-            var _a, _b;
+            var _a, _b, _c;
             if (!(event.data instanceof ArrayBuffer)) {
                 return;
             }
@@ -97,7 +144,7 @@ export class WebSocketProvider {
                     return;
                 }
             }
-            catch (_c) {
+            catch (_d) {
                 return;
             }
             const buttons = [
@@ -109,6 +156,12 @@ export class WebSocketProvider {
                     actions: ['revert']
                 }));
             }
+            if (this._onConflictShowDiff) {
+                buttons.push(Dialog.okButton({
+                    label: this._trans.__('Show Diff'),
+                    actions: ['show-diff']
+                }));
+            }
             if (this._onConflictSaveAs) {
                 buttons.push(Dialog.okButton({
                     label: this._trans.__('Save As'),
@@ -126,13 +179,17 @@ export class WebSocketProvider {
             if (result.button.actions.includes('revert')) {
                 await ((_a = this._onConflictRevert) === null || _a === void 0 ? void 0 : _a.call(this));
             }
+            else if (result.button.actions.includes('show-diff')) {
+                await ((_b = this._onConflictShowDiff) === null || _b === void 0 ? void 0 : _b.call(this, this._sharedModel.getSource()));
+            }
             else if (result.button.actions.includes('save-as')) {
-                await ((_b = this._onConflictSaveAs) === null || _b === void 0 ? void 0 : _b.call(this));
+                await ((_c = this._onConflictSaveAs) === null || _c === void 0 ? void 0 : _c.call(this));
             }
         };
         this._onSync = (isSynced) => {
             if (isSynced) {
                 this._hasSynced = true;
+                this._clearLoadTimeout();
                 if (this._yWebsocketProvider) {
                     this._yWebsocketProvider.off('sync', this._onSync);
                     const state = this._sharedModel.ydoc.getMap('state');
@@ -145,6 +202,8 @@ export class WebSocketProvider {
         this._hasSynced = false;
         this._saveCounter = 0;
         this._conflictWs = null;
+        this._loadTimeoutId = null;
+        this._isShowingDialog = false;
         this._isDisposed = false;
         this._path = options.path;
         this._contentType = options.contentType;
@@ -158,6 +217,7 @@ export class WebSocketProvider {
         this._trans = options.translator;
         this._onConflictSaveAs = options.onConflictSaveAs;
         this._onConflictRevert = options.onConflictRevert;
+        this._onConflictShowDiff = options.onConflictShowDiff;
         const user = options.user;
         user.ready
             .then(() => {
@@ -166,6 +226,7 @@ export class WebSocketProvider {
             .catch(e => console.error(e));
         user.userChanged.connect(this._onUserChanged, this);
         this._connect().catch(e => console.warn(e));
+        this._startLoadTimeout();
     }
     /**
      * Test whether the object has been disposed.
@@ -194,6 +255,7 @@ export class WebSocketProvider {
             return;
         }
         this._isDisposed = true;
+        this._clearLoadTimeout();
         if (this._conflictWs) {
             this._conflictWs.removeEventListener('message', this._handleConflictMessage);
             this._conflictWs = null;
@@ -205,8 +267,9 @@ export class WebSocketProvider {
         Signal.clearData(this);
     }
     async reconnect() {
+        this._clearLoadTimeout();
         this._disconnect();
-        this._connect();
+        this._connect().catch(e => console.warn(e));
     }
     async save() {
         var _a;
@@ -290,6 +353,28 @@ export class WebSocketProvider {
                 this._attachConflictListener();
             }
         });
+        this._startLoadTimeout();
+    }
+    /**
+     * Start the load timeout that shows a retry dialog if the document
+     * hasn't synced within LOAD_TIMEOUT milliseconds.
+     */
+    _startLoadTimeout() {
+        this._clearLoadTimeout();
+        if (!this._isDisposed) {
+            this._loadTimeoutId = window.setTimeout(() => {
+                this._onLoadTimeout();
+            }, LOAD_TIMEOUT);
+        }
+    }
+    /**
+     * Clear the load timeout.
+     */
+    _clearLoadTimeout() {
+        if (this._loadTimeoutId !== null) {
+            clearTimeout(this._loadTimeoutId);
+            this._loadTimeoutId = null;
+        }
     }
     async connectToForkDoc(forkRoomId, sessionId) {
         const token = this._serverSettings.token;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter/docprovider",
-  "version": "5.0.0-alpha.0",
+  "version": "5.0.0-rc.0",
   "description": "JupyterLab - Document Provider",
   "homepage": "https://github.com/jupyterlab/jupyter-collaboration",
   "bugs": {
@@ -41,15 +41,15 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyter/collaborative-drive": "^5.0.0-alpha.0",
-    "@jupyter/ydoc": "^4.0.0-a3",
-    "@jupyterlab/apputils": "^4.7.0-beta.1",
-    "@jupyterlab/cells": "^4.6.0-beta.1",
-    "@jupyterlab/coreutils": "^6.6.0-beta.1",
-    "@jupyterlab/docmanager": "^4.6.0-beta.1",
-    "@jupyterlab/notebook": "^4.6.0-beta.1",
-    "@jupyterlab/services": "^7.6.0-beta.1",
-    "@jupyterlab/translation": "^4.6.0-beta.1",
+    "@jupyter/collaborative-drive": "^5.0.0-rc.0",
+    "@jupyter/ydoc": "^4.0.0",
+    "@jupyterlab/apputils": "^4.7.0",
+    "@jupyterlab/cells": "^4.6.0",
+    "@jupyterlab/coreutils": "^6.6.0",
+    "@jupyterlab/docmanager": "^4.6.0",
+    "@jupyterlab/notebook": "^4.6.0",
+    "@jupyterlab/services": "^7.6.0",
+    "@jupyterlab/translation": "^4.6.0",
     "@lumino/coreutils": "^2.2.1",
     "@lumino/disposable": "^2.1.4",
     "@lumino/signaling": "^2.1.4",
@@ -59,8 +59,8 @@
     "yjs": "^13.5.40"
   },
   "devDependencies": {
-    "@jupyterlab/testing": "^4.6.0-beta.1",
-    "@jupyterlab/testutils": "^4.6.0-beta.1",
+    "@jupyterlab/testing": "^4.6.0",
+    "@jupyterlab/testutils": "^4.6.0",
     "@types/jest": "^29.2.0",
     "jest": "^29.5.0",
     "rimraf": "^4.1.2",