@osano/osano-cmp-react-native 0.13.0 → 0.15.0

package/README.dev.md

@@ -34,35 +34,229 @@ corepack yarn example android # or ios
 cd example && corepack yarn start android # or ios
 ```
 
-### Specifying run destination
+## Architecture Testing
 
-**iOS**
+This project supports testing for both React Native Legacy Architecture and New Architecture (TurboModules/Fabric). The testing framework provides automated testing across both architectures to ensure compatibility.
 
-`corepack yarn example ios --simulator "iPhone 15 Pro"`
+### Automated Architecture Testing
 
-**Android**
+The project includes a comprehensive testing framework that can automatically test both architectures without manual configuration changes.
 
-`// TODO`
+#### Available Test Commands
+
+**Basic Test Commands:**
+
+```bash
+# Run all tests (default - uses current architecture settings)
+yarn test
+
+# Run tests with Legacy Architecture
+yarn test:legacy
+
+# Run tests with New Architecture  
+yarn test:newarch
+```
+
+#### CI/CD Integration
+
+The project includes automated GitHub workflows that run comprehensive tests on all pull requests to the main branch.
+
+**GitHub Workflows:**
+
+- **Test Suite (`test.yml`)**: Automatically runs all tests for both Legacy and New Architecture when PRs are opened
+- **Build Validation (`build.yml`)**: Ensures the project builds successfully  
+- **Commit Validation (`validate-commits.yml`)**: Validates commit message format with Jira ticket IDs
+
+For manual CI/CD integration, you can run both architecture tests:
+
+```yaml
+# GitHub Actions example
+- name: Test Legacy Architecture
+  run: yarn test:legacy
+  
+- name: Test New Architecture  
+  run: yarn test:newarch
+```
+
+The automated workflow uses a matrix strategy to test both architectures in parallel, ensuring all tests pass before allowing PR merges.
+
+### Manual Architecture Testing (Example App)
+
+For manual testing of the example application with different architectures:
+
+#### Testing with Legacy Architecture (Default)
+
+The legacy architecture uses React Native's bridge system for native module communication.
+
+**Setup for Legacy Architecture:**
+
+1. **iOS Setup:**
+   ```shell
+   # Navigate to iOS example directory
+   cd example/ios
+   
+   # Edit Podfile to disable new architecture
+   # Comment out or remove this line:
+   # ENV['RCT_NEW_ARCH_ENABLED'] = '1'
+   
+   # Clean and reinstall pods
+   rm -rf Pods Podfile.lock
+   pod install
+   cd ../..
+   ```
+
+2. **Android Setup:**
+   ```shell
+   # Navigate to Android example directory
+   cd example/android
+   
+   # Edit gradle.properties to disable new architecture
+   # Add or modify:
+   newArchEnabled=false
+   
+   # Clean build
+   ./gradlew clean
+   cd ../..
+   ```
+
+3. **Run the app:**
+   ```shell
+   # iOS
+   corepack yarn example ios
+   
+   # Android
+   corepack yarn example android
+   ```
+
+#### Testing with New Architecture (TurboModules)
+
+The new architecture uses TurboModules for improved performance and type safety.
+
+**Setup for New Architecture:**
+
+1. **iOS Setup:**
+   ```shell
+   # Navigate to iOS example directory
+   cd example/ios
+   
+   # Edit Podfile to enable new architecture
+   # Add or uncomment this line:
+   ENV['RCT_NEW_ARCH_ENABLED'] = '1'
+   
+   # Clean and reinstall pods with new architecture
+   rm -rf Pods Podfile.lock
+   pod install
+   cd ../..
+   ```
+
+2. **Android Setup:**
+   ```shell
+   # Navigate to Android example directory
+   cd example/android
+   
+   # Edit gradle.properties to enable new architecture
+   # Add or modify:
+   newArchEnabled=true
+   
+   # Clean build
+   ./gradlew clean
+   cd ../..
+   ```
+
+3. **Rebuild the JavaScript bundle:**
+   ```shell
+   # Regenerate code for new architecture
+   corepack yarn prepare
+   ```
+
+4. **Run the app:**
+   ```shell
+   # iOS with new architecture
+   corepack yarn example ios
+   
+   # Android with new architecture  
+   corepack yarn example android
+   ```
+
+#### Quick Switch Scripts
+
+**Quick Switch Script (iOS):**
+
+```shell
+# Switch to Legacy
+cd example/ios
+sed -i '' "s/ENV\['RCT_NEW_ARCH_ENABLED'\] = '1'/# ENV['RCT_NEW_ARCH_ENABLED'] = '1'/" Podfile
+rm -rf Pods Podfile.lock && pod install && cd ../..
+
+# Switch to New Architecture  
+cd example/ios
+sed -i '' "s/# ENV\['RCT_NEW_ARCH_ENABLED'\] = '1'/ENV['RCT_NEW_ARCH_ENABLED'] = '1'/" Podfile
+rm -rf Pods Podfile.lock && pod install && cd ../..
+```
+
+**Quick Switch Script (Android):**
+
+```shell
+# Switch to Legacy
+cd example/android
+sed -i '' 's/newArchEnabled=true/newArchEnabled=false/' gradle.properties
+./gradlew clean && cd ../..
+
+# Switch to New Architecture
+cd example/android  
+sed -i '' 's/newArchEnabled=false/newArchEnabled=true/' gradle.properties
+./gradlew clean && cd ../..
+```
 
 ## Running Tests
 
