Merge pull request #1186 from BranchMetrics/SDK-1461-Updates-to-GBRAID-handling

SDK-1461 -- [iOS] Updates to GBRAID handling.

Author: nsingh-branch

Branch-SDK/BNCServerInterface.m

@@ -456,8 +456,8 @@ - (NSMutableDictionary *)prepareParamDict:(NSDictionary *)params
             fullParamDict[BRANCH_REQUEST_KEY_INSTRUMENTATION] = instrumentationDictionary;
         }
     }
-    // For DOWNSTREAM EVENTS v1/open & v2/events, include referrer_gbraid in request if available
-    if(([self.requestEndpoint containsString:@"/v1/open"]) || ([self.requestEndpoint containsString:@"/v2/event"])){
+    // For DOWNSTREAM EVENTS v2/events, include referrer_gbraid in request if available
+    if([self.requestEndpoint containsString:@"/v2/event"]){
         NSString *ref_gbraid = self.preferenceHelper.referrerGBRAID;
         if ((ref_gbraid != nil) && (ref_gbraid.length > 0))  {
             // Check if its valid or expired

Branch-SDK/BranchConstants.m

@@ -75,7 +75,7 @@
 NSString * const BRANCH_REQUEST_KEY_PARTNER_PARAMETERS = @"partner_data";
 
 NSString * const BRANCH_REQUEST_METADATA_KEY_SCANTIME_WINDOW = @"skan_time_window";
-NSString * const BRANCH_REQUEST_KEY_REFERRER_GBRAID = @"referrer_gbraid";
+NSString * const BRANCH_REQUEST_KEY_REFERRER_GBRAID = @"gbraid";
 
 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

@@ -10,12 +10,25 @@
 #import "BNCTestCase.h"
 #import "BNCServerInterface.h"
 #import "BNCPreferenceHelper.h"
+#import "BranchConstants.h"
 #import <OCMock/OCMock.h>
 #import <OHHTTPStubs/HTTPStubs.h>
 #import <OHHTTPStubs/HTTPStubsResponse+JSON.h>
 
 typedef void (^UrlConnectionCallback)(NSURLResponse *, NSData *, NSError *);
 
+@interface BNCServerInterface()
+
+// private BNCServerInterface method/properties to prepare dictionary for requests
+@property (copy, nonatomic) NSString *requestEndpoint;
+- (NSMutableDictionary *)prepareParamDict:(NSDictionary *)params
+                               key:(NSString *)key
+                       retryNumber:(NSInteger)retryNumber
+                              requestType:(NSString *)reqType;
+@end
+
+
+
 @interface BNCServerInterfaceTests : BNCTestCase
 @end
 
@@ -410,4 +423,50 @@ - (void)testRequestIdFromHeader {
     [self waitForExpectationsWithTimeout:1.0 handler:nil];
 }
 
+- (void) testServerInterfaceDictionaryPrepForGbraid {
+    
+    [HTTPStubs removeAllStubs];
+    
+    BNCServerInterface *serverInterface = [[BNCServerInterface alloc] init];
+    serverInterface.preferenceHelper = [BNCPreferenceHelper sharedInstance];
+    serverInterface.preferenceHelper.retryCount = 3;
+    serverInterface.requestEndpoint = @"/v2/event/standard";
+    
+    //Check - gbraid should not be present
+    NSMutableDictionary *result = [serverInterface prepareParamDict:NULL key:@"1234567890" retryNumber:3 requestType:@"POST"];
+    XCTAssertNil([result objectForKey:BRANCH_REQUEST_KEY_REFERRER_GBRAID]);
+    
+    [BNCPreferenceHelper sharedInstance].randomizedBundleToken = @"575759106028389737";
+ 
+    // Set referrerGBRAID and referrerGBRAIDInitDate
+    NSString *gbraidValue = @"CjwKCAiA3L6PBhBvEiwAINlJ9Chixm216y8kYYJ1K94dm4FEkOgFfhIdKQdjWsYB7FqE7rf_zkGNEhoCuIEQAvD_BwE";
+    [BNCPreferenceHelper sharedInstance].referrerGBRAID = gbraidValue;
+    NSDate *now = [NSDate date];
+    [BNCPreferenceHelper sharedInstance].referrerGBRAIDInitDate = now;
+    
+    //Check - gbraid should be present
+    result = [serverInterface prepareParamDict:NULL key:@"1234567890" retryNumber:3 requestType:@"POST"];
+    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
+    serverInterface.requestEndpoint = @"/v1/open";
+    result = [serverInterface prepareParamDict:NULL key:@"1234567890" retryNumber:3 requestType:@"POST"];
+    XCTAssertNil([result objectForKey:BRANCH_REQUEST_KEY_REFERRER_GBRAID]);
+    
+    //Check - gbraid should not be present - validity is expired
+    NSDate *pastDate = [[NSDate date] dateByAddingTimeInterval:-2592001];
+    [BNCPreferenceHelper sharedInstance].referrerGBRAIDInitDate = pastDate;
+    serverInterface.requestEndpoint = @"/v2/event/standard";
+    result = [serverInterface prepareParamDict:NULL key:@"1234567890" retryNumber:3 requestType:@"POST"];
+    XCTAssertNil([result objectForKey:BRANCH_REQUEST_KEY_REFERRER_GBRAID]);
+    
+    //Check - gbraid should be present. Date is reset
+    [BNCPreferenceHelper sharedInstance].referrerGBRAIDInitDate = now;
+    result = [serverInterface prepareParamDict:NULL key:@"1234567890" retryNumber:3 requestType:@"POST"];
+    XCTAssertNotNil([result objectForKey:BRANCH_REQUEST_KEY_REFERRER_GBRAID]);
+    XCTAssertTrue([[result objectForKey:BRANCH_REQUEST_KEY_REFERRER_GBRAID] isEqualToString:gbraidValue]);
+  
+}
+
 @end