From b97b862fb66bafee542e3c0baac35d6576b3a75d Mon Sep 17 00:00:00 2001
From: David Baker <dbkr@users.noreply.github.com>
Date: Fri, 10 Jun 2022 12:01:40 +0100
Subject: [PATCH] Emit unknown device errors for group call participants
 without e2e (#2447)

* Emit unknown device errors for group call participants without e2e

There are a number of different cases here: there were some before
when dealing with versions that didn't send deviceId. This catches
all of them and makes all these cases emit the same error.

* Add type
---
 src/webrtc/call.ts             |  3 ++-
 src/webrtc/callEventHandler.ts | 18 +++++++++++-------
 src/webrtc/groupCall.ts        | 31 +++++++++++++++++++------------
 3 files changed, 32 insertions(+), 20 deletions(-)

diff --git a/src/webrtc/call.ts b/src/webrtc/call.ts
index 8c736b252bc..bcc1de17fd3 100644
--- a/src/webrtc/call.ts
+++ b/src/webrtc/call.ts
@@ -48,6 +48,7 @@ import { MatrixClient } from "../client";
 import { ISendEventResponse } from "../@types/requests";
 import { EventEmitterEvents, TypedEventEmitter } from "../models/typed-event-emitter";
 import { DeviceInfo } from '../crypto/deviceinfo';
+import { GroupCallUnknownDeviceError } from './groupCall';
 
 // events: hangup, error(err), replaced(call), state(state, oldState)
 
@@ -521,7 +522,7 @@ export class MatrixCall extends TypedEventEmitter<CallEvent, CallEventHandlerMap
         const deviceInfoMap = await this.client.crypto.deviceList.downloadKeys([userId], false);
         this.opponentDeviceInfo = deviceInfoMap[userId][this.opponentDeviceId];
         if (this.opponentDeviceInfo === undefined) {
-            throw new Error(`No keys found for opponent device ${this.opponentDeviceId}!`);
+            throw new GroupCallUnknownDeviceError(userId);
         }
     }
 
diff --git a/src/webrtc/callEventHandler.ts b/src/webrtc/callEventHandler.ts
index c0de09f1ece..33235d48ef2 100644
--- a/src/webrtc/callEventHandler.ts
+++ b/src/webrtc/callEventHandler.ts
@@ -20,7 +20,7 @@ import { CallDirection, CallErrorCode, CallState, createNewMatrixCall, MatrixCal
 import { EventType } from '../@types/event';
 import { ClientEvent, MatrixClient } from '../client';
 import { MCallAnswer, MCallHangupReject } from "./callEventTypes";
-import { GroupCallError, GroupCallErrorCode, GroupCallEvent } from './groupCall';
+import { GroupCall, GroupCallErrorCode, GroupCallEvent, GroupCallUnknownDeviceError } from './groupCall';
 import { RoomEvent } from "../models/room";
 
 // Don't ring unless we'd be ringing for at least 3 seconds: the user needs some
@@ -210,8 +210,9 @@ export class CallEventHandler {
 
         let opponentDeviceId: string | undefined;
 
+        let groupCall: GroupCall;
         if (groupCallId) {
-            const groupCall = this.client.groupCallEventHandler.getGroupCallById(groupCallId);
+            groupCall = this.client.groupCallEventHandler.getGroupCallById(groupCallId);
 
             if (!groupCall) {
                 logger.warn(`Cannot find a group call ${groupCallId} for event ${type}. Ignoring event.`);
@@ -224,10 +225,7 @@ export class CallEventHandler {
                 logger.warn(`Cannot find a device id for ${senderId}. Ignoring event.`);
                 groupCall.emit(
                     GroupCallEvent.Error,
-                    new GroupCallError(
-                        GroupCallErrorCode.UnknownDevice,
-                        `Incoming Call: No opponent device found for ${senderId}, ignoring.`,
-                    ),
+                    new GroupCallUnknownDeviceError(senderId),
                 );
                 return;
             }
@@ -282,7 +280,13 @@ export class CallEventHandler {
             }
 
             call.callId = content.call_id;
-            await call.initWithInvite(event);
+            try {
+                await call.initWithInvite(event);
+            } catch (e) {
+                if (e.code === GroupCallErrorCode.UnknownDevice) {
+                    groupCall?.emit(GroupCallEvent.Error, e);
+                }
+            }
             this.calls.set(call.callId, call);
 
             // if we stashed candidate events for that call ID, play them back now
diff --git a/src/webrtc/groupCall.ts b/src/webrtc/groupCall.ts
index 5d6d0ad857c..3a8f12eca76 100644
--- a/src/webrtc/groupCall.ts
+++ b/src/webrtc/groupCall.ts
@@ -39,7 +39,7 @@ export enum GroupCallEvent {
     LocalScreenshareStateChanged = "local_screenshare_state_changed",
     LocalMuteStateChanged = "local_mute_state_changed",
     ParticipantsChanged = "participants_changed",
-    Error = "error"
+    Error = "error",
 }
 
 export type GroupCallEventHandlerMap = {
@@ -77,6 +77,12 @@ export class GroupCallError extends Error {
     }
 }
 
+export class GroupCallUnknownDeviceError extends GroupCallError {
+    constructor(public userId: string) {
+        super(GroupCallErrorCode.UnknownDevice, "No device found for " + userId);
+    }
+}
+
 export class OtherUserSpeakingError extends Error {
     constructor() {
         super("Cannot unmute: another user is speaking");
@@ -750,10 +756,7 @@ export class GroupCall extends TypedEventEmitter<GroupCallEvent, GroupCallEventH
             logger.warn(`No opponent device found for ${member.userId}, ignoring.`);
             this.emit(
                 GroupCallEvent.Error,
-                new GroupCallError(
-                    GroupCallErrorCode.UnknownDevice,
-                    `Outgoing Call: No opponent device found for ${member.userId}, ignoring.`,
-                ),
+                new GroupCallUnknownDeviceError(member.userId),
             );
             return;
         }
@@ -791,13 +794,17 @@ export class GroupCall extends TypedEventEmitter<GroupCallEvent, GroupCallEventH
             );
         } catch (e) {
             logger.warn(`Failed to place call to ${member.userId}!`, e);
-            this.emit(
-                GroupCallEvent.Error,
-                new GroupCallError(
-                    GroupCallErrorCode.PlaceCallFailed,
-                    `Failed to place call to ${member.userId}.`,
-                ),
-            );
+            if (e.code === GroupCallErrorCode.UnknownDevice) {
+                this.emit(GroupCallEvent.Error, e);
+            } else {
+                this.emit(
+                    GroupCallEvent.Error,
+                    new GroupCallError(
+                        GroupCallErrorCode.PlaceCallFailed,
+                        `Failed to place call to ${member.userId}.`,
+                    ),
+                );
+            }
             return;
         }