-Testing should be done through both the example integration and the package itself.
+Testing should be done through both the example integration and the package itself. The project includes comprehensive architecture testing to ensure compatibility with both Legacy and New Architecture.
 
-### Testing the package
+### Architecture Testing
 
-1. From the `packages/osano-comp-react-native` folder run the following. This specifically runs the tests associated with the main package
+**Automated Testing Across Architectures:**
 
 ```shell
-npm test /src/__tests__
+# Test with Legacy Architecture only
+yarn test:legacy
+
+# Test with New Architecture only  
+yarn test:newarch
+
+# Test both architectures sequentially
+yarn test:both
+
+# Interactive test runner with comparison
+yarn run-arch-tests compare
+```
+
+#### Testing the Package
+
+1. **Run architecture-specific tests** from the root folder:
+
+```shell
+# Run all tests with current architecture
+yarn test
+
+# Run tests across both architectures
+yarn test:both
+```
+
+2. **Run all test files in the package** (including IAB tests):
+
+```shell
+yarn test
 ```
 
-1. In order to test all test files in the package, including IAB, run the following from the `packages/osano-comp-react-native` folder
+3. **Run specific test files:**
 
 ```shell
-npm test
+# Test specific file patterns
+yarn test src/__tests__/index.test.tsx
+yarn test src/services/__tests__/
 ```
 
-### Testing the examples
+### Testing the Examples
 
 #### Build the test applications from local builds
 
@@ -81,6 +275,25 @@ npm test
 
 Both files can be sent to coworkers with an ios simulator or android emulator to run for testing
 
+## Publishing
+
+When publishing to NPM, the package version is automatically incremented by 1. This ensures that each published version has a unique version number for proper semantic versioning.
+
+**Version Increment Examples:**
+- If the current `package.json` version is `0.14.0`, the NPM published version will be `0.15.0`
+
+**Publishing Process:**
+1. Create a pull request with your changes
+2. Once the PR is reviewed and merged to `main`, the GitHub Actions workflow automatically:
+   - Builds the package
+   - Publishes to NPM with the new version
+   - Creates a git tag with the new version
+
+**Important Notes:**
+- The version increment happens automatically during the `yarn release:prod` command
+- Manually update the version in `package.json` before creating your PR
+- Each merge to `main` results in a new NPM package version
+
 ## Troubleshooting
 
 1.  If the `run` command fails saying there is no development project, make sure to open the relevant simulator/emulator before running.
