INTENG-3137 Handle duplicate local attribution calls (#558)

aaustin · E-B-Smith · commit a2e03afd9997 · 2017-02-01T13:39:54.000-08:00
* Handle duplicate local attribution calls
* Match getter setter to variable
* Better boolean logic
diff --git a/Branch-SDK/Branch-SDK/BNCPreferenceHelper.h b/Branch-SDK/Branch-SDK/BNCPreferenceHelper.h
@@ -31,6 +31,7 @@
 @property (assign, nonatomic) BOOL shouldWaitForInit;
 @property (assign, nonatomic) BOOL suppressWarningLogs;
 @property (assign, nonatomic) BOOL checkedFacebookAppLinks;
+@property (assign, nonatomic) BOOL checkedAppleSearchAdAttribution;
 @property (assign, nonatomic) NSInteger retryCount;
 @property (assign, nonatomic) NSTimeInterval retryInterval;
 @property (assign, nonatomic) NSTimeInterval timeout;
diff --git a/Branch-SDK/Branch-SDK/BNCPreferenceHelper.m b/Branch-SDK/Branch-SDK/BNCPreferenceHelper.m
@@ -26,6 +26,7 @@
 NSString * const BRANCH_PREFS_KEY_IDENTITY_ID = @"bnc_identity_id";
 NSString * const BRANCH_PREFS_KEY_IDENTITY = @"bnc_identity";
 NSString * const BRANCH_PREFS_KEY_CHECKED_FACEBOOK_APP_LINKS = @"bnc_checked_fb_app_links";
+NSString * const BRANCH_PREFS_KEY_CHECKED_APPLE_SEARCH_ADS = @"bnc_checked_apple_search_ads";
 NSString * const BRANCH_PREFS_KEY_APPLE_SEARCH_ADS_INFO = @"bnc_apple_search_ads_info";
 NSString * const BRANCH_PREFS_KEY_LINK_CLICK_IDENTIFIER = @"bnc_link_click_identifier";
 NSString * const BRANCH_PREFS_KEY_SPOTLIGHT_IDENTIFIER = @"bnc_spotlight_identifier";
@@ -80,6 +81,7 @@ @implementation BNCPreferenceHelper
             timeout = _timeout,
             lastStrongMatchDate = _lastStrongMatchDate,
             checkedFacebookAppLinks = _checkedFacebookAppLinks,
+            checkedAppleSearchAdAttribution = _checkedAppleSearchAdAttribution,
             appleSearchAdDetails = _appleSearchAdDetails,
             requestMetadataDictionary = _requestMetadataDictionary,
             instrumentationDictionary = _instrumentationDictionary;
@@ -444,6 +446,17 @@ - (void)setUserUrl:(NSString *)userUrl {
     }
 }
 
