Support Hydra rooms (matrix-org#1077)

* Updates to support 0.7.1-element.14

* Cleanup

* fix bot spec

* never

* Update express to match bot-sdk

* Support new hydra power levels

* Update package.json

* lint

* Add changelog

* Add a test for v12 rooms

* Fixes for new PR

* missed a bit

* cleanup

* current

* fixup

* lint

* Remove new unused imports

* Set currentPl correctly

---------

Co-authored-by: Andrew Ferrazzutti <[email protected]>

Author: Half-Shot

changelog.d/1077.feature

@@ -0,0 +1 @@
+Support Matrix v12 rooms.

spec/permissions.spec.ts

@@ -110,4 +110,25 @@ describe("Permissions test", () => {
       "Room configured to bridge webhooks. See admin room for secret url.",
     );
   });
+
+  test("should allow users with permission to use a service in a v12 room", async () => {
+    const user = testEnv.getUser("allowed_user");
+    const roomId = await user.createRoom({
+      name: "Test room",
+      invite: [testEnv.botMxid],
+      room_version: "12",
+    });
+    await user.setUserPowerLevel(testEnv.botMxid, roomId, 50);
+    await user.waitForRoomJoin({ sender: testEnv.botMxid, roomId });
+
+    const msgWebhooks = user.waitForRoomEvent<MessageEventContent>({
+      eventType: "m.room.message",
+      sender: testEnv.botMxid,
+      roomId,
+    });
+    await user.sendText(roomId, "!hookshot webhook test");
+    expect((await msgWebhooks).data.content.body).to.include(
+      "Room configured to bridge webhooks. See admin room for secret url.",
+    );
+  });
 });

src/Bridge.ts

