Queued Opens AIS-128 (#506)

* Updated preference helper.

* Updated server queue.

* Tested & fixed for iOS 10/9/8.

* Updated storyboards for Xcode 7.

* Added try/catch to NSKeyedArchiver call.

Author: E-B-Smith

Branch-SDK/Branch-SDK/BNCPreferenceHelper.m

@@ -374,17 +374,20 @@ - (void)setUniversalLinkUrl:(NSString *)universalLinkUrl {
 }
 
 - (NSString *)sessionParams {
-    if (_sessionParams) {
-        _sessionParams = [self readStringFromDefaults:BRANCH_PREFS_KEY_SESSION_PARAMS];
+    @synchronized (self) {
+        if (!_sessionParams) {
+            _sessionParams = [self readStringFromDefaults:BRANCH_PREFS_KEY_SESSION_PARAMS];
+        }
+        return _sessionParams;
     }
-    
-    return _sessionParams;
 }
 
 - (void)setSessionParams:(NSString *)sessionParams {
-    if (![_sessionParams isEqualToString:sessionParams]) {
-        _sessionParams = sessionParams;
-        [self writeObjectToDefaults:BRANCH_PREFS_KEY_SESSION_PARAMS value:sessionParams];
+    @synchronized (self) {
+        if (![_sessionParams isEqualToString:sessionParams]) {
+            _sessionParams = sessionParams;
+            [self writeObjectToDefaults:BRANCH_PREFS_KEY_SESSION_PARAMS value:sessionParams];
+        }
     }
 }
 
@@ -606,42 +609,48 @@ - (NSDictionary *)getContentAnalyticsManifest {
     return (NSDictionary *)[self readObjectFromDefaults:BRANCH_PREFS_KEY_ANALYTICS_MANIFEST];
 }
 
+
 #pragma mark - Writing To Persistence
 
+
 - (void)writeIntegerToDefaults:(NSString *)key value:(NSInteger)value {
-    self.persistenceDict[key] = @(value);
-    [self persistPrefsToDisk];
+    [self writeObjectToDefaults:key value:@(value)];
 }
 
 - (void)writeBoolToDefaults:(NSString *)key value:(BOOL)value {
-    self.persistenceDict[key] = @(value);
-    [self persistPrefsToDisk];
+    [self writeObjectToDefaults:key value:@(value)];
 }
 
 - (void)writeObjectToDefaults:(NSString *)key value:(NSObject *)value {
-    if (value) {
-        self.persistenceDict[key] = value;
-    }
-    else {
-        [self.persistenceDict removeObjectForKey:key];
+    @synchronized (self) {
+        if (value) {
+            self.persistenceDict[key] = value;
+        }
+        else {
+            [self.persistenceDict removeObjectForKey:key];
+        }
+        [self persistPrefsToDisk];
     }
-
-    [self persistPrefsToDisk];
 }
 
 - (void)persistPrefsToDisk {
     @synchronized (self) {
-        NSDictionary *persistenceDict = [self.persistenceDict copy];
+        if (!self.persistenceDict) return;
+        NSData *data = nil;
+        @try {
+            data = [NSKeyedArchiver archivedDataWithRootObject:self.persistenceDict];
+        }
+        @catch (id exception) {
+            data = nil;
+            [self logWarning:
+                [NSString stringWithFormat:@"Exception creating preferences data: %@.",
+                    exception]];
+        }
+        if (!data) {
+            [self logWarning:@"Can't create preferences data."];
+            return;
+        }
         NSBlockOperation *newPersistOp = [NSBlockOperation blockOperationWithBlock:^ {
-            NSData *data = nil;
-            @try {
-                data = [NSKeyedArchiver archivedDataWithRootObject:persistenceDict];
-            } @catch (id n) {
-            }
-            if (!data) {
-                [self logWarning:@"Can't create preferences archive."];
-                return;
-            }
             NSError *error = nil;
             [data writeToURL:self.class.URLForPrefsFile
                 options:NSDataWritingAtomic error:&error];
@@ -651,7 +660,7 @@ - (void)persistPrefsToDisk {
                         @"Failed to persist preferences to disk: %@.", error]];
             }
         }];
-    [self.persistPrefsQueue addOperation:newPersistOp];
+        [self.persistPrefsQueue addOperation:newPersistOp];
     }
 }
 

Branch-SDK/Branch-SDK/BNCServerRequestQueue.h

@@ -26,6 +26,7 @@
 - (void)clearQueue;
 
 - (BOOL)containsInstallOrOpen;
+- (BOOL)removeInstallOrOpen;
 - (BOOL)containsClose;
 - (BranchOpenRequest *)moveInstallOrOpenToFront:(NSInteger)networkCount;
 

Branch-SDK/Branch-SDK/BNCServerRequestQueue.m

@@ -131,6 +131,21 @@ - (BOOL)containsInstallOrOpen {
     return NO;
 }
 
+- (BOOL)removeInstallOrOpen {
+    @synchronized (self.queue) {
+        for (int i = 0; i < self.queue.count; i++) {
+            BranchOpenRequest *req = [self.queue objectAtIndex:i];
+            // Install extends open, so only need to check open.
+            if ([req isKindOfClass:[BranchOpenRequest class]]) {
+                req.callback = nil;
+                [self remove:req];
+                return YES;
+            }
+        }
+        return NO;
+    }
+}
+
 - (BranchOpenRequest *)moveInstallOrOpenToFront:(NSInteger)networkCount {
     BOOL requestAlreadyInProgress = networkCount > 0;
 

Branch-SDK/Branch-SDK/Branch.m

@@ -72,11 +72,10 @@ @interface Branch() <BranchDeepLinkingControllerCompletionDelegate, FABKit>
 
 
 @property (strong, nonatomic) BNCServerInterface *bServerInterface;
-@property (strong, nonatomic) NSTimer *sessionTimer;
 @property (strong, nonatomic) BNCServerRequestQueue *requestQueue;
 @property (strong, nonatomic) dispatch_semaphore_t processing_sema;
-@property (strong, nonatomic) callbackWithParams sessionInitWithParamsCallback;
-@property (strong, nonatomic) callbackWithBranchUniversalObject sessionInitWithBranchUniversalObjectCallback;
+@property (copy,   nonatomic) callbackWithParams sessionInitWithParamsCallback;
+@property (copy,   nonatomic) callbackWithBranchUniversalObject sessionInitWithBranchUniversalObjectCallback;
 @property (assign, nonatomic) NSInteger networkCount;
 @property (assign, nonatomic) BOOL isInitialized;
 @property (assign, nonatomic) BOOL shouldCallSessionInitCallback;
@@ -86,15 +85,15 @@ @interface Branch() <BranchDeepLinkingControllerCompletionDelegate, FABKit>
 @property (strong, nonatomic) BNCContentDiscoveryManager *contentDiscoveryManager;
 @property (strong, nonatomic) NSString *branchKey;
 @property (strong, nonatomic) NSMutableDictionary *deepLinkControllers;
-@property (weak, nonatomic) UIViewController *deepLinkPresentingController;
+@property (weak,   nonatomic) UIViewController *deepLinkPresentingController;
 @property (assign, nonatomic) BOOL useCookieBasedMatching;
 @property (strong, nonatomic) NSDictionary *deepLinkDebugParams;
 @property (assign, nonatomic) BOOL accountForFacebookSDK;
 @property (assign, nonatomic) id FBSDKAppLinkUtility;
 @property (assign, nonatomic) BOOL delayForAppleAds;
 @property (assign, nonatomic) BOOL searchAdsDebugMode;
 @property (strong, nonatomic) NSMutableArray *whiteListedSchemeList;
-
+@property (assign, nonatomic) BOOL appIsInBackground;
 @end
 
 @implementation Branch
@@ -1152,6 +1151,7 @@ - (BNCLinkData *)prepareLinkDataFor:(NSArray *)tags andAlias:(NSString *)alias a
 
 #pragma mark - BranchUniversalObject methods
 
+
 - (void)registerViewWithParams:(NSDictionary *)params andCallback:(callbackWithParams)callback {
     [self initSessionIfNeededAndNotInProgress];
 
@@ -1164,22 +1164,18 @@ - (void)registerViewWithParams:(NSDictionary *)params andCallback:(callbackWithP
 #pragma mark - Application State Change methods
 
 - (void)applicationDidBecomeActive {
-    [self clearTimer];
+    self.appIsInBackground = NO;
     if (!self.isInitialized && !self.preferenceHelper.shouldWaitForInit && ![self.requestQueue containsInstallOrOpen]) {
         [self initUserSessionAndCallCallback:YES];
     }
 }
 
 - (void)applicationWillResignActive {
-    [self clearTimer];
-    self.sessionTimer = [NSTimer scheduledTimerWithTimeInterval:0.5 target:self selector:@selector(callClose) userInfo:nil repeats:NO];
+    self.appIsInBackground = YES;
+    [self callClose];
     [self.requestQueue persistImmediately];
 }
 
-- (void)clearTimer {
-    [self.sessionTimer invalidate];
-}
-
 - (void)callClose {
     if (self.isInitialized) {
         self.isInitialized = NO;
@@ -1268,11 +1264,7 @@ - (void)processNextQueueItem {
                 [req processResponse:nil error:[NSError errorWithDomain:BNCErrorDomain code:BNCInitError userInfo:@{ NSLocalizedDescriptionKey: @"Branch User Session has not been initialized" }]];
                 return;
             }
-            
-            if (![req isKindOfClass:[BranchCloseRequest class]]) {
-                [self clearTimer];
-            }
-            
+                        
             [req makeRequest:self.bServerInterface key:self.branchKey callback:callback];
         }
     }
@@ -1338,26 +1330,17 @@ - (void)registerInstallOrOpen:(Class)clazz {
     if ([BNCSystemObserver getOSVersion].integerValue >= 9 && self.useCookieBasedMatching) {
         [[BNCStrongMatchHelper strongMatchHelper] createStrongMatchWithBranchKey:self.branchKey];
     }
-    
-    // If there isn't already an Open / Install request, add one to the queue
-    if (![self.requestQueue containsInstallOrOpen]) {
-        BranchOpenRequest *req = [[clazz alloc] initWithCallback:initSessionCallback];
-        
-        [self insertRequestAtFront:req];
-    }
-    // If there is already one in the queue, make sure it's in the front.
-    // Make sure a callback is associated with this request. This callback can
-    // be cleared if the app is terminated while an Open/Install is pending.
-    else {
-        BranchOpenRequest *req = [self.requestQueue moveInstallOrOpenToFront:self.networkCount];
-        req.callback = initSessionCallback;
-    }
-    
+
+    if ([self.requestQueue removeInstallOrOpen])
+        self.networkCount = 0;
+    BranchOpenRequest *req = [[clazz alloc] initWithCallback:initSessionCallback];
+    [self insertRequestAtFront:req];
     [self processNextQueueItem];
 }
 
 - (void)handleInitSuccess {
-    self.isInitialized = YES;
+    if (!self.appIsInBackground)
+        self.isInitialized = YES;
 
     NSDictionary *latestReferringParams = [self getLatestReferringParams];
     if (self.shouldCallSessionInitCallback) {
@@ -1436,4 +1419,4 @@ + (NSString *)kitDisplayVersion {
 	return @"0.12.16";
 }
 
-@end
+@end

Branch-SDK/Branch-SDK/Requests/BranchOpenRequest.h

@@ -11,7 +11,7 @@
 
 @interface BranchOpenRequest : BNCServerRequest
 
-@property (strong, nonatomic) callbackWithStatus callback;
+@property (copy, nonatomic) callbackWithStatus callback;
 
 - (id)initWithCallback:(callbackWithStatus)callback;
 - (id)initWithCallback:(callbackWithStatus)callback isInstall:(BOOL)isInstall;

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

@@ -22,6 +22,7 @@ @interface BranchOpenRequest ()
 
 @end
 
+
 @implementation BranchOpenRequest
 
 - (id)initWithCallback:(callbackWithStatus)callback {

Branch-TestBed/Branch-TestBed/main.m

@@ -10,8 +10,7 @@
 
 #import "AppDelegate.h"
 
-int main(int argc, char * argv[])
-{
+int main(int argc, char * argv[]) {
     @autoreleasepool {
         return UIApplicationMain(argc, argv, nil, NSStringFromClass([AppDelegate class]));
     }