[release] 1.38.0

Author: branch-sdkteam

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     = @"0.37.0";
+NSString * const BNC_SDK_VERSION     = @"1.38.0";

Branch-SDK/BNCPreferenceHelper.m

@@ -872,50 +872,12 @@ - (NSInteger)readIntegerFromDefaults:(NSString *)key {
 
 #pragma mark - Preferences File URL
 
-+ (NSString *)prefsFile_deprecated {
-    NSString * path =
-        [[NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES)
-            firstObject]
-                stringByAppendingPathComponent:BRANCH_PREFS_FILE];
-    return path;
-}
-
 + (NSURL* _Nonnull) URLForPrefsFile {
     NSURL *URL = BNCURLForBranchDirectory();
     URL = [URL URLByAppendingPathComponent:BRANCH_PREFS_FILE isDirectory:NO];
     return URL;
 }
 
-+ (void) moveOldPrefsFile {
-    NSString* oldPath = self.prefsFile_deprecated;
-    NSURL *oldURL = (oldPath) ? [NSURL fileURLWithPath:self.prefsFile_deprecated] : nil;
-    NSURL *newURL = [self URLForPrefsFile];
-
-    if (!oldURL || !newURL) { return; }
-
-    NSError *error = nil;
-    [[NSFileManager defaultManager]
-        moveItemAtURL:oldURL
-        toURL:newURL
-        error:&error];
-
-    if (error && error.code != NSFileNoSuchFileError) {
-        if (error.code == NSFileWriteFileExistsError) {
-            [[NSFileManager defaultManager]
-                removeItemAtURL:oldURL
-                error:&error];
-        } else {
-            BNCLogError([NSString stringWithFormat:@"Can't move prefs file: %@.", error]);
-        }
-    }
-}
-
-+ (void) initialize {
-    if (self == [BNCPreferenceHelper self]) {
-        [self moveOldPrefsFile];
-    }
-}
-
 @end
 
 #pragma mark - BNCURLForBranchDirectory

Branch-SDK/BNCServerInterface.m

