Merge branch 'master' into SDK-1329-SDK-layout-update

echo-branch · echo-branch · commit 6d52fb67d631 · 2023-02-01T17:25:43.000-08:00
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions" # Maintain dependencies for GitHub Actions
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -119,7 +119,7 @@ jobs:
           bundle config set --local path vendor
           bundle check || bundle install
       - name: Download build artifacts
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v3
       - name: Relocate checksum artifacts
         run: |
           cp framework/checksum carthage-files
diff --git a/Branch-TestBed/Branch-SDK-Tests/BNCPartnerParametersTests.m b/Branch-TestBed/Branch-SDK-Tests/BNCPartnerParametersTests.m
@@ -108,53 +108,76 @@ - (void)testJsonEmpty {
 }
 
 - (void)testJsonFBParameterEmpty {
-    [self.partnerParams addFaceBookParameterWithName:@"em" value:@""];
+    [self.partnerParams addFacebookParameterWithName:@"em" value:@""];
     NSString *jsonString = [self jsonStringFromDictionary:[self.partnerParams parameterJson]];
     XCTAssertTrue([@"{}" isEqualToString:jsonString]);
 }
 
 - (void)testJsonFBParameterShort {
-    [self.partnerParams addFaceBookParameterWithName:@"em" value:@"0123456789ABCDEF0123456789ABCDEF1234567890abcdef1234567890abcde"];
+    [self.partnerParams addFacebookParameterWithName:@"em" value:@"0123456789ABCDEF0123456789ABCDEF1234567890abcdef1234567890abcde"];
     NSString *jsonString = [self jsonStringFromDictionary:[self.partnerParams parameterJson]];
     XCTAssertTrue([@"{}" isEqualToString:jsonString]);
 }
 
 - (void)testJsonFBParameterPhoneNumberIsIgnored {
-    [self.partnerParams addFaceBookParameterWithName:@"em" value:@"1-555-555-5555"];
+    [self.partnerParams addFacebookParameterWithName:@"em" value:@"1-555-555-5555"];
     NSString *jsonString = [self jsonStringFromDictionary:[self.partnerParams parameterJson]];
     XCTAssertTrue([@"{}" isEqualToString:jsonString]);
 }
 
 - (void)testJsonFBParameterEmailIsIgnored {
-    [self.partnerParams addFaceBookParameterWithName:@"em" value:@"test@branch.io"];
+    [self.partnerParams addFacebookParameterWithName:@"em" value:@"test@branch.io"];
     NSString *jsonString = [self jsonStringFromDictionary:[self.partnerParams parameterJson]];
     XCTAssertTrue([@"{}" isEqualToString:jsonString]);
 }
 
 - (void)testJsonFBParameterBase64EncodedIsIgnored {
     // 123456789012345678901234567890123456789012345678 -> MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTIzNDU2Nzg5MDEyMzQ1Njc4
-    [self.partnerParams addFaceBookParameterWithName:@"em" value:@"MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTIzNDU2Nzg5MDEyMzQ1Njc4"];
+    [self.partnerParams addFacebookParameterWithName:@"em" value:@"MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTIzNDU2Nzg5MDEyMzQ1Njc4"];
     NSString *jsonString = [self jsonStringFromDictionary:[self.partnerParams parameterJson]];
     XCTAssertTrue([@"{}" isEqualToString:jsonString]);
 }
 
 - (void)testJsonFBParameterHashedValue {
-    [self.partnerParams addFaceBookParameterWithName:@"em" value:@"11234e56af071e9c79927651156bd7a10bca8ac34672aba121056e2698ee7088"];
+    [self.partnerParams addFacebookParameterWithName:@"em" value:@"11234e56af071e9c79927651156bd7a10bca8ac34672aba121056e2698ee7088"];
     NSString *jsonString = [self jsonStringFromDictionary:[self.partnerParams parameterJson]];
     XCTAssertTrue([@"{\"fb\":{\"em\":\"11234e56af071e9c79927651156bd7a10bca8ac34672aba121056e2698ee7088\"}}" isEqualToString:jsonString]);
 }
 
 - (void)testJsonFBParameterExample {
-    [self.partnerParams addFaceBookParameterWithName:@"em" value:@"11234e56af071e9c79927651156bd7a10bca8ac34672aba121056e2698ee7088"];
-    [self.partnerParams addFaceBookParameterWithName:@"ph" value:@"b90598b67534f00b1e3e68e8006631a40d24fba37a3a34e2b84922f1f0b3b29b"];
+    [self.partnerParams addFacebookParameterWithName:@"em" value:@"11234e56af071e9c79927651156bd7a10bca8ac34672aba121056e2698ee7088"];
+    [self.partnerParams addFacebookParameterWithName:@"ph" value:@"b90598b67534f00b1e3e68e8006631a40d24fba37a3a34e2b84922f1f0b3b29b"];
     NSString *jsonString = [self jsonStringFromDictionary:[self.partnerParams parameterJson]];
     
     XCTAssertTrue([@"{\"fb\":{\"ph\":\"b90598b67534f00b1e3e68e8006631a40d24fba37a3a34e2b84922f1f0b3b29b\",\"em\":\"11234e56af071e9c79927651156bd7a10bca8ac34672aba121056e2698ee7088\"}}" isEqualToString:jsonString]);
 }
 
