Mark as Unread (#12254)

* Support the mark as unread flag

* Add mark as unread menu option

and make clering notifications also clear the unread flag

* Mark as read on viewing room

* Tests

* Remove random import

* Don't show mark as unread for historical rooms

* Fix tests & add test for menu option

* Test RoomNotificationState updates on unread flag change

* Test it doesn't update on other room account data

* New icon for mark as unread

* Add analytics events for mark as (un)read

* Bump to new analytics-events package

* Read from both stable & unstable prefixes

* Cast to boolean before checking

to avoid setting state unnecessarily

* Typo

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

* Doc external interface (and the rest at the same time)

* Doc & rename unread market set function

* Doc const exports

* Remove listener on destroy

* Add playwright test

* Clearer language, hopefully

* Move comment

* Add reference to the MSC

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

* Expand on function doc

* Remove empty beforeEach

* Rejig badge logic a little and add tests

* Fix basdges to not display dots in room sublists again

and hopefully rename the forceDot option to something that better
indicates what it does, and add tests.

* Remove duplicate license header (?)

* Missing word (several times...)

* Incorporate PR suggestion on badge type switch

* Better description in doc comment

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

* Update other doc comments in the same way

* Remove duplicate quote

* Use quotes consistently

* Better test name

* c+p fail

---------

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

test/stores/RoomViewStore-test.ts

@@ -108,6 +108,7 @@ describe("RoomViewStore", function () {
         relations: jest.fn(),
         knockRoom: jest.fn(),
         leave: jest.fn(),
+        setRoomAccountData: jest.fn(),
     });
     const room = new Room(roomId, mockClient, userId);
     const room2 = new Room(roomId2, mockClient, userId);
@@ -339,6 +340,17 @@ describe("RoomViewStore", function () {
         expect(mocked(Modal).createDialog.mock.calls[0][1]).toMatchSnapshot();
     });
 
+    it("clears the unread flag when viewing a room", async () => {
+        room.getAccountData = jest.fn().mockReturnValue({
+            getContent: jest.fn().mockReturnValue({ unread: true }),
+        });
+        dis.dispatch({ action: Action.ViewRoom, room_id: roomId });
+        await untilDispatch(Action.ActiveRoomChanged, dis);
+        expect(mockClient.setRoomAccountData).toHaveBeenCalledWith(roomId, "com.famedly.marked_unread", {
+            unread: false,
+        });
+    });
+
     describe("when listening to a voice broadcast", () => {
         let voiceBroadcastPlayback: VoiceBroadcastPlayback;
 

test/stores/notifications/RoomNotificationState-test.ts

@@ -22,6 +22,7 @@ import {
     NotificationCountType,
     EventType,
     MatrixEvent,
+    RoomEvent,
 } from "matrix-js-sdk/src/matrix";
 
 import type { MatrixClient } from "matrix-js-sdk/src/matrix";
@@ -80,7 +81,7 @@ describe("RoomNotificationState", () => {
         room.setUnreadNotificationCount(NotificationCountType.Total, greys);
     }
 
-    it("Updates on event decryption", () => {
+    it("updates on event decryption", () => {
         const roomNotifState = new RoomNotificationState(room, true);
         const listener = jest.fn();
         roomNotifState.addListener(NotificationStateEvents.Update, listener);
@@ -92,6 +93,36 @@ describe("RoomNotificationState", () => {
         expect(listener).toHaveBeenCalled();
     });
 
+    it("emits an Update event on marked unread room account data", () => {
+        const roomNotifState = new RoomNotificationState(room, true);
+        const listener = jest.fn();
+        roomNotifState.addListener(NotificationStateEvents.Update, listener);
+        const accountDataEvent = {
+            getType: () => "com.famedly.marked_unread",
+            getContent: () => {
+                return { unread: true };
+            },
+        } as unknown as MatrixEvent;
+        room.getAccountData = jest.fn().mockReturnValue(accountDataEvent);
+        room.emit(RoomEvent.AccountData, accountDataEvent, room);
+        expect(listener).toHaveBeenCalled();
+    });
+
+    it("does not update on other account data", () => {
+        const roomNotifState = new RoomNotificationState(room, true);
+        const listener = jest.fn();
+        roomNotifState.addListener(NotificationStateEvents.Update, listener);
+        const accountDataEvent = {
+            getType: () => "else.something",
+            getContent: () => {
+                return {};
+            },
+        } as unknown as MatrixEvent;
+        room.getAccountData = jest.fn().mockReturnValue(accountDataEvent);
+        room.emit(RoomEvent.AccountData, accountDataEvent, room);
+        expect(listener).not.toHaveBeenCalled();
+    });
+
     it("removes listeners", () => {
         const roomNotifState = new RoomNotificationState(room, false);
         expect(() => roomNotifState.destroy()).not.toThrow();