add error boundary to GroupCall

src/matrix/calls/group/GroupCall.ts

@@ -21,6 +21,7 @@ import {MuteSettings, CALL_LOG_TYPE, CALL_MEMBER_VALIDITY_PERIOD_MS, mute} from
 import {MemberChange, RoomMember} from "../../room/members/RoomMember";
 import {EventEmitter} from "../../../utils/EventEmitter";
 import {EventType, CallIntent} from "../callEventTypes";
+import { ErrorBoundary } from "../../../utils/ErrorBoundary";
 
 import type {Options as MemberOptions} from "./Member";
 import type {TurnServerSource} from "../TurnServerSource";
@@ -92,6 +93,9 @@ export class GroupCall extends EventEmitter<{change: never}> {
     private bufferedDeviceMessages = new Map<string, Set<SignallingMessage<MGroupCallBase>>>();
     /** Set between calling join and leave. */
     private joinedData?: JoinedData;
+    private errorBoundary = new ErrorBoundary(err => {
+        this.emitChange();
+    });
 
     constructor(
         public readonly id: string,
@@ -154,6 +158,10 @@ export class GroupCall extends EventEmitter<{change: never}> {
         return this.joinedData?.logItem;
     }
 
+    get error(): Error | undefined {
+        return this.errorBoundary.error;
+    }
+
     async join(localMedia: LocalMedia): Promise<void> {
         if (this._state !== GroupCallState.Created || this.joinedData) {
             return;
@@ -206,6 +214,9 @@ export class GroupCall extends EventEmitter<{change: never}> {
             // and update the track info so PeerCall can use it to send up to date metadata,
             this.joinedData.localMuteSettings.updateTrackInfo(localMedia.userMedia);
             this.emitChange(); //allow listeners to see new media/mute settings
+            // TODO: if setMedia fails on one of the members, we should revert to the old media
+            // on the members processed so far, and show an error that we could not set the new media
+            // for this, we will need to remove the usage of the errorBoundary in member.setMedia.
             await Promise.all(Array.from(this._members.values()).map(m => {
                 return m.setMedia(localMedia, oldMedia);
             }));
@@ -234,6 +245,9 @@ export class GroupCall extends EventEmitter<{change: never}> {
             if (this.localMedia) {
                 mute(this.localMedia, muteSettings, this.joinedData!.logItem);
             }
+            // TODO: if setMuted fails on one of the members, we should revert to the old media
+            // on the members processed so far, and show an error that we could not set the new media
+            // for this, we will need to remove the usage of the errorBoundary in member.setMuted.
             await Promise.all(Array.from(this._members.values()).map(m => {
                 return m.setMuted(joinedData.localMuteSettings);
             }));
@@ -271,7 +285,14 @@ export class GroupCall extends EventEmitter<{change: never}> {
                     log.set("already_left", true);
                 }
             } finally {
-                this.disconnect(log);
+                // disconnect is called both from the sync loop and from methods like this one that
+                // are called from the view model. We want errors during the sync loop being caught
+                // by the errorboundary, but since leave is called from the view model, we want
+                // the error to be thrown. So here we check if disconnect succeeded, and if not
+                // we rethrow the error put into the errorBoundary.
+                if(!this.disconnect(log)) {
+                    throw this.errorBoundary.error;
+                }
             }
         });
     }
@@ -308,6 +329,7 @@ export class GroupCall extends EventEmitter<{change: never}> {
 
     /** @internal */
     updateCallEvent(callContent: Record<string, any>, syncLog: ILogItem) {
+        this.errorBoundary.try(() => {
             syncLog.wrap({l: "update call", t: CALL_LOG_TYPE, id: this.id}, log => {
                 this.callContent = callContent;
                 if (this._state === GroupCallState.Creating) {
@@ -316,10 +338,12 @@ export class GroupCall extends EventEmitter<{change: never}> {
                 log.set("status", this._state);
                 this.emitChange();
             });
+        });
     }
 
     /** @internal */
     updateRoomMembers(memberChanges: Map<string, MemberChange>) {
+        this.errorBoundary.try(() => {
             for (const change of memberChanges.values()) {
                 const {member} = change;
                 for (const callMember of this._members.values()) {
@@ -329,10 +353,12 @@ export class GroupCall extends EventEmitter<{change: never}> {
                     }
                 }
             }
+        });
     }
 
     /** @internal */
     updateMembership(userId: string, roomMember: RoomMember, callMembership: CallMembership, syncLog: ILogItem) {
+        this.errorBoundary.try(() => {
             syncLog.wrap({l: "update call membership", t: CALL_LOG_TYPE, id: this.id, userId}, log => {
                 const now = this.options.clock.now();
                 const devices = callMembership["m.devices"];
@@ -411,10 +437,12 @@ export class GroupCall extends EventEmitter<{change: never}> {
                     this.removeOwnDevice(log);
                 }
             });
+        });
     }
 
     /** @internal */
     removeMembership(userId: string, syncLog: ILogItem) {
+        this.errorBoundary.try(() => {
             const deviceIds = this.getDeviceIdsForUserId(userId);
             syncLog.wrap({
                 l: "remove call member",
@@ -429,6 +457,7 @@ export class GroupCall extends EventEmitter<{change: never}> {
                     this.removeOwnDevice(log);
                 }
             });
+        });
     }
 
     private flushPendingIncomingDeviceMessages(member: Member, log: ILogItem) {
@@ -465,7 +494,8 @@ export class GroupCall extends EventEmitter<{change: never}> {
     }
 
     /** @internal */
-    disconnect(log: ILogItem) {
+    disconnect(log: ILogItem): boolean {
+        return this.errorBoundary.try(() => {
             if (this.hasJoined) {
                 for (const [,member] of this._members) {
                     const disconnectLogItem = member.disconnect(true);
@@ -478,6 +508,7 @@ export class GroupCall extends EventEmitter<{change: never}> {
             this.joinedData?.dispose();
             this.joinedData = undefined;
             this.emitChange();
+        }, false) || true;
     }
 
     /** @internal */
@@ -500,6 +531,7 @@ export class GroupCall extends EventEmitter<{change: never}> {
 
     /** @internal */
     handleDeviceMessage(message: SignallingMessage<MGroupCallBase>, userId: string, deviceId: string, syncLog: ILogItem) {
+        this.errorBoundary.try(() => {
             // TODO: return if we are not membering to the call
             const key = getMemberKey(userId, deviceId);
             let member = this._members.get(key);
@@ -525,6 +557,7 @@ export class GroupCall extends EventEmitter<{change: never}> {
                 }
                 messages.add(message);
             }
+        });
     }
 
     private async _createMemberPayload(includeOwn: boolean): Promise<CallMemberContent> {