-- (void)testJsonFBParameterClear {
-    [self.partnerParams addFaceBookParameterWithName:@"em" value:@"11234e56af071e9c79927651156bd7a10bca8ac34672aba121056e2698ee7088"];
-    [self.partnerParams addFaceBookParameterWithName:@"ph" value:@"b90598b67534f00b1e3e68e8006631a40d24fba37a3a34e2b84922f1f0b3b29b"];
+- (void)testJsonSnapParameterExample {
+    [self.partnerParams addSnapParameterWithName:@"hashed_email_address" value:@"11234e56af071e9c79927651156bd7a10bca8ac34672aba121056e2698ee7088"];
+    [self.partnerParams addSnapParameterWithName:@"hashed_phone_number" value:@"b90598b67534f00b1e3e68e8006631a40d24fba37a3a34e2b84922f1f0b3b29b"];
+    NSString *jsonString = [self jsonStringFromDictionary:[self.partnerParams parameterJson]];
+    
+    XCTAssertTrue([@"{\"snap\":{\"hashed_phone_number\":\"b90598b67534f00b1e3e68e8006631a40d24fba37a3a34e2b84922f1f0b3b29b\",\"hashed_email_address\":\"11234e56af071e9c79927651156bd7a10bca8ac34672aba121056e2698ee7088\"}}" isEqualToString:jsonString]);
+}
+
+
+- (void)testJsonMultipleParameterExample {
+    [self.partnerParams addFacebookParameterWithName:@"em" value:@"11234e56af071e9c79927651156bd7a10bca8ac34672aba121056e2698ee7088"];
+    [self.partnerParams addFacebookParameterWithName:@"ph" value:@"b90598b67534f00b1e3e68e8006631a40d24fba37a3a34e2b84922f1f0b3b29b"];
+    [self.partnerParams addSnapParameterWithName:@"hashed_email_address" value:@"11234e56af071e9c79927651156bd7a10bca8ac34672aba121056e2698ee7088"];
+    [self.partnerParams addSnapParameterWithName:@"hashed_phone_number" value:@"b90598b67534f00b1e3e68e8006631a40d24fba37a3a34e2b84922f1f0b3b29b"];
+    NSString *jsonString = [self jsonStringFromDictionary:[self.partnerParams parameterJson]];
+    
+    NSString *expectedJsonString = @"{\"snap\":{\"hashed_phone_number\":\"b90598b67534f00b1e3e68e8006631a40d24fba37a3a34e2b84922f1f0b3b29b\",\"hashed_email_address\":\"11234e56af071e9c79927651156bd7a10bca8ac34672aba121056e2698ee7088\"},\"fb\":{\"ph\":\"b90598b67534f00b1e3e68e8006631a40d24fba37a3a34e2b84922f1f0b3b29b\",\"em\":\"11234e56af071e9c79927651156bd7a10bca8ac34672aba121056e2698ee7088\"}}";
+    
+    XCTAssertTrue([expectedJsonString isEqualToString:jsonString]);
+}
+
+- (void)testParameterClear {
+    [self.partnerParams addFacebookParameterWithName:@"em" value:@"11234e56af071e9c79927651156bd7a10bca8ac34672aba121056e2698ee7088"];
+    [self.partnerParams addFacebookParameterWithName:@"ph" value:@"b90598b67534f00b1e3e68e8006631a40d24fba37a3a34e2b84922f1f0b3b29b"];
+    [self.partnerParams addSnapParameterWithName:@"hashed_email_address" value:@"11234e56af071e9c79927651156bd7a10bca8ac34672aba121056e2698ee7088"];
+    [self.partnerParams addSnapParameterWithName:@"hashed_phone_number" value:@"b90598b67534f00b1e3e68e8006631a40d24fba37a3a34e2b84922f1f0b3b29b"];
     [self.partnerParams clearAllParameters];
     
     NSString *jsonString = [self jsonStringFromDictionary:[self.partnerParams parameterJson]];
@@ -179,6 +202,8 @@ - (void)testSampleJson {
     XCTAssertTrue([@"{\"fb\":{\"ph\":\"b90598b67534f00b1e3e68e8006631a40d24fba37a3a34e2b84922f1f0b3b29b\",\"em\":\"11234e56af071e9c79927651156bd7a10bca8ac34672aba121056e2698ee7088\"}}" isEqualToString:jsonString]);
 }
 
+// There is an assumption that this code always results in the same string for the same json data.
+// This appears to be true, but I haven't found documentation to confirm it.
 - (NSString *)jsonStringFromDictionary:(NSDictionary *)dictionary {
     NSError *error;
     NSData *json = [NSJSONSerialization dataWithJSONObject:dictionary options:0 error:&error];
diff --git a/Branch-TestBed/Branch-SDK-Tests/BNCServerInterface.Test.m b/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_TIMESTAMP] 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];
diff --git a/Branch-TestBed/Branch-SDK-Tests/BranchEvent.Test.m b/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"];
diff --git a/BranchSDK/BNCPartnerParameters.h b/BranchSDK/BNCPartnerParameters.h
@@ -19,7 +19,11 @@ NS_ASSUME_NONNULL_BEGIN
 
 // FB partner parameters, see FB documentation for details
 // Values that do not look like a valid SHA-256 hash are ignored
-- (void)addFaceBookParameterWithName:(NSString *)name value:(NSString *)value;
+- (void)addFacebookParameterWithName:(NSString *)name value:(NSString *)value;
+
+// Snap partner parameters, see Snap documentation for details
+// Values that do not look like a valid SHA-256 hash are ignored
+- (void)addSnapParameterWithName:(NSString *)name value:(NSString *)value;
 
 - (void)clearAllParameters;
 
diff --git a/BranchSDK/BNCPartnerParameters.m b/BranchSDK/BNCPartnerParameters.m
@@ -7,6 +7,7 @@
 //
 
 #import "BNCPartnerParameters.h"
+#import "BNCLog.h"
 
 @interface BNCPartnerParameters()
 @property (nonatomic, strong, readwrite) NSMutableDictionary<NSString *, NSMutableDictionary<NSString *, NSString *> *> *parameters;
@@ -49,11 +50,19 @@ - (void)addParameterWithName:(NSString *)name value:(NSString *)value partnerNam
     [parametersForPartner setObject:value forKey:name];
 }
 