@@ -13,6 +13,7 @@ import {
   Intent,
   MatrixError,
   RoomEvent,
+  PLManager,
 } from "matrix-bot-sdk";
 import BotUsersManager from "./managers/BotUsersManager";
 import {
@@ -1719,15 +1720,19 @@ export class Bridge {
           log.debug(
             `${roomId} got a new powerlevel change and isn't connected to any connections, testing to see if we should create a setup widget`,
           );
+
+          const createEvent =
+            await botUser.intent.underlyingClient.getRoomCreateEvent(roomId);
           const plEvent = new PowerLevelsEvent(event);
-          const currentPl =
-            plEvent.content.users?.[botUser.userId] ?? plEvent.defaultUserLevel;
-          const previousPl =
-            plEvent.previousContent?.users?.[botUser.userId] ??
-            plEvent.previousContent?.users_default;
+          const plsOld = new PLManager(createEvent, plEvent.previousContent);
+          const plsCurrent = new PLManager(createEvent, plEvent.content);
+          const previousPl = plsOld.getUserPowerLevel(botUser.userId);
+          const currentPl = plsCurrent.getUserPowerLevel(botUser.userId);
           const requiredPl =
-            plEvent.content.events?.["im.vector.modular.widgets"] ??
-            plEvent.defaultStateEventLevel;
+            plsCurrent.currentPL.events?.["im.vector.modular.widgets"] ??
+            plsCurrent.currentPL.state_default ??
+            50;
+
           if (currentPl !== previousPl && currentPl >= requiredPl) {
             // PL changed for bot user, check to see if the widget can be created.
             try {

src/widgets/Api.ts

@@ -2,7 +2,7 @@ import {
   Intent,
   MatrixError,
   MembershipEventContent,
-  PowerLevelsEventContent,
+  PLManager,
 } from "matrix-bot-sdk";
 import { ApiError, ErrCode } from "../api";
 import { Logger } from "matrix-appservice-bridge";
@@ -57,7 +57,7 @@ export async function assertUserPermissionsInRoom(
         ErrCode.NotInRoom,
       );
     }
-    if (isNotFoundError(ex)) {
+    if (ex instanceof MatrixError && ex.errcode === "M_NOT_FOUND") {
       throw new ApiError("User is not joined to the room.", ErrCode.NotInRoom);
     }
     log.warn(`Failed to find member event for ${userId} in room ${roomId}`, ex);
@@ -77,7 +77,7 @@ export async function assertUserPermissionsInRoom(
       throw new ApiError("User is not joined to the room.", ErrCode.NotInRoom);
     }
   } catch (ex) {
-    if (isNotFoundError(ex)) {
+    if (ex instanceof MatrixError && ex.errcode === "M_NOT_FOUND") {
       throw new ApiError("User is not joined to the room.", ErrCode.NotInRoom);
     }
     log.warn(`Failed to find member event for ${userId} in room ${roomId}`, ex);
@@ -89,13 +89,16 @@ export async function assertUserPermissionsInRoom(
   if (requiredPermission === "read") {
     return true;
   }
-  let pls: PowerLevelsEventContent;
+  let pls: PLManager;
   try {
-    pls = (await intent.underlyingClient.getRoomStateEvent(
-      roomId,
-      "m.room.power_levels",
-      "",
-    )) as PowerLevelsEventContent;
+    pls = new PLManager(
+      await intent.underlyingClient.getRoomCreateEvent(roomId),
+      await intent.underlyingClient.getRoomStateEventContent(
+        roomId,
+        "m.room.power_levels",
+        "",
+      ),
+    );
   } catch (ex) {
     log.warn(`Failed to find PL event for room ${roomId}`, ex);
     throw new ApiError(
@@ -105,9 +108,9 @@ export async function assertUserPermissionsInRoom(
   }
 
   // TODO: Decide what PL consider "write" permissions
-  const botPl = pls.users?.[intent.userId] || pls.users_default || 0;
-  const userPl = pls.users?.[userId] || pls.users_default || 0;
-  const requiredPl = pls.state_default || 50;
+  const botPl = pls.getUserPowerLevel(intent.userId);
+  const userPl = pls.getUserPowerLevel(userId);
+  const requiredPl = pls.currentPL.state_default || 50;
 
   // Check the bot's permissions
   if (botPl < requiredPl) {
@@ -127,12 +130,3 @@ export async function assertUserPermissionsInRoom(
     );
   }
 }
-
-// TODO Use MatrixError as a type once matrix-bot-sdk is updated to a version that exports it
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-function isNotFoundError(ex: any) {
-  return (
-    "M_NOT_FOUND" ==
-    (ex instanceof ApiError ? ex.jsonBody.errcode : (ex.body?.errcode ?? ""))
-  );
-}

src/widgets/BridgeWidgetApi.ts

@@ -13,7 +13,7 @@ import { IBridgeStorageProvider } from "../stores/StorageProvider";
 import { ConnectionManager } from "../ConnectionManager";
 import BotUsersManager, { BotUser } from "../managers/BotUsersManager";
 import { assertUserPermissionsInRoom, GetConnectionsResponseItem } from "./Api";
-import { Appservice, PowerLevelsEvent } from "matrix-bot-sdk";
+import { Appservice, PLManager } from "matrix-bot-sdk";
 import { GithubInstance } from "../github/GithubInstance";
 import {
   AllowedTokenTypes,
@@ -216,13 +216,16 @@ export class BridgeWidgetApi extends ProvisioningApi {
       botUser.intent,
     );
     const allConnections = this.connMan.getAllConnectionsForRoom(roomId);
-    const powerlevel = new PowerLevelsEvent({
-      content: await botUser.intent.underlyingClient.getRoomStateEvent(
+
+    const powerlevel = new PLManager(
+      await botUser.intent.underlyingClient.getRoomCreateEvent(roomId),
+      await botUser.intent.underlyingClient.getRoomStateEventContent(
         roomId,
         "m.room.power_levels",
         "",
       ),
-    });
+    );
+
     const serviceFilter = req.params.service;
     const connections = allConnections
       .map((c) => c.getProvisionerDetails?.(true))
@@ -232,19 +235,18 @@ export class BridgeWidgetApi extends ProvisioningApi {
         (c) =>
           typeof serviceFilter !== "string" || c?.service === serviceFilter,
       ) as GetConnectionsResponseItem[];
-    const userPl =
-      powerlevel.content.users?.[req.userId] || powerlevel.defaultUserLevel;
-    const botPl =
-      powerlevel.content.users?.[botUser.userId] || powerlevel.defaultUserLevel;
+    const userPl = powerlevel.getUserPowerLevel(req.userId);
+    const botPl = powerlevel.getUserPowerLevel(botUser.userId);
+
     for (const c of connections) {
       // TODO: What about crypto?
       const requiredPlForEdit = Math.max(
-        powerlevel.content.events?.[c.type] ?? 0,
-        powerlevel.defaultStateEventLevel,
+        powerlevel.currentPL.events?.[c.type] ?? 0,
+        powerlevel.currentPL.state_default ?? 50,
       );
       const requiredPlForMessages = Math.max(
-        powerlevel.content.events?.["m.room.message"] ??
-          powerlevel.content.events_default ??
+        powerlevel.currentPL.events?.["m.room.message"] ??
+          powerlevel.currentPL.events_default ??
           0,
       );
       c.canEdit = userPl >= requiredPlForEdit;
@@ -256,7 +258,7 @@ export class BridgeWidgetApi extends ProvisioningApi {
 
     return {
       connections,
-      canEdit: userPl >= powerlevel.defaultStateEventLevel,
+      canEdit: userPl >= (powerlevel.currentPL.state_default ?? 50),
     };
   }