Merge branch 'livekit' into valere/fix_blank_widget_auto_leave

src/room/CallEventAudioRenderer.test.tsx

@@ -38,7 +38,7 @@ import {
   local,
   localRtcMember,
 } from "../utils/test-fixtures";
-import { MAX_PARTICIPANT_COUNT_FOR_SOUND } from "../state/CallViewModel";
+import { MAX_PARTICIPANT_COUNT_FOR_SOUND } from "../state/CallViewModel/CallViewModel";
 
 vitest.mock("livekit-client/e2ee-worker?worker");
 vitest.mock("../useAudioContext");

src/room/CallEventAudioRenderer.tsx

@@ -7,7 +7,7 @@ Please see LICENSE in the repository root for full details.
 
 import { type ReactNode, useEffect } from "react";
 
-import { type CallViewModel } from "../state/CallViewModel";
+import { type CallViewModel } from "../state/CallViewModel/CallViewModel";
 import joinCallSoundMp3 from "../sound/join_call.mp3";
 import joinCallSoundOgg from "../sound/join_call.ogg";
 import leftCallSoundMp3 from "../sound/left_call.mp3";

src/room/GroupCallView.test.tsx

@@ -78,13 +78,13 @@ const leaveRTCSession = vi.hoisted(() =>
   ),
 );
 
-vi.mock("../rtcSessionHelpers", async (importOriginal) => {
-  // TODO: perhaps there is a more elegant way to manage the type import here?
-  // eslint-disable-next-line @typescript-eslint/consistent-type-imports
-  const orig = await importOriginal<typeof import("../rtcSessionHelpers")>();
-  // TODO: leaveRTCSession no longer exists! Tests need adapting.
-  return { ...orig, enterRTCSession, leaveRTCSession };
-});
+// vi.mock("../rtcSessionHelpers", async (importOriginal) => {
+//   // TODO: perhaps there is a more elegant way to manage the type import here?
+//   // eslint-disable-next-line @typescript-eslint/consistent-type-imports
+//   const orig = await importOriginal<typeof import("../rtcSessionHelpers")>();
+//   // TODO: leaveRTCSession no longer exists! Tests need adapting.
+//   return { ...orig, enterRTCSession, leaveRTCSession };
+// });
 
 let playSound: MockedFunction<
   NonNullable<ReturnType<typeof useAudioContext>>["playSound"]