-- (void)addFaceBookParameterWithName:(NSString *)name value:(NSString *)value {
+- (void)addFacebookParameterWithName:(NSString *)name value:(NSString *)value {
     if ([self sha256HashSanityCheckValue:value]) {
         [self addParameterWithName:name value:value partnerName:@"fb"];
     } else {
-        // TODO: log a warning that the parameter looks invalid and will be ignored. Do not log the value as it may be PII that was inadvertently passed in.
+        BNCLogWarning(@"Partner parameter does not appear to be SHA256 hashed. Dropping the parameter.");
+    }
+}
+
+- (void)addSnapParameterWithName:(NSString *)name value:(NSString *)value {
+    if ([self sha256HashSanityCheckValue:value]) {
+        [self addParameterWithName:name value:value partnerName:@"snap"];
+    } else {
+        BNCLogWarning(@"Partner parameter does not appear to be SHA256 hashed. Dropping the parameter.");
     }
 }
 
diff --git a/BranchSDK/BNCServerInterface.m b/BranchSDK/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];
                 }
             }
         }
diff --git a/BranchSDK/Branch.h b/BranchSDK/Branch.h
@@ -719,6 +719,14 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
  */
 - (void)addFacebookPartnerParameterWithName:(NSString *)name value:(NSString *)value;
 
