2022-02-17 09:18:37 +00:00
|
|
|
/*
|
2024-09-09 13:57:16 +00:00
|
|
|
Copyright 2024 New Vector Ltd.
|
|
|
|
Copyright 2022, 2023 The Matrix.org Foundation C.I.C.
|
2022-02-17 09:18:37 +00:00
|
|
|
|
2024-09-09 13:57:16 +00:00
|
|
|
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
|
|
|
|
Please see LICENSE files in the repository root for full details.
|
2022-02-17 09:18:37 +00:00
|
|
|
*/
|
|
|
|
|
2023-01-31 09:58:17 +00:00
|
|
|
import {
|
2023-08-04 07:36:16 +00:00
|
|
|
Room,
|
2023-01-31 09:58:17 +00:00
|
|
|
MatrixEventEvent,
|
|
|
|
PendingEventOrdering,
|
|
|
|
EventStatus,
|
|
|
|
NotificationCountType,
|
|
|
|
EventType,
|
2023-08-03 12:56:30 +00:00
|
|
|
MatrixEvent,
|
2024-03-19 13:28:20 +00:00
|
|
|
RoomEvent,
|
2023-01-31 09:58:17 +00:00
|
|
|
} from "matrix-js-sdk/src/matrix";
|
2024-03-18 14:40:52 +00:00
|
|
|
import { KnownMembership } from "matrix-js-sdk/src/types";
|
2022-02-17 09:18:37 +00:00
|
|
|
|
2023-01-31 09:58:17 +00:00
|
|
|
import type { MatrixClient } from "matrix-js-sdk/src/matrix";
|
|
|
|
import { mkEvent, muteRoom, stubClient } from "../../test-utils";
|
2022-02-17 09:18:37 +00:00
|
|
|
import { RoomNotificationState } from "../../../src/stores/notifications/RoomNotificationState";
|
|
|
|
import { NotificationStateEvents } from "../../../src/stores/notifications/NotificationState";
|
2024-01-15 15:25:48 +00:00
|
|
|
import { NotificationLevel } from "../../../src/stores/notifications/NotificationLevel";
|
2023-01-31 09:58:17 +00:00
|
|
|
import { createMessageEventContent } from "../../test-utils/events";
|
2022-02-17 09:18:37 +00:00
|
|
|
|
|
|
|
describe("RoomNotificationState", () => {
|
2023-01-31 09:58:17 +00:00
|
|
|
let room: Room;
|
2022-10-24 06:50:21 +00:00
|
|
|
let client: MatrixClient;
|
2022-02-17 09:18:37 +00:00
|
|
|
|
2022-10-24 06:50:21 +00:00
|
|
|
beforeEach(() => {
|
2023-01-31 09:58:17 +00:00
|
|
|
client = stubClient();
|
|
|
|
room = new Room("!room:example.com", client, "@user:example.org", {
|
|
|
|
pendingEventOrdering: PendingEventOrdering.Detached,
|
|
|
|
});
|
2022-10-24 06:50:21 +00:00
|
|
|
});
|
2022-02-17 09:18:37 +00:00
|
|
|
|
2023-01-31 09:58:17 +00:00
|
|
|
function addThread(room: Room): void {
|
|
|
|
const threadId = "thread_id";
|
|
|
|
jest.spyOn(room, "eventShouldLiveIn").mockReturnValue({
|
|
|
|
shouldLiveInRoom: true,
|
|
|
|
shouldLiveInThread: true,
|
|
|
|
threadId,
|
|
|
|
});
|
|
|
|
const thread = room.createThread(
|
|
|
|
threadId,
|
|
|
|
new MatrixEvent({
|
|
|
|
room_id: room.roomId,
|
|
|
|
event_id: "event_root_1",
|
|
|
|
type: EventType.RoomMessage,
|
|
|
|
sender: "userId",
|
|
|
|
content: createMessageEventContent("RootEvent"),
|
|
|
|
}),
|
|
|
|
[],
|
|
|
|
true,
|
|
|
|
);
|
|
|
|
for (let i = 0; i < 10; i++) {
|
|
|
|
thread.addEvent(
|
|
|
|
new MatrixEvent({
|
|
|
|
room_id: room.roomId,
|
|
|
|
event_id: "event_reply_1" + i,
|
|
|
|
type: EventType.RoomMessage,
|
|
|
|
sender: "userId",
|
|
|
|
content: createMessageEventContent("ReplyEvent" + 1),
|
|
|
|
}),
|
|
|
|
false,
|
|
|
|
);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
function setUnreads(room: Room, greys: number, reds: number): void {
|
|
|
|
room.setUnreadNotificationCount(NotificationCountType.Highlight, reds);
|
|
|
|
room.setUnreadNotificationCount(NotificationCountType.Total, greys);
|
|
|
|
}
|
|
|
|
|
2024-03-19 13:28:20 +00:00
|
|
|
it("updates on event decryption", () => {
|
2024-01-29 17:52:48 +00:00
|
|
|
const roomNotifState = new RoomNotificationState(room, true);
|
2022-02-17 09:18:37 +00:00
|
|
|
const listener = jest.fn();
|
|
|
|
roomNotifState.addListener(NotificationStateEvents.Update, listener);
|
|
|
|
const testEvent = {
|
2023-01-31 09:58:17 +00:00
|
|
|
getRoomId: () => room.roomId,
|
2022-03-11 16:03:33 +00:00
|
|
|
} as unknown as MatrixEvent;
|
2023-01-31 09:58:17 +00:00
|
|
|
room.getUnreadNotificationCount = jest.fn().mockReturnValue(1);
|
2022-03-11 16:03:33 +00:00
|
|
|
client.emit(MatrixEventEvent.Decrypted, testEvent);
|
2022-02-17 09:18:37 +00:00
|
|
|
expect(listener).toHaveBeenCalled();
|
|
|
|
});
|
2022-10-24 06:50:21 +00:00
|
|
|
|
2024-03-19 13:28:20 +00:00
|
|
|
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();
|
|
|
|
});
|
|
|
|
|
2022-10-24 06:50:21 +00:00
|
|
|
it("removes listeners", () => {
|
2024-01-29 17:52:48 +00:00
|
|
|
const roomNotifState = new RoomNotificationState(room, false);
|
2022-10-24 06:50:21 +00:00
|
|
|
expect(() => roomNotifState.destroy()).not.toThrow();
|
|
|
|
});
|
2023-01-31 09:58:17 +00:00
|
|
|
|
|
|
|
it("suggests an 'unread' ! if there are unsent messages", () => {
|
2024-01-29 17:52:48 +00:00
|
|
|
const roomNotifState = new RoomNotificationState(room, false);
|
2023-01-31 09:58:17 +00:00
|
|
|
|
|
|
|
const event = mkEvent({
|
|
|
|
event: true,
|
|
|
|
type: "m.message",
|
|
|
|
user: "@user:example.org",
|
|
|
|
content: {},
|
|
|
|
});
|
|
|
|
event.status = EventStatus.NOT_SENT;
|
|
|
|
room.addPendingEvent(event, "txn");
|
|
|
|
|
2024-01-15 15:25:48 +00:00
|
|
|
expect(roomNotifState.level).toBe(NotificationLevel.Unsent);
|
2023-01-31 09:58:17 +00:00
|
|
|
expect(roomNotifState.symbol).toBe("!");
|
|
|
|
expect(roomNotifState.count).toBeGreaterThan(0);
|
|
|
|
});
|
|
|
|
|
|
|
|
it("suggests nothing if the room is muted", () => {
|
2024-01-29 17:52:48 +00:00
|
|
|
const roomNotifState = new RoomNotificationState(room, false);
|
2023-01-31 09:58:17 +00:00
|
|
|
|
|
|
|
muteRoom(room);
|
|
|
|
setUnreads(room, 1234, 0);
|
2024-03-12 14:52:54 +00:00
|
|
|
room.updateMyMembership(KnownMembership.Join); // emit
|
2023-01-31 09:58:17 +00:00
|
|
|
|
2024-01-15 15:25:48 +00:00
|
|
|
expect(roomNotifState.level).toBe(NotificationLevel.None);
|
2023-01-31 09:58:17 +00:00
|
|
|
expect(roomNotifState.symbol).toBe(null);
|
|
|
|
expect(roomNotifState.count).toBe(0);
|
|
|
|
});
|
|
|
|
|
|
|
|
it("suggests a red ! if the user has been invited to a room", () => {
|
2024-01-29 17:52:48 +00:00
|
|
|
const roomNotifState = new RoomNotificationState(room, false);
|
2023-01-31 09:58:17 +00:00
|
|
|
|
2024-03-12 14:52:54 +00:00
|
|
|
room.updateMyMembership(KnownMembership.Invite); // emit
|
2023-01-31 09:58:17 +00:00
|
|
|
|
2024-01-15 15:25:48 +00:00
|
|
|
expect(roomNotifState.level).toBe(NotificationLevel.Highlight);
|
2023-01-31 09:58:17 +00:00
|
|
|
expect(roomNotifState.symbol).toBe("!");
|
|
|
|
expect(roomNotifState.count).toBeGreaterThan(0);
|
|
|
|
});
|
|
|
|
|
|
|
|
it("returns a proper count and color for regular unreads", () => {
|
2024-01-29 17:52:48 +00:00
|
|
|
const roomNotifState = new RoomNotificationState(room, false);
|
2023-01-31 09:58:17 +00:00
|
|
|
|
|
|
|
setUnreads(room, 4321, 0);
|
2024-03-12 14:52:54 +00:00
|
|
|
room.updateMyMembership(KnownMembership.Join); // emit
|
2023-01-31 09:58:17 +00:00
|
|
|
|
2024-01-15 15:25:48 +00:00
|
|
|
expect(roomNotifState.level).toBe(NotificationLevel.Notification);
|
2023-01-31 09:58:17 +00:00
|
|
|
expect(roomNotifState.symbol).toBe(null);
|
|
|
|
expect(roomNotifState.count).toBe(4321);
|
|
|
|
});
|
|
|
|
|
|
|
|
it("returns a proper count and color for highlights", () => {
|
2024-01-29 17:52:48 +00:00
|
|
|
const roomNotifState = new RoomNotificationState(room, false);
|
2023-01-31 09:58:17 +00:00
|
|
|
|
|
|
|
setUnreads(room, 0, 69);
|
2024-03-12 14:52:54 +00:00
|
|
|
room.updateMyMembership(KnownMembership.Join); // emit
|
2023-01-31 09:58:17 +00:00
|
|
|
|
2024-01-15 15:25:48 +00:00
|
|
|
expect(roomNotifState.level).toBe(NotificationLevel.Highlight);
|
2023-01-31 09:58:17 +00:00
|
|
|
expect(roomNotifState.symbol).toBe(null);
|
|
|
|
expect(roomNotifState.count).toBe(69);
|
|
|
|
});
|
|
|
|
|
|
|
|
it("includes threads", async () => {
|
2024-01-29 17:52:48 +00:00
|
|
|
const roomNotifState = new RoomNotificationState(room, true);
|
2023-01-31 09:58:17 +00:00
|
|
|
|
|
|
|
room.timeline.push(
|
|
|
|
new MatrixEvent({
|
|
|
|
room_id: room.roomId,
|
|
|
|
type: EventType.RoomMessage,
|
|
|
|
sender: "userId",
|
|
|
|
content: createMessageEventContent("timeline event"),
|
|
|
|
}),
|
|
|
|
);
|
|
|
|
|
|
|
|
addThread(room);
|
2024-03-12 14:52:54 +00:00
|
|
|
room.updateMyMembership(KnownMembership.Join); // emit
|
2023-01-31 09:58:17 +00:00
|
|
|
|
2024-01-15 15:25:48 +00:00
|
|
|
expect(roomNotifState.level).toBe(NotificationLevel.Activity);
|
2023-01-31 09:58:17 +00:00
|
|
|
expect(roomNotifState.symbol).toBe(null);
|
|
|
|
});
|
2022-02-17 09:18:37 +00:00
|
|
|
});
|