strip down dispatch pre init block to simply dispatching to isolationqueue and require management of the sephamore inside the passed in block

Author: bklastaitis-branch

Branch-SDK-Tests/BNCPreInitBlockTests.m …DK-Tests/DispatchToIsolationQueueTests.mBranch-SDK-Tests/BNCPreInitBlockTests.m renamed to Branch-SDK-Tests/DispatchToIsolationQueueTests.m Branch-SDK-Tests/BNCPreInitBlockTests.m renamed to Branch-SDK-Tests/DispatchToIsolationQueueTests.m

@@ -9,12 +9,13 @@
 #import <XCTest/XCTest.h>
 #import "Branch.h"
 
-@interface BNCPreInitBlockTests : XCTestCase
+@interface DispatchToIsolationQueueTests : XCTestCase
 @property (nonatomic, strong, readwrite) Branch *branch;
 @property (nonatomic, strong, readwrite) BNCPreferenceHelper *prefHelper;
 @end
 
-@implementation BNCPreInitBlockTests
+// this is an integration test, needs to be moved to a new target
+@implementation DispatchToIsolationQueueTests
 
 - (void)setUp {
     self.branch = [Branch getInstance];
@@ -28,9 +29,14 @@ - (void)tearDown {
 - (void)testPreInitBlock {
     __block XCTestExpectation *expectation = [self expectationWithDescription:@""];
 
-    [self.branch dispatchPreInitBlock:^{
-        [self.branch setRequestMetadataKey:@"$marketing_cloud_visitor_id" value:@"adobeID123"];
-    } executeAfter:3];
+    [self.branch dispatchToIsolationQueue:^{
+        dispatch_semaphore_t semaphore = dispatch_semaphore_create(0);
+        dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(3 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
+            [self.branch setRequestMetadataKey:@"$marketing_cloud_visitor_id" value:@"adobeID123"];
+            dispatch_semaphore_signal(semaphore);
+        });
+        dispatch_semaphore_wait(semaphore, DISPATCH_TIME_FOREVER);
+    }];
 
     [self.branch initSessionWithLaunchOptions:nil andRegisterDeepLinkHandlerUsingBranchUniversalObject:
         ^ (BranchUniversalObject * _Nullable universalObject,
@@ -46,7 +52,7 @@ - (void)testPreInitBlock {
         XCTAssertNil([[self.prefHelper requestMetadataDictionary] objectForKey:@"$marketing_cloud_visitor_id"]);
     });
 
-    // test that initialization does happen afterwards and that pre inti block was executed
+    // test that initialization does happen afterwards and that pre init block was executed
     dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(5 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
         id initializationStatus = [self.branch valueForKey:@"initializationStatus"];
         XCTAssertTrue([self enumIntValueFromId:initializationStatus] == 2);// initialized

Branch-SDK/Branch-SDK/Branch.h

@@ -517,13 +517,17 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
 #pragma mark - Pre-initialization support
 
 /**
- When certain actions are required to complete prior to session initialization, call this method passing in a dispatch_block_t
- object and an int, inidicating the number of seconds Branch should wait to  invoke the passed in block.
+ DO NOT USE unless you are familiar with the SDK's threading model.
+ 
+ When certain actions are required to complete prior to session initialization, this method can be used to pass in a blocking dispatch_block_t.
+ The structure of the dispatch_block_t should be as follows:
+ 1. obtain semaphore
+ 2. initiate async task that signals the sephamore in its callback
+ 3. make sephamore wait for the signal
  
  @param initBlock         dispatch_block_t object to be executed prior to session initialization
- @param waitTime           An int inidicating the number of seconds Branch should wait before executing the passed in block
  */
-- (void)dispatchPreInitBlock:(dispatch_block_t)initBlock executeAfter:(int)waitTime;
+- (void)dispatchToIsolationQueue:(dispatch_block_t)initBlock;
 
 #pragma mark - Push Notification support
 

Branch-SDK/Branch-SDK/Branch.m

@@ -919,19 +919,8 @@ - (void)checkAppleSearchAdsAttribution {
 
 #pragma mark - Pre-initialization support
 
-- (void) dispatchPreInitBlock:(dispatch_block_t) initBlock executeAfter:(int)waitTime {
-    dispatch_async(self.isolationQueue, ^(){
-        dispatch_semaphore_t semaphore = dispatch_semaphore_create(0);
-        
-        dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(waitTime * NSEC_PER_SEC)), self.isolationQueue, ^{
-            @try {
-               initBlock();
-            } @catch (NSException *ignored) {}
-            dispatch_semaphore_signal(semaphore);
-        });
-        
-        dispatch_semaphore_wait(semaphore, DISPATCH_TIME_FOREVER);
-    });
+- (void) dispatchToIsolationQueue:(dispatch_block_t) initBlock {
+    dispatch_async(self.isolationQueue, initBlock);
 }
 
 #pragma mark - Facebook App Link Check

Branch-TestBed/Branch-TestBed.xcodeproj/project.pbxproj

@@ -24,7 +24,7 @@
 		4683F0751B20A73F00A432E7 /* CreditHistoryViewController.m in Sources */ = {isa = PBXBuildFile; fileRef = 7EAA790119E89F67008D4A83 /* CreditHistoryViewController.m */; };
 		4683F0761B20A73F00A432E7 /* AppDelegate.m in Sources */ = {isa = PBXBuildFile; fileRef = 670016731940F51400A9E103 /* AppDelegate.m */; };
 		46DC406E1B2A328900D2D203 /* AdSupport.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 67BBCF271A69E49A009C7DAE /* AdSupport.framework */; };
-		4AB16368239E3A2700D42931 /* BNCPreInitBlockTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 4AB16367239E3A2700D42931 /* BNCPreInitBlockTests.m */; };
+		4AB16368239E3A2700D42931 /* DispatchToIsolationQueueTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 4AB16367239E3A2700D42931 /* DispatchToIsolationQueueTests.m */; };
 		4D130E731EE0C7B100A69A0A /* BNCNetworkService.m in Sources */ = {isa = PBXBuildFile; fileRef = 4D130E4D1EE0C7B000A69A0A /* BNCNetworkService.m */; };
 		4D130E761EE0C7B100A69A0A /* BNCServerInterface.m in Sources */ = {isa = PBXBuildFile; fileRef = 4D130E501EE0C7B000A69A0A /* BNCServerInterface.m */; };
 		4D130E781EE0C7B100A69A0A /* BNCServerRequest.m in Sources */ = {isa = PBXBuildFile; fileRef = 4D130E521EE0C7B000A69A0A /* BNCServerRequest.m */; };
@@ -302,7 +302,7 @@
 		466D5A0F1B5991E3009DB845 /* BNCContentDiscoveryManager.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = BNCContentDiscoveryManager.h; sourceTree = "<group>"; };
 		466D5A101B5991E3009DB845 /* BNCContentDiscoveryManager.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = BNCContentDiscoveryManager.m; sourceTree = "<group>"; };
 		46DBB42F1B335A9B00642FC8 /* BranchDeepLinkingController.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = BranchDeepLinkingController.h; sourceTree = "<group>"; };
-		4AB16367239E3A2700D42931 /* BNCPreInitBlockTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = BNCPreInitBlockTests.m; sourceTree = "<group>"; };
+		4AB16367239E3A2700D42931 /* DispatchToIsolationQueueTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = DispatchToIsolationQueueTests.m; sourceTree = "<group>"; };
 		4D130E4C1EE0C7B000A69A0A /* BNCNetworkService.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = BNCNetworkService.h; sourceTree = "<group>"; };
 		4D130E4D1EE0C7B000A69A0A /* BNCNetworkService.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = BNCNetworkService.m; sourceTree = "<group>"; };
 		4D130E4E1EE0C7B000A69A0A /* BNCNetworkServiceProtocol.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = BNCNetworkServiceProtocol.h; sourceTree = "<group>"; };
@@ -724,7 +724,7 @@
 				5F3D6719233062FD00454FF1 /* BNCJsonLoader.h */,
 				5F3D671A233062FD00454FF1 /* BNCJsonLoader.m */,
 				4D16839F2098C901008819E3 /* Info.plist */,
-				4AB16367239E3A2700D42931 /* BNCPreInitBlockTests.m */,
+				4AB16367239E3A2700D42931 /* DispatchToIsolationQueueTests.m */,
 			);
 			name = "Branch-SDK-Tests";
 			path = "../Branch-SDK-Tests";
