Merge branch 'master' into mobileboost

Branch-TestBed/Branch-TestBed/AppDelegate.m

@@ -41,15 +41,23 @@ - (BOOL)application:(UIApplication *)application
     // test pre init support
     //[self testDispatchToIsolationQueue:branch]
 
-
-    [Branch enableLoggingAtLevel:BranchLogLevelVerbose withCallback:^(NSString * _Nonnull message, BranchLogLevel logLevel, NSError * _Nullable error) {
+    [Branch enableLoggingAtLevel:BranchLogLevelVerbose withAdvancedCallback:^(NSString * _Nonnull message, BranchLogLevel logLevel, NSError * _Nullable error, NSMutableURLRequest * _Nullable request, BNCServerResponse * _Nullable response) {
         // Handle the log message and error here. For example, printing to the console:
         if (error) {
             NSLog(@"[BranchLog] Level: %lu, Message: %@, Error: %@", (unsigned long)logLevel, message, error.localizedDescription);
         } else {
             NSLog(@"[BranchLog] Level: %lu, Message: %@", (unsigned long)logLevel, message);
         }
 
+        if (request) {
+            NSString *jsonString = [[NSString alloc] initWithData:request.HTTPBody encoding:NSUTF8StringEncoding];
+            NSLog(@"[BranchLog] Got %@ Request: %@", request.URL , jsonString);
+        }
+
+        if (response) {
+            NSLog(@"[BranchLog] Got Response for request (%@): %@", response.requestId, response.data);
+        }
+
         NSString *logEntry = error ? [NSString stringWithFormat:@"Level: %lu, Message: %@, Error: %@", (unsigned long)logLevel, message, error.localizedDescription]
                                    : [NSString stringWithFormat:@"Level: %lu, Message: %@", (unsigned long)logLevel, message];
         APPLogHookFunction([NSDate date], logLevel, logEntry);

Sources/BranchSDK/BNCServerInterface.m

@@ -289,7 +289,7 @@ - (NSURLRequest *)preparePostRequest:(NSDictionary *)params url:(NSString *)url
     [request setHTTPBody:postData];
 
     if ([[BranchLogger shared] shouldLog:BranchLogLevelDebug]) {
-        [[BranchLogger shared] logDebug:[NSString stringWithFormat:@"%@\nHeaders %@\nBody %@", request, [request allHTTPHeaderFields], [BNCEncodingUtils prettyPrintJSON:updatedParams]] error:nil];
+        [[BranchLogger shared] logDebug:[NSString stringWithFormat:@"%@\nHeaders %@\nBody %@", request, [request allHTTPHeaderFields], [BNCEncodingUtils prettyPrintJSON:updatedParams]] error:nil request:request response:nil];
     }
 
     return request;
@@ -310,7 +310,7 @@ - (BNCServerResponse *)processServerResponse:(NSURLResponse *)response data:(NSD
         serverResponse.requestId = requestId;
 
         if ([[BranchLogger shared] shouldLog:BranchLogLevelDebug]) {
-            [[BranchLogger shared] logDebug:[NSString stringWithFormat:@"%@\nBody %@", response, [BNCEncodingUtils prettyPrintJSON:serverResponse.data]] error:nil];
+            [[BranchLogger shared] logDebug:[NSString stringWithFormat:@"%@\nBody %@", response, [BNCEncodingUtils prettyPrintJSON:serverResponse.data]] error:nil request:nil response:serverResponse];
         }
 
     } else {

Sources/BranchSDK/Branch.m

@@ -256,6 +256,20 @@ - (id)initWithInterface:(BNCServerInterface *)interface
     if (config.checkPasteboardOnInstall) {
         [self checkPasteboardOnInstall];
     }
+
+    if (config.cppLevel) {
+        if ([config.cppLevel caseInsensitiveCompare:@"FULL"] == NSOrderedSame) {
+            [[Branch getInstance] setConsumerProtectionAttributionLevel:BranchAttributionLevelFull];
+        } else if ([config.cppLevel caseInsensitiveCompare:@"REDUCED"] == NSOrderedSame) {
+            [[Branch getInstance] setConsumerProtectionAttributionLevel:BranchAttributionLevelReduced];
+        } else if ([config.cppLevel caseInsensitiveCompare:@"MINIMAL"] == NSOrderedSame) {
+            [[Branch getInstance] setConsumerProtectionAttributionLevel:BranchAttributionLevelMinimal];
+        } else if ([config.cppLevel caseInsensitiveCompare:@"NONE"] == NSOrderedSame) {
+            [[Branch getInstance] setConsumerProtectionAttributionLevel:BranchAttributionLevelNone];
+        } else {
+            NSLog(@"Invalid CPP Level set in branch.json: %@", config.cppLevel);
+        }
+    }
 
     return self;
 }
@@ -455,6 +469,15 @@ + (void)enableLoggingAtLevel:(BranchLogLevel)logLevel withCallback:(nullable Bra
     }
 }
 
++ (void)enableLoggingAtLevel:(BranchLogLevel)logLevel withAdvancedCallback:(nullable BranchAdvancedLogCallback)callback {
+    BranchLogger *logger = [BranchLogger shared];
+    logger.loggingEnabled = YES;
+    logger.logLevelThreshold = logLevel;
+    if (callback) {
+        logger.advancedLogCallback = callback;
+    }
+}
+
 - (void)useEUEndpoints {
     [BNCServerAPI sharedInstance].useEUServers = YES;
 }
@@ -632,7 +655,7 @@ - (void)initSessionWithLaunchOptions:(NSDictionary *)options automaticallyDispla
 
 #pragma mark - Actual Init Session
 
-- (void)initSessionWithLaunchOptions:(NSDictionary *)options isReferrable:(BOOL)isReferrable explicitlyRequestedReferrable:(BOOL)explicitlyRequestedReferrable automaticallyDisplayController:(BOOL)automaticallyDisplayController registerDeepLinkHandlerUsingBranchUniversalObject:(callbackWithBranchUniversalObject)callback {    
+- (void)initSessionWithLaunchOptions:(NSDictionary *)options isReferrable:(BOOL)isReferrable explicitlyRequestedReferrable:(BOOL)explicitlyRequestedReferrable automaticallyDisplayController:(BOOL)automaticallyDisplayController registerDeepLinkHandlerUsingBranchUniversalObject:(callbackWithBranchUniversalObject)callback {
     [self initSceneSessionWithLaunchOptions:options isReferrable:isReferrable explicitlyRequestedReferrable:explicitlyRequestedReferrable automaticallyDisplayController:automaticallyDisplayController
                     registerDeepLinkHandler:^(BNCInitSessionResponse * _Nullable initResponse, NSError * _Nullable error) {
         if (callback) {
@@ -1107,8 +1130,8 @@ - (NSDictionary *)getFirstReferringParams {
 
     if (self.deepLinkDebugParams) {
         NSMutableDictionary* debugInstallParams =
-			[[BNCEncodingUtils decodeJsonStringToDictionary:self.preferenceHelper.sessionParams]
-				mutableCopy];
+            [[BNCEncodingUtils decodeJsonStringToDictionary:self.preferenceHelper.sessionParams]
+                mutableCopy];
         [debugInstallParams addEntriesFromDictionary:self.deepLinkDebugParams];
         return debugInstallParams;
     }
@@ -2051,7 +2074,7 @@ - (void)initUserSessionAndCallCallback:(BOOL)callCallback sceneIdentifier:(NSStr
 // only called from initUserSessionAndCallCallback!
 - (void)initializeSessionAndCallCallback:(BOOL)callCallback sceneIdentifier:(NSString *)sceneIdentifier urlString:(NSString *)urlString {
 
-	// BranchDelegate willStartSessionWithURL notification
+    // BranchDelegate willStartSessionWithURL notification
     NSURL *URL = (self.preferenceHelper.referringURL.length) ? [NSURL URLWithString:self.preferenceHelper.referringURL] : nil;
     if ([self.delegate respondsToSelector:@selector(branch:willStartSessionWithURL:)]) {
         [self.delegate branch:self willStartSessionWithURL:URL];
@@ -2116,7 +2139,7 @@ - (void)initializeSessionAndCallCallback:(BOOL)callCallback sceneIdentifier:(NSS
 
             [self processNextQueueItem];
         });
-	}
+    }
 }
 
 

Sources/BranchSDK/BranchJsonConfig.m

@@ -18,7 +18,7 @@
 NSString * _Nonnull const BranchJsonConfigEnableLogging = @"enableLogging";
 NSString * _Nonnull const BranchJsonConfigCheckPasteboardOnInstall = @"checkPasteboardOnInstall";
 NSString * _Nonnull const BranchJsonConfigAPIUrl = @"apiUrl";
-
+NSString * _Nonnull const BranchJsonConfigCPPLevel = @"consumerProtectionAttributionLevel";
 
 @interface BranchJsonConfig()
 @property (nonatomic, strong) NSDictionary *configuration;
@@ -163,6 +163,11 @@ - (NSString *)apiUrl
     return self[BranchJsonConfigAPIUrl];
 }
 
+- (NSString *)cppLevel
+{
+    return self[BranchJsonConfigCPPLevel];
+}
+
 - (id)objectForKey:(NSString *)key
 {
     return self.configuration[key];

Sources/BranchSDK/BranchLogger.m

@@ -53,22 +53,29 @@ - (void)disableCallerDetails {
 }
 
 - (void)logError:(NSString *)message error:(NSError *_Nullable)error {
-    [self logMessage:message withLevel:BranchLogLevelError error:error];
+    [self logMessage:message withLevel:BranchLogLevelError error:error request:nil response:nil];
 }
 
 - (void)logWarning:(NSString *)message error:(NSError *_Nullable)error {
-    [self logMessage:message withLevel:BranchLogLevelWarning error:error];
+    [self logMessage:message withLevel:BranchLogLevelWarning error:error request:nil response:nil];
 }
 
-- (void)logDebug:(NSString *)message error:(NSError *_Nullable)error {
-    [self logMessage:message withLevel:BranchLogLevelDebug error:error];
+- (void)logDebug:(NSString * _Nonnull)message error:(NSError * _Nullable)error {
+    [self logDebug:message error:error request:nil response:nil];
+}
+
+- (void)logDebug:(NSString * _Nonnull)message
+           error:(NSError * _Nullable)error
+         request:(NSMutableURLRequest * _Nullable)request
+        response:(BNCServerResponse * _Nullable)response {
+    [self logMessage:message withLevel:BranchLogLevelDebug error:error request:request response:response];
 }
 
 - (void)logVerbose:(NSString *)message error:(NSError *_Nullable)error {
-    [self logMessage:message withLevel:BranchLogLevelVerbose error:error];
+    [self logMessage:message withLevel:BranchLogLevelVerbose error:error request:nil response:nil];
 }
 
-- (void)logMessage:(NSString *)message withLevel:(BranchLogLevel)level error:(NSError *_Nullable)error {
+- (void)logMessage:(NSString *)message withLevel:(BranchLogLevel)level error:(NSError *_Nullable)error request:(NSMutableURLRequest * _Nullable)request response:(BNCServerResponse * _Nullable)response {
     if (!self.loggingEnabled || level < self.logLevelThreshold || message.length == 0) {
         return;
     }
@@ -77,8 +84,10 @@ - (void)logMessage:(NSString *)message withLevel:(BranchLogLevel)level error:(NS
     if (self.includeCallerDetails) {
         formattedMessage = [NSString stringWithFormat:@"%@ %@", [self callingClass], message];
     }
-
-    if (self.logCallback) {
+
+    if  (self.advancedLogCallback) {
+        self.advancedLogCallback(formattedMessage, level, error, request, response);
+    } else if (self.logCallback) {
         self.logCallback(formattedMessage, level, error);
     }
 }

Sources/BranchSDK/Private/BranchJsonConfig.h

@@ -31,6 +31,7 @@ extern NSString * _Nonnull const BranchJsonConfigAPIUrl;
 @property (nonatomic, readonly, assign) BOOL enableLogging;
 @property (nonatomic, readonly, assign) BOOL checkPasteboardOnInstall;
 @property (nonatomic, readonly, nullable, copy) NSString *apiUrl;
+@property (nonatomic, readonly, nullable, copy) NSString *cppLevel;
 
 - (nullable id)objectForKey:(NSString * _Nonnull)key;
 - (nullable id)objectForKeyedSubscript:(NSString * _Nonnull)key;

Sources/BranchSDK/Public/Branch.h

@@ -568,6 +568,7 @@ extern NSString * __nonnull const BNCSpotlightFeature;
  */
 + (void)enableLogging;
 + (void)enableLoggingAtLevel:(BranchLogLevel)logLevel withCallback:(nullable BranchLogCallback)callback;
++ (void)enableLoggingAtLevel:(BranchLogLevel)logLevel withAdvancedCallback:(nullable BranchAdvancedLogCallback)callback;
 
 // The new logging system is independent of the Branch singleton and can be called earlier.
 - (void)enableLogging __attribute__((deprecated(("This API is deprecated. Please use the static version."))));

Sources/BranchSDK/Public/BranchLogger.h

@@ -7,6 +7,7 @@
 //
 
 #import <Foundation/Foundation.h>
+#import "BNCServerResponse.h"
 
 typedef NS_ENUM(NSUInteger, BranchLogLevel) {
     BranchLogLevelVerbose, // development
@@ -16,6 +17,7 @@ typedef NS_ENUM(NSUInteger, BranchLogLevel) {
 };
 
 typedef void(^BranchLogCallback)(NSString * _Nonnull message, BranchLogLevel logLevel, NSError * _Nullable error);
+typedef void(^BranchAdvancedLogCallback)(NSString * _Nonnull message, BranchLogLevel logLevel, NSError * _Nullable error, NSMutableURLRequest * _Nullable request, BNCServerResponse * _Nullable response);
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -24,6 +26,7 @@ NS_ASSUME_NONNULL_BEGIN
 @property (nonatomic, assign) BOOL loggingEnabled;
 @property (nonatomic, assign) BOOL includeCallerDetails;
 @property (nonatomic, copy, nullable) BranchLogCallback logCallback;
+@property (nonatomic, copy, nullable) BranchAdvancedLogCallback advancedLogCallback;
 @property (nonatomic, assign) BranchLogLevel logLevelThreshold;
 
 + (instancetype _Nonnull)shared;
@@ -37,6 +40,7 @@ NS_ASSUME_NONNULL_BEGIN
 - (void)logError:(NSString * _Nonnull)message error:(NSError * _Nullable)error;
 - (void)logWarning:(NSString * _Nonnull)message error:(NSError * _Nullable)error;
 - (void)logDebug:(NSString * _Nonnull)message error:(NSError * _Nullable)error;
+- (void)logDebug:(NSString * _Nonnull)message error:(NSError * _Nullable)error request:(NSMutableURLRequest * _Nullable)request response:(BNCServerResponse * _Nullable)response;
 - (void)logVerbose:(NSString * _Nonnull)message error:(NSError * _Nullable)error;
 
 // default Branch log format