Send the Apple Search Ad attribution only when it changes (DLA-969, #723).

Author: E-B-Smith

Branch-SDK/Branch-SDK/BNCPreferenceHelper.h

@@ -39,6 +39,7 @@ NSURL* /* _Nonnull */ BNCURLForBranchDirectory(void);
 @property (strong, nonatomic) NSMutableDictionary *savedAnalyticsData;
 @property (assign, nonatomic) NSInteger installRequestDelay;
 @property (strong, nonatomic) NSDictionary *appleSearchAdDetails;
+@property (assign, nonatomic) BOOL          appleSearchAdNeedsSend;
 @property (strong, nonatomic) NSString *lastSystemBuildVersion;
 @property (strong, nonatomic) NSString *browserUserAgentString;
 @property (strong, atomic) NSString *branchAPIURL;

Branch-SDK/Branch-SDK/BNCPreferenceHelper.m

@@ -121,24 +121,6 @@ + (BNCPreferenceHelper *)getInstance {
     return preferenceHelper;
 }
 
-
-/*
-
-    This creates one global queue.  Not so desirable.
-
-- (NSOperationQueue *)persistPrefsQueue {
-    static NSOperationQueue *persistPrefsQueue;
-    static dispatch_once_t persistOnceToken;
-    
-    dispatch_once(&persistOnceToken, ^{
-        persistPrefsQueue = [[NSOperationQueue alloc] init];
-        persistPrefsQueue.maxConcurrentOperationCount = 1;
-    });
-
-    return persistPrefsQueue;
-}
-*/
-
 - (NSOperationQueue *)persistPrefsQueue {
     @synchronized (self) {
         if (_persistPrefsQueue)
@@ -421,6 +403,14 @@ - (NSDictionary*) appleSearchAdDetails {
     return [_appleSearchAdDetails isKindOfClass:[NSDictionary class]] ? _appleSearchAdDetails : nil;
 }
 
+- (void) setAppleSearchAdNeedsSend:(BOOL)appleSearchAdNeedsSend {
+    [self writeBoolToDefaults:@"_appleSearchAdNeedsSend" value:appleSearchAdNeedsSend];
+}
+
+- (BOOL) appleSearchAdNeedsSend {
+    return [self readBoolFromDefaults:@"_appleSearchAdNeedsSend"];
+}
+
 - (NSString*) lastSystemBuildVersion {
     if (!_lastSystemBuildVersion) {
         _lastSystemBuildVersion = [self readStringFromDefaults:@"_lastSystemBuildVersion"];

Branch-SDK/Branch-SDK/Branch.m

@@ -807,20 +807,21 @@ - (BOOL)checkAppleSearchAdsAttribution {
       ^ void(NSDictionary *__nullable attrDetails, NSError *__nullable error) {
         self.asyncRequestCount--;
 
-        if (attrDetails.count) {
-            self.preferenceHelper.appleSearchAdDetails = attrDetails;
-        }
-        else if (self.searchAdsDebugMode) {
+        if (attrDetails.count == 0 && self.searchAdsDebugMode) {
+            // Round down to one day for testing.
+            NSTimeInterval const kOneDay = (60.0*60.0*24.0);
+            NSTimeInterval t = trunc([[NSDate date] timeIntervalSince1970] / kOneDay) * kOneDay;
+            NSDate *date = [NSDate dateWithTimeIntervalSince1970:t];
 
-            NSDictionary *debugSearchAd = @{
+            attrDetails = @{
                 @"Version3.1": @{
                     @"iad-adgroup-id":      @1234567890,
                     @"iad-adgroup-name":    @"AdGroupName",
                     @"iad-attribution":     (id)kCFBooleanTrue,
                     @"iad-campaign-id":     @1234567890,
                     @"iad-campaign-name":   @"CampaignName",
-                    @"iad-click-date":      [NSDate date],
-                    @"iad-conversion-date": [NSDate date],
+                    @"iad-click-date":      date,
+                    @"iad-conversion-date": date,
                     @"iad-creative-id":     @1234567890,
                     @"iad-creative-name":   @"CreativeName",
                     @"iad-keyword":         @"Keyword",
@@ -829,11 +830,17 @@ - (BOOL)checkAppleSearchAdsAttribution {
                     @"iad-org-name":        @"OrgName"
                 }
             };
+        }
 
-            self.preferenceHelper.appleSearchAdDetails = debugSearchAd;
+        if (attrDetails == nil) attrDetails = @{};
+        if (self.preferenceHelper.appleSearchAdDetails == nil)
+            self.preferenceHelper.appleSearchAdDetails = @{};
+        if (![self.preferenceHelper.appleSearchAdDetails isEqualToDictionary:attrDetails]) {
+            self.preferenceHelper.appleSearchAdDetails = attrDetails;
+            self.preferenceHelper.appleSearchAdNeedsSend = YES;
         }
 
-        // if there's another async attribution check in flight, don't continue with init
+        // If there's another async attribution check in flight, don't continue with init
         if (self.asyncRequestCount > 0) { return; }
 
         self.preferenceHelper.shouldWaitForInit = NO;
@@ -843,13 +850,14 @@ - (BOOL)checkAppleSearchAdsAttribution {
         });
     };
 
-    ((void (*)(id, SEL, void (^ __nullable)(NSDictionary *__nullable attrDetails, NSError * __nullable error)))[sharedClientInstance methodForSelector:requestAttribution])(sharedClientInstance, requestAttribution, completionBlock);
+    ((void (*)(id, SEL, void (^ __nullable)(NSDictionary *__nullable attrDetails, NSError * __nullable error)))
+        [sharedClientInstance methodForSelector:requestAttribution])
+            (sharedClientInstance, requestAttribution, completionBlock);
 
     return YES;
 }
 
-
-# pragma mark - Facebook App Link check
+#pragma mark - Facebook App Link Check
 
 - (void)registerFacebookDeepLinkingClass:(id)FBSDKAppLinkUtility {
     self.FBSDKAppLinkUtility = FBSDKAppLinkUtility;

Branch-SDK/Branch-SDK/Networking/Requests/BranchInstallRequest.m

@@ -38,7 +38,7 @@ - (void)makeRequest:(BNCServerInterface *)serverInterface key:(NSString *)key ca
 
     params[BRANCH_REQUEST_KEY_DEBUG] = @(preferenceHelper.isDebug);
 
-    if (preferenceHelper.appleSearchAdDetails) {
+    if (preferenceHelper.appleSearchAdNeedsSend) {
         NSString *encodedSearchData = nil;
         @try {
             NSData *jsonData = [BNCEncodingUtils encodeDictionaryToJsonData:preferenceHelper.appleSearchAdDetails];

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

@@ -57,8 +57,10 @@ - (void)makeRequest:(BNCServerInterface *)serverInterface key:(NSString *)key ca
     [self safeSetValue:[BNCSystemObserver getAppVersion] forKey:BRANCH_REQUEST_KEY_APP_VERSION onDict:params];
     [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:[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];
@@ -70,7 +72,7 @@ - (void)makeRequest:(BNCServerInterface *)serverInterface key:(NSString *)key ca
     [cdDict bnc_safeSetObject:[BNCSystemObserver getBundleID] forKey:BRANCH_BUNDLE_IDENTIFIER];
     [self safeSetValue:cdDict forKey:BRANCH_CONTENT_DISCOVER_KEY onDict:params];
 
-    if (preferenceHelper.appleSearchAdDetails) {
+    if (preferenceHelper.appleSearchAdNeedsSend) {
         NSString *encodedSearchData = nil;
         @try {
             NSData *jsonData = [BNCEncodingUtils encodeDictionaryToJsonData:preferenceHelper.appleSearchAdDetails];
@@ -80,7 +82,6 @@ - (void)makeRequest:(BNCServerInterface *)serverInterface key:(NSString *)key ca
                     forKey:BRANCH_REQUEST_KEY_SEARCH_AD
                     onDict:params];
     }
-    /**/
 
     [serverInterface postRequest:params url:[preferenceHelper getAPIURL:BRANCH_REQUEST_ENDPOINT_OPEN] key:key callback:callback];
 }
@@ -186,7 +187,7 @@ - (void)processResponse:(BNCServerResponse *)response error:(NSError *)error {
     preferenceHelper.spotlightIdentifier = nil;
     preferenceHelper.universalLinkUrl = nil;
     preferenceHelper.externalIntentURI = nil;
-    preferenceHelper.appleSearchAdDetails = nil;
+    preferenceHelper.appleSearchAdNeedsSend = NO;
 
     if (data[BRANCH_RESPONSE_KEY_BRANCH_IDENTITY]) {
         preferenceHelper.identityID = data[BRANCH_RESPONSE_KEY_BRANCH_IDENTITY];