Merge pull request #536 from the-draupnir-project/gnuxie/interface-manager-rework

Extract the `@the-draupnir-project/interface-manager` system to its own library where it can be better tested and improved.

Author: Gnuxie

.github/workflows/mjolnir.yml

@@ -6,11 +6,11 @@ name: Tests
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
   schedule:
-    - cron: '20 20 * * *'
+    - cron: "20 20 * * *"
 env:
   CARGO_TERM_COLOR: always
 
@@ -19,68 +19,57 @@ jobs:
     name: Build & Lint
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
-    - name: Specifically use node 18 like in the readme.
-      uses: actions/setup-node@v4
-      with:
-        node-version: '18'
-    - run: corepack enable
-    - run: corepack yarn install
-    - run: corepack yarn build
-    - run: corepack yarn lint
-  unit:
-    name: Unit tests
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v4
-    - name: Specifically use node 18 like in the readme.
-      uses: actions/setup-node@v4
-      with:
-        node-version: '18'
-    - run: corepack yarn install
-    - run: corepack yarn test
+      - name: Specifically use node 18 like in the readme.
+        uses: actions/setup-node@v4
+        with:
+          node-version: "18"
+      - run: corepack enable
+      - run: corepack yarn install
+      - run: corepack yarn build
+      - run: corepack yarn lint
   integration:
     name: Integration tests
     runs-on: ubuntu-latest
     timeout-minutes: 60
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-node@v4
-      with:
-        node-version: '18'
-    - name: Fetch and build mx-tester (cached across runs)
-      uses: baptiste0928/cargo-install@v3
-      with:
-        crate: mx-tester
-        version: "0.3.3"
-    - name: Setup image
-      run: RUST_LOG=debug,hyper=info,rusttls=info mx-tester build up
-    - name: Setup dependencies
-      run: corepack yarn install
-    - name: Run tests
-      run: RUST_LOG=debug,hyper=info,rusttls=info mx-tester run
-    - name: Cleanup
-      run: mx-tester down
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "18"
+      - name: Fetch and build mx-tester (cached across runs)
+        uses: baptiste0928/cargo-install@v3
+        with:
+          crate: mx-tester
+          version: "0.3.3"
+      - name: Setup image
+        run: RUST_LOG=debug,hyper=info,rusttls=info mx-tester build up
+      - name: Setup dependencies
+        run: corepack yarn install
+      - name: Run tests
+        run: RUST_LOG=debug,hyper=info,rusttls=info mx-tester run
+      - name: Cleanup
+        run: mx-tester down
   appservice-integration:
     name: Application Service Integration tests
     runs-on: ubuntu-latest
     timeout-minutes: 30
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-node@v4
-      with:
-        node-version: '18'
-    - name: Fetch and build mx-tester (cached across runs)
-      uses: baptiste0928/cargo-install@v3
-      with:
-        crate: mx-tester
-        version: "0.3.3"
-    - name: Setup image
-      run: RUST_LOG=debug,hyper=info,rusttls=info mx-tester build up
-    - name: Setup dependencies
-      run: corepack yarn install
-    - name: Run tests
-      run: corepack yarn test:appservice:integration
-    - name: Cleanup
-      run: mx-tester down
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "18"
+      - name: Fetch and build mx-tester (cached across runs)
+        uses: baptiste0928/cargo-install@v3
+        with:
+          crate: mx-tester
+          version: "0.3.3"
+      - name: Setup image
+        run: RUST_LOG=debug,hyper=info,rusttls=info mx-tester build up
+      - name: Setup dependencies
+        run: corepack yarn install
+      - name: Run tests
+        run: corepack yarn test:appservice:integration
+      - name: Cleanup
+        run: mx-tester down

package.json