+/*
+ Add a Partner Parameter for Snap.
+ Once set, this parameter is attached to install, opens and events until cleared or the app restarts.
+ 
+ See Snap's documentation for details on valid parameters
+ */
+- (void)addSnapPartnerParameterWithName:(NSString *)name value:(NSString *)value;
+
 /**
  Clears all Partner Parameters
  */
diff --git a/BranchSDK/Branch.m b/BranchSDK/Branch.m
@@ -514,6 +514,8 @@ + (void)setTrackingDisabled:(BOOL)disabled {
         if (!!currentSetting == !!disabled)
             return;
         if (disabled) {
+            [[BNCPartnerParameters shared] clearAllParameters];
+            
             // Set the flag (which also clears the settings):
             [BNCPreferenceHelper sharedInstance].trackingDisabled = YES;
             Branch *branch = Branch.getInstance;
@@ -1024,7 +1026,15 @@ - (void)clearPartnerParameters {
 }
 
 - (void)addFacebookPartnerParameterWithName:(NSString *)name value:(NSString *)value {
-    [[BNCPartnerParameters shared] addFaceBookParameterWithName:name value:value];
+    if (![Branch trackingDisabled]) {
+        [[BNCPartnerParameters shared] addFacebookParameterWithName:name value:value];
+    }
+}
+
+- (void)addSnapPartnerParameterWithName:(NSString *)name value:(NSString *)value {
+    if (![Branch trackingDisabled]) {
+        [[BNCPartnerParameters shared] addSnapParameterWithName:name value:value];
+    }
 }
 
 #pragma mark - Pre-initialization support
diff --git a/BranchSDK/BranchConstants.h b/BranchSDK/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;
diff --git a/BranchSDK/BranchConstants.m b/BranchSDK/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";

Original file line number	Diff line number	Diff line change
`@@ -457,7 +457,7 @@ - (NSMutableDictionary )prepareParamDict:(NSDictionary )params`
`457`	`457`	`}`
`458`	`458`	`}`
`459`	`459`	`// For DOWNSTREAM EVENTS v2/events, include referrer_gbraid in request if available`
`460`		`- if([self.requestEndpoint containsString:@"/v2/event"]){`
	`460`	`+ if([self.requestEndpoint containsString:@"/v2/event"] \|\| [self.requestEndpoint containsString:@"/v1/open"]){`
`461`	`461`	`NSString *ref_gbraid = self.preferenceHelper.referrerGBRAID;`
`462`	`462`	`if ((ref_gbraid != nil) && (ref_gbraid.length > 0)) {`
`463`	`463`	`// Check if its valid or expired`
`@@ -468,6 +468,8 @@ - (NSMutableDictionary )prepareParamDict:(NSDictionary )params`
`468`	`468`	`NSDate *now = [NSDate date];`
`469`	`469`	`if ([now compare:expirationDate] == NSOrderedAscending) {`
`470`	`470`	`fullParamDict[BRANCH_REQUEST_KEY_REFERRER_GBRAID] = ref_gbraid;`
	`471`	`+ long long timestampInMilliSec = (long long)([initDate timeIntervalSince1970] * 1000.0);`
	`472`	`+ fullParamDict[BRANCH_REQUEST_KEY_REFERRER_GBRAID_TIMESTAMP] = [NSString stringWithFormat:@"%lld", timestampInMilliSec];`
`471`	`473`	`}`
`472`	`474`	`}`
`473`	`475`	`}`