Merge pull request #980 from BranchMetrics/INTENG-8009

INTENG-8009

Author: bklastaitis-branch

Branch-SDK-Tests/DispatchToIsolationQueueTests.m

@@ -0,0 +1,76 @@
+//
+//  BNCPreInitBlockTests.m
+//  Branch-SDK-Tests
+//
+//  Created by Benas Klastaitis on 12/9/19.
+//  Copyright © 2019 Branch, Inc. All rights reserved.
+//
+
+#import <XCTest/XCTest.h>
+// #import "Branch.h"
+
+@interface DispatchToIsolationQueueTests : XCTestCase
+// @property (nonatomic, strong, readwrite) Branch *branch;
+// @property (nonatomic, strong, readwrite) BNCPreferenceHelper *prefHelper;
+@end
+
+// this is an integration test, needs to be moved to a new target
+@implementation DispatchToIsolationQueueTests
+
+- (void)setUp {
+   // self.branch = [Branch getInstance];
+   // self.prefHelper = [[BNCPreferenceHelper alloc] init];
+}
+
+- (void)tearDown {
+   // [self.prefHelper setRequestMetadataKey:@"$marketing_cloud_visitor_id" value:@"dummy"];
+}
+
+- (void)testPreInitBlock {
+   // __block XCTestExpectation *expectation = [self expectationWithDescription:@""];
+
+   // [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,
+   //        BranchLinkProperties * _Nullable linkProperties,
+   //        NSError * _Nullable error) {
+   //     [expectation fulfill];
+   // }];
+
+   // // test that session initialization blocking works
+   // dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(2 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
+   //     id initializationStatus = [self.branch valueForKey:@"initializationStatus"];
+   //     XCTAssertTrue([self enumIntValueFromId:initializationStatus] == 0);// uninitialized
+   //     XCTAssertNil([[self.prefHelper requestMetadataDictionary] objectForKey:@"$marketing_cloud_visitor_id"]);
+   // });
+
+   // // 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
+
+   //     XCTAssertTrue([[[self.prefHelper requestMetadataDictionary] objectForKey:@"$marketing_cloud_visitor_id"] isEqualToString:@"adobeID123"]);
+   // });
+
+
+   // [self waitForExpectationsWithTimeout:6 handler:^(NSError * _Nullable error) {
+   //     NSLog(@"%@", error);
+   // }];
+}
+
+// -(int)enumIntValueFromId:(id)enumValueId {
+//    if (![enumValueId respondsToSelector:@selector(intValue)])
+//        return -1;
+
+//    return [enumValueId intValue];
+// }
+
+@end

Branch-SDK/Branch-SDK/Branch.h

@@ -514,6 +514,18 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
 /// @name Push Notification Support
 ///--------------------------------
 
+#pragma mark - Pre-initialization support
+
+/**
+ 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 passed in dispatch_block_t will block Branch initialization thread, not the main thread.
+ 
+ @param initBlock         dispatch_block_t object to be executed prior to session initialization
+ */
+- (void)dispatchToIsolationQueue:(dispatch_block_t)initBlock;
+
 #pragma mark - Push Notification support
 
 /**

Branch-SDK/Branch-SDK/Branch.m

@@ -917,6 +917,12 @@ - (void)checkAppleSearchAdsAttribution {
     });
 }
 
+#pragma mark - Pre-initialization support
+
+- (void) dispatchToIsolationQueue:(dispatch_block_t) initBlock {
+    dispatch_async(self.isolationQueue, initBlock);
+}
+
 #pragma mark - Facebook App Link Check
 
 - (void)registerFacebookDeepLinkingClass:(id)FBSDKAppLinkUtility {
@@ -1775,11 +1781,10 @@ - (void)registerViewWithParams:(NSDictionary *)params andCallback:(callbackWithP
 #pragma mark - Application State Change methods
 
 - (void)applicationDidBecomeActive {
-    if (!Branch.trackingDisabled) {
-        if ((self.initializationStatus != BNCInitStatusInitialized) &&
-            ![self.requestQueue containsInstallOrOpen]) {
-            [self initUserSessionAndCallCallback:YES];
-        }
+    if (!Branch.trackingDisabled &&
+        self.initializationStatus != BNCInitStatusInitialized &&
+        [self.requestQueue containsInstallOrOpen]) {
+        [self initUserSessionAndCallCallback:YES];
     }
 }
 

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

@@ -24,6 +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 /* 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 */; };
@@ -317,6 +318,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 /* 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>"; };
@@ -758,8 +760,12 @@
 				5F3D6719233062FD00454FF1 /* BNCJsonLoader.h */,
 				5F3D671A233062FD00454FF1 /* BNCJsonLoader.m */,
 				4D16839F2098C901008819E3 /* Info.plist */,
+<<<<<<< HEAD
+				4AB16367239E3A2700D42931 /* DispatchToIsolationQueueTests.m */,
+=======
 				5F437E39237DE3480052064B /* BNCTelephonyTests.m */,
 				5F437E3F237E1A560052064B /* BNCDeviceSystemTests.m */,
+>>>>>>> 16154d53d1bb758765658b3bc2368881e658cc89
 			);
 			name = "Branch-SDK-Tests";
 			path = "../Branch-SDK-Tests";
@@ -1460,6 +1466,7 @@
 				4D1683B92098C902008819E3 /* BNCSystemObserver.Test.m in Sources */,
 				4D1683BE2098C902008819E3 /* BranchShortUrlSyncRequestTests.m in Sources */,
 				4D1683CA2098C902008819E3 /* BNCPreferenceHelperTests.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.xcodeproj/xcshareddata/xcschemes/Branch-SDK-Tests.xcscheme

@@ -76,6 +76,16 @@
                </Test>
             </SkippedTests>
          </TestableReference>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "5F8B7B3A21B5F5CD009CE0A6"
+               BuildableName = "Branch-SDK-Unhosted-Tests.xctest"
+               BlueprintName = "Branch-SDK-Unhosted-Tests"
+               ReferencedContainer = "container:Branch-TestBed.xcodeproj">
+            </BuildableReference>
+         </TestableReference>
       </Testables>
    </TestAction>
    <LaunchAction
@@ -88,6 +98,7 @@
       ignoresPersistentStateOnLaunch = "NO"
       debugDocumentVersioning = "YES"
       stopOnEveryThreadSanitizerIssue = "YES"
+      migratedStopOnEveryIssue = "YES"
       debugServiceExtension = "internal"
       allowLocationSimulation = "YES">
       <MacroExpansion>

Branch-TestBed/Branch-TestBed.xcodeproj/xcshareddata/xcschemes/Branch-TestBed.xcscheme

@@ -91,6 +91,16 @@
                ReferencedContainer = "container:Branch-TestBed.xcodeproj">
             </BuildableReference>
          </TestableReference>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "5F8B7B3A21B5F5CD009CE0A6"
+               BuildableName = "Branch-SDK-Unhosted-Tests.xctest"
+               BlueprintName = "Branch-SDK-Unhosted-Tests"
+               ReferencedContainer = "container:Branch-TestBed.xcodeproj">
+            </BuildableReference>
+         </TestableReference>
       </Testables>
    </TestAction>
    <LaunchAction

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);