@jupyter/docprovider 1.0.0-alpha.8 → 1.0.0-alpha.9

package/lib/requests.d.ts

@@ -1,8 +1,23 @@
 import { Contents } from '@jupyterlab/services';
+/**
+ * Document session model
+ */
 export interface ISessionModel {
+    /**
+     * Document format; 'text', 'base64',...
+     */
     format: Contents.FileFormat;
+    /**
+     * Document type
+     */
     type: Contents.ContentType;
+    /**
+     * File unique identifier
+     */
     fileId: string;
+    /**
+     * Server session identifier
+     */
     sessionId: string;
 }
 export declare function requestDocSession(format: string, type: string, path: string): Promise<ISessionModel>;

package/lib/requests.js

@@ -10,16 +10,30 @@ import { ServerConnection } from '@jupyterlab/services';
  */
 const DOC_SESSION_URL = 'api/collaboration/session';
 export async function requestDocSession(format, type, path) {
-    const { makeSettings, makeRequest, ResponseError } = ServerConnection;
-    const settings = makeSettings();
+    const settings = ServerConnection.makeSettings();
     const url = URLExt.join(settings.baseUrl, DOC_SESSION_URL, encodeURIComponent(path));
-    const data = {
+    const body = {
         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);
+    let response;
+    try {
+        response = await ServerConnection.makeRequest(url, body, settings);
     }
-    return response.json();
+    catch (error) {
+        throw new ServerConnection.NetworkError(error);
+    }
+    let data = await response.text();
+    if (data.length > 0) {
+        try {
+            data = JSON.parse(data);
+        }
+        catch (error) {
+            console.log('Not a JSON response body.', response);
+        }
+    }
+    if (!response.ok) {
+        throw new ServerConnection.ResponseError(response, data.message || data);
+    }
+    return data;
 }

package/lib/ydrive.js

@@ -1,6 +1,5 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
-import { showDialog, Dialog } from '@jupyterlab/apputils';
 import { URLExt } from '@jupyterlab/coreutils';
 import { Drive } from '@jupyterlab/services';
 import { WebSocketProvider } from './yprovider';
@@ -43,19 +42,6 @@ export class YDrive extends Drive {
                         this._providers.delete(key);
                     }
                 });
-                for (const provider of this._providers.keys()) {
-                    if (provider === key) {
-                        continue;
-                    }
-                    const path = provider.split(':')[2];
-                    if (options.path === path) {
-                        showDialog({
-                            title: this._trans.__('Warning'),
-                            body: this._trans.__('Opening a document with multiple views simultaneously is not supported.Please, close one view otherwise, you might lose some of your changes.'),
-                            buttons: [Dialog.okButton()]
-                        });
-                    }
-                }
             }
             catch (error) {
                 // Falling back to the contents API if opening the websocket failed

package/lib/yprovider.d.ts

@@ -39,6 +39,7 @@ export declare class WebSocketProvider implements IDocumentProvider {
     private _connect;
     private _onUserChanged;
     private _onConnectionClosed;
+    private _onSync;
     private _awareness;
     private _contentType;
     private _format;

package/lib/yprovider.js

@@ -23,18 +23,21 @@ export class WebSocketProvider {
         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());
+                showErrorMessage(this._trans.__('Document session error'), event.reason, [
+                    Dialog.okButton()
+                ]);
                 // Dispose shared model immediately. Better break the document model,
                 // than overriding data on disk.
                 this._sharedModel.dispose();
             }
         };
+        this._onSync = (isSynced) => {
+            var _a;
+            if (isSynced) {
+                this._ready.resolve();
+                (_a = this._yWebsocketProvider) === null || _a === void 0 ? void 0 : _a.off('sync', this._onSync);
+            }
+        };
         this._ready = new PromiseDelegate();
         this._isDisposed = false;
         this._path = options.path;
@@ -52,7 +55,7 @@ export class WebSocketProvider {
         })
             .catch(e => console.error(e));
         user.userChanged.connect(this._onUserChanged, this);
-        this._connect();
+        this._connect().catch(e => console.warn(e));
     }
     /**
      * Test whether the object has been disposed.
@@ -70,27 +73,25 @@ export class WebSocketProvider {
      * Dispose of the resources held by the object.
      */
     dispose() {
-        var _a, _b;
+        var _a, _b, _c;
         if (this.isDisposed) {
             return;
         }
         this._isDisposed = true;
         (_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();
+        (_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();
         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));
+    async _connect() {
+        const session = await requestDocSession(this._format, this._contentType, this._path);
+        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('sync', this._onSync);
+        this._yWebsocketProvider.on('connection-close', this._onConnectionClosed);
     }
     _onUserChanged(user) {
         this._awareness.setLocalStateField('user', user.identity);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter/docprovider",
-  "version": "1.0.0-alpha.8",
+  "version": "1.0.0-alpha.9",
   "description": "JupyterLab - Document Provider",
   "homepage": "https://github.com/jupyterlab/jupyter_collaboration",
   "bugs": {
@@ -41,21 +41,22 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyter/ydoc": "^1.0.0",
-    "@jupyterlab/coreutils": "^6.0.0-beta.0",
-    "@jupyterlab/services": "^7.0.0-beta.0",
-    "@lumino/coreutils": "^2.0.0",
-    "@lumino/disposable": "^2.0.0",
-    "@lumino/signaling": "^2.0.0",
+    "@jupyter/ydoc": "^1.0.2",
+    "@jupyterlab/coreutils": "^6.0.0",
+    "@jupyterlab/services": "^7.0.0",
+    "@lumino/coreutils": "^2.1.0",
+    "@lumino/disposable": "^2.1.0",
+    "@lumino/signaling": "^2.1.0",
     "y-protocols": "^1.0.5",
     "y-websocket": "^1.3.15",
     "yjs": "^13.5.40"
   },
   "devDependencies": {
-    "@jupyterlab/testing": "^4.0.0-beta.0",
+    "@jupyterlab/testing": "^4.0.0",
     "@types/jest": "^29.2.0",
+    "jest": "^29.5.0",
     "rimraf": "^4.1.2",
-    "typescript": "~5.0.2"
+    "typescript": "~5.0.4"
   },
   "publishConfig": {
     "access": "public"