Collaborative chat using jupyterlab_chat package

jupyter_collaboration/chat_ydoc.py → jupyter_collaboration/ychat.py

@@ -1,15 +1,16 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
+# TODO: remove this module in favor of the one in jupyter_ydoc when released.
+
 import json
+import jupyter_ydoc
 from functools import partial
 from typing import Any, Callable, List
-
-from jupyter_ydoc.ybasedoc import YBaseDoc
 from pycrdt import Array, Map
 
 
-class YChat(YBaseDoc):
+class YChat(jupyter_ydoc.YBaseDoc):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self._ydoc["content"] = self._ycontent = Map()
@@ -58,3 +59,7 @@ def observe(self, callback: Callable[[str, Any], None]) -> None:
             partial(callback, "messages")
         )
         self._subscriptions[self._ycontent] = self._ycontent.observe(partial(callback, "content"))
+
+
+# Register the ydoc
+jupyter_ydoc.ydocs["jupyter_collaboration.chat_ydoc:YChat"] = YChat

packages/collaboration-extension/src/chat.ts

@@ -15,10 +15,10 @@ import {
   ChatPanel,
   ChatWidgetFactory,
   CollaborativeChatModelFactory,
-  CollaborativeChat,
   CollaborativeChatModel,
   CollaborativeChatWidget,
-  ICollaborativeDrive
+  ICollaborativeDrive,
+  YChat
 } from '@jupyter/docprovider';
 import {
   ILayoutRestorer,
@@ -78,7 +78,7 @@ export const chatDocument: JupyterFrontEndPlugin<IChatFileType> = {
 
     if (drive) {
       const chatFactory = () => {
-        return CollaborativeChat.create();
+        return YChat.create();
       };
       drive.sharedModelFactory.registerDocumentFactory('chat', chatFactory);
     }
@@ -280,7 +280,7 @@ export const chat: JupyterFrontEndPlugin<ChatPanel> = {
           format: model.format,
           contentType: chatFileType.contentType,
           collaborative: true
-        }) as CollaborativeChat;
+        }) as YChat;
 
         /**
          * Initialize the chat model with the share model

packages/docprovider/src/chat/factory.ts

@@ -10,8 +10,9 @@ import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
 import { Contents } from '@jupyterlab/services';
 import { Awareness } from 'y-protocols/awareness';
 
-import { CollaborativeChat, CollaborativeChatModel } from './model';
+import { CollaborativeChatModel } from './model';
 import { CollaborativeChatWidget } from './widget';
+import { YChat } from './ychat';
 
 /**
  * A widget factory to create new instances of CollaborativeChatWidget.
@@ -138,7 +139,7 @@ export class CollaborativeChatModelFactory
    */
 
   createNew(
-    options: DocumentRegistry.IModelOptions<CollaborativeChat>
+    options: DocumentRegistry.IModelOptions<YChat>
   ): CollaborativeChatModel {
     return new CollaborativeChatModel({
       ...options,

packages/docprovider/src/chat/index.ts

@@ -6,3 +6,4 @@
 export * from './factory';
 export * from './model';
 export * from './widget';
+export * from './ychat';

packages/docprovider/src/chat/model.ts

@@ -4,26 +4,20 @@
  */
 
 import { ChatModel, IChatMessage, INewMessage, IUser } from 'chat-jupyter';
-import { Delta, MapChange, StateChange, YDocument } from '@jupyter/ydoc';
 import { DocumentRegistry } from '@jupyterlab/docregistry';
 import { IChangedArgs } from '@jupyterlab/coreutils';
-import {
-  JSONExt,
-  JSONObject,
-  PartialJSONObject,
-  UUID
-} from '@lumino/coreutils';
+import { PartialJSONObject, UUID } from '@lumino/coreutils';
 import { ISignal, Signal } from '@lumino/signaling';
 import { Awareness } from 'y-protocols/awareness';
-import * as Y from 'yjs';
+import { ChatChange, YChat } from './ychat';
 
 /**
  * Collaborative chat namespace.
  */
 export namespace CollaborativeChatModel {
   export interface IOptions extends ChatModel.IOptions {
     awareness: Awareness;
-    sharedModel?: CollaborativeChat;
+    sharedModel?: YChat;
     languagePreference?: string;
   }
 }
@@ -44,7 +38,7 @@ export class CollaborativeChatModel
     if (sharedModel) {
       this._sharedModel = sharedModel;
     } else {
-      this._sharedModel = CollaborativeChat.create();
+      this._sharedModel = YChat.create();
     }
 
     this.sharedModel.changed.connect(this._onchange, this);
@@ -54,7 +48,7 @@ export class CollaborativeChatModel
 
   readonly collaborative = true;
 
-  get sharedModel(): CollaborativeChat {
+  get sharedModel(): YChat {
     return this._sharedModel;
   }
 
@@ -144,12 +138,9 @@ export class CollaborativeChatModel
     this.sharedModel.transact(() => void this.sharedModel.setMessage(msg));
   }
 
-  private _onchange = (
-    _: CollaborativeChat,
-    change: ICollaborativeChatModelChange
-  ) => {
-    if (change.messageChange) {
-      const msgDelta = change.messageChange;
+  private _onchange = (_: YChat, change: ChatChange) => {
+    if (change.messagesChange) {
+      const msgDelta = change.messagesChange;
       // let retain: number;
       const messages: IChatMessage[] = [];
       msgDelta.forEach(data => {
@@ -171,7 +162,7 @@ export class CollaborativeChatModel
   readonly defaultKernelName: string = '';
   readonly defaultKernelLanguage: string = '';
 
-  private _sharedModel: CollaborativeChat;
+  private _sharedModel: YChat;
 
   private _dirty = false;
   private _readOnly = false;
@@ -182,69 +173,3 @@ export class CollaborativeChatModel
   private _awareness: Awareness;
   private _user: IUser;
 }
-
-interface ICollaborativeChatModelChange {
-  messageChange?: Delta<any>;
-  contentChange?: MapChange;
-  stateChange?: StateChange<any>[];
-}
-
-interface IDict<T = any> {
-  [key: string]: T;
-}
-
-/**
- * The collaborative chat shared document.
- */
-export class CollaborativeChat extends YDocument<ICollaborativeChatModelChange> {
-  /**
-   * Create a new collaborative chat model.
-   */
-  constructor(options?: YDocument.IOptions) {
-    super(options);
-    this._content = this.ydoc.getMap<IDict>('content');
-    this._content.observe(this._contentObserver);
-
-    this._messages = this.ydoc.getArray<IDict>('messages');
-    this._messages.observe(this._messagesObserver);
-  }
-
-  /**
-   * Document version
-   */
-  readonly version: string = '1.0.0';
-
-  /**
-   * Static method to create instances on the sharedModel
-   *
-   * @returns The sharedModel instance
-   */
-  static create(options?: YDocument.IOptions): CollaborativeChat {
-    return new CollaborativeChat(options);
-  }
-
-  get content(): JSONObject {
-    return JSONExt.deepCopy(this._content.toJSON());
-  }
-
-  get messages(): string[] {
-    return JSONExt.deepCopy(this._messages.toJSON());
-  }
-
-  setMessage(value: IDict): void {
-    this._messages.push([value]);
-  }
-
-  private _contentObserver = (event: Y.YMapEvent<IDict>): void => {
-    this._changed.emit(this.content);
-  };
-
-  private _messagesObserver = (event: Y.YArrayEvent<IDict>): void => {
-    const changes: ICollaborativeChatModelChange = {};
-    changes.messageChange = event.delta;
-    this._changed.emit(changes);
-  };
-
-  private _content: Y.Map<IDict>;
-  private _messages: Y.Array<IDict>;
-}

packages/docprovider/src/chat/ychat.ts

@@ -0,0 +1,84 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
+// TODO: remove this module in favor of the one in jupyter_ydoc when released.
+
+import { Delta, DocumentChange, MapChange, YDocument } from '@jupyter/ydoc';
+import { JSONExt, JSONObject } from '@lumino/coreutils';
+import * as Y from 'yjs';
+
+/**
+ * Definition of the shared Chat changes.
+ */
+export type ChatChange = DocumentChange & {
+  /**
+   * Messages list change
+   */
+  messagesChange?: Delta<any>;
+  /**
+   * Content change
+   */
+  contentChange?: MapChange;
+};
+
+interface IDict<T = any> {
+  [key: string]: T;
+}
+
+/**
+ * The collaborative chat shared document.
+ */
+export class YChat extends YDocument<ChatChange> {
+  /**
+   * Create a new collaborative chat model.
+   */
+  constructor(options?: YDocument.IOptions) {
+    super(options);
+    this._content = this.ydoc.getMap<IDict>('content');
+    this._content.observe(this._contentObserver);
+
+    this._messages = this.ydoc.getArray<IDict>('messages');
+    this._messages.observe(this._messagesObserver);
+  }
+
+  /**
+   * Document version
+   */
+  readonly version: string = '1.0.0';
+
+  /**
+   * Static method to create instances on the sharedModel
+   *
+   * @returns The sharedModel instance
+   */
+  static create(options?: YDocument.IOptions): YChat {
+    return new YChat(options);
+  }
+
+  get content(): JSONObject {
+    return JSONExt.deepCopy(this._content.toJSON());
+  }
+
+  get messages(): string[] {
+    return JSONExt.deepCopy(this._messages.toJSON());
+  }
+
+  setMessage(value: IDict): void {
+    this._messages.push([value]);
+  }
+
+  private _contentObserver = (event: Y.YMapEvent<IDict>): void => {
+    this._changed.emit(this.content);
+  };
+
+  private _messagesObserver = (event: Y.YArrayEvent<IDict>): void => {
+    const changes: ChatChange = {};
+    changes.messagesChange = event.delta;
+    this._changed.emit(changes);
+  };
+
+  private _content: Y.Map<IDict>;
+  private _messages: Y.Array<IDict>;
+}

pyproject.toml

@@ -173,6 +173,3 @@ module = [
     "terminado"
 ]
 ignore_missing_imports = true
-
-[project.entry-points.jupyter_ydoc]
-chat = "jupyter_collaboration.chat_ydoc:YChat"