Merge pull request #538 from the-draupnir-project/gnuxie/commands-unit-tests

Allow command executors to be unit tested.

Part of the-draupnir-project/planning#22.

Only testing Watch/Unwatch command for now to prove that it works.
- Kick command will require a tiny MPS patch to expose kicking as a capability (I don't know if we're going to use the word Kick though).
- Kick command also will require the throttling queue to be hooked up and working again.
- Ban command should be pretty straight forward.

Author: Gnuxie

.github/workflows/mjolnir.yml

@@ -29,6 +29,17 @@ jobs:
       - 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:unit
   integration:
     name: Integration tests
     runs-on: ubuntu-latest

package.json

@@ -14,11 +14,12 @@
     "remove-tests-from-lib": "rm -rf lib/test/ && cp -r lib/src/* lib/ && rm -rf lib/src/",
     "lint": "corepack yarn eslint src test && corepack yarn prettier --check src test",
     "start:dev": "corepack yarn build && node --async-stack-traces lib/index.js",
-    "test": "ts-mocha --project ./tsconfig.json test/commands/**/*.ts",
-    "test:integration": "NODE_ENV=harness ts-mocha --async-stack-traces --forbid-only --require test/integration/fixtures.ts --timeout 300000 --project ./tsconfig.json \"test/integration/**/*Test.ts\"",
-    "test:integration:single": "NODE_ENV=harness corepack npx ts-mocha --require test/integration/fixtures.ts --timeout 300000 --project ./tsconfig.json",
-    "test:appservice:integration": "NODE_ENV=harness ts-mocha --async-stack-traces --forbid-only --timeout 300000 --project ./tsconfig.json \"test/appservice/integration/**/*Test.ts\"",
-    "test:appservice:integration:single": "NODE_ENV=harness corepack npx ts-mocha --timeout 300000 --project ./tsconfig.json",
+    "test:unit": "mocha --require './test/tsnode.cjs' 'test/unit/**/*.{ts,tsx}'",
+    "test:unit:single": "mocha --require test/tsnode.cjs",
+    "test:integration": "NODE_ENV=harness mocha --require test/tsnode.cjs --async-stack-traces --forbid-only --require test/integration/fixtures.ts --timeout 300000 --project ./tsconfig.json \"test/integration/**/*Test.ts\"",
+    "test:integration:single": "NODE_ENV=harness corepack yarn mocha --require test/tsnode.cjs --require test/integration/fixtures.ts --timeout 300000 --project ./tsconfig.json",
+    "test:appservice:integration": "NODE_ENV=harness mocha --require test/tsnode.cjs --async-stack-traces --forbid-only --timeout 300000 --project ./tsconfig.json \"test/appservice/integration/**/*Test.ts\"",
+    "test:appservice:integration:single": "NODE_ENV=harness corepack yarn mocha --require test/tsnode.cjs --timeout 300000 --project ./tsconfig.json",
     "test:manual": "NODE_ENV=harness ts-node test/integration/manualLaunchScript.ts",
     "version": "sed -i '/# version automated/s/[0-9][0-9]*\\.[0-9][0-9]*\\.[0-9][^\"]*/'$npm_package_version'/' synapse_antispam/setup.py && git add synapse_antispam/setup.py && cat synapse_antispam/setup.py"
   },
@@ -44,7 +45,8 @@
     "expect": "^29.7.0",
     "mocha": "^10.7.0",
     "prettier": "^3.3.3",
-    "ts-mocha": "^10.0.0",
+    "ts-auto-mock": "^3.7.4",
+    "ts-node": "^10.9.2",
     "typescript": "^5.5.3",
     "typescript-eslint": "^7.16.1",
     "typescript-formatter": "^7.2"
@@ -54,7 +56,7 @@
     "@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/interface-manager": "1.1.0",
     "@the-draupnir-project/matrix-basic-types": "^0.1.1",
     "await-lock": "^2.2.2",
     "better-sqlite3": "^9.4.3",

src/commands/WatchUnwatchCommand.ts

@@ -8,15 +8,28 @@
 // https://github.com/matrix-org/mjolnir
 // </text>
 
-import { PropagationType, isError } from "matrix-protection-suite";
+import {
+  PolicyListConfig,
+  PropagationType,
+  RoomResolver,
+  isError,
+} from "matrix-protection-suite";
 import {
   MatrixRoomReferencePresentationSchema,
   describeCommand,
   tuple,
 } from "@the-draupnir-project/interface-manager";
 import { Result } from "@gnuxie/typescript-result";
 import { Draupnir } from "../Draupnir";
