Unit tests for the ban and unban commands. (#542)

* Unit test Ban and UnbanCommands.

Fixes #441
will follow up with the-draupnir-project/interface-manager#7.

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

* Update to @the-draupnir-project/[email protected].

* Rest parameters can only give one argument from prompts.

* Update to @the-draupnir-project/[email protected].

Author: Gnuxie

package.json

@@ -56,7 +56,7 @@
     "@sentry/node": "^7.17.2",
     "@sentry/tracing": "^7.17.2",
     "@sinclair/typebox": "0.32.34",
-    "@the-draupnir-project/interface-manager": "2.0.0",
+    "@the-draupnir-project/interface-manager": "2.2.0",
     "@the-draupnir-project/matrix-basic-types": "^0.1.1",
     "await-lock": "^2.2.2",
     "better-sqlite3": "^9.4.3",

src/commands/Ban.tsx

@@ -8,19 +8,21 @@
 // https://github.com/matrix-org/mjolnir
 // </text>
 
-import { Draupnir } from "../Draupnir";
 import {
   ActionResult,
   PolicyRoomEditor,
   PolicyRuleType,
   isError,
   Ok,
+  PolicyRoomManager,
+  RoomResolver,
+  PolicyListConfig,
 } from "matrix-protection-suite";
-import { resolveRoomReferenceSafe } from "matrix-protection-suite-for-matrix-bot-sdk";
 import { findPolicyRoomIDFromShortcode } from "./CreateBanListCommand";
 import {
   MatrixRoomReference,
   MatrixUserID,
+  StringUserID,
 } from "@the-draupnir-project/matrix-basic-types";
 import {
   BasicInvocationInformation,
@@ -32,22 +34,31 @@ import {
   tuple,
   union,
 } from "@the-draupnir-project/interface-manager";
-import { DraupnirInterfaceAdaptor } from "./DraupnirCommandPrerequisites";
+import {
+  DraupnirContextToCommandContextTranslator,
+  DraupnirInterfaceAdaptor,
+} from "./DraupnirCommandPrerequisites";
 
 export async function findPolicyRoomEditorFromRoomReference(
-  draupnir: Draupnir,
+  roomResolver: RoomResolver,
+  policyRoomManager: PolicyRoomManager,
   policyRoomReference: MatrixRoomReference
 ): Promise<ActionResult<PolicyRoomEditor>> {
-  const policyRoomID = await resolveRoomReferenceSafe(
-    draupnir.client,
-    policyRoomReference
-  );
+  const policyRoomID = await roomResolver.resolveRoom(policyRoomReference);
   if (isError(policyRoomID)) {
     return policyRoomID;
   }
-  return await draupnir.policyRoomManager.getPolicyRoomEditor(policyRoomID.ok);
+  return await policyRoomManager.getPolicyRoomEditor(policyRoomID.ok);
 }
 
+export type DraupnirBanCommandContext = {
+  policyRoomManager: PolicyRoomManager;
+  issuerManager: PolicyListConfig;
+  defaultReasons: string[];
+  roomResolver: RoomResolver;
+  clientUserID: StringUserID;
+};
+
 export const DraupnirBanCommand = describeCommand({
   summary: "Bans an entity from the policy list.",
   parameters: tuple(
@@ -67,13 +78,13 @@ export const DraupnirBanCommand = describeCommand({
         MatrixRoomReferencePresentationSchema,
         StringPresentationType
       ),
-      prompt: async function (draupnir: Draupnir) {
+      prompt: async function ({
+        policyRoomManager,
+        clientUserID,
+      }: DraupnirBanCommandContext) {
         return Ok({
-          suggestions: draupnir.policyRoomManager
-            .getEditablePolicyRoomIDs(
-              draupnir.clientUserID,
-              PolicyRuleType.User
-            )
+          suggestions: policyRoomManager
+            .getEditablePolicyRoomIDs(clientUserID, PolicyRuleType.User)
             .map((room) => MatrixRoomIDPresentationType.wrap(room)),
         });
       },
@@ -83,16 +94,21 @@ export const DraupnirBanCommand = describeCommand({
     name: "reason",
     description: "The reason for the ban.",
     acceptor: StringPresentationType,
-    prompt: async function (draupnir: Draupnir) {
+    prompt: async function ({ defaultReasons }: DraupnirBanCommandContext) {
       return Ok({
-        suggestions: draupnir.config.commands.ban.defaultReasons.map(
-          (reason) => [StringPresentationType.wrap(reason)]
+        suggestions: defaultReasons.map((reason) =>
+          StringPresentationType.wrap(reason)
         ),
       });
     },
   },
   async executor(
-    draupnir: Draupnir,
+    {
+      issuerManager,
+      policyRoomManager,
+      roomResolver,
+      clientUserID,
+    }: DraupnirBanCommandContext,
     _info: BasicInvocationInformation,
     _keywords,
     reasonParts,
@@ -101,13 +117,19 @@ export const DraupnirBanCommand = describeCommand({
   ): Promise<ActionResult<string>> {
     const policyRoomReference =
       typeof policyRoomDesignator === "string"
-        ? await findPolicyRoomIDFromShortcode(draupnir, policyRoomDesignator)
+        ? await findPolicyRoomIDFromShortcode(
+            issuerManager,
+            policyRoomManager,
+            clientUserID,
+            policyRoomDesignator
+          )
         : Ok(policyRoomDesignator);
     if (isError(policyRoomReference)) {
       return policyRoomReference;
     }
     const policyListEditorResult = await findPolicyRoomEditorFromRoomReference(
-      draupnir,
+      roomResolver,
+      policyRoomManager,
       policyRoomReference.ok
     );
     if (isError(policyListEditorResult)) {
@@ -128,10 +150,7 @@ export const DraupnirBanCommand = describeCommand({
         reason
       );
     } else {
-      const resolvedRoomReference = await resolveRoomReferenceSafe(
-        draupnir.client,
-        entity
-      );
+      const resolvedRoomReference = await roomResolver.resolveRoom(entity);
       if (isError(resolvedRoomReference)) {
         return resolvedRoomReference;
       }
@@ -144,6 +163,19 @@ export const DraupnirBanCommand = describeCommand({
   },
 });
 
+DraupnirContextToCommandContextTranslator.registerTranslation(
+  DraupnirBanCommand,
+  function (draupnir) {
+    return {
+      policyRoomManager: draupnir.policyRoomManager,
+      issuerManager: draupnir.protectedRoomsSet.issuerManager,
+      defaultReasons: draupnir.config.commands.ban.defaultReasons,
+      roomResolver: draupnir.clientPlatform.toRoomResolver(),
+      clientUserID: draupnir.clientUserID,
+    };
+  }
+);
+
 DraupnirInterfaceAdaptor.describeRenderer(DraupnirBanCommand, {
   isAlwaysSupposedToUseDefaultRenderer: true,
 });

src/commands/CreateBanListCommand.ts

@@ -12,13 +12,18 @@ import {
   ActionError,
   ActionResult,
   Ok,
+  PolicyListConfig,
+  PolicyRoomManager,
   PolicyRuleType,
   PropagationType,
   isError,
 } from "matrix-protection-suite";
 import { listInfo } from "./StatusCommand";
 import { Draupnir } from "../Draupnir";
-import { MatrixRoomID } from "@the-draupnir-project/matrix-basic-types";
+import {
+  MatrixRoomID,
+  StringUserID,
+} from "@the-draupnir-project/matrix-basic-types";
 import {
   BasicInvocationInformation,
   ParsedKeywords,
@@ -84,10 +89,12 @@ DraupnirInterfaceAdaptor.describeRenderer(DraupnirListCreateCommand, {
 });
 
 export async function findPolicyRoomIDFromShortcode(
-  draupnir: Draupnir,
+  issuerManager: PolicyListConfig,
+  policyRoomManager: PolicyRoomManager,
+  editingClientUserID: StringUserID,
   shortcode: string
 ): Promise<ActionResult<MatrixRoomID>> {
-  const info = await listInfo(draupnir);
+  const info = await listInfo(issuerManager, policyRoomManager);
   const matchingRevisions = info.filter(
     (list) => list.revision.shortcode === shortcode
   );
@@ -99,7 +106,7 @@ export async function findPolicyRoomIDFromShortcode(
     return Ok(matchingRevisions[0].revision.room);
   } else {
     const remainingRevisions = matchingRevisions.filter((revision) =>
-      revision.revision.isAbleToEdit(draupnir.clientUserID, PolicyRuleType.User)
+      revision.revision.isAbleToEdit(editingClientUserID, PolicyRuleType.User)
     );
     if (
       remainingRevisions.length !== 1 ||

src/commands/Rules.tsx

@@ -90,7 +90,10 @@ export const DraupnirListRulesCommand = describeCommand({
   summary: "Lists the rules currently in use by Draupnir.",
   parameters: [],
   async executor(draupnir: Draupnir): Promise<Result<ListMatches[]>> {
-    const infoResult = await listInfo(draupnir);
+    const infoResult = await listInfo(
+      draupnir.protectedRoomsSet.issuerManager,
+      draupnir.policyRoomManager
+    );
     return Ok(
       infoResult.map((policyRoom) => ({
         room: policyRoom.revision.room,
@@ -124,7 +127,10 @@ export const DraupnirRulesMatchingCommand = describeCommand({
     _rest,
     entity
   ): Promise<Result<ListMatches[]>> {
-    const policyRooms = await listInfo(draupnir);
+    const policyRooms = await listInfo(
+      draupnir.protectedRoomsSet.issuerManager,
+      draupnir.policyRoomManager
+    );
     return Ok(
       policyRooms.map((policyRoom) => {
         return {

src/commands/StatusCommand.tsx

@@ -12,6 +12,8 @@ import { DOCUMENTATION_URL, PACKAGE_JSON, SOFTWARE_VERSION } from "../config";
 import {
   ActionResult,
   Ok,
+  PolicyListConfig,
+  PolicyRoomManager,
   PolicyRoomRevision,
   PolicyRoomWatchProfile,
   PolicyRuleType,
@@ -47,12 +49,14 @@ export interface StatusInfo {
   documentationURL: string;
 }
 
-export async function listInfo(draupnir: Draupnir): Promise<ListInfo[]> {
-  const watchedListProfiles =
-    draupnir.protectedRoomsSet.issuerManager.allWatchedLists;
+export async function listInfo(
+  issuerManager: PolicyListConfig,
+  policyRoomManager: PolicyRoomManager
+): Promise<ListInfo[]> {
+  const watchedListProfiles = issuerManager.allWatchedLists;
   const issuerResults = await Promise.all(
     watchedListProfiles.map((profile) =>
-      draupnir.policyRoomManager.getPolicyRoomRevisionIssuer(profile.room)
+      policyRoomManager.getPolicyRoomRevisionIssuer(profile.room)
     )
   );
   return issuerResults.map((result) => {
@@ -89,7 +93,10 @@ DraupnirInterfaceAdaptor.describeRenderer(DraupnirStatusCommand, {
 export async function draupnirStatusInfo(
   draupnir: Draupnir
 ): Promise<StatusInfo> {
-  const watchedListInfo = await listInfo(draupnir);
+  const watchedListInfo = await listInfo(
+    draupnir.protectedRoomsSet.issuerManager,
+    draupnir.policyRoomManager
+  );
   const protectedWatchedLists = watchedListInfo.filter((info) =>
     draupnir.protectedRoomsSet.isProtectedRoom(
       info.revision.room.toRoomIDOrAlias()