Test for asserted identity

This is out first CallHandler test(!) Switches react-sdk to use
createCall on the client object so we can stub this out in the test.
Add a bunch more stubs to the test client.

There's more stuff in this test that has scope to be used more
widely, like waiting for a certain dispatch and mocking out rooms
with particular sets of users in them: we could consider moving these
out to test utils if we wanted.

src/CallHandler.tsx

@@ -59,7 +59,6 @@ import {MatrixClientPeg} from './MatrixClientPeg';
 import PlatformPeg from './PlatformPeg';
 import Modal from './Modal';
 import { _t } from './languageHandler';
-import { createNewMatrixCall } from 'matrix-js-sdk/src/webrtc/call';
 import dis from './dispatcher/dispatcher';
 import WidgetUtils from './utils/WidgetUtils';
 import WidgetEchoStore from './stores/WidgetEchoStore';
@@ -395,7 +394,7 @@ export default class CallHandler {
         // We don't allow placing more than one call per room, but that doesn't mean there
         // can't be more than one, eg. in a glare situation. This checks that the given call
         // is the call we consider 'the' call for its room.
-        const mappedRoomId = CallHandler.sharedInstance().roomIdForCall(call);
+        const mappedRoomId = this.roomIdForCall(call);
 
         const callForThisRoom = this.getCallForRoom(mappedRoomId);
         return callForThisRoom && call.callId === callForThisRoom.callId;
@@ -539,7 +538,7 @@ export default class CallHandler {
                 // on a call with can cause you to send a room invite to someone.
                 await ensureDMExists(MatrixClientPeg.get(), newNativeAssertedIdentity);
 
-                const newMappedRoomId = CallHandler.sharedInstance().roomIdForCall(call);
+                const newMappedRoomId = this.roomIdForCall(call);
                 console.log(`Old room ID: ${mappedRoomId}, new room ID: ${newMappedRoomId}`);
                 if (newMappedRoomId !== mappedRoomId) {
                     this.removeCallForRoom(mappedRoomId);
@@ -691,7 +690,7 @@ export default class CallHandler {
 
         const timeUntilTurnCresExpire = MatrixClientPeg.get().getTurnServersExpiry() - Date.now();
         console.log("Current turn creds expire in " + timeUntilTurnCresExpire + " ms");
-        const call = createNewMatrixCall(MatrixClientPeg.get(), mappedRoomId);
+        const call = MatrixClientPeg.get().createCall(mappedRoomId);
 
         this.calls.set(roomId, call);
         if (transferee) {

src/utils/DMRoomMap.ts

@@ -55,6 +55,15 @@ export default class DMRoomMap {
         return DMRoomMap.sharedInstance;
     }
 
+    /**
+     * Set the shared instance to the instance supplied
+     * Used by tests
+     * @param inst the new shared instance
+     */
+    public static setShared(inst: DMRoomMap) {
+        DMRoomMap.sharedInstance = inst;
+    }
+
     /**
      * Returns a shared instance of the class
      * that uses the singleton matrix client

test/CallHandler-test.ts

@@ -0,0 +1,214 @@
+/*
+Copyright 2015-2021 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import './skinned-sdk';
+
+import CallHandler, { PlaceCallType } from '../src/CallHandler';
+import { stubClient, mkStubRoom } from './test-utils';
+import { MatrixClientPeg } from '../src/MatrixClientPeg';
+import dis from '../src/dispatcher/dispatcher';
+import { CallEvent, CallState } from 'matrix-js-sdk/src/webrtc/call';
+import DMRoomMap from '../src/utils/DMRoomMap';
+import EventEmitter from 'events';
+import { Action } from '../src/dispatcher/actions';
+import SdkConfig from '../src/SdkConfig';
+
+const REAL_ROOM_ID = '$room1:example.org';
+const MAPPED_ROOM_ID = '$room2:example.org';
+const MAPPED_ROOM_ID_2 = '$room3:example.org';
+
+function mkStubDM(roomId, userId) {
+    const room = mkStubRoom(roomId);
+    room.getJoinedMembers = jest.fn().mockReturnValue([
+        {
+            userId: '@me:example.org',
+            name: 'Member',
+            rawDisplayName: 'Member',
+            roomId: roomId,
+            membership: 'join',
+            getAvatarUrl: () => 'mxc://avatar.url/image.png',
+            getMxcAvatarUrl: () => 'mxc://avatar.url/image.png',
+        },
+        {
+            userId: userId,
+            name: 'Member',
+            rawDisplayName: 'Member',
+            roomId: roomId,
+            membership: 'join',
+            getAvatarUrl: () => 'mxc://avatar.url/image.png',
+            getMxcAvatarUrl: () => 'mxc://avatar.url/image.png',
+        },
+    ]);
+    room.currentState.getMembers = room.getJoinedMembers;
+
+    return room;
+}
+
+class FakeCall extends EventEmitter {
+    roomId: string;
+    callId = "fake call id";
+
+    constructor(roomId) {
+        super();
+
+        this.roomId = roomId;
+    }
+
+    setRemoteOnHold() {}
+    setRemoteAudioElement() {}
+
+    placeVoiceCall() {
+        this.emit(CallEvent.State, CallState.Connected, null);
+    }
+}
+
+describe('CallHandler', () => {
+    let dmRoomMap;
+    let callHandler;
+    let audioElement;
+    let fakeCall;
+
+    beforeEach(() => {
+        stubClient();
+        MatrixClientPeg.get().createCall = roomId => {
+            if (fakeCall && fakeCall.roomId !== roomId) {
+                throw new Error("Only one call is supported!");
+            }
+            fakeCall = new FakeCall(roomId);
+            return fakeCall;
+        };
+
+        callHandler = new CallHandler();
+        callHandler.start();
+
+        dmRoomMap = {
+            getUserIdForRoomId: roomId => {
+                if (roomId === REAL_ROOM_ID) {
+                    return '@user1:example.org';
+                } else if (roomId === MAPPED_ROOM_ID) {
+                    return '@user2:example.org';
+                } else if (roomId === MAPPED_ROOM_ID_2) {
+                    return '@user3:example.org';
+                } else {
+                    return null;
+                }
+            },
+            getDMRoomsForUserId: userId => {
+                if (userId === '@user2:example.org') {
+                    return [MAPPED_ROOM_ID];
+                } else if (userId === '@user3:example.org') {
+                    return [MAPPED_ROOM_ID_2];
+                } else {
+                    return [];
+                }
+            },
+        };
+        DMRoomMap.setShared(dmRoomMap);
+
+        audioElement = document.createElement('audio');
+        audioElement.id = "remoteAudio";
+        document.body.appendChild(audioElement);
+    });
+
+    afterEach(() => {
+        callHandler.stop();
+        DMRoomMap.setShared(null);
+        // @ts-ignore
+        window.mxCallHandler = null;
+        MatrixClientPeg.unset();
+
+        document.body.removeChild(audioElement);
+        SdkConfig.unset();
+    });
+
+    it('should move calls between rooms when remote asserted identity changes', async () => {
+        const realRoom = mkStubDM(REAL_ROOM_ID, '@user1:example.org');
+        const mappedRoom = mkStubDM(MAPPED_ROOM_ID, '@user2:example.org');
+        const mappedRoom2 = mkStubDM(MAPPED_ROOM_ID_2, '@user3:example.org');
+
+        MatrixClientPeg.get().getRoom = roomId => {
+            switch (roomId) {
+                case REAL_ROOM_ID:
+                    return realRoom;
+                case MAPPED_ROOM_ID:
+                    return mappedRoom;
+                case MAPPED_ROOM_ID_2:
+                    return mappedRoom2;
+            }
+        };
+
+        dis.dispatch({
+            action: 'place_call',
+            type: PlaceCallType.Voice,
+            room_id: REAL_ROOM_ID,
+        }, true);
+
+        let dispatchHandle;
+        // wait for the call to be set up
+        await new Promise<void>(resolve => {
+            dispatchHandle = dis.register(payload => {
+                if (payload.action === 'call_state') {
+                    resolve();
+                }
+            });
+        });
+        dis.unregister(dispatchHandle);
+
+        // should start off in the actual room ID it's in at the protocol level
+        expect(callHandler.getCallForRoom(REAL_ROOM_ID)).toBe(fakeCall);
+
+        let callRoomChangeEventCount = 0;
+        const roomChangePromise = new Promise<void>(resolve => {
+            dispatchHandle = dis.register(payload => {
+                if (payload.action === Action.CallChangeRoom) {
+                    ++callRoomChangeEventCount;
+                    resolve();
+                }
+            });
+        });
+
+        // Now emit an asserted identity for user2: this should be ignored
+        // because we haven't set the config option to obey asserted identity
+        fakeCall.getRemoteAssertedIdentity = jest.fn().mockReturnValue({
+            id: "@user2:example.org",
+        });
+        fakeCall.emit(CallEvent.AssertedIdentityChanged);
+
+        // Now set the config option
+        SdkConfig.put({
+            voipObeyAssertedIdentity: true,
+        });
+
+        // ...and send another asserted identity event for a different user
+        fakeCall.getRemoteAssertedIdentity = jest.fn().mockReturnValue({
+            id: "@user3:example.org",
+        });
+        fakeCall.emit(CallEvent.AssertedIdentityChanged);
+
+        await roomChangePromise;
+        dis.unregister(dispatchHandle);
+
+        // If everything's gone well, we should have seen only one room change
+        // event and the call should now be in user 3's room.
+        // If it's not obeying any, the call will still be in REAL_ROOM_ID.
+        // If it incorrectly obeyed both asserted identity changes, either it will
+        // have just processed one and the call will be in the wrong room, or we'll
+        // have seen two room change dispatches.
+        expect(callRoomChangeEventCount).toEqual(1);
+        expect(callHandler.getCallForRoom(REAL_ROOM_ID)).toBeNull();
+        expect(callHandler.getCallForRoom(MAPPED_ROOM_ID_2)).toBe(fakeCall);
+    });
+});

test/test-utils.js

@@ -64,6 +64,11 @@ export function createTestClient() {
         getRoomIdForAlias: jest.fn().mockResolvedValue(undefined),
         getRoomDirectoryVisibility: jest.fn().mockResolvedValue(undefined),
         getProfileInfo: jest.fn().mockResolvedValue({}),
+        getThirdpartyProtocols: jest.fn().mockResolvedValue({}),
+        getClientWellKnown: jest.fn().mockReturnValue(null),
+        supportsVoip: jest.fn().mockReturnValue(true),
+        getTurnServersExpiry: jest.fn().mockReturnValue(2^32),
+        getThirdpartyUser: jest.fn().mockResolvedValue([]),
         getAccountData: (type) => {
             return mkEvent({
                 type,