@@ -1401,7 +1401,7 @@
 				4D1683B92098C902008819E3 /* BNCSystemObserver.Test.m in Sources */,
 				4D1683BE2098C902008819E3 /* BranchShortUrlSyncRequestTests.m in Sources */,
 				4D1683CA2098C902008819E3 /* BNCPreferenceHelperTests.m in Sources */,
-				4AB16368239E3A2700D42931 /* BNCPreInitBlockTests.m in Sources */,
+				4AB16368239E3A2700D42931 /* DispatchToIsolationQueueTests.m in Sources */,
 				4D1683B32098C902008819E3 /* BranchGetCreditHistoryRequestTests.m in Sources */,
 				5F892ECE23624E0A0023AEC1 /* BNCFacebookAppLinksTests.m in Sources */,
 				4D1683BB2098C902008819E3 /* BranchShortUrlRequestTests.m in Sources */,

Branch-TestBed/Branch-TestBed/AppDelegate.m

@@ -29,6 +29,10 @@ - (BOOL)application:(UIApplication *)application
 
     //
     Branch *branch = [Branch getInstance];
+    
+    
+    // test pre init support
+//    [self testDispatchToIsolationQueue:branch]
 
     // Comment out (for match guarantee testing) / or un-comment to toggle debugging:
     // Note: Unit tests will fail if 'setDebug' is set.
@@ -57,6 +61,21 @@ - (BOOL)application:(UIApplication *)application
     return YES;
 }
 
+// pre init support is meant for extensions, for exmaple, when Adobe axtension needs to pass in Adobe IDs
+// before init session is called. This method will block the queue used by open/install requests until the
+// the passsed in block completes
+- (void) testDispatchToIsolationQueue:(Branch*)branch {
+    [branch dispatchToIsolationQueue:^{
+        dispatch_semaphore_t semaphore = dispatch_semaphore_create(0);
+        dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(2 * NSEC_PER_SEC)),
+                       dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
+            [branch setRequestMetadataKey:@"keykey" value:@"valuevalue"];
+            dispatch_semaphore_signal(semaphore);
+        });
+        dispatch_semaphore_wait(semaphore, DISPATCH_TIME_FOREVER);
+    }];
+}
+
 - (void) handleDeepLinkParams:(NSDictionary*)params error:(NSError*)error {
     if (error) {
         NSLog(@"Branch TestBed: Error deep linking: %@.", error.localizedDescription);