@stream-io/video-react-native-sdk 1.28.3 → 1.29.0-beta.1

package/src/utils/push/internal/ios.ts

@@ -1,10 +1,9 @@
-import { AppState, NativeModules, Platform } from 'react-native';
-import { getCallKeepLib, getVoipPushNotificationLib } from '../libs';
-import { voipPushNotificationCallCId$ } from './rxSubjects';
+import { Platform } from 'react-native';
 import { pushUnsubscriptionCallbacks } from './constants';
-import { canAddPushWSSubscriptionsRef, shouldCallBeEnded } from './utils';
+import { canListenToWS, shouldCallBeClosed } from './utils';
 import { StreamVideoConfig } from '../../StreamVideoRN/types';
 import { videoLoggerSystem } from '@stream-io/video-client';
+import { getCallingxLib } from '../libs/callingx';
 
 export const onVoipNotificationReceived = async (
   notification: any,
@@ -32,71 +31,51 @@ export const onVoipNotificationReceived = async (
         "version": "v2"
       }
     } */
+  const logger = videoLoggerSystem.getLogger('setupIosVoipPushEvents');
+
   const sender = notification?.stream?.sender;
   const type = notification?.stream?.type;
   // do not process any other notifications other than stream.video or ringing
   if (sender !== 'stream.video' && type !== 'call.ring') {
     return;
   }
+
   const call_cid = notification?.stream?.call_cid;
   if (!call_cid || Platform.OS !== 'ios' || !pushConfig.ios.pushProviderName) {
     return;
   }
-  const logger = videoLoggerSystem.getLogger('setupIosVoipPushEvents');
-  const client = await pushConfig.createStreamVideoClient();
 
