SDK-1831 move feature to Branch class

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 deferInitForPlugin to true in branch.json
+@property (nonatomic, assign, readwrite) BOOL deferInitForPlugin;
+@property (nonatomic, copy, nullable) void (^cachedInitBlock)(void);
+
 @end
 
 @implementation Branch
@@ -226,6 +231,7 @@ - (id)initWithInterface:(BNCServerInterface *)interface
     [self loadUserAgent];
 
     BranchJsonConfig *config = BranchJsonConfig.instance;
+    self.deferInitForPlugin = config.deferInitForPlugin;
 
     if (config.enableLogging) {
         [self enableLogging];
@@ -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,6 +2144,34 @@ - (void)clearNetworkQueue {
 
 #pragma mark - Session Initialization
 
+// Defers block until notifyNativeToInit is called. Also blocks autoinitialization by initSafetyCheck.
+- (BOOL)deferInitBlock:(void (^)(void))block {
+    BOOL deferred = NO;
+    @synchronized (self) {
+        if (self.deferInitForPlugin) {
+            self.cachedInitBlock = block;
+            deferred = YES;
+        }
+    }
+    
+    if (!deferred && block) {
+        block();
+    }
+    return deferred;
+}
+
+// Releases deferred init block
+- (void)notifyNativeToInit {
+    @synchronized (self) {
+        self.deferInitForPlugin = 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

BranchSDK/BranchPluginSupport.h

@@ -7,28 +7,13 @@
 //
 
 #import <Foundation/Foundation.h>
-#import "BranchUniversalObject.h"
 
 NS_ASSUME_NONNULL_BEGIN
 
 @interface BranchPluginSupport : NSObject
 
 + (BranchPluginSupport *)instance;
 
-#pragma mark - SDK entry points
-
-- (void)initSessionWithLaunchOptions:(nullable NSDictionary *)options registerDeepLinkHandler:(void (^)(NSDictionary * _Nullable params, NSError * _Nullable error))callback;
-
-- (void)initSessionWithLaunchOptions:(nullable NSDictionary *)options registerDeepLinkHandlerUsingBranchUniversalObject:(void (^)(BranchUniversalObject * _Nullable universalObject, BranchLinkProperties * _Nullable linkProperties, NSError * _Nullable error))callback;
-
-- (BOOL)handleDeepLink:(nullable NSURL *)url;
-
-- (BOOL)continueUserActivity:(nullable NSUserActivity *)userActivity;
-
-- (void)notifyNativeToInit;
-
-#pragma mark - Utility methods
-
 - (NSDictionary<NSString *, NSString *> *)deviceDescription;
 
 @end

BranchSDK/BranchPluginSupport.m

@@ -11,14 +11,6 @@
 #import "BNCDeviceInfo.h"
 #import "BNCPreferenceHelper.h"
 #import "Branch.h"
-#import "BranchJsonConfig.h"
-
-@interface BranchPluginSupport()
-
-@property (nonatomic, assign, readwrite) BOOL deferInitForPlugin;
-@property (nonatomic, copy, nullable) void (^cachedBlock)(void);
-
-@end
 
 @implementation BranchPluginSupport
 
@@ -31,66 +23,6 @@ + (BranchPluginSupport *)instance {
     return pluginSupport;
 }
 
-- (instancetype)init {
-    self = [super init];
-    if (self) {
-        self.deferInitForPlugin = [BranchJsonConfig instance].deferInitForPlugin;
-    }
-    return self;
-}
-
-- (void)initSessionWithLaunchOptions:(nullable NSDictionary *)options registerDeepLinkHandler:(void (^)(NSDictionary * _Nullable params, NSError * _Nullable error))callback {
-    [self deferBlock:^{
-        [[Branch getInstance] initSessionWithLaunchOptions:options andRegisterDeepLinkHandler:callback];
-    }];
-}
-
-- (void)initSessionWithLaunchOptions:(nullable NSDictionary *)options registerDeepLinkHandlerUsingBranchUniversalObject:(void (^)(BranchUniversalObject * _Nullable universalObject, BranchLinkProperties * _Nullable linkProperties, NSError * _Nullable error))callback {
-    [self deferBlock:^{
-        [[Branch getInstance] initSessionWithLaunchOptions:options andRegisterDeepLinkHandlerUsingBranchUniversalObject:callback];
-    }];
-}
-
-- (BOOL)handleDeepLink:(nullable NSURL *)url {
-    [self deferBlock:^{
-        [[Branch getInstance] handleDeepLink:url sceneIdentifier:nil];
-    }];
-    return YES;
-}
-
-- (BOOL)continueUserActivity:(nullable NSUserActivity *)userActivity {
-    [self deferBlock:^{
-        [[Branch getInstance] continueUserActivity:userActivity sceneIdentifier:nil];
-    }];
-    return YES;
-}
-
-- (BOOL)deferBlock:(void (^)(void))block {
-    BOOL deferred = NO;
-    @synchronized (self) {
-        if (self.deferInitForPlugin) {
-            self.cachedBlock = block;
-            deferred = YES;
-        }
-    }
-    
-    if (!deferred && block) {
-        block();
-    }
-    return deferred;
-}
-
-- (void)notifyNativeToInit {
-    @synchronized (self) {
-        self.deferInitForPlugin = NO;
-    }
-    
-    if (self.cachedBlock) {
-        self.cachedBlock();
-    }
-    self.cachedBlock = nil;
-}
-
 - (NSDictionary<NSString *, NSString *> *)deviceDescription {
     NSMutableDictionary<NSString *, NSString *> *dictionary = [NSMutableDictionary new];
     BNCDeviceInfo *deviceInfo = [BNCDeviceInfo getInstance];