SDK - 1758 - Added gbraid_timestamp on v1/open and v2/event. Updated Unit test cases to include gbraid params.

Author: NidhiDixit09

Branch-SDK/BNCServerInterface.m

@@ -457,7 +457,7 @@ - (NSMutableDictionary *)prepareParamDict:(NSDictionary *)params
         }
     }
     // For DOWNSTREAM EVENTS v2/events, include referrer_gbraid in request if available
-    if([self.requestEndpoint containsString:@"/v2/event"]){
+    if([self.requestEndpoint containsString:@"/v2/event"] || [self.requestEndpoint containsString:@"/v1/open"]){
         NSString *ref_gbraid = self.preferenceHelper.referrerGBRAID;
         if ((ref_gbraid != nil) && (ref_gbraid.length > 0))  {
             // Check if its valid or expired
@@ -468,6 +468,8 @@ - (NSMutableDictionary *)prepareParamDict:(NSDictionary *)params
                 NSDate *now = [NSDate date];
                 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];
                 }
             }
         }

Branch-SDK/BranchConstants.h

@@ -81,6 +81,7 @@ extern NSString * const BRANCH_REQUEST_KEY_PARTNER_PARAMETERS;
 
 extern NSString * const BRANCH_REQUEST_METADATA_KEY_SCANTIME_WINDOW;
 extern NSString * const BRANCH_REQUEST_KEY_REFERRER_GBRAID;
+extern NSString * const BRANCH_REQUEST_KEY_REFERRER_GBRAID_TIMESTAMP;
 
 extern NSString * const BRANCH_REQUEST_ENDPOINT_SET_IDENTITY;
 extern NSString * const BRANCH_REQUEST_ENDPOINT_APP_LINK_SETTINGS;

Branch-SDK/BranchConstants.m

@@ -76,6 +76,7 @@
 
 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_ENDPOINT_SET_IDENTITY = @"profile";
 NSString * const BRANCH_REQUEST_ENDPOINT_APP_LINK_SETTINGS = @"app-link-settings";

Branch-TestBed/Branch-SDK-Tests/BNCServerInterface.Test.m

@@ -445,10 +445,15 @@ - (void) testServerInterfaceDictionaryPrepForGbraid {
     XCTAssertNotNil([result objectForKey:BRANCH_REQUEST_KEY_REFERRER_GBRAID]);
     XCTAssertTrue([[result objectForKey:BRANCH_REQUEST_KEY_REFERRER_GBRAID] isEqualToString:gbraidValue]);
 
-    //Check - gbraid should not be present - endpoint is open
+    // Check for gbraid timestamp
+    XCTAssertNotNil([result objectForKey:BRANCH_REQUEST_KEY_REFERRER_GBRAID_TIMESTAMP]);
+    NSString *tsInMs = [NSString stringWithFormat:@"%lld", (long long)[now timeIntervalSince1970]*1000];
+    XCTAssertTrue([[result objectForKey:BRANCH_REQUEST_KEY_REFERRER_GBRAID] isEqualToString:tsInMs]);
+
+    //Check - gbraid should  be present - endpoint is open
     serverInterface.requestEndpoint = @"/v1/open";
     result = [serverInterface prepareParamDict:NULL key:@"1234567890" retryNumber:3 requestType:@"POST"];
-    XCTAssertNil([result objectForKey:BRANCH_REQUEST_KEY_REFERRER_GBRAID]);
+    XCTAssertNotNil([result objectForKey:BRANCH_REQUEST_KEY_REFERRER_GBRAID]);
 
     //Check - gbraid should not be present - validity is expired
     NSDate *pastDate = [[NSDate date] dateByAddingTimeInterval:-2592001];

Branch-TestBed/Branch-SDK-Tests/BranchEvent.Test.m

@@ -130,6 +130,22 @@ - (void) testEvent {
         [self mutableDictionaryFromBundleJSONWithKey:@"V2EventJSON"];
     expectedRequest[@"branch_key"] = Branch.branchKey;
     expectedRequest[@"user_data"] = [[BNCDeviceInfo getInstance] v2dictionary];
+    
+    // Add params for Gbraid
+    BNCPreferenceHelper *preferenceHelper = [BNCPreferenceHelper sharedInstance];
+    if(preferenceHelper.referrerGBRAID){
+        NSTimeInterval validityWindow = preferenceHelper.referrerGBRAIDValidityWindow;
+        if (validityWindow) {
+            NSDate *initDate = preferenceHelper.referrerGBRAIDInitDate ;
+            NSDate *expirationDate = [initDate dateByAddingTimeInterval:validityWindow];
+            NSDate *now = [NSDate date];
+            if ([now compare:expirationDate] == NSOrderedAscending) {
+                expectedRequest[BRANCH_REQUEST_KEY_REFERRER_GBRAID] = preferenceHelper.referrerGBRAID;
+                long long timestampInMilliSec = (long long)([initDate timeIntervalSince1970] * 1000.0);
+                expectedRequest[BRANCH_REQUEST_KEY_REFERRER_GBRAID_TIMESTAMP] = [NSString stringWithFormat:@"%lld", timestampInMilliSec];
+            }
+        }
+    }
 
     Branch *branch = [Branch getInstance:@"key_live_foo"];
     XCTestExpectation *expectation = [self expectationWithDescription:@"v2-event"];
@@ -180,6 +196,22 @@ - (void) testUserCompletedAction {
     expectedRequest[@"event_data"] = nil;
     expectedRequest[@"custom_data"] = nil;
     expectedRequest[@"customer_event_alias"] = nil;
+    
+    // Add params for Gbraid 
+    BNCPreferenceHelper *preferenceHelper = [BNCPreferenceHelper sharedInstance];
+    if(preferenceHelper.referrerGBRAID){
+        NSTimeInterval validityWindow = preferenceHelper.referrerGBRAIDValidityWindow;
+        if (validityWindow) {
+            NSDate *initDate = preferenceHelper.referrerGBRAIDInitDate ;
+            NSDate *expirationDate = [initDate dateByAddingTimeInterval:validityWindow];
+            NSDate *now = [NSDate date];
+            if ([now compare:expirationDate] == NSOrderedAscending) {
+                expectedRequest[BRANCH_REQUEST_KEY_REFERRER_GBRAID] = preferenceHelper.referrerGBRAID;
+                long long timestampInMilliSec = (long long)([initDate timeIntervalSince1970] * 1000.0);
+                expectedRequest[BRANCH_REQUEST_KEY_REFERRER_GBRAID_TIMESTAMP] = [NSString stringWithFormat:@"%lld", timestampInMilliSec];
+            }
+        }
+    }
 
     Branch *branch = [Branch getInstance:@"key_live_foo"];
     XCTestExpectation *expectation = [self expectationWithDescription:@"v2-event-user-action"];