@jupyter/docprovider 1.0.0-alpha.1 → 1.0.0-alpha.3

package/lib/requests.d.ts

@@ -0,0 +1,8 @@
+import { Contents } from '@jupyterlab/services';
+export interface ISessionModel {
+    format: Contents.FileFormat;
+    type: Contents.ContentType;
+    fileId: string;
+    sessionId: string;
+}
+export declare function requestDocSession(format: string, type: string, path: string): Promise<ISessionModel>;

package/lib/requests.js

@@ -0,0 +1,25 @@
+/* -----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+import { URLExt } from '@jupyterlab/coreutils';
+import { ServerConnection } from '@jupyterlab/services';
+/**
+ * Document session endpoint provided by `jupyter_collaboration`
+ * See https://github.com/jupyterlab/jupyter_collaboration
+ */
+const DOC_SESSION_URL = 'api/collaboration/session';
+export async function requestDocSession(format, type, path) {
+    const { makeSettings, makeRequest, ResponseError } = ServerConnection;
+    const settings = makeSettings();
+    const url = URLExt.join(settings.baseUrl, DOC_SESSION_URL, encodeURIComponent(path));
+    const data = {
+        method: 'PUT',
+        body: JSON.stringify({ format, type })
+    };
+    const response = await makeRequest(url, data, settings);
+    if (response.status !== 200 && response.status !== 201) {
+        throw new ResponseError(response);
+    }
+    return response.json();
+}

package/lib/ydrive.d.ts

@@ -1,3 +1,5 @@
+import { DocumentChange, ISharedDocument, YDocument } from '@jupyter/ydoc';
+import { TranslationBundle } from '@jupyterlab/translation';
 import { Contents, Drive, User } from '@jupyterlab/services';
 /**
  * A Collaborative implementation for an `IDrive`, talking to the
@@ -9,11 +11,11 @@ export declare class YDrive extends Drive {
      *
      * @param user - The user manager to add the identity to the awareness of documents.
      */
-    constructor(user: User.IManager);
+    constructor(user: User.IManager, translator: TranslationBundle);
     /**
      * SharedModel factory for the YDrive.
      */
-    readonly sharedModelFactory: Contents.ISharedFactory;
+    readonly sharedModelFactory: SharedModelFactory;
     /**
      * Delete a file.
      *
@@ -73,5 +75,26 @@ export declare class YDrive extends Drive {
     save(localPath: string, options?: Partial<Contents.IModel>): Promise<Contents.IModel>;
     private _onCreate;
     private _user;
+    private _trans;
     private _providers;
 }
+/**
+ * Yjs sharedModel factory for real-time collaboration.
+ */
+declare class SharedModelFactory implements Contents.ISharedFactory {
+    private _onCreate;
+    private _documentOptions;
+    constructor(_onCreate: (options: Contents.ISharedFactoryOptions, sharedModel: YDocument<DocumentChange>) => void);
+    /**
+     * Whether the IDrive supports real-time collaboration or not.
+     */
+    readonly collaborative = true;
+    setDocumentOptions(type: Contents.ContentType, value: Record<string, any>): void;
+    /**
+     * Create a new `ISharedDocument` instance.
+     *
+     * It should return `undefined` if the factory is not able to create a `ISharedDocument`.
+     */
+    createNew(options: Contents.ISharedFactoryOptions): ISharedDocument | undefined;
+}
+export {};

package/lib/ydrive.js

@@ -7,7 +7,7 @@ import { WebSocketProvider } from './yprovider';
 /**
  * The url for the default drive service.
  */
-const Y_DOCUMENT_PROVIDER_URL = 'api/yjs';
+const DOCUMENT_PROVIDER_URL = 'api/collaboration/room';
 /**
  * A Collaborative implementation for an `IDrive`, talking to the
  * server using the Jupyter REST API and a WebSocket connection.
@@ -18,7 +18,7 @@ export class YDrive extends Drive {
      *
      * @param user - The user manager to add the identity to the awareness of documents.
      */
