Fix blacklist open with URI scheme DEVEX-341 (#824)

* Save work.

* Added code that clears the blacklisted URL after sending the regex pattern to the server.

* Fixed unit tests.

* Send matching blacklist regex in externalIntentURI instead.

Author: E-B-Smith

Branch-SDK/Branch-SDK/BNCPreferenceHelper.h

@@ -53,6 +53,7 @@ NSURL* /* _Nonnull */ BNCURLForBranchDirectory(void);
 
 @property (strong, atomic) NSArray<NSString*> *URLBlackList;
 @property (assign, atomic) NSInteger URLBlackListVersion;
+@property (assign, atomic) BOOL blacklistURLOpen;
 
 @property (assign, atomic) BOOL trackingDisabled;
 - (void) clearTrackingInformation;

Branch-SDK/Branch-SDK/BNCPreferenceHelper.m

@@ -571,6 +571,19 @@ - (void) setURLBlackListVersion:(NSInteger)URLBlackListVersion {
     }
 }
 
+- (BOOL) blacklistURLOpen {
+    @synchronized(self) {
+        return [self readBoolFromDefaults:@"blacklistURLOpen"];
+    }
+}
+
+- (void) setBlacklistURLOpen:(BOOL)value {
+    @synchronized(self) {
+        [self writeBoolToDefaults:@"blacklistURLOpen" value:value];
+    }
+}
+
+
 - (BOOL) trackingDisabled {
     @synchronized(self) {
         NSNumber *b = (id) [self readObjectFromDefaults:@"trackingDisabled"];

Branch-SDK/Branch-SDK/Branch.m

@@ -717,10 +717,18 @@ - (BOOL)handleDeepLink:(NSURL *)url fromSelf:(BOOL)isFromSelf {
         blackListPattern = [_userURLBlackList blackListPatternMatchingURL:url];
     }
     if (blackListPattern) {
-        [self handleUniversalDeepLink_private:blackListPattern fromSelf:isFromSelf];
+        self.preferenceHelper.blacklistURLOpen = YES;
+        self.preferenceHelper.externalIntentURI = blackListPattern;
+        self.preferenceHelper.referringURL = blackListPattern;
+        [self initUserSessionAndCallCallback:!self.isInitialized];
         return NO;
     }
 
+    self.preferenceHelper.blacklistURLOpen = NO;
+    self.preferenceHelper.referringURL = nil;
+    self.preferenceHelper.externalIntentURI = nil;
+    self.preferenceHelper.universalLinkUrl = nil;
+
     NSString *scheme = [url scheme];
     if ([scheme isEqualToString:@"http"] || [scheme isEqualToString:@"https"]) {
         return [self handleUniversalDeepLink_private:url.absoluteString fromSelf:isFromSelf];

Branch-SDK/Branch-SDK/Networking/BNCServerInterface.m

@@ -612,7 +612,6 @@ - (void)genericHTTPRequest:(NSURLRequest *)request
               (prefs.spotlightIdentifier.length > 0 ) ||
               (prefs.universalLinkUrl.length > 0))) {
             // Allow this network operation since it's an open/install to resolve a link.
-            NSLog(@"Yope!"); // EBS eDebug
         } else {
             [[BNCPreferenceHelper preferenceHelper] clearTrackingInformation];
             NSError *error = [NSError branchErrorWithCode:BNCTrackingDisabledError];

Branch-SDK/Branch-SDK/Networking/Requests/BranchOpenRequest.m

@@ -137,6 +137,16 @@ + (NSNumber*) appUpdateState {
 }
 
 - (void)processResponse:(BNCServerResponse *)response error:(NSError *)error {
+    BNCPreferenceHelper *preferenceHelper = [BNCPreferenceHelper preferenceHelper];
+    if (error && preferenceHelper.blacklistURLOpen) {
+        // Ignore this response from the server. Dummy up a response:
+        error = nil;
+        response.data = @{
+            BRANCH_RESPONSE_KEY_SESSION_DATA: @{
+                BRANCH_RESPONSE_KEY_CLICKED_BRANCH_LINK: @0
+            }
+        };
+    } else
     if (error) {
         [BranchOpenRequest releaseOpenResponseLock];
         if (self.callback) {
@@ -145,7 +155,6 @@ - (void)processResponse:(BNCServerResponse *)response error:(NSError *)error {
         return;
     }
 
-    BNCPreferenceHelper *preferenceHelper = [BNCPreferenceHelper preferenceHelper];
     NSDictionary *data = response.data;
 
     // Handle possibly mis-parsed identity.
@@ -243,6 +252,7 @@ - (void)processResponse:(BNCServerResponse *)response error:(NSError *)error {
     preferenceHelper.externalIntentURI = nil;
     preferenceHelper.appleSearchAdNeedsSend = NO;
     preferenceHelper.referringURL = referringURL;
+    preferenceHelper.blacklistURLOpen = NO;
 
     NSString *string = BNCStringFromWireFormat(data[BRANCH_RESPONSE_KEY_BRANCH_IDENTITY]);
     if (string) preferenceHelper.identityID = string;

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

@@ -23,14 +23,19 @@ @implementation BNCURLBlackListTest
 - (void) setUp {
     [BNCPreferenceHelper preferenceHelper].URLBlackList = nil;
     [BNCPreferenceHelper preferenceHelper].URLBlackListVersion = 0;
+    [BNCPreferenceHelper preferenceHelper].blacklistURLOpen = NO;
+}
+
+- (void) tearDown {
+    [BNCPreferenceHelper preferenceHelper].blacklistURLOpen = NO;
 }
 
 - (void)testListDownLoad {
     XCTestExpectation *expectation = [self expectationWithDescription:@"BlackList Download"];
     BNCURLBlackList *blackList = [BNCURLBlackList new];
     [blackList refreshBlackListFromServerWithCompletion:^ (NSError*error, NSArray*list) {
         XCTAssertNil(error);
-        XCTAssertTrue(list.count == 7);
+        XCTAssertTrue(list.count == 6);
         [expectation fulfill];
     }];
     [self awaitExpectations];

Branch-TestBed/Branch-TestBed-UITests/UITestBed/Info.plist

@@ -24,6 +24,7 @@
 			<key>CFBundleURLSchemes</key>
 			<array>
 				<string>branchuitest</string>
+				<string>fb123</string>
 			</array>
 		</dict>
 	</array>

ChangeLog.md

@@ -1,5 +1,10 @@
 Branch iOS SDK Change Log
 
+- v0.24.2
+  * _*Master Release*_ - April 19, 2018
+  * Fixed a bug where a opening a blacklisted URI scheme would cause an HTTP status 400 for each
+    Branch open until the app was opened with a universal link.
+
 - v0.24.1
   * _*Master Release*_ - April 5, 2018
   * Updated the SDK for Xcode 9.3 and Swift 4.1.