Release 1.42.0

Author: nsingh-branch

Branch-SDK/BNCConfig.m

@@ -11,4 +11,4 @@
 NSString * const BNC_API_BASE_URL    = @"https://api2.branch.io";
 NSString * const BNC_API_VERSION     = @"v1";
 NSString * const BNC_LINK_URL        = @"https://bnc.lt";
-NSString * const BNC_SDK_VERSION     = @"1.41.0";
+NSString * const BNC_SDK_VERSION     = @"1.42.0";

Branch-SDK/BNCPreferenceHelper.h

@@ -66,6 +66,11 @@ NSURL* /* _Nonnull */ BNCURLForBranchDirectory(void);
 @property (assign, nonatomic) BOOL sendCloseRequests;
 
 @property (assign, nonatomic) BOOL trackingDisabled;
+
+@property (copy, nonatomic) NSString *referrerGBRAID;
+@property (assign, nonatomic) NSTimeInterval referrerGBRAIDValidityWindow;
+@property (strong, nonatomic) NSDate *referrerGBRAIDInitDate;
+
 - (void) clearTrackingInformation;
 
 + (BNCPreferenceHelper *)sharedInstance;

Branch-SDK/BNCPreferenceHelper.m

@@ -17,6 +17,7 @@
 static const NSTimeInterval DEFAULT_TIMEOUT = 5.5;
 static const NSTimeInterval DEFAULT_RETRY_INTERVAL = 0;
 static const NSInteger DEFAULT_RETRY_COUNT = 3;
+static const NSTimeInterval DEFAULT_REFERRER_GBRAID_WINDOW = 2592000; // 30 days = 2,592,000 seconds
 
 static NSString * const BRANCH_PREFS_FILE = @"BNCPreferences";
 
@@ -43,6 +44,9 @@
 static NSString * const BRANCH_PREFS_KEY_BRANCH_VIEW_USAGE_CNT = @"bnc_branch_view_usage_cnt_";
 static NSString * const BRANCH_PREFS_KEY_ANALYTICAL_DATA = @"bnc_branch_analytical_data";
 static NSString * const BRANCH_PREFS_KEY_ANALYTICS_MANIFEST = @"bnc_branch_analytics_manifest";
+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";
 
 NSURL* /* _Nonnull */ BNCURLForBranchDirectory_Unthreaded(void);
 
@@ -86,7 +90,9 @@ @implementation BNCPreferenceHelper
             checkedAppleSearchAdAttribution = _checkedAppleSearchAdAttribution,
             appleSearchAdDetails = _appleSearchAdDetails,
             requestMetadataDictionary = _requestMetadataDictionary,
-            instrumentationDictionary = _instrumentationDictionary;
+            instrumentationDictionary = _instrumentationDictionary,
+            referrerGBRAID = _referrerGBRAID,
+            referrerGBRAIDValidityWindow = _referrerGBRAIDValidityWindow;
 
 + (BNCPreferenceHelper *)sharedInstance {
     static BNCPreferenceHelper *preferenceHelper;
@@ -650,6 +656,53 @@ - (void)setSendCloseRequests:(BOOL)disabled {
     }
 }
 