+- (BOOL)checkedAppleSearchAdAttribution {
+    _checkedAppleSearchAdAttribution = [self readBoolFromDefaults:BRANCH_PREFS_KEY_CHECKED_APPLE_SEARCH_ADS];
+    return _checkedAppleSearchAdAttribution;
+}
+
+- (void)setCheckedAppleSearchAdAttribution:(BOOL)checked {
+    _checkedAppleSearchAdAttribution = checked;
+    [self writeBoolToDefaults:BRANCH_PREFS_KEY_CHECKED_APPLE_SEARCH_ADS value:checked];
+}
+
+
 - (BOOL)checkedFacebookAppLinks {
     _checkedFacebookAppLinks = [self readBoolFromDefaults:BRANCH_PREFS_KEY_CHECKED_FACEBOOK_APP_LINKS];
     return _checkedFacebookAppLinks;
diff --git a/Branch-SDK/Branch-SDK/Branch.m b/Branch-SDK/Branch-SDK/Branch.m
@@ -91,6 +91,7 @@ @interface Branch() <BranchDeepLinkingControllerCompletionDelegate, FABKit>
 @property (copy,   nonatomic) callbackWithParams sessionInitWithParamsCallback;
 @property (copy,   nonatomic) callbackWithBranchUniversalObject sessionInitWithBranchUniversalObjectCallback;
 @property (assign, nonatomic) NSInteger networkCount;
+@property (assign, nonatomic) NSInteger asyncRequestCount;
 @property (assign, nonatomic) BOOL isInitialized;
 @property (assign, nonatomic) BOOL shouldCallSessionInitCallback;
 @property (assign, nonatomic) BOOL shouldAutomaticallyDeepLink;
@@ -175,6 +176,7 @@ - (id)initWithInterface:(BNCServerInterface *)interface queue:(BNCServerRequestQ
         _shouldCallSessionInitCallback = YES;
         _processing_sema = dispatch_semaphore_create(1);
         _networkCount = 0;
+        _asyncRequestCount = 0;
         _deepLinkControllers = [[NSMutableDictionary alloc] init];
         _whiteListedSchemeList = [[NSMutableArray alloc] init];
         _useCookieBasedMatching = YES;
@@ -370,9 +372,14 @@ - (void)initSessionWithLaunchOptions:(NSDictionary *)options isReferrable:(BOOL)
         if (![options.allKeys containsObject:UIApplicationLaunchOptionsURLKey] &&
             ![options.allKeys containsObject:UIApplicationLaunchOptionsUserActivityDictionaryKey]) {
             
+            self.asyncRequestCount = 0;
+
             // If Facebook SDK is present, call deferred app link check here which will later on call initUserSession
-            if (![self checkFacebookAppLinks] && ![self checkAppleSearchAdsAttribution]) {
-                
+            [self checkFacebookAppLinks];
+            // If developer opted in, call deferred apple search attribution API here which will later on call initUserSession
+            [self checkAppleSearchAdsAttribution];
+            
+            if (self.asyncRequestCount == 0) {
                 // If we're not looking for App Links or Apple Search Ads, initialize
                 [self initUserSessionAndCallCallback:YES];
             }
@@ -540,9 +547,11 @@ - (BOOL)checkAppleSearchAdsAttribution {
             id sharedClientInstance = ((id (*)(id, SEL))[ADClientClass methodForSelector:sharedClient])(ADClientClass, sharedClient);
             
             self.preferenceHelper.shouldWaitForInit = YES;
+            self.preferenceHelper.checkedAppleSearchAdAttribution = YES;
+            self.asyncRequestCount++;
             
             void (^__nullable completionBlock)(NSDictionary *attrDetails, NSError *error) = ^void(NSDictionary *__nullable attrDetails, NSError *__nullable error) {
-                self.preferenceHelper.shouldWaitForInit = NO;
+                self.asyncRequestCount--;
                 
                 if (attrDetails && [attrDetails count]) {
                     self.preferenceHelper.appleSearchAdDetails = attrDetails;
@@ -567,6 +576,11 @@ - (BOOL)checkAppleSearchAdsAttribution {
                     self.preferenceHelper.appleSearchAdDetails = testInfo;
                 }
                 
+                // if there's another async attribution check in flight, don't continue with init
+                if (self.asyncRequestCount > 0) { return; }
+                
+                self.preferenceHelper.shouldWaitForInit = NO;
+                
                 dispatch_async(dispatch_get_main_queue(), ^{
                     [self initUserSessionAndCallCallback:!self.isInitialized];
                 });
@@ -594,10 +608,17 @@ - (BOOL)checkFacebookAppLinks {
         
         if ([self.FBSDKAppLinkUtility methodForSelector:fetchDeferredAppLink]) {
             void (^__nullable completionBlock)(NSURL *appLink, NSError *error) = ^void(NSURL *__nullable appLink, NSError *__nullable error) {
+                self.asyncRequestCount--;
+                
+                // if there's another async attribution check in flight, don't continue with init
+                if (self.asyncRequestCount > 0) { return; }
+                
                 self.preferenceHelper.shouldWaitForInit = NO;
+                
                 [self handleDeepLink:appLink];
             };
         
+            self.asyncRequestCount++;
             self.preferenceHelper.checkedFacebookAppLinks = YES;
             self.preferenceHelper.shouldWaitForInit = YES;
         
diff --git a/Branch-SDK/Branch-SDK/BranchConstants.h b/Branch-SDK/Branch-SDK/BranchConstants.h
@@ -50,6 +50,7 @@ extern NSString * const BRANCH_REQUEST_KEY_OS_VERSION;
 extern NSString * const BRANCH_REQUEST_KEY_URI_SCHEME;
 extern NSString * const BRANCH_REQUEST_KEY_UPDATE;
 extern NSString * const BRANCH_REQUEST_KEY_CHECKED_FACEBOOK_APPLINKS;
+extern NSString * const BRANCH_REQUEST_KEY_CHECKED_APPLE_AD_ATTRIBUTION;
 extern NSString * const BRANCH_REQUEST_KEY_LINK_IDENTIFIER;
 extern NSString * const BRANCH_REQUEST_KEY_SPOTLIGHT_IDENTIFIER;
 extern NSString * const BRANCH_REQUEST_KEY_UNIVERSAL_LINK_URL;
diff --git a/Branch-SDK/Branch-SDK/BranchConstants.m b/Branch-SDK/Branch-SDK/BranchConstants.m
@@ -51,6 +51,7 @@
 NSString * const BRANCH_REQUEST_KEY_UPDATE = @"update";
 NSString * const BRANCH_REQUEST_KEY_LINK_IDENTIFIER = @"link_identifier";
 NSString * const BRANCH_REQUEST_KEY_CHECKED_FACEBOOK_APPLINKS = @"facebook_app_link_checked";
+NSString * const BRANCH_REQUEST_KEY_CHECKED_APPLE_AD_ATTRIBUTION = @"apple_ad_attribution_checked";
 NSString * const BRANCH_REQUEST_KEY_SPOTLIGHT_IDENTIFIER = @"spotlight_identifier";
 NSString * const BRANCH_REQUEST_KEY_UNIVERSAL_LINK_URL = @"universal_link_url";
 NSString * const BRANCH_REQUEST_KEY_BRAND = @"brand";
diff --git a/Branch-SDK/Branch-SDK/Requests/BranchInstallRequest.m b/Branch-SDK/Branch-SDK/Requests/BranchInstallRequest.m
@@ -31,6 +31,7 @@ - (void)makeRequest:(BNCServerInterface *)serverInterface key:(NSString *)key ca
     [self safeSetValue:[BNCSystemObserver getDefaultUriScheme] forKey:BRANCH_REQUEST_KEY_URI_SCHEME onDict:params];
     [self safeSetValue:[BNCSystemObserver getUpdateState] forKey:BRANCH_REQUEST_KEY_UPDATE onDict:params];
     [self safeSetValue:[NSNumber numberWithBool:preferenceHelper.checkedFacebookAppLinks] forKey:BRANCH_REQUEST_KEY_CHECKED_FACEBOOK_APPLINKS onDict:params];
+    [self safeSetValue:[NSNumber numberWithBool:preferenceHelper.checkedAppleSearchAdAttribution] forKey:BRANCH_REQUEST_KEY_CHECKED_APPLE_AD_ATTRIBUTION onDict:params];
     [self safeSetValue:preferenceHelper.linkClickIdentifier forKey:BRANCH_REQUEST_KEY_LINK_IDENTIFIER onDict:params];
     [self safeSetValue:preferenceHelper.spotlightIdentifier forKey:BRANCH_REQUEST_KEY_SPOTLIGHT_IDENTIFIER onDict:params];
     [self safeSetValue:preferenceHelper.universalLinkUrl forKey:BRANCH_REQUEST_KEY_UNIVERSAL_LINK_URL onDict:params];
diff --git a/Branch-SDK/Branch-SDK/Requests/BranchOpenRequest.m b/Branch-SDK/Branch-SDK/Requests/BranchOpenRequest.m
@@ -54,6 +54,7 @@ - (void)makeRequest:(BNCServerInterface *)serverInterface key:(NSString *)key ca
     [self safeSetValue:[BNCSystemObserver getDefaultUriScheme] forKey:BRANCH_REQUEST_KEY_URI_SCHEME onDict:params];
     [self safeSetValue:[BNCSystemObserver getUpdateState] forKey:BRANCH_REQUEST_KEY_UPDATE onDict:params];
     [self safeSetValue:[NSNumber numberWithBool:preferenceHelper.checkedFacebookAppLinks] forKey:BRANCH_REQUEST_KEY_CHECKED_FACEBOOK_APPLINKS onDict:params];
+    [self safeSetValue:[NSNumber numberWithBool:preferenceHelper.checkedAppleSearchAdAttribution] forKey:BRANCH_REQUEST_KEY_CHECKED_APPLE_AD_ATTRIBUTION onDict:params];
     [self safeSetValue:preferenceHelper.linkClickIdentifier forKey:BRANCH_REQUEST_KEY_LINK_IDENTIFIER onDict:params];
     [self safeSetValue:preferenceHelper.spotlightIdentifier forKey:BRANCH_REQUEST_KEY_SPOTLIGHT_IDENTIFIER onDict:params];
     [self safeSetValue:preferenceHelper.universalLinkUrl forKey:BRANCH_REQUEST_KEY_UNIVERSAL_LINK_URL onDict:params];
