@react-native-firebase/analytics 26.4.0 → 27.1.0

package/ios/RNFBAnalytics/RNFBAnalyticsHelper.m

@@ -0,0 +1,338 @@
+/**
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+#if __has_include(<Firebase/Firebase.h>)
+#import <Firebase/Firebase.h>
+#elif __has_include(<FirebaseAnalytics/FirebaseAnalytics.h>)
+#import <FirebaseAnalytics/FirebaseAnalytics.h>
+#import <FirebaseCore/FirebaseCore.h>
+#else
+@import FirebaseCore;
+@import FirebaseAnalytics;
+#endif
+
+#if __has_include(<RNFBAnalytics/RNFBAnalytics-Swift.h>)
+#import <RNFBAnalytics/RNFBAnalytics-Swift.h>
+#elif __has_include("RNFBAnalytics-Swift.h")
+#import "RNFBAnalytics-Swift.h"
+#elif __has_include("RNFBAnalyticsJavascriptParamsCleaner-Swift.inc")
+#import "RNFBAnalyticsJavascriptParamsCleaner-Swift.inc"
+#if __has_include("RNFBAnalytics/RNFBAnalyticsLogTransactionHostStub.h")
+#import "RNFBAnalytics/RNFBAnalyticsLogTransactionHostStub.h"
+#endif
+#else
+#error "RNFBAnalytics Swift interface not found"
+#endif
+
+#if __has_include(<RNFBApp/RNFBApp-Swift.h>)
+#import <RNFBApp/RNFBApp-Swift.h>
+#elif __has_include("RNFBApp-Swift.h")
+#import "RNFBApp-Swift.h"
+#elif __has_include("RNFBHandleMapStorage-Swift.inc")
+#import "RNFBHandleMapStorage-Swift.inc"
+#endif
+
+#import "RNFBAnalyticsHelper.h"
+#import "RNFBApp/RNFBSharedUtils.h"
+
+@implementation RNFBAnalyticsHelper
+
++ (NSDictionary *)decodedParams:(NSDictionary *)params {
+  return [RNFBNullSentinelDecoder decodeNullSentinels:params];
+}
+
++ (NSDictionary *)logEventParams:(NSDictionary *)params {
+  return [self dictionaryByDecodingAndOmittingNSNull:params];
+}
+
++ (NSDictionary *)decodedUserProperties:(NSDictionary *)properties {
+  return [self dictionaryByDecodingAndOmittingNSNull:properties];
+}
+
++ (NSDictionary *)dictionaryByDecodingAndOmittingNSNull:(NSDictionary *)params {
+  return [self dictionaryByOmittingNSNull:[RNFBNullSentinelDecoder decodeNullSentinels:params]];
+}
+
++ (NSDictionary *)dictionaryByOmittingNSNull:(id)decoded {
+  if (decoded == nil || decoded == [NSNull null]) {
+    return nil;
+  }
+  if (![decoded isKindOfClass:[NSDictionary class]]) {
+    return nil;
+  }
+  return [self valueByOmittingNSNull:decoded];
+}
+
++ (id)valueByOmittingNSNull:(id)value {
+  if (value == nil || value == [NSNull null]) {
+    return nil;
+  }
+  if ([value isKindOfClass:[NSDictionary class]]) {
+    NSDictionary *dict = (NSDictionary *)value;
+    NSMutableDictionary *normalized = [NSMutableDictionary dictionaryWithCapacity:dict.count];
+    for (id key in dict) {
+      id child = [self valueByOmittingNSNull:dict[key]];
+      if (child != nil) {
+        normalized[key] = child;
+      }
+    }
+    return normalized;
+  }
+  if ([value isKindOfClass:[NSArray class]]) {
+    NSArray *array = (NSArray *)value;
+    NSMutableArray *normalized = [NSMutableArray arrayWithCapacity:array.count];
+    for (id child in array) {
+      id processed = [self valueByOmittingNSNull:child];
+      if (processed != nil) {
+        [normalized addObject:processed];
+      }
+    }
+    return normalized;
+  }
+  return value;
+}
+
++ (void)logEvent:(NSString *)name
+          params:(NSDictionary *)params
+         resolve:(RCTPromiseResolveBlock)resolve
+          reject:(RCTPromiseRejectBlock)reject {
+  @try {
+    NSDictionary *decoded = [self logEventParams:params];
+    [FIRAnalytics
+        logEventWithName:name
+              parameters:[RNFBAnalyticsJavascriptParamsCleaner cleanJavascriptParams:decoded]];
+  } @catch (NSException *exception) {
+    return [RNFBSharedUtils rejectPromiseWithExceptionDict:reject exception:exception];
+  }
+
+  return resolve([NSNull null]);
+}
+
++ (void)setAnalyticsCollectionEnabled:(BOOL)enabled
+                              resolve:(RCTPromiseResolveBlock)resolve
+                               reject:(RCTPromiseRejectBlock)reject {
+  @try {
+    [FIRAnalytics setAnalyticsCollectionEnabled:enabled];
+  } @catch (NSException *exception) {
+    return [RNFBSharedUtils rejectPromiseWithExceptionDict:reject exception:exception];
+  }
+
+  return resolve([NSNull null]);
+}
+
++ (void)setUserId:(NSString *)userId
+          resolve:(RCTPromiseResolveBlock)resolve
+           reject:(RCTPromiseRejectBlock)reject {
+  @try {
+    [FIRAnalytics setUserID:[RNFBAnalyticsJavascriptParamsCleaner convertNSNullToNil:userId]];
+  } @catch (NSException *exception) {
+    return [RNFBSharedUtils rejectPromiseWithExceptionDict:reject exception:exception];
+  }
+  return resolve([NSNull null]);
+}
+
++ (void)setUserProperty:(NSString *)name
+                  value:(NSString *)value
+                resolve:(RCTPromiseResolveBlock)resolve
+                 reject:(RCTPromiseRejectBlock)reject {
+  @try {
+    [FIRAnalytics
+        setUserPropertyString:[RNFBAnalyticsJavascriptParamsCleaner convertNSNullToNil:value]
+                      forName:name];
+  } @catch (NSException *exception) {
+    return [RNFBSharedUtils rejectPromiseWithExceptionDict:reject exception:exception];
+  }
+  return resolve([NSNull null]);
+}
+
++ (void)setUserProperties:(NSDictionary *)properties
+                  resolve:(RCTPromiseResolveBlock)resolve
+                   reject:(RCTPromiseRejectBlock)reject {
+  @try {
+    // Seam omits NSNull keys (subscript → nil). Iterate the original keys so a cleared
+    // property still reaches setUserPropertyString:forName: (nil removes the property).
+    NSDictionary *decoded = [self decodedUserProperties:properties];
+    for (NSString *key in properties) {
+      [FIRAnalytics setUserPropertyString:decoded[key] forName:key];
+    }
+  } @catch (NSException *exception) {
+    return [RNFBSharedUtils rejectPromiseWithExceptionDict:reject exception:exception];
+  }
+  return resolve([NSNull null]);
+}
+
++ (void)resetAnalyticsData:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject {
+  @try {
+    [FIRAnalytics resetAnalyticsData];
+  } @catch (NSException *exception) {
+    return [RNFBSharedUtils rejectPromiseWithExceptionDict:reject exception:exception];
+  }
+  return resolve([NSNull null]);
+}
+
++ (void)setSessionTimeoutDuration:(double)milliseconds
+                          resolve:(RCTPromiseResolveBlock)resolve
+                           reject:(RCTPromiseRejectBlock)reject {
+  (void)reject;
+  [FIRAnalytics setSessionTimeoutInterval:milliseconds / 1000];
+  return resolve([NSNull null]);
+}
+
++ (void)getAppInstanceId:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject {
+  (void)reject;
+  return resolve([FIRAnalytics appInstanceID]);
+}
+
++ (void)getSessionId:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject {
+  (void)reject;
+  __block BOOL completed = NO;
+  const int64_t timeoutNs = (int64_t)(60 * NSEC_PER_SEC);
+
+  dispatch_after(dispatch_time(DISPATCH_TIME_NOW, timeoutNs), dispatch_get_main_queue(), ^{
+    if (completed) {
+      return;
+    }
+    completed = YES;
+    DLog(@"getSessionId timed_out: no SDK callback within 60 seconds");
+    resolve([NSNull null]);
+  });
+
+  [FIRAnalytics sessionIDWithCompletion:^(int64_t sessionID, NSError *_Nullable error) {
+    dispatch_async(dispatch_get_main_queue(), ^{
+      if (completed) {
+        return;
+      }
+      completed = YES;
+
+      // Occasionally sessionID is 0 despite nil error, treat as if it were an error
+      // https://github.com/firebase/firebase-ios-sdk/issues/15258
+      if (!error && sessionID == 0) {
+        DLog(@"getSessionId zero_without_error: sessionID=0 (firebase-ios-sdk#15258)");
+        return resolve([NSNull null]);
+      }
+
+      if (error) {
+        DLog(@"getSessionId sdk_error: domain=%@ code=%ld description=%@", error.domain,
+             (long)error.code, error.localizedDescription ?: @"(none)");
+        return resolve([NSNull null]);
+      }
+
+      DLog(@"getSessionId success: sessionID=%lld", sessionID);
+      return resolve([NSNumber numberWithLongLong:sessionID]);
+    });
+  }];
+}
+
++ (void)setDefaultEventParameters:(NSDictionary *)params
+                          resolve:(RCTPromiseResolveBlock)resolve
+                           reject:(RCTPromiseRejectBlock)reject {
+  @try {
+    NSDictionary *decoded = [self decodedParams:params];
+    [FIRAnalytics setDefaultEventParameters:[RNFBAnalyticsJavascriptParamsCleaner
+                                                cleanJavascriptParams:decoded]];
+  } @catch (NSException *exception) {
+    return [RNFBSharedUtils rejectPromiseWithExceptionDict:reject exception:exception];
+  }
+
+  return resolve([NSNull null]);
+}
+
++ (void)initiateOnDeviceConversionMeasurementWithEmailAddress:(NSString *)emailAddress
+                                                      resolve:(RCTPromiseResolveBlock)resolve
+                                                       reject:(RCTPromiseRejectBlock)reject {
+  @try {
+    [FIRAnalytics initiateOnDeviceConversionMeasurementWithEmailAddress:emailAddress];
+  } @catch (NSException *exception) {
+    return [RNFBSharedUtils rejectPromiseWithExceptionDict:reject exception:exception];
+  }
+
+  return resolve([NSNull null]);
+}
+
++ (void)initiateOnDeviceConversionMeasurementWithHashedEmailAddress:(NSString *)hashedEmailAddress
+                                                            resolve:(RCTPromiseResolveBlock)resolve
+                                                             reject:(RCTPromiseRejectBlock)reject {
+  @try {
+    NSData *emailAddress =
+        [RNFBAnalyticsJavascriptParamsCleaner dataFromSHA256HexString:hashedEmailAddress];
+    if (emailAddress == nil) {
+      reject(@"firebase_analytics", @"Expected a 64-character SHA-256 hex string", nil);
+      return;
+    }
+    [FIRAnalytics initiateOnDeviceConversionMeasurementWithHashedEmailAddress:emailAddress];
+  } @catch (NSException *exception) {
+    return [RNFBSharedUtils rejectPromiseWithExceptionDict:reject exception:exception];
+  }
+
+  return resolve([NSNull null]);
+}
+
++ (void)initiateOnDeviceConversionMeasurementWithPhoneNumber:(NSString *)phoneNumber
+                                                     resolve:(RCTPromiseResolveBlock)resolve
+                                                      reject:(RCTPromiseRejectBlock)reject {
+  @try {
+    [FIRAnalytics initiateOnDeviceConversionMeasurementWithPhoneNumber:phoneNumber];
+  } @catch (NSException *exception) {
+    return [RNFBSharedUtils rejectPromiseWithExceptionDict:reject exception:exception];
+  }
+
+  return resolve([NSNull null]);
+}
+
++ (void)initiateOnDeviceConversionMeasurementWithHashedPhoneNumber:(NSString *)hashedPhoneNumber
+                                                           resolve:(RCTPromiseResolveBlock)resolve
+                                                            reject:(RCTPromiseRejectBlock)reject {
+  @try {
+    NSData *phoneNumber =
+        [RNFBAnalyticsJavascriptParamsCleaner dataFromSHA256HexString:hashedPhoneNumber];
+    if (phoneNumber == nil) {
+      reject(@"firebase_analytics", @"Expected a 64-character SHA-256 hex string", nil);
+      return;
+    }
+    [FIRAnalytics initiateOnDeviceConversionMeasurementWithHashedPhoneNumber:phoneNumber];
+  } @catch (NSException *exception) {
+    return [RNFBSharedUtils rejectPromiseWithExceptionDict:reject exception:exception];
+  }
+
+  return resolve([NSNull null]);
+}
+
++ (void)logTransaction:(NSString *)transactionId
+               resolve:(RCTPromiseResolveBlock)resolve
+                reject:(RCTPromiseRejectBlock)reject {
+  if (@available(iOS 15.0, macOS 12.0, *)) {
+    RNFBAnalyticsLogTransaction *handler = [[RNFBAnalyticsLogTransaction alloc] init];
+    [handler logTransactionWithTransactionId:transactionId resolve:resolve reject:reject];
+  } else {
+    reject(@"firebase_analytics", @"logTransaction() is only supported on iOS 15.0 or newer", nil);
+  }
+}
+
++ (void)setConsent:(NSDictionary *)consentSettings
+           resolve:(RCTPromiseResolveBlock)resolve
+            reject:(RCTPromiseRejectBlock)reject {
+  @try {
+    NSDictionary *consent =
+        [RNFBAnalyticsConsentSettingsMapper consentDictionaryFromSettings:consentSettings];
+    [FIRAnalytics setConsent:consent];
+  } @catch (NSException *exception) {
+    return [RNFBSharedUtils rejectPromiseWithExceptionDict:reject exception:exception];
+  }
+  return resolve([NSNull null]);
+}
+
+@end

package/ios/RNFBAnalytics/RNFBAnalyticsJavascriptParamsCleaner.swift

@@ -0,0 +1,167 @@
+/**
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import Foundation
+
+/**
+ * Foundation-friendly Analytics JS param helpers previously inlined in
+ * `RNFBAnalyticsModule.mm`.
+ *
+ * Pre-port contracts:
+ * - NSNull over the bridge → nil (`convertNSNullToNil`)
+ * - 64 hex chars → 32-byte `Data` or nil (`dataFromSHA256HexString`)
+ * - Long-numeric GA4 keys coerced via `integerValue`
+ * - `success` string/bool coercion to 0/1 `NSNumber`
+ * - `extend_session` `@1` → `@YES`
+ *
+ * Parameter key strings match Firebase Analytics `kFIRParameter*` values
+ * (Foundation-only so unit tests do not link the Analytics SDK).
+ */
+@objc(RNFBAnalyticsJavascriptParamsCleaner)
+public final class RNFBAnalyticsJavascriptParamsCleaner: NSObject {
+  // MARK: - Firebase Analytics parameter key strings (kFIRParameter*)
+
+  private static let parameterQuantity = "quantity"
+  private static let parameterIndex = "index"
+  private static let parameterLevel = "level"
+  private static let parameterNumberOfNights = "number_of_nights"
+  private static let parameterNumberOfPassengers = "number_of_passengers"
+  private static let parameterNumberOfRooms = "number_of_rooms"
+  private static let parameterScore = "score"
+  private static let parameterItems = "items"
+  private static let parameterSuccess = "success"
+  private static let parameterExtendSession = "extend_session"
+
+  /// Same keys as pre-port `RNFBAnalyticsLongNumericParameterKeys`.
+  @objc public static var longNumericParameterKeys: [String] {
+    [
+      parameterQuantity,
+      parameterIndex,
+      parameterLevel,
+      parameterNumberOfNights,
+      parameterNumberOfPassengers,
+      parameterNumberOfRooms,
+      parameterScore,
+    ]
+  }
+
+  // MARK: - NSNull bridge
+
+  /// Converts null values received over the bridge from NSNull to nil.
+  @objc(convertNSNullToNil:)
+  public static func convertNSNullToNil(_ value: Any?) -> String? {
+    // Pre-port: `[value isEqual:[NSNull null]] ? nil : value`
+    if let value, (value as AnyObject).isEqual(NSNull()) {
+      return nil
+    }
+    return value as? String
+  }
+
+  // MARK: - SHA-256 hex
+
+  private static func hexDigit(_ character: unichar) -> Int {
+    if character >= 0x30 && character <= 0x39 {
+      return Int(character) - 0x30
+    }
+    if character >= 0x61 && character <= 0x66 {
+      return Int(character) - 0x61 + 10
+    }
+    if character >= 0x41 && character <= 0x46 {
+      return Int(character) - 0x41 + 10
+    }
+    return -1
+  }
+
+  /// 64 hex characters → 32-byte `Data`, or nil when length/hex is invalid.
+  @objc(dataFromSHA256HexString:)
+  public static func dataFromSHA256HexString(_ hexString: String?) -> Data? {
+    guard let hexString, (hexString as NSString).length == 64 else {
+      return nil
+    }
+
+    var bytes = [UInt8](repeating: 0, count: 32)
+    let nsString = hexString as NSString
+    for i in 0..<32 {
+      let high = hexDigit(nsString.character(at: i * 2))
+      let low = hexDigit(nsString.character(at: i * 2 + 1))
+      if high < 0 || low < 0 {
+        return nil
+      }
+      bytes[i] = UInt8((high << 4) | low)
+    }
+    return Data(bytes)
+  }
+
+  // MARK: - JS params cleaning
+
+  @objc(cleanJavascriptParams:)
+  public static func cleanJavascriptParams(_ params: NSDictionary?) -> NSDictionary? {
+    guard let params else {
+      return nil
+    }
+    let newParams = NSMutableDictionary(dictionary: params)
+
+    if newParams[parameterItems] != nil {
+      let newItems = NSMutableArray()
+      let items = newParams[parameterItems] as! NSArray
+      items.enumerateObjects { obj, _, _ in
+        let item = (obj as AnyObject).mutableCopy() as! NSMutableDictionary
+        coerceLongNumericParameters(in: item)
+        newItems.add(item.copy())
+      }
+      newParams[parameterItems] = newItems.copy()
+    }
+
+    coerceLongNumericParameters(in: newParams)
+    coerceSuccessParameter(in: newParams)
+
+    if let extendSession = newParams.value(forKey: parameterExtendSession) as? NSNumber,
+      extendSession.isEqual(to: NSNumber(value: 1))
+    {
+      newParams[parameterExtendSession] = NSNumber(value: true)
+    }
+
+    return newParams.copy() as? NSDictionary
+  }
+
+  private static func coerceLongNumericParameters(in dict: NSMutableDictionary) {
+    for key in longNumericParameterKeys {
+      guard let value = dict[key], !(value is NSNull) else {
+        continue
+      }
+      // Pre-port: `dict[key] = @([value integerValue]);`
+      dict[key] = NSNumber(value: (value as AnyObject).integerValue)
+    }
+  }
+
+  private static func coerceSuccessParameter(in dict: NSMutableDictionary) {
+    guard let value = dict[parameterSuccess], !(value is NSNull) else {
+      return
+    }
+
+    var success = 0
+    if let string = value as? String {
+      let lower = string.lowercased()
+      if lower == "true" || lower == "yes" || lower == "1" {
+        success = 1
+      }
+    } else {
+      // Pre-port: `success = [value boolValue] ? 1 : 0;`
+      success = (value as AnyObject).boolValue ? 1 : 0
+    }
+    dict[parameterSuccess] = NSNumber(value: success)
+  }
+}