Revert "Check each thread for unread messages. (#9723)" (#9745)

* Revert "Check each thread for unread messages. (#9723)"

This reverts commit 9de5654353.

* ts strict

src/Unread.ts

@@ -15,7 +15,6 @@ limitations under the License.
 */
 
 import { Room } from "matrix-js-sdk/src/models/room";
-import { Thread } from "matrix-js-sdk/src/models/thread";
 import { MatrixEvent } from "matrix-js-sdk/src/models/event";
 import { EventType } from "matrix-js-sdk/src/@types/event";
 import { M_BEACON } from "matrix-js-sdk/src/@types/beacon";
@@ -60,33 +59,35 @@ export function doesRoomHaveUnreadMessages(room: Room): boolean {
         return false;
     }
 
-    for (const timeline of [room, ...room.getThreads()]) {
-        // If the current timeline has unread messages, we're done.
-        if (doesRoomOrThreadHaveUnreadMessages(timeline)) {
-            return true;
-        }
-    }
-    // If we got here then no timelines were found with unread messages.
-    return false;
-}
-
-function doesRoomOrThreadHaveUnreadMessages(room: Room | Thread): boolean {
     const myUserId = MatrixClientPeg.get().getUserId();
 
+    // get the most recent read receipt sent by our account.
+    // N.B. this is NOT a read marker (RM, aka "read up to marker"),
+    // despite the name of the method :((
+    const readUpToId = room.getEventReadUpTo(myUserId!);
+
+    if (!SettingsStore.getValue("feature_thread")) {
         // as we don't send RRs for our own messages, make sure we special case that
         // if *we* sent the last message into the room, we consider it not unread!
         // Should fix: https://github.com/vector-im/element-web/issues/3263
         //             https://github.com/vector-im/element-web/issues/2427
         // ...and possibly some of the others at
         //             https://github.com/vector-im/element-web/issues/3363
-    if (room.timeline.at(-1)?.getSender() === myUserId) {
+        if (room.timeline.length && room.timeline[room.timeline.length - 1].getSender() === myUserId) {
             return false;
         }
+    }
 
-    // get the most recent read receipt sent by our account.
+    // if the read receipt relates to an event is that part of a thread
-    // N.B. this is NOT a read marker (RM, aka "read up to marker"),
+    // we consider that there are no unread messages
-    // despite the name of the method :((
+    // This might be a false negative, but probably the best we can do until
-    const readUpToId = room.getEventReadUpTo(myUserId!);
+    // the read receipts have evolved to cater for threads
+    if (readUpToId) {
+        const event = room.findEventById(readUpToId);
+        if (event?.getThread()) {
+            return false;
+        }
+    }
 
     // this just looks at whatever history we have, which if we've only just started
     // up probably won't be very much, so if the last couple of events are ones that

test/Unread-test.ts

@@ -15,26 +15,25 @@ limitations under the License.
 */
 
 import { mocked } from "jest-mock";
-import { MatrixEvent, EventType, MsgType, Room } from "matrix-js-sdk/src/matrix";
+import { MatrixEvent, EventType, MsgType } from "matrix-js-sdk/src/matrix";
-import { ReceiptType } from "matrix-js-sdk/src/@types/read_receipts";
 
 import { haveRendererForEvent } from "../src/events/EventTileFactory";
-import { makeBeaconEvent, mkEvent, stubClient } from "./test-utils";
+import { getMockClientWithEventEmitter, makeBeaconEvent, mockClientMethodsUser } from "./test-utils";
-import { mkThread } from "./test-utils/threads";
+import { eventTriggersUnreadCount } from "../src/Unread";
-import { doesRoomHaveUnreadMessages, eventTriggersUnreadCount } from "../src/Unread";
-import { MatrixClientPeg } from "../src/MatrixClientPeg";
 
 jest.mock("../src/events/EventTileFactory", () => ({
     haveRendererForEvent: jest.fn(),
 }));
 
-describe("Unread", () => {
+describe("eventTriggersUnreadCount()", () => {
-    // A different user.
     const aliceId = "@alice:server.org";
-    stubClient();
+    const bobId = "@bob:server.org";
-    const client = MatrixClientPeg.get();
+
+    // mock user credentials
+    getMockClientWithEventEmitter({
+        ...mockClientMethodsUser(bobId),
+    });
 
-    describe("eventTriggersUnreadCount()", () => {
     // setup events
     const alicesMessage = new MatrixEvent({
         type: EventType.RoomMessage,
@@ -45,9 +44,9 @@ describe("Unread", () => {
         },
     });
 
-        const ourMessage = new MatrixEvent({
+    const bobsMessage = new MatrixEvent({
         type: EventType.RoomMessage,
-            sender: client.getUserId()!,
+        sender: bobId,
         content: {
             msgtype: MsgType.Text,
             body: "Hello from Bob",
@@ -66,7 +65,7 @@ describe("Unread", () => {
     });
 
     it("returns false when the event was sent by the current user", () => {
-            expect(eventTriggersUnreadCount(ourMessage)).toBe(false);
+        expect(eventTriggersUnreadCount(bobsMessage)).toBe(false);
         // returned early before checking renderer
         expect(haveRendererForEvent).not.toHaveBeenCalled();
     });
@@ -104,217 +103,12 @@ describe("Unread", () => {
         EventType.RoomServerAcl,
     ];
 
-        it.each(noUnreadEventTypes)(
+    it.each(noUnreadEventTypes)("returns false without checking for renderer for events with type %s", (eventType) => {
-            "returns false without checking for renderer for events with type %s",
-            (eventType) => {
         const event = new MatrixEvent({
             type: eventType,
             sender: aliceId,
         });
         expect(eventTriggersUnreadCount(event)).toBe(false);
         expect(haveRendererForEvent).not.toHaveBeenCalled();
-            },
-        );
-    });
-
-    describe("doesRoomHaveUnreadMessages()", () => {
-        let room: Room;
-        let event: MatrixEvent;
-        const roomId = "!abc:server.org";
-        const myId = client.getUserId()!;
-
-        beforeAll(() => {
-            client.supportsExperimentalThreads = () => true;
-        });
-
-        beforeEach(() => {
-            // Create a room and initial event in it.
-            room = new Room(roomId, client, myId);
-            event = mkEvent({
-                event: true,
-                type: "m.room.message",
-                user: aliceId,
-                room: roomId,
-                content: {},
-            });
-            room.addLiveEvents([event]);
-
-            // Don't care about the code path of hidden events.
-            mocked(haveRendererForEvent).mockClear().mockReturnValue(true);
-        });
-
-        it("returns true for a room with no receipts", () => {
-            expect(doesRoomHaveUnreadMessages(room)).toBe(true);
-        });
-
-        it("returns false for a room when the latest event was sent by the current user", () => {
-            event = mkEvent({
-                event: true,
-                type: "m.room.message",
-                user: myId,
-                room: roomId,
-                content: {},
-            });
-            // Only for timeline events.
-            room.addLiveEvents([event]);
-
-            expect(doesRoomHaveUnreadMessages(room)).toBe(false);
-        });
-
-        it("returns false for a room when the read receipt is at the latest event", () => {
-            const receipt = new MatrixEvent({
-                type: "m.receipt",
-                room_id: "!foo:bar",
-                content: {
-                    [event.getId()!]: {
-                        [ReceiptType.Read]: {
-                            [myId]: { ts: 1 },
-                        },
-                    },
-                },
-            });
-            room.addReceipt(receipt);
-
-            expect(doesRoomHaveUnreadMessages(room)).toBe(false);
-        });
-
-        it("returns true for a room when the read receipt is earlier than the latest event", () => {
-            const receipt = new MatrixEvent({
-                type: "m.receipt",
-                room_id: "!foo:bar",
-                content: {
-                    [event.getId()!]: {
-                        [ReceiptType.Read]: {
-                            [myId]: { ts: 1 },
-                        },
-                    },
-                },
-            });
-            room.addReceipt(receipt);
-
-            const event2 = mkEvent({
-                event: true,
-                type: "m.room.message",
-                user: aliceId,
-                room: roomId,
-                content: {},
-            });
-            // Only for timeline events.
-            room.addLiveEvents([event2]);
-
-            expect(doesRoomHaveUnreadMessages(room)).toBe(true);
-        });
-
-        it("returns true for a room with an unread message in a thread", () => {
-            // Mark the main timeline as read.
-            const receipt = new MatrixEvent({
-                type: "m.receipt",
-                room_id: "!foo:bar",
-                content: {
-                    [event.getId()!]: {
-                        [ReceiptType.Read]: {
-                            [myId]: { ts: 1 },
-                        },
-                    },
-                },
-            });
-            room.addReceipt(receipt);
-
-            // Create a thread as a different user.
-            mkThread({ room, client, authorId: myId, participantUserIds: [aliceId] });
-
-            expect(doesRoomHaveUnreadMessages(room)).toBe(true);
-        });
-
-        it("returns false for a room when the latest thread event was sent by the current user", () => {
-            // Mark the main timeline as read.
-            const receipt = new MatrixEvent({
-                type: "m.receipt",
-                room_id: "!foo:bar",
-                content: {
-                    [event.getId()!]: {
-                        [ReceiptType.Read]: {
-                            [myId]: { ts: 1 },
-                        },
-                    },
-                },
-            });
-            room.addReceipt(receipt);
-
-            // Create a thread as the current user.
-            mkThread({ room, client, authorId: myId, participantUserIds: [myId] });
-
-            expect(doesRoomHaveUnreadMessages(room)).toBe(false);
-        });
-
-        it("returns false for a room with read thread messages", () => {
-            // Mark the main timeline as read.
-            let receipt = new MatrixEvent({
-                type: "m.receipt",
-                room_id: "!foo:bar",
-                content: {
-                    [event.getId()!]: {
-                        [ReceiptType.Read]: {
-                            [myId]: { ts: 1 },
-                        },
-                    },
-                },
-            });
-            room.addReceipt(receipt);
-
-            // Create threads.
-            const { rootEvent, events } = mkThread({ room, client, authorId: myId, participantUserIds: [aliceId] });
-
-            // Mark the thread as read.
-            receipt = new MatrixEvent({
-                type: "m.receipt",
-                room_id: "!foo:bar",
-                content: {
-                    [events[events.length - 1].getId()!]: {
-                        [ReceiptType.Read]: {
-                            [myId]: { ts: 1, thread_id: rootEvent.getId()! },
-                        },
-                    },
-                },
-            });
-            room.addReceipt(receipt);
-
-            expect(doesRoomHaveUnreadMessages(room)).toBe(false);
-        });
-
-        it("returns true for a room when read receipt is not on the latest thread messages", () => {
-            // Mark the main timeline as read.
-            let receipt = new MatrixEvent({
-                type: "m.receipt",
-                room_id: "!foo:bar",
-                content: {
-                    [event.getId()!]: {
-                        [ReceiptType.Read]: {
-                            [myId]: { ts: 1 },
-                        },
-                    },
-                },
-            });
-            room.addReceipt(receipt);
-
-            // Create threads.
-            const { rootEvent, events } = mkThread({ room, client, authorId: myId, participantUserIds: [aliceId] });
-
-            // Mark the thread as read.
-            receipt = new MatrixEvent({
-                type: "m.receipt",
-                room_id: "!foo:bar",
-                content: {
-                    [events[0].getId()!]: {
-                        [ReceiptType.Read]: {
-                            [myId]: { ts: 1, threadId: rootEvent.getId()! },
-                        },
-                    },
-                },
-            });
-            room.addReceipt(receipt);
-
-            expect(doesRoomHaveUnreadMessages(room)).toBe(true);
-        });
     });
 });