Release 3.8.0

nsingh-branch · nsingh-branch · commit 37d0fb8ff040 · 2025-01-08T13:33:49.000-08:00
diff --git a/Branch-TestBed/Branch-TestBed/AppDelegate.m b/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);
diff --git a/BranchSDK.podspec b/BranchSDK.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = "BranchSDK"
-  s.version          = "3.7.0"
+  s.version          = "3.8.0"
   s.summary          = "Create an HTTP URL for any piece of content in your app"
   s.description      = <<-DESC
 - Want the highest possible conversions on your sharing feature?
diff --git a/BranchSDK.xcodeproj/project.pbxproj b/BranchSDK.xcodeproj/project.pbxproj
@@ -1974,7 +1974,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 3.7.0;
+				MARKETING_VERSION = 3.8.0;
 				OTHER_LDFLAGS = (
 					"-weak_framework",
 					LinkPresentation,
@@ -2009,7 +2009,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 3.7.0;
+				MARKETING_VERSION = 3.8.0;
 				OTHER_LDFLAGS = (
 					"-weak_framework",
 					LinkPresentation,
@@ -2215,7 +2215,7 @@
 					"@loader_path/Frameworks",
 				);
 				MACH_O_TYPE = staticlib;
-				MARKETING_VERSION = 3.7.0;
+				MARKETING_VERSION = 3.8.0;
 				OTHER_LDFLAGS = (
 					"-weak_framework",
 					LinkPresentation,
@@ -2254,7 +2254,7 @@
 					"@loader_path/Frameworks",
 				);
 				MACH_O_TYPE = staticlib;
-				MARKETING_VERSION = 3.7.0;
+				MARKETING_VERSION = 3.8.0;
 				OTHER_LDFLAGS = (
 					"-weak_framework",
 					LinkPresentation,
@@ -2291,7 +2291,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 3.7.0;
+				MARKETING_VERSION = 3.8.0;
 				OTHER_LDFLAGS = (
 					"-weak_framework",
 					LinkPresentation,
@@ -2326,7 +2326,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 3.7.0;
+				MARKETING_VERSION = 3.8.0;
 				OTHER_LDFLAGS = (
 					"-weak_framework",
 					LinkPresentation,
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -1,5 +1,9 @@
 Branch iOS SDK Change Log
 
+v.3.8.0
+- Added new `BranchAdvancedLogCallback` which contains request and response data for Branch network requests
+- Added ability to set Consumer Protection Attribution Level through the `branch.json` file
+
 v.3.7.0
 - Added `setConsumerProtectionAttributionLevel` for controlling attribution data collection
 - Deprecated `setTrackingDisabled` in favor of `setConsumerProtectionAttributionLevel(NONE)`
diff --git a/Sources/BranchSDK/BNCConfig.m b/Sources/BranchSDK/BNCConfig.m
@@ -8,7 +8,7 @@
 
 #include "BNCConfig.h"
 
-NSString * const BNC_SDK_VERSION  = @"3.7.0";
+NSString * const BNC_SDK_VERSION  = @"3.8.0";
 NSString * const BNC_LINK_URL = @"https://bnc.lt";
 NSString * const BNC_CDN_URL = @"https://cdn.branch.io";
 
diff --git a/Sources/BranchSDK/BNCServerInterface.m b/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 {
diff --git a/Sources/BranchSDK/Branch.m b/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];
         });
-	}
+    }
 }
 
 
diff --git a/Sources/BranchSDK/BranchJsonConfig.m b/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];
diff --git a/Sources/BranchSDK/BranchLogger.m b/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);
     }
 }
diff --git a/Sources/BranchSDK/Private/BranchJsonConfig.h b/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;
diff --git a/Sources/BranchSDK/Public/Branch.h b/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."))));
diff --git a/Sources/BranchSDK/Public/BranchLogger.h b/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
diff --git a/scripts/version.sh b/scripts/version.sh
@@ -30,7 +30,7 @@ Options:
 USAGE
 }
 