@@ -346,6 +346,7 @@ test.skip("GroupCallView leaves the session when an error occurs", async () => {
 
 test.skip("GroupCallView shows errors that occur during joining", async () => {
   const user = userEvent.setup();
+  // This should not mock this error that deep. it should only mock the CallViewModel.
   enterRTCSession.mockRejectedValue(new MatrixRTCTransportMissingError(""));
   onTestFinished(() => {
     enterRTCSession.mockReset();

src/room/InCallView.test.tsx

@@ -43,9 +43,6 @@ import { LivekitRoomAudioRenderer } from "../livekit/MatrixAudioRenderer";
 import { MediaDevicesContext } from "../MediaDevicesContext";
 import { HeaderStyle } from "../UrlParams";
 
-// vi.hoisted(() => {
-//   localStorage = {} as unknown as Storage;
-// });
 vi.hoisted(
   () =>
     (global.ImageData = class MockImageData {
@@ -109,6 +106,7 @@ function createInCallView(): RenderResult & {
     getUserId: () => localRtcMember.userId,
     getDeviceId: () => localRtcMember.deviceId,
     getRoom: (rId) => (rId === roomId ? room : null),
+    getDomain: () => "example.com",
   } as Partial<MatrixClient> as MatrixClient;
   const room = mockMatrixRoom({
     relations: {
@@ -119,7 +117,8 @@ function createInCallView(): RenderResult & {
     } as unknown as RelationsContainer,
     client,
     roomId,
-    getMember: (userId) => roomMembers.get(userId) ?? null,
+    // getMember: (userId) => roomMembers.get(userId) ?? null,
+    getMembers: () => Array.from(roomMembers.values()),
     getMxcAvatarUrl: () => null,
     hasEncryptionStateEvent: vi.fn().mockReturnValue(true),
     getCanonicalAlias: () => null,

src/room/InCallView.tsx

@@ -58,7 +58,11 @@ import { type MuteStates } from "../state/MuteStates";
 import { type MatrixInfo } from "./VideoPreview";
 import { InviteButton } from "../button/InviteButton";
 import { LayoutToggle } from "./LayoutToggle";
-import { CallViewModel, type GridMode } from "../state/CallViewModel";
+import {
+  type CallViewModel,
+  createCallViewModel$,
+  type GridMode,
+} from "../state/CallViewModel/CallViewModel.ts";
 import { Grid, type TileProps } from "../grid/Grid";
 import { useInitial } from "../useInitial";
 import { SpotlightTile } from "../tile/SpotlightTile";
@@ -117,17 +121,17 @@ export interface ActiveCallProps
 }
 
 export const ActiveCall: FC<ActiveCallProps> = (props) => {
-  const mediaDevices = useMediaDevices();
   const [vm, setVm] = useState<CallViewModel | null>(null);
 
-  const { autoLeaveWhenOthersLeft, waitForCallPickup, sendNotificationType } =
-    useUrlParams();
-
+  const urlParams = useUrlParams();
+  const mediaDevices = useMediaDevices();
   const trackProcessorState$ = useTrackProcessorObservable$();
   useEffect(() => {
     const scope = new ObservableScope();
     const reactionsReader = new ReactionsReader(scope, props.rtcSession);
-    const vm = new CallViewModel(
+    const { autoLeaveWhenOthersLeft, waitForCallPickup, sendNotificationType } =
+      urlParams;
+    const vm = createCallViewModel$(
       scope,
       props.rtcSession,
       props.matrixRoom,
@@ -140,7 +144,7 @@ export const ActiveCall: FC<ActiveCallProps> = (props) => {
       },
       reactionsReader.raisedHands$,
       reactionsReader.reactions$,
-      trackProcessorState$,
+      scope.behavior(trackProcessorState$),
     );
     setVm(vm);
 
@@ -151,13 +155,11 @@ export const ActiveCall: FC<ActiveCallProps> = (props) => {
   }, [
     props.rtcSession,
     props.matrixRoom,
-    mediaDevices,
     props.muteStates,
     props.e2eeSystem,
-    autoLeaveWhenOthersLeft,
-    sendNotificationType,
-    waitForCallPickup,
     props.onLeft,
+    urlParams,
+    mediaDevices,
     trackProcessorState$,
   ]);
 
@@ -249,7 +251,6 @@ export const InCallView: FC<InCallViewProps> = ({
     () => void toggleRaisedHand(),
   );
 
-  const allLivekitRooms = useBehavior(vm.allLivekitRooms$);
   const audioParticipants = useBehavior(vm.audioParticipants$);
   const participantCount = useBehavior(vm.participantCount$);
   const reconnecting = useBehavior(vm.reconnecting$);
@@ -264,6 +265,7 @@ export const InCallView: FC<InCallViewProps> = ({
   const audioOutputSwitcher = useBehavior(vm.audioOutputSwitcher$);
   const sharingScreen = useBehavior(vm.sharingScreen$);
 
+  const ringOverlay = useBehavior(vm.ringOverlay$);
   const fatalCallError = useBehavior(vm.configError$);
   // Stop the rendering and throw for the error boundary
   if (fatalCallError) throw fatalCallError;
@@ -300,47 +302,26 @@ export const InCallView: FC<InCallViewProps> = ({
 
   // Waiting UI overlay
   const waitingOverlay: JSX.Element | null = useMemo(() => {
-    // No overlay if not in ringing state
-    if (callPickupState !== "ringing") return null;
-
-    // Use room state for other participants data (the one that we likely want to reach)
-    // TODO: this screams it wants to be a behavior in the vm.
-    const roomOthers = [
-      ...matrixRoom.getMembersWithMembership("join"),
-      ...matrixRoom.getMembersWithMembership("invite"),
-    ].filter((m) => m.userId !== client.getUserId());
-    // Yield if there are not other members in the room.
-    if (roomOthers.length === 0) return null;
-
-    const otherMember = roomOthers.length > 0 ? roomOthers[0] : undefined;
-    const isOneOnOne = roomOthers.length === 1 && otherMember;
-    const text = isOneOnOne
-      ? `Waiting for ${otherMember.name ?? otherMember.userId} to join…`
-      : "Waiting for other participants…";
-    const avatarMxc = isOneOnOne
-      ? (otherMember.getMxcAvatarUrl?.() ?? undefined)
-      : (matrixRoom.getMxcAvatarUrl() ?? undefined);
-
-    return (
+    return ringOverlay ? (
       <div className={classNames(overlayStyles.bg, waitingStyles.overlay)}>
         <div
           className={classNames(overlayStyles.content, waitingStyles.content)}
         >
           <div className={waitingStyles.pulse}>
             <Avatar
-              id={isOneOnOne ? otherMember.userId : matrixRoom.roomId}
-              name={isOneOnOne ? otherMember.name : matrixRoom.name}
-              src={avatarMxc}
+              id={ringOverlay.idForAvatar}
+              name={ringOverlay.name}
+              src={ringOverlay.avatarMxc}
               size={AvatarSize.XL}
             />
           </div>
           <Text size="md" className={waitingStyles.text}>
-            {text}
+            {ringOverlay.text}
           </Text>
         </div>
       </div>
-    );
-  }, [callPickupState, client, matrixRoom]);
+    ) : null;
+  }, [ringOverlay]);
 
   // Ideally we could detect taps by listening for click events and checking
   // that the pointerType of the event is "touch", but this isn't yet supported
@@ -821,7 +802,7 @@ export const InCallView: FC<InCallViewProps> = ({
           key={url}
           url={url}
           livekitRoom={livekitRoom}
-          validIdentities={participants.map((p) => p.identity)}
+          validIdentities={participants}
           muted={muteAllAudio}
         />
       ))}
@@ -843,7 +824,8 @@ export const InCallView: FC<InCallViewProps> = ({
             onDismiss={closeSettings}
             tab={settingsTab}
             onTabChange={setSettingsTab}
-            livekitRooms={allLivekitRooms}
+            // TODO expose correct data to setttings modal
+            livekitRooms={[]}
           />
         </>
       )}

src/room/ReactionAudioRenderer.test.tsx

@@ -10,8 +10,9 @@ import {
   afterAll,
   afterEach,
   beforeEach,
+  describe,
   expect,
-  test,
+  it,
   vitest,
   type MockedFunction,
   type Mock,
@@ -27,7 +28,7 @@ import {
 import { useAudioContext } from "../useAudioContext";
 import { GenericReaction, ReactionSet } from "../reactions";
 import { prefetchSounds } from "../soundUtils";
-import { type CallViewModel } from "../state/CallViewModel";
+import { type CallViewModel } from "../state/CallViewModel/CallViewModel";
 import { getBasicCallViewModelEnvironment } from "../utils/test-viewmodel";
 import {
   alice,
@@ -49,122 +50,125 @@ vitest.mock("livekit-client/e2ee-worker?worker");
 vitest.mock("../useAudioContext");
 vitest.mock("../soundUtils");
 
-afterEach(() => {
-  vitest.resetAllMocks();
-  playReactionsSoundSetting.setValue(playReactionsSoundSetting.defaultValue);
-  soundEffectVolumeSetting.setValue(soundEffectVolumeSetting.defaultValue);
-});
-
-afterAll(() => {
-  vitest.restoreAllMocks();
-});
-
 let playSound: Mock<
   NonNullable<ReturnType<typeof useAudioContext>>["playSound"]
 >;
 
-beforeEach(() => {
-  (prefetchSounds as MockedFunction<typeof prefetchSounds>).mockResolvedValue({
-    sound: new ArrayBuffer(0),
+describe("ReactionAudioRenderer", () => {
+  afterEach(() => {
+    playReactionsSoundSetting.setValue(playReactionsSoundSetting.defaultValue);
+    soundEffectVolumeSetting.setValue(soundEffectVolumeSetting.defaultValue);
   });
-  playSound = vitest.fn();
-  (useAudioContext as MockedFunction<typeof useAudioContext>).mockReturnValue({
-    playSound,
-    playSoundLooping: vitest.fn(),
-    soundDuration: {},
-  });
-});
-
-test("preloads all audio elements", () => {
-  const { vm } = getBasicCallViewModelEnvironment([local, alice]);
-  playReactionsSoundSetting.setValue(true);
-  render(<TestComponent vm={vm} />);
-  expect(prefetchSounds).toHaveBeenCalledOnce();
-});
-
-test("will play an audio sound when there is a reaction", () => {
-  const { vm, reactionsSubject$ } = getBasicCallViewModelEnvironment([
-    local,
-    alice,
-  ]);
-  playReactionsSoundSetting.setValue(true);
-  render(<TestComponent vm={vm} />);
-
-  // Find the first reaction with a sound effect
-  const chosenReaction = ReactionSet.find((r) => !!r.sound);
-  if (!chosenReaction) {
-    throw Error(
-      "No reactions have sounds configured, this test cannot succeed",
+  beforeEach(() => {
+    (prefetchSounds as MockedFunction<typeof prefetchSounds>).mockResolvedValue(
+      {
+        sound: new ArrayBuffer(0),
+      },
     );
-  }
-  act(() => {
-    reactionsSubject$.next({
-      [aliceRtcMember.deviceId]: {
-        reactionOption: chosenReaction,
-        expireAfter: new Date(0),
+    playSound = vitest.fn();
+    (useAudioContext as MockedFunction<typeof useAudioContext>).mockReturnValue(
+      {
+        playSound,
+        playSoundLooping: vitest.fn(),
+        soundDuration: {},
       },
-    });
-  });
-  expect(playSound).toHaveBeenCalledWith(chosenReaction.name);
-});
-
-test("will play the generic audio sound when there is soundless reaction", () => {
-  const { vm, reactionsSubject$ } = getBasicCallViewModelEnvironment([
-    local,
-    alice,
-  ]);
-  playReactionsSoundSetting.setValue(true);
-  render(<TestComponent vm={vm} />);
-
-  // Find the first reaction with a sound effect
-  const chosenReaction = ReactionSet.find((r) => !r.sound);
-  if (!chosenReaction) {
-    throw Error(
-      "No reactions have sounds configured, this test cannot succeed",
     );
-  }
-  act(() => {
-    reactionsSubject$.next({
-      [aliceRtcMember.deviceId]: {
-        reactionOption: chosenReaction,
-        expireAfter: new Date(0),
-      },
-    });
   });
-  expect(playSound).toHaveBeenCalledWith(GenericReaction.name);
-});
-
-test("will play multiple audio sounds when there are multiple different reactions", () => {
-  const { vm, reactionsSubject$ } = getBasicCallViewModelEnvironment([
-    local,
-    alice,
-  ]);
-  playReactionsSoundSetting.setValue(true);
-  render(<TestComponent vm={vm} />);
-
-  // Find the first reaction with a sound effect
-  const [reaction1, reaction2] = ReactionSet.filter((r) => !!r.sound);
-  if (!reaction1 || !reaction2) {
-    throw Error(
-      "No reactions have sounds configured, this test cannot succeed",
-    );
-  }
-  act(() => {
-    reactionsSubject$.next({
-      [aliceRtcMember.deviceId]: {
-        reactionOption: reaction1,
-        expireAfter: new Date(0),
-      },
-      [bobRtcMember.deviceId]: {
-        reactionOption: reaction2,
-        expireAfter: new Date(0),
-      },
-      [localRtcMember.deviceId]: {
-        reactionOption: reaction1,
-        expireAfter: new Date(0),
-      },
-    });
+  afterAll(() => {
+    vitest.restoreAllMocks();
+  });
+
+  it("preloads all audio elements", () => {
+    const { vm } = getBasicCallViewModelEnvironment([local, alice]);
+    playReactionsSoundSetting.setValue(true);
+    render(<TestComponent vm={vm} />);
+    expect(prefetchSounds).toHaveBeenCalledOnce();
+  });
+
+  it("will play an audio sound when there is a reaction", () => {
+    const { vm, reactionsSubject$ } = getBasicCallViewModelEnvironment([
+      local,
+      alice,
+    ]);
+    playReactionsSoundSetting.setValue(true);
+    render(<TestComponent vm={vm} />);
+
+    // Find the first reaction with a sound effect
+    const chosenReaction = ReactionSet.find((r) => !!r.sound);
+    if (!chosenReaction) {
+      throw Error(
+        "No reactions have sounds configured, this test cannot succeed",
+      );
+    }
+    act(() => {
+      reactionsSubject$.next({
+        [aliceRtcMember.deviceId]: {
+          reactionOption: chosenReaction,
+          expireAfter: new Date(0),
+        },
+      });
+    });
+    expect(playSound).toHaveBeenCalledWith(chosenReaction.name);
+  });
+
+  it("will play the generic audio sound when there is soundless reaction", () => {
+    const { vm, reactionsSubject$ } = getBasicCallViewModelEnvironment([
+      local,
+      alice,
+    ]);
+    playReactionsSoundSetting.setValue(true);
+    render(<TestComponent vm={vm} />);
+
+    // Find the first reaction with a sound effect
+    const chosenReaction = ReactionSet.find((r) => !r.sound);
+    if (!chosenReaction) {
+      throw Error(
+        "No reactions have sounds configured, this test cannot succeed",
+      );
+    }
+    act(() => {
+      reactionsSubject$.next({
+        [aliceRtcMember.deviceId]: {
+          reactionOption: chosenReaction,
+          expireAfter: new Date(0),
+        },
+      });
+    });
+    expect(playSound).toHaveBeenCalledWith(GenericReaction.name);
+  });
+
+  it("will play multiple audio sounds when there are multiple different reactions", () => {
+    const { vm, reactionsSubject$ } = getBasicCallViewModelEnvironment([
+      local,
+      alice,
+    ]);
+    playReactionsSoundSetting.setValue(true);
+    render(<TestComponent vm={vm} />);
+
+    // Find the first reaction with a sound effect
+    const [reaction1, reaction2] = ReactionSet.filter((r) => !!r.sound);
+    if (!reaction1 || !reaction2) {
+      throw Error(
+        "No reactions have sounds configured, this test cannot succeed",
+      );
+    }
+    act(() => {
+      reactionsSubject$.next({
+        [aliceRtcMember.deviceId]: {
+          reactionOption: reaction1,
+          expireAfter: new Date(0),
+        },
+        [bobRtcMember.deviceId]: {
+          reactionOption: reaction2,
+          expireAfter: new Date(0),
+        },
+        [localRtcMember.deviceId]: {
+          reactionOption: reaction1,
+          expireAfter: new Date(0),
+        },
+      });
+    });
+    expect(playSound).toHaveBeenCalledWith(reaction1.name);
+    expect(playSound).toHaveBeenCalledWith(reaction2.name);
   });
-  expect(playSound).toHaveBeenCalledWith(reaction1.name);
-  expect(playSound).toHaveBeenCalledWith(reaction2.name);
 });

src/room/ReactionAudioRenderer.tsx

@@ -12,7 +12,7 @@ import { GenericReaction, ReactionSet } from "../reactions";
 import { useAudioContext } from "../useAudioContext";
 import { prefetchSounds } from "../soundUtils";
 import { useLatest } from "../useLatest";
-import { type CallViewModel } from "../state/CallViewModel";
+import { type CallViewModel } from "../state/CallViewModel/CallViewModel";
 
 const soundMap = Object.fromEntries([
   ...ReactionSet.filter((v) => v.sound !== undefined).map((v) => [

src/room/ReactionsOverlay.tsx

@@ -8,7 +8,7 @@ Please see LICENSE in the repository root for full details.
 import { type ReactNode } from "react";
 
 import styles from "./ReactionsOverlay.module.css";
-import { type CallViewModel } from "../state/CallViewModel";
+import { type CallViewModel } from "../state/CallViewModel/CallViewModel";
 import { useBehavior } from "../useBehavior";
 
 export function ReactionsOverlay({ vm }: { vm: CallViewModel }): ReactNode {

src/room/__snapshots__/InCallView.test.tsx.snap

@@ -83,9 +83,6 @@ exports[`InCallView > rendering > renders 1`] = `
         class="nav rightNav"
       />
     </header>
-    <div>
-      mocked: MatrixAudioRenderer
-    </div>
     <div
       class="scrollingGrid grid"
     >