Merge pull request #1233 from BranchMetrics/SDK-1831-update-branch.json-support

SDK-1831 update branch.json support

Author: echo-branch

BranchSDK/Branch.h

@@ -528,6 +528,16 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
  */
 - (void)dispatchToIsolationQueue:(dispatch_block_t)initBlock;
 
+/**
+ DO NOT USE unless you are implementing deferred initialization for plugins.
+ 
+ Platforms such as React Native and Unity, have slow runtime startups. This results in early lifecycle events before client code can run.
+ When `deferInitForPlugin` is true in `branch.json` initSession with cache itself until this method is called.
+ 
+ Note that while init is deferred, other calls to the Branch SDK may result in errors. For that reason, do not use this feature for general SDK init deferral.
+ */
+- (void)notifyNativeToInit;
+
 #pragma mark - Push Notification support
 
 /**

BranchSDK/Branch.m

@@ -152,6 +152,11 @@ @interface Branch() <BranchDeepLinkingControllerCompletionDelegate> {
 
 @property (nonatomic, copy, nullable) void (^sceneSessionInitWithCallback)(BNCInitSessionResponse * _Nullable initResponse, NSError * _Nullable error);
 
+// Support for deferred SDK initialization. Used to support slow plugin runtime startup.
+// This is enabled by setting deferInitForPluginRuntime to true in branch.json
+@property (nonatomic, assign, readwrite) BOOL deferInitForPluginRuntime;
+@property (nonatomic, copy, nullable) void (^cachedInitBlock)(void);
+
 @end
 
 @implementation Branch
@@ -226,13 +231,14 @@ - (id)initWithInterface:(BNCServerInterface *)interface
     [self loadUserAgent];
 
     BranchJsonConfig *config = BranchJsonConfig.instance;
+    self.deferInitForPluginRuntime = config.deferInitForPluginRuntime;
 
-    if (config.checkPasteboardOnInstall) {
-        [self checkPasteboardOnInstall];
+    if (config.enableLogging) {
+        [self enableLogging];
     }
 
-    if (config.delayInitToCheckForSearchAds) {
-        [self delayInitToCheckForSearchAds];
+    if (config.checkPasteboardOnInstall) {
+        [self checkPasteboardOnInstall];
     }
 
     if (config.enableFacebookLinkCheck) {
@@ -613,8 +619,10 @@ - (void)initSessionWithLaunchOptions:(NSDictionary *)options isReferrable:(BOOL)
 
 - (void)initSceneSessionWithLaunchOptions:(NSDictionary *)options isReferrable:(BOOL)isReferrable explicitlyRequestedReferrable:(BOOL)explicitlyRequestedReferrable automaticallyDisplayController:(BOOL)automaticallyDisplayController
                   registerDeepLinkHandler:(void (^)(BNCInitSessionResponse * _Nullable initResponse, NSError * _Nullable error))callback {
-    self.sceneSessionInitWithCallback = callback;
-    [self initSessionWithLaunchOptions:options isReferrable:isReferrable explicitlyRequestedReferrable:explicitlyRequestedReferrable automaticallyDisplayController:automaticallyDisplayController];
+    [self deferInitBlock:^{
+        self.sceneSessionInitWithCallback = callback;
+        [self initSessionWithLaunchOptions:options isReferrable:isReferrable explicitlyRequestedReferrable:explicitlyRequestedReferrable automaticallyDisplayController:automaticallyDisplayController];
+    }];
 }
 
 - (void)initSessionWithLaunchOptions:(NSDictionary *)options
@@ -2136,9 +2144,36 @@ - (void)clearNetworkQueue {
 
 #pragma mark - Session Initialization
 
+// Defers block until notifyNativeToInit is called.
+- (BOOL)deferInitBlock:(void (^)(void))block {
+    BOOL deferred = NO;
+    @synchronized (self) {
+        if (self.deferInitForPluginRuntime) {
+            self.cachedInitBlock = block;
+            deferred = YES;
+        }
+    }
+    
+    if (!deferred && block) {
+        block();
+    }
+    return deferred;
+}
+
+// Releases deferred init block
+- (void)notifyNativeToInit {
+    @synchronized (self) {
+        self.deferInitForPluginRuntime = NO;
+    }
+    
+    if (self.cachedInitBlock) {
+        self.cachedInitBlock();
+    }
+    self.cachedInitBlock = nil;
+}
+
 // SDK-631 Workaround to maintain existing error handling behavior.
 // Some methods require init before they are called.  Instead of returning an error, we try to fix the situation by calling init ourselves.
-// There is a follow up ticket to improve this.  SDK-633
 - (void)initSafetyCheck {
     if (self.initializationStatus == BNCInitStatusUninitialized) {
         BNCLogDebug(@"Branch avoided an error by preemptively initializing.");
@@ -2147,6 +2182,16 @@ - (void)initSafetyCheck {
 }
 
 - (void)initUserSessionAndCallCallback:(BOOL)callCallback sceneIdentifier:(NSString *)sceneIdentifier {
+    
+    // ignore lifecycle calls while waiting for a plugin runtime.
+    @synchronized (self) {
+        if (self.deferInitForPluginRuntime) {
+            //NSString *debug = [NSString stringWithFormat:@"Init is deferred, ignoring call: %@", NSThread.callStackSymbols];
+            //BNCLogDebug(debug);
+            return;
+        }
+    }
+    
     dispatch_async(self.isolationQueue, ^(){
         NSString *urlstring = nil;
         if (self.preferenceHelper.universalLinkUrl.length) {

BranchSDK/BranchJsonConfig.h

@@ -13,9 +13,8 @@ extern NSString * _Nonnull const BranchJsonConfigBranchKeyOption;
 extern NSString * _Nonnull const BranchJsonConfigLiveKeyOption;
 extern NSString * _Nonnull const BranchJsonConfigTestKeyOption;
 extern NSString * _Nonnull const BranchJsonConfigUseTestInstanceOption;
-extern NSString * _Nonnull const BranchJsonConfigDelayInitToCheckForSearchAdsOption;
-extern NSString * _Nonnull const BranchJsonConfigAppleSearchAdsDebugModeOption;
-extern NSString * _Nonnull const BranchJsonConfigDeferInitializationForJSLoadOption;
+extern NSString * _Nonnull const BranchJsonConfigDeferInitForPluginRuntimeOption;
+extern NSString * _Nonnull const BranchJsonConfigEnableLogging;
 extern NSString * _Nonnull const BranchJsonConfigEnableFacebookLinkCheck;
 extern NSString * _Nonnull const BranchJsonConfigCheckPasteboardOnInstall;
 
@@ -28,9 +27,8 @@ extern NSString * _Nonnull const BranchJsonConfigCheckPasteboardOnInstall;
 @property (nonatomic, readonly, nullable, copy) NSString *liveKey;
 @property (nonatomic, readonly, nullable, copy) NSString *testKey;
 @property (nonatomic, readonly, assign) BOOL useTestInstance;
-@property (nonatomic, readonly, assign) BOOL delayInitToCheckForSearchAds;
-@property (nonatomic, readonly, assign) BOOL appleSearchAdsDebugMode;
-@property (nonatomic, readonly, assign) BOOL deferInitializationForJSLoad;
+@property (nonatomic, readonly, assign) BOOL deferInitForPluginRuntime;
+@property (nonatomic, readonly, assign) BOOL enableLogging;
 @property (nonatomic, readonly, assign) BOOL enableFacebookLinkCheck;
 @property (nonatomic, readonly, assign) BOOL checkPasteboardOnInstall;
 

BranchSDK/BranchJsonConfig.m

@@ -14,9 +14,8 @@
 NSString * _Nonnull const BranchJsonConfigLiveKeyOption = @"liveKey";
 NSString * _Nonnull const BranchJsonConfigTestKeyOption = @"testKey";
 NSString * _Nonnull const BranchJsonConfigUseTestInstanceOption = @"useTestInstance";
-NSString * _Nonnull const BranchJsonConfigDelayInitToCheckForSearchAdsOption = @"delayInitToCheckForSearchAds";
-NSString * _Nonnull const BranchJsonConfigAppleSearchAdsDebugModeOption = @"appleSearchAdsDebugMode";
-NSString * _Nonnull const BranchJsonConfigDeferInitializationForJSLoadOption = @"deferInitializationForJSLoad";
+NSString * _Nonnull const BranchJsonConfigDeferInitForPluginRuntimeOption = @"deferInitForPluginRuntime";
+NSString * _Nonnull const BranchJsonConfigEnableLogging = @"enableLogging";
 NSString * _Nonnull const BranchJsonConfigEnableFacebookLinkCheck = @"enableFacebookLinkCheck";
 NSString * _Nonnull const BranchJsonConfigCheckPasteboardOnInstall = @"checkPasteboardOnInstall";
 
@@ -73,7 +72,7 @@ - (void)loadConfigFile
 - (NSData *)configFileContents
 {
     if (!self.configFileURL) return nil;
-    BNCLog([NSString stringWithFormat:@"Loading %@", self.configFileURL.pathComponents.lastObject]);
+    BNCLogDebug([NSString stringWithFormat:@"Loading %@", self.configFileURL.pathComponents.lastObject]);
 
     NSError *error;
     NSData *data = [NSData dataWithContentsOfURL:self.configFileURL options:0 error:&error];
@@ -99,12 +98,17 @@ - (void)findConfigFile
       @"branch.ios",
       @"branch"
       ];
-
+    
     [filesToCheck enumerateObjectsUsingBlock:^(NSString *  _Nonnull file, NSUInteger idx, BOOL * _Nonnull stop) {
         configFileURL = [mainBundle URLForResource:file withExtension:@"json"];
         *stop = (configFileURL != nil);
     }];
-
+    
+    // Unity places the config at [[NSBundle mainBundle] bundlePath] + /Data/Raw/branch.json
+    if (!configFileURL) {
+        configFileURL = [mainBundle URLForResource:@"branch" withExtension:@"json" subdirectory:@"Data/Raw"];
+    }
+    
     if (!configFileURL) {
         BNCLogDebug(@"No branch.json in app bundle.");
         return;
@@ -125,21 +129,15 @@ - (BOOL)useTestInstance
     return number.boolValue;
 }
 
-- (BOOL)delayInitToCheckForSearchAds
-{
-    NSNumber *number = self[BranchJsonConfigDelayInitToCheckForSearchAdsOption];
-    return number.boolValue;
-}
-
-- (BOOL)appleSearchAdsDebugMode
+- (BOOL)deferInitForPluginRuntime
 {
-    NSNumber *number = self[BranchJsonConfigAppleSearchAdsDebugModeOption];
+    NSNumber *number = self[BranchJsonConfigDeferInitForPluginRuntimeOption];
     return number.boolValue;
 }
 
-- (BOOL)deferInitializationForJSLoad
+- (BOOL)enableLogging
 {
-    NSNumber *number = self[BranchJsonConfigDeferInitializationForJSLoadOption];
+    NSNumber *number = self[BranchJsonConfigEnableLogging];
     return number.boolValue;
 }
 

BranchSDK/BranchPluginSupport.h

@@ -13,6 +13,7 @@ NS_ASSUME_NONNULL_BEGIN
 @interface BranchPluginSupport : NSObject
 
 + (BranchPluginSupport *)instance;
+
 - (NSDictionary<NSString *, NSString *> *)deviceDescription;
 
 @end

BranchSDK/BranchPluginSupport.m

@@ -10,10 +10,7 @@
 #import "NSMutableDictionary+Branch.h"
 #import "BNCDeviceInfo.h"
 #import "BNCPreferenceHelper.h"
-
-@interface BranchPluginSupport()
-
-@end
+#import "Branch.h"
 
 @implementation BranchPluginSupport
 
@@ -26,7 +23,6 @@ + (BranchPluginSupport *)instance {
     return pluginSupport;
 }
 
-
 - (NSDictionary<NSString *, NSString *> *)deviceDescription {
     NSMutableDictionary<NSString *, NSString *> *dictionary = [NSMutableDictionary new];
     BNCDeviceInfo *deviceInfo = [BNCDeviceInfo getInstance];