Merge pull request #257 from Hexastack/feat/refactor-extension

feat: refactor extensions as npm packages (be brave 1)

api/.dockerignore

@@ -14,3 +14,4 @@ test
 *.mock.ts
 __mock__
 __test__
+.hexabot

api/.gitignore

@@ -1,3 +1,4 @@
+.hexabot/
 node_modules/
 dist/
 coverage/

api/Dockerfile

@@ -4,10 +4,6 @@ WORKDIR /app
 
 COPY package*.json ./
 
-COPY merge-extensions-deps.js ./
-
-COPY src/extensions ./src/extensions
-
 COPY patches ./patches
 
 RUN npm ci
@@ -22,8 +18,6 @@ WORKDIR /app
 
 COPY package*.json ./
 
-COPY --from=builder /app/merge-extensions-deps.js ./
-
 COPY --from=builder /app/src/extensions ./src/extensions
 
 COPY --from=builder /app/patches ./patches
@@ -44,8 +38,6 @@ WORKDIR /app
 
 COPY package*.json ./
 
-COPY --from=builder /app/merge-extensions-deps.js ./
-
 COPY --from=builder /app/src/extensions ./src/extensions
 
 COPY --from=builder /app/patches ./patches

api/package.json

@@ -6,14 +6,19 @@
   "author": "Hexastack",
   "license": "AGPL-3.0-only",
   "scripts": {
-    "preinstall": "node merge-extensions-deps.js",
     "postinstall": "patch-package",
-    "build": "nest build",
-    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "build:clean": "rm -rf src/.hexabot",
+    "build:channels": "mkdir -p src/.hexabot/channels && find node_modules/ -name 'hexabot-channel-*' -exec cp -R {} src/.hexabot/channels/ \\;",
+    "build:helpers": "mkdir -p src/.hexabot/helpers && find node_modules/ -name 'hexabot-helper-*' -exec cp -R {} src/.hexabot/helpers/ \\;",
+    "build:plugins": "mkdir -p src/.hexabot/plugins && find node_modules/ -name 'hexabot-plugin-*' -exec cp -R {} src/.hexabot/plugins/ \\;",
+    "build:extensions": "npm run build:channels && npm run build:helpers && npm run build:plugins",
+    "build:prepare": "npm run build:clean && npm run build:extensions",
+    "build": "npm run build:prepare && nest build",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\" \"libs/**/*.ts\"",
     "start": "nest start",
     "doc": "npx @compodoc/compodoc --hideGenerator -p tsconfig.doc.json -s -r 9003 -w",
-    "start:dev": "nest start --watch",
-    "start:debug": "nest start --debug 0.0.0.0:9229 --watch",
+    "start:dev": "npm run build:prepare && nest start --watch",
+    "start:debug": "npm run build:prepare && nest start --debug 0.0.0.0:9229 --watch",
     "start:prod": "node dist/main",
     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\"",
     "lint:fix": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",

api/src/attachment/services/attachment.service.ts

@@ -108,13 +108,13 @@ export class AttachmentService extends BaseService<Attachment> {
         await this.getStoragePlugin().uploadAvatar(picture);
         this.logger.log(
           `Profile picture uploaded successfully to ${
-            this.getStoragePlugin().id
+            this.getStoragePlugin().name
           }`,
         );
       } catch (err) {
         this.logger.error(
           `Error while uploading profile picture to ${
-            this.getStoragePlugin().id
+            this.getStoragePlugin().name
           }`,
           err,
         );

api/src/channel/channel.controller.ts

@@ -23,7 +23,7 @@ export class ChannelController {
   getChannels(): { name: string }[] {
     return this.channelService.getAll().map((handler) => {
       return {
-        name: handler.getChannel(),
+        name: handler.getName(),
       };
     });
   }

api/src/channel/channel.middleware.ts

@@ -7,7 +7,7 @@
  */
 
 import { Injectable, NestMiddleware } from '@nestjs/common';
-import { Request, Response, NextFunction } from 'express';
+import { NextFunction, Request, Response } from 'express';
 
 import { ChannelService } from './channel.service';
 
@@ -20,7 +20,9 @@ export class ChannelMiddleware implements NestMiddleware {
     try {
       const [_, path, channelName] = req.path.split('/');
       if (path === 'webhook' && channelName) {
-        const channel = this.channelService.getChannelHandler(channelName);
+        const channel = this.channelService.getChannelHandler(
+          `${channelName}-channel`,
+        );
         if (channel) {
           return await channel.middleware(req, res, next);
         }

api/src/channel/channel.module.ts

@@ -7,7 +7,12 @@
  */
 
 import { HttpModule } from '@nestjs/axios';
-import { MiddlewareConsumer, Module, RequestMethod } from '@nestjs/common';
+import {
+  Global,
+  MiddlewareConsumer,
+  Module,
+  RequestMethod,
+} from '@nestjs/common';
 import { InjectDynamicProviders } from 'nestjs-dynamic-providers';
 
 import { AttachmentModule } from '@/attachment/attachment.module';
@@ -23,7 +28,13 @@ export interface ChannelModuleOptions {
   folder: string;
 }
 
-@InjectDynamicProviders('dist/extensions/**/*.channel.js')
+@Global()
+@InjectDynamicProviders(
+  // Core & under dev channels
+  'dist/extensions/**/*.channel.js',
+  // Installed channels via npm
+  'dist/.hexabot/channels/**/*.channel.js',
+)
 @Module({
   controllers: [WebhookController, ChannelController],
   providers: [ChannelService],

api/src/channel/channel.service.ts

@@ -10,8 +10,8 @@ import { Injectable, UnauthorizedException } from '@nestjs/common';
 import { Request, Response } from 'express';
 
 import { SubscriberService } from '@/chat/services/subscriber.service';
-import { LIVE_CHAT_TEST_CHANNEL_NAME } from '@/extensions/channels/live-chat-tester/settings';
-import { OFFLINE_CHANNEL_NAME } from '@/extensions/channels/offline/settings';
+import { CONSOLE_CHANNEL_NAME } from '@/extensions/channels/console/settings';
+import { WEB_CHANNEL_NAME } from '@/extensions/channels/web/settings';
 import { LoggerService } from '@/logger/logger.service';
 import {
   SocketGet,
@@ -23,10 +23,11 @@ import { SocketRequest } from '@/websocket/utils/socket-request';
 import { SocketResponse } from '@/websocket/utils/socket-response';
 
 import ChannelHandler from './lib/Handler';
+import { ChannelName } from './types';
 
 @Injectable()
 export class ChannelService {
-  private registry: Map<string, ChannelHandler<string>> = new Map();
+  private registry: Map<string, ChannelHandler<ChannelName>> = new Map();
 
   constructor(
     private readonly logger: LoggerService,
@@ -40,7 +41,7 @@ export class ChannelService {
    * @param channel - The channel handler associated with the channel name.
    * @typeParam C The channel handler's type that extends `ChannelHandler`.
    */
-  public setChannel<T extends string, C extends ChannelHandler<T>>(
+  public setChannel<T extends ChannelName, C extends ChannelHandler<T>>(
     name: T,
     channel: C,
   ) {
@@ -62,19 +63,19 @@ export class ChannelService {
    * @param name - The name of the channel to find.
    * @returns The channel handler associated with the specified name, or undefined if the channel is not found.
    */
-  public findChannel(name: string) {
+  public findChannel(name: ChannelName) {
     return this.getAll().find((c) => {
-      return c.getChannel() === name;
+      return c.getName() === name;
     });
   }
 
   /**
    * Retrieves the appropriate channel handler based on the channel name.
    *
-   * @param channelName - The name of the channel (messenger, offline, ...).
+   * @param channelName - The name of the channel (messenger, web, ...).
    * @returns The handler for the specified channel.
    */
-  public getChannelHandler<T extends string, C extends ChannelHandler<T>>(
+  public getChannelHandler<T extends ChannelName, C extends ChannelHandler<T>>(
     name: T,
   ): C {
     const handler = this.registry.get(name);
@@ -93,42 +94,42 @@ export class ChannelService {
    * @returns A promise that resolves when the handler has processed the request.
    */
   async handle(channel: string, req: Request, res: Response): Promise<void> {
-    const handler = this.getChannelHandler(channel);
+    const handler = this.getChannelHandler(`${channel}-channel`);
     handler.handle(req, res);
   }
 
   /**
-   * Handles a websocket request for the offline channel.
+   * Handles a websocket request for the web channel.
    *
    * @param req - The websocket request object.
    * @param res - The websocket response object.
    */
-  @SocketGet(`/webhook/${OFFLINE_CHANNEL_NAME}/`)
-  @SocketPost(`/webhook/${OFFLINE_CHANNEL_NAME}/`)
-  handleWebsocketForOffline(
+  @SocketGet(`/webhook/${WEB_CHANNEL_NAME}/`)
+  @SocketPost(`/webhook/${WEB_CHANNEL_NAME}/`)
+  handleWebsocketForWebChannel(
     @SocketReq() req: SocketRequest,
     @SocketRes() res: SocketResponse,
   ) {
-    this.logger.log('Channel notification (Offline Socket) : ', req.method);
-    const handler = this.getChannelHandler(OFFLINE_CHANNEL_NAME);
+    this.logger.log('Channel notification (Web Socket) : ', req.method);
+    const handler = this.getChannelHandler(WEB_CHANNEL_NAME);
     return handler.handle(req, res);
   }
 
   /**
-   * Handles a websocket request for the live chat tester channel.
+   * Handles a websocket request for the admin chat console channel.
    * It considers the user as a subscriber.
    *
    * @param req - The websocket request object.
    * @param res - The websocket response object.
    */
-  @SocketGet(`/webhook/${LIVE_CHAT_TEST_CHANNEL_NAME}/`)
-  @SocketPost(`/webhook/${LIVE_CHAT_TEST_CHANNEL_NAME}/`)
-  async handleWebsocketForLiveChatTester(
+  @SocketGet(`/webhook/${CONSOLE_CHANNEL_NAME}/`)
+  @SocketPost(`/webhook/${CONSOLE_CHANNEL_NAME}/`)
+  async handleWebsocketForAdminChatConsole(
     @SocketReq() req: SocketRequest,
     @SocketRes() res: SocketResponse,
   ) {
     this.logger.log(
-      'Channel notification (Live Chat Tester Socket) : ',
+      'Channel notification (Admin Chat Console Socket) : ',
       req.method,
     );
 
@@ -157,21 +158,21 @@ export class ChannelService {
         country: '',
         labels: [],
         channel: {
-          name: LIVE_CHAT_TEST_CHANNEL_NAME,
+          name: CONSOLE_CHANNEL_NAME,
           isSocket: true,
         },
       },
     );
 
     // Update session (end user is both a user + subscriber)
-    req.session.offline = {
+    req.session.web = {
       profile: testSubscriber,
       isSocket: true,
       messageQueue: [],
       polling: false,
     };
 
-    const handler = this.getChannelHandler(LIVE_CHAT_TEST_CHANNEL_NAME);
+    const handler = this.getChannelHandler(CONSOLE_CHANNEL_NAME);
     return handler.handle(req, res);
   }
 }

api/src/channel/lib/EventWrapper.ts

@@ -55,7 +55,7 @@ export default abstract class EventWrapper<
   toString() {
     return JSON.stringify(
       {
-        handler: this._handler.getChannel(),
+        handler: this._handler.getName(),
         channelData: this.getChannelData(),
         sender: this.getSender(),
         recipient: this.getRecipientForeignId(),