Clean up logs. Add braces for clarity.

echo-branch · echo-branch · commit de3a91abb15f · 2024-03-07T18:45:47.000-08:00
diff --git a/Sources/BranchSDK/BNCApplication.m b/Sources/BranchSDK/BNCApplication.m
@@ -21,7 +21,7 @@
 @implementation BNCApplication
 
 // BNCApplication checks a few values in keychain
-// Checking keychain from main thread early in the app lifecycle can deadlock.  INTENG-7291
+// Checking keychain from main thread early in the app lifecycle can deadlock. INTENG-7291
 + (void)loadCurrentApplicationWithCompletion:(void (^)(BNCApplication *application))completion {
     dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
         BNCApplication *tmp = [BNCApplication currentApplication];
@@ -78,7 +78,7 @@ + (NSDate *)currentBuildDate {
         // path to the app on device. file:///private/var/containers/Bundle/Application/GUID
         appURL = [bundleURL URLByAppendingPathComponent:appName];
     } else {
-        // This else block is probably no longer necessary
+        // TODO: Why is this fallback necessary? The NSBundle approach has been available since iOS 2.0
         // path to old app location, this symlinks to the new location. file:///var/containers/Bundle/Application/GUID
         NSString *path = [[NSProcessInfo processInfo].arguments firstObject];
         if (path) {
diff --git a/Sources/BranchSDK/BNCEncodingUtils.m b/Sources/BranchSDK/BNCEncodingUtils.m
@@ -165,9 +165,8 @@ + (NSString *)encodeDictionaryToJsonString:(NSDictionary *)dictionary {
     NSMutableString *encodedDictionary = [[NSMutableString alloc] initWithString:@"{"];
     for (NSString *key in dictionary) {
         
-        // protect against non-string keys
         if (![key isKindOfClass:[NSString class]]) {
-            [[BranchLogger shared] logError:[NSString stringWithFormat:@"Unexpected key type %@. Skipping key.", [key class]] error:nil];
+            [[BranchLogger shared] logWarning:[NSString stringWithFormat:@"Ignoring unexpected key type %@", [key class]] error:nil];
             continue;
         }
         
@@ -177,38 +176,30 @@ + (NSString *)encodeDictionaryToJsonString:(NSDictionary *)dictionary {
         id obj = dictionary[key];
         if ([obj isKindOfClass:[NSString class]]) {
             value = [BNCEncodingUtils sanitizedStringFromString:obj];
-        }
-        else if ([obj isKindOfClass:[NSURL class]]) {
+        } else if ([obj isKindOfClass:[NSURL class]]) {
             value = [obj absoluteString];
-        }
-        else if ([obj isKindOfClass:[NSDate class]]) {
+        } else if ([obj isKindOfClass:[NSDate class]]) {
             value = [BNCEncodingUtils iso8601StringFromDate:obj];
-        }
-        else if ([obj isKindOfClass:[NSArray class]]) {
+        } else if ([obj isKindOfClass:[NSArray class]]) {
             value = [BNCEncodingUtils encodeArrayToJsonString:obj];
             string = NO;
-        }
-        else if ([obj isKindOfClass:[NSDictionary class]] || [obj isKindOfClass:[NSMutableDictionary class]]) {
+        } else if ([obj isKindOfClass:[NSDictionary class]] || [obj isKindOfClass:[NSMutableDictionary class]]) {
             value = [BNCEncodingUtils encodeDictionaryToJsonString:obj];
             string = NO;
-        }
-        else if ([obj isKindOfClass:[NSNumber class]]) {
+        } else if ([obj isKindOfClass:[NSNumber class]]) {
             string = NO;
-            if (obj == (id)kCFBooleanFalse)
+            if (obj == (id)kCFBooleanFalse) {
                 value = @"false";
-            else
-            if (obj == (id)kCFBooleanTrue)
+            } else if (obj == (id)kCFBooleanTrue) {
                 value = @"true";
-            else
+            } else {
                 value = [obj stringValue];
-        }
-        else if ([obj isKindOfClass:[NSNull class]]) {
+            }
+        } else if ([obj isKindOfClass:[NSNull class]]) {
             value = @"null";
             string = NO;
-        }
-        else {
-            // If this type is not a known type, don't attempt to encode it.
-            [[BranchLogger shared] logError:[NSString stringWithFormat:@"Cannot encode value for key %@. The value is not an accepted type.", key] error:nil];
+        } else {
+            [[BranchLogger shared] logWarning:[NSString stringWithFormat:@"Ignoring unexpected value type %@", [obj class]] error:nil];
             continue;
         }
         
@@ -230,12 +221,11 @@ + (NSString *)encodeDictionaryToJsonString:(NSDictionary *)dictionary {
 
     [encodedDictionary appendString:@"}"];
 
-    [[BranchLogger shared] logDebug:[NSString stringWithFormat:@"Encoded dictionary: %@.", encodedDictionary] error:nil];
+    [[BranchLogger shared] logVerbose:[NSString stringWithFormat:@"Encoded dictionary: %@.", encodedDictionary] error:nil];
     return encodedDictionary;
 }
 
 + (NSString *)encodeArrayToJsonString:(NSArray *)array {
-    // Empty array
     if (![array count]) {
         return @"[]";
     }
@@ -247,41 +237,31 @@ + (NSString *)encodeArrayToJsonString:(NSArray *)array {
         
         if ([obj isKindOfClass:[NSString class]]) {
             value = [BNCEncodingUtils sanitizedStringFromString:obj];
-        }
-        else if ([obj isKindOfClass:[NSURL class]]) {
+        } else if ([obj isKindOfClass:[NSURL class]]) {
             value = [obj absoluteString];
-        }
-        else if ([obj isKindOfClass:[NSDate class]]) {
+        } else if ([obj isKindOfClass:[NSDate class]]) {
             value = [BNCEncodingUtils iso8601StringFromDate:obj];
-        }
-        else if ([obj isKindOfClass:[NSArray class]]) {
+        } else if ([obj isKindOfClass:[NSArray class]]) {
             value = [BNCEncodingUtils encodeArrayToJsonString:obj];
             string = NO;
-        }
-        else if ([obj isKindOfClass:[NSDictionary class]] || [obj isKindOfClass:[NSMutableDictionary class]]) {
+        } else if ([obj isKindOfClass:[NSDictionary class]] || [obj isKindOfClass:[NSMutableDictionary class]]) {
             value = [BNCEncodingUtils encodeDictionaryToJsonString:obj];
             string = NO;
-        }
-        else if ([obj isKindOfClass:[NSNumber class]]) {
+        } else if ([obj isKindOfClass:[NSNumber class]]) {
             value = [obj stringValue];
             string = NO;
-        }
-        else if ([obj isKindOfClass:[NSNull class]]) {
+        } else if ([obj isKindOfClass:[NSNull class]]) {
             value = @"null";
             string = NO;
-        }
-        else {
-            // If this type is not a known type, don't attempt to encode it.
-            [[BranchLogger shared] logError:[NSString stringWithFormat:@"Cannot encode value %@. The value is not an accepted type.", obj] error:nil];
+        } else {
+            [[BranchLogger shared] logWarning:[NSString stringWithFormat:@"Ignoring unexpected value type %@", [obj class]] error:nil];
             continue;
         }
         
-        // If this is a "string" object, wrap it in quotes
         if (string) {
+            // quote strings
             [encodedArray appendFormat:@"\"%@\",", value];
-        }
-        // Otherwise, just add the raw value after the colon
-        else {
+        } else {
             [encodedArray appendFormat:@"%@,", value];
         }
     }
@@ -290,8 +270,7 @@ + (NSString *)encodeArrayToJsonString:(NSArray *)array {
     [encodedArray deleteCharactersInRange:NSMakeRange([encodedArray length] - 1, 1)];
     [encodedArray appendString:@"]"];
     
-    [[BranchLogger shared] logDebug:[NSString stringWithFormat:@"Encoded array: %@.", encodedArray] error:nil];
-
+    [[BranchLogger shared] logVerbose:[NSString stringWithFormat:@"Encoded array: %@.", encodedArray] error:nil];
     return encodedArray;
 }
 
@@ -305,26 +284,20 @@ + (NSString *)encodeDictionaryToQueryString:(NSDictionary *)dictionary {
     NSMutableString *queryString = [[NSMutableString alloc] initWithString:@"?"];
 
     for (NSString *key in [dictionary allKeys]) {
-        // No empty keys, please.
         if (key.length) {
             id obj = dictionary[key];
             NSString *value;
             
             if ([obj isKindOfClass:[NSString class]]) {
                 value = [BNCEncodingUtils urlEncodedString:obj];
-            }
-            else if ([obj isKindOfClass:[NSURL class]]) {
+            } else if ([obj isKindOfClass:[NSURL class]]) {
                 value = [BNCEncodingUtils urlEncodedString:[obj absoluteString]];
-            }
-            else if ([obj isKindOfClass:[NSDate class]]) {
+            } else if ([obj isKindOfClass:[NSDate class]]) {
                 value = [BNCEncodingUtils iso8601StringFromDate:obj];
-            }
-            else if ([obj isKindOfClass:[NSNumber class]]) {
+            } else if ([obj isKindOfClass:[NSNumber class]]) {
                 value = [obj stringValue];
-            }
-            else {
-                // If this type is not a known type, don't attempt to encode it.
-                [[BranchLogger shared] logError:[NSString stringWithFormat:@"Cannot encode value %@. The value is not an accepted type.", obj] error:nil];
+            } else {
+                [[BranchLogger shared] logWarning:[NSString stringWithFormat:@"Ignoring unexpected value type %@", [obj class]] error:nil];
                 continue;
             }
             
@@ -334,29 +307,25 @@ + (NSString *)encodeDictionaryToQueryString:(NSDictionary *)dictionary {
 
     // Delete last character (either trailing & or ? if no params present)
     [queryString deleteCharactersInRange:NSMakeRange(queryString.length - 1, 1)];
-    
     return queryString;
 }
 
-+ (NSString*) stringByPercentDecodingString:(NSString *)string {
++ (NSString *)stringByPercentDecodingString:(NSString *)string {
     return [string stringByRemovingPercentEncoding];
 }
 
-+ (NSString*) stringByPercentEncodingStringForQuery:(NSString *)string {
-    return [string stringByAddingPercentEncodingWithAllowedCharacters:
-                [NSCharacterSet URLQueryAllowedCharacterSet]];
++ (NSString *)stringByPercentEncodingStringForQuery:(NSString *)string {
+    return [string stringByAddingPercentEncodingWithAllowedCharacters: [NSCharacterSet URLQueryAllowedCharacterSet]];
 }
 
 #pragma mark - Param Decoding Methods
 
 + (NSDictionary *)decodeJsonDataToDictionary:(NSData *)jsonData {
     NSString *jsonString = [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding];
-    
     return [BNCEncodingUtils decodeJsonStringToDictionary:jsonString];
 }
 
 + (NSDictionary *)decodeJsonStringToDictionary:(NSString *)jsonString {
-    // Just a basic decode, easy enough
     NSData *tempData = [jsonString dataUsingEncoding:NSUTF8StringEncoding];
     if (!tempData) {
         return @{};
@@ -379,7 +348,6 @@ + (NSDictionary *)decodeJsonStringToDictionary:(NSString *)jsonString {
         return base64DecodedDictionary;
     }
 
-    // Apparently this data was not parsible into a dictionary, so we'll just return an empty one
     return @{};
 }
 
@@ -393,27 +361,29 @@ + (NSDictionary *)decodeQueryStringToDictionary:(NSString *)queryString {
             NSString *key = kv[0];
             NSString *val = [kv[1] stringByRemovingPercentEncoding];
             
-            // Don't add empty items
             if (val.length) {
                 params[key] = val;
             }
         }
     }
-
     return params;
 }
 
 #pragma mark - Hex Strings
 
-+ (NSString *) hexStringFromData:(NSData*)data {
-
++ (NSString *)hexStringFromData:(NSData*)data {
     NSUInteger bytesCount = data.length;
-    if (bytesCount <= 0) return @"";
-
+    if (bytesCount <= 0) {
+        return @"";
+    }
+    
     const char *hexChars = "0123456789ABCDEF";
     const char *dataBuffer = data.bytes;
     char *chars = malloc(sizeof(char) * (bytesCount * 2 + 1));
-    if (!chars) return @"";
+    if (!chars) {
+        return @"";
+    }
+    
     char *s = chars;
     for (unsigned i = 0; i < bytesCount; ++i) {
         *s++ = hexChars[((*dataBuffer & 0xF0) >> 4)];
@@ -423,35 +393,39 @@ + (NSString *) hexStringFromData:(NSData*)data {
     *s = '\0';
 
     NSString *hexString = [NSString stringWithUTF8String:chars];
-    if (chars) free(chars);
+    if (chars) {
+        free(chars);
+    }
+    
     return hexString;
 }
 
-+ (NSData *) dataFromHexString:(NSString*)string {
-    if (!string) return nil;
-
++ (NSData *)dataFromHexString:(NSString*)string {
+    if (!string) {
+        return nil;
+    }
+    
     NSData *data = nil;
     NSData *inputData = [string dataUsingEncoding:NSUTF8StringEncoding];
 
     size_t length = (inputData.length+1)/2;
     uint8_t *bytes = malloc(length);
     uint8_t *b = bytes;
-    if (!bytes) goto exit;
-
+    if (!bytes) {
+        goto exit;
+    }
+    
     int highValue = -1;
     const uint8_t *p = (const uint8_t*) [inputData bytes];
     for (NSUInteger i = 0; i < inputData.length; ++i) {
         int value;
-        if (*p >= '0' && *p <= '9')
+        if (*p >= '0' && *p <= '9') {
             value = *p - '0';
-        else
-        if (*p >= 'A' && *p <= 'F')
+        } else if (*p >= 'A' && *p <= 'F') {
             value = *p - 'A' + 10;
-        else
-        if (*p >= 'a' && *p <= 'f')
+        } else if (*p >= 'a' && *p <= 'f') {
             value = *p - 'a' + 10;
-        else
-        if (isspace(*p)) {
+        } else if (isspace(*p)) {
             p++;
             continue;
         } else {
@@ -468,8 +442,9 @@ + (NSData *) dataFromHexString:(NSString*)string {
     }
 
     // If highValue != -1 then we got an odd number of hex values, which is an error.
-    if (highValue == -1)
+    if (highValue == -1) {
         data = [NSData dataWithBytes:bytes length:b-bytes];
+    }
 
 exit:
     if (bytes) {
@@ -480,23 +455,27 @@ + (NSData *) dataFromHexString:(NSString*)string {
 
 #pragma mark - URL QueryItems
 
-+ (NSArray<BNCKeyValue*>*) queryItems:(NSURL*)URL {
-    NSMutableArray* keyValues = [NSMutableArray new];
-    if (!URL) return keyValues;
-
++ (NSArray<BNCKeyValue *> *)queryItems:(NSURL *)URL {
+    NSMutableArray *keyValues = [NSMutableArray new];
+    if (!URL) {
+        return keyValues;
+    }
+    
     NSArray *queryItems = [[URL query] componentsSeparatedByString:@"&"];
-    for (NSString* itemPair in queryItems) {
+    for (NSString *itemPair in queryItems) {
 
         BNCKeyValue *keyValue = [BNCKeyValue new];
         NSRange range = [itemPair rangeOfString:@"="];
         if (range.location == NSNotFound) {
-            if (itemPair.length)
+            if (itemPair.length) {
                 keyValue.key = itemPair;
+            }
         } else {
             keyValue.key = [itemPair substringWithRange:NSMakeRange(0, range.location)];
             NSRange r = NSMakeRange(range.location+1, itemPair.length-range.location-1);
-            if (r.length > 0)
+            if (r.length > 0) {
                 keyValue.value = [itemPair substringWithRange:r];
+            }
         }
 
         keyValue.key = [BNCEncodingUtils stringByPercentDecodingString:keyValue.key];
@@ -506,8 +485,13 @@ + (NSData *) dataFromHexString:(NSString*)string {
         keyValue.value = [keyValue.value stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]];
 
         if (keyValue.key.length || keyValue.value.length) {
-            if (keyValue.key == nil) keyValue.key = @"";
-            if (keyValue.value == nil) keyValue.value = @"";
+            if (keyValue.key == nil) {
+                keyValue.key = @"";
+            }
+             
+            if (keyValue.value == nil) {
+                keyValue.value = @"";
+            }
             [keyValues addObject:keyValue];
         }
     }
