Merge pull request #725 from the-draupnir-project/gnuxie/revision-feedback

Show the time of the last `RoomStateRevision` for each room in the `!draupnir rooms` command. 

We also do this for policy lists.

#718

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@2.8.0",
-    "matrix-protection-suite-for-matrix-bot-sdk": "npm:@gnuxie/matrix-protection-suite-for-matrix-bot-sdk@2.8.0",
+    "matrix-protection-suite": "npm:@gnuxie/matrix-protection-suite@2.9.0",
+    "matrix-protection-suite-for-matrix-bot-sdk": "npm:@gnuxie/matrix-protection-suite-for-matrix-bot-sdk@2.9.0",
     "pg": "^8.8.0",
     "yaml": "^2.3.2"
   },

src/Draupnir.ts

@@ -298,13 +298,13 @@ export class Draupnir implements Client, MatrixAdaptorContext {
    * This means this is only used in the index.ts.
    */
   public async startupComplete(): Promise<void> {
-    const statusInfo = await draupnirStatusInfo(this);
     try {
       await this.managementRoomOutput.logMessage(
         LogLevel.INFO,
         "Draupnir@startup",
         "Startup complete. Now monitoring rooms."
       );
+      const statusInfo = draupnirStatusInfo(this);
       await sendMatrixEventsFromDeadDocument(
         this.clientPlatform.toRoomMessageSender(),
         this.managementRoomID,

src/appservice/AppServiceDraupnirManager.ts

@@ -23,7 +23,6 @@ import {
   ActionExceptionKind,
   ActionResult,
   Ok,
-  PropagationType,
   Task,
   isError,
 } from "matrix-protection-suite";
@@ -412,9 +411,7 @@ async function createFirstList(
   if (isError(addRoomResult)) {
     return addRoomResult;
   }
-  return await draupnir.protectedRoomsSet.issuerManager.watchList(
-    PropagationType.Direct,
-    policyRoom.ok,
-    {}
+  return await draupnir.protectedRoomsSet.watchedPolicyRooms.watchPolicyRoomDirectly(
+    policyRoom.ok
   );
 }

src/commands/Ban.tsx

@@ -1,4 +1,4 @@
-// Copyright 2022 - 2023 Gnuxie <[email protected]>
+// Copyright 2022 - 2025 Gnuxie <[email protected]>
 // Copyright 2019 - 2021 The Matrix.org Foundation C.I.C.
 //
 // SPDX-License-Identifier: AFL-3.0 AND Apache-2.0
@@ -16,9 +16,8 @@ import {
   Ok,
   PolicyRoomManager,
   RoomResolver,
-  PolicyListConfig,
+  WatchedPolicyRooms,
 } from "matrix-protection-suite";
-import { findPolicyRoomIDFromShortcode } from "./CreateBanListCommand";
 import {
   MatrixRoomReference,
   MatrixUserID,
@@ -38,6 +37,7 @@ import {
   DraupnirContextToCommandContextTranslator,
   DraupnirInterfaceAdaptor,
 } from "./DraupnirCommandPrerequisites";
+import { ResultError } from "@gnuxie/typescript-result";
 
 export async function findPolicyRoomEditorFromRoomReference(
   roomResolver: RoomResolver,
@@ -53,7 +53,7 @@ export async function findPolicyRoomEditorFromRoomReference(
 
 export type DraupnirBanCommandContext = {
   policyRoomManager: PolicyRoomManager;
-  issuerManager: PolicyListConfig;
+  watchedPolicyRooms: WatchedPolicyRooms;
   defaultReasons: string[];
   roomResolver: RoomResolver;
   clientUserID: StringUserID;
@@ -104,10 +104,9 @@ export const DraupnirBanCommand = describeCommand({
   },
   async executor(
     {
-      issuerManager,
+      watchedPolicyRooms,
       policyRoomManager,
       roomResolver,
-      clientUserID,
     }: DraupnirBanCommandContext,
     _info: BasicInvocationInformation,
     _keywords,
@@ -117,16 +116,19 @@ export const DraupnirBanCommand = describeCommand({
   ): Promise<ActionResult<string>> {
     const policyRoomReference =
       typeof policyRoomDesignator === "string"
-        ? await findPolicyRoomIDFromShortcode(
-            issuerManager,
-            policyRoomManager,
-            clientUserID,
-            policyRoomDesignator
+        ? Ok(
+            watchedPolicyRooms.findPolicyRoomFromShortcode(policyRoomDesignator)
+              ?.room
           )
         : Ok(policyRoomDesignator);
     if (isError(policyRoomReference)) {
       return policyRoomReference;
     }
+    if (policyRoomReference.ok === undefined) {
+      return ResultError.Result(
+        `Unable to find a policy room from the shortcode ${policyRoomDesignator.toString()}`
+      );
+    }
     const policyListEditorResult = await findPolicyRoomEditorFromRoomReference(
       roomResolver,
       policyRoomManager,
@@ -168,7 +170,7 @@ DraupnirContextToCommandContextTranslator.registerTranslation(
   function (draupnir) {
     return {
       policyRoomManager: draupnir.policyRoomManager,
-      issuerManager: draupnir.protectedRoomsSet.issuerManager,
+      watchedPolicyRooms: draupnir.protectedRoomsSet.watchedPolicyRooms,
       defaultReasons: draupnir.config.commands.ban.defaultReasons,
       roomResolver: draupnir.clientPlatform.toRoomResolver(),
       clientUserID: draupnir.clientUserID,

src/commands/CreateBanListCommand.ts

@@ -8,22 +8,9 @@
 // https://github.com/matrix-org/mjolnir
 // </text>
 
-import {
-  ActionError,
-  ActionResult,
-  Ok,
-  PolicyListConfig,
-  PolicyRoomManager,
-  PolicyRuleType,
-  PropagationType,
-  isError,
-} from "matrix-protection-suite";
-import { listInfo } from "./StatusCommand";
+import { ActionResult, isError } from "matrix-protection-suite";
 import { Draupnir } from "../Draupnir";
-import {
-  MatrixRoomID,
-  StringUserID,
-} from "@the-draupnir-project/matrix-basic-types";
+import { MatrixRoomID } from "@the-draupnir-project/matrix-basic-types";
 import {
   BasicInvocationInformation,
   ParsedKeywords,
@@ -52,11 +39,10 @@ export async function createList(
   if (isError(newList)) {
     return newList;
   }
-  const watchResult = await draupnir.protectedRoomsSet.issuerManager.watchList(
-    PropagationType.Direct,
-    newList.ok,
-    {}
-  );
+  const watchResult =
+    await draupnir.protectedRoomsSet.watchedPolicyRooms.watchPolicyRoomDirectly(
+      newList.ok
+    );
   if (isError(watchResult)) {
     return watchResult;
   }
@@ -87,36 +73,3 @@ export const DraupnirListCreateCommand = describeCommand({
 DraupnirInterfaceAdaptor.describeRenderer(DraupnirListCreateCommand, {
   isAlwaysSupposedToUseDefaultRenderer: true,
 });
-
-export async function findPolicyRoomIDFromShortcode(
-  issuerManager: PolicyListConfig,
-  policyRoomManager: PolicyRoomManager,
-  editingClientUserID: StringUserID,
-  shortcode: string
-): Promise<ActionResult<MatrixRoomID>> {
-  const info = await listInfo(issuerManager, policyRoomManager);
-  const matchingRevisions = info.filter(
-    (list) => list.revision.shortcode === shortcode
-  );
-  if (matchingRevisions.length === 0 || matchingRevisions[0] === undefined) {
-    return ActionError.Result(
-      `Could not find a policy room from the shortcode: ${shortcode}`
-    );
-  } else if (matchingRevisions.length === 1) {
-    return Ok(matchingRevisions[0].revision.room);
-  } else {
-    const remainingRevisions = matchingRevisions.filter((revision) =>
-      revision.revision.isAbleToEdit(editingClientUserID, PolicyRuleType.User)
-    );
-    if (
-      remainingRevisions.length !== 1 ||
-      remainingRevisions[0] === undefined
-    ) {
-      return ActionError.Result(
-        `The shortcode ${shortcode} is ambiguous and is currently used by ${remainingRevisions.length} lists.`
-      );
-    } else {
-      return Ok(remainingRevisions[0].revision.room);
-    }
-  }
-}

src/commands/Rooms.tsx

@@ -13,6 +13,8 @@ import {
   ActionExceptionKind,
   ActionResult,
   Ok,
+  Revision,
+  WatchedPolicyRoom,
   isError,
 } from "matrix-protection-suite";
 import {
@@ -29,11 +31,24 @@ import {
 import { Draupnir } from "../Draupnir";
 import { Result } from "@gnuxie/typescript-result";
 import { DraupnirInterfaceAdaptor } from "./DraupnirCommandPrerequisites";
+import {
+  groupWatchedPolicyRoomsByProtectionStatus,
+  renderPolicyList,
+} from "./StatusCommand";
+
+type RoomListItem = {
+  // used for room pill rendering
+  room: MatrixRoomID;
+  mostRecentRevision?: Revision;
+};
 
 type ListRoomsCommandInfo = {
-  joinedAndProtectedRooms: MatrixRoomID[];
-  joinedAndUnprotectedRooms: MatrixRoomID[];
-  partedAndProtectedRooms: MatrixRoomID[];
+  joinedAndProtectedLists: WatchedPolicyRoom[];
+  joinedAndWatchedLists: WatchedPolicyRoom[];
+  partedAndWatchedLists: WatchedPolicyRoom[];
+  joinedAndProtectedRooms: RoomListItem[];
+  joinedAndUnprotectedRooms: RoomListItem[];
+  partedAndProtectedRooms: RoomListItem[];
 };
 
 export const DraupnirListProtectedRoomsCommand = describeCommand({
@@ -42,25 +57,62 @@ export const DraupnirListProtectedRoomsCommand = describeCommand({
   async executor(draupnir: Draupnir): Promise<Result<ListRoomsCommandInfo>> {
     const allJoinedRooms = draupnir.clientRooms.currentRevision.allJoinedRooms;
     const allProtectedRooms = draupnir.protectedRoomsSet.allProtectedRooms;
+    const listInfo = groupWatchedPolicyRoomsByProtectionStatus(
+      draupnir.protectedRoomsSet.watchedPolicyRooms,
+      draupnir.clientRooms.currentRevision.allJoinedRooms,
+      draupnir.protectedRoomsSet.allProtectedRooms
+    );
+    const makeRoomListItem = (room: MatrixRoomID) => {
+      const revision = draupnir.protectedRoomsSet.setRoomState.getRevision(
+        room.toRoomIDOrAlias()
+      );
+      if (revision) {
+        return { room, mostRecentRevision: revision.revisionID };
+      } else {
+        return { room };
+      }
+    };
     return Ok({
-      joinedAndProtectedRooms: allProtectedRooms.filter((room) =>
-        allJoinedRooms.includes(room.toRoomIDOrAlias())
-      ),
+      joinedAndProtectedLists: listInfo.subscribedAndProtectedLists,
+      joinedAndWatchedLists: listInfo.subscribedLists,
+      partedAndWatchedLists: listInfo.subscribedButPartedLists,
+      joinedAndProtectedRooms: allProtectedRooms
+        .filter((room) => allJoinedRooms.includes(room.toRoomIDOrAlias()))
+        .map(makeRoomListItem),
       joinedAndUnprotectedRooms: allJoinedRooms
         .filter(
           (roomID) =>
             !allProtectedRooms.find((room) => room.toRoomIDOrAlias() === roomID)
         )
-        .map((roomID) => MatrixRoomReference.fromRoomID(roomID)),
-      partedAndProtectedRooms: allProtectedRooms.filter(
-        (room) => !allJoinedRooms.includes(room.toRoomIDOrAlias())
-      ),
+        .map((roomID) =>
+          makeRoomListItem(MatrixRoomReference.fromRoomID(roomID))
+        ),
+      partedAndProtectedRooms: allProtectedRooms
+        .filter((room) => !allJoinedRooms.includes(room.toRoomIDOrAlias()))
+        .map(makeRoomListItem),
     });
   },
 });
 
+function renderPolicyLists(
+  rooms: WatchedPolicyRoom[],
+  options: { name: string }
+): DocumentNode {
+  if (rooms.length === 0) {
+    return <fragment></fragment>;
+  }
+  return (
+    <details>
+      <summary>
+        {options.name} ({rooms.length}):
+      </summary>
+      <ul>{rooms.map(renderPolicyList)}</ul>
+    </details>
+  );
+}
+
 function renderRoomList(
-  rooms: MatrixRoomID[],
+  rooms: RoomListItem[],
   options: { name: string }
 ): DocumentNode {
   if (rooms.length === 0) {
@@ -72,9 +124,20 @@ function renderRoomList(
         {options.name} ({rooms.length}):
       </summary>
       <ul>
-        {rooms.map((r) => (
+        {rooms.map((item) => (
           <li>
-            <a href={r.toPermalink()}>{r.toRoomIDOrAlias()}</a>
+            <a href={item.room.toPermalink()}>{item.room.toRoomIDOrAlias()}</a>{" "}
+            {"mostRecentRevision" in item ? (
+              <fragment>
+                (last update:{" "}
+                <code>
+                  {new Date(item.mostRecentRevision.time).toLocaleString()}
+                </code>
+                )
+              </fragment>
+            ) : (
+              <fragment></fragment>
+            )}
           </li>
         ))}
       </ul>
@@ -94,6 +157,15 @@ DraupnirInterfaceAdaptor.describeRenderer(DraupnirListProtectedRoomsCommand, {
         ) : (
           <fragment></fragment>
         )}
+        {renderPolicyLists(result.ok.joinedAndProtectedLists, {
+          name: "Joined and protected policy rooms",
+        })}
+        {renderPolicyLists(result.ok.joinedAndWatchedLists, {
+          name: "Joined and watched unprotected policy rooms",
+        })}
+        {renderPolicyLists(result.ok.partedAndWatchedLists, {
+          name: "Parted policy rooms that are still marked as watched",
+        })}
         {renderRoomList(result.ok.joinedAndProtectedRooms, {
           name: "Protected rooms",
         })}