Initial commit

nsingh-branch · nsingh-branch · commit b9a771f7d850 · 2023-03-09T17:41:26.000-08:00
diff --git a/Branch-TestBed/Branch-SDK-Tests/BNCReferringURLUtilityTests.m b/Branch-TestBed/Branch-SDK-Tests/BNCReferringURLUtilityTests.m
@@ -0,0 +1,33 @@
+//
+//  BNCReferringURLUtilityTests.m
+//  Branch-SDK-Tests
+//
+//  Created by Nipun Singh on 3/9/23.
+//  Copyright © 2023 Branch, Inc. All rights reserved.
+//
+
+#import <XCTest/XCTest.h>
+#import "BNCReferringURLUtility.h"
+
+@interface BNCReferringURLUtilityTests : XCTestCase
+
+@end
+
+@implementation BNCReferringURLUtilityTests
+
+- (void)setUp {
+    // Put setup code here. This method is called before the invocation of each test method in the class.
+}
+
+- (void)tearDown {
+    // Put teardown code here. This method is called after the invocation of each test method in the class.
+}
+
+- (void)testExample {
+    NSURL *url = [NSURL URLWithString:@"https://www.google.com?gbraid=a123&test=456"];
+    
+    BNCReferringURLUtility *utility = [BNCReferringURLUtility new];
+    [utility parseReferringURL:url];
+}
+
+@end
diff --git a/Branch-TestBed/Branch-TestBed.xcodeproj/project.pbxproj b/Branch-TestBed/Branch-TestBed.xcodeproj/project.pbxproj
@@ -274,6 +274,10 @@
 		C1614D56285BC8A00098946B /* LinkPresentation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = C1614D55285BC8A00098946B /* LinkPresentation.framework */; settings = {ATTRIBUTES = (Weak, ); }; };
 		C1614D5C285BD4AF0098946B /* BranchPluginSupport.h in Headers */ = {isa = PBXBuildFile; fileRef = C1614D5A285BD4AF0098946B /* BranchPluginSupport.h */; };
 		C1614D5D285BD4AF0098946B /* BranchPluginSupport.m in Sources */ = {isa = PBXBuildFile; fileRef = C1614D5B285BD4AF0098946B /* BranchPluginSupport.m */; };
+		C1CC887F29BAA06600BDD2B5 /* BNCReferringURLUtility.h in Headers */ = {isa = PBXBuildFile; fileRef = C1CC887D29BAA06600BDD2B5 /* BNCReferringURLUtility.h */; };
+		C1CC888029BAA06600BDD2B5 /* BNCReferringURLUtility.m in Sources */ = {isa = PBXBuildFile; fileRef = C1CC887E29BAA06600BDD2B5 /* BNCReferringURLUtility.m */; };
+		C1CC888229BAAFC000BDD2B5 /* BNCReferringURLUtilityTests.m in Sources */ = {isa = PBXBuildFile; fileRef = C1CC888129BAAFC000BDD2B5 /* BNCReferringURLUtilityTests.m */; };
+		C1CC888529BAB10D00BDD2B5 /* BNCReferringURLUtility.m in Sources */ = {isa = PBXBuildFile; fileRef = C1CC888329BAB0C600BDD2B5 /* BNCReferringURLUtility.m */; };
 		E2B9474A1D15D75000F2270D /* BNCCallbacks.h in Headers */ = {isa = PBXBuildFile; fileRef = E2B947491D15D73900F2270D /* BNCCallbacks.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		E72489D228E40D0200DCD8FD /* PasteControlViewController.m in Sources */ = {isa = PBXBuildFile; fileRef = E72489D128E40D0200DCD8FD /* PasteControlViewController.m */; };
 		E729974D28E2BBFA007D91B2 /* BranchPasteControl.h in Headers */ = {isa = PBXBuildFile; fileRef = E729974B28E2BBFA007D91B2 /* BranchPasteControl.h */; };
@@ -618,6 +622,11 @@
 		C1614D55285BC8A00098946B /* LinkPresentation.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = LinkPresentation.framework; path = System/Library/Frameworks/LinkPresentation.framework; sourceTree = SDKROOT; };
 		C1614D5A285BD4AF0098946B /* BranchPluginSupport.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = BranchPluginSupport.h; sourceTree = "<group>"; };
 		C1614D5B285BD4AF0098946B /* BranchPluginSupport.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = BranchPluginSupport.m; sourceTree = "<group>"; };
+		C1CC887D29BAA06600BDD2B5 /* BNCReferringURLUtility.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = BNCReferringURLUtility.h; sourceTree = "<group>"; };
+		C1CC887E29BAA06600BDD2B5 /* BNCReferringURLUtility.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = BNCReferringURLUtility.m; sourceTree = "<group>"; };
+		C1CC888129BAAFC000BDD2B5 /* BNCReferringURLUtilityTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = BNCReferringURLUtilityTests.m; sourceTree = "<group>"; };
+		C1CC888329BAB0C600BDD2B5 /* BNCReferringURLUtility.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = BNCReferringURLUtility.m; sourceTree = "<group>"; };
+		C1CC888429BAB0E300BDD2B5 /* BNCReferringURLUtility.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = BNCReferringURLUtility.h; sourceTree = "<group>"; };
 		D258D2C41A794D64004A1C90 /* BranchActivityItemProvider.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = BranchActivityItemProvider.h; sourceTree = "<group>"; };
 		D258D2C51A794D64004A1C90 /* BranchActivityItemProvider.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = BranchActivityItemProvider.m; sourceTree = "<group>"; };
 		E2B947491D15D73900F2270D /* BNCCallbacks.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = BNCCallbacks.h; sourceTree = "<group>"; };
@@ -768,6 +777,7 @@
 				5F2035CB240DDE90004FDC3E /* BNCDisableAdNetworkCalloutsTests.m */,
 				5FDB04F324E6156800F2F267 /* BNCSKAdNetworkTests.m */,
 				5FDF91582581CDF4009BE5A3 /* BNCPartnerParametersTests.m */,
+				C1CC888129BAAFC000BDD2B5 /* BNCReferringURLUtilityTests.m */,
 			);
 			path = "Branch-SDK-Tests";
 			sourceTree = "<group>";