-version=3.7.0
+version=3.8.0
 prev_version="$version"
 
 if (( $# == 0 )); then

Original file line number	Diff line number	Diff line change
`@@ -289,7 +289,7 @@ - (NSURLRequest )preparePostRequest:(NSDictionary )params url:(NSString *)url`
`289`	`289`	`[request setHTTPBody:postData];`
`290`	`290`
`291`	`291`	`if ([[BranchLogger shared] shouldLog:BranchLogLevelDebug]) {`
`292`		`- [[BranchLogger shared] logDebug:[NSString stringWithFormat:@"%@\nHeaders %@\nBody %@", request, [request allHTTPHeaderFields], [BNCEncodingUtils prettyPrintJSON:updatedParams]] error:nil];`
	`292`	`+ [[BranchLogger shared] logDebug:[NSString stringWithFormat:@"%@\nHeaders %@\nBody %@", request, [request allHTTPHeaderFields], [BNCEncodingUtils prettyPrintJSON:updatedParams]] error:nil request:request response:nil];`
`293`	`293`	`}`
`294`	`294`
`295`	`295`	`return request;`
`@@ -310,7 +310,7 @@ - (BNCServerResponse )processServerResponse:(NSURLResponse )response data:(NSD`
`310`	`310`	`serverResponse.requestId = requestId;`
`311`	`311`
`312`	`312`	`if ([[BranchLogger shared] shouldLog:BranchLogLevelDebug]) {`
`313`		`- [[BranchLogger shared] logDebug:[NSString stringWithFormat:@"%@\nBody %@", response, [BNCEncodingUtils prettyPrintJSON:serverResponse.data]] error:nil];`
	`313`	`+ [[BranchLogger shared] logDebug:[NSString stringWithFormat:@"%@\nBody %@", response, [BNCEncodingUtils prettyPrintJSON:serverResponse.data]] error:nil request:nil response:serverResponse];`
`314`	`314`	`}`
`315`	`315`
`316`	`316`	`} else {`
Original file line number	Diff line number	Diff line change
`@@ -53,22 +53,29 @@ - (void)disableCallerDetails {`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`- (void)logError:(NSString )message error:(NSError _Nullable)error {`
`56`		`- [self logMessage:message withLevel:BranchLogLevelError error:error];`
	`56`	`+ [self logMessage:message withLevel:BranchLogLevelError error:error request:nil response:nil];`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`- (void)logWarning:(NSString )message error:(NSError _Nullable)error {`
`60`		`- [self logMessage:message withLevel:BranchLogLevelWarning error:error];`
	`60`	`+ [self logMessage:message withLevel:BranchLogLevelWarning error:error request:nil response:nil];`
`61`	`61`	`}`
`62`	`62`
`63`		`-- (void)logDebug:(NSString )message error:(NSError _Nullable)error {`
`64`		`- [self logMessage:message withLevel:BranchLogLevelDebug error:error];`
	`63`	`+- (void)logDebug:(NSString * _Nonnull)message error:(NSError * _Nullable)error {`
	`64`	`+ [self logDebug:message error:error request:nil response:nil];`
	`65`	`+}`
	`66`	`+`
	`67`	`+- (void)logDebug:(NSString * _Nonnull)message`
	`68`	`+ error:(NSError * _Nullable)error`
	`69`	`+ request:(NSMutableURLRequest * _Nullable)request`
	`70`	`+ response:(BNCServerResponse * _Nullable)response {`
	`71`	`+ [self logMessage:message withLevel:BranchLogLevelDebug error:error request:request response:response];`
`65`	`72`	`}`
`66`	`73`
`67`	`74`	`- (void)logVerbose:(NSString )message error:(NSError _Nullable)error {`
`68`		`- [self logMessage:message withLevel:BranchLogLevelVerbose error:error];`
	`75`	`+ [self logMessage:message withLevel:BranchLogLevelVerbose error:error request:nil response:nil];`
`69`	`76`	`}`
`70`	`77`
`71`		`-- (void)logMessage:(NSString )message withLevel:(BranchLogLevel)level error:(NSError _Nullable)error {`
	`78`	`+- (void)logMessage:(NSString )message withLevel:(BranchLogLevel)level error:(NSError _Nullable)error request:(NSMutableURLRequest * _Nullable)request response:(BNCServerResponse * _Nullable)response {`
`72`	`79`	`if (!self.loggingEnabled \|\| level < self.logLevelThreshold \|\| message.length == 0) {`
`73`	`80`	`return;`
`74`	`81`	`}`
`@@ -77,8 +84,10 @@ - (void)logMessage:(NSString *)message withLevel:(BranchLogLevel)level error:(NS`
`77`	`84`	`if (self.includeCallerDetails) {`
`78`	`85`	`formattedMessage = [NSString stringWithFormat:@"%@ %@", [self callingClass], message];`
`79`	`86`	`}`
`80`		`-`
`81`		`- if (self.logCallback) {`
	`87`	`+`
	`88`	`+ if (self.advancedLogCallback) {`
	`89`	`+ self.advancedLogCallback(formattedMessage, level, error, request, response);`
	`90`	`+ } else if (self.logCallback) {`
`82`	`91`	`self.logCallback(formattedMessage, level, error);`
`83`	`92`	`}`
`84`	`93`	`}`