Fdl/fixes issues parsing utm parameters from universal links (#10413)

cvlos · Cristian Avalos · web-flow · commit 6dfadd235a63 · 2022-11-01T20:08:35.000-07:00
* updates changelog

* updates code to fix missing utm parameters

* fixes missing utm_term and utm_content

* fixes unit tests

* fixes changelog

* fixes clang-format issues

* updates changelog

Co-authored-by: Cristian Avalos &lt;ceavalos@google.com&gt;
diff --git a/FirebaseDynamicLinks/CHANGELOG.md b/FirebaseDynamicLinks/CHANGELOG.md
@@ -1,3 +1,6 @@
+# Unreleased
+- [fixed] Fixes utm parameters not being returned to dynamic link when using universal links (#10341)
+
 # 10.0.0
 - [removed] Removed bare initializer from `DynamicLink`. (#10000)
 - [fixed] Added app.google (1p domain) support in FDL SDK which was missing.
diff --git a/FirebaseDynamicLinks/Sources/FIRDynamicLinkNetworking.m b/FirebaseDynamicLinks/Sources/FIRDynamicLinkNetworking.m
@@ -41,6 +41,8 @@
 static NSString *const kFDLAnalyticsDataSourceKey = @"utmSource";
 static NSString *const kFDLAnalyticsDataMediumKey = @"utmMedium";
 static NSString *const kFDLAnalyticsDataCampaignKey = @"utmCampaign";
+static NSString *const kFDLAnalyticsDataTermKey = @"utmTerm";
+static NSString *const kFDLAnalyticsDataContentKey = @"utmContent";
 static NSString *const kHeaderIosBundleIdentifier = @"X-Ios-Bundle-Identifier";
 static NSString *const kGenericErrorDomain = @"com.firebase.dynamicLinks";
 
@@ -171,9 +173,11 @@ - (void)resolveShortLink:(NSURL *)url
             NSString *utmSource = result[kFDLAnalyticsDataSourceKey];
             NSString *utmMedium = result[kFDLAnalyticsDataMediumKey];
             NSString *utmCampaign = result[kFDLAnalyticsDataCampaignKey];
-            resolvedURL = FIRDLDeepLinkURLWithInviteID(invitationIDString, deepLinkString,
-                                                       utmSource, utmMedium, utmCampaign, NO, nil,
-                                                       minAppVersion, self->_URLScheme, nil);
+            NSString *utmContent = result[kFDLAnalyticsDataContentKey];
+            NSString *utmTerm = result[kFDLAnalyticsDataTermKey];
+            resolvedURL = FIRDLDeepLinkURLWithInviteID(
+                invitationIDString, deepLinkString, utmSource, utmMedium, utmCampaign, utmContent,
+                utmTerm, NO, nil, minAppVersion, self->_URLScheme, nil);
           }
         }
         handler(resolvedURL, extractedError);
diff --git a/FirebaseDynamicLinks/Sources/FIRDynamicLinks.m b/FirebaseDynamicLinks/Sources/FIRDynamicLinks.m
@@ -417,10 +417,18 @@ - (nullable FIRDynamicLink *)dynamicLinkFromCustomSchemeURL:(NSURL *)url {
         NSString *urlString = parameters[kFIRDLParameterLink];
         NSURL *deepLinkURL = [NSURL URLWithString:urlString];
         if (deepLinkURL) {
-          FIRDynamicLink *dynamicLink = [[FIRDynamicLink alloc]
-              initWithParametersDictionary:@{kFIRDLParameterDeepLinkIdentifier : urlString}];
+          FIRDynamicLink *dynamicLink = [[FIRDynamicLink alloc] initWithParametersDictionary:@{
+            kFIRDLParameterDeepLinkIdentifier : urlString,
+            kFIRDLParameterCampaign : parameters[kFIRDLParameterCampaign] ?: [NSNull null],
+            kFIRDLParameterContent : parameters[kFIRDLParameterContent] ?: [NSNull null],
+            kFIRDLParameterMedium : parameters[kFIRDLParameterMedium] ?: [NSNull null],
+            kFIRDLParameterSource : parameters[kFIRDLParameterSource] ?: [NSNull null],
+            kFIRDLParameterTerm : parameters[kFIRDLParameterTerm] ?: [NSNull null],
+            kFIRDLParameterMinimumAppVersion : parameters[kFIRDLParameterMinimumAppVersion]
+                ?: [NSNull null],
+          }];
           dynamicLink.matchType = FIRDLMatchTypeUnique;
-          dynamicLink.minimumAppVersion = parameters[kFIRDLParameterMinimumAppVersion];
+
           // Call resolveShortLink:completion: to do logging.
           // TODO: Create dedicated logging function to prevent this.
           [self.dynamicLinkNetworking
diff --git a/FirebaseDynamicLinks/Sources/Utilities/FDLUtilities.h b/FirebaseDynamicLinks/Sources/Utilities/FDLUtilities.h
@@ -21,9 +21,11 @@ NS_ASSUME_NONNULL_BEGIN
 FOUNDATION_EXPORT NSString *const kFIRDLParameterDeepLinkIdentifier;
 FOUNDATION_EXPORT NSString *const kFIRDLParameterLink;
 FOUNDATION_EXPORT NSString *const kFIRDLParameterMinimumAppVersion;
-FOUNDATION_EXPORT NSString *const kFIRDLParameterSource;
-FOUNDATION_EXPORT NSString *const kFIRDLParameterMedium;
 FOUNDATION_EXPORT NSString *const kFIRDLParameterCampaign;
+FOUNDATION_EXPORT NSString *const kFIRDLParameterContent;
+FOUNDATION_EXPORT NSString *const kFIRDLParameterMedium;
+FOUNDATION_EXPORT NSString *const kFIRDLParameterTerm;
+FOUNDATION_EXPORT NSString *const kFIRDLParameterSource;
 FOUNDATION_EXPORT NSString *const kFIRDLParameterMatchType;
 FOUNDATION_EXPORT NSString *const kFIRDLParameterInviteId;
 FOUNDATION_EXPORT NSString *const kFIRDLParameterWeakMatchEndpoint;
@@ -79,6 +81,8 @@ NSURL *FIRDLDeepLinkURLWithInviteID(NSString *_Nullable inviteID,
                                     NSString *_Nullable utmSource,
                                     NSString *_Nullable utmMedium,
                                     NSString *_Nullable utmCampaign,
+                                    NSString *_Nullable utmContent,
+                                    NSString *_Nullable utmTerm,
                                     BOOL isWeakLink,
                                     NSString *_Nullable weakMatchEndpoint,
                                     NSString *_Nullable minAppVersion,
diff --git a/FirebaseDynamicLinks/Sources/Utilities/FDLUtilities.m b/FirebaseDynamicLinks/Sources/Utilities/FDLUtilities.m
@@ -27,9 +27,11 @@
 NSString *const kFIRDLParameterDeepLinkIdentifier = @"deep_link_id";
 NSString *const kFIRDLParameterLink = @"link";
 NSString *const kFIRDLParameterMinimumAppVersion = @"imv";
-NSString *const kFIRDLParameterSource = @"utm_source";
-NSString *const kFIRDLParameterMedium = @"utm_medium";
 NSString *const kFIRDLParameterCampaign = @"utm_campaign";
+NSString *const kFIRDLParameterContent = @"utm_content";
+NSString *const kFIRDLParameterMedium = @"utm_medium";
+NSString *const kFIRDLParameterSource = @"utm_source";
+NSString *const kFIRDLParameterTerm = @"utm_term";
 NSString *const kFIRDLParameterMatchType = @"match_type";
 NSString *const kFIRDLParameterInviteId = @"invitation_id";
 NSString *const kFIRDLParameterWeakMatchEndpoint = @"invitation_weakMatchEndpoint";
@@ -98,6 +100,8 @@
                                     NSString *_Nullable utmSource,
                                     NSString *_Nullable utmMedium,
                                     NSString *_Nullable utmCampaign,
+                                    NSString *_Nullable utmContent,
+                                    NSString *_Nullable utmTerm,
                                     BOOL isWeakLink,
                                     NSString *_Nullable weakMatchEndpoint,
                                     NSString *_Nullable minAppVersion,
@@ -122,6 +126,15 @@
   if (utmCampaign != nil) {
     queryDictionary[kFIRDLParameterCampaign] = utmCampaign;
   }
+
+  if (utmContent != nil) {
+    queryDictionary[kFIRDLParameterContent] = utmContent;
+  }
+
+  if (utmTerm != nil) {
+    queryDictionary[kFIRDLParameterTerm] = utmTerm;
+  }
+
   if (isWeakLink) {
     queryDictionary[kFIRDLParameterMatchType] = @"weak";
   } else {
diff --git a/FirebaseDynamicLinks/Tests/Unit/FIRDynamicLinksTest.m b/FirebaseDynamicLinks/Tests/Unit/FIRDynamicLinksTest.m
@@ -811,8 +811,8 @@ - (void)testDynamicLinkFromCustomSchemeURLReturnsDLWithNilMinimumVersion {
                                 apiKey:kAPIKey
                              urlScheme:kURLScheme
                           userDefaults:self.userDefaults];
-  NSURL *url = FIRDLDeepLinkURLWithInviteID(nil, kEncodedComplicatedURLString, nil, nil, nil, NO,
-                                            nil, nil, kURLScheme, nil);
+  NSURL *url = FIRDLDeepLinkURLWithInviteID(nil, kEncodedComplicatedURLString, nil, nil, nil, nil,
+                                            nil, NO, nil, nil, kURLScheme, nil);
   FIRDynamicLink *dynamicLink = [self.service dynamicLinkFromCustomSchemeURL:url];
 
   XCTAssertNil(dynamicLink.minimumAppVersion, @"Min app version was not nil when not set.");
@@ -825,8 +825,8 @@ - (void)testDynamicLinkFromCustomSchemeURLReturnsDLMinimumVersion {
                                 apiKey:kAPIKey
                              urlScheme:kURLScheme
                           userDefaults:self.userDefaults];
-  NSURL *url = FIRDLDeepLinkURLWithInviteID(nil, kEncodedComplicatedURLString, nil, nil, nil, NO,
-                                            nil, expectedMinVersion, kURLScheme, nil);
+  NSURL *url = FIRDLDeepLinkURLWithInviteID(nil, kEncodedComplicatedURLString, nil, nil, nil, nil,
+                                            nil, NO, nil, expectedMinVersion, kURLScheme, nil);
   FIRDynamicLink *dynamicLink = [self.service dynamicLinkFromCustomSchemeURL:url];
 
   NSString *minVersion = dynamicLink.minimumAppVersion;
@@ -841,8 +841,8 @@ - (void)testDynamicLinkFromUniversalLinkURLReturnsDLWithNilMinimumVersion {
                              urlScheme:kURLScheme
                           userDefaults:self.userDefaults];
 
-  NSURL *url = FIRDLDeepLinkURLWithInviteID(nil, kEncodedComplicatedURLString, nil, nil, nil, NO,
-                                            nil, nil, kURLScheme, nil);
+  NSURL *url = FIRDLDeepLinkURLWithInviteID(nil, kEncodedComplicatedURLString, nil, nil, nil, nil,
+                                            nil, NO, nil, nil, kURLScheme, nil);
 
   FIRDynamicLink *dynamicLink = [self.service dynamicLinkFromUniversalLinkURL:url];
 
@@ -857,8 +857,8 @@ - (void)testDynamicLinkFromUniversalLinkURLCompletionReturnsDLWithNilMinimumVers
                              urlScheme:kURLScheme
                           userDefaults:self.userDefaults];
 
-  NSURL *url = FIRDLDeepLinkURLWithInviteID(nil, kEncodedComplicatedURLString, nil, nil, nil, NO,
-                                            nil, nil, kURLScheme, nil);
+  NSURL *url = FIRDLDeepLinkURLWithInviteID(nil, kEncodedComplicatedURLString, nil, nil, nil, nil,
+                                            nil, NO, nil, nil, kURLScheme, nil);
 
   XCTestExpectation *expectation = [self expectationWithDescription:@"completion called"];
   [self.service
@@ -1478,6 +1478,8 @@ - (void)testRetrievalProcessResultURLContainsAllParametersPassedToDynamicLinkIni
     @"utm_campaign" : @"Maksym M Test",
     @"utm_medium" : @"test_medium",
     @"utm_source" : @"test_source",
+    @"utm_content" : @"test_content",
+    @"utm_term" : @"test_term",
     @"a_parameter" : @"a_value"
   };
 
diff --git a/FirebaseDynamicLinks/Tests/Unit/UtilitiesTests.m b/FirebaseDynamicLinks/Tests/Unit/UtilitiesTests.m
@@ -145,19 +145,22 @@ - (void)testDeepLinkURLWithInviteIDDeepLinkStringWeakMatchEndpointCreatesExpecte
   NSString *utmSource = @"firebase";
   NSString *utmMedium = @"email";
   NSString *utmCampaign = @"testCampaign";
+  NSString *utmTerm = @"testTerm";
+  NSString *utmContent = @"testContent";
   NSString *matchType = @"unique";
 
-  NSString *expectedURLString =
-      [NSString stringWithFormat:@"%@://google/link/?utm_campaign=%@"
-                                 @"&deep_link_id=%@&utm_medium=%@&invitation_weakMatchEndpoint=%@"
-                                 @"&utm_source=%@&invitation_id=%@&match_type=%@",
-                                 kURLScheme, utmCampaign, encodedDeepLinkString, utmMedium,
-                                 weakMatchEndpoint, utmSource, inviteID, matchType];
+  NSString *expectedURLString = [NSString
+      stringWithFormat:@"%@://google/link/?utm_campaign=%@"
+                       @"&deep_link_id=%@&utm_medium=%@&invitation_weakMatchEndpoint=%@"
+                       @"&utm_source=%@&invitation_id=%@&match_type=%@"
+                       @"&utm_content=%@&utm_term=%@",
+                       kURLScheme, utmCampaign, encodedDeepLinkString, utmMedium, weakMatchEndpoint,
+                       utmSource, inviteID, matchType, utmContent, utmTerm];
   NSURLComponents *expectedURLComponents = [NSURLComponents componentsWithString:expectedURLString];
 
-  NSURL *actualURL =
-      FIRDLDeepLinkURLWithInviteID(inviteID, deepLinkString, utmSource, utmMedium, utmCampaign, NO,
-                                   weakMatchEndpoint, nil, kURLScheme, nil);
+  NSURL *actualURL = FIRDLDeepLinkURLWithInviteID(inviteID, deepLinkString, utmSource, utmMedium,
+                                                  utmCampaign, utmContent, utmTerm, NO,
+                                                  weakMatchEndpoint, nil, kURLScheme, nil);
 
   NSURLComponents *actualURLComponents = [NSURLComponents componentsWithURL:actualURL
                                                     resolvingAgainstBaseURL:NO];
