Improves chat (#173)

* Follow up

* Update jupyter_ydoc

Author: hbcarlos

jupyter_collaboration/handlers.py

@@ -5,6 +5,7 @@
 
 import asyncio
 import json
+import time
 import uuid
 from pathlib import Path
 from typing import Any
@@ -216,7 +217,6 @@ def on_message(self, message):
         On message receive.
         """
         message_type = message[0]
-        print("message type:", message_type)
 
         if message_type == YMessageType.AWARENESS:
             # awareness
@@ -245,8 +245,12 @@ def on_message(self, message):
 
         if message_type == MessageType.CHAT:
             msg = message[2:].decode("utf-8")
+
             user = self.get_current_user()
-            data = json.dumps({"username": user.username, "msg": msg}).encode("utf8")
+            data = json.dumps(
+                {"sender": user.username, "timestamp": time.time(), "content": json.loads(msg)}
+            ).encode("utf8")
+
             for client in self.room.clients:
                 if client != self:
                     task = asyncio.create_task(

packages/collaboration-extension/package.json

@@ -55,6 +55,7 @@
   "dependencies": {
     "@jupyter/collaboration": "^1.0.1",
     "@jupyter/docprovider": "^1.0.1",
+    "@jupyter/ydoc": "^1.1.0-a0",
     "@jupyterlab/application": "^4.0.0",
     "@jupyterlab/apputils": "^4.0.0",
     "@jupyterlab/codemirror": "^4.0.0",

packages/collaboration-extension/src/collaboration.ts

@@ -14,6 +14,17 @@ import {
   EditorExtensionRegistry,
   IEditorExtensionRegistry
 } from '@jupyterlab/codemirror';
+import { WebSocketAwarenessProvider } from '@jupyter/docprovider';
+import { SidePanel, usersIcon } from '@jupyterlab/ui-components';
+import { URLExt } from '@jupyterlab/coreutils';
+import { ServerConnection } from '@jupyterlab/services';
+import { IStateDB, StateDB } from '@jupyterlab/statedb';
+import { ITranslator, nullTranslator } from '@jupyterlab/translation';
+
+import { Menu, MenuBar } from '@lumino/widgets';
+
+import { IAwareness } from '@jupyter/ydoc';
+
 import {
   CollaboratorsPanel,
   IGlobalAwareness,
@@ -23,13 +34,6 @@ import {
   UserInfoPanel,
   UserMenu
 } from '@jupyter/collaboration';
-import { IAwareness, WebSocketAwarenessProvider } from '@jupyter/docprovider';
-import { SidePanel, usersIcon } from '@jupyterlab/ui-components';
-import { Menu, MenuBar } from '@lumino/widgets';
-import { URLExt } from '@jupyterlab/coreutils';
-import { ServerConnection } from '@jupyterlab/services';
-import { IStateDB, StateDB } from '@jupyterlab/statedb';
-import { ITranslator, nullTranslator } from '@jupyterlab/translation';
 
 import * as Y from 'yjs';
 import { Awareness } from 'y-protocols/awareness';

packages/collaboration/src/tokens.ts

@@ -3,9 +3,10 @@
 
 import type { Menu } from '@lumino/widgets';
 import { Token } from '@lumino/coreutils';
-import { IAwareness } from '@jupyter/docprovider';
 import type { User } from '@jupyterlab/services';
 
+import { IAwareness } from '@jupyter/ydoc';
+
 /**
  * The user menu token.
  *

packages/docprovider/package.json

@@ -41,7 +41,7 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyter/ydoc": "^1.0.2",
+    "@jupyter/ydoc": "^1.1.0-a0",
     "@jupyterlab/coreutils": "^6.0.0",
     "@jupyterlab/services": "^7.0.0",
     "@lumino/coreutils": "^2.1.0",

packages/docprovider/src/awareness.ts

@@ -6,21 +6,29 @@
 import { User } from '@jupyterlab/services';
 
 import { IDisposable } from '@lumino/disposable';
-import { ISignal, Signal } from '@lumino/signaling';
+import { IStream, Stream } from '@lumino/signaling';
+
+import { IAwareness } from '@jupyter/ydoc';
 
 import * as decoding from 'lib0/decoding';
 import * as encoding from 'lib0/encoding';
 import { WebsocketProvider } from 'y-websocket';
 
-import { IAwareness, IAwarenessProvider } from './tokens';
+import { IAwarenessProvider } from './tokens';
 
 export enum MessageType {
   CHAT = 125
 }
 
+export interface IContent {
+  type: string;
+  body: string;
+}
+
 export interface IChatMessage {
-  username: string;
-  msg: string;
+  sender: string;
+  timestamp: number;
+  content: IContent;
 }
 
 /**
@@ -45,13 +53,13 @@ export class WebSocketAwarenessProvider
 
     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._user.userChanged.connect(this._onUserChanged, this);
 
-    this._chatMessage = new Signal(this);
+    this._messageStream = new Stream(this);
 
     this.messageHandlers[MessageType.CHAT] = (
       encoder,
@@ -62,8 +70,7 @@ export class WebSocketAwarenessProvider
     ) => {
       const content = decoding.readVarString(decoder);
       const data = JSON.parse(content) as IChatMessage;
-      console.debug('Chat:', data);
-      this._chatMessage.emit(data);
+      this._messageStream.emit(data);
     };
   }
 
@@ -74,17 +81,18 @@ export class WebSocketAwarenessProvider
   /**
    * A signal to subscribe for incoming messages.
    */
-  get chatMessage(): ISignal<this, IChatMessage> {
-    return this._chatMessage;
+  get messageStream(): IStream<this, IChatMessage> {
+    return this._messageStream;
   }
 
   dispose(): void {
     if (this._isDisposed) {
       return;
     }
 
-    this.destroy();
+    this._user.userChanged.disconnect(this._onUserChanged, this);
     this._isDisposed = true;
+    this.destroy();
   }
 
   /**
@@ -93,10 +101,13 @@ export class WebSocketAwarenessProvider
    * @param msg message
    */
   sendMessage(msg: string): void {
-    console.debug('Send message:', msg);
+    const data: IContent = {
+      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));
   }
 
@@ -105,9 +116,10 @@ export class WebSocketAwarenessProvider
   }
 
   private _isDisposed = false;
+  private _user: User.IManager;
   private _awareness: IAwareness;
 
-  private _chatMessage: Signal<this, IChatMessage>;
+  private _messageStream: Stream<this, IChatMessage>;
 }
 
 /**

packages/docprovider/src/tokens.ts

@@ -5,9 +5,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';
 
@@ -52,21 +50,14 @@ export interface ISharedModelFactory extends Contents.ISharedFactory {
   ): void;
 }
 
-/**
- * The awareness interface.
- *
- * TODO: Move to @jupyter/YDoc
- */
-export type IAwareness = Awareness;
-
 /**
  * A provider interface for global awareness features.
  */
 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.

pyproject.toml

@@ -28,7 +28,7 @@ classifiers = [
 ]
 dependencies = [
     "jupyter_server>=2.0.0,<3.0.0",
-    "jupyter_ydoc>=1.0.1,<2.0.0",
+    "jupyter_ydoc>=1.1.0a0,<2.0.0",
     "ypy-websocket>=0.12.1,<0.13.0",
     "jupyter_events",
     "jupyter_server_fileid>=0.6.0,<1"

yarn.lock

@@ -2021,6 +2021,7 @@ __metadata:
   dependencies:
     "@jupyter/collaboration": ^1.0.1
     "@jupyter/docprovider": ^1.0.1
+    "@jupyter/ydoc": ^1.1.0-a0
     "@jupyterlab/application": ^4.0.0
     "@jupyterlab/apputils": ^4.0.0
     "@jupyterlab/builder": ^4.0.0
@@ -2075,7 +2076,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@jupyter/docprovider@workspace:packages/docprovider"
   dependencies:
-    "@jupyter/ydoc": ^1.0.2
+    "@jupyter/ydoc": ^1.1.0-a0
     "@jupyterlab/coreutils": ^6.0.0
     "@jupyterlab/services": ^7.0.0
     "@jupyterlab/testing": ^4.0.0
@@ -2129,6 +2130,20 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@jupyter/ydoc@npm:^1.1.0-a0":
+  version: 1.1.0-a0
+  resolution: "@jupyter/ydoc@npm:1.1.0-a0"
+  dependencies:
+    "@jupyterlab/nbformat": ^3.0.0 || ^4.0.0-alpha.21 || ^4.0.0
+    "@lumino/coreutils": ^1.11.0 || ^2.0.0
+    "@lumino/disposable": ^1.10.0 || ^2.0.0
+    "@lumino/signaling": ^1.10.0 || ^2.0.0
+    y-protocols: ^1.0.5
+    yjs: ^13.5.40
+  checksum: 0099bacb2884a460867658e7f5a944e4d6eca7c4d3d68a6b31102be77d8fc9b6ba162af55c20f81c70f7fef4e9d9329eee4da32063c0caa0c6e3f10a488f95b5
+  languageName: node
+  linkType: hard
+
 "@jupyterlab/application@npm:^4.0.0":
   version: 4.0.0
   resolution: "@jupyterlab/application@npm:4.0.0"