Adding "utmParametersDictionary" api to FIRDynamicLink (#7505)

Adding "utmParametersDictionary" api to FIRDynamicLink.

This new property will enable 3p developers to fetch the Utm parameters associated with a Firebase Dynamic Link.

Related Issue: #6730

API Review Doc : https://docs.google.com/document/d/1NDBjiuCQEs3vnaPGfYKK2cdvJMIsJqukRtrZf8wsWCk (Approved)

Author: eldhosembabu

FIRDynamicLinkTest.m

@@ -0,0 +1,79 @@
+/*
+ * Copyright 2021 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file 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.h>
+#import <XCTest/XCTest.h>
+#import "FirebaseDynamicLinks/Sources/FIRDynamicLink+Private.h"
+
+@interface FIRDynamicLinkTest : XCTestCase {
+}
+@end
+
+@implementation FIRDynamicLinkTest
+
+NSMutableDictionary<NSString *, NSString *> *fdlParameters = nil;
+NSDictionary<NSString *, NSString *> *linkParameters = nil;
+NSDictionary<NSString *, NSString *> *utmParameters = nil;
+
+- (void)setUp {
+  [super setUp];
+
+  linkParameters = @{
+    @"deep_link_id" : @"https://mmaksym.com/test-app1",
+    @"match_message" : @"Link is uniquely matched for this device.",
+    @"match_type" : @"unique",
+    @"a_parameter" : @"a_value"
+  };
+  utmParameters = @{
+    @"utm_campaign" : @"eldhosembabu Test",
+    @"utm_medium" : @"test_medium",
+    @"utm_source" : @"test_source",
+  };
+
+  fdlParameters = [[NSMutableDictionary alloc] initWithDictionary:linkParameters];
+  [fdlParameters addEntriesFromDictionary:utmParameters];
+}
+
+- (void)testDynamicLinkParameters_InitWithParameters {
+  FIRDynamicLink *dynamicLink = [[FIRDynamicLink alloc] initWithParametersDictionary:fdlParameters];
+  XCTAssertEqual([fdlParameters count], [[dynamicLink parametersDictionary] count]);
+  for (NSString *key in fdlParameters) {
+    NSString *expectedValue = [fdlParameters valueForKey:key];
+    NSString *derivedValue = [[dynamicLink parametersDictionary] valueForKey:key];
+    XCTAssertNotNil(derivedValue, @"Cannot be null!");
+    XCTAssertEqualObjects(derivedValue, expectedValue);
+  }
+}
+
+- (void)testDynamicLinkUtmParameters_InitWithParameters {
+  FIRDynamicLink *dynamicLink = [[FIRDynamicLink alloc] initWithParametersDictionary:fdlParameters];
+  XCTAssertEqual([[dynamicLink utmParametersDictionary] count], [utmParameters count]);
+  for (NSString *key in utmParameters) {
+    NSString *expectedValue = [utmParameters valueForKey:key];
+    NSString *derivedValue = [[dynamicLink utmParametersDictionary] valueForKey:key];
+    XCTAssertNotNil(derivedValue, @"Cannot be null!");
+    XCTAssertEqualObjects(derivedValue, expectedValue);
+  }
+}
+
+- (void)testDynamicLinkParameters_InitWithNoUtmParameters {
+  FIRDynamicLink *dynamicLink =
+      [[FIRDynamicLink alloc] initWithParametersDictionary:linkParameters];
+  XCTAssertEqual([[dynamicLink parametersDictionary] count], [linkParameters count]);
+  XCTAssertEqual([[dynamicLink utmParametersDictionary] count], 0);
+}
+
+@end

FirebaseDynamicLinks/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v7.7.0
+- [added] Added `utmParametersDictionary` property to `DynamicLink`. (#6730)
+
 # v7.6.0
 - [fixed] Fixed build warnings introduced with Xcode 12.5. (#7434)
 

FirebaseDynamicLinks/Sources/FIRDynamicLink.m

@@ -23,6 +23,8 @@
 
 @implementation FIRDynamicLink
 
+NSString *const FDLUTMParamPrefix = @"utm_";
+
 - (NSString *)description {
   return [NSString stringWithFormat:@"<%@: %p, url [%@], match type: %@, minimumAppVersion: %@, "
                                      "match message: %@>",
@@ -36,7 +38,7 @@ - (instancetype)initWithParametersDictionary:(NSDictionary<NSString *, id> *)par
 
   if (self = [super init]) {
     _parametersDictionary = [parameters copy];
-
+    _utmParametersDictionary = [[self class] extractUTMParams:parameters];
     NSString *urlString = parameters[kFIRDLParameterDeepLinkIdentifier];
     _url = [NSURL URLWithString:urlString];
     _inviteId = parameters[kFIRDLParameterInviteId];
@@ -134,6 +136,18 @@ + (FIRDLMatchType)matchTypeWithString:(NSString *)string {
   return [matchMap[string] integerValue] ?: FIRDLMatchTypeNone;
 }
 
++ (NSDictionary<NSString *, id> *)extractUTMParams:(NSDictionary<NSString *, id> *)parameters {
+  NSMutableDictionary<NSString *, id> *utmParamsDictionary = [[NSMutableDictionary alloc] init];
+
+  for (NSString *key in parameters) {
+    if ([key hasPrefix:FDLUTMParamPrefix]) {
+      [utmParamsDictionary setObject:[parameters valueForKey:key] forKey:key];
+    }
+  }
+
+  return [[NSDictionary alloc] initWithDictionary:utmParamsDictionary];
+}
+
 @end
 
 #endif  // TARGET_OS_IOS

FirebaseDynamicLinks/Sources/Public/FirebaseDynamicLinks/FIRDynamicLink.h

@@ -67,6 +67,12 @@ NS_SWIFT_NAME(DynamicLink)
  */
 @property(nonatomic, assign, readonly) FIRDLMatchType matchType;
 
+/**
+ * @property utmParametersDictionary
+ * @abstract UTM parameters associated with a Firebase Dynamic Link.
+ */
+@property(nonatomic, copy, readonly) NSDictionary<NSString *, id> *utmParametersDictionary;
+
 /**
  * @property minimumAppVersion
  * @abstract The minimum iOS application version that supports the Dynamic Link. This is retrieved

FirebaseDynamicLinks/Tests/Sample/FDLBuilderTestAppObjC/AppDelegate.m

@@ -84,10 +84,12 @@ - (void)_showDynamicLinkInfo:(FIRDynamicLink *)dynamicLink {
 
   UIAlertController *alertVC = [UIAlertController
       alertControllerWithTitle:@"Got Dynamic Link!"
-                       message:[NSString stringWithFormat:
-                                             @"URL [%@], matchType [%ld], minimumAppVersion [%@]",
-                                             dynamicLink.url, (unsigned long)dynamicLink.matchType,
-                                             dynamicLink.minimumAppVersion]
+                       message:[NSString stringWithFormat:@"URL [%@], matchType [%ld], "
+                                                          @"minimumAppVersion [%@], utmParams [%@]",
+                                                          dynamicLink.url,
+                                                          (unsigned long)dynamicLink.matchType,
+                                                          dynamicLink.minimumAppVersion,
+                                                          dynamicLink.utmParametersDictionary]
                 preferredStyle:UIAlertControllerStyleAlert];
   [alertVC addAction:[UIAlertAction actionWithTitle:@"Dismiss"
                                               style:UIAlertActionStyleCancel

FirebaseDynamicLinks/Tests/Sample/FDLBuilderTestAppObjC/SceneDelegate.m

@@ -92,10 +92,12 @@ - (void)_showDynamicLinkInfo:(FIRDynamicLink *)dynamicLink {
 
   UIAlertController *alertVC = [UIAlertController
       alertControllerWithTitle:@"Got Dynamic Link!"
-                       message:[NSString stringWithFormat:
-                                             @"URL [%@], matchType [%ld], minimumAppVersion [%@]",
-                                             dynamicLink.url, (unsigned long)dynamicLink.matchType,
-                                             dynamicLink.minimumAppVersion]
+                       message:[NSString stringWithFormat:@"URL [%@], matchType [%ld], "
+                                                          @"minimumAppVersion [%@], utmParams [%@]",
+                                                          dynamicLink.url,
+                                                          (unsigned long)dynamicLink.matchType,
+                                                          dynamicLink.minimumAppVersion,
+                                                          dynamicLink.utmParametersDictionary]
                 preferredStyle:UIAlertControllerStyleAlert];
   [alertVC addAction:[UIAlertAction actionWithTitle:@"Dismiss"
                                               style:UIAlertActionStyleCancel