/* Copyright 2023, 2024 New Vector Ltd. SPDX-License-Identifier: AGPL-3.0-only Please see LICENSE in the repository root for full details. */ import { map, Observable, of } from "rxjs"; import { RunHelpers, TestScheduler } from "rxjs/testing"; import { expect, vi } from "vitest"; import { RoomMember, Room as MatrixRoom } from "matrix-js-sdk/src/matrix"; import { LocalParticipant, LocalTrackPublication, RemoteParticipant, RemoteTrackPublication, Room as LivekitRoom, } from "livekit-client"; import { LocalUserMediaViewModel, RemoteUserMediaViewModel, } from "../state/MediaViewModel"; import { E2eeType } from "../e2ee/e2eeType"; export function withFakeTimers(continuation: () => void): void { vi.useFakeTimers(); try { continuation(); } finally { vi.useRealTimers(); } } export interface OurRunHelpers extends RunHelpers { /** * Schedules a sequence of actions to happen, as described by a marble * diagram. */ schedule: (marbles: string, actions: Record void>) => void; } /** * Run Observables with a scheduler that virtualizes time, for testing purposes. */ export function withTestScheduler( continuation: (helpers: OurRunHelpers) => void, ): void { new TestScheduler((actual, expected) => { expect(actual).deep.equals(expected); }).run((helpers) => continuation({ ...helpers, schedule(marbles, actions) { const actionsObservable = helpers .cold(marbles) .pipe(map((value) => actions[value]())); const results = Object.fromEntries( Object.keys(actions).map((value) => [value, undefined] as const), ); // Run the actions and verify that none of them error helpers.expectObservable(actionsObservable).toBe(marbles, results); }, }), ); } interface EmitterMock { on: () => T; off: () => T; addListener: () => T; removeListener: () => T; } function mockEmitter(): EmitterMock { return { on(): T { return this as T; }, off(): T { return this as T; }, addListener(): T { return this as T; }, removeListener(): T { return this as T; }, }; } // Maybe it'd be good to move this to matrix-js-sdk? Our testing needs are // rather simple, but if one util to mock a member is good enough for us, maybe // it's useful for matrix-js-sdk consumers in general. export function mockMember(member: Partial): RoomMember { return { ...mockEmitter(), ...member } as RoomMember; } export function mockMatrixRoom(room: Partial): MatrixRoom { return { ...mockEmitter(), ...room } as Partial as MatrixRoom; } export function mockLivekitRoom( room: Partial, { remoteParticipants, }: { remoteParticipants?: Observable } = {}, ): LivekitRoom { const livekitRoom = { ...mockEmitter(), ...room, } as Partial as LivekitRoom; if (remoteParticipants) { livekitRoom.remoteParticipants = new Map(); remoteParticipants.subscribe((newRemoteParticipants) => { livekitRoom.remoteParticipants.clear(); newRemoteParticipants.forEach((p) => { livekitRoom.remoteParticipants.set(p.identity, p); }); }); } return livekitRoom; } export function mockLocalParticipant( participant: Partial, ): LocalParticipant { return { isLocal: true, getTrackPublication: () => ({}) as Partial as LocalTrackPublication, ...mockEmitter(), ...participant, } as Partial as LocalParticipant; } export async function withLocalMedia( member: Partial, continuation: (vm: LocalUserMediaViewModel) => void | Promise, ): Promise { const localParticipant = mockLocalParticipant({}); const vm = new LocalUserMediaViewModel( "local", mockMember(member), localParticipant, { kind: E2eeType.PER_PARTICIPANT, }, mockLivekitRoom({ localParticipant }), ); try { await continuation(vm); } finally { vm.destroy(); } } export function mockRemoteParticipant( participant: Partial, ): RemoteParticipant { return { isLocal: false, setVolume() {}, getTrackPublication: () => ({}) as Partial as RemoteTrackPublication, ...mockEmitter(), ...participant, } as RemoteParticipant; } export async function withRemoteMedia( member: Partial, participant: Partial, continuation: (vm: RemoteUserMediaViewModel) => void | Promise, ): Promise { const remoteParticipant = mockRemoteParticipant(participant); const vm = new RemoteUserMediaViewModel( "remote", mockMember(member), remoteParticipant, { kind: E2eeType.PER_PARTICIPANT, }, mockLivekitRoom({}, { remoteParticipants: of([remoteParticipant]) }), ); try { await continuation(vm); } finally { vm.destroy(); } }