chore: improve voip lib configs for better mobile compatibility (RocketChat#37265)

Author: pierre-lehnen-rc

packages/media-signaling/src/definition/call/CallEvents.ts

@@ -14,6 +14,9 @@ export type CallEvents = {
 	/* Triggered as soon as the call is registered on this client */
 	initialized: void;
 
+	/* Triggered when the call is confirmed to exist in the server */
+	confirmed: void;
+
 	/* Triggered when this client is telling the server that we want to accept the call */
 	accepting: void;
 	/* Triggered when the call's state on the server changes to 'accepted' */

packages/media-signaling/src/definition/call/IClientMediaCall.ts

@@ -90,6 +90,11 @@ export interface IClientMediaCall {
 	audioLevel: number;
 	localAudioLevel: number;
 
+	/** if the call was requested by this session, then this will have the ID used to request the call, otherwise it will be the same as callId */
+	readonly tempCallId: string;
+	/** confirmed indicates if the call exists on the server */
+	readonly confirmed: boolean;
+
 	emitter: Emitter<CallEvents>;
 
 	getRemoteMediaStream(): MediaStream;

packages/media-signaling/src/lib/Call.ts

@@ -34,6 +34,7 @@ export interface IClientMediaCallConfig {
 	sessionId: string;
 
 	iceGatheringTimeout: number;
+	iceServers: RTCIceServer[];
 }
 
 const TIMEOUT_TO_ACCEPT = 30000;
@@ -143,6 +144,14 @@ export class ClientMediaCall implements IClientMediaCall {
 		return !this.isPendingAcceptance() && !this.isOver();
 	}
 
+	public get confirmed(): boolean {
+		return this.hasRemoteData;
+	}
+
+	public get tempCallId(): string {
+		return this.localCallId;
+	}
+
 	protected webrtcProcessor: IWebRTCProcessor | null = null;
 
 	private acceptedLocally: boolean;
@@ -357,6 +366,7 @@ export class ClientMediaCall implements IClientMediaCall {
 		if (!wasInitialized) {
 			this.emitter.emit('initialized');
 		}
+		this.emitter.emit('confirmed');
 
 		await this.processEarlySignals();
 	}
@@ -1163,7 +1173,13 @@ export class ClientMediaCall implements IClientMediaCall {
 			this.throwError('webrtc-not-implemented');
 		}
 
-		this.webrtcProcessor = webrtcFactory({ logger, iceGatheringTimeout, call: this, inputTrack: this.inputTrack });
+		this.webrtcProcessor = webrtcFactory({
+			logger,
+			iceGatheringTimeout,
+			call: this,
+			inputTrack: this.inputTrack,
+			...(this.config.iceServers.length && { rtc: { iceServers: this.config.iceServers } }),
+		});
 		this.webrtcProcessor.emitter.on('internalStateChange', (stateName) => this.onWebRTCInternalStateChange(stateName));
 
 		this.negotiationManager.emitter.on('local-sdp', ({ sdp, negotiationId }) => this.deliverSdp({ sdp, negotiationId }));

packages/media-signaling/src/lib/Session.ts

@@ -30,6 +30,7 @@ export type MediaSignalingSessionConfig = {
 	randomStringFactory: RandomStringFactory;
 	transport: MediaSignalTransport<ClientMediaSignal>;
 	iceGatheringTimeout?: number;
+	iceServers?: RTCIceServer[];
 };
 
 const STATE_REPORT_INTERVAL = 60000;
@@ -90,7 +91,7 @@ export class MediaSignalingSession extends Emitter<MediaSignalingEvents> {
 	}
 
 	public isBusy(): boolean {
-		return this.getMainCall()?.busy ?? false;
+		return this.getMainCall(false)?.busy ?? false;
 	}
 
 	public enableStateReport(interval: number): void {
@@ -126,14 +127,17 @@ export class MediaSignalingSession extends Emitter<MediaSignalingEvents> {
 		return this.knownCalls.get(callId) || null;
 	}
 
-	public getMainCall(): IClientMediaCall | null {
+	public getMainCall(skipLocal = false): IClientMediaCall | null {
 		let ringingCall: IClientMediaCall | null = null;
 		let pendingCall: IClientMediaCall | null = null;
 
 		for (const call of this.knownCalls.values()) {
 			if (call.state === 'hangup' || call.ignored) {
 				continue;
 			}
+			if (skipLocal && !call.confirmed) {
+				continue;
+			}
 
 			if (call.busy) {
 				return call;
@@ -193,6 +197,10 @@ export class MediaSignalingSession extends Emitter<MediaSignalingEvents> {
 
 	public async startCall(calleeType: CallActorType, calleeId: string, params: { contactInfo?: CallContact } = {}): Promise<void> {
 		this.config.logger?.debug('MediaSignalingSession.startCall', calleeId);
+		if (this.getMainCall(false)) {
+			throw new Error(`Already on a call.`);
+		}
+
 		const { contactInfo } = params;
 
 		const callId = this.createTemporaryCallId();
@@ -215,6 +223,10 @@ export class MediaSignalingSession extends Emitter<MediaSignalingEvents> {
 		this.config.iceGatheringTimeout = newTimeout;
 	}
 
+	public setIceServers(iceServers: RTCIceServer[]): void {
+		this.config.iceServers = iceServers;
+	}
+
 	private createTemporaryCallId(): string {
 		return `${this._sessionId}-${this.config.randomStringFactory()}`;
 	}
@@ -450,7 +462,8 @@ export class MediaSignalingSession extends Emitter<MediaSignalingEvents> {
 			logger: this.config.logger,
 			transporter: this.transporter,
 			processorFactories: this.config.processorFactories,
-			iceGatheringTimeout: this.config.iceGatheringTimeout || 1000,
+			iceGatheringTimeout: this.config.iceGatheringTimeout || 5000,
+			iceServers: this.config.iceServers || [],
 			sessionId: this._sessionId,
 		};
 
@@ -462,6 +475,7 @@ export class MediaSignalingSession extends Emitter<MediaSignalingEvents> {
 		call.emitter.on('clientStateChange', () => this.onCallClientStateChange(call));
 		call.emitter.on('trackStateChange', () => this.onTrackStateChange(call));
 		call.emitter.on('initialized', () => this.onNewCall(call));
+		call.emitter.on('confirmed', () => this.onConfirmedCall(call));
 		call.emitter.on('accepted', () => this.onAcceptedCall(call));
 		call.emitter.on('accepting', () => this.onAcceptingCall(call));
 		call.emitter.on('hidden', () => this.onHiddenCall(call));
@@ -491,6 +505,11 @@ export class MediaSignalingSession extends Emitter<MediaSignalingEvents> {
 		this.onSessionStateChange();
 	}
 
+	private onConfirmedCall(_call: ClientMediaCall): void {
+		this.config.logger?.debug('MediaSignalingSession.onConfirmedCall');
+		this.onSessionStateChange();
+	}
+
 	private onAcceptedCall(_call: ClientMediaCall): void {
 		this.config.logger?.debug('MediaSignalingSession.onAcceptedCall');
 		this.onSessionStateChange();
@@ -523,15 +542,16 @@ export class MediaSignalingSession extends Emitter<MediaSignalingEvents> {
 	}
 
 	private onSessionStateChange(): void {
-		const mainCall = this.getMainCall();
-		const hasCall = Boolean(mainCall);
-		const hasVisibleCall = Boolean(mainCall && !mainCall.hidden);
-		const hasBusyCall = Boolean(hasVisibleCall && mainCall?.busy);
-
 		const hadCall = this.lastState.hasCall;
 		const hadVisibleCall = this.lastState.hasVisibleCall;
 		const hadBusyCall = this.lastState.hasBusyCall;
 
+		// Do not skip local calls if we transitioned from a different active call to it
+		const mainCall = this.getMainCall(!hadCall);
+		const hasCall = Boolean(mainCall);
+		const hasVisibleCall = Boolean(mainCall && !mainCall.hidden);
+		const hasBusyCall = Boolean(hasVisibleCall && mainCall?.busy);
+
 		this.lastState = { hasCall, hasVisibleCall, hasBusyCall };
 
 		if (mainCall && !hadCall) {