@jupyter/docprovider 4.4.0 → 5.0.0-alpha.0

package/lib/yprovider.d.ts

@@ -41,6 +41,8 @@ export declare class WebSocketProvider implements IDocumentProvider, IForkProvid
     private _onUserChanged;
     private _buildSessionExpiredMessage;
     private _onConnectionClosed;
+    private _attachConflictListener;
+    private _handleConflictMessage;
     private _onSync;
     private _getCloseReasonMessage;
     private _awareness;
@@ -56,6 +58,9 @@ export declare class WebSocketProvider implements IDocumentProvider, IForkProvid
     private _trans;
     private _hasSynced;
     private _saveCounter;
+    private _conflictWs;
+    private _onConflictSaveAs?;
+    private _onConflictRevert?;
 }
 /**
  * A namespace for WebSocketProvider statics.
@@ -97,5 +102,13 @@ export declare namespace WebSocketProvider {
          * The server settings.
          */
         serverSettings?: ServerConnection.ISettings;
+        /**
+         * Called when the user chooses "Save As" from the conflict dialog.
+         */
+        onConflictSaveAs?: () => Promise<void>;
+        /**
+         * Called when the user chooses "Revert" from the conflict dialog.
+         */
+        onConflictRevert?: () => Promise<void>;
     }
 }

package/lib/yprovider.js

@@ -78,6 +78,58 @@ export class WebSocketProvider {
                 this._sharedModel.dispose();
             }
         };
+        this._handleConflictMessage = async (event) => {
+            var _a, _b;
+            if (!(event.data instanceof ArrayBuffer)) {
+                return;
+            }
+            const data = new Uint8Array(event.data);
+            if (data.length === 0) {
+                return;
+            }
+            const decoder = decoding.createDecoder(data);
+            try {
+                if (decoding.readVarUint(decoder) !== RAW_MESSAGE_TYPE) {
+                    return;
+                }
+                const payload = JSON.parse(decoding.readVarString(decoder));
+                if (!payload || payload.type !== 'conflict') {
+                    return;
+                }
+            }
+            catch (_c) {
+                return;
+            }
+            const buttons = [
+                Dialog.cancelButton({ label: this._trans.__('Dismiss') })
+            ];
+            if (this._onConflictRevert) {
+                buttons.push(Dialog.warnButton({
+                    label: this._trans.__('Revert'),
+                    actions: ['revert']
+                }));
+            }
+            if (this._onConflictSaveAs) {
+                buttons.push(Dialog.okButton({
+                    label: this._trans.__('Save As'),
+                    actions: ['save-as']
+                }));
+            }
+            const result = await showDialog({
+                title: this._trans.__('Edit Conflict'),
+                body: this._trans.__('Your recent changes could not be applied because the document ' +
+                    'structure changed while you were disconnected (for example, another ' +
+                    'user or external tool modified the file). Your edits were not ' +
+                    'saved to the shared document.'),
+                buttons
+            });
+            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('save-as')) {
+                await ((_b = this._onConflictSaveAs) === null || _b === void 0 ? void 0 : _b.call(this));
+            }
+        };
         this._onSync = (isSynced) => {
             if (isSynced) {
                 this._hasSynced = true;
@@ -92,6 +144,7 @@ export class WebSocketProvider {
         this._ready = new PromiseDelegate();
         this._hasSynced = false;
         this._saveCounter = 0;
+        this._conflictWs = null;
         this._isDisposed = false;
         this._path = options.path;
         this._contentType = options.contentType;
@@ -103,6 +156,8 @@ export class WebSocketProvider {
         this._serverSettings =
             (_a = options.serverSettings) !== null && _a !== void 0 ? _a : ServerConnection.makeSettings();
         this._trans = options.translator;
+        this._onConflictSaveAs = options.onConflictSaveAs;
+        this._onConflictRevert = options.onConflictRevert;
         const user = options.user;
         user.ready
             .then(() => {
@@ -139,6 +194,10 @@ export class WebSocketProvider {
             return;
         }
         this._isDisposed = true;
+        if (this._conflictWs) {
+            this._conflictWs.removeEventListener('message', this._handleConflictMessage);
+            this._conflictWs = null;
+        }
         (_a = this._yWebsocketProvider) === null || _a === void 0 ? void 0 : _a.off('connection-close', this._onConnectionClosed);
         (_b = this._yWebsocketProvider) === null || _b === void 0 ? void 0 : _b.off('sync', this._onSync);
         (_c = this._yWebsocketProvider) === null || _c === void 0 ? void 0 : _c.destroy();
@@ -226,6 +285,11 @@ export class WebSocketProvider {
         });
         this._yWebsocketProvider.on('sync', this._onSync);
         this._yWebsocketProvider.on('connection-close', this._onConnectionClosed);
+        this._yWebsocketProvider.on('status', ({ status }) => {
+            if (status === 'connected') {
+                this._attachConflictListener();
+            }
+        });
     }
     async connectToForkDoc(forkRoomId, sessionId) {
         const token = this._serverSettings.token;
@@ -276,6 +340,17 @@ export class WebSocketProvider {
                 };
         }
     }
+    _attachConflictListener() {
+        var _a;
+        if (this._conflictWs) {
+            this._conflictWs.removeEventListener('message', this._handleConflictMessage);
+        }
+        const ws = (_a = this._yWebsocketProvider) === null || _a === void 0 ? void 0 : _a.ws;
+        if (ws) {
+            ws.addEventListener('message', this._handleConflictMessage);
+            this._conflictWs = ws;
+        }
+    }
     _getCloseReasonMessage(code) {
         switch (code) {
             case 4400: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter/docprovider",
-  "version": "4.4.0",
+  "version": "5.0.0-alpha.0",
   "description": "JupyterLab - Document Provider",
   "homepage": "https://github.com/jupyterlab/jupyter-collaboration",
   "bugs": {
@@ -41,26 +41,26 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyter/collaborative-drive": "^4.4.0",
-    "@jupyter/ydoc": "^2.1.3 || ^3.0.0",
-    "@jupyterlab/apputils": "^4.5.0",
-    "@jupyterlab/cells": "^4.5.0",
-    "@jupyterlab/coreutils": "^6.5.0",
-    "@jupyterlab/docmanager": "^4.5.0",
-    "@jupyterlab/notebook": "^4.5.0",
-    "@jupyterlab/services": "^7.5.0",
-    "@jupyterlab/translation": "^4.5.0",
+    "@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",
     "@lumino/coreutils": "^2.2.1",
     "@lumino/disposable": "^2.1.4",
     "@lumino/signaling": "^2.1.4",
-    "@lumino/widgets": "^2.7.0",
+    "@lumino/widgets": "^2.8.0",
     "y-protocols": "^1.0.5",
     "y-websocket": "^1.3.15",
     "yjs": "^13.5.40"
   },
   "devDependencies": {
-    "@jupyterlab/testing": "^4.5.0",
-    "@jupyterlab/testutils": "^4.5.0",
+    "@jupyterlab/testing": "^4.6.0-beta.1",
+    "@jupyterlab/testutils": "^4.6.0-beta.1",
     "@types/jest": "^29.2.0",
     "jest": "^29.5.0",
     "rimraf": "^4.1.2",