/* Copyright 2024 New Vector Ltd. Copyright 2022 The Matrix.org Foundation C.I.C. SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial Please see LICENSE files in the repository root for full details. */ import React from "react"; import { render, screen, cleanup, fireEvent, waitFor } from "jest-matrix-react"; import { mocked, type Mocked } from "jest-mock"; import { Room, RoomStateEvent, type MatrixEvent, MatrixEventEvent, type MatrixClient, type RoomMember, EventType, RoomEvent, type IRoomTimelineData, type ISendEventResponse, type IContent, } from "matrix-js-sdk/src/matrix"; import { Widget } from "matrix-widget-api"; import { type IRTCNotificationContent } from "matrix-js-sdk/src/matrixrtc"; import { randomUUID } from "node:crypto"; import { useMockedCalls, MockedCall, stubClient, mkRoomMember, setupAsyncStoreWithClient, resetAsyncStoreWithClient, mkEvent, clientAndSDKContextRenderOptions, } from "../../test-utils"; import defaultDispatcher from "../../../src/dispatcher/dispatcher"; import { Action } from "../../../src/dispatcher/actions"; import { MatrixClientPeg } from "../../../src/MatrixClientPeg"; import { CallStore } from "../../../src/stores/CallStore"; import { WidgetMessagingStore } from "../../../src/stores/widgets/WidgetMessagingStore"; import DMRoomMap from "../../../src/utils/DMRoomMap"; import ToastStore from "../../../src/stores/ToastStore"; import { getIncomingCallToastKey, getNotificationEventSendTs, IncomingCallToast, } from "../../../src/toasts/IncomingCallToast"; import { AudioID } from "../../../src/LegacyCallHandler"; import { CallEvent } from "../../../src/models/Call"; import { type WidgetMessaging } from "../../../src/stores/widgets/WidgetMessaging"; import { TestSDKContext } from "../TestSDKContext.ts"; function makeNotificationEvent(room: Room, content: IContent = {}): MatrixEvent { const ts = Date.now(); const notificationContent = { "notification_type": "notification", "m.relation": { rel_type: "m.reference", event_id: "$memberEventId" }, "m.mentions": { user_ids: [], room: true }, "lifetime": 3000, "sender_ts": ts, ...content, } as unknown as IRTCNotificationContent; return mkEvent({ type: EventType.RTCNotification, user: "@userId:matrix.org", content: notificationContent, room: room.roomId, ts, id: "$notificationEventId", event: true, }); } describe("IncomingCallToast", () => { useMockedCalls(); let client: Mocked; let sdkContext: TestSDKContext; let room: Room; let alice: RoomMember; let bob: RoomMember; let call: MockedCall; let widget: Widget; const dmRoomMap = { getUserIdForRoomId: jest.fn(), } as unknown as DMRoomMap; const toastStore = { dismissToast: jest.fn(), } as unknown as Mocked; beforeEach(async () => { stubClient(); client = mocked(MatrixClientPeg.safeGet()); sdkContext = new TestSDKContext(); sdkContext._client = client; const audio = document.createElement("audio"); audio.id = AudioID.Ring; document.body.appendChild(audio); room = new Room("!1:example.org", client, "@alice:example.org"); alice = mkRoomMember(room.roomId, "@alice:example.org"); bob = mkRoomMember(room.roomId, "@bob:example.org"); client.getRoom.mockImplementation((roomId) => (roomId === room.roomId ? room : null)); client.getRooms.mockReturnValue([room]); client.reEmitter.reEmit(room, [RoomStateEvent.Events]); MockedCall.create(room, "1"); await Promise.all( [CallStore.instance, WidgetMessagingStore.instance].map((store) => setupAsyncStoreWithClient(store, client), ), ); const maybeCall = CallStore.instance.getCall(room.roomId); if (!(maybeCall instanceof MockedCall)) throw new Error("Failed to create call"); call = maybeCall; widget = new Widget(call.widget); WidgetMessagingStore.instance.storeMessaging(widget, room.roomId, { stop: () => {}, } as unknown as WidgetMessaging); jest.spyOn(DMRoomMap, "shared").mockReturnValue(dmRoomMap); jest.spyOn(ToastStore, "sharedInstance").mockReturnValue(toastStore); toastStore.dismissToast.mockReset(); }); afterEach(async () => { cleanup(); // Unmount before we do any cleanup that might update the component call.destroy(); WidgetMessagingStore.instance.stopMessaging(widget, room.roomId); await Promise.all([CallStore.instance, WidgetMessagingStore.instance].map(resetAsyncStoreWithClient)); jest.restoreAllMocks(); }); const renderToast = (notificationEvent: MatrixEvent = makeNotificationEvent(room)): string => { const callId = randomUUID(); call.event.getContent = () => ({ call_id: callId, getRoomId: () => room.roomId, }) as any; render( , clientAndSDKContextRenderOptions(client, sdkContext), ); return callId; }; it.each(["video", "voice"])("shows information for a group %s call", (callType: string) => { call.participants = new Map([ [alice, new Set("a")], [bob, new Set(["b1", "b2"])], ]); const notificationEvent = makeNotificationEvent(room, { "m.call.intent": callType === "voice" ? "audio" : "video", }); renderToast(notificationEvent); screen.getByText("Group call started"); screen.getByLabelText(callType === "voice" ? "Voice call" : "Video call"); screen.getByLabelText("@alice:example.org"); screen.getByLabelText("@bob:example.org"); screen.getByText("on the call"); screen.getByRole("button", { name: "Join" }); screen.getByRole("button", { name: "Decline" }); screen.getByRole("button", { name: "Expand" }); }); it.each(["video", "voice"])("shows information for a DM %s call", (callType: string) => { mocked(dmRoomMap.getUserIdForRoomId).mockImplementation((roomId) => roomId === room.roomId ? alice.userId : undefined, ); try { call.participants = new Map([[alice, new Set("a")]]); const notificationEvent = makeNotificationEvent(room, { "m.call.intent": callType === "voice" ? "audio" : "video", }); renderToast(notificationEvent); screen.getByText(callType === "voice" ? "Incoming voice call" : "Incoming video call"); screen.getByLabelText(callType === "voice" ? "Voice call" : "Video call"); screen.getByLabelText("@alice:example.org"); screen.getByRole("button", { name: "Join" }); screen.getByRole("button", { name: "Decline" }); screen.getByRole("button", { name: "Expand" }); } finally { mocked(dmRoomMap.getUserIdForRoomId).mockReset(); } }); it("start ringing on ring notify event", () => { const notificationEvent = makeNotificationEvent(room, { notification_type: "ring" }); const playMock = jest.spyOn(sdkContext.legacyCallHandler, "play"); render( , clientAndSDKContextRenderOptions(client, sdkContext), ); expect(playMock).toHaveBeenCalled(); }); it("correctly renders toast without a call", () => { call.destroy(); renderToast(); screen.getByText("Group call started"); screen.getByLabelText("Video call"); expect(screen.queryByText("on the call")).toBe(null); screen.getByRole("button", { name: "Join" }); screen.getByRole("button", { name: "Decline" }); screen.getByRole("button", { name: "Expand" }); }); it("joins with video and closes the toast", async () => { const callId = renderToast(); const dispatcherSpy = jest.fn(); const dispatcherRef = defaultDispatcher.register(dispatcherSpy); screen.getByRole("switch", { name: "Join with video", checked: true }); fireEvent.click(screen.getByRole("button", { name: "Join" })); await waitFor(() => expect(dispatcherSpy).toHaveBeenCalledWith({ action: Action.ViewRoom, room_id: room.roomId, skipLobby: true, view_call: true, voiceOnly: false, }), ); await waitFor(() => expect(toastStore.dismissToast).toHaveBeenCalledWith(getIncomingCallToastKey(callId, room.roomId)), ); defaultDispatcher.unregister(dispatcherRef); }); it("joins without video and closes the toast", async () => { const callId = renderToast(); const dispatcherSpy = jest.fn(); const dispatcherRef = defaultDispatcher.register(dispatcherSpy); fireEvent.click(screen.getByRole("switch", {})); screen.getByRole("switch", { name: "Join with video", checked: false }); fireEvent.click(screen.getByRole("button", { name: "Join" })); await waitFor(() => expect(dispatcherSpy).toHaveBeenCalledWith({ action: Action.ViewRoom, room_id: room.roomId, skipLobby: true, view_call: true, voiceOnly: true, }), ); await waitFor(() => expect(toastStore.dismissToast).toHaveBeenCalledWith(getIncomingCallToastKey(callId, room.roomId)), ); defaultDispatcher.unregister(dispatcherRef); }); it("Dismiss toast if user starts call and skips lobby when using shift key click", async () => { const callId = renderToast(); const dispatcherSpy = jest.fn(); const dispatcherRef = defaultDispatcher.register(dispatcherSpy); fireEvent.click(screen.getByRole("button", { name: "Join" }), { shiftKey: true }); await waitFor(() => expect(dispatcherSpy).toHaveBeenCalledWith({ action: Action.ViewRoom, room_id: room.roomId, skipLobby: true, view_call: true, voiceOnly: false, }), ); await waitFor(() => expect(toastStore.dismissToast).toHaveBeenCalledWith(getIncomingCallToastKey(callId, room.roomId)), ); defaultDispatcher.unregister(dispatcherRef); }); it("Dismiss toast if user joins with a remote device", async () => { const callId = renderToast(); const dispatcherSpy = jest.fn(); const dispatcherRef = defaultDispatcher.register(dispatcherSpy); call.emit( CallEvent.Participants, new Map([[mkRoomMember(room.roomId, "@userId:matrix.org"), new Set(["a"])]]), new Map(), ); await waitFor(() => expect(toastStore.dismissToast).toHaveBeenCalledWith(getIncomingCallToastKey(callId, room.roomId)), ); defaultDispatcher.unregister(dispatcherRef); }); it("expands to show the call lobby", async () => { const callId = renderToast(); const dispatcherSpy = jest.fn(); const dispatcherRef = defaultDispatcher.register(dispatcherSpy); fireEvent.click(screen.getByRole("button", { name: "Expand" })); await waitFor(() => expect(dispatcherSpy).toHaveBeenCalledWith({ action: Action.ViewRoom, room_id: room.roomId, skipLobby: false, view_call: true, voiceOnly: false, }), ); await waitFor(() => expect(toastStore.dismissToast).toHaveBeenCalledWith(getIncomingCallToastKey(callId, room.roomId)), ); defaultDispatcher.unregister(dispatcherRef); }); it("closes toast when the call lobby is viewed", async () => { const callId = renderToast(); defaultDispatcher.dispatch({ action: Action.ViewRoom, room_id: room.roomId, view_call: true, }); await waitFor(() => expect(toastStore.dismissToast).toHaveBeenCalledWith(getIncomingCallToastKey(callId, room.roomId)), ); }); it("closes toast when the call event is redacted", async () => { const callId = renderToast(); const event = room.currentState.getStateEvents(MockedCall.EVENT_TYPE, "1")!; room.emit(MatrixEventEvent.BeforeRedaction, event, {} as unknown as MatrixEvent); await waitFor(() => expect(toastStore.dismissToast).toHaveBeenCalledWith(getIncomingCallToastKey(callId, room.roomId)), ); }); it("closes toast when the notification event is redacted", async () => { const notificationEvent = makeNotificationEvent(room); const callId = renderToast(notificationEvent); room.emit(MatrixEventEvent.BeforeRedaction, notificationEvent, {} as unknown as MatrixEvent); await waitFor(() => expect(toastStore.dismissToast).toHaveBeenCalledWith(getIncomingCallToastKey(callId, room.roomId)), ); }); it("closes toast when the matrixRTC session has ended", async () => { const callId = renderToast(); call.destroy(); await waitFor(() => expect(toastStore.dismissToast).toHaveBeenCalledWith(getIncomingCallToastKey(callId, room.roomId)), ); }); it("closes toast when a decline event was received", async () => { const notificationEvent = makeNotificationEvent(room); const callId = renderToast(notificationEvent); room.emit( RoomEvent.Timeline, mkEvent({ user: "@userId:matrix.org", type: EventType.RTCDecline, content: { "m.relates_to": { event_id: notificationEvent.getId()!, rel_type: "m.reference" } }, event: true, }), room, undefined, false, {} as unknown as IRoomTimelineData, ); await waitFor(() => expect(toastStore.dismissToast).toHaveBeenCalledWith(getIncomingCallToastKey(callId, room.roomId)), ); }); it("does not close toast when a decline event for another user was received", async () => { const notificationEvent = makeNotificationEvent(room); const callId = renderToast(notificationEvent); room.emit( RoomEvent.Timeline, mkEvent({ user: "@userIdNotMe:matrix.org", type: EventType.RTCDecline, content: { "m.relates_to": { event_id: notificationEvent.getId()!, rel_type: "m.reference" } }, event: true, }), room, undefined, false, {} as unknown as IRoomTimelineData, ); await waitFor(() => expect(toastStore.dismissToast).not.toHaveBeenCalledWith(getIncomingCallToastKey(callId, room.roomId)), ); }); it("does not close toast when a decline event for another notification Event was received", async () => { renderToast(); const callId = renderToast(); room.emit( RoomEvent.Timeline, mkEvent({ user: "@userId:matrix.org", type: EventType.RTCDecline, content: { "m.relates_to": { event_id: "$otherNotificationEventRelation", rel_type: "m.reference" } }, event: true, }), room, undefined, false, {} as unknown as IRoomTimelineData, ); await waitFor(() => expect(toastStore.dismissToast).not.toHaveBeenCalledWith(getIncomingCallToastKey(callId, room.roomId)), ); }); it("sends a decline event when clicking the ignore button and only dismiss after sending", async () => { const callId = renderToast(); const { promise, resolve } = Promise.withResolvers(); client.sendRtcDecline.mockImplementation(() => { return promise; }); fireEvent.click(screen.getByRole("button", { name: "Decline" })); expect(toastStore.dismissToast).not.toHaveBeenCalledWith(getIncomingCallToastKey(callId, room.roomId)); expect(client.sendRtcDecline).toHaveBeenCalledWith("!1:example.org", "$notificationEventId"); resolve({ event_id: "$declineEventId" }); await waitFor(() => expect(toastStore.dismissToast).toHaveBeenCalledWith(getIncomingCallToastKey(callId, room.roomId)), ); }); it("getNotificationEventSendTs returns the correct ts", () => { const notificationEvent = makeNotificationEvent(room); const eventOriginServerTs = mkEvent({ user: "@userId:matrix.org", type: EventType.RTCNotification, content: { "m.relates_to": { event_id: notificationEvent.getId()!, rel_type: "m.reference" }, "sender_ts": 222_000, }, event: true, ts: 1111, }); const eventSendTs = mkEvent({ user: "@userId:matrix.org", type: EventType.RTCNotification, content: { "m.relates_to": { event_id: notificationEvent.getId()!, rel_type: "m.reference" }, "sender_ts": 2222, }, event: true, ts: 1111, }); expect(getNotificationEventSendTs(eventOriginServerTs)).toBe(1111); expect(getNotificationEventSendTs(eventSendTs)).toBe(2222); }); });