feat: improve initialization state handling and expo auto init support (#504)

mrehan27 · web-flow · commit d3ed7f92f002 · 2025-08-22T20:18:42.000+05:00
diff --git a/android/cio-core.gradle b/android/cio-core.gradle
@@ -1,5 +1,5 @@
 dependencies {
-    implementation "io.customer.android:datapipelines:$cioAndroidSDKVersion"
-    implementation "io.customer.android:messaging-push-fcm:$cioAndroidSDKVersion"
-    implementation "io.customer.android:messaging-in-app:$cioAndroidSDKVersion"
+    api "io.customer.android:datapipelines:$cioAndroidSDKVersion"
+    api "io.customer.android:messaging-push-fcm:$cioAndroidSDKVersion"
+    api "io.customer.android:messaging-in-app:$cioAndroidSDKVersion"
 }
diff --git a/android/src/main/java/io/customer/reactnative/sdk/NativeCustomerIOModuleImpl.kt b/android/src/main/java/io/customer/reactnative/sdk/NativeCustomerIOModuleImpl.kt
@@ -29,18 +29,31 @@ internal object NativeCustomerIOModuleImpl {
     private val logger: Logger
         get() = SDKComponent.logger
 
-    private fun customerIO(): CustomerIO? = runCatching {
+    // Returns CustomerIO instance if initialized, null otherwise, with configurable failure handling.
+    private inline fun getSDKInstanceOrNull(
+        onFailure: (exception: Throwable) -> Unit = {}
+    ): CustomerIO? = runCatching {
         // If the SDK is not initialized, `CustomerIO.instance()` throws an exception
         CustomerIO.instance()
-    }.onFailure {
-        logger.error("Customer.io instance not initialized")
-    }.getOrNull()
+    }.onFailure(onFailure).getOrNull()
+
+    // Returns CustomerIO instance if initialized, null otherwise, logging error on failure.
+    private fun requireSDKInstance(): CustomerIO? = getSDKInstanceOrNull {
+        logger.error("CustomerIO SDK is not initialized. Please call initialize() first.")
+    }
 
     fun initialize(
         reactContext: ReactApplicationContext,
         sdkConfig: ReadableMap?,
         promise: Promise?
     ) {
+        // Skip initialization if already initialized
+        if (getSDKInstanceOrNull() != null) {
+            logger.info("CustomerIO SDK is already initialized. Skipping initialization.")
+            promise?.resolve(true)
+            return
+        }
+
         try {
             val packageConfig = sdkConfig.toMap()
             val cdpApiKey = packageConfig.getTypedValue<String>(
@@ -98,7 +111,7 @@ internal object NativeCustomerIOModuleImpl {
     }
 
     fun clearIdentify() {
-        customerIO()?.clearIdentify()
+        requireSDKInstance()?.clearIdentify()
     }
 
     fun identify(params: ReadableMap?) {
@@ -111,39 +124,39 @@ internal object NativeCustomerIOModuleImpl {
         }
 
         userId?.let {
-            customerIO()?.identify(userId, traits.toMap())
+            requireSDKInstance()?.identify(userId, traits.toMap())
         } ?: run {
-            customerIO()?.profileAttributes = traits.toMap()
+            requireSDKInstance()?.profileAttributes = traits.toMap()
         }
     }
 
     fun track(name: String?, properties: ReadableMap?) {
         val eventName = assertNotNull(name) ?: return
 
-        customerIO()?.track(eventName, properties.toMap())
+        requireSDKInstance()?.track(eventName, properties.toMap())
     }
 
     fun setDeviceAttributes(attributes: ReadableMap?) {
-        customerIO()?.deviceAttributes = attributes.toMap()
+        requireSDKInstance()?.deviceAttributes = attributes.toMap()
     }
 
     fun setProfileAttributes(attributes: ReadableMap?) {
-        customerIO()?.profileAttributes = attributes.toMap()
+        requireSDKInstance()?.profileAttributes = attributes.toMap()
     }
 
     fun screen(title: String?, properties: ReadableMap?) {
         val screenTitle = assertNotNull(title) ?: return
 
-        customerIO()?.screen(screenTitle, properties.toMap())
+        requireSDKInstance()?.screen(screenTitle, properties.toMap())
     }
 
     fun registerDeviceToken(token: String?) {
         val deviceToken = assertNotNull(token) ?: return
 
-        customerIO()?.registerDeviceToken(deviceToken)
+        requireSDKInstance()?.registerDeviceToken(deviceToken)
     }
 
     fun deleteDeviceToken() {
-        customerIO()?.deleteDeviceToken()
+        requireSDKInstance()?.deleteDeviceToken()
     }
 }
diff --git a/api-extractor-output/customerio-reactnative.api.md b/api-extractor-output/customerio-reactnative.api.md
@@ -78,6 +78,7 @@ export class CustomerIO {
     // (undocumented)
     static readonly inAppMessaging: CustomerIOInAppMessaging;
     static readonly initialize: (config: CioConfig) => Promise<void>;
+    // @deprecated
     static readonly isInitialized: () => boolean;
     // (undocumented)
     static readonly pushMessaging: CustomerIOPushMessaging;
diff --git a/example/src/App.tsx b/example/src/App.tsx
@@ -7,7 +7,7 @@ import { ContentNavigator } from '@screens';
 import { Storage } from '@services';
 import { appTheme } from '@utils';
 import { CioConfig, CioPushPermissionStatus, CustomerIO, InAppMessageEvent, InAppMessageEventType } from 'customerio-reactnative';
-import FlashMessage, { showMessage } from 'react-native-flash-message';
+import FlashMessage from 'react-native-flash-message';
 import { AppEnvValues } from './env';
 
 export default function App({ appName }: { appName: string }) {
@@ -133,16 +133,8 @@ export default function App({ appName }: { appName: string }) {
               CustomerIO.clearIdentify();
             },
             onTrackEvent: (eventPayload) => {
-              if (CustomerIO.isInitialized()) {
-                console.log('Tracking event', eventPayload);
-                CustomerIO.track(eventPayload.name, eventPayload.properties);
-              } else {
-                showMessage({
-                  message: 'CustomerIO not initialized',
-                  description: 'Please set the CustomerIO config',
-                  type: 'danger',
-                });
-              }
+              console.log('Tracking event', eventPayload);
+              CustomerIO.track(eventPayload.name, eventPayload.properties);
             },
             onProfileAttributes(attributes) {
               console.log('Setting profile attributes', attributes);
@@ -154,10 +146,8 @@ export default function App({ appName }: { appName: string }) {
             },
             onScreenChange(screenName) {
               // See 'src/screens/content-navigator.tsx' for the how we implemented screen auto-tracking
-              if (CustomerIO.isInitialized()) {
-                console.log('Tracking screen change', screenName);
-                CustomerIO.screen(screenName);
-              }
+              console.log('Tracking screen change', screenName);
+              CustomerIO.screen(screenName);
             },
             async onPushNotificationRequestPermisionButtonPress(): Promise<void> {
               console.log('Requesting push notification permission');
diff --git a/ios/wrappers/NativeCustomerIO.swift b/ios/wrappers/NativeCustomerIO.swift
@@ -6,6 +6,19 @@ import CioMessagingInApp
 @objc(NativeCustomerIO)
 public class NativeCustomerIO: NSObject {
     private let logger: CioInternalCommon.Logger = DIGraphShared.shared.logger
+    /// Checks whether the CustomerIO SDK has been initialized.
+    /// Returns `true` if the SDK has been successfully initialized, `false` otherwise.
+    private var isInitialized: Bool { CustomerIO.shared.implementation != nil }
+
+    /// Ensures that the CustomerIO SDK is initialized before performing operations.
+    /// Logs an error and returns false if the SDK is not initialized.
+    private func ensureInitialized() -> Bool {
+        guard isInitialized else {
+            logger.error("CustomerIO SDK is not initialized. Please call initialize() first.")
+            return false
+        }
+        return true
+    }
 
     @objc
     func initialize(
@@ -14,6 +27,13 @@ public class NativeCustomerIO: NSObject {
         resolve: @escaping (RCTPromiseResolveBlock),
         reject: @escaping (RCTPromiseRejectBlock)
     ) {
+        // Skip initialization if already initialized
+        if isInitialized {
+            logger.info("CustomerIO SDK is already initialized. Skipping initialization.")
+            resolve(true)
+            return
+        }
+
         do {
             let packageSource = args["packageSource"] as? String
             let packageVersion = args["packageVersion"] as? String
@@ -50,6 +70,8 @@ public class NativeCustomerIO: NSObject {
 
     @objc
     func identify(_ params: [String: Any]?) {
+        guard ensureInitialized() else { return }
+
         let userId = params?["userId"] as? String
         let traits = params?["traits"] as? [String: Any]
 
@@ -70,36 +92,43 @@ public class NativeCustomerIO: NSObject {
 
     @objc
     func clearIdentify() {
+        guard ensureInitialized() else { return }
         CustomerIO.shared.clearIdentify()
     }
 
     @objc
     func track(_ name: String, properties: [String: Any]?) {
+        guard ensureInitialized() else { return }
         CustomerIO.shared.track(name: name, properties: properties)
     }
 
     @objc
     func screen(_ title: String, properties: [String: Any]?) {
+        guard ensureInitialized() else { return }
         CustomerIO.shared.screen(title: title, properties: properties)
     }
 
     @objc
     func setProfileAttributes(_ attributes: [String: Any]) {
+        guard ensureInitialized() else { return }
         CustomerIO.shared.profileAttributes = attributes
     }
 
     @objc
     func setDeviceAttributes(_ attributes: [String: Any]) {
+        guard ensureInitialized() else { return }
         CustomerIO.shared.deviceAttributes = attributes
     }
 
     @objc
     func registerDeviceToken(_ token: String) {
+        guard ensureInitialized() else { return }
         CustomerIO.shared.registerDeviceToken(token)
     }
 
     @objc
     func deleteDeviceToken() {
+        guard ensureInitialized() else { return }
         CustomerIO.shared.deleteDeviceToken()
     }
 }
diff --git a/ios/wrappers/inapp/ReactInAppEventListener.swift b/ios/wrappers/inapp/ReactInAppEventListener.swift
@@ -4,9 +4,9 @@ import CioMessagingInApp
  * React Native bridge for Customer.io in-app messaging events.
  * Converts native SDK events to JavaScript compatible format.
  */
-class ReactInAppEventListener: InAppEventListener {
+public class ReactInAppEventListener: InAppEventListener {
     // Shared instance for global access
-    static let shared = ReactInAppEventListener()
+    public static let shared = ReactInAppEventListener()
     // Event emitter function to send events to React Native layer
     private var eventEmitter: (([String: Any?]) -> Void)?
 
diff --git a/src/customerio-cdp.ts b/src/customerio-cdp.ts
@@ -25,11 +25,6 @@ const nativeModule = ensureNativeModule(NativeModule);
 
 // Wrapper function that ensures SDK is initialized before calling native methods
 const withNativeModule = <R>(fn: (native: CodegenSpec) => R): R => {
-  if (!_initialized) {
-    throw new Error(
-      'CustomerIO SDK must be initialized before calling any methods. Please call CustomerIO.initialize() first.'
-    );
-  }
   return callNativeModule(nativeModule, fn);
 };
 
@@ -155,9 +150,18 @@ export class CustomerIO {
     return withNativeModule((native) => native.deleteDeviceToken());
   };
 
-  /** Check if the CustomerIO SDK has been initialized. */
+  /**
+   * Check if the CustomerIO SDK has been initialized.
+   * @deprecated This method will be removed in a future version. If you need this functionality, please contact us.
+   */
   static readonly isInitialized = () => _initialized;
 
   static readonly inAppMessaging = new CustomerIOInAppMessaging();
   static readonly pushMessaging = new CustomerIOPushMessaging();
 }
+
+// Initialize native logger when this module loads to ensure it's always available.
+// Since customerio-cdp.ts is the main SDK entry point and always imported,
+// this guarantees logger initialization even when native-logger-listener.ts
+// isn't directly accessed, also supporting auto-initialization in Expo apps.
+NativeLoggerListener.initNativeLogger();
diff --git a/src/native-logger-listener.ts b/src/native-logger-listener.ts
@@ -60,16 +60,35 @@ export class NativeLoggerListener {
         native.onCioLogEvent(logHandler);
       } catch {
         // Fallback to old arch NativeEventEmitter when new arch method fails
-        const bridge = new NativeEventEmitter(native);
-        bridge.addListener('CioLogEvent', logHandler);
+        try {
+          // Use try-catch to prevent crashes for cases where native module may
+          // not be available instantly
+          const bridge = new NativeEventEmitter(native);
+          bridge.addListener('CioLogEvent', logHandler);
+        } catch (error) {
+          NativeLoggerListener.warn(
+            'Failed to attach old arch log listener:',
+            error
+          );
+        }
       }
     });
     this.isInitialized = true;
   }
 
-  static warn(message: string) {
+  // Logs warning messages in development mode only, with CIO prefix
+  static warn(message: string, error?: unknown) {
     if (__DEV__) {
-      console.warn(this.loggerPrefix + message);
+      console.warn(this.loggerPrefix + message, error);
+    }
+  }
+
+  // Initializes native logger listener with error handling
+  static initNativeLogger() {
+    try {
+      NativeLoggerListener.initialize();
+    } catch (error) {
+      NativeLoggerListener.warn('Failed to initialize native logger:', error);
     }
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`dependencies {`
`2`		`- implementation "io.customer.android:datapipelines:$cioAndroidSDKVersion"`
`3`		`- implementation "io.customer.android:messaging-push-fcm:$cioAndroidSDKVersion"`
`4`		`- implementation "io.customer.android:messaging-in-app:$cioAndroidSDKVersion"`
	`2`	`+ api "io.customer.android:datapipelines:$cioAndroidSDKVersion"`
	`3`	`+ api "io.customer.android:messaging-push-fcm:$cioAndroidSDKVersion"`
	`4`	`+ api "io.customer.android:messaging-in-app:$cioAndroidSDKVersion"`
`5`	`5`	`}`