@@ -152,6 +365,18 @@ import { Osano, OsanoContext } from '@osano/osano-cmp-react-native'
 
 Note that the `configId` and `customerId` parameters are not optional, and must match the values of your configuration on the [Osano website](https://my.osano.com).
 
+To associate an external user identifier with the stored consent record, use `extUsrData`. This identifier is essential for
+[Cross-Device Consent](https://docs.osano.com/hc/en-us/articles/22472143433364-Cross-Domain-and-Cross-Device-Consent).
+
+By providing the same ID across devices and platforms (e.g., web and mobile), the SDK can look up and apply the user’s existing consent record, ensuring consistency across environments. For more internal details, see our [Cross-Device Consent Lookups documentation](https://osano.atlassian.net/wiki/spaces/CMPM/pages/604078081/Cross-Device+Consent+Lookups).
+
+> **_Important considerations_**
+>
+> - SDK behavior: All Osano SDKs will always record `extUsrData`. This is required for cross-device consent to function properly.
+> - Web CMP behavior: The Web CMP will not record `extUsrData` unless cross-device consent is explicitly enabled in your configuration. If cross-device consent is not enabled, the parameter will be ignored.
+>
+> Because of this distinction, developers should not expect extUsrData to have any effect in the Web CMP unless cross-device consent is turned on.
+
 #### Logging Configuration
 
 The SDK includes built-in logging for debugging. Use `setLoggingEnabled={__DEV__}` to enable logging in development and disable it in production. All logs are prefixed with `[OsanoSDK]`.

package/android/build.gradle

@@ -8,7 +8,7 @@ buildscript {
   }
 
   dependencies {
-    classpath "com.android.tools.build:gradle:7.2.1"
+    classpath "com.android.tools.build:gradle:7.4.2"
     // noinspection DifferentKotlinGradleVersion
     classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
   }

package/android/src/main/java/com/OsanoCMPSDK/OsanoCMPSDKModule.kt

@@ -4,110 +4,193 @@ import com.facebook.react.bridge.ReactApplicationContext
 import com.facebook.react.bridge.ReactContextBaseJavaModule
 import com.facebook.react.bridge.ReactMethod
 import com.facebook.react.bridge.Promise
+import com.facebook.react.module.annotations.ReactModule
 import android.content.Context
+import android.content.SharedPreferences
 import android.provider.Settings
 import android.preference.PreferenceManager
 import java.util.UUID
 
+@ReactModule(name = OsanoCMPSDKModule.NAME)
 class OsanoCMPSDKModule(reactContext: ReactApplicationContext) :
-  ReactContextBaseJavaModule(reactContext) {
+    ReactContextBaseJavaModule(reactContext) {
 
-  override fun getName(): String {
-    return NAME
-  }
+    // Lazy initialization for better performance
+    private val appContext: Context by lazy { reactApplicationContext.applicationContext }
+    private val sharedPreferences: SharedPreferences by lazy { 
+        appContext.getSharedPreferences(PREFERENCE_NAME, Context.MODE_PRIVATE) 
+    }
+    private val defaultSharedPreferences: SharedPreferences by lazy { 
+        PreferenceManager.getDefaultSharedPreferences(appContext) 
+    }
+
+    override fun getName(): String = NAME
 
-  @ReactMethod
+    @ReactMethod
     fun setStorage(key: String?, consentString: String?, promise: Promise) {
-        val appContext = this.reactApplicationContext.applicationContext
-        val sharedPreference =  appContext.getSharedPreferences("com.osano.cmp.sdk", Context.MODE_PRIVATE)
-        val editor = sharedPreference.edit()
-        editor.putString(key, consentString)
-        editor.apply()
-        promise.resolve(consentString)
+        executeStorageOperation(promise, "Failed to set storage") {
+            if (key.isNullOrBlank()) {
+                promise.reject(ERROR_INVALID_KEY, "Key cannot be null or empty")
+                return@executeStorageOperation
+            }
+            
+            sharedPreferences.edit()
+                .putString(key, consentString)
+                .apply()
+            promise.resolve(consentString)
+        }
     }
 
     @ReactMethod
     fun getStorage(key: String?, promise: Promise) {
-        val appContext = this.reactApplicationContext.applicationContext
-        val sharedPreference =  appContext.getSharedPreferences("com.osano.cmp.sdk", Context.MODE_PRIVATE)
-        val consentString = sharedPreference.getString(key, "")
-        promise.resolve(consentString)
+        executeStorageOperation(promise, "Failed to get storage") {
+            if (key.isNullOrBlank()) {
+                promise.reject(ERROR_INVALID_KEY, "Key cannot be null or empty")
+                return@executeStorageOperation
+            }
+            
+            val consentString = sharedPreferences.getString(key, "")
+            promise.resolve(consentString)
+        }
     }
 
     @ReactMethod
     fun clearStorage(key: String?, promise: Promise) {
-        val appContext = this.reactApplicationContext.applicationContext
-        val sharedPreference =  appContext.getSharedPreferences("com.osano.cmp.sdk", Context.MODE_PRIVATE)
-        val editor = sharedPreference.edit()
-        editor.remove(key)
-        editor.apply()
-        promise.resolve(null)
+        executeStorageOperation(promise, "Failed to clear storage") {
+            if (key.isNullOrBlank()) {
+                promise.reject(ERROR_INVALID_KEY, "Key cannot be null or empty")
+                return@executeStorageOperation
+            }
+            
+            sharedPreferences.edit()
+                .remove(key)
+                .apply()
+            promise.resolve(null)
+        }
     }
 
     @ReactMethod
     fun setStorageToDefault(key: String?, value: String?, promise: Promise) {
-        val appContext = this.reactApplicationContext.applicationContext
-        val defaultSharedPreferences = PreferenceManager.getDefaultSharedPreferences(appContext)
-        val editor = defaultSharedPreferences.edit()
-        editor.putString(key, value)
-        editor.apply()
-        promise.resolve(value)
+        executeStorageOperation(promise, "Failed to set default storage") {
+            if (key.isNullOrBlank()) {
+                promise.reject(ERROR_INVALID_KEY, "Key cannot be null or empty")
+                return@executeStorageOperation
+            }
+            
+            defaultSharedPreferences.edit()
+                .putString(key, value)
+                .apply()
+            promise.resolve(value)
+        }
     }
 
     @ReactMethod
     fun setIntStorageToDefault(key: String?, value: Int, promise: Promise) {
-        val appContext = this.reactApplicationContext.applicationContext
-        val defaultSharedPreferences = PreferenceManager.getDefaultSharedPreferences(appContext)
-        val editor = defaultSharedPreferences.edit()
-        editor.putInt(key, value)
-        editor.apply()
-        promise.resolve(value)
+        executeStorageOperation(promise, "Failed to set int default storage") {
+            if (key.isNullOrBlank()) {
+                promise.reject(ERROR_INVALID_KEY, "Key cannot be null or empty")
+                return@executeStorageOperation
+            }
+            
+            defaultSharedPreferences.edit()
+                .putInt(key, value)
+                .apply()
+            promise.resolve(value)
+        }
     }
 
     @ReactMethod
     fun setBoolStorageToDefault(key: String?, value: Boolean, promise: Promise) {
-        val appContext = this.reactApplicationContext.applicationContext
-        val defaultSharedPreferences = PreferenceManager.getDefaultSharedPreferences(appContext)
-        val editor = defaultSharedPreferences.edit()
-        editor.putBoolean(key, value)
-        editor.apply()
-        promise.resolve(value)
+        executeStorageOperation(promise, "Failed to set bool default storage") {
+            if (key.isNullOrBlank()) {
+                promise.reject(ERROR_INVALID_KEY, "Key cannot be null or empty")
+                return@executeStorageOperation
+            }
+            
+            defaultSharedPreferences.edit()
+                .putBoolean(key, value)
+                .apply()
+            promise.resolve(value)
+        }
     }
 
     @ReactMethod
     fun clearStorageFromDefault(key: String?, promise: Promise) {
-        val appContext = this.reactApplicationContext.applicationContext
-        val defaultSharedPreferences = PreferenceManager.getDefaultSharedPreferences(appContext)
-        val editor = defaultSharedPreferences.edit()
-        editor.remove(key)
-        editor.apply()
-        promise.resolve(null)
+        executeStorageOperation(promise, "Failed to clear default storage") {
+            if (key.isNullOrBlank()) {
+                promise.reject(ERROR_INVALID_KEY, "Key cannot be null or empty")
+                return@executeStorageOperation
+            }
+            
+            defaultSharedPreferences.edit()
+                .remove(key)
+                .apply()
+            promise.resolve(null)
+        }
     }
 
     @ReactMethod
     fun getDeviceId(promise: Promise) {
-        // Get a unique vendor ID for the android device
-        val appContext = this.reactApplicationContext.applicationContext
-        val sharedPreference =  appContext.getSharedPreferences("com.osano.cmp.sdk", Context.MODE_PRIVATE)
-        val uuid = sharedPreference.getString("uuid", null)
+        executeStorageOperation(promise, "Failed to get device ID") {
+            val deviceId = getOrCreateDeviceId()
+            promise.resolve(deviceId)
+        }
+    }
+
+    override fun getConstants(): MutableMap<String, Any> {
+        return try {
+            val appId = reactApplicationContext.packageName
+            val isOfficialSample = SAMPLE_APP_IDS.contains(appId)
+            hashMapOf("IS_OFFICIAL_SAMPLE" to isOfficialSample)
+        } catch (e: Exception) {
+            hashMapOf("IS_OFFICIAL_SAMPLE" to false)
+        }
+    }
+
+    // Private helper methods
+    private inline fun executeStorageOperation(
+        promise: Promise, 
+        errorMessage: String, 
+        operation: () -> Unit
+    ) {
+        try {
+            operation()
+        } catch (e: Exception) {
+            promise.reject(ERROR_STORAGE, "$errorMessage: ${e.message}", e)
+        }
+    }
+
+    private fun getOrCreateDeviceId(): String {
+        val storedUuid = sharedPreferences.getString(UUID_KEY, null)
         val androidId = Settings.Secure.getString(
-                this.reactApplicationContext.contentResolver,
-                Settings.Secure.ANDROID_ID
+            reactApplicationContext.contentResolver,
+            Settings.Secure.ANDROID_ID
         )
-        if (uuid === androidId) {
-            promise.resolve(uuid)
-        } else if (uuid != null && uuid != "") {
-            promise.resolve(uuid)
-        } else {
-            val uniqueID = UUID.randomUUID().toString()
-            val editor = sharedPreference.edit()
-            editor.putString("uuid", uniqueID)
-            editor.apply()
-            promise.resolve(uniqueID)
+        
+        return when {
+            storedUuid == androidId && storedUuid != null -> storedUuid
+            !storedUuid.isNullOrBlank() -> storedUuid
+            else -> {
+                val newUuid = UUID.randomUUID().toString()
+                sharedPreferences.edit()
+                    .putString(UUID_KEY, newUuid)
+                    .apply()
+                newUuid
+            }
         }
     }
 
-  companion object {
-    const val NAME = "OsanoCmpSdk"
-  }
+    companion object {
+        const val NAME = "OsanoCmpSdk"
+        
+        // Constants for better maintainability
+        private const val PREFERENCE_NAME = "com.osano.cmp.sdk"
+        private const val UUID_KEY = "uuid"
+        
+        // Error codes
+        private const val ERROR_STORAGE = "STORAGE_ERROR"
+        private const val ERROR_INVALID_KEY = "INVALID_KEY_ERROR"
+        
+        private val SAMPLE_APP_IDS = setOf("com.OsanoCMPExample")
+    }
 }

package/android/src/main/java/com/OsanoCMPSDK/OsanoCMPSDKPackage.kt

@@ -5,7 +5,6 @@ import com.facebook.react.bridge.NativeModule
 import com.facebook.react.bridge.ReactApplicationContext
 import com.facebook.react.uimanager.ViewManager
 
-
 class OsanoCMPSDKPackage : ReactPackage {
   override fun createNativeModules(reactContext: ReactApplicationContext): List<NativeModule> {
     return listOf(OsanoCMPSDKModule(reactContext))

package/ios/OsanoCmpSDK.mm

@@ -1,8 +1,39 @@
 #import "OsanoCmpSdk.h"
+#import <Foundation/Foundation.h>
+#import <React/RCTBridgeModule.h>
+#import <UIKit/UIKit.h>
+#import <React/RCTLog.h>
+
+static NSArray<NSString *> *OCMSampleBundleIDs(void) {
+  static NSArray<NSString *> *ids;
+  static dispatch_once_t onceToken;
+  dispatch_once(&onceToken, ^{
+    ids = @[
+      @"org.reactjs.native.example.OsanoCMPExample"
+    ];
+  });
+  return ids;
+}
+
+static BOOL OCMIsOfficialSample(void) {
+  NSString *bundleID = [[NSBundle mainBundle] bundleIdentifier] ?: @"";
+  return [OCMSampleBundleIDs() containsObject:bundleID];
+}
 
 @implementation OsanoCmpSdk
+
 RCT_EXPORT_MODULE()
 
++ (BOOL)requiresMainQueueSetup { return YES; }
+
+- (NSDictionary *)constantsToExport
+{
+    BOOL isSample = OCMIsOfficialSample();
+    return @{
+        @"IS_OFFICIAL_SAMPLE": @(isSample),
+    };
+}
+
 RCT_EXPORT_METHOD(setStorage:(NSString *)key
                   val:(NSString *)value
                   res:(RCTPromiseResolveBlock)resolve
@@ -44,7 +75,7 @@ RCT_EXPORT_METHOD(setStorageToDefault:(NSString *)key
 }
 
 RCT_EXPORT_METHOD(setIntStorageToDefault:(NSString *)key
-                  val:(NSNumber *)value
+                  val:(nonnull NSNumber *)value
                   res:(RCTPromiseResolveBlock)resolve
                   rej:(RCTPromiseRejectBlock)reject
 ) {
@@ -55,7 +86,7 @@ RCT_EXPORT_METHOD(setIntStorageToDefault:(NSString *)key
 }
 
 RCT_EXPORT_METHOD(setBoolStorageToDefault:(NSString *)key
-                  val:(NSNumber *)value
+                  val:(nonnull NSNumber *)value
                   res:(RCTPromiseResolveBlock)resolve
                   rej:(RCTPromiseRejectBlock)reject
 ) {
@@ -81,5 +112,4 @@ RCT_EXPORT_METHOD(getDeviceId:(RCTPromiseResolveBlock)resolve
     resolve(uuid);
 }
 
-
 @end

package/ios/OsanoCmpSdk.h

@@ -1,12 +1,5 @@
-
-#ifdef RCT_NEW_ARCH_ENABLED
-#import "RNOsanoCmpSdkSpec.h"
-
-@interface OsanoCmpSdk : NSObject <NativeOsanoCmpSdkSpec>
-#else
 #import <React/RCTBridgeModule.h>
 
 @interface OsanoCmpSdk : NSObject <RCTBridgeModule>
-#endif
 
 @end