+- (NSString *) referrerGBRAID {
+    @synchronized(self) {
+        if (!_referrerGBRAID) {
+            _referrerGBRAID = [self readStringFromDefaults:BRANCH_PREFS_KEY_REFERRER_GBRAID];
+        }
+        return _referrerGBRAID;
+    }
+}
+
+- (void) setReferrerGBRAID:(NSString *)referrerGBRAID {
+    if (![_referrerGBRAID isEqualToString:referrerGBRAID]) {
+        _referrerGBRAID = referrerGBRAID;
+        [self writeObjectToDefaults:BRANCH_PREFS_KEY_REFERRER_GBRAID value:referrerGBRAID];
+        self.referrerGBRAIDInitDate = [NSDate date];
+    }
+}
+
+- (NSTimeInterval) referrerGBRAIDValidityWindow {
+    @synchronized (self) {
+        _referrerGBRAIDValidityWindow = [self readDoubleFromDefaults:BRANCH_PREFS_KEY_REFERRER_GBRAID_WINDOW];
+        if (_referrerGBRAIDValidityWindow == NSNotFound) {
+            _referrerGBRAIDValidityWindow = DEFAULT_REFERRER_GBRAID_WINDOW;
+        }
+        return _referrerGBRAIDValidityWindow;
+    }
+}
+
+- (void) setReferrerGBRAIDValidityWindow:(NSTimeInterval)validityWindow {
+    @synchronized (self) {
+        [self writeObjectToDefaults:BRANCH_PREFS_KEY_REFERRER_GBRAID_WINDOW value:@(validityWindow)];
+    }
+}
+
+- (NSDate*) referrerGBRAIDInitDate {
+    @synchronized (self) {
+        NSDate* initdate = (NSDate*)[self readObjectFromDefaults:BRANCH_PREFS_KEY_REFERRER_GBRAID_INIT_DATE];
+        if ([initdate isKindOfClass:[NSDate class]]) return initdate;
+        return nil;
+    }
+}
+
+- (void)setReferrerGBRAIDInitDate:(NSDate *)initDate {
+    @synchronized (self) {
+        [self writeObjectToDefaults:BRANCH_PREFS_KEY_REFERRER_GBRAID_INIT_DATE value:initDate];
+    }
+}
+
 - (void) clearTrackingInformation {
     @synchronized(self) {
         /*
@@ -742,24 +795,10 @@ - (void)writeObjectToDefaults:(NSString *)key value:(NSObject *)value {
 - (void)persistPrefsToDisk {
     @synchronized (self) {
         if (!self.persistenceDict) return;
-        NSData *data = nil;
-        @try {
-            if (@available(iOS 11.0, tvOS 11.0, *)) {
-                data = [NSKeyedArchiver archivedDataWithRootObject:self.persistenceDict requiringSecureCoding:YES error:NULL];
-            } else {
-#if __IPHONE_OS_VERSION_MIN_REQUIRED < 12000
-                data = [NSKeyedArchiver archivedDataWithRootObject:self.persistenceDict];
-#endif
-            }
-        }
-        @catch (id exception) {
-            data = nil;
-            BNCLogWarning([NSString stringWithFormat:@"Exception creating preferences data: %@.", exception]);
-        }
-        if (!data) {
-            BNCLogWarning(@"Can't create preferences data.");
-            return;
-        }
+
+        NSData *data = [self serializePrefDict:self.persistenceDict];
+        if (!data) return;
+        
         NSURL *prefsURL = [self.class.URLForPrefsFile copy];
         NSBlockOperation *newPersistOp = [NSBlockOperation blockOperationWithBlock:^ {
             NSError *error = nil;
@@ -772,6 +811,24 @@ - (void)persistPrefsToDisk {
     }
 }
 
+- (NSData *)serializePrefDict:(NSMutableDictionary *)dict {
+    if (dict == nil) return nil;
+    
+    NSData *data = nil;
+    @try {
+        if (@available(iOS 11.0, tvOS 11.0, *)) {
+            data = [NSKeyedArchiver archivedDataWithRootObject:dict requiringSecureCoding:YES error:NULL];
+        } else {
+            #if __IPHONE_OS_VERSION_MIN_REQUIRED < 12000
+            data = [NSKeyedArchiver archivedDataWithRootObject:dict];
+            #endif
+        }
+    } @catch (id exception) {
+        BNCLogWarning([NSString stringWithFormat:@"Exception serializing preferences dict: %@.", exception]);
+    }
+    return data;
+}
+
 + (void) clearAll {
     NSURL *prefsURL = [self.URLForPrefsFile copy];
     if (prefsURL) [[NSFileManager defaultManager] removeItemAtURL:prefsURL error:nil];
@@ -782,31 +839,50 @@ + (void) clearAll {
 - (NSMutableDictionary *)persistenceDict {
     @synchronized(self) {
         if (!_persistenceDict) {
-            NSDictionary *persistenceDict = nil;
-            @try {
-                NSError *error = nil;
-                NSData *data = [NSData dataWithContentsOfURL:self.class.URLForPrefsFile options:0 error:&error];
-                if (!error && data) {
-//                    if (@available(iOS 11.0, tvOS 11.0, *)) {
-//                        persistenceDict = [NSKeyedUnarchiver unarchivedObjectOfClass:[NSMutableDictionary class] fromData:data error:NULL];
-//                    } else {
-//#if __IPHONE_OS_VERSION_MIN_REQUIRED < 12000
-                        persistenceDict = [NSKeyedUnarchiver unarchiveObjectWithData:data];
-//#endif
-//                    }
-                }
-            }
-            @catch (NSException*) {
+            _persistenceDict = [self deserializePrefDictFromData:[self loadPrefData]];
+        }
+        return _persistenceDict;
+    }
+}
+
+- (NSData *)loadPrefData {
+    NSData *data = nil;
+    @try {
+        NSError *error = nil;
+        data = [NSData dataWithContentsOfURL:self.class.URLForPrefsFile options:0 error:&error];
+        if (error || !data) {
+            BNCLogWarning(@"Failed to load preferences from storage.");
+        }
+    } @catch (NSException *) {
+        BNCLogWarning(@"Failed to load preferences from storage.");
+    }
+    return data;
+}
+
+- (NSMutableDictionary *)deserializePrefDictFromData:(NSData *)data {
+    NSDictionary *dict = nil;
+    if (data) {
+        if (@available(iOS 11.0, tvOS 11.0, *)) {
+            NSError *error = nil;
+            NSSet *classes = [[NSMutableSet alloc] initWithArray:@[ NSNumber.class, NSString.class, NSDate.class, NSArray.class, NSDictionary.class ]];
+
+            dict = [NSKeyedUnarchiver unarchivedObjectOfClasses:classes fromData:data error:&error];
+            if (error) {
                 BNCLogWarning(@"Failed to load preferences from storage.");
             }
 
-            if ([persistenceDict isKindOfClass:[NSDictionary class]]) {
-                _persistenceDict = [persistenceDict mutableCopy];
-            } else {
-                _persistenceDict = [[NSMutableDictionary alloc] init];
-            }
+        } else {
+        #if __IPHONE_OS_VERSION_MIN_REQUIRED < 12000
+            dict = [NSKeyedUnarchiver unarchiveObjectWithData:data];
+        #endif
         }
-        return _persistenceDict;
+    }
+    
+    // NSKeyedUnarchiver returns an NSDictionary, convert to NSMutableDictionary
+    if (dict && [dict isKindOfClass:[NSDictionary class]]) {
+        return [dict mutableCopy];
+    } else {
+        return [[NSMutableDictionary alloc] init];
     }
 }
 
@@ -858,6 +934,16 @@ - (NSInteger)readIntegerFromDefaults:(NSString *)key {
     }
 }
 
+- (double)readDoubleFromDefaults:(NSString *)key {
+    @synchronized(self) {
+        NSNumber *number = self.persistenceDict[key];
+        if (number != nil && [number respondsToSelector:@selector(doubleValue)]){
+            return [number doubleValue];
+        }
+        return NSNotFound;
+    }
+}
+
 #pragma mark - Preferences File URL
 
 + (NSURL* _Nonnull) URLForPrefsFile {

Branch-SDK/BNCServerInterface.m

@@ -17,6 +17,7 @@
 #import "Branch.h"
 #import "NSString+Branch.h"
 #import "BNCApplication.h"
+#import "BNCSKAdNetwork.h"
 
 @interface BNCServerInterface ()
 @property (copy, nonatomic) NSString *requestEndpoint;
@@ -132,13 +133,13 @@ - (void)postRequest:(NSDictionary *)post
         retryNumber:(NSInteger)retryNumber
                 key:(NSString *)key
            callback:(BNCServerCallback)callback {
-
-    NSMutableDictionary *extendedParams = [self buildExtendedParametersForURL:url withPostDictionary:post];
-    NSURLRequest *request = [self preparePostRequest:extendedParams url:url key:key retryNumber:retryNumber];
 
     // Instrumentation metrics
     self.requestEndpoint = [self.preferenceHelper getEndpointFromURL:url];
-
+    
+    NSMutableDictionary *extendedParams = [self buildExtendedParametersForURL:url withPostDictionary:post];
+    NSURLRequest *request = [self preparePostRequest:extendedParams url:url key:key retryNumber:retryNumber];
+    
     [self genericHTTPRequest:request
                  retryNumber:retryNumber
                     callback:callback
@@ -440,6 +441,11 @@ - (NSMutableDictionary *)prepareParamDict:(NSDictionary *)params
     NSMutableDictionary *metadata = [[NSMutableDictionary alloc] init];
     [metadata bnc_safeAddEntriesFromDictionary:self.preferenceHelper.requestMetadataDictionary];
     [metadata bnc_safeAddEntriesFromDictionary:fullParamDict[BRANCH_REQUEST_KEY_STATE]];
+    
+    if(([self.requestEndpoint containsString:@"/v1/open"]) || ([self.requestEndpoint containsString:@"/v1/install"]) || ([self.requestEndpoint containsString:@"/v2/event"])){
+        [metadata bnc_safeSetObject:[NSString stringWithFormat:@"%f", [BNCSKAdNetwork sharedInstance].maxTimeSinceInstall] forKey:BRANCH_REQUEST_METADATA_KEY_SCANTIME_WINDOW];
+    }
+    
     if (metadata.count) {
         fullParamDict[BRANCH_REQUEST_KEY_STATE] = metadata;
     }
@@ -450,6 +456,22 @@ - (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"])){
+        NSString *ref_gbraid = self.preferenceHelper.referrerGBRAID;
+        if ((ref_gbraid != nil) && (ref_gbraid.length > 0))  {
+            // Check if its valid or expired
+            NSTimeInterval validityWindow = self.preferenceHelper.referrerGBRAIDValidityWindow;
+            if (validityWindow) {
+                NSDate *initDate = self.preferenceHelper.referrerGBRAIDInitDate ;
+                NSDate *expirationDate = [initDate dateByAddingTimeInterval:validityWindow];
+                NSDate *now = [NSDate date];
+                if ([now compare:expirationDate] == NSOrderedAscending) {
+                    fullParamDict[BRANCH_REQUEST_KEY_REFERRER_GBRAID] = ref_gbraid;
+                }
+            }
+        }
+    }
     return fullParamDict;
 }
 

Branch-SDK/Branch.h

@@ -825,6 +825,18 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
 ///Returns the current tracking state.
 + (BOOL) trackingDisabled;
 
+/*
+ 
+ Sets the time window for which referrer_graid is valid starting from now.
+ After validity window is over, its cleared from settings and will not be sent
+ with requests anymore.
+ 
+ Default time interval is 30 days (2,592,000 seconds).
+ 
+ @param validityWindow -(NSTimeInterval) number of seconds for which referrer_gbraid will be valid starting from now.
+ */
++ (void) setReferrerGbraidValidityWindow:(NSTimeInterval) validityWindow;
+
 #pragma mark - Session Item methods
 
 ///--------------------
@@ -1292,6 +1304,19 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
  */
 - (NSString *)getLongURLWithParams:(nullable NSDictionary *)params andChannel:(nullable NSString *)channel andTags:(nullable NSArray *)tags andFeature:(nullable NSString *)feature andStage:(nullable NSString *)stage andAlias:(nullable NSString *)alias;
 
+/**
+ Get a long app.link url with specified params, tags, feature, stage, and alias. The usage type will default to unlimited.
+
+ @param params Dictionary of parameters to include in the link.
+ @param channel The channel for the link. Examples could be Facebook, Twitter, SMS, etc, depending on where it will be shared.
+ @param tags An array of tags to associate with this link, useful for tracking.
+ @param feature The feature this is utilizing. Examples could be Sharing, Referring, Inviting, etc.
+ @param stage The stage used for the generated link, indicating what part of a funnel the user is in.
+ @param alias The alias for a link.
+ @warning This can fail if the alias is already taken.
+ */
+- (NSString *)getLongAppLinkURLWithParams:(NSDictionary *)params andChannel:(nullable NSString *)channel andTags:(NSArray *)tags andFeature:(NSString *)feature andStage:(NSString *)stage andAlias:(NSString *)alias;
+
 #pragma mark - Short Url Async methods
 
 ///----------------------------------------