Command prefix fixes (#699)

We have added a "command normaliser" to interface-manager that can cover all the edge cases for pinging the bot or prefixing a command.

Fixes #678
Fixes #686

* Use interface-manager's command normaliser.

There's still work to be done to make sure we can get ahold of the
displyaname.

* Fetch displayname for Draupnir for the command normaliser.

* Update to [email protected]

This gives us the new command normaliser

Author: Gnuxie

package.json

@@ -52,7 +52,7 @@
     "@gnuxie/typescript-result": "^1.0.0",
     "@sentry/node": "^7.17.2",
     "@sinclair/typebox": "0.34.13",
-    "@the-draupnir-project/interface-manager": "3.0.0",
+    "@the-draupnir-project/interface-manager": "4.0.0",
     "@the-draupnir-project/matrix-basic-types": "^0.2.0",
     "better-sqlite3": "^9.4.3",
     "body-parser": "^1.20.2",

src/Draupnir.ts

@@ -126,6 +126,7 @@ export class Draupnir implements Client, MatrixAdaptorContext {
   private constructor(
     public readonly client: MatrixSendClient,
     public readonly clientUserID: StringUserID,
+    public clientDisplayName: string,
     public readonly clientPlatform: ClientPlatform,
     public readonly managementRoomDetail: ManagementRoomDetail,
     public readonly clientRooms: ClientRooms,
@@ -186,6 +187,7 @@ export class Draupnir implements Client, MatrixAdaptorContext {
   public static async makeDraupnirBot(
     client: MatrixSendClient,
     clientUserID: StringUserID,
+    clientDisplayName: string,
     clientPlatform: ClientPlatform,
     managementRoomDetail: ManagementRoomDetail,
     clientRooms: ClientRooms,
@@ -240,6 +242,7 @@ export class Draupnir implements Client, MatrixAdaptorContext {
     const draupnir = new Draupnir(
       client,
       clientUserID,
+      clientDisplayName,
       clientPlatform,
       managementRoomDetail,
       clientRooms,

src/appservice/bot/AppserviceBotCommandDispatcher.ts

@@ -9,8 +9,9 @@
 
 import {
   BasicInvocationInformation,
-  CommandPrefixExtractor,
+  CommandNormaliser,
   JSInterfaceCommandDispatcher,
+  makeCommandNormaliser,
   MatrixInterfaceCommandDispatcher,
   StandardJSInterfaceCommandDispatcher,
   StandardMatrixInterfaceCommandDispatcher,
@@ -21,33 +22,27 @@ import {
   invocationInformationFromMatrixEventcontext,
 } from "../../commands/interface-manager/MPSMatrixInterfaceAdaptor";
 import { AppserviceAdaptorContext } from "./AppserviceBotPrerequisite";
-import { userLocalpart } from "@the-draupnir-project/matrix-basic-types";
 import { AppserviceBotCommands } from "./AppserviceBotCommandTable";
 import { AppserviceBotHelpCommand } from "./AppserviceBotHelp";
 import {
   AppserviceBotInterfaceAdaptor,
   AppserviceAdaptorContextToCommandContextTranslator,
 } from "./AppserviceBotInterfaceAdaptor";
 
-function makePrefixExtractor(
+function makeAppserviceCommandNormaliser(
   appserviceContext: AppserviceAdaptorContext
-): CommandPrefixExtractor {
-  const plainPrefixes = [
-    "admin",
-    userLocalpart(appserviceContext.clientUserID),
-    appserviceContext.clientUserID,
-  ];
-  const allPossiblePrefixes = [
-    ...plainPrefixes.map((p) => `!${p}`),
-    ...plainPrefixes.map((p) => `${p}:`),
-    ...plainPrefixes,
-  ];
-  return (body) => {
-    const isPrefixUsed = allPossiblePrefixes.find((p) =>
-      body.toLowerCase().startsWith(p.toLowerCase())
-    );
-    return isPrefixUsed ? "admin" : undefined;
-  };
+): CommandNormaliser {
+  return makeCommandNormaliser(appserviceContext.clientUserID, {
+    symbolPrefixes: ["!"],
+    isAllowedOnlySymbolPrefixes: false,
+    additionalPrefixes: ["admin"],
+    getDisplayName: function (): string {
+      // TODO: I don't nkow how we're going to do this yet but we'll
+      // figure it out one day.
+      return "admin";
+    },
+    normalisedPrefix: "admin",
+  });
 }
 
 export function makeAppserviceBotCommandDispatcher(
@@ -61,7 +56,7 @@ export function makeAppserviceBotCommandDispatcher(
     invocationInformationFromMatrixEventcontext,
     {
       ...MPSCommandDispatcherCallbacks,
-      prefixExtractor: makePrefixExtractor(appserviceContext),
+      commandNormaliser: makeAppserviceCommandNormaliser(appserviceContext),
     }
   );
 }
@@ -75,7 +70,7 @@ export function makeAppserviceJSCommandDispatcher(
     appserviceContext,
     {
       ...MPSCommandDispatcherCallbacks,
-      prefixExtractor: makePrefixExtractor(appserviceContext),
+      commandNormaliser: makeAppserviceCommandNormaliser(appserviceContext),
     },
     AppserviceAdaptorContextToCommandContextTranslator
   );

src/commands/DraupnirCommandDispatcher.ts

@@ -10,10 +10,11 @@
 import {
   MatrixInterfaceCommandDispatcher,
   StandardMatrixInterfaceCommandDispatcher,
-  CommandPrefixExtractor,
   JSInterfaceCommandDispatcher,
   BasicInvocationInformation,
   StandardJSInterfaceCommandDispatcher,
+  CommandNormaliser,
+  makeCommandNormaliser,
 } from "@the-draupnir-project/interface-manager";
 import { Draupnir } from "../Draupnir";
 import {
@@ -22,33 +23,29 @@ import {
   invocationInformationFromMatrixEventcontext,
 } from "./interface-manager/MPSMatrixInterfaceAdaptor";
 import { DraupnirHelpCommand } from "./Help";
-import { userLocalpart } from "@the-draupnir-project/matrix-basic-types";
+import { StringUserID } from "@the-draupnir-project/matrix-basic-types";
 import { DraupnirTopLevelCommands } from "./DraupnirCommandTable";
 import {
   DraupnirContextToCommandContextTranslator,
   DraupnirInterfaceAdaptor,
 } from "./DraupnirCommandPrerequisites";
 import "./DraupnirCommands";
+import { IConfig } from "../config";
 
-function makePrefixExtractor(draupnir: Draupnir): CommandPrefixExtractor {
-  const plainPrefixes = [
-    "!draupnir",
-    userLocalpart(draupnir.clientUserID),
-    draupnir.clientUserID,
-    ...draupnir.config.commands.additionalPrefixes,
-  ];
-  const allPossiblePrefixes = [
-    ...plainPrefixes.map((p) => `!${p}`),
-    ...plainPrefixes.map((p) => `${p}:`),
-    ...plainPrefixes,
-    ...(draupnir.config.commands.allowNoPrefix ? ["!"] : []),
-  ];
-  return (body) => {
-    const isPrefixUsed = allPossiblePrefixes.find((p) =>
-      body.toLowerCase().startsWith(p.toLowerCase())
-    );
-    return isPrefixUsed ? "draupnir" : undefined;
-  };
+export function makeDraupnirCommandNormaliser(
+  clientUserID: StringUserID,
+  displayNameIssuer: { clientDisplayName: string },
+  config: IConfig
+): CommandNormaliser {
+  return makeCommandNormaliser(clientUserID, {
+    symbolPrefixes: ["!"],
+    isAllowedOnlySymbolPrefixes: config.commands.allowNoPrefix,
+    additionalPrefixes: ["draupnir", ...config.commands.additionalPrefixes],
+    getDisplayName: function (): string {
+      return displayNameIssuer.clientDisplayName;
+    },
+    normalisedPrefix: "draupnir",
+  });
 }
 
 export function makeDraupnirCommandDispatcher(
@@ -62,7 +59,11 @@ export function makeDraupnirCommandDispatcher(
     invocationInformationFromMatrixEventcontext,
     {
       ...MPSCommandDispatcherCallbacks,
-      prefixExtractor: makePrefixExtractor(draupnir),
+      commandNormaliser: makeDraupnirCommandNormaliser(
+        draupnir.clientUserID,
+        draupnir,
+        draupnir.config
+      ),
     }
   );
 }
@@ -76,7 +77,11 @@ export function makeDraupnirJSCommandDispatcher(
     draupnir,
     {
       ...MPSCommandDispatcherCallbacks,
-      prefixExtractor: makePrefixExtractor(draupnir),
+      commandNormaliser: makeDraupnirCommandNormaliser(
+        draupnir.clientUserID,
+        draupnir,
+        draupnir.config
+      ),
     },
     DraupnirContextToCommandContextTranslator
   );

src/commands/interface-manager/MPSMatrixInterfaceAdaptor.ts

@@ -180,6 +180,9 @@ export const MPSCommandDispatcherCallbacks = {
       error.message
     );
   },
+  commandNormaliser(body) {
+    return body;
+  },
 } satisfies CommandDispatcherCallbacks<BasicInvocationInformation>;
 
 export const rendererFailedCB: MatrixInterfaceRendererFailedCB<

src/draupnirfactory/DraupnirFactory.ts

@@ -15,6 +15,7 @@ import {
   ClientForUserID,
   RoomStateManagerFactory,
   joinedRoomsSafe,
+  resultifyBotSDKRequestErrorWith404AsUndefined,
 } from "matrix-protection-suite-for-matrix-bot-sdk";
 import { IConfig } from "../config";
 import { makeProtectedRoomsSet } from "./DraupnirProtectedRoomsSet";
@@ -101,9 +102,19 @@ export class DraupnirFactory {
       managementRoomMembership.ok,
       managementRoomState.ok
     );
+    const clientProfileResult = await client.getUserProfile(clientUserID).then(
+      (value) => Ok(value),
+      (error) => resultifyBotSDKRequestErrorWith404AsUndefined(error)
+    );
+    if (isError(clientProfileResult)) {
+      return clientProfileResult.elaborate(
+        "Unable to fetch Draupnir's profile information"
+      );
+    }
     return await Draupnir.makeDraupnirBot(
       client,
       clientUserID,
+      clientProfileResult.ok?.displayname ?? clientUserID,
       clientPlatform,
       managementRoomDetail,
       clientRooms.ok,
@@ -136,11 +147,21 @@ export class DraupnirFactory {
       clientUserID,
       client
     );
+    const clientProfileResult = await client.getUserProfile(clientUserID).then(
+      (value) => Ok(value),
+      (error) => resultifyBotSDKRequestErrorWith404AsUndefined(error)
+    );
+    if (isError(clientProfileResult)) {
+      return clientProfileResult.elaborate(
+        "Unable to fetch Draupnir's profile information"
+      );
+    }
     return Ok(
       new SafeModeDraupnir(
         cause,
         client,
         clientUserID,
+        clientProfileResult.ok?.displayname ?? clientUserID,
         clientPlatform,
         managementRoom,
         clientRooms.ok,

src/safemode/DraupnirSafeMode.ts

@@ -59,6 +59,7 @@ export class SafeModeDraupnir implements MatrixAdaptorContext {
     public readonly cause: SafeModeCause,
     public readonly client: MatrixSendClient,
     public readonly clientUserID: StringUserID,
+    public clientDisplayName: string,
     public readonly clientPlatform: ClientPlatform,
     public readonly managementRoom: MatrixRoomID,
     private readonly clientRooms: ClientRooms,

src/safemode/SafeModeCommandDispatcher.ts

@@ -4,7 +4,6 @@
 
 import {
   BasicInvocationInformation,
-  CommandPrefixExtractor,
   JSInterfaceCommandDispatcher,
   MatrixInterfaceCommandDispatcher,
   StandardJSInterfaceCommandDispatcher,
@@ -16,35 +15,13 @@ import {
   MatrixEventContext,
   invocationInformationFromMatrixEventcontext,
 } from "../commands/interface-manager/MPSMatrixInterfaceAdaptor";
-import { userLocalpart } from "@the-draupnir-project/matrix-basic-types";
 import { SafeModeCommands } from "./commands/SafeModeCommands";
 import { SafeModeHelpCommand } from "./commands/HelpCommand";
 import {
   SafeModeContextToCommandContextTranslator,
   SafeModeInterfaceAdaptor,
 } from "./commands/SafeModeAdaptor";
-
-function makePrefixExtractor(
-  safeModeDraupnir: SafeModeDraupnir
-): CommandPrefixExtractor {
-  const plainPrefixes = [
-    "!draupnir",
-    userLocalpart(safeModeDraupnir.clientUserID),
-    safeModeDraupnir.clientUserID,
-  ];
-  const allPossiblePrefixes = [
-    ...plainPrefixes.map((p) => `!${p}`),
-    ...plainPrefixes.map((p) => `${p}:`),
-    ...plainPrefixes,
-    ...(safeModeDraupnir.config.commands.allowNoPrefix ? ["!"] : []),
-  ];
-  return (body) => {
-    const isPrefixUsed = allPossiblePrefixes.find((p) =>
-      body.toLowerCase().startsWith(p.toLowerCase())
-    );
-    return isPrefixUsed ? "draupnir" : undefined;
-  };
-}
+import { makeDraupnirCommandNormaliser } from "../commands/DraupnirCommandDispatcher";
 
 export function makeSafeModeCommandDispatcher(
   safeModeDraupnir: SafeModeDraupnir
@@ -57,7 +34,11 @@ export function makeSafeModeCommandDispatcher(
     invocationInformationFromMatrixEventcontext,
     {
       ...MPSCommandDispatcherCallbacks,
-      prefixExtractor: makePrefixExtractor(safeModeDraupnir),
+      commandNormaliser: makeDraupnirCommandNormaliser(
+        safeModeDraupnir.clientUserID,
+        safeModeDraupnir,
+        safeModeDraupnir.config
+      ),
     }
   );
 }
@@ -71,7 +52,11 @@ export function makeSafeModeJSDispatcher(
     safeModeDraupnir,
     {
       ...MPSCommandDispatcherCallbacks,
-      prefixExtractor: makePrefixExtractor(safeModeDraupnir),
+      commandNormaliser: makeDraupnirCommandNormaliser(
+        safeModeDraupnir.clientUserID,
+        safeModeDraupnir,
+        safeModeDraupnir.config
+      ),
     },
     SafeModeContextToCommandContextTranslator
   );

yarn.lock

@@ -311,10 +311,10 @@
   resolved "https://registry.yarnpkg.com/@sinclair/typebox/-/typebox-0.27.8.tgz#6667fac16c436b5434a387a34dedb013198f6e6e"
   integrity sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA==
 
-"@the-draupnir-project/interface-manager@3.0.0":
-  version "3.0.0"
-  resolved "https://registry.yarnpkg.com/@the-draupnir-project/interface-manager/-/interface-manager-3.0.0.tgz#8aedad18be4f33a098e5dc2e74ed8590ca1aba68"
-  integrity sha512-TRPBf+JqcwHS8ARp2FXQhIGcvBrXhUEB16oCKQAybUqMN6f9G7hKP0WQnT1A+IK9xWkG1eAtyUf2HX1LUzwLxg==
+"@the-draupnir-project/interface-manager@4.0.0":
+  version "4.0.0"
+  resolved "https://registry.yarnpkg.com/@the-draupnir-project/interface-manager/-/interface-manager-4.0.0.tgz#068f4d22ee1f4c964879b1a3f0a619bec1a655c6"
+  integrity sha512-szatmeDnJgkeEBSwdvMRNum/CKVB15WVbN+0gIJQOsZZihQy6PZ4CGl9pLuV49E24kcFK9Z2our0Ut4N3oCAZA==
   dependencies:
     "@gnuxie/super-cool-stream" "^0.2.1"
     "@gnuxie/typescript-result" "^1.0.0"