Fix appservice management room creation for room V12 (#924)

* Update MPS for client capability negotiation.

* Update appservice room creation for V12.

Author: Gnuxie

package.json

@@ -63,8 +63,8 @@
     "jsdom": "^24.0.0",
     "matrix-appservice-bridge": "^10.3.1",
     "matrix-bot-sdk": "npm:@vector-im/matrix-bot-sdk@^0.7.1-element.6",
-    "matrix-protection-suite": "npm:@gnuxie/matrix-protection-suite@3.7.1",
-    "matrix-protection-suite-for-matrix-bot-sdk": "npm:@gnuxie/matrix-protection-suite-for-matrix-bot-sdk@3.6.6",
+    "matrix-protection-suite": "npm:@gnuxie/matrix-protection-suite@3.8.0",
+    "matrix-protection-suite-for-matrix-bot-sdk": "npm:@gnuxie/matrix-protection-suite-for-matrix-bot-sdk@3.8.0",
     "pg": "^8.8.0",
     "yaml": "^2.3.2"
   },

src/appservice/AppService.ts

@@ -193,6 +193,7 @@ export class MjolnirAppService {
       roomStateManagerFactory,
       stores,
       clientCapabilityFactory,
+      clientsInRoomMap,
       clientProvider,
       instanceCountGauge
     );

src/appservice/AppServiceDraupnirManager.ts

