Merge pull request #1007 from BranchMetrics/SDK-842-disable-Ad-network-callout-option-

SDK-842 disable ad network callout option

Author: echo-branch

Branch-SDK-Tests/BNCDeviceInfoTests.m

@@ -136,10 +136,12 @@ - (void)testLocalIPAddress {
 - (void)testV2Dictionary {
     NSDictionary *dict = [self.deviceInfo v2dictionary];
     XCTAssertNotNil(dict);
-    XCTAssertNotNil([dict objectForKey:@"brand"]);
-    XCTAssertNotNil([dict objectForKey:@"os"]);
-    XCTAssertNotNil([dict objectForKey:@"sdk"]);
-    XCTAssertNotNil([dict objectForKey:@"sdk_version"]);
+    XCTAssertNotNil(dict[@"brand"]);
+    XCTAssertNotNil(dict[@"os"]);
+    XCTAssertNotNil(dict[@"sdk"]);
+    XCTAssertNotNil(dict[@"sdk_version"]);
+    
+    XCTAssertNil(dict[@"disable_ad_network_callouts"]);
 }
 
 @end

Branch-SDK-Tests/BNCDisableAdNetworkCalloutsTests.m

@@ -0,0 +1,58 @@
+//
+//  BNCDisableAdNetworkCalloutsTests.m
+//  Branch-SDK-Tests
+//
+//  Created by Ernest Cho on 3/2/20.
+//  Copyright © 2020 Branch, Inc. All rights reserved.
+//
+
+#import <XCTest/XCTest.h>
+#import "BNCPreferenceHelper.h"
+#import "BNCDeviceInfo.h"
+#import "BNCServerInterface.h"
+
+@interface BNCServerInterface()
+- (void)updateDeviceInfoToMutableDictionary:(NSMutableDictionary *)dict;
+@end
+
+@interface BNCDisableAdNetworkCalloutsTests : XCTestCase
+
+@end
+
+// These tests are not parallelizable and therefore disabled by default
+// This is due to the tight coupling between BNCPreferenceHelper and BNCDeviceInfo
+@implementation BNCDisableAdNetworkCalloutsTests
+
+- (void)setUp {
+    [BNCPreferenceHelper preferenceHelper].disableAdNetworkCallouts = YES;
+}
+
+- (void)tearDown {
+    [BNCPreferenceHelper preferenceHelper].disableAdNetworkCallouts = NO;
+}
+
+// check on the V2 dictionary
+- (void)testV2Dictionary {
+    NSDictionary *dict = [[BNCDeviceInfo getInstance] v2dictionary];
+    XCTAssertNotNil(dict);
+    XCTAssertNotNil(dict[@"brand"]);
+    XCTAssertNotNil(dict[@"os"]);
+    XCTAssertNotNil(dict[@"sdk"]);
+    XCTAssertNotNil(dict[@"sdk_version"]);
+    
+    XCTAssertTrue(dict[@"disable_ad_network_callouts"]);
+}
+
+// check on V1 payload
+- (void)testV1Payload {
+    BNCServerInterface *interface = [BNCServerInterface new];
+    interface.preferenceHelper = [BNCPreferenceHelper preferenceHelper];
+    
+    NSMutableDictionary *tmp = [NSMutableDictionary new];
+    [interface updateDeviceInfoToMutableDictionary:tmp];
+    
+    XCTAssertNotNil(tmp);
+    XCTAssertTrue(tmp[@"disable_ad_network_callouts"]);
+}
+
+@end

Branch-SDK-Tests/BNCPreferenceHelperTests.m

@@ -29,6 +29,7 @@ - (void)testPreferenceDefaults {
     XCTAssertEqual(self.prefHelper.timeout, 5.5);
     XCTAssertEqual(self.prefHelper.retryInterval, 0);
     XCTAssertEqual(self.prefHelper.retryCount, 3);
+    XCTAssertFalse(self.prefHelper.disableAdNetworkCallouts);
 }
 
 - (void)testPreferenceSets {

Branch-SDK/Branch-SDK/BNCDeviceInfo.m

@@ -149,6 +149,11 @@ - (NSDictionary *)v2dictionary {
     @synchronized (self) {
         [self checkAdvertisingIdentifier];
 
+        BOOL disableAdNetworkCallouts = [BNCPreferenceHelper preferenceHelper].disableAdNetworkCallouts;
+        if (disableAdNetworkCallouts) {
+            dictionary[@"disable_ad_network_callouts"] = [NSNumber numberWithBool:disableAdNetworkCallouts];
+        }
+        
         if ([BNCPreferenceHelper preferenceHelper].isDebug) {
             dictionary[@"unidentified_device"] = @(YES);
         } else {

Branch-SDK/Branch-SDK/BNCPreferenceHelper.h

@@ -49,6 +49,7 @@ NSURL* /* _Nonnull */ BNCURLForBranchDirectory(void);
 @property (nonatomic, strong, readwrite) NSString *branchBlacklistURL;
 @property (assign, atomic) BOOL      limitFacebookTracking;
 @property (strong, atomic) NSDate   *previousAppBuildDate;
+@property (assign, nonatomic, readwrite) BOOL disableAdNetworkCallouts;
 
 @property (strong, nonatomic, readwrite) NSURL *faceBookAppLink;
 

Branch-SDK/Branch-SDK/BNCPreferenceHelper.m

@@ -97,19 +97,19 @@ + (BNCPreferenceHelper *)preferenceHelper {
     return preferenceHelper;
 }
 
-- (id)init {
+- (instancetype)init {
     self = [super init];
-    if (!self) return self;
+    if (self) {
+        _timeout = DEFAULT_TIMEOUT;
+        _retryCount = DEFAULT_RETRY_COUNT;
+        _retryInterval = DEFAULT_RETRY_INTERVAL;
+        _isDebug = NO;
+        _persistPrefsQueue = [[NSOperationQueue alloc] init];
+        _persistPrefsQueue.maxConcurrentOperationCount = 1;
 
-    _timeout = DEFAULT_TIMEOUT;
-    _retryCount = DEFAULT_RETRY_COUNT;
-    _retryInterval = DEFAULT_RETRY_INTERVAL;
-    _isDebug = NO;
-    _persistPrefsQueue = [[NSOperationQueue alloc] init];
-    _persistPrefsQueue.maxConcurrentOperationCount = 1;
-
-    self.branchBlacklistURL = @"https://cdn.branch.io";
-    
+        self.branchBlacklistURL = @"https://cdn.branch.io";
+        self.disableAdNetworkCallouts = NO;
+    }
     return self;
 }
 

Branch-SDK/Branch-SDK/Branch.h

@@ -678,6 +678,15 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
  */
 - (void)setNetworkTimeout:(NSTimeInterval)timeout;
 
+/**
+ Set disable_ad_network_callouts server flag.  Default value is NO.
+
+ By calling this method with YES, the flag disable_ad_network_callouts = true will be set on all events for a user.
+ Those events will not be sent to ad networks that have been specified by the customer on the dashboard.
+ Customer is required to select the ad networks that the event should not be sent to on the dashboard in order for the flag to be effective.
+ */
+- (void)disableAdNetworkCallouts:(BOOL)disableCallouts;
+
 /**
  Specify that Branch should NOT use an invisible SFSafariViewController to attempt cookie-based matching upon install.
  If you call this method, we will fall back to using our pool of cookie-IDFA pairs for matching.

Branch-SDK/Branch-SDK/Branch.m

@@ -464,6 +464,10 @@ - (BOOL)isUserIdentified {
     return self.preferenceHelper.userIdentity != nil;
 }
 
+- (void)disableAdNetworkCallouts:(BOOL)disableCallouts {
+    self.preferenceHelper.disableAdNetworkCallouts = disableCallouts;
+}
+
 - (void)setNetworkTimeout:(NSTimeInterval)timeout {
     self.preferenceHelper.timeout = timeout;
 }

Branch-SDK/Branch-SDK/Networking/BNCServerInterface.m

@@ -456,7 +456,7 @@ - (NSMutableDictionary *)prepareParamDict:(NSDictionary *)params
     if (self.preferenceHelper.instrumentationDictionary.count && [reqType isEqualToString:@"POST"]) {
         fullParamDict[BRANCH_REQUEST_KEY_INSTRUMENTATION] = self.preferenceHelper.instrumentationDictionary;
     }
-   
+    
     return fullParamDict;
 }
 
@@ -529,6 +529,11 @@ - (void)updateDeviceInfoToMutableDictionary:(NSMutableDictionary *)dict {
         [self safeSetValue:deviceInfo.applicationVersion forKey:@"app_version" onDict:dict];
         [self safeSetValue:deviceInfo.pluginName forKey:@"plugin_name" onDict:dict];
         [self safeSetValue:deviceInfo.pluginVersion forKey:@"plugin_version" onDict:dict];
+        
+        BOOL disableAdNetworkCallouts = self.preferenceHelper.disableAdNetworkCallouts;
+        if (disableAdNetworkCallouts) {
+            [dict setObject:[NSNumber numberWithBool:disableAdNetworkCallouts] forKey:@"disable_ad_network_callouts"];
+        }
     }
 }
 

Branch-TestBed/Branch-TestBed.xcodeproj/project.pbxproj

@@ -445,6 +445,7 @@
 		54FF1F901BD1DC320004CE2E /* BranchLinkProperties.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = BranchLinkProperties.m; sourceTree = "<group>"; };
 		5F08460F23480008005B17E6 /* BNCTuneUtility.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = BNCTuneUtility.h; sourceTree = "<group>"; };
 		5F08461023480008005B17E6 /* BNCTuneUtility.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = BNCTuneUtility.m; sourceTree = "<group>"; };
+		5F2035CB240DDE90004FDC3E /* BNCDisableAdNetworkCalloutsTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = BNCDisableAdNetworkCalloutsTests.m; sourceTree = "<group>"; };
 		5F205D022318641700C776D1 /* BNCUserAgentCollectorTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = BNCUserAgentCollectorTests.m; sourceTree = "<group>"; };
 		5F205D04231864E800C776D1 /* WebKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = WebKit.framework; path = System/Library/Frameworks/WebKit.framework; sourceTree = SDKROOT; };
 		5F3D6712232C589100454FF1 /* BranchLastAttributedTouchData.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = BranchLastAttributedTouchData.m; sourceTree = "<group>"; };
@@ -763,6 +764,7 @@
 				4AB16367239E3A2700D42931 /* DispatchToIsolationQueueTests.m */,
 				5F437E39237DE3480052064B /* BNCTelephonyTests.m */,
 				5F437E3F237E1A560052064B /* BNCDeviceSystemTests.m */,
+				5F2035CB240DDE90004FDC3E /* BNCDisableAdNetworkCalloutsTests.m */,
 			);
 			name = "Branch-SDK-Tests";
 			path = "../Branch-SDK-Tests";