@@ -50,9 +50,11 @@
     "typescript-formatter": "^7.2"
   },
   "dependencies": {
+    "@gnuxie/typescript-result": "^0.2.0",
     "@sentry/node": "^7.17.2",
     "@sentry/tracing": "^7.17.2",
     "@sinclair/typebox": "0.32.34",
+    "@the-draupnir-project/interface-manager": "1.0.2",
     "@the-draupnir-project/matrix-basic-types": "^0.1.1",
     "await-lock": "^2.2.2",
     "better-sqlite3": "^9.4.3",
@@ -65,8 +67,8 @@
     "js-yaml": "^4.1.0",
     "jsdom": "^24.0.0",
     "matrix-appservice-bridge": "^9.0.1",
-    "matrix-protection-suite": "npm:@gnuxie/matrix-protection-suite@1.0.0",
-    "matrix-protection-suite-for-matrix-bot-sdk": "npm:@gnuxie/matrix-protection-suite-for-matrix-bot-sdk@1.0.0",
+    "matrix-protection-suite": "npm:@gnuxie/matrix-protection-suite@1.1.0",
+    "matrix-protection-suite-for-matrix-bot-sdk": "npm:@gnuxie/matrix-protection-suite-for-matrix-bot-sdk@1.1.0",
     "parse-duration": "^1.0.2",
     "pg": "^8.8.0",
     "shell-quote": "^1.7.3",

src/Draupnir.ts

@@ -31,7 +31,6 @@ import {
   isError,
 } from "matrix-protection-suite";
 import { UnlistedUserRedactionQueue } from "./queues/UnlistedUserRedactionQueue";
-import { findCommandTable } from "./commands/interface-manager/InterfaceCommand";
 import { ThrottlingQueue } from "./queues/ThrottlingQueue";
 import ManagementRoomOutput from "./ManagementRoomOutput";
 import { ReportPoller } from "./report/ReportPoller";
@@ -42,12 +41,6 @@ import {
   SynapseAdminClient,
 } from "matrix-protection-suite-for-matrix-bot-sdk";
 import { IConfig } from "./config";
-import {
-  COMMAND_PREFIX,
-  DraupnirContext,
-  extractCommandFromMessageBody,
-  handleCommand,
-} from "./commands/CommandHandler";
 import { LogLevel } from "matrix-bot-sdk";
 import {
   ARGUMENT_PROMPT_LISTENER,
@@ -59,7 +52,6 @@ import { RendererMessageCollector } from "./capabilities/RendererMessageCollecto
 import { DraupnirRendererMessageCollector } from "./capabilities/DraupnirRendererMessageCollector";
 import { renderProtectionFailedToStart } from "./protections/ProtectedRoomsSetRenderers";
 import { draupnirStatusInfo, renderStatusInfo } from "./commands/StatusCommand";
-import { renderMatrixAndSend } from "./commands/interface-manager/DeadDocumentMatrix";
 import { isInvitationForUser } from "./protections/invitation/inviteCore";
 import {
   StringRoomID,
@@ -68,9 +60,13 @@ import {
   isStringRoomID,
   isStringRoomAlias,
   MatrixRoomReference,
-  userLocalpart,
   userServerName,
 } from "@the-draupnir-project/matrix-basic-types";
+import {
+  MatrixAdaptorContext,
+  sendMatrixEventsFromDeadDocument,
+} from "./commands/interface-manager/MPSMatrixInterfaceAdaptor";
+import { makeDraupnirCommandDispatcher } from "./commands/DraupnirCommandDispatcher";
 
 const log = new Logger("Draupnir");
 
@@ -80,14 +76,14 @@ const log = new Logger("Draupnir");
 // to Mjolnir because it needs to be started after Mjolnir started and not before.
 // And giving it to the class was a dumb easy way of doing that.
 
-export class Draupnir implements Client {
+export class Draupnir implements Client, MatrixAdaptorContext {
   /**
    * This is for users who are not listed on a watchlist,
    * but have been flagged by the automatic spam detection as suispicous
    */
   public unlistedUserRedactionQueue = new UnlistedUserRedactionQueue();
 
-  private readonly commandTable = findCommandTable("draupnir");
+  private readonly commandDispatcher = makeDraupnirCommandDispatcher(this);
   public taskQueue: ThrottlingQueue;
   /**
    * Reporting back to the management room.
@@ -106,8 +102,6 @@ export class Draupnir implements Client {
 
   public readonly reactionHandler: MatrixReactionHandler;
 
-  public readonly commandContext: Omit<DraupnirContext, "event">;
-
   private readonly timelineEventListener = this.handleTimelineEvent.bind(this);
 
   public readonly capabilityMessageRenderer: RendererMessageCollector;
@@ -146,38 +140,16 @@ export class Draupnir implements Client {
     if (config.pollReports) {
       this.reportPoller = new ReportPoller(this, this.reportManager);
     }
-
-    this.commandContext = {
-      draupnir: this,
-      roomID: this.managementRoomID,
-      client: this.client,
-      reactionHandler: this.reactionHandler,
-      clientPlatform: this.clientPlatform,
-    };
     this.reactionHandler.on(
       ARGUMENT_PROMPT_LISTENER,
-      makeListenerForArgumentPrompt(
-        this.client,
-        this.clientPlatform,
-        this.managementRoomID,
-        this.reactionHandler,
-        this.commandTable,
-        this.commandContext
-      )
+      makeListenerForArgumentPrompt(this.commandDispatcher)
     );
     this.reactionHandler.on(
       DEFAUILT_ARGUMENT_PROMPT_LISTENER,
-      makeListenerForPromptDefault(
-        this.client,
-        this.clientPlatform,
-        this.managementRoomID,
-        this.reactionHandler,
-        this.commandTable,
-        this.commandContext
-      )
+      makeListenerForPromptDefault(this.commandDispatcher)
     );
     this.capabilityMessageRenderer = new DraupnirRendererMessageCollector(
-      this.client,
+      this.clientPlatform.toRoomMessageSender(),
       this.managementRoomID
     );
   }
@@ -256,7 +228,7 @@ export class Draupnir implements Client {
       draupnir,
       (error, protectionName, description) =>
         renderProtectionFailedToStart(
-          client,
+          clientPlatform.toRoomMessageSender(),
           managementRoom.toRoomIDOrAlias(),
           error,
           protectionName,
@@ -291,11 +263,11 @@ export class Draupnir implements Client {
         "Mjolnir@startup",
         "Startup complete. Now monitoring rooms."
       );
-      await renderMatrixAndSend(
-        renderStatusInfo(statusInfo),
+      await sendMatrixEventsFromDeadDocument(
+        this.clientPlatform.toRoomMessageSender(),
         this.managementRoomID,
-        undefined,
-        this.client
+        renderStatusInfo(statusInfo),
+        {}
       );
     } catch (ex) {
       log.error(`Caught an error when trying to show status at startup`, ex);
@@ -355,33 +327,12 @@ export class Draupnir implements Client {
         );
         return;
       }
-      const commandBeingRun = extractCommandFromMessageBody(
-        event.content.body,
+      this.commandDispatcher.handleCommandMessageEvent(
         {
-          prefix: COMMAND_PREFIX,
-          localpart: userLocalpart(this.clientUserID),
-          userId: this.clientUserID,
-          additionalPrefixes: this.config.commands.additionalPrefixes,
-          allowNoPrefix: this.config.commands.allowNoPrefix,
-        }
-      );
-      if (commandBeingRun === undefined) {
-        return;
-      }
-      log.info(`Command being run by ${event.sender}: ${commandBeingRun}`);
-      void Task(
-        this.client
-          .sendReadReceipt(roomID, event.event_id)
-          .then((_) => Ok(undefined))
-      );
-      void Task(
-        handleCommand(
-          roomID,
           event,
-          commandBeingRun,
-          this,
-          this.commandTable
-        ).then((_) => Ok(undefined))
+          roomID,
+        },
+        event.content.body
       );
     }
     this.reportManager.handleTimelineEvent(roomID, event);
@@ -414,4 +365,11 @@ export class Draupnir implements Client {
   public handleEventReport(report: EventReport): void {
     this.protectedRoomsSet.handleEventReport(report);
   }
+
+  /**
+   * This is needed to implement the MatrixInterfaceAdaptor interface.
+   */
+  public get commandRoomID() {
+    return this.managementRoomID;
+  }
 }

src/appservice/AppService.ts

@@ -56,7 +56,7 @@ const log = new Logger("AppService");
  */
 export class MjolnirAppService {
   private readonly api: Api;
-  private readonly commands: AppserviceCommandHandler;
+  public readonly commands: AppserviceCommandHandler;
 
   /**
    * The constructor is private because we want to ensure intialization steps are followed,