fix unit test. clarify comments.

Author: echo-branch

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

@@ -250,19 +250,12 @@ - (void)testLogFormat_includeCallerDetailsNO_NSError {
 }
 
 - (void)testDefaultBranchLogFormat {
-    __block NSError *originalError = [NSError errorWithDomain:@"com.domain.test" code:200 userInfo:@{@"Error Message": @"Test Error"}];
+    NSError *error = [NSError errorWithDomain:@"com.domain.test" code:200 userInfo:@{@"Error Message": @"Test Error"}];
 
-    BranchLogger *logger = [BranchLogger new];
-    logger.loggingEnabled = YES;
-
-    logger.logCallback = ^(NSString * _Nonnull message, BranchLogLevel logLevel, NSError * _Nullable error) {
-        NSString *expectedMessage = @"[BranchSDK][Error][BranchLoggerTests testDefaultBranchLogFormat] msg NSError: The operation couldn’t be completed. (com.domain.test error 200.)";
-        NSString *formattedMessage = [BranchLogger formatMessage:message logLevel:logLevel error:error];
-        
-        XCTAssertTrue([expectedMessage isEqualToString:formattedMessage]);
-    };
+    NSString *expectedMessage = @"[BranchSDK][Error]msg NSError: Error Domain=com.domain.test Code=200 \"(null)\" UserInfo={Error Message=Test Error}";
+    NSString *formattedMessage = [BranchLogger formatMessage:@"msg" logLevel:BranchLogLevelError error:error];
 
-    [logger logError:@"msg" error:originalError];
+    XCTAssertTrue([expectedMessage isEqualToString:formattedMessage]);
 }
 
 @end

Sources/BranchSDK/BNCEncodingUtils.m

@@ -462,6 +462,8 @@ + (NSData *)dataFromHexString:(NSString*)string {
         data = [NSData dataWithBytes:bytes length:b-bytes];
     }
 
+    // Error handling in C code is one case where goto can improve readability.
+    // https://www.kernel.org/doc/html/v4.19/process/coding-style.html
 exit:
     if (bytes) {
         free(bytes);

Sources/BranchSDK/BNCKeyChain.m

@@ -68,8 +68,7 @@ + (NSDate *)retrieveDateForService:(NSString *)service key:(NSString *)key error
     if (valueData) {
         @try {
             value = [NSKeyedUnarchiver unarchivedObjectOfClass:[NSDate class] fromData:(__bridge NSData*)valueData error:NULL];
-        }
-        @catch (id) {
+        } @catch (NSException *exception) {
             value = nil;
             NSError *localError = [self errorWithKey:key OSStatus:errSecDecode];
             if (error) *error = localError;
@@ -91,8 +90,7 @@ + (NSError *) storeDate:(NSDate *)date
     NSData* valueData = nil;
     @try {
         valueData = [NSKeyedArchiver archivedDataWithRootObject:date requiringSecureCoding:YES error:NULL];
-    }
-    @catch(id) {
+    } @catch (NSException *exception) {
         valueData = nil;
     }
     if (!valueData) {

Sources/BranchSDK/BNCNetworkInterface.m

@@ -52,9 +52,7 @@ - (NSString*) description {
         int e = errno;
         [[BranchLogger shared] logWarning:[NSString stringWithFormat:@"Failed to read IP Address: (%d): %s", e, strerror(e)] error:nil];
 
-        // Error handling in C code is one case where goto can improve readability.
-        // https://www.kernel.org/doc/html/v4.19/process/coding-style.html
-        goto err_free_interfaces;
+        goto exit;
     }
 
     // Loop through linked list of interfaces --
@@ -96,7 +94,9 @@ - (NSString*) description {
         }
     }
 
-err_free_interfaces:
+    // Error handling in C code is one case where goto can improve readability.
+    // https://www.kernel.org/doc/html/v4.19/process/coding-style.html
+exit:
     if (interfaces) freeifaddrs(interfaces);
     return currentInterfaces;
 }

Sources/BranchSDK/BNCPreferenceHelper.m

@@ -937,8 +937,8 @@ - (NSData *)serializePrefDict:(NSMutableDictionary *)dict {
     NSData *data = nil;
     @try {
         data = [NSKeyedArchiver archivedDataWithRootObject:dict requiringSecureCoding:YES error:NULL];
-    } @catch (id exception) {
-        [[BranchLogger shared] logWarning:[NSString stringWithFormat:@"Exception serializing preferences dict: %@.", exception] error:nil];
+    } @catch (NSException *exception) {
+        [[BranchLogger shared] logError:[NSString stringWithFormat:@"Exception serializing preferences dict: %@.", exception] error:nil];
     }
     return data;
 }
@@ -971,8 +971,8 @@ - (NSData *)loadPrefData {
         if (error || !data) {
             [[BranchLogger shared] logWarning:@"Failed to load preferences from storage. This is expected on first run." error:error];
         }
-    } @catch (NSException *) {
-        [[BranchLogger shared] logWarning:@"Failed to load preferences from storage." error:nil];
+    } @catch (NSException *exception) {
+        [[BranchLogger shared] logError:[NSString stringWithFormat:@"Exception loading preferences dict: %@.", exception] error:nil];
     }
     return data;
 }

Sources/BranchSDK/BranchShareLink.m

@@ -197,11 +197,12 @@ - (void) presentActivityViewControllerFromViewController:(UIViewController*_Null
     NSString *emailSubject = self.linkProperties.controlParams[BRANCH_LINK_DATA_KEY_EMAIL_SUBJECT];
     if (emailSubject.length <= 0) emailSubject = self.emailSubject;
     if (emailSubject.length) {
+        // Key value coding to set email subject
+        // https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/KeyValueCoding/SearchImplementation.html#//apple_ref/doc/uid/20000955
         @try {
             [shareViewController setValue:emailSubject forKey:@"subject"];
-        }
-        @catch (NSException*) {
-            [[BranchLogger shared] logWarning:  @"Unable to setValue 'emailSubject' forKey 'subject' on UIActivityViewController." error:nil];
+        } @catch (NSException *exception) {
+            [[BranchLogger shared] logWarning:[NSString stringWithFormat:@"Exception to setValue 'emailSubject' forKey 'subject' on UIActivityViewController: %@.", exception] error:nil];
         }
     }
 

Sources/BranchSDK/Public/BranchLogger.h

@@ -11,8 +11,8 @@
 typedef NS_ENUM(NSUInteger, BranchLogLevel) {
     BranchLogLevelVerbose, // development
     BranchLogLevelDebug,   // validation and troubleshooting
-    BranchLogLevelWarning, // potential errors and attempts at recovery
-    BranchLogLevelError,   // unexpected or unhandled errors
+    BranchLogLevelWarning, // potential errors and attempts at recovery. SDK may be in a bad state.
+    BranchLogLevelError,   // severe errors. SDK is probably in a bad state.
 };
 
 typedef void(^BranchLogCallback)(NSString * _Nonnull message, BranchLogLevel logLevel, NSError * _Nullable error);