Added options for disabling callerDetails

Author: nsingh-branch

Branch-TestBed/Branch-SDK-Tests/BranchLoggerTests.m

@@ -15,35 +15,26 @@ @interface BranchLoggerTests : XCTestCase
 
 @implementation BranchLoggerTests
 
-- (void)setUp {
-    [super setUp];
-    [BranchLogger shared].loggingEnabled = NO;
-    [BranchLogger shared].logCallback = nil;
-}
-
-- (void)tearDown {
-    [BranchLogger shared].loggingEnabled = NO;
-    [BranchLogger shared].logCallback = nil;
-    [super tearDown];
-}
-
 - (void)testEnableLoggingSetsCorrectDefaultLevel {
     [[Branch getInstance] enableLogging];
     XCTAssertEqual([BranchLogger shared].logLevelThreshold, BranchLogLevelDebug, "Default log level should be Debug.");
 }
 
 - (void)testLogLevelThresholdBlocksLowerLevels {
-    [[Branch getInstance] enableLoggingAtLevel:BranchLogLevelDebug];
+    BranchLogger *logger = [BranchLogger new];
+    logger.loggingEnabled = true;
+    logger.logLevelThreshold = BranchLogLevelDebug;
+    
     XCTestExpectation *expectation = [self expectationWithDescription:@"Log callback expectation for message that should pass the threshold"];
 
-    [BranchLogger shared].logCallback = ^(NSString * _Nonnull message, BranchLogLevel logLevel, NSError * _Nullable error) {
+    logger.logCallback = ^(NSString * _Nonnull message, BranchLogLevel logLevel, NSError * _Nullable error) {
         if ([message isEqualToString:@"[BranchSDK][Debug][BranchLoggerTests testLogLevelThresholdBlocksLowerLevels] This message should trigger the log callback."] && logLevel >= BranchLogLevelDebug) {
             [expectation fulfill];
         }
     };
 
-    [[BranchLogger shared] logVerbose:@"This verbose message should not trigger the log callback."];
-    [[BranchLogger shared] logDebug:@"This message should trigger the log callback."];
+    [logger logVerbose:@"This verbose message should not trigger the log callback."];
+    [logger logDebug:@"This message should trigger the log callback."];
 
     [self waitForExpectationsWithTimeout:1 handler:nil];
 }
@@ -53,28 +44,33 @@ - (void)testLogCallbackExecutesWithCorrectParameters {
     NSString *expectedMessage = @"[BranchSDK][Info][BranchLoggerTests testLogCallbackExecutesWithCorrectParameters] Test message";
     BranchLogLevel expectedLevel = BranchLogLevelInfo;
 
-    [BranchLogger shared].logCallback = ^(NSString * _Nonnull message, BranchLogLevel logLevel, NSError * _Nullable error) {
+    BranchLogger *logger = [BranchLogger new];
+
+    logger.logCallback = ^(NSString * _Nonnull message, BranchLogLevel logLevel, NSError * _Nullable error) {
         XCTAssertEqualObjects(message, expectedMessage, "Logged message does not match expected message.");
         XCTAssertEqual(logLevel, expectedLevel, "Logged level does not match expected level.");
         XCTAssertNil(error, "Error should be nil.");
         [expectation fulfill];
     };
-
-    [[Branch getInstance] enableLoggingAtLevel:BranchLogLevelInfo];
-    [[BranchLogger shared] logInfo:@"Test message"];
+    
+    logger.loggingEnabled = YES;
+    logger.logLevelThreshold = BranchLogLevelInfo;
+    [logger logInfo:@"Test message"];
 
     [self waitForExpectationsWithTimeout:1 handler:nil];
 }
 
 - (void)testLogLevelSpecificityFiltersLowerLevels {
-    [[Branch getInstance] enableLoggingAtLevel:BranchLogLevelWarning];
+    BranchLogger *logger = [BranchLogger new];
+    logger.loggingEnabled = YES;
+    logger.logLevelThreshold = BranchLogLevelWarning;
 
     XCTestExpectation *verboseExpectation = [self expectationWithDescription:@"Verbose log callback"];
     verboseExpectation.inverted = YES;
     XCTestExpectation *errorExpectation = [self expectationWithDescription:@"Error log callback"];
 
     __block NSUInteger callbackCount = 0;
-    [BranchLogger shared].logCallback = ^(NSString * _Nonnull message, BranchLogLevel logLevel, NSError * _Nullable error) {
+    logger.logCallback = ^(NSString * _Nonnull message, BranchLogLevel logLevel, NSError * _Nullable error) {
         if (logLevel == BranchLogLevelVerbose) {
             [verboseExpectation fulfill];
         } else if (logLevel == BranchLogLevelError) {
@@ -83,28 +79,29 @@ - (void)testLogLevelSpecificityFiltersLowerLevels {
         callbackCount++;
     };
 
-    [[BranchLogger shared] logVerbose:@"This should not be logged due to log level threshold."];
-    [[BranchLogger shared] logError:@"This should be logged" error:nil];
+    [logger logVerbose:@"This should not be logged due to log level threshold."];
+    [logger logError:@"This should be logged" error:nil];
 
     [self waitForExpectations:@[verboseExpectation, errorExpectation] timeout:2];
     XCTAssertEqual(callbackCount, 1, "Only one log callback should have been invoked.");
 }
 
 - (void)testErrorLoggingIncludesErrorDetails {
-    [[Branch getInstance] enableLogging];
+    BranchLogger *logger = [BranchLogger new];
+    logger.loggingEnabled = YES;
+    
     XCTestExpectation *expectation = [self expectationWithDescription:@"Error log includes error details"];
 
     NSError *testError = [NSError errorWithDomain:@"TestDomain" code:42 userInfo:@{NSLocalizedDescriptionKey: @"Test error description"}];
-    [BranchLogger shared].logCallback = ^(NSString * _Nonnull message, BranchLogLevel logLevel, NSError * _Nullable error) {
+    logger.logCallback = ^(NSString * _Nonnull message, BranchLogLevel logLevel, NSError * _Nullable error) {
         if ([message containsString:@"Test error description"] && error == testError) {
             [expectation fulfill];
         }
     };
 
-    [[BranchLogger shared] logError:@"Testing error logging" error:testError];
+    [logger logError:@"Testing error logging" error:testError];
 
     [self waitForExpectationsWithTimeout:1 handler:nil];
 }
 
-
 @end

BranchSDK/BranchLogger.h

@@ -23,11 +23,14 @@ NS_ASSUME_NONNULL_BEGIN
 @interface BranchLogger : NSObject
 
 @property (nonatomic, assign) BOOL loggingEnabled;
+@property (nonatomic, assign) BOOL includeCallerDetails;
 @property (nonatomic, copy, nullable) BranchLogCallback logCallback;
 @property (nonatomic, assign) BranchLogLevel logLevelThreshold;
 
 + (instancetype _Nonnull)shared;
 
+- (void)disableCallerDetails;
+
 - (void)logError:(NSString * _Nonnull)message error:(NSError * _Nullable)error;
 - (void)logWarning:(NSString * _Nonnull)message;
 - (void)logInfo:(NSString * _Nonnull)message;

BranchSDK/BranchLogger.m

@@ -11,7 +11,14 @@
 
 @implementation BranchLogger
 
-static BranchLogLevel _logLevelThreshold = BranchLogLevelDebug;
+- (instancetype)init {
+    if ((self = [super init])) {
+        _loggingEnabled = NO;
+        _logLevelThreshold = BranchLogLevelDebug;
+        _includeCallerDetails = YES;
+    }
+    return self;
+}
 
 + (instancetype)shared {
     static BranchLogger *sharedInstance = nil;
@@ -20,10 +27,15 @@ + (instancetype)shared {
         sharedInstance = [[BranchLogger alloc] init];
         sharedInstance.loggingEnabled = NO;
         sharedInstance.logLevelThreshold = BranchLogLevelDebug;
+        sharedInstance.includeCallerDetails = YES;
     });
     return sharedInstance;
 }
 
+- (void)disableCallerDetails {
+    self.includeCallerDetails = NO;
+}
+
 - (void)logError:(NSString *)message error:(NSError *_Nullable)error {
     [self logMessage:message withLevel:BranchLogLevelError error:error];
 }
@@ -49,7 +61,7 @@ - (void)logMessage:(NSString *)message withLevel:(BranchLogLevel)level error:(NS
         return;
     }
 
-    NSString *callerDetails = [self callingClass];
+    NSString *callerDetails = self.includeCallerDetails ? [self callingClass] : @"";
     NSString *logLevelString = [self stringForLogLevel:level];
     NSString *logTag = [NSString stringWithFormat:@"[BranchSDK][%@]", logLevelString];
     NSMutableString *fullMessage = [NSMutableString stringWithFormat:@"%@%@ %@", logTag, callerDetails, message];