@jupyter/docprovider 4.2.1 → 4.3.0-beta.0

package/lib/tokens.d.ts

@@ -101,3 +101,9 @@ export interface IForkManager extends IDisposable {
  * Token providing a fork manager instance.
  */
 export declare const IForkManagerToken: Token<IForkManager>;
+export interface ISessionClosePayload {
+    reason: 'unknown_session' | 'version_mismatch' | 'initialization_error';
+    sessionId?: string;
+    reloadable?: boolean;
+    errorReason?: string;
+}

package/lib/ydrive.js

@@ -191,6 +191,13 @@ export class RtcContentProvider {
             const key = `${options.format}:${options.type}:${localPath}`;
             const provider = this._providers.get(key);
             if (provider) {
+                // The default jupyter-server REST content provider would ask
+                // for content here; this would trigger any encoding errors
+                // leading to fast-rejection. However we do not ask for
+                // content as it is synced over a websocket instead,
+                // this means that the errors do not propagate.
+                // Instead we handle it by ensuring that the `ready` promise
+                // rejection (due to websocket closure ahead of sync) propagates.
                 // If the document doesn't exist, `super.get` will reject with an
                 // error and the provider will never be resolved.
                 // Use `Promise.all` to reject as soon as possible. The Context will

package/lib/yprovider.d.ts

@@ -38,8 +38,10 @@ export declare class WebSocketProvider implements IDocumentProvider, IForkProvid
     get wsProvider(): YWebsocketProvider | null;
     private _disconnect;
     private _onUserChanged;
+    private _buildSessionExpiredMessage;
     private _onConnectionClosed;
     private _onSync;
+    private _getCloseReasonMessage;
     private _awareness;
     private _contentType;
     private _format;
@@ -51,6 +53,7 @@ export declare class WebSocketProvider implements IDocumentProvider, IForkProvid
     private _yWebsocketProvider;
     private _serverSettings;
     private _trans;
+    private _hasSynced;
 }
 /**
  * A namespace for WebSocketProvider statics.

package/lib/yprovider.js

@@ -2,7 +2,7 @@
 | Copyright (c) Jupyter Development Team.
 | Distributed under the terms of the Modified BSD License.
 |----------------------------------------------------------------------------*/
-import { showErrorMessage, Dialog } from '@jupyterlab/apputils';
+import { Dialog, showDialog } from '@jupyterlab/apputils';
 import { ServerConnection } from '@jupyterlab/services';
 import { PromiseDelegate } from '@lumino/coreutils';
 import { Signal } from '@lumino/signaling';
@@ -27,12 +27,46 @@ export class WebSocketProvider {
      */
     constructor(options) {
         var _a;
-        this._onConnectionClosed = (event) => {
+        this._onConnectionClosed = async (event) => {
+            if ([4400, 4404, 4500].includes(event.code)) {
+                if (!this._hasSynced) {
+                    // Rejecting the ready promise will close the file placeholder widget.
+                    const reason = this._getCloseReasonMessage(event.code);
+                    this._ready.reject(reason);
+                    // Disposing model prevents repeated websocket reconnection attempts.
+                    // Rejecting the ready promise will ultimately close the file,
+                    // but the document manager takes some time to do so.
+                    this._sharedModel.dispose();
+                }
+            }
             if (event.code === 1003) {
                 console.error('Document provider closed:', event.reason);
-                showErrorMessage(this._trans.__('Document session error'), event.reason, [
-                    Dialog.okButton()
-                ]);
+                let payload;
+                try {
+                    payload = JSON.parse(event.reason);
+                }
+                catch (_a) {
+                    payload = {
+                        reason: 'unknown_session',
+                        sessionId: '',
+                        reloadable: false,
+                        errorReason: event.reason
+                    };
+                }
+                const { title, body } = this._buildSessionExpiredMessage(payload, this._trans);
+                const result = await showDialog({
+                    title,
+                    body,
+                    buttons: payload.reloadable
+                        ? [
+                            Dialog.cancelButton({ label: this._trans.__('Continue') }),
+                            Dialog.okButton({ label: this._trans.__('Reload') })
+                        ]
+                        : [Dialog.okButton({ label: this._trans.__('Ok') })]
+                });
+                if (result.button.accept && payload.reloadable) {
+                    window.location.reload();
+                }
                 // Dispose shared model immediately. Better break the document model,
                 // than overriding data on disk.
                 this._sharedModel.dispose();
@@ -40,6 +74,7 @@ export class WebSocketProvider {
         };
         this._onSync = (isSynced) => {
             if (isSynced) {
+                this._hasSynced = true;
                 if (this._yWebsocketProvider) {
                     this._yWebsocketProvider.off('sync', this._onSync);
                     const state = this._sharedModel.ydoc.getMap('state');
@@ -49,6 +84,7 @@ export class WebSocketProvider {
             }
         };
         this._ready = new PromiseDelegate();
+        this._hasSynced = false;
         this._isDisposed = false;
         this._path = options.path;
         this._contentType = options.contentType;
@@ -153,4 +189,39 @@ export class WebSocketProvider {
     _onUserChanged(user) {
         this._awareness.setLocalStateField('user', user.identity);
     }
+    _buildSessionExpiredMessage(payload, trans) {
+        switch (payload.reason) {
+            case 'version_mismatch':
+                return {
+                    title: trans.__('Collaboration extension updated'),
+                    body: trans.__('Reload the browser tab to load the new version.')
+                };
+            case 'initialization_error':
+                return {
+                    title: trans.__('Document error'),
+                    body: trans.__('Failed to initialize the document. Close this tab and reopen the file.')
+                };
+            case 'unknown_session':
+            default:
+                return {
+                    title: trans.__('Session expired'),
+                    body: payload.errorReason
+                        ? trans.__(payload.errorReason)
+                        : trans.__('Reload the browser tab to continue.')
+                };
+        }
+    }
+    _getCloseReasonMessage(code) {
+        switch (code) {
+            case 4400: {
+                return this._trans.__('Bad request for %1', this._path);
+            }
+            case 4404: {
+                return this._trans.__('Could not find %1', this._path);
+            }
+            case 4500: {
+                return this._trans.__('Internal server error when loading %1', this._path);
+            }
+        }
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter/docprovider",
-  "version": "4.2.1",
+  "version": "4.3.0-beta.0",
   "description": "JupyterLab - Document Provider",
   "homepage": "https://github.com/jupyterlab/jupyter-collaboration",
   "bugs": {
@@ -41,7 +41,7 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyter/collaborative-drive": "^4.2.1",
+    "@jupyter/collaborative-drive": "^4.3.0-beta.0",
     "@jupyter/ydoc": "^2.1.3 || ^3.0.0",
     "@jupyterlab/apputils": "^4.5.0",
     "@jupyterlab/cells": "^4.5.0",
@@ -59,6 +59,7 @@
   },
   "devDependencies": {
     "@jupyterlab/testing": "^4.5.0",
+    "@jupyterlab/testutils": "^4.5.0",
     "@types/jest": "^29.2.0",
     "jest": "^29.5.0",
     "rimraf": "^4.1.2",