RoomListStore: Support specific sorting requirements for muted rooms (#29665)

* Sort muted rooms to the bottom of the room list

* Re-insert room on mute/unmute

* Write tests

* Fix broken playwright test

Muted rooms are at the bottom, so we need to scroll.

src/stores/room-list-v3/RoomListStoreV3.ts

@@ -34,6 +34,7 @@ import { LowPriorityFilter } from "./skip-list/filters/LowPriorityFilter";
 import { type Sorter, SortingAlgorithm } from "./skip-list/sorters";
 import { SettingLevel } from "../../settings/SettingLevel";
 import { MARKED_UNREAD_TYPE_STABLE, MARKED_UNREAD_TYPE_UNSTABLE } from "../../utils/notifications";
+import { getChangedOverrideRoomMutePushRules } from "../room-list/utils/roomMute";
 
 /**
  * These are the filters passed to the room skip list.
@@ -179,22 +180,7 @@ export class RoomListStoreV3Class extends AsyncStoreWithClient<EmptyObject> {
             }
 
             case "MatrixActions.accountData": {
-                if (payload.event_type !== EventType.Direct) return;
-                const dmMap = payload.event.getContent();
-                let needsEmit = false;
-                for (const userId of Object.keys(dmMap)) {
-                    const roomIds = dmMap[userId];
-                    for (const roomId of roomIds) {
-                        const room = this.matrixClient.getRoom(roomId);
-                        if (!room) {
-                            logger.warn(`${roomId} was found in DMs but the room is not in the store`);
-                            continue;
-                        }
-                        this.roomSkipList.addRoom(room);
-                        needsEmit = true;
-                    }
-                }
-                if (needsEmit) this.emit(LISTS_UPDATE_EVENT);
+                this.handleAccountDataPayload(payload);
                 break;
             }
 
@@ -230,6 +216,47 @@ export class RoomListStoreV3Class extends AsyncStoreWithClient<EmptyObject> {
         }
     }
 
+    /**
+     * This method deals with the two types of account data payloads that we care about.
+     */
+    private handleAccountDataPayload(payload: ActionPayload): void {
+        const eventType = payload.event_type;
+        let needsEmit = false;
+        switch (eventType) {
+            // When we're told about new DMs, insert the associated dm rooms.
+            case EventType.Direct: {
+                const dmMap = payload.event.getContent();
+                for (const userId of Object.keys(dmMap)) {
+                    const roomIds = dmMap[userId];
+                    for (const roomId of roomIds) {
+                        const room = this.matrixClient!.getRoom(roomId);
+                        if (!room) {
+                            logger.warn(`${roomId} was found in DMs but the room is not in the store`);
+                            continue;
+                        }
+                        this.roomSkipList!.addRoom(room);
+                        needsEmit = true;
+                    }
+                }
+                break;
+            }
+            case EventType.PushRules: {
+                // When a room becomes muted/unmuted, re-insert that room.
+                const possibleMuteChangeRoomIds = getChangedOverrideRoomMutePushRules(payload);
+                if (!possibleMuteChangeRoomIds) return;
+                const rooms = possibleMuteChangeRoomIds
+                    .map((id) => this.matrixClient?.getRoom(id))
+                    .filter((room) => !!room);
+                for (const room of rooms) {
+                    this.roomSkipList!.addRoom(room);
+                    needsEmit = true;
+                }
+                break;
+            }
+        }
+        if (needsEmit) this.emit(LISTS_UPDATE_EVENT);
+    }
+
     /**
      * Create the correct sorter depending on the persisted user preference.
      * @param myUserId The user-id of our user.

src/stores/room-list-v3/skip-list/sorters/RecencySorter.ts

@@ -8,6 +8,7 @@ Please see LICENSE files in the repository root for full details.
 import type { Room } from "matrix-js-sdk/src/matrix";
 import { type Sorter, SortingAlgorithm } from ".";
 import { getLastTs } from "../../../room-list/algorithms/tag-sorting/RecentAlgorithm";
+import { RoomNotificationStateStore } from "../../../notifications/RoomNotificationStateStore";
 
 export class RecencySorter implements Sorter {
     public constructor(private myUserId: string) {}
@@ -18,6 +19,13 @@ export class RecencySorter implements Sorter {
     }
 
     public comparator(roomA: Room, roomB: Room, cache?: any): number {
+        // Check mute status first; muted rooms should be at the bottom
+        const isRoomAMuted = RoomNotificationStateStore.instance.getRoomState(roomA).muted;
+        const isRoomBMuted = RoomNotificationStateStore.instance.getRoomState(roomB).muted;
+        if (isRoomAMuted && !isRoomBMuted) return 1;
+        if (isRoomBMuted && !isRoomAMuted) return -1;
+
+        // Then check recency; recent rooms should be at the top
         const roomALastTs = this.getTs(roomA, cache);
         const roomBLastTs = this.getTs(roomB, cache);
         return roomBLastTs - roomALastTs;