-import { DraupnirInterfaceAdaptor } from "./DraupnirCommandPrerequisites";
+import {
+  DraupnirContextToCommandContextTranslator,
+  DraupnirInterfaceAdaptor,
+} from "./DraupnirCommandPrerequisites";
+
+export type DraupnirWatchUnwatchCommandContext = {
+  issuerManager: PolicyListConfig;
+  roomResolver: RoomResolver;
+};
 
 export const DraupnirWatchPolicyRoomCommand = describeCommand({
   summary:
@@ -26,19 +39,17 @@ export const DraupnirWatchPolicyRoomCommand = describeCommand({
     acceptor: MatrixRoomReferencePresentationSchema,
   }),
   async executor(
-    draupnir: Draupnir,
+    { issuerManager, roomResolver }: DraupnirWatchUnwatchCommandContext,
     _info,
     _keywords,
     _rest,
     policyRoomReference
   ): Promise<Result<void>> {
-    const policyRoom = await draupnir.clientPlatform
-      .toRoomResolver()
-      .resolveRoom(policyRoomReference);
+    const policyRoom = await roomResolver.resolveRoom(policyRoomReference);
     if (isError(policyRoom)) {
       return policyRoom;
     }
-    return await draupnir.protectedRoomsSet.issuerManager.watchList(
+    return await issuerManager.watchList(
       PropagationType.Direct,
       policyRoom.ok,
       {}
@@ -54,19 +65,17 @@ export const DraupnirUnwatchPolicyRoomCommand = describeCommand({
     acceptor: MatrixRoomReferencePresentationSchema,
   }),
   async executor(
-    draupnir: Draupnir,
+    { issuerManager, roomResolver }: DraupnirWatchUnwatchCommandContext,
     _info,
     _keywords,
     _rest,
     policyRoomReference
   ): Promise<Result<void>> {
-    const policyRoom = await draupnir.clientPlatform
-      .toRoomResolver()
-      .resolveRoom(policyRoomReference);
+    const policyRoom = await roomResolver.resolveRoom(policyRoomReference);
     if (isError(policyRoom)) {
       return policyRoom;
     }
-    return await draupnir.protectedRoomsSet.issuerManager.unwatchList(
+    return await issuerManager.unwatchList(
       PropagationType.Direct,
       policyRoom.ok
     );
@@ -80,4 +89,11 @@ for (const command of [
   DraupnirInterfaceAdaptor.describeRenderer(command, {
     isAlwaysSupposedToUseDefaultRenderer: true,
   });
+  DraupnirContextToCommandContextTranslator.registerTranslation(
+    command,
+    (draupnir: Draupnir) => ({
+      issuerManager: draupnir.protectedRoomsSet.issuerManager,
+      roomResolver: draupnir.clientPlatform.toRoomResolver(),
+    })
+  );
 }

test/tsnode.cjs

@@ -0,0 +1,11 @@
+// SPDX-FileCopyrightText: 2024 Gnuxie <[email protected]>
+//
+// SPDX-License-Identifier: CC0-1.0
+
+const tsAutoMockTransformer = require("ts-auto-mock/transformer").default;
+require("ts-node").register({
+  project: "./tsconfig.json",
+  transformers: (program) => ({
+    before: [tsAutoMockTransformer(program)],
+  }),
+});

test/unit/commands/WatchUnwatchCommandTest.ts

@@ -0,0 +1,62 @@
+// SPDX-FileCopyrightText: 2024 Gnuxie <[email protected]>
+//
+// SPDX-License-Identifier: AFL-3.0
+
+import {
+  MatrixRoomID,
+  MatrixRoomReference,
+  StringRoomID,
+} from "@the-draupnir-project/matrix-basic-types";
+import expect from "expect";
+import {
+  Ok,
+  PolicyListConfig,
+  PropagationType,
+  RoomResolver,
+  isOk,
+} from "matrix-protection-suite";
+import { createMock } from "ts-auto-mock";
+import {
+  DraupnirUnwatchPolicyRoomCommand,
+  DraupnirWatchPolicyRoomCommand,
+} from "../../../src/commands/WatchUnwatchCommand";
+import { CommandExecutorHelper } from "@the-draupnir-project/interface-manager";
+
+describe("Test the WatchUnwatchCommmands", function () {
+  const policyRoom = MatrixRoomReference.fromRoomID(
+    "!room:example.com" as StringRoomID
+  );
+  const issuerManager = createMock<PolicyListConfig>({
+    async watchList(propagation, room, _options) {
+      expect(room).toBe(policyRoom);
+      expect(propagation).toBe(PropagationType.Direct);
+      return Ok(undefined);
+    },
+  });
+  const roomResolver = createMock<RoomResolver>({
+    async resolveRoom(roomReference) {
+      if (roomReference instanceof MatrixRoomID) {
+        return Ok(roomReference);
+      }
+      throw new TypeError(`We don't really expect to resolve anything`);
+    },
+  });
+  it("DraupnirWatchCommand", async function () {
+    const result = await CommandExecutorHelper.execute(
+      DraupnirWatchPolicyRoomCommand,
+      { issuerManager, roomResolver },
+      {},
+      policyRoom
+    );
+    expect(isOk(result)).toBe(true);
+  });
+  it("DraupnirUnwatchCommand", async function () {
+    const result = await CommandExecutorHelper.execute(
+      DraupnirUnwatchPolicyRoomCommand,
+      { issuerManager, roomResolver },
+      {},
+      policyRoom
+    );
+    expect(isOk(result)).toBe(true);
+  });
+});