-    constructor(user) {
+    constructor(user, translator) {
         super({ name: 'YDrive' });
         this._onCreate = (options, sharedModel) => {
             if (typeof options.format !== 'string') {
@@ -26,14 +26,15 @@ export class YDrive extends Drive {
             }
             try {
                 const provider = new WebSocketProvider({
-                    url: URLExt.join(this.serverSettings.wsUrl, Y_DOCUMENT_PROVIDER_URL),
+                    url: URLExt.join(this.serverSettings.wsUrl, DOCUMENT_PROVIDER_URL),
                     path: options.path,
                     format: options.format,
                     contentType: options.contentType,
                     model: sharedModel,
-                    user: this._user
+                    user: this._user,
+                    translator: this._trans
                 });
-                const key = `${options.contentType}:${options.format}:${options.path}`;
+                const key = `${options.format}:${options.contentType}:${options.path}`;
                 this._providers.set(key, provider);
                 sharedModel.disposed.connect(() => {
                     const provider = this._providers.get(key);
@@ -50,6 +51,7 @@ export class YDrive extends Drive {
             }
         };
         this._user = user;
+        this._trans = translator;
         this._providers = new Map();
         this.sharedModelFactory = new SharedModelFactory(this._onCreate);
     }
@@ -93,7 +95,7 @@ export class YDrive extends Drive {
      */
     async get(localPath, options) {
         if (options && options.format && options.type) {
-            const key = `${options.type}:${options.format}:${localPath}`;
+            const key = `${options.format}:${options.type}:${localPath}`;
             const provider = this._providers.get(key);
             if (provider) {
                 const model = super.get(localPath, { ...options, content: false });
@@ -149,6 +151,13 @@ class SharedModelFactory {
          * Whether the IDrive supports real-time collaboration or not.
          */
         this.collaborative = true;
+        this._documentOptions = new Map();
+        this._documentOptions.set('notebook', {
+            disableDocumentWideUndoRedo: true
+        });
+    }
+    setDocumentOptions(type, value) {
+        this._documentOptions.set(type, value);
     }
     /**
      * Create a new `ISharedDocument` instance.
@@ -169,7 +178,7 @@ class SharedModelFactory {
                 sharedModel = new YFile();
                 break;
             case 'notebook':
-                sharedModel = new YNotebook();
+                sharedModel = new YNotebook(this._documentOptions.get('notebook'));
                 break;
             //default:
             // FIXME we should request a registry for the proper sharedModel

package/lib/yprovider.d.ts

@@ -1,6 +1,7 @@
 import { User } from '@jupyterlab/services';
-import { DocumentChange, YDocument } from '@jupyter/ydoc';
+import { TranslationBundle } from '@jupyterlab/translation';
 import { IDisposable } from '@lumino/disposable';
+import { DocumentChange, YDocument } from '@jupyter/ydoc';
 /**
  * An interface for a document provider.
  */
@@ -35,7 +36,9 @@ export declare class WebSocketProvider implements IDocumentProvider {
      * Dispose of the resources held by the object.
      */
     dispose(): void;
+    private _connect;
     private _onUserChanged;
+    private _onConnectionClosed;
     private _awareness;
     private _contentType;
     private _format;
@@ -43,8 +46,9 @@ export declare class WebSocketProvider implements IDocumentProvider {
     private _path;
     private _ready;
     private _serverUrl;
-    private _ydoc;
+    private _sharedModel;
     private _yWebsocketProvider;
+    private _trans;
 }
 /**
  * A namespace for WebSocketProvider statics.
@@ -78,5 +82,9 @@ export declare namespace WebSocketProvider {
          * The user data
          */
         user: User.IManager;
+        /**
+         * The jupyterlab translator
+         */
+        translator: TranslationBundle;
     }
 }

package/lib/yprovider.js

@@ -2,16 +2,11 @@
 | Copyright (c) Jupyter Development Team.
 | Distributed under the terms of the Modified BSD License.
 |----------------------------------------------------------------------------*/
-import { URLExt } from '@jupyterlab/coreutils';
-import { ServerConnection } from '@jupyterlab/services';
+import { showErrorMessage, Dialog } from '@jupyterlab/apputils';
 import { PromiseDelegate } from '@lumino/coreutils';
 import { Signal } from '@lumino/signaling';
 import { WebsocketProvider as YWebsocketProvider } from 'y-websocket';
-/**
- * Room Id endpoint provided by `jupyter_collaboration`
- * See https://github.com/jupyterlab/jupyter_collaboration
- */
-const FILE_PATH_TO_ROOM_ID_URL = 'api/yjs/roomid';
+import { requestDocSession } from './requests';
 /**
  * A class to provide Yjs synchronization over WebSocket.
  *
@@ -25,15 +20,31 @@ export class WebSocketProvider {
      * @param options The instantiation options for a WebSocketProvider
      */
     constructor(options) {
+        this._onConnectionClosed = (event) => {
+            if (event.code === 1003) {
+                console.error('Document provider closed:', event.reason);
+                showErrorMessage(this._trans.__('Session expired'), this._trans.__('The document session expired. You need to reload this browser tab.'), [Dialog.okButton({ label: this._trans.__('Reload') })])
+                    .then((r) => {
+                    if (r.button.accept) {
+                        window.location.reload();
+                    }
+                })
+                    .catch(e => window.location.reload());
+                // Dispose shared model immediately. Better break the document model,
+                // than overriding data on disk.
+                this._sharedModel.dispose();
+            }
+        };
         this._ready = new PromiseDelegate();
         this._isDisposed = false;
         this._path = options.path;
         this._contentType = options.contentType;
         this._format = options.format;
         this._serverUrl = options.url;
-        this._ydoc = options.model.ydoc;
+        this._sharedModel = options.model;
         this._awareness = options.model.awareness;
         this._yWebsocketProvider = null;
+        this._trans = options.translator;
         const user = options.user;
         user.ready
             .then(() => {
@@ -41,26 +52,7 @@ export class WebSocketProvider {
         })
             .catch(e => console.error(e));
         user.userChanged.connect(this._onUserChanged, this);
-        const serverSettings = ServerConnection.makeSettings();
-        const url = URLExt.join(serverSettings.baseUrl, FILE_PATH_TO_ROOM_ID_URL, encodeURIComponent(this._path));
-        const data = {
-            method: 'PUT',
-            body: JSON.stringify({ format: this._format, type: this._contentType })
-        };
-        ServerConnection.makeRequest(url, data, serverSettings)
-            .then(response => {
-            if (response.status !== 200 && response.status !== 201) {
-                throw new ServerConnection.ResponseError(response);
-            }
-            return response.text();
-        })
-            .then(roomid => {
-            this._yWebsocketProvider = new YWebsocketProvider(this._serverUrl, roomid, this._ydoc, {
-                awareness: this._awareness
-            });
-        })
-            .then(() => this._ready.resolve())
-            .catch(reason => console.warn(reason));
+        this._connect();
     }
     /**
      * Test whether the object has been disposed.
@@ -78,14 +70,28 @@ export class WebSocketProvider {
      * Dispose of the resources held by the object.
      */
     dispose() {
-        var _a;
+        var _a, _b;
         if (this.isDisposed) {
             return;
         }
         this._isDisposed = true;
-        (_a = this._yWebsocketProvider) === null || _a === void 0 ? void 0 : _a.destroy();
+        (_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.destroy();
         Signal.clearData(this);
     }
+    _connect() {
+        requestDocSession(this._format, this._contentType, this._path)
+            .then((session) => {
+            this._yWebsocketProvider = new YWebsocketProvider(this._serverUrl, `${session.format}:${session.type}:${session.fileId}`, this._sharedModel.ydoc, {
+                disableBc: true,
+                params: { sessionId: session.sessionId },
+                awareness: this._awareness
+            });
+            this._yWebsocketProvider.on('connection-close', this._onConnectionClosed);
+        })
+            .then(r => this._ready.resolve())
+            .catch(e => console.warn(e));
+    }
     _onUserChanged(user) {
         this._awareness.setLocalStateField('user', user.identity);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter/docprovider",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0-alpha.3",
   "description": "JupyterLab - Document Provider",
   "homepage": "https://github.com/jupyterlab/jupyter_collaboration",
   "bugs": {
@@ -41,7 +41,7 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyter/ydoc": "^0.3.1",
+    "@jupyter/ydoc": "^0.3.4",
     "@jupyterlab/coreutils": "^6.0.0-alpha.19",
     "@jupyterlab/services": "^7.0.0-alpha.19",
     "@lumino/coreutils": "^2.0.0-beta.0",