@@ -913,6 +923,8 @@
 		670016BB1946309100A9E103 /* BranchSDK */ = {
 			isa = PBXGroup;
 			children = (
+				C1CC888429BAB0E300BDD2B5 /* BNCReferringURLUtility.h */,
+				C1CC888329BAB0C600BDD2B5 /* BNCReferringURLUtility.m */,
 				C12320B8280E2091007771C0 /* BranchQRCode.m */,
 				C12320B6280E2060007771C0 /* BranchQRCode.h */,
 				C1614D5A285BD4AF0098946B /* BranchPluginSupport.h */,
@@ -1071,6 +1083,8 @@
 				5FDF914425818280009BE5A3 /* BNCPartnerParameters.m */,
 				C10C61AB28248E5A00761D7E /* BNCQRCodeCache.h */,
 				C10C61AC28248E5A00761D7E /* BNCQRCodeCache.m */,
+				C1CC887D29BAA06600BDD2B5 /* BNCReferringURLUtility.h */,
+				C1CC887E29BAA06600BDD2B5 /* BNCReferringURLUtility.m */,
 			);
 			name = BranchSDK;
 			path = ../BranchSDK;
@@ -1113,6 +1127,7 @@
 				4DCAC8121F426F7C00405D1D /* BranchConstants.h in Headers */,
 				5F38022924DCC2E800E6FAFD /* BNCNetworkServiceProtocol.h in Headers */,
 				5F437E3D237E03C00052064B /* BNCDeviceSystem.h in Headers */,
+				C1CC887F29BAA06600BDD2B5 /* BNCReferringURLUtility.h in Headers */,
 				C12320B7280E2060007771C0 /* BranchQRCode.h in Headers */,
 				4DCAC8171F426F7C00405D1D /* BranchDeepLinkingController.h in Headers */,
 				5F892EB92360EFE90023AEC1 /* BNCAppleSearchAds.h in Headers */,
@@ -1425,6 +1440,7 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				C1CC888029BAA06600BDD2B5 /* BNCReferringURLUtility.m in Sources */,
 				C12320B9280E2091007771C0 /* BranchQRCode.m in Sources */,
 				5FDF914625818280009BE5A3 /* BNCPartnerParameters.m in Sources */,
 				5F38020F24DCC2E800E6FAFD /* BNCServerRequest.m in Sources */,
@@ -1535,6 +1551,7 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				C1CC888529BAB10D00BDD2B5 /* BNCReferringURLUtility.m in Sources */,
 				5F22AFC0240600A200837CF5 /* BNCCallbackMap.m in Sources */,
 				4D1683B72098C902008819E3 /* BNCTestCase.m in Sources */,
 				4D1683B82098C902008819E3 /* BNCEncodingUtils.Test.m in Sources */,
@@ -1558,6 +1575,7 @@
 				4D1683CA2098C902008819E3 /* BNCPreferenceHelperTests.m in Sources */,
 				4AB16368239E3A2700D42931 /* DispatchToIsolationQueueTests.m in Sources */,
 				5F8BB66E278771890055D2DC /* BNCKeyChainTests.m in Sources */,
+				C1CC888229BAAFC000BDD2B5 /* BNCReferringURLUtilityTests.m in Sources */,
 				5F892ECE23624E0A0023AEC1 /* BNCFacebookAppLinksTests.m in Sources */,
 				5FE694382405FA2700E3AEE2 /* BNCCallbackMapTests.m in Sources */,
 				5FDB04F424E6156800F2F267 /* BNCSKAdNetworkTests.m in Sources */,
diff --git a/BranchSDK/BNCPreferenceHelper.h b/BranchSDK/BNCPreferenceHelper.h
@@ -15,6 +15,8 @@
 #define FILE_NAME   [[NSString stringWithUTF8String:__FILE__] lastPathComponent]
 #define LINE_NUM    __LINE__
 
+
+
 NSURL* /* _Nonnull */ BNCURLForBranchDirectory(void);
 
 @interface BNCPreferenceHelper : NSObject
@@ -71,6 +73,7 @@ NSURL* /* _Nonnull */ BNCURLForBranchDirectory(void);
 @property (copy, nonatomic) NSString *referrerGBRAID;
 @property (assign, nonatomic) NSTimeInterval referrerGBRAIDValidityWindow;
 @property (strong, nonatomic) NSDate *referrerGBRAIDInitDate;
+@property (strong, nonatomic) NSMutableDictionary *referringURLQueryParameters;
 
 @property (assign, nonatomic) NSInteger skanCurrentWindow;
 @property (assign, nonatomic) NSInteger highestConversionValueSent;
diff --git a/BranchSDK/BNCPreferenceHelper.m b/BranchSDK/BNCPreferenceHelper.m
@@ -49,10 +49,13 @@
 static NSString * const BRANCH_PREFS_KEY_REFERRER_GBRAID = @"bnc_referrer_gbraid";
 static NSString * const BRANCH_PREFS_KEY_REFERRER_GBRAID_WINDOW = @"bnc_referrer_gbraid_window";
 static NSString * const BRANCH_PREFS_KEY_REFERRER_GBRAID_INIT_DATE = @"bnc_referrer_gbraid_init_date";
+static NSString * const BRANCH_PREFS_KEY_REFERRER_GCLID = @"bnc_referrer_gclid";
 static NSString * const BRANCH_PREFS_KEY_SKAN_CURRENT_WINDOW = @"bnc_skan_current_window";
 static NSString * const BRANCH_PREFS_KEY_FIRST_APP_LAUNCH_TIME = @"bnc_first_app_launch_time";
 static NSString * const BRANCH_PREFS_KEY_SKAN_HIGHEST_CONV_VALUE_SENT = @"bnc_skan_send_highest_conv_value";
 static NSString * const BRANCH_PREFS_KEY_SKAN_INVOKE_REGISTER_APP = @"bnc_invoke_register_app";
+                                                                
+static NSString * const BRANCH_PREFS_KEY_REFFERING_URL_QUERY_PARAMETERS = @"bnc_referring_url_query_parameters";
 
 NSURL* /* _Nonnull */ BNCURLForBranchDirectory_Unthreaded(void);
 
@@ -102,7 +105,8 @@ @implementation BNCPreferenceHelper
             referrerGBRAIDValidityWindow = _referrerGBRAIDValidityWindow,
             skanCurrentWindow = _skanCurrentWindow,
             firstAppLaunchTime = _firstAppLaunchTime,
-            highestConversionValueSent = _highestConversionValueSent;
+            highestConversionValueSent = _highestConversionValueSent,
+            referringURLQueryParameters = _referringURLQueryParameters;
 
 + (BNCPreferenceHelper *)sharedInstance {
     static BNCPreferenceHelper *preferenceHelper;
@@ -674,6 +678,14 @@ - (void)setSendCloseRequests:(BOOL)disabled {
     }
 }
 
+- (void)setReferringURLQueryParameters:(NSMutableDictionary *)parameter {
+
+}
+
+- (NSMutableDictionary *)referringURLQueryParameters {
+    return (NSMutableDictionary *)[self readObjectFromDefaults:BRANCH_PREFS_KEY_REFFERING_URL_QUERY_PARAMETERS];
+}
+
 - (NSString *) referrerGBRAID {
     @synchronized(self) {
         if (!_referrerGBRAID) {
diff --git a/BranchSDK/BNCReferringURLUtility.h b/BranchSDK/BNCReferringURLUtility.h
@@ -0,0 +1,26 @@
+//
+//  BNCReferringURLUtility.h
+//  Branch
+//
+//  Created by Nipun Singh on 3/9/23.
+//  Copyright © 2023 Branch, Inc. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+
+@interface BNCReferringURLUtility : NSObject
+
+//Parses the referring URL query parameters from a URL
+- (void)parseReferringURL:(NSURL *)url;
+
+//Convert the URL parameters to dictionary
+- (NSDictionary *)referringURLDictionary;
+
+- (NSDictionary *)getQueryParams(NSString *)event;
+
+@end
+
+NS_ASSUME_NONNULL_END
diff --git a/BranchSDK/BNCReferringURLUtility.m b/BranchSDK/BNCReferringURLUtility.m
@@ -0,0 +1,78 @@
+//
+//  BNCReferringURLUtility.m
+//  Branch
+//
+//  Created by Nipun Singh on 3/9/23.
+//  Copyright © 2023 Branch, Inc. All rights reserved.
+//
+
+#import "BNCReferringURLUtility.h"
+#import "BNCPreferenceHelper.h"
+
+//@interface BNCReferringURLQueryParameter: NSObject
+//
+//@property (copy, nonatomic) NSString *name;
+//@property (copy, nonatomic) NSString *value;
+//@property (assign, nonatomic) NSTimeInterval validityWindow;
+//@property (strong, nonatomic) NSDate *startDate;
+//
+//@end
+
+@interface BNCReferringURLUtility()
+
+@property (strong, readwrite, nonatomic) NSMutableDictionary<NSString *, NSMutableDictionary *> *urlQueryParameters;
+
+@end
+
+@implementation BNCReferringURLUtility
+
+- (instancetype)init {
+    self = [super init];
+    if (self) {
+        self.urlQueryParameters = [BNCPreferenceHelper sharedInstance].referringURLQueryParameters;
+        [self initializeURLQueryParameters];
+    }
+    
+    return self;
+}
+
+- (void)initializeURLQueryParameters {
+    self.urlQueryParameters = [NSMutableDictionary<NSString *, NSMutableDictionary *> new];
+   
+    //Don't init if it was loaded from disc
+    NSMutableDictionary *gbraid = [NSMutableDictionary new];
+    gbraid[@"name"] = @"gbraid";
+    gbraid[@"is_deeplink"] = [NSNumber numberWithBool:YES];
+    [self.urlQueryParameters setValue: gbraid forKey:@"gbraid"];
+    
+    NSMutableDictionary *gclid = [NSMutableDictionary new];
+    gbraid[@"name"] = @"gclid";
+    [self.urlQueryParameters setValue: gclid forKey:@"gclid"];
+    
+    //Consider how to load the existing gbraid
+}
+
+- (void)parseReferringURL:(NSURL *)url {
+    NSURLComponents *components = [NSURLComponents componentsWithURL:url resolvingAgainstBaseURL:NO];
+    for(NSURLQueryItem *item in components.queryItems){
+
+        NSMutableDictionary *param = self.urlQueryParameters[item.name];
+        if (param != nil) {
+            param[@"value"] = item.value;
+            param[@"initDate"] = [NSDate date];
+        }
+    }
+    
+    [BNCPreferenceHelper sharedInstance].referringURLQueryParameters = self.urlQueryParameters;
+}
+
+- (NSDictionary *)referringURLDictionary {
+    return [NSDictionary new];
+}
+
+- (NSDictionary *)getQueryParams {
+    //Get
+    return nil;
+}
+
+@end
diff --git a/BranchSDK/BNCServerInterface.m b/BranchSDK/BNCServerInterface.m
@@ -456,6 +456,9 @@ - (NSMutableDictionary *)prepareParamDict:(NSDictionary *)params
             fullParamDict[BRANCH_REQUEST_KEY_INSTRUMENTATION] = instrumentationDictionary;
         }
     }
+    
+    //utility getQueryParams(requestEndpoint) -> [Dictionary]
+    
     // For DOWNSTREAM EVENTS v2/events, include referrer_gbraid in request if available
     if([self.requestEndpoint containsString:@"/v2/event"] || [self.requestEndpoint containsString:@"/v1/open"]){
         NSString *ref_gbraid = self.preferenceHelper.referrerGBRAID;
@@ -469,7 +472,7 @@ - (NSMutableDictionary *)prepareParamDict:(NSDictionary *)params
                 if ([now compare:expirationDate] == NSOrderedAscending) {
                     fullParamDict[BRANCH_REQUEST_KEY_REFERRER_GBRAID] = ref_gbraid;
                     long long timestampInMilliSec = (long long)([initDate timeIntervalSince1970] * 1000.0);
-                    fullParamDict[BRANCH_REQUEST_KEY_REFERRER_GBRAID_TIMESTAMP] = [NSString stringWithFormat:@"%lld", timestampInMilliSec];
+                    //fullParamDict[BRANCH_REQUEST_KEY_REFERRER_GBRAID_TIMESTAMP] = [NSString stringWithFormat:@"%lld", timestampInMilliSec];
                 }
             }
         }
diff --git a/BranchSDK/Branch.m b/BranchSDK/Branch.m
@@ -711,6 +711,8 @@ - (BOOL)handleDeepLink:(NSURL *)url sceneIdentifier:(NSString *)sceneIdentifier
     // this allows foreground links to callback
     self.initializationStatus = BNCInitStatusUninitialized;
 
+    //ParseURL
+    
     //check the referring url/uri for query parameter gbraid
     NSURLComponents *components = [NSURLComponents componentsWithURL:url resolvingAgainstBaseURL:NO];
     NSString *gbraidValue = nil;
diff --git a/BranchSDK/BranchConstants.m b/BranchSDK/BranchConstants.m
@@ -77,6 +77,8 @@
 NSString * const BRANCH_REQUEST_METADATA_KEY_SCANTIME_WINDOW = @"skan_time_window";
 NSString * const BRANCH_REQUEST_KEY_REFERRER_GBRAID = @"gbraid";
 NSString * const BRANCH_REQUEST_KEY_REFERRER_GBRAID_TIMESTAMP = @"gbraid_timestamp";
+NSString * const BRANCH_REQUEST_KEY_GCLID = @"gclid";
+NSString * const BRANCH_REQUEST_KEY_IS_DEEPLINK_GBRAID = @"is_deeplink_gbraid";
 
 NSString * const BRANCH_REQUEST_ENDPOINT_SET_IDENTITY = @"profile";
 NSString * const BRANCH_REQUEST_ENDPOINT_APP_LINK_SETTINGS = @"app-link-settings";

Original file line number	Diff line number	Diff line change
`@@ -456,6 +456,9 @@ - (NSMutableDictionary )prepareParamDict:(NSDictionary )params`
`456`	`456`	`fullParamDict[BRANCH_REQUEST_KEY_INSTRUMENTATION] = instrumentationDictionary;`
`457`	`457`	`}`
`458`	`458`	`}`
	`459`	`+`
	`460`	`+ //utility getQueryParams(requestEndpoint) -> [Dictionary]`
	`461`	`+`
`459`	`462`	`// For DOWNSTREAM EVENTS v2/events, include referrer_gbraid in request if available`
`460`	`463`	`if([self.requestEndpoint containsString:@"/v2/event"] \|\| [self.requestEndpoint containsString:@"/v1/open"]){`
`461`	`464`	`NSString *ref_gbraid = self.preferenceHelper.referrerGBRAID;`
`@@ -469,7 +472,7 @@ - (NSMutableDictionary )prepareParamDict:(NSDictionary )params`
`469`	`472`	`if ([now compare:expirationDate] == NSOrderedAscending) {`
`470`	`473`	`fullParamDict[BRANCH_REQUEST_KEY_REFERRER_GBRAID] = ref_gbraid;`
`471`	`474`	`long long timestampInMilliSec = (long long)([initDate timeIntervalSince1970] * 1000.0);`
`472`		`- fullParamDict[BRANCH_REQUEST_KEY_REFERRER_GBRAID_TIMESTAMP] = [NSString stringWithFormat:@"%lld", timestampInMilliSec];`
	`475`	`+ //fullParamDict[BRANCH_REQUEST_KEY_REFERRER_GBRAID_TIMESTAMP] = [NSString stringWithFormat:@"%lld", timestampInMilliSec];`
`473`	`476`	`}`
`474`	`477`	`}`
`475`	`478`	`}`