-  if (!client) {
+  const callingx = getCallingxLib();
+  if (callingx.isCallRegistered(call_cid)) {
+    //same call_cid is registered, so we skipping the notification
     logger.debug(
-      'client not found, not processing call.ring voip push notification',
+      `the same call_cid ${call_cid} is registered, skipping the call.ring notification`,
     );
     return;
   }
-  const shouldRejectCallWhenBusy = client['rejectCallWhenBusy'] ?? false;
-  if (shouldRejectCallWhenBusy) {
-    // inform the iOS native module that we should reject call when busy
-    NativeModules.StreamVideoReactNative.setShouldRejectCallWhenBusy(
-      shouldRejectCallWhenBusy,
-    );
-  }
-  const callFromPush = await client.onRingingCall(call_cid);
-  let uuid = '';
-  try {
-    uuid =
-      await NativeModules?.StreamVideoReactNative?.getIncomingCallUUid(
-        call_cid,
-      );
-  } catch (error) {
-    logger.error('Error in getting call uuid from native module', error);
-  }
-  if (!uuid) {
-    logger.error(
-      `Not processing call.ring push notification, as no uuid found for call_cid: ${call_cid}`,
+
+  const client = await pushConfig.createStreamVideoClient();
+  if (!client) {
+    logger.debug(
+      'client not found, not processing call.ring voip push notification',
     );
     return;
   }
-  const created_by_id = notification?.stream?.created_by_id;
-  const receiver_id = notification?.stream?.receiver_id;
+
+  const callFromPush = await client.onRingingCall(call_cid);
+
   function closeCallIfNecessary() {
-    const { mustEndCall, callkeepReason } = shouldCallBeEnded(
-      callFromPush,
-      created_by_id,
-      receiver_id,
-    );
+    const mustEndCall = shouldCallBeClosed(callFromPush, notification?.stream);
     if (mustEndCall) {
-      const callkeep = getCallKeepLib();
-      logger.debug(
-        `callkeep.reportEndCallWithUUID for uuid: ${uuid}, call_cid: ${call_cid}, reason: ${callkeepReason}`,
-      );
-      callkeep.reportEndCallWithUUID(uuid, callkeepReason);
-      const voipPushNotification = getVoipPushNotificationLib();
-      voipPushNotification.onVoipNotificationCompleted(uuid);
+      logger.debug(`callkeep.reportEndCallWithUUID for call_cid: ${call_cid}`);
+      //TODO: think about sending appropriate reason for end call
+      callingx.endCallWithReason(call_cid, 'local');
       return true;
     }
     return false;
   }
+
   const closed = closeCallIfNecessary();
-  const canListenToWS = () =>
-    canAddPushWSSubscriptionsRef.current && AppState.currentState !== 'active';
   if (!closed && canListenToWS()) {
     const unsubscribe = callFromPush.on('all', (event) => {
       const _canListenToWS = canListenToWS();
@@ -121,10 +100,10 @@ export const onVoipNotificationReceived = async (
     pushUnsubscriptionCallbacks.get(call_cid)?.forEach((cb) => cb());
     pushUnsubscriptionCallbacks.set(call_cid, [unsubscribe]);
   }
+
   // send the info to this subject, it is listened by callkeep events
   // callkeep events will then accept/reject the call
   logger.debug(
-    `call_cid:${call_cid} uuid:${uuid} received and processed from call.ring push notification`,
+    `call_cid:${call_cid} received and processed from call.ring push notification`,
   );
-  voipPushNotificationCallCId$.next(call_cid);
 };

package/src/utils/push/internal/rxSubjects.ts

@@ -40,32 +40,3 @@ export const pushAndroidBackgroundDeliveredIncomingCallCId$ =
 export const pushRejectedIncomingCallCId$ = new BehaviorSubject<
   string | undefined
 >(undefined);
-
-/**
- * This rxjs subject is used to store the call cid of the incoming call from ios voip pushkit notification
- */
-export const voipPushNotificationCallCId$ = new BehaviorSubject<
-  string | undefined
->(undefined);
-
-/** The pair of cid of a call and its corresponding uuid created in the native side */
-type CallkeepMap = {
-  uuid: string;
-  cid: string;
-};
-
-/*
- * This rxjs subject should only used to store the CallkeepMap
- * for the incoming call when on foreground
- * or in other words, when we get didDisplayIncomingCall from callkeep lib
- */
-export const voipCallkeepCallOnForegroundMap$ = new BehaviorSubject<
-  CallkeepMap | undefined
->(undefined);
-
-/*
- * This rxjs subject should only used to store the CallkeepMap when it was accepted in the native dialer
- */
-export const voipCallkeepAcceptedCallOnNativeDialerMap$ = new BehaviorSubject<
-  CallkeepMap | undefined
->(undefined);

package/src/utils/push/internal/utils.ts

@@ -10,6 +10,7 @@ import type {
 } from '../../StreamVideoRN/types';
 import { onNewCallNotification } from '../../internal/newNotificationCallbacks';
 import { pushUnsubscriptionCallbacks } from './constants';
+import { AppState } from 'react-native';
 
 type PushConfig = NonNullable<StreamVideoConfig['push']>;
 
@@ -122,6 +123,16 @@ export const processCallFromPush = async (
         .debug(
           `joining call from push notification with callCid: ${callFromPush.cid}`,
         );
+
+      if (callFromPush.state.callingState === CallingState.JOINED) {
+        videoLoggerSystem
+          .getLogger('processCallFromPush')
+          .debug(
+            `call already joined from push notification with callCid: ${callFromPush.cid}`,
+          );
+        return;
+      }
+
       await callFromPush.join();
     } else if (action === 'decline') {
       const canReject =
@@ -191,3 +202,17 @@ export const clearPushWSEventSubscriptions = (call_cid: string) => {
 export const canAddPushWSSubscriptionsRef: CanAddPushWSSubscriptionsRef = {
   current: true,
 };
+
+export const canListenToWS = () =>
+  canAddPushWSSubscriptionsRef.current && AppState.currentState !== 'active';
+
+export const shouldCallBeClosed = (
+  call: Call,
+  pushData: { [key: string]: string | object },
+) => {
+  const created_by_id = pushData?.created_by_id as string;
+  const receiver_id = pushData?.receiver_id as string;
+
+  const { mustEndCall } = shouldCallBeEnded(call, created_by_id, receiver_id);
+  return mustEndCall;
+};

package/src/utils/push/ios.ts

@@ -62,12 +62,7 @@ export const oniOSExpoNotificationEvent = (event: ExpoNotification) => {
   }
 };
 
-export const oniOSNotifeeEvent = ({
-  event,
-}: {
-  event: Event;
-  isBackground: boolean;
-}) => {
+export const oniOSNotifeeEvent = ({ event }: { event: Event }) => {
   if (Platform.OS !== 'ios') return;
   const pushConfig = StreamVideoRN.getConfig().push;
   const { type, detail } = event;

package/src/utils/push/libs/callingx.ts

@@ -0,0 +1,90 @@
+import { StreamVideoConfig } from '../../StreamVideoRN/types';
+
+export type RNCallingxType =
+  import('@stream-io/react-native-callingx').ICallingxModule;
+export type EventData = import('@stream-io/react-native-callingx').EventData;
+export type EventParams =
+  import('@stream-io/react-native-callingx').EventParams;
+export type CallingExpOptions =
+  import('@stream-io/react-native-callingx').CallingExpOptions;
+
+let callingx: RNCallingxType | undefined;
+
+try {
+  callingx = require('@stream-io/react-native-callingx').CallingxModule;
+} catch {}
+
+export function getCallingxLib() {
+  if (!callingx) {
+    throw Error('react-native-callingx library is not installed.');
+  }
+  return callingx;
+}
+
+export function getCallingxLibIfAvailable() {
+  return callingx ?? undefined;
+}
+
+export function extractCallingExpOptions(
+  config: StreamVideoConfig,
+): CallingExpOptions {
+  const { push: pushConfig, foregroundService: foregroundServiceConfig } =
+    config;
+  const callingExpOptions: CallingExpOptions = {};
+
+  if (pushConfig?.ios) {
+    const iosOptions: CallingExpOptions['ios'] = {};
+    if (pushConfig.ios.supportsVideo !== undefined) {
+      iosOptions.supportsVideo = pushConfig.ios.supportsVideo;
+    }
+    if (pushConfig.ios.sound !== undefined) {
+      iosOptions.sound = pushConfig.ios.sound;
+    }
+    if (pushConfig.ios.imageName !== undefined) {
+      iosOptions.imageName = pushConfig.ios.imageName;
+    }
+    if (pushConfig.ios.callsHistory !== undefined) {
+      iosOptions.callsHistory = pushConfig.ios.callsHistory;
+    }
+    if (pushConfig.ios.displayCallTimeout !== undefined) {
+      iosOptions.displayCallTimeout = pushConfig.ios.displayCallTimeout;
+    }
+
+    if (Object.keys(iosOptions).length > 0) {
+      callingExpOptions.ios = iosOptions;
+    }
+  }
+
+  const androidOptions: CallingExpOptions['android'] = {};
+  if (pushConfig?.android) {
+    if (pushConfig.android.incomingChannel) {
+      androidOptions.incomingChannel = pushConfig.android.incomingChannel;
+    }
+    if (pushConfig.android.titleTransformer) {
+      androidOptions.titleTransformer = pushConfig.android.titleTransformer;
+    }
+    if (pushConfig.android.subtitleTransformer) {
+      androidOptions.subtitleTransformer =
+        pushConfig.android.subtitleTransformer;
+    }
+  }
+
+  if (foregroundServiceConfig.android.channel) {
+    androidOptions.ongoingChannel = foregroundServiceConfig.android.channel;
+  }
+
+  if (Object.keys(androidOptions).length > 0) {
+    callingExpOptions.android = androidOptions;
+  }
+
+  if (pushConfig?.shouldRejectCallWhenBusy !== undefined) {
+    callingExpOptions.shouldRejectCallWhenBusy =
+      pushConfig.shouldRejectCallWhenBusy;
+  }
+
+  if (pushConfig?.enableOngoingCalls !== undefined) {
+    callingExpOptions.enableOngoingCalls = pushConfig?.enableOngoingCalls;
+  }
+
+  return callingExpOptions;
+}

package/src/utils/push/libs/index.ts

@@ -1,9 +1,8 @@
 export * from './expoNotifications';
 export * from './firebaseMessaging';
 export * from './iosPushNotification';
-export * from './voipPushNotification';
-export * from './callkeep';
 export * from './notifee';
+export * from './callingx';
 
 /*
     NOTE: must keep each libs in different files

package/src/utils/push/libs/notifee/index.ts

@@ -1,6 +1,4 @@
-import { PermissionsAndroid } from 'react-native';
 import { lib, type Type } from './lib';
-import { videoLoggerSystem } from '@stream-io/video-client';
 
 export type NotifeeLib = Type;
 
@@ -36,34 +34,9 @@ export function getNotifeeLibThrowIfNotInstalledForPush() {
 }
 
 export function getNotifeeLibNoThrowForKeepCallAlive() {
-  if (!lib) {
-    const logger = videoLoggerSystem.getLogger('getNotifeeLibNoThrow');
-    logger.info(
-      `${'@notifee/react-native library not installed. It is required to keep call alive in the background for Android. '}${INSTALLATION_INSTRUCTION}`,
-    );
-  }
   return lib;
 }
 
-export async function getKeepCallAliveForegroundServiceTypes() {
-  const types: AndroidForegroundServiceType[] = [
-    AndroidForegroundServiceType.FOREGROUND_SERVICE_TYPE_MEDIA_PLAYBACK,
-  ];
-  const hasCameraPermission = await PermissionsAndroid.check(
-    PermissionsAndroid.PERMISSIONS.CAMERA!,
-  );
-  if (hasCameraPermission) {
-    types.push(AndroidForegroundServiceType.FOREGROUND_SERVICE_TYPE_CAMERA);
-  }
-  const hasMicrophonePermission = await PermissionsAndroid.check(
-    PermissionsAndroid.PERMISSIONS.RECORD_AUDIO!,
-  );
-  if (hasMicrophonePermission) {
-    types.push(AndroidForegroundServiceType.FOREGROUND_SERVICE_TYPE_MICROPHONE);
-  }
-  return types;
-}
-
 export function getIncomingCallForegroundServiceTypes() {
   const types: AndroidForegroundServiceType[] = [
     AndroidForegroundServiceType.FOREGROUND_SERVICE_TYPE_SHORT_SERVICE,

package/src/utils/push/setupCallingExpEvents.ts

@@ -0,0 +1,117 @@
+import { pushAcceptedIncomingCallCId$ } from './internal/rxSubjects';
+import { videoLoggerSystem } from '@stream-io/video-client';
+import type { StreamVideoConfig } from '../StreamVideoRN/types';
+import {
+  clearPushWSEventSubscriptions,
+  processCallFromPushInBackground,
+} from './internal/utils';
+import { setPushLogoutCallback } from '../internal/pushLogoutCallback';
+import { resolvePendingAudioSession } from '../internal/audioSessionPromise';
+import {
+  getCallingxLib,
+  type EventData,
+  type EventParams,
+} from './libs/callingx';
+import { Platform } from 'react-native';
+
+type PushConfig = NonNullable<StreamVideoConfig['push']>;
+
+const logger = videoLoggerSystem.getLogger('Callingx');
+
+/**
+ * This hook is used to listen to callkeep events and do the necessary actions
+ */
+export function setupCallingExpEvents(pushConfig: NonNullable<PushConfig>) {
+  const hasPushProvider =
+    (Platform.OS === 'android' && pushConfig.android?.pushProviderName) ||
+    (Platform.OS === 'ios' && pushConfig.ios?.pushProviderName);
+
+  if (!hasPushProvider) {
+    return;
+  }
+
+  const callingx = getCallingxLib();
+
+  const { remove: removeAnswerCall } = callingx.addEventListener(
+    'answerCall',
+    onAcceptCall,
+  );
+  const { remove: removeEndCall } = callingx.addEventListener(
+    'endCall',
+    onEndCall(pushConfig),
+  );
+
+  const { remove: removeDidActivateAudioSession } = callingx.addEventListener(
+    'didActivateAudioSession',
+    onDidActivateAudioSession,
+  );
+  const { remove: removeDidDeactivateAudioSession } = callingx.addEventListener(
+    'didDeactivateAudioSession',
+    onDidDeactivateAudioSession,
+  );
+
+  //NOTE: until getInitialEvents invocation, events are delayed and won't be sent to event listeners, this is a way to make sure none of required events are missed
+  //in most cases there will be no delayed answers or ends, but it we don't want to miss any of them
+  const events = callingx.getInitialEvents();
+  events.forEach((event: EventData) => {
+    const { eventName, params } = event;
+    if (eventName === 'answerCall') {
+      logger.debug(`answerCall delayed event callId: ${params?.callId}`);
+      onAcceptCall(params as EventParams['answerCall']);
+    } else if (eventName === 'endCall') {
+      logger.debug(`endCall delayed event callId: ${params?.callId}`);
+      onEndCall(pushConfig)(params as EventParams['endCall']);
+    } else if (eventName === 'didActivateAudioSession') {
+      onDidActivateAudioSession();
+    } else if (eventName === 'didDeactivateAudioSession') {
+      onDidDeactivateAudioSession();
+    }
+  });
+
+  setPushLogoutCallback(async () => {
+    removeAnswerCall();
+    removeEndCall();
+    removeDidActivateAudioSession();
+    removeDidDeactivateAudioSession();
+  });
+}
+
+const onDidActivateAudioSession = () => {
+  logger.debug('callingExpDidActivateAudioSession');
+  resolvePendingAudioSession();
+};
+
+const onDidDeactivateAudioSession = () => {
+  logger.debug('callingExpDidDeactivateAudioSession');
+};
+
+const onAcceptCall = ({
+  callId: call_cid,
+  source,
+}: EventParams['answerCall']) => {
+  logger.debug(`onAcceptCall event callId: ${call_cid} source: ${source}`);
+
+  if (source === 'app' || !call_cid) {
+    //we only need to process the call if the call was answered from the system
+    return;
+  }
+
+  clearPushWSEventSubscriptions(call_cid);
+  // to process the call in the app
+  pushAcceptedIncomingCallCId$.next(call_cid);
+};
+
+const onEndCall =
+  (pushConfig: PushConfig) =>
+  async ({ callId: call_cid, source }: EventParams['endCall']) => {
+    logger.debug(`onEndCall event callId: ${call_cid} source: ${source}`);
+
+    if (source === 'app' || !call_cid) {
+      //we only need to process the call if the call was rejected from the system
+      return;
+    }
+
+    clearPushWSEventSubscriptions(call_cid);
+
+    await processCallFromPushInBackground(pushConfig, call_cid, 'decline');
+  };

package/src/utils/push/setupIosVoipPushEvents.ts

@@ -1,10 +1,11 @@
-import { getVoipPushNotificationLib } from './libs';
+// import { getVoipPushNotificationLib } from './libs';
 
 import { Platform } from 'react-native';
 import { onVoipNotificationReceived } from './internal/ios';
 import { setPushLogoutCallback } from '../internal/pushLogoutCallback';
 import { StreamVideoConfig } from '../StreamVideoRN/types';
 import { videoLoggerSystem } from '@stream-io/video-client';
+import { getCallingxLib } from './libs';
 
 export function setupIosVoipPushEvents(
   pushConfig: NonNullable<StreamVideoConfig['push']>,
@@ -20,16 +21,19 @@ export function setupIosVoipPushEvents(
     );
     return;
   }
-  const voipPushNotification = getVoipPushNotificationLib();
 
-  logger.debug('notification event listener added');
-  voipPushNotification.addEventListener('notification', (notification) => {
-    onVoipNotificationReceived(notification, pushConfig);
-  });
+  const callingx = getCallingxLib();
+  const voipNotificationReceivedListener = callingx.addEventListener(
+    'voipNotificationReceived',
+    (params) => {
+      onVoipNotificationReceived(params, pushConfig);
+    },
+  );
+
   setPushLogoutCallback(async () => {
     videoLoggerSystem
       .getLogger('setPushLogoutCallback')
       .debug('notification event listener removed');
-    voipPushNotification.removeEventListener('notification');
+    voipNotificationReceivedListener.remove();
   });
 }

package/src/version.ts

@@ -1 +1 @@
-export const version = '1.28.3';
+export const version = '1.29.0-beta.1';