mattermost-mobile-upstream/app/init/calls_native.ts
Bill Gardner 827eae876c
[MM-70525] Fix CallKit call disconnect on lock-screen answer (#10111)
* [MM-70525] Fix CallKit call disconnect on lock-screen answer

NativeCallMapping gains an optional callId field. When a VoIP push
arrives the mapping is created with callId seeded from calls state
(empty string if call_started hasn't been processed yet). handleCallStarted
backfills the callId once the WebSocket event confirms the call is live.

getNativeCallUUIDForCall now accepts an optional callId: when provided,
a mapping whose callId is empty or mismatched is treated as unconfirmed
and returns undefined, making endNativeCall a no-op. This prevents a
buffered call_end event from a prior call being replayed on WebSocket
reconnect from tearing down the active CallKit session.

handleCallEnded reads the callId from calls state before callEnded()
removes it, then passes it through to endNativeCall so the guard can
distinguish the current call from a stale replayed event.

* [MM-70525] Add handler-level tests for callId backfill and stale replay guard

Tests handleCallStarted backfilling callId into an existing native mapping
(VoIP-push-first ordering), handleCallEnded reading callId from state before
callEnded() clears it, and the stale call_end replay path where no active call
is in state.

* [MM-70525] Tighten callId ordering test: callEnded mock clears state

Makes the callEnded mock simulate state cleanup so the test fails if
callId is read after callEnded() rather than before it.
2026-09-08 14:17:56 -04:00

226 lines
8.0 KiB
TypeScript

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
import CallsNative, {
type CallActionPayload,
type CallMutePayload,
type IncomingCallPayload,
type VoIPTokenUpdated,
} from '@mattermost/calls-native';
import {defineMessages} from 'react-intl';
import {Platform, type EmitterSubscription} from 'react-native';
defineMessages({
incomingCallPlaceholder: {
id: 'mobile.ios.calls.incoming_call_placeholder',
defaultMessage: '{applicationName} call',
},
});
import {storeVoIPDeviceToken} from '@actions/app/global';
import {dismissIncomingCall, hasMicrophonePermission, joinCall, leaveCall, muteMyself, unmuteMyself} from '@calls/actions';
import {hasBluetoothPermission} from '@calls/actions/permissions';
import {
clearNativeCallMapping,
getNativeCallMapping,
setNativeCallMapping,
} from '@calls/native_call';
import {
getCurrentCall,
getCallsState,
setMicPermissionsGranted,
} from '@calls/state';
import {Device} from '@constants';
import DatabaseManager from '@database/manager';
import WebsocketManager from '@managers/websocket_manager';
import {getServerByIdentifier} from '@queries/app/servers';
import {getCurrentUser} from '@queries/servers/user';
import {getIntlShape, isBetaApp} from '@utils/general';
import {logDebug, logError, logInfo} from '@utils/log';
class CallsNativeSingleton {
subscriptions?: EmitterSubscription[];
init() {
if (Platform.OS !== 'ios') {
// The Android side of @mattermost/calls-native is a no-op
// stub for Phase 1.
return;
}
this.subscriptions?.forEach((s) => s.remove());
this.subscriptions = [
CallsNative.onVoIPTokenUpdated(this.onVoIPTokenUpdated),
CallsNative.onIncomingCall(this.onIncomingCall),
CallsNative.onCallAnswered(this.onCallAnswered),
CallsNative.onCallDeclined(this.onCallDeclined),
CallsNative.onCallEnded(this.onCallEnded),
CallsNative.onMuteChanged(this.onMuteChanged),
];
}
cleanup() {
this.subscriptions?.forEach((s) => s.remove());
this.subscriptions = [];
}
private onVoIPTokenUpdated = async (event: VoIPTokenUpdated) => {
const {token} = event;
if (!token) {
// Token invalidation: clear the stored value so the next
// setExtraSessionProps call doesn't attach a stale token.
await storeVoIPDeviceToken('');
return;
}
let prefix = Device.PUSH_NOTIFY_APPLE_REACT_NATIVE;
if (isBetaApp) {
prefix = `${prefix}beta`;
}
const prefixed = `${prefix}-v2:${token}`;
await storeVoIPDeviceToken(prefixed);
logInfo('VoIP device token stored');
};
private onIncomingCall = async (payload: IncomingCallPayload) => {
const {uuid, serverId, channelId, postId, threadId} = payload;
if (!serverId) {
logDebug('onIncomingCall received without serverId; ignoring', uuid);
return;
}
if (!channelId) {
logDebug('onIncomingCall received without channelId; ignoring', uuid);
return;
}
const server = await getServerByIdentifier(serverId);
if (!server?.url) {
logDebug('onIncomingCall could not resolve serverId to a known server', serverId);
// Tell native to clear the Native UI so the user isn't stuck.
CallsNative.reportEnded(uuid, 'failed');
return;
}
setNativeCallMapping(uuid, {
serverUrl: server.url,
channelId,
postId,
threadId,
callId: getCallsState(server.url).calls[channelId]?.id ?? '',
});
// Open WS to the call's server so user_dismissed_notification /
// call_end / answered_elsewhere events arrive live while CallKit is
// ringing. Fire-and-forget: idempotent if already connected, and we
// don't want to delay the handler on a slow first-connect sync.
WebsocketManager.initializeClient(server.url);
};
private onCallAnswered = async (event: CallActionPayload) => {
const {uuid} = event;
const mapping = getNativeCallMapping(uuid);
if (!mapping) {
// No mapping means we can't route the answer anywhere; tell
// Native to close the UI so the user isn't stuck in
// "Connecting…" forever.
CallsNative.reportEnded(uuid, 'failed');
return;
}
const {serverUrl, channelId, threadId} = mapping;
try {
const {database} = DatabaseManager.getServerDatabaseAndOperator(serverUrl);
const user = await getCurrentUser(database);
if (!user) {
logError('onCallAnswered: no current user for server', serverUrl);
CallsNative.reportEnded(uuid, 'failed');
clearNativeCallMapping(uuid);
return;
}
// If the user was in another call, leave it without prompting —
// they already chose to answer via the Native overlay.
const currentCall = getCurrentCall();
if (currentCall && (currentCall.serverUrl !== serverUrl || currentCall.channelId !== channelId)) {
leaveCall();
}
await hasBluetoothPermission();
const hasMic = await hasMicrophonePermission();
setMicPermissionsGranted(hasMic);
const intl = getIntlShape(user.locale);
const res = await joinCall(serverUrl, channelId, user.id, hasMic, intl, undefined, threadId);
if (res.error) {
logError('onCallAnswered: joinCall failed', res.error);
CallsNative.reportEnded(uuid, 'failed');
clearNativeCallMapping(uuid);
return;
}
// Native is showing "Connecting…"; flip to "Connected" so the
// timer starts. joinCall awaits waitForPeerConnection before
// returning, so we know RTC is up at this point.
CallsNative.reportConnected(uuid);
// Ring notifications only fire for DM/GM, so an answered native
// call is always DM/GM — match the in-app DM/GM join behavior
// and unmute. unmuteMyself mirrors the state to the native UI.
unmuteMyself();
} catch (error) {
logError('onCallAnswered failed', error);
CallsNative.reportEnded(uuid, 'failed');
clearNativeCallMapping(uuid);
}
};
private onCallDeclined = async (event: CallActionPayload) => {
const {uuid} = event;
const mapping = getNativeCallMapping(uuid);
clearNativeCallMapping(uuid);
if (!mapping) {
return;
}
await dismissIncomingCall(mapping.serverUrl, mapping.channelId);
};
private onCallEnded = (event: CallActionPayload) => {
const {uuid} = event;
const mapping = getNativeCallMapping(uuid);
clearNativeCallMapping(uuid);
if (!mapping) {
return;
}
// If we're still in the call (the user ended via the Native
// overlay rather than the in-app UI), tear down the RTC connection.
const currentCall = getCurrentCall();
if (currentCall && currentCall.serverUrl === mapping.serverUrl && currentCall.channelId === mapping.channelId) {
leaveCall();
}
};
private onMuteChanged = (event: CallMutePayload) => {
const {uuid, muted} = event;
const mapping = getNativeCallMapping(uuid);
if (!mapping) {
return;
}
const currentCall = getCurrentCall();
if (!currentCall || currentCall.serverUrl !== mapping.serverUrl || currentCall.channelId !== mapping.channelId) {
return;
}
if (muted) {
muteMyself();
} else {
unmuteMyself();
}
};
}
const CallsNativeInit = new CallsNativeSingleton();
export default CallsNativeInit;