element-web/test/voice-broadcast/utils/setUpVoiceBroadcastPreRecording-test.ts

/*
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
Please see LICENSE files in the repository root for full details.
*/

import { mocked } from "jest-mock";
import { MatrixClient, MatrixEvent, Room, SyncState } from "matrix-js-sdk/src/matrix";

import Modal from "../../../src/Modal";
import {
    VoiceBroadcastInfoState,
    VoiceBroadcastPlayback,
    VoiceBroadcastPlaybacksStore,
    VoiceBroadcastPreRecording,
    VoiceBroadcastPreRecordingStore,
    VoiceBroadcastRecordingsStore,
} from "../../../src/voice-broadcast";
import { setUpVoiceBroadcastPreRecording } from "../../../src/voice-broadcast/utils/setUpVoiceBroadcastPreRecording";
import { mkRoomMemberJoinEvent, stubClient } from "../../test-utils";
import { mkVoiceBroadcastInfoStateEvent } from "./test-utils";

jest.mock("../../../src/Modal");

describe("setUpVoiceBroadcastPreRecording", () => {
    const roomId = "!room:example.com";
    let client: MatrixClient;
    let userId: string;
    let room: Room;
    let preRecordingStore: VoiceBroadcastPreRecordingStore;
    let infoEvent: MatrixEvent;
    let playback: VoiceBroadcastPlayback;
    let playbacksStore: VoiceBroadcastPlaybacksStore;
    let recordingsStore: VoiceBroadcastRecordingsStore;
    let preRecording: VoiceBroadcastPreRecording | null;

    const itShouldNotCreateAPreRecording = () => {
        it("should return null", () => {
            expect(preRecording).toBeNull();
        });

        it("should not create a broadcast pre recording", () => {
            expect(preRecordingStore.getCurrent()).toBeNull();
        });
    };

    const setUpPreRecording = async () => {
        preRecording = await setUpVoiceBroadcastPreRecording(
            room,
            client,
            playbacksStore,
            recordingsStore,
            preRecordingStore,
        );
    };

    beforeEach(() => {
        client = stubClient();
        userId = client.getSafeUserId();
        room = new Room(roomId, client, userId);
        infoEvent = mkVoiceBroadcastInfoStateEvent(
            roomId,
            VoiceBroadcastInfoState.Started,
            client.getUserId()!,
            client.getDeviceId()!,
        );
        preRecording = null;
        preRecordingStore = new VoiceBroadcastPreRecordingStore();
        recordingsStore = new VoiceBroadcastRecordingsStore();
        playback = new VoiceBroadcastPlayback(infoEvent, client, recordingsStore);
        jest.spyOn(playback, "pause");
        playbacksStore = new VoiceBroadcastPlaybacksStore(recordingsStore);
    });

    describe("when trying to start a broadcast if there is no connection", () => {
        beforeEach(async () => {
            mocked(client.getSyncState).mockReturnValue(SyncState.Error);
            await setUpPreRecording();
        });

        it("should show an info dialog and not set up a pre-recording", () => {
            expect(preRecordingStore.getCurrent()).toBeNull();
            expect(Modal.createDialog).toMatchSnapshot();
        });
    });

    describe("when setting up a pre-recording", () => {
        describe("and there is no user id", () => {
            beforeEach(async () => {
                mocked(client.getUserId).mockReturnValue(null);
                await setUpPreRecording();
            });

            itShouldNotCreateAPreRecording();
        });

        describe("and there is no room member", () => {
            beforeEach(async () => {
                // check test precondition
                expect(room.getMember(userId)).toBeNull();
                await setUpPreRecording();
            });

            itShouldNotCreateAPreRecording();
        });

        describe("and there is a room member and listening to another broadcast", () => {
            beforeEach(async () => {
                playbacksStore.setCurrent(playback);
                room.currentState.setStateEvents([mkRoomMemberJoinEvent(userId, roomId)]);
                await setUpPreRecording();
            });

            it("should pause the current playback and create a voice broadcast pre-recording", () => {
                expect(playback.pause).toHaveBeenCalled();
                expect(playbacksStore.getCurrent()).toBeNull();
                expect(preRecording).toBeInstanceOf(VoiceBroadcastPreRecording);
            });
        });
    });
});