Abstract ChatModel class (#197)

* Abstract ChatModel class

* lint

* Rename ChatModel to AbstractChatModel and ChatModel namespace to IChatModel

Author: brichet

docs/jupyter-chat-example/src/index.ts

@@ -7,7 +7,7 @@ import {
   ActiveCellManager,
   AttachmentOpenerRegistry,
   buildChatSidebar,
-  ChatModel,
+  AbstractChatModel,
   IAttachment,
   IChatMessage,
   INewMessage,
@@ -24,7 +24,7 @@ import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
 import { UUID } from '@lumino/coreutils';
 
-class MyChatModel extends ChatModel {
+class MyChatModel extends AbstractChatModel {
   sendMessage(
     newMessage: INewMessage
   ): Promise<boolean | void> | boolean | void {

docs/source/developers/developing_extensions/extension-providing-chat.md

@@ -52,9 +52,9 @@ As an example, here is a simple model that logs the message to the console and a
 the message list.
 
 ```typescript
-import { ChatModel, IChatMessage, INewMessage } from '@jupyter/chat';
+import { AbstractChatModel, IChatMessage, INewMessage } from '@jupyter/chat';
 
-class MyModel extends ChatModel {
+class MyModel extends AbstractChatModel {
   sendMessage(
     newMessage: INewMessage
   ): Promise<boolean | void> | boolean | void {
@@ -94,7 +94,7 @@ methods to correctly manage message transmission and reception.
 
 ```typescript
 import {
-  ChatModel,
+  AbstractChatModel,
   ChatWidget,
   IChatMessage,
   INewMessage
@@ -106,7 +106,7 @@ import {
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
 import { UUID } from '@lumino/coreutils';
 
-class MyModel extends ChatModel {
+class MyModel extends AbstractChatModel {
   sendMessage(
     newMessage: INewMessage
   ): Promise<boolean | void> | boolean | void {
@@ -242,7 +242,7 @@ jupyterlab. In the previous example, the modification would be:
 ```typescript
 import {
   ActiveCellManager,
-  ChatModel,
+  AbstractChatModel,
   ChatWidget,
   IChatMessage,
   INewMessage
@@ -325,7 +325,7 @@ specific function for an attachment type.
 ```typescript
 import {
   AttachmentOpenerRegistry,
-  ChatModel,
+  AbstractChatModel,
   ChatWidget,
   IAttachment,
   IChatMessage,
@@ -335,7 +335,7 @@ import { IDefaultFileBrowser } from '@jupyterlab/filebrowser';
 
 ...
 
-class MyModel extends ChatModel {
+class MyModel extends AbstractChatModel {
   sendMessage(
     newMessage: INewMessage
   ): Promise<boolean | void> | boolean | void {

packages/jupyter-chat/src/__tests__/model.spec.ts

@@ -7,29 +7,40 @@
  * Example of [Jest](https://jestjs.io/docs/getting-started) unit tests
  */
 
-import { ChatModel, IChatModel } from '../model';
-import { IChatMessage } from '../types';
+import { AbstractChatModel, IChatModel } from '../model';
+import { IChatMessage, INewMessage } from '../types';
+
+class MyChatModel extends AbstractChatModel {
+  sendMessage(message: INewMessage): Promise<boolean | void> | boolean | void {
+    // No-op
+  }
+}
 
 describe('test chat model', () => {
   describe('model instantiation', () => {
-    it('should create a ChatModel', () => {
-      const model = new ChatModel();
-      expect(model).toBeInstanceOf(ChatModel);
+    it('should create an AbstractChatModel', () => {
+      const model = new MyChatModel();
+      expect(model).toBeInstanceOf(AbstractChatModel);
     });
 
-    it('should dispose a ChatModel', () => {
-      const model = new ChatModel();
+    it('should dispose an AbstractChatModel', () => {
+      const model = new MyChatModel();
       model.dispose();
       expect(model.isDisposed).toBeTruthy();
     });
   });
 
   describe('incoming message', () => {
-    class TestChat extends ChatModel {
+    class TestChat extends AbstractChatModel {
       protected formatChatMessage(message: IChatMessage): IChatMessage {
         message.body = 'formatted msg';
         return message;
       }
+      sendMessage(
+        message: INewMessage
+      ): Promise<boolean | void> | boolean | void {
+        // No-op
+      }
     }
 
     let model: IChatModel;
@@ -47,7 +58,7 @@ describe('test chat model', () => {
     });
 
     it('should signal incoming message', () => {
-      model = new ChatModel();
+      model = new MyChatModel();
       model.messagesUpdated.connect((sender: IChatModel) => {
         expect(sender).toBe(model);
         messages = model.messages;
@@ -72,12 +83,12 @@ describe('test chat model', () => {
 
   describe('model config', () => {
     it('should have empty config', () => {
-      const model = new ChatModel();
+      const model = new MyChatModel();
       expect(model.config.sendWithShiftEnter).toBeUndefined();
     });
 
     it('should allow config', () => {
-      const model = new ChatModel({ config: { sendWithShiftEnter: true } });
+      const model = new MyChatModel({ config: { sendWithShiftEnter: true } });
       expect(model.config.sendWithShiftEnter).toBeTruthy();
     });
   });

packages/jupyter-chat/src/__tests__/widgets.spec.ts

@@ -11,25 +11,32 @@ import {
   IRenderMimeRegistry,
   RenderMimeRegistry
 } from '@jupyterlab/rendermime';
-import { ChatModel, IChatModel } from '../model';
+import { AbstractChatModel, IChatModel } from '../model';
+import { INewMessage } from '../types';
 import { ChatWidget } from '../widgets/chat-widget';
 
+class MyChatModel extends AbstractChatModel {
+  sendMessage(message: INewMessage): Promise<boolean | void> | boolean | void {
+    // No-op
+  }
+}
+
 describe('test chat widget', () => {
   let model: IChatModel;
   let rmRegistry: IRenderMimeRegistry;
 
   beforeEach(() => {
-    model = new ChatModel();
+    model = new MyChatModel();
     rmRegistry = new RenderMimeRegistry();
   });
 
   describe('model instantiation', () => {
-    it('should create a ChatModel', () => {
+    it('should create an AbstractChatModel', () => {
       const widget = new ChatWidget({ model, rmRegistry });
       expect(widget).toBeInstanceOf(ChatWidget);
     });
 
-    it('should dispose a ChatModel', () => {
+    it('should dispose an AbstractChatModel', () => {
       const widget = new ChatWidget({ model, rmRegistry });
       widget.dispose();
       expect(widget.isDisposed).toBeTruthy();

packages/jupyter-chat/src/model.ts

@@ -175,15 +175,16 @@ export interface IChatModel extends IDisposable {
 }
 
 /**
- * The default chat model implementation.
- * It is not able to send or update a message by itself, since it depends on the
- * chosen technology.
+ * An abstract implementation of IChatModel.
+ *
+ * The class inheriting from it must implement at least:
+ * - sendMessage(message: INewMessage)
  */
-export class ChatModel implements IChatModel {
+export abstract class AbstractChatModel implements IChatModel {
   /**
    * Create a new chat model.
    */
-  constructor(options: ChatModel.IOptions = {}) {
+  constructor(options: IChatModel.IOptions = {}) {
     if (options.id) {
       this.id = options.id;
     }
@@ -421,7 +422,9 @@ export class ChatModel implements IChatModel {
    * @param message - the message to send.
    * @returns whether the message has been sent or not.
    */
-  sendMessage(message: INewMessage): Promise<boolean | void> | boolean | void {}
+  abstract sendMessage(
+    message: INewMessage
+  ): Promise<boolean | void> | boolean | void;
 
   /**
    * Clear the message list.
@@ -609,7 +612,7 @@ export class ChatModel implements IChatModel {
 /**
  * The chat model namespace.
  */
-export namespace ChatModel {
+export namespace IChatModel {
   /**
    * The instantiation options for a ChatModel.
    */

packages/jupyterlab-chat/src/model.ts

@@ -4,9 +4,10 @@
  */
 
 import {
-  ChatModel,
+  AbstractChatModel,
   IAttachment,
   IChatMessage,
+  IChatModel,
   IInputModel,
   INewMessage,
   IUser
@@ -26,7 +27,7 @@ const WRITING_DELAY = 1000;
  * Chat model namespace.
  */
 export namespace LabChatModel {
-  export interface IOptions extends ChatModel.IOptions {
+  export interface IOptions extends IChatModel.IOptions {
     widgetConfig: IWidgetConfig;
     user: User.IIdentity | null;
     sharedModel?: YChat;
@@ -37,7 +38,10 @@ export namespace LabChatModel {
 /**
  * The chat model.
  */
-export class LabChatModel extends ChatModel implements DocumentRegistry.IModel {
+export class LabChatModel
+  extends AbstractChatModel
+  implements DocumentRegistry.IModel
+{
   constructor(options: LabChatModel.IOptions) {
     super(options);