Avoid creating multiple call objects for the same widget (#30839)

* Extract some setup code out of the call tests

* Don't force all rooms to be rechecked for calls when starting a call

* Remove misleading unused group call callbacks

The GroupCallEventHandler hasn't been relevant to our Element Call group calls for some time; instead we look at the state of the MatrixRTCSessionManager and WidgetStore to determine whether a call has been started.

* Avoid creating multiple call objects for the same widget

* fix test

---------

Co-authored-by: Will Hunt <will@half-shot.uk>

test/test-utils/call.ts

@@ -7,11 +7,29 @@ Please see LICENSE files in the repository root for full details.
 */
 
 import { MatrixWidgetType } from "matrix-widget-api";
+import {
+    type GroupCall,
+    Room,
+    type RoomMember,
+    type MatrixEvent,
+    type MatrixClient,
+    PendingEventOrdering,
+    KnownMembership,
+    RoomStateEvent,
+    type IContent,
+} from "matrix-js-sdk/src/matrix";
+import { mocked, type Mocked } from "jest-mock";
+import { type MatrixRTCSession } from "matrix-js-sdk/src/matrixrtc";
 
-import type { GroupCall, Room, RoomMember, MatrixEvent } from "matrix-js-sdk/src/matrix";
-import { mkEvent } from "./test-utils";
+import { mkEvent, mkRoomMember, setupAsyncStoreWithClient, stubClient } from "./test-utils";
 import { Call, type ConnectionState, ElementCall, JitsiCall } from "../../src/models/Call";
 import { CallStore } from "../../src/stores/CallStore";
+import { MatrixClientPeg } from "../../src/MatrixClientPeg";
+import DMRoomMap from "../../src/utils/DMRoomMap";
+import { MockEventEmitter } from "./client";
+import WidgetStore from "../../src/stores/WidgetStore";
+import { WidgetMessagingStore } from "../../src/stores/widgets/WidgetMessagingStore";
+import SettingsStore from "../../src/settings/SettingsStore";
 
 export class MockedCall extends Call {
     public static readonly EVENT_TYPE = "org.example.mocked_call";
@@ -105,8 +123,92 @@ export class MockedCall extends Call {
 /**
  * Sets up the call store to use mocked calls.
  */
-export const useMockedCalls = () => {
+export function useMockedCalls() {
     Call.get = (room) => MockedCall.get(room);
     JitsiCall.create = async (room) => MockedCall.create(room, "1");
     ElementCall.create = (room) => MockedCall.create(room, "1");
-};
+}
+
+/**
+ * Enables the feature flags required for call tests.
+ */
+export function enableCalls(): { enabledSettings: Set<string> } {
+    const enabledSettings = new Set(["feature_group_calls", "feature_video_rooms", "feature_element_call_video_rooms"]);
+    jest.spyOn(SettingsStore, "getValue").mockImplementation((settingName): any => {
+        if (settingName.startsWith("feature_")) return enabledSettings.has(settingName);
+        if (settingName === "activeCallRoomIds") return [];
+        return undefined;
+    });
+    return { enabledSettings };
+}
+
+export function setUpClientRoomAndStores(): {
+    client: Mocked<MatrixClient>;
+    room: Room;
+    alice: RoomMember;
+    bob: RoomMember;
+    carol: RoomMember;
+    roomSession: Mocked<MatrixRTCSession>;
+} {
+    stubClient();
+    const client = mocked<MatrixClient>(MatrixClientPeg.safeGet());
+    DMRoomMap.makeShared(client);
+
+    const room = new Room("!1:example.org", client, "@alice:example.org", {
+        pendingEventOrdering: PendingEventOrdering.Detached,
+    });
+
+    const alice = mkRoomMember(room.roomId, "@alice:example.org");
+    const bob = mkRoomMember(room.roomId, "@bob:example.org");
+    const carol = mkRoomMember(room.roomId, "@carol:example.org");
+    jest.spyOn(room, "getMember").mockImplementation((userId) => {
+        switch (userId) {
+            case alice.userId:
+                return alice;
+            case bob.userId:
+                return bob;
+            case carol.userId:
+                return carol;
+            default:
+                return null;
+        }
+    });
+
+    jest.spyOn(room, "getMyMembership").mockReturnValue(KnownMembership.Join);
+
+    client.getRoom.mockImplementation((roomId) => (roomId === room.roomId ? room : null));
+
+    const roomSession = new MockEventEmitter({
+        memberships: [],
+        getOldestMembership: jest.fn().mockReturnValue(undefined),
+        room,
+    }) as Mocked<MatrixRTCSession>;
+
+    client.matrixRTC.getRoomSession.mockReturnValue(roomSession);
+    client.getRooms.mockReturnValue([room]);
+    client.getUserId.mockReturnValue(alice.userId);
+    client.getDeviceId.mockReturnValue("alices_device");
+    client.reEmitter.reEmit(room, [RoomStateEvent.Events]);
+    client.sendStateEvent.mockImplementation(async (roomId, eventType, content, stateKey = "") => {
+        if (roomId !== room.roomId) throw new Error("Unknown room");
+        const event = mkEvent({
+            event: true,
+            type: eventType,
+            room: roomId,
+            user: alice.userId,
+            skey: stateKey,
+            content: content as IContent,
+        });
+        room.addLiveEvents([event], { addToState: true });
+        return { event_id: event.getId()! };
+    });
+
+    setupAsyncStoreWithClient(WidgetStore.instance, client);
+    setupAsyncStoreWithClient(WidgetMessagingStore.instance, client);
+
+    return { client, room, alice, bob, carol, roomSession };
+}
+
+export function cleanUpClientRoomAndStores(client: MatrixClient, room: Room) {
+    client.reEmitter.stopReEmitting(room, [RoomStateEvent.Events]);
+}