feat(analytics, ios): add support for initiateOnDeviceConversionMeasurementWithPhoneNumber and initiateOnDeviceConversionMeasurementWithHashedEmailAddress (#12976)

Lyokone · web-flow · commit 1e25ec1e55d7 · 2024-06-25T16:18:15.000+02:00
* feat(analytics, ios): add support for initiateOnDeviceConversionMeasurementWithPhoneNumber and initiateOnDeviceConversionMeasurementWithHashedEmailAddress

* mocks
diff --git a/packages/firebase_analytics/firebase_analytics/example/ios/Runner.xcodeproj/project.pbxproj b/packages/firebase_analytics/firebase_analytics/example/ios/Runner.xcodeproj/project.pbxproj
@@ -169,7 +169,7 @@
 		97C146E61CF9000F007C117D /* Project object */ = {
 			isa = PBXProject;
 			attributes = {
-				LastUpgradeCheck = 1430;
+				LastUpgradeCheck = 1510;
 				ORGANIZATIONNAME = "The Chromium Authors";
 				TargetAttributes = {
 					97C146ED1CF9000F007C117D = {
diff --git a/packages/firebase_analytics/firebase_analytics/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/packages/firebase_analytics/firebase_analytics/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
diff --git a/packages/firebase_analytics/firebase_analytics/ios/Classes/FLTFirebaseAnalyticsPlugin.m b/packages/firebase_analytics/firebase_analytics/ios/Classes/FLTFirebaseAnalyticsPlugin.m
@@ -186,13 +186,23 @@ - (void)initiateOnDeviceConversionMeasurement:(id)arguments
                          withMethodCallResult:(FLTFirebaseMethodCallResult *)result {
   NSString *emailAddress = arguments[@"emailAddress"];
   NSString *phoneNumber = arguments[@"phoneNumber"];
+  NSString *hashedEmailAddress = arguments[@"hashedEmailAddress"];
+  NSString *hashedPhoneNumber = arguments[@"hashedPhoneNumber"];
 
   if (![emailAddress isKindOfClass:[NSNull class]]) {
     [FIRAnalytics initiateOnDeviceConversionMeasurementWithEmailAddress:emailAddress];
   }
   if (![phoneNumber isKindOfClass:[NSNull class]]) {
     [FIRAnalytics initiateOnDeviceConversionMeasurementWithPhoneNumber:phoneNumber];
   }
+  if (![hashedEmailAddress isKindOfClass:[NSNull class]]) {
+    NSData *data = [hashedEmailAddress dataUsingEncoding:NSUTF8StringEncoding];
+    [FIRAnalytics initiateOnDeviceConversionMeasurementWithHashedEmailAddress:data];
+  }
+  if (![hashedPhoneNumber isKindOfClass:[NSNull class]]) {
+    NSData *data = [hashedPhoneNumber dataUsingEncoding:NSUTF8StringEncoding];
+    [FIRAnalytics initiateOnDeviceConversionMeasurementWithHashedPhoneNumber:data];
+  }
   result.success(nil);
 }
 
diff --git a/packages/firebase_analytics/firebase_analytics/lib/src/firebase_analytics.dart b/packages/firebase_analytics/firebase_analytics/lib/src/firebase_analytics.dart
@@ -1292,6 +1292,40 @@ class FirebaseAnalytics extends FirebasePluginPlatform {
       phoneNumber: phoneNumber,
     );
   }
+
+  /// Initiates on-device conversion measurement given a sha256-hashed, UTF8 encoded, user email address.
+  /// Requires dependency GoogleAppMeasurementOnDeviceConversion to be linked in, otherwise it is a no-op.
+  ///
+  /// Only available on iOS.
+  Future<void> initiateOnDeviceConversionMeasurementWithHashedEmailAddress(
+    String hashedEmailAddress,
+  ) async {
+    if (defaultTargetPlatform != TargetPlatform.iOS) {
+      throw UnimplementedError(
+        'initiateOnDeviceConversionMeasurementWithHashedEmailAddress() is only supported on iOS.',
+      );
+    }
+    await _delegate.initiateOnDeviceConversionMeasurement(
+      hashedEmailAddress: hashedEmailAddress,
+    );
+  }
+
+  /// Initiates on-device conversion measurement given a sha256-hashed, UTF8 encoded, phone number in E.164 format.
+  /// Requires dependency GoogleAppMeasurementOnDeviceConversion to be linked in, otherwise it is a no-op.
+  ///
+  /// Only available on iOS.
+  Future<void> initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(
+    String hashedPhoneNumber,
+  ) async {
+    if (defaultTargetPlatform != TargetPlatform.iOS) {
+      throw UnimplementedError(
+        'initiateOnDeviceConversionMeasurementWithHashedPhoneNumber() is only supported on iOS.',
+      );
+    }
+    await _delegate.initiateOnDeviceConversionMeasurement(
+      hashedPhoneNumber: hashedPhoneNumber,
+    );
+  }
 }
 
 /// Creates a new map containing all of the key/value pairs from [parameters]
diff --git a/packages/firebase_analytics/firebase_analytics_platform_interface/lib/src/method_channel/method_channel_firebase_analytics.dart b/packages/firebase_analytics/firebase_analytics_platform_interface/lib/src/method_channel/method_channel_firebase_analytics.dart
@@ -214,13 +214,17 @@ class MethodChannelFirebaseAnalytics extends FirebaseAnalyticsPlatform {
   Future<void> initiateOnDeviceConversionMeasurement({
     String? emailAddress,
     String? phoneNumber,
+    String? hashedEmailAddress,
+    String? hashedPhoneNumber,
   }) {
     try {
       return channel.invokeMethod<void>(
         'Analytics#initiateOnDeviceConversionMeasurement',
         <String, String?>{
           'emailAddress': emailAddress,
           'phoneNumber': phoneNumber,
+          'hashedEmailAddress': hashedEmailAddress,
+          'hashedPhoneNumber': hashedPhoneNumber,
         },
       );
     } catch (e, s) {
diff --git a/packages/firebase_analytics/firebase_analytics_platform_interface/lib/src/platform_interface/platform_interface_firebase_analytics.dart b/packages/firebase_analytics/firebase_analytics_platform_interface/lib/src/platform_interface/platform_interface_firebase_analytics.dart
@@ -208,6 +208,8 @@ abstract class FirebaseAnalyticsPlatform extends PlatformInterface {
   Future<void> initiateOnDeviceConversionMeasurement({
     String? emailAddress,
     String? phoneNumber,
+    String? hashedEmailAddress,
+    String? hashedPhoneNumber,
   }) {
     throw UnimplementedError(
       'initiateOnDeviceConversionMeasurement() is not implemented',
diff --git a/packages/firebase_analytics/firebase_analytics_web/test/firebase_analytics_web_test.mocks.dart b/packages/firebase_analytics/firebase_analytics_web/test/firebase_analytics_web_test.mocks.dart
@@ -289,6 +289,8 @@ class MockFirebaseAnalyticsWeb extends _i1.Mock
   _i5.Future<void> initiateOnDeviceConversionMeasurement({
     String? emailAddress,
     String? phoneNumber,
+    String? hashedEmailAddress,
+    String? hashedPhoneNumber,
   }) =>
       (super.noSuchMethod(
         Invocation.method(
@@ -297,6 +299,8 @@ class MockFirebaseAnalyticsWeb extends _i1.Mock
           {
             #emailAddress: emailAddress,
             #phoneNumber: phoneNumber,
+            #hashedEmailAddress: hashedEmailAddress,
+            #hashedPhoneNumber: hashedPhoneNumber,
           },
         ),
         returnValue: _i5.Future<void>.value(),