@@ -244,8 +244,8 @@ - (void)genericHTTPRequest:(NSURLRequest *)request
     if (Branch.trackingDisabled) {
         NSString *endpoint = request.URL.absoluteString;
 
-        // if endpoint is not on the whitelist, fail it.
-        if (![self whiteListContainsEndpoint:endpoint]) {
+        // if endpoint is not linking related, fail it.
+        if (![self isLinkingRelatedRequest:endpoint]) {
             [[BNCPreferenceHelper preferenceHelper] clearTrackingInformation];
             NSError *error = [NSError branchErrorWithCode:BNCTrackingDisabledError];
             BNCLogWarning([NSString stringWithFormat:@"Dropping Request %@: - %@", endpoint, error]);
@@ -269,7 +269,7 @@ - (void)genericHTTPRequest:(NSURLRequest *)request
     }
 }
 
-- (BOOL)whiteListContainsEndpoint:(NSString *)endpoint {
+- (BOOL)isLinkingRelatedRequest:(NSString *)endpoint {
     BNCPreferenceHelper *prefs = [BNCPreferenceHelper preferenceHelper];
     BOOL hasIdentifier = (prefs.linkClickIdentifier.length > 0 ) || (prefs.spotlightIdentifier.length > 0 ) || (prefs.universalLinkUrl.length > 0);
 

Branch-SDK/BNCServerRequestQueue.m

@@ -365,49 +365,12 @@ + (NSString *)exceptionString:(NSException *)exception {
             [exception.callStackSymbols componentsJoinedByString:@"\n\t"]];
 }
 
-+ (NSString *)queueFile_deprecated {
-    NSString *path =
-        [[NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES)
-            firstObject]
-                stringByAppendingPathComponent:BRANCH_QUEUE_FILE];
-    return path;
-}
-
 + (NSURL* _Nonnull) URLForQueueFile {
     NSURL *URL = BNCURLForBranchDirectory();
     URL = [URL URLByAppendingPathComponent:BRANCH_QUEUE_FILE isDirectory:NO];
     return URL;
 }
 
-+ (void) moveOldQueueFile {
-    NSURL *oldURL = [NSURL fileURLWithPath:self.queueFile_deprecated];
-    NSURL *newURL = [self URLForQueueFile];
-    
-    if (!oldURL || !newURL) { return; }
-    
-    NSError *error = nil;
-    [[NSFileManager defaultManager]
-        moveItemAtURL:oldURL
-        toURL:newURL
-        error:&error];
-
-    if (error && error.code != NSFileNoSuchFileError) {
-        if (error.code == NSFileWriteFileExistsError) {
-            [[NSFileManager defaultManager]
-                removeItemAtURL:oldURL
-                error:&error];
-        } else {
-            BNCLogError([NSString stringWithFormat:@"Failed to move the queue file: %@.", error]);
-        }
-    }
-}
-
-+ (void) initialize {
-    if (self == [BNCServerRequestQueue self]) {
-        [self moveOldQueueFile];
-    }
-}
-
 #pragma mark - Shared Method
 
 + (id)getInstance {

Branch-SDK/Branch.h

@@ -619,18 +619,18 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
 -(void)setDeepLinkDebugMode:(nullable NSDictionary *)debugParams;
 
 /**
- Add a scheme to a whitelist of URI schemes that will be tracked by Branch. Default to all schemes.
+ Allow a URI scheme to be tracked by Branch. Default to all schemes.
 
- @param scheme to add to the whitelist, i.e. @"http", @"https" or @"myapp"
+ @param scheme URI scheme allowed to track, i.e. @"http", @"https" or @"myapp"
  */
--(void)addWhiteListedScheme:(nullable NSString *)scheme;
+-(void)addAllowedScheme:(nullable NSString *)scheme;
 
 /**
- Add an array of schemes to a whitelist of URI schemes that will be tracked by Branch. Default to all schemes.
+ Allow an array of URI schemes to be tracked by Branch. Default to all schemes.
 
- @param schemes array to add to the whitelist, i.e. @[@"http", @"https", @"myapp"]
+ @param schemes An array of URI schemes allowed to track, i.e. @[@"http", @"https", @"myapp"]
  */
--(void)setWhiteListedSchemes:(nullable NSArray *)schemes;
+-(void)setAllowedSchemes:(nullable NSArray *)schemes;
 
 /**
  @brief     Sets an array of regex patterns that match URLs for Branch to ignore.
@@ -1120,7 +1120,7 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
  @param window attribution window in days.  If the window is 0, the server will use the server side default.  If the window is outside the server supported range, it will default to 30 days.
  @param completion callback with attribution data
  */
-- (void)lastAttributedTouchDataWithAttributionWindow:(NSInteger)window completion:(void(^) (BranchLastAttributedTouchData * _Nullable latd))completion;
+- (void)lastAttributedTouchDataWithAttributionWindow:(NSInteger)window completion:(void(^) (BranchLastAttributedTouchData * _Nullable latd, NSError * _Nullable error))completion;
 
 #pragma mark - Short Url Sync methods
 

Branch-SDK/Branch.m

@@ -140,7 +140,7 @@ @interface Branch() <BranchDeepLinkingControllerCompletionDelegate> {
 @property (strong, nonatomic) NSMutableDictionary *deepLinkControllers;
 @property (weak,   nonatomic) UIViewController *deepLinkPresentingController;
 @property (strong, nonatomic) NSDictionary *deepLinkDebugParams;
-@property (strong, nonatomic) NSMutableArray *whiteListedSchemeList;
+@property (strong, nonatomic) NSMutableArray *allowedSchemeList;
 @property (strong, nonatomic) BNCURLFilter *urlFilter;
 
 #if !TARGET_OS_TV
@@ -193,7 +193,7 @@ - (id)initWithInterface:(BNCServerInterface *)interface
     _processing_sema = dispatch_semaphore_create(1);
     _networkCount = 0;
     _deepLinkControllers = [[NSMutableDictionary alloc] init];
-    _whiteListedSchemeList = [[NSMutableArray alloc] init];
+    _allowedSchemeList = [[NSMutableArray alloc] init];
 
     #if !TARGET_OS_TV
     _contentDiscoveryManager = [[BNCContentDiscoveryManager alloc] init];
@@ -665,12 +665,12 @@ - (void)setDeepLinkDebugMode:(NSDictionary *)debugParams {
     self.deepLinkDebugParams = debugParams;
 }
 
-- (void)setWhiteListedSchemes:(NSArray *)schemes {
-    self.whiteListedSchemeList = [schemes mutableCopy];
+- (void)setAllowedSchemes:(NSArray *)schemes {
+    self.allowedSchemeList = [schemes mutableCopy];
 }
 
-- (void)addWhiteListedScheme:(NSString *)scheme {
-    [self.whiteListedSchemeList addObject:scheme];
+- (void)addAllowedScheme:(NSString *)scheme {
+    [self.allowedSchemeList addObject:scheme];
 }
 
 - (void)setUrlPatternsToIgnore:(NSArray<NSString*>*)urlsToIgnore {
@@ -731,8 +731,8 @@ - (BOOL)handleSchemeDeepLink_private:(NSURL*)url sceneIdentifier:(NSString *)sce
         NSString *urlScheme = [url scheme];
 
         // save the incoming url in the preferenceHelper in the externalIntentURI field
-        if ([self.whiteListedSchemeList count]) {
-            for (NSString *scheme in self.whiteListedSchemeList) {
+        if ([self.allowedSchemeList count]) {
+            for (NSString *scheme in self.allowedSchemeList) {
                 if (urlScheme && [scheme isEqualToString:urlScheme]) {
                     self.preferenceHelper.externalIntentURI = [url absoluteString];
                     self.preferenceHelper.referringURL = [url absoluteString];
@@ -1285,7 +1285,7 @@ - (void)crossPlatformIdDataWithCompletion:(void(^) (BranchCrossPlatformID * _Nul
     });
 }
 
-- (void)lastAttributedTouchDataWithAttributionWindow:(NSInteger)window completion:(void(^) (BranchLastAttributedTouchData * _Nullable latd))completion {
+- (void)lastAttributedTouchDataWithAttributionWindow:(NSInteger)window completion:(void(^) (BranchLastAttributedTouchData * _Nullable latd, NSError * _Nullable error))completion {
     [self initSafetyCheck];
     dispatch_async(self.isolationQueue, ^(){
         [BranchLastAttributedTouchData requestLastTouchAttributedData:self.serverInterface key:self.class.branchKey attributionWindow:window completion:completion];

Branch-SDK/BranchLastAttributedTouchData.h

@@ -20,7 +20,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 + (nullable BranchLastAttributedTouchData *)buildFromJSON:(NSDictionary *)json;
 
-+ (void)requestLastTouchAttributedData:(BNCServerInterface *)serverInterface key:(NSString *)key attributionWindow:(NSInteger)window completion:(void(^) (BranchLastAttributedTouchData *latd))completion;
++ (void)requestLastTouchAttributedData:(BNCServerInterface *)serverInterface key:(NSString *)key attributionWindow:(NSInteger)window completion:(void(^) (BranchLastAttributedTouchData *latd, NSError *error))completion;
 
 @end
 

Branch-SDK/BranchLastAttributedTouchData.m

@@ -26,7 +26,7 @@ + (BranchLastAttributedTouchData *)buildFromJSON:(NSDictionary *)json {
     return nil;
 }
 
-+ (void)requestLastTouchAttributedData:(BNCServerInterface *)serverInterface key:(NSString *)key attributionWindow:(NSInteger)window completion:(void(^) (BranchLastAttributedTouchData *latd))completion {
++ (void)requestLastTouchAttributedData:(BNCServerInterface *)serverInterface key:(NSString *)key attributionWindow:(NSInteger)window completion:(void (^)(BranchLastAttributedTouchData *__nullable latd, NSError *__nullable error))completion {
     BranchLATDRequest *request = [BranchLATDRequest new];
 
     // Limit attribution range to about a year.  Although the server only supports up to 90 days as of Nov. 2019, it will fail gracefully for higher values.
@@ -41,14 +41,14 @@ + (void)requestLastTouchAttributedData:(BNCServerInterface *)serverInterface key
         // error is logged by the network service, skip parsing on error
         if (error) {
             if (completion) {
-                completion(nil);
+                completion(nil, error);
             }
             return;
         }
 
         BranchLastAttributedTouchData *latd = [self buildFromJSON:response.data];
         if (completion) {
-            completion(latd);
+            completion(latd, error);
         }
     }];
 }

Branch-SDK/NSError+Branch.m

@@ -41,7 +41,7 @@ + (NSString *) messageForCode:(BNCErrorCode)code {
         [messages setObject:@"Can't redeem zero credits." forKey:@(BNCRedeemZeroCreditsError)];
         [messages setObject:@"The Spotlight identifier is required to remove indexing from spotlight." forKey:@(BNCSpotlightIdentifierError)];
         [messages setObject:@"Spotlight cannot remove publicly indexed content." forKey:@(BNCSpotlightPublicIndexError)];
-        [messages setObject:@"User tracking is disabled and the request is not on the whitelist" forKey:@(BNCTrackingDisabledError)];
+        [messages setObject:@"User tracking is disabled and the request is not allowed" forKey:@(BNCTrackingDisabledError)];
     });
 
     NSString *errorMessage = [messages objectForKey:@(code)];

Branch-TestBed/Branch-SDK-Tests/BNCUserAgentCollectorTests.m

@@ -70,7 +70,7 @@ - (void)testCollectUserAgent {
         [expectation fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:2.0 handler:^(NSError * _Nullable error) {
+    [self waitForExpectationsWithTimeout:4.0 handler:^(NSError * _Nullable error) {
 
     }];
 }