@jupyter/docprovider 1.2.0 → 2.0.0-alpha.0

package/lib/awareness.d.ts

@@ -1,14 +1,17 @@
 import { User } from '@jupyterlab/services';
 import { IDisposable } from '@lumino/disposable';
-import { ISignal } from '@lumino/signaling';
+import { IStream } from '@lumino/signaling';
+import { IAwareness } from '@jupyter/ydoc';
 import { WebsocketProvider } from 'y-websocket';
-import { IAwareness, IAwarenessProvider } from './tokens';
-export declare enum MessageType {
-    CHAT = 125
+import { IAwarenessProvider } from './tokens';
+export interface IContent {
+    type: string;
+    body: string;
 }
 export interface IChatMessage {
-    username: string;
-    msg: string;
+    sender: string;
+    timestamp: number;
+    content: IContent;
 }
 /**
  * A class to provide Yjs synchronization over WebSocket.
@@ -27,7 +30,7 @@ export declare class WebSocketAwarenessProvider extends WebsocketProvider implem
     /**
      * A signal to subscribe for incoming messages.
      */
-    get chatMessage(): ISignal<this, IChatMessage>;
+    get messageStream(): IStream<this, IChatMessage>;
     dispose(): void;
     /**
      * Send a message to every collaborator.
@@ -37,8 +40,9 @@ export declare class WebSocketAwarenessProvider extends WebsocketProvider implem
     sendMessage(msg: string): void;
     private _onUserChanged;
     private _isDisposed;
+    private _user;
     private _awareness;
-    private _chatMessage;
+    private _messageStream;
 }
 /**
  * A namespace for WebSocketAwarenessProvider statics.

package/lib/awareness.js

@@ -2,14 +2,11 @@
 | Copyright (c) Jupyter Development Team.
 | Distributed under the terms of the Modified BSD License.
 |----------------------------------------------------------------------------*/
-import { Signal } from '@lumino/signaling';
+import { Stream } from '@lumino/signaling';
 import * as decoding from 'lib0/decoding';
 import * as encoding from 'lib0/encoding';
 import { WebsocketProvider } from 'y-websocket';
-export var MessageType;
-(function (MessageType) {
-    MessageType[MessageType["CHAT"] = 125] = "CHAT";
-})(MessageType || (MessageType = {}));
+import { MessageType } from './utils';
 /**
  * A class to provide Yjs synchronization over WebSocket.
  *
@@ -28,17 +25,16 @@ export class WebSocketAwarenessProvider extends WebsocketProvider {
         });
         this._isDisposed = false;
         this._awareness = options.awareness;
-        const user = options.user;
-        user.ready
-            .then(() => this._onUserChanged(user))
+        this._user = options.user;
+        this._user.ready
+            .then(() => this._onUserChanged(this._user))
             .catch(e => console.error(e));
-        user.userChanged.connect(this._onUserChanged, this);
-        this._chatMessage = new Signal(this);
+        this._user.userChanged.connect(this._onUserChanged, this);
+        this._messageStream = new Stream(this);
         this.messageHandlers[MessageType.CHAT] = (encoder, decoder, provider, emitSynced, messageType) => {
             const content = decoding.readVarString(decoder);
             const data = JSON.parse(content);
-            console.debug('Chat:', data);
-            this._chatMessage.emit(data);
+            this._messageStream.emit(data);
         };
     }
     get isDisposed() {
@@ -47,15 +43,16 @@ export class WebSocketAwarenessProvider extends WebsocketProvider {
     /**
      * A signal to subscribe for incoming messages.
      */
-    get chatMessage() {
-        return this._chatMessage;
+    get messageStream() {
+        return this._messageStream;
     }
     dispose() {
         if (this._isDisposed) {
             return;
         }
-        this.destroy();
+        this._user.userChanged.disconnect(this._onUserChanged, this);
         this._isDisposed = true;
+        this.destroy();
     }
     /**
      * Send a message to every collaborator.
@@ -63,10 +60,13 @@ export class WebSocketAwarenessProvider extends WebsocketProvider {
      * @param msg message
      */
     sendMessage(msg) {
-        console.debug('Send message:', msg);
+        const data = {
+            type: 'text',
+            body: msg
+        };
         const encoder = encoding.createEncoder();
         encoding.writeVarUint(encoder, MessageType.CHAT);
-        encoding.writeVarString(encoder, msg);
+        encoding.writeVarString(encoder, JSON.stringify(data));
         this.ws.send(encoding.toUint8Array(encoder));
     }
     _onUserChanged(user) {

package/lib/tokens.d.ts

@@ -1,8 +1,7 @@
 import { DocumentChange, YDocument } from '@jupyter/ydoc';
 import { Contents } from '@jupyterlab/services';
 import { Token } from '@lumino/coreutils';
-import { ISignal } from '@lumino/signaling';
-import type { Awareness } from 'y-protocols/awareness';
+import { IStream } from '@lumino/signaling';
 import { IChatMessage } from './awareness';
 /**
  * The collaborative drive.
@@ -34,12 +33,6 @@ export interface ISharedModelFactory extends Contents.ISharedFactory {
      */
     registerDocumentFactory(type: Contents.ContentType, factory: SharedDocumentFactory): void;
 }
-/**
- * The awareness interface.
- *
- * TODO: Move to @jupyter/YDoc
- */
-export type IAwareness = Awareness;
 /**
  * A provider interface for global awareness features.
  */
@@ -47,7 +40,7 @@ export interface IAwarenessProvider {
     /**
      * A signal to subscribe for incoming messages.
      */
-    get chatMessage(): ISignal<this, IChatMessage>;
+    readonly messageStream: IStream<this, IChatMessage>;
     /**
      * Send a message to every collaborator.
      *

package/lib/utils.d.ts

@@ -0,0 +1,11 @@
+export declare enum MessageType {
+    ROOM = 124,
+    CHAT = 125
+}
+export declare enum RoomMessage {
+    RELOAD = 0,
+    OVERWRITE = 1,
+    FILE_CHANGED = 2,
+    FILE_OVERWRITTEN = 3,
+    DOC_OVERWRITTEN = 4
+}

package/lib/utils.js

@@ -0,0 +1,17 @@
+/* -----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+export var MessageType;
+(function (MessageType) {
+    MessageType[MessageType["ROOM"] = 124] = "ROOM";
+    MessageType[MessageType["CHAT"] = 125] = "CHAT";
+})(MessageType || (MessageType = {}));
+export var RoomMessage;
+(function (RoomMessage) {
+    RoomMessage[RoomMessage["RELOAD"] = 0] = "RELOAD";
+    RoomMessage[RoomMessage["OVERWRITE"] = 1] = "OVERWRITE";
+    RoomMessage[RoomMessage["FILE_CHANGED"] = 2] = "FILE_CHANGED";
+    RoomMessage[RoomMessage["FILE_OVERWRITTEN"] = 3] = "FILE_OVERWRITTEN";
+    RoomMessage[RoomMessage["DOC_OVERWRITTEN"] = 4] = "DOC_OVERWRITTEN";
+})(RoomMessage || (RoomMessage = {}));

package/lib/ydrive.js

@@ -82,8 +82,14 @@ export class YDrive extends Drive {
             const key = `${options.format}:${options.type}:${localPath}`;
             const provider = this._providers.get(key);
             if (provider) {
-                const model = super.get(localPath, { ...options, content: false });
-                await provider.ready;
+                // If the document does'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
+                // show a dialog to the user.
+                const [model] = await Promise.all([
+                    super.get(localPath, { ...options, content: false }),
+                    provider.ready
+                ]);
                 return model;
             }
         }

package/lib/yprovider.d.ts

@@ -40,6 +40,11 @@ export declare class WebSocketProvider implements IDocumentProvider {
     private _onUserChanged;
     private _onConnectionClosed;
     private _onSync;
+    private _handleRoomMessage;
+    private _handleFileChanged;
+    private _sendReloadMsg;
+    private _sendOverwriteMsg;
+    private _dialog;
     private _awareness;
     private _contentType;
     private _format;

package/lib/yprovider.js

@@ -5,8 +5,11 @@
 import { showErrorMessage, Dialog } from '@jupyterlab/apputils';
 import { PromiseDelegate } from '@lumino/coreutils';
 import { Signal } from '@lumino/signaling';
+import * as decoding from 'lib0/decoding';
+import * as encoding from 'lib0/encoding';
 import { WebsocketProvider as YWebsocketProvider } from 'y-websocket';
 import { requestDocSession } from './requests';
+import { MessageType, RoomMessage } from './utils';
 /**
  * A class to provide Yjs synchronization over WebSocket.
  *
@@ -38,6 +41,7 @@ export class WebSocketProvider {
                 (_a = this._yWebsocketProvider) === null || _a === void 0 ? void 0 : _a.off('sync', this._onSync);
             }
         };
+        this._dialog = null;
         this._ready = new PromiseDelegate();
         this._isDisposed = false;
         this._path = options.path;
@@ -85,15 +89,70 @@ export class WebSocketProvider {
     }
     async _connect() {
         const session = await requestDocSession(this._format, this._contentType, this._path);
+        const params = session.sessionId !== null ? { sessionId: session.sessionId } : undefined;
         this._yWebsocketProvider = new YWebsocketProvider(this._serverUrl, `${session.format}:${session.type}:${session.fileId}`, this._sharedModel.ydoc, {
             disableBc: true,
-            params: { sessionId: session.sessionId },
+            params,
             awareness: this._awareness
         });
         this._yWebsocketProvider.on('sync', this._onSync);
         this._yWebsocketProvider.on('connection-close', this._onConnectionClosed);
+        this._yWebsocketProvider.messageHandlers[MessageType.ROOM] = (encoder, decoder, provider, emitSynced, messageType) => {
+            const msgType = decoding.readVarUint(decoder);
+            const data = decoding.readVarString(decoder);
+            this._handleRoomMessage(msgType, data);
+        };
     }
     _onUserChanged(user) {
         this._awareness.setLocalStateField('user', user.identity);
     }
+    _handleRoomMessage(type, data) {
+        switch (type) {
+            case RoomMessage.FILE_CHANGED:
+                this._handleFileChanged(data);
+                break;
+            case RoomMessage.DOC_OVERWRITTEN:
+            case RoomMessage.FILE_OVERWRITTEN:
+                if (this._dialog) {
+                    this._dialog.close();
+                    this._dialog = null;
+                }
+                break;
+        }
+    }
+    _handleFileChanged(data) {
+        this._dialog = new Dialog({
+            title: this._trans.__('File changed'),
+            body: this._trans.__('Do you want to overwrite the file or reload it?'),
+            buttons: [
+                Dialog.okButton({ label: 'Reload' }),
+                Dialog.warnButton({ label: 'Overwrite' })
+            ],
+            hasClose: false
+        });
+        this._dialog.launch().then(resp => {
+            if (resp.button.label === 'Reload') {
+                this._sendReloadMsg(data);
+            }
+            else if (resp.button.label === 'Overwrite') {
+                this._sendOverwriteMsg(data);
+            }
+        });
+    }
+    _sendReloadMsg(data) {
+        var _a;
+        const encoder = encoding.createEncoder();
+        encoding.writeVarUint(encoder, MessageType.ROOM);
+        encoding.writeVarUint(encoder, RoomMessage.RELOAD);
+        encoding.writeVarString(encoder, data);
+        (_a = this._yWebsocketProvider) === null || _a === void 0 ? void 0 : _a.ws.send(encoding.toUint8Array(encoder));
+    }
+    _sendOverwriteMsg(data) {
+        var _a;
+        const encoder = encoding.createEncoder();
+        encoding.writeVarUint(encoder, MessageType.ROOM);
+        encoding.writeVarUint(encoder, RoomMessage.OVERWRITE);
+        encoding.writeVarString(encoder, data);
+        (_a = this._yWebsocketProvider) === null || _a === void 0 ? void 0 : _a.ws.send(encoding.toUint8Array(encoder));
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter/docprovider",
-  "version": "1.2.0",
+  "version": "2.0.0-alpha.0",
   "description": "JupyterLab - Document Provider",
   "homepage": "https://github.com/jupyterlab/jupyter_collaboration",
   "bugs": {
@@ -41,9 +41,9 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyter/ydoc": "^1.0.2",
-    "@jupyterlab/coreutils": "^6.0.0",
-    "@jupyterlab/services": "^7.0.0",
+    "@jupyter/ydoc": "^1.1.0-a0",
+    "@jupyterlab/coreutils": "^6.0.5",
+    "@jupyterlab/services": "^7.0.5",
     "@lumino/coreutils": "^2.1.0",
     "@lumino/disposable": "^2.1.0",
     "@lumino/signaling": "^2.1.0",
@@ -52,7 +52,7 @@
     "yjs": "^13.5.40"
   },
   "devDependencies": {
-    "@jupyterlab/testing": "^4.0.0",
+    "@jupyterlab/testing": "^4.0.5",
     "@types/jest": "^29.2.0",
     "jest": "^29.5.0",
     "rimraf": "^4.1.2",