feat: Update VoIP call handling to support accept success events and refactor state management

Author: diegolmello

android/app/src/main/java/chat/rocket/reactnative/voip/VoipModule.kt

@@ -16,7 +16,7 @@ class VoipModule(reactContext: ReactApplicationContext) : NativeVoipSpec(reactCo
 
     companion object {
         private const val TAG = "RocketChat.VoipModule"
-        private const val EVENT_INITIAL_EVENTS = "VoipPushInitialEvents"
+        private const val EVENT_VOIP_ACCEPT_SUCCEEDED = "VoipAcceptSucceeded"
         private const val EVENT_VOIP_ACCEPT_FAILED = "VoipAcceptFailed"
 
         private var reactContextRef: WeakReference<ReactApplicationContext>? = null
@@ -40,7 +40,7 @@ class VoipModule(reactContext: ReactApplicationContext) : NativeVoipSpec(reactCo
                     if (context.hasActiveReactInstance()) {
                         context
                             .getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter::class.java)
-                            .emit(EVENT_INITIAL_EVENTS, voipPayload.toWritableMap())
+                            .emit(EVENT_VOIP_ACCEPT_SUCCEEDED, voipPayload.toWritableMap())
                     }
                 }
             } catch (e: Exception) {

app/lib/methods/logout.ts

@@ -8,7 +8,6 @@ import database, { getDatabase } from '../database';
 import log from './helpers/log';
 import { disconnect } from '../services/connect';
 import sdk from '../services/sdk';
-import { useCallStore } from '../services/voip/useCallStore';
 import { CURRENT_SERVER, E2E_PRIVATE_KEY, E2E_PUBLIC_KEY, E2E_RANDOM_PASSWORD_KEY, TOKEN_KEY } from '../constants/keys';
 import UserPreferences from './userPreferences';
 import { removePushToken } from '../services/restApi';
@@ -90,8 +89,6 @@ export async function removeServer({ server }: { server: string }): Promise<void
 }
 
 export async function logout({ server }: { server: string }): Promise<void> {
-	useCallStore.getState().clearNativePendingAccept();
-
 	if (roomsSubscription?.stop) {
 		roomsSubscription.stop();
 	}

app/lib/services/voip/MediaCallEvents.ts

@@ -15,9 +15,12 @@ const platform = isIOS ? 'iOS' : 'Android';
 const TAG = `[MediaCallEvents][${platform}]`;
 
 const EVENT_VOIP_ACCEPT_FAILED = 'VoipAcceptFailed';
+const EVENT_VOIP_ACCEPT_SUCCEEDED = 'VoipAcceptSucceeded';
 
 /** Dedupe native emit + stash replay for the same failed accept. */
 let lastHandledVoipAcceptFailureCallId: string | null = null;
+/** Idempotent warm delivery of native accept success. */
+let lastHandledVoipAcceptSucceededCallId: string | null = null;
 
 function dispatchVoipAcceptFailureFromNative(raw: VoipPayload & { voipAcceptFailed?: boolean }) {
 	if (!raw.voipAcceptFailed) {
@@ -38,6 +41,29 @@ function dispatchVoipAcceptFailureFromNative(raw: VoipPayload & { voipAcceptFail
 	);
 }
 
+function handleVoipAcceptSucceededFromNative(data: VoipPayload) {
+	const { callId } = data;
+	if (callId && lastHandledVoipAcceptSucceededCallId === callId) {
+		return;
+	}
+	if (callId) {
+		lastHandledVoipAcceptSucceededCallId = callId;
+	}
+	if (data.type !== 'incoming_call') {
+		console.log(`${TAG} VoipAcceptSucceeded: not an incoming call`);
+		return;
+	}
+	console.log(`${TAG} VoipAcceptSucceeded:`, data);
+	NativeVoipModule.clearInitialEvents();
+	useCallStore.getState().setNativeAcceptedCallId(data.callId);
+	store.dispatch(
+		deepLinkingOpen({
+			callId: data.callId,
+			host: data.host
+		})
+	);
+}
+
 /**
  * Sets up listeners for media call events.
  * @returns Cleanup function to remove listeners
@@ -66,39 +92,19 @@ export const setupMediaCallEvents = (): (() => void) => {
 		// Note: there is intentionally no 'answerCall' listener here.
 		// VoipService.swift handles accept natively: handleObservedCallChanged detects
 		// hasConnected = true and calls handleNativeAccept(), which sends the DDP accept
-		// signal before JS runs. JS only reads the stored initialEventsData payload after the fact.
-	} else {
-		// Android listens for media call events from VoipModule
-		subscriptions.push(
-			Emitter.addListener('VoipPushInitialEvents', async (data: VoipPayload & { voipAcceptFailed?: boolean }) => {
-				try {
-					if (data.voipAcceptFailed) {
-						console.log(`${TAG} Accept failed initial event`);
-						dispatchVoipAcceptFailureFromNative(data);
-						NativeVoipModule.clearInitialEvents();
-						return;
-					}
-					if (data.type !== 'incoming_call') {
-						console.log(`${TAG} Not an incoming call`);
-						return;
-					}
-					console.log(`${TAG} Initial events event:`, data);
-					NativeVoipModule.clearInitialEvents();
-					useCallStore.getState().setNativePendingAccept(data.callId);
-					store.dispatch(
-						deepLinkingOpen({
-							callId: data.callId,
-							host: data.host
-						})
-					);
-					// await mediaSessionInstance.answerCall(data.callId);
-				} catch (error) {
-					console.error(`${TAG} Error handling initial events event:`, error);
-				}
-			})
-		);
+		// signal before JS runs. JS receives VoipAcceptSucceeded after success.
 	}
 
+	subscriptions.push(
+		Emitter.addListener(EVENT_VOIP_ACCEPT_SUCCEEDED, (data: VoipPayload) => {
+			try {
+				handleVoipAcceptSucceededFromNative(data);
+			} catch (error) {
+				console.error(`${TAG} Error handling VoipAcceptSucceeded:`, error);
+			}
+		})
+	);
+
 	subscriptions.push(
 		Emitter.addListener(EVENT_VOIP_ACCEPT_FAILED, (data: VoipPayload & { voipAcceptFailed?: boolean }) => {
 			console.log(`${TAG} VoipAcceptFailed event:`, data);
@@ -165,7 +171,7 @@ export const getInitialMediaCallEvents = async (): Promise<boolean> => {
 		}
 
 		if (wasAnswered) {
-			useCallStore.getState().setNativePendingAccept(initialEvents.callId);
+			useCallStore.getState().setNativeAcceptedCallId(initialEvents.callId);
 
 			store.dispatch(
 				deepLinkingOpen({

app/lib/services/voip/MediaSessionInstance.test.ts

@@ -3,13 +3,11 @@ import { mediaSessionStore } from './MediaSessionStore';
 import { mediaSessionInstance } from './MediaSessionInstance';
 
 const mockCallStoreReset = jest.fn();
-const mockSyncTransientCallIdFromNativePending = jest.fn();
 const mockUseCallStoreGetState = jest.fn(() => ({
 	reset: mockCallStoreReset,
 	setCall: jest.fn(),
 	setCallId: jest.fn(),
-	clearNativePendingAccept: jest.fn(),
-	syncTransientCallIdFromNativePending: mockSyncTransientCallIdFromNativePending,
+	resetNativeCallId: jest.fn(),
 	call: null as unknown,
 	callId: null as string | null,
 	nativeAcceptedCallId: null as string | null
@@ -116,8 +114,7 @@ describe('MediaSessionInstance', () => {
 			reset: mockCallStoreReset,
 			setCall: jest.fn(),
 			setCallId: jest.fn(),
-			clearNativePendingAccept: jest.fn(),
-			syncTransientCallIdFromNativePending: mockSyncTransientCallIdFromNativePending,
+			resetNativeCallId: jest.fn(),
 			call: null,
 			callId: null,
 			nativeAcceptedCallId: null
@@ -155,35 +152,6 @@ describe('MediaSessionInstance', () => {
 			spy.mockRestore();
 		});
 
-		it('should sync transient callId from sticky native pending after reset inside init', () => {
-			mockUseCallStoreGetState.mockReturnValue({
-				reset: mockCallStoreReset,
-				setCall: jest.fn(),
-				setCallId: jest.fn(),
-				clearNativePendingAccept: jest.fn(),
-				syncTransientCallIdFromNativePending: mockSyncTransientCallIdFromNativePending,
-				call: null,
-				callId: null,
-				nativeAcceptedCallId: 'native-accepted-call-id'
-			});
-			mediaSessionInstance.init('user-1');
-			expect(mockSyncTransientCallIdFromNativePending).toHaveBeenCalledWith();
-		});
-
-		it('should still invoke sync when store already has call object', () => {
-			mockUseCallStoreGetState.mockReturnValue({
-				reset: mockCallStoreReset,
-				setCall: jest.fn(),
-				setCallId: jest.fn(),
-				clearNativePendingAccept: jest.fn(),
-				syncTransientCallIdFromNativePending: mockSyncTransientCallIdFromNativePending,
-				call: { callId: 'x' } as any,
-				callId: 'x',
-				nativeAcceptedCallId: 'native-accepted-call-id'
-			});
-			mediaSessionInstance.init('user-1');
-			expect(mockSyncTransientCallIdFromNativePending).toHaveBeenCalledWith();
-		});
 	});
 
 	describe('teardown and user switch', () => {
@@ -251,16 +219,47 @@ describe('MediaSessionInstance', () => {
 			answerSpy.mockRestore();
 		});
 
-		it('calls answerCall when native-accepted store callId matches signal and contract matches device', async () => {
+		it('does not call answerCall when transient callId matches signal but nativeAcceptedCallId does not', async () => {
 			const answerSpy = jest.spyOn(mediaSessionInstance, 'answerCall').mockResolvedValue(undefined);
 			mockUseCallStoreGetState.mockReturnValue({
 				reset: mockCallStoreReset,
 				setCall: jest.fn(),
 				setCallId: jest.fn(),
-				clearNativePendingAccept: jest.fn(),
-				syncTransientCallIdFromNativePending: mockSyncTransientCallIdFromNativePending,
+				resetNativeCallId: jest.fn(),
 				call: null,
 				callId: 'from-signal',
+				nativeAcceptedCallId: null
+			});
+			mediaSessionInstance.init('user-1');
+			const streamHandler = getStreamNotifyHandler();
+			streamHandler({
+				msg: 'changed',
+				fields: {
+					eventName: 'uid/media-signal',
+					args: [
+						{
+							type: 'notification',
+							notification: 'accepted',
+							signedContractId: 'test-device-id',
+							callId: 'from-signal'
+						}
+					]
+				}
+			});
+			await Promise.resolve();
+			expect(answerSpy).not.toHaveBeenCalled();
+			answerSpy.mockRestore();
+		});
+
+		it('calls answerCall when nativeAcceptedCallId matches signal and contract matches device', async () => {
+			const answerSpy = jest.spyOn(mediaSessionInstance, 'answerCall').mockResolvedValue(undefined);
+			mockUseCallStoreGetState.mockReturnValue({
+				reset: mockCallStoreReset,
+				setCall: jest.fn(),
+				setCallId: jest.fn(),
+				resetNativeCallId: jest.fn(),
+				call: null,
+				callId: null,
 				nativeAcceptedCallId: 'from-signal'
 			});
 			mediaSessionInstance.init('user-1');
@@ -284,14 +283,13 @@ describe('MediaSessionInstance', () => {
 			answerSpy.mockRestore();
 		});
 
-		it('calls answerCall when only sticky native id matches (transient callId null)', async () => {
+		it('calls answerCall when only nativeAcceptedCallId matches (transient callId null)', async () => {
 			const answerSpy = jest.spyOn(mediaSessionInstance, 'answerCall').mockResolvedValue(undefined);
 			mockUseCallStoreGetState.mockReturnValue({
 				reset: mockCallStoreReset,
 				setCall: jest.fn(),
 				setCallId: jest.fn(),
-				clearNativePendingAccept: jest.fn(),
-				syncTransientCallIdFromNativePending: mockSyncTransientCallIdFromNativePending,
+				resetNativeCallId: jest.fn(),
 				call: null,
 				callId: null,
 				nativeAcceptedCallId: 'sticky-only'
@@ -323,8 +321,7 @@ describe('MediaSessionInstance', () => {
 				reset: mockCallStoreReset,
 				setCall: jest.fn(),
 				setCallId: jest.fn(),
-				clearNativePendingAccept: jest.fn(),
-				syncTransientCallIdFromNativePending: mockSyncTransientCallIdFromNativePending,
+				resetNativeCallId: jest.fn(),
 				call: { callId: 'from-signal' } as any,
 				callId: 'from-signal',
 				nativeAcceptedCallId: 'from-signal'

app/lib/services/voip/MediaSessionInstance.ts

@@ -12,7 +12,6 @@ import { getUniqueIdSync } from 'react-native-device-info';
 
 import { mediaSessionStore } from './MediaSessionStore';
 import { useCallStore } from './useCallStore';
-import { getEffectiveNativeAcceptedCallId } from './nativeAcceptHelpers';
 import { store } from '../../store/auxStore';
 import sdk from '../sdk';
 import Navigation from '../../navigation/appNavigation';
@@ -34,8 +33,6 @@ class MediaSessionInstance {
 	public init(userId: string): void {
 		this.reset();
 
-		useCallStore.getState().syncTransientCallIdFromNativePending();
-
 		registerGlobals();
 		this.configureIceServers();
 
@@ -68,16 +65,15 @@ class MediaSessionInstance {
 
 			console.log('🤙 [VoIP] Processed signal:', signal);
 
-			// Answer when native already accepted (sticky/transient id) and stream matches device contract + callId.
+			// Answer when native already accepted and stream matches device contract + callId.
 			const storeSlice = useCallStore.getState();
-			const { call } = storeSlice;
-			const effectiveNativeCallId = getEffectiveNativeAcceptedCallId(storeSlice);
+			const { call, nativeAcceptedCallId } = storeSlice;
 
 			if (
 				signal.type === 'notification' &&
 				signal.notification === 'accepted' &&
 				signal.signedContractId === getUniqueIdSync() &&
-				effectiveNativeCallId === signal.callId &&
+				nativeAcceptedCallId === signal.callId &&
 				call == null
 			) {
 				this.answerCall(signal.callId).catch(error => {
@@ -127,7 +123,7 @@ class MediaSessionInstance {
 			RNCallKeep.endCall(callId);
 			const st = useCallStore.getState();
 			if (st.nativeAcceptedCallId === callId) {
-				st.clearNativePendingAccept();
+				st.resetNativeCallId();
 			}
 			console.warn('[VoIP] Call not found:', callId); // TODO: Show error message?
 		}
@@ -158,7 +154,7 @@ class MediaSessionInstance {
 		RNCallKeep.endCall(callId);
 		RNCallKeep.setCurrentCallActive('');
 		RNCallKeep.setAvailable(true);
-		useCallStore.getState().clearNativePendingAccept();
+		useCallStore.getState().resetNativeCallId();
 		useCallStore.getState().reset();
 	};