@@ -22,14 +22,18 @@ import {
   ActionException,
   ActionExceptionKind,
   ActionResult,
+  ClientCapabilitiesNegotiation,
+  ClientsInRoomMap,
   Ok,
+  RoomCreator,
   Task,
   isError,
 } from "matrix-protection-suite";
 import { Draupnir } from "../Draupnir";
 import {
   ClientCapabilityFactory,
   ClientForUserID,
+  joinedRoomsSafe,
   RoomStateManagerFactory,
 } from "matrix-protection-suite-for-matrix-bot-sdk";
 import {
@@ -43,9 +47,10 @@ import {
   StringRoomID,
   MatrixRoomReference,
   userLocalpart,
-  isStringRoomID,
+  MatrixRoomID,
 } from "@the-draupnir-project/matrix-basic-types";
 import { TopLevelStores } from "../backingstore/DraupnirStores";
+import { Result } from "@gnuxie/typescript-result";
 
 const log = new Logger("AppServiceDraupnirManager");
 
@@ -66,6 +71,7 @@ export class AppServiceDraupnirManager {
     private readonly roomStateManagerFactory: RoomStateManagerFactory,
     stores: TopLevelStores,
     private readonly clientCapabilityFactory: ClientCapabilityFactory,
+    private readonly clientsInRoomMap: ClientsInRoomMap,
     clientProvider: ClientForUserID,
     private readonly instanceCountGauge: Gauge<"status" | "uuid">
   ) {
@@ -102,6 +108,7 @@ export class AppServiceDraupnirManager {
     roomStateManagerFactory: RoomStateManagerFactory,
     stores: TopLevelStores,
     clientCapabilityFactory: ClientCapabilityFactory,
+    clientsInRoomMap: ClientsInRoomMap,
     clientProvider: ClientForUserID,
     instanceCountGauge: Gauge<"status" | "uuid">
   ): Promise<AppServiceDraupnirManager> {
@@ -113,6 +120,7 @@ export class AppServiceDraupnirManager {
       roomStateManagerFactory,
       stores,
       clientCapabilityFactory,
+      clientsInRoomMap,
       clientProvider,
       instanceCountGauge
     );
@@ -202,26 +210,36 @@ export class AppServiceDraupnirManager {
     if (provisionedMjolnirs.length === 0) {
       const mjolnirLocalPart = `draupnir_${randomUUID()}`;
       const mjIntent = await this.makeMatrixIntent(mjolnirLocalPart);
-
-      const managementRoomID = await mjIntent.matrixClient.createRoom({
-        preset: "private_chat",
-        invite: [requestingUserID],
-        name: `${requestingUserID}'s Draupnir`,
-        power_level_content_override: {
-          users: {
-            [requestingUserID]: 100,
-            // Give the draupnir a higher PL so that can avoid issues with managing the management room.
-            [await mjIntent.matrixClient.getUserId()]: 101,
-          },
-        },
-      });
-      if (!isStringRoomID(managementRoomID)) {
-        throw new TypeError(`${managementRoomID} malformed managmentRoomID`);
+      const draupnirUserID = StringUserID(mjIntent.userId);
+      // we need to make sure the client rooms are available for the capability factory
+      const clientRooms = await this.clientsInRoomMap.makeClientRooms(
+        draupnirUserID,
+        async () => joinedRoomsSafe(mjIntent.matrixClient)
+      );
+      if (isError(clientRooms)) {
+        return clientRooms.elaborate(
+          "Unable to make client rooms for draupnir"
+        );
+      }
+      const clientPlatform = this.clientCapabilityFactory.makeClientPlatform(
+        draupnirUserID,
+        mjIntent.matrixClient
+      );
+      const managementRoom = await makeManagementRoom(
+        clientPlatform.toRoomCreator(),
+        clientPlatform.toClientCapabilitiesNegotiation(),
+        requestingUserID,
+        draupnirUserID
+      );
+      if (isError(managementRoom)) {
+        return managementRoom.elaborate(
+          "Failed to create management room for draupnir"
+        );
       }
       const draupnir = await this.makeInstance(
         mjolnirLocalPart,
         requestingUserID,
-        managementRoomID,
+        managementRoom.ok.toRoomIDOrAlias(),
         mjIntent.matrixClient
       );
       if (isError(draupnir)) {
@@ -238,7 +256,7 @@ export class AppServiceDraupnirManager {
       const record = {
         local_part: mjolnirLocalPart,
         owner: requestingUserID,
-        management_room: managementRoomID,
+        management_room: managementRoom.ok.toRoomIDOrAlias(),
       } as MjolnirRecord;
       await this.dataStore.store(record);
       return Ok(record);
@@ -424,3 +442,38 @@ async function createFirstList(
     policyRoom.ok
   );
 }
+
+export async function makeManagementRoom(
+  roomCreator: RoomCreator,
+  clientCapabilitiesNegotiation: ClientCapabilitiesNegotiation,
+  requestingUserID: StringUserID,
+  draupnirUserID: StringUserID
+): Promise<Result<MatrixRoomID>> {
+  const capabilities =
+    await clientCapabilitiesNegotiation.getClientCapabilities();
+  if (isError(capabilities)) {
+    return capabilities.elaborate(
+      "Failed to fetch room versions from client capabilities"
+    );
+  }
+  const isV12OrAboveDefault =
+    capabilities.ok.capabilities["m.room_versions"].default >= "12";
+  return await roomCreator.createRoom({
+    preset: "private_chat",
+    invite: [requestingUserID],
+    name: `${requestingUserID}'s Draupnir`,
+    power_level_content_override: isV12OrAboveDefault
+      ? {
+          users: {
+            [requestingUserID]: 150,
+          },
+        }
+      : {
+          users: {
+            [requestingUserID]: 100,
+            // Give the draupnir a higher PL so that can avoid issues with managing the management room.
+            [draupnirUserID]: 101,
+          },
+        },
+  });
+}

yarn.lock

@@ -2598,18 +2598,18 @@ matrix-appservice@^2.0.0:
     request-promise "^4.2.6"
     sanitize-html "^2.11.0"
 
-"matrix-protection-suite-for-matrix-bot-sdk@npm:@gnuxie/matrix-protection-suite-for-matrix-bot-sdk@3.6.6":
-  version "3.6.6"
-  resolved "https://registry.yarnpkg.com/@gnuxie/matrix-protection-suite-for-matrix-bot-sdk/-/matrix-protection-suite-for-matrix-bot-sdk-3.6.6.tgz#bdae14f76f5ffc54b2bfdaadfc0865c81511115f"
-  integrity sha512-PueDOaju+lxtljox0HBRrI1Q+U0hynAK4EjOItRGlwkWbjslONMJ7/ZR4JaFm7v5ZwG/DO4ShMrKrBZTfw1fQg==
+"matrix-protection-suite-for-matrix-bot-sdk@npm:@gnuxie/matrix-protection-suite-for-matrix-bot-sdk@3.8.0":
+  version "3.8.0"
+  resolved "https://registry.yarnpkg.com/@gnuxie/matrix-protection-suite-for-matrix-bot-sdk/-/matrix-protection-suite-for-matrix-bot-sdk-3.8.0.tgz#d47c87154c41f81816feb740b460696f2e141820"
+  integrity sha512-P1YkVGVbcCKfQlPMKDY72gm9u/XJ4Hq/6NTTU2rp7/aE7erP9UiZWKn5b+gglSS2SlcIxnbSFRohNKpvGHcptA==
   dependencies:
     "@gnuxie/typescript-result" "^1.0.0"
     await-lock "^2.2.2"
 
-"matrix-protection-suite@npm:@gnuxie/matrix-protection-suite@3.7.1":
-  version "3.7.1"
-  resolved "https://registry.yarnpkg.com/@gnuxie/matrix-protection-suite/-/matrix-protection-suite-3.7.1.tgz#0f5e128bb05a087b0f144f5466e648c89d88a50d"
-  integrity sha512-awSsgCqcWtPfNKOHM76Sb5w8UFpB1JDSy5vI5GXWOL2tFl7kXdZ9QXc0ohPC31+jXsKZgXOBaGMY3z830p+DVw==
+"matrix-protection-suite@npm:@gnuxie/matrix-protection-suite@3.8.0":
+  version "3.8.0"
+  resolved "https://registry.yarnpkg.com/@gnuxie/matrix-protection-suite/-/matrix-protection-suite-3.8.0.tgz#8e6370381d3bed0578624a3ba8c2ca3df7899024"
+  integrity sha512-R+6om4Mrf2evEaYZWzkLukjMdsyZv+0xyslCoQ0exd7i3LiAQ6TbcMyML7FD9UFxtPBHCO3my6OyWKCFtt5fQA==
   dependencies:
     "@gnuxie/typescript-result" "^1.0.0"
     await-lock "^2.2.2"