Update some log messages

echo-branch · echo-branch · commit 5c6d17054c7d · 2024-03-14T18:42:58.000-07:00
diff --git a/Sources/BranchSDK/BNCNetworkInterface.m b/Sources/BranchSDK/BNCNetworkInterface.m
@@ -41,6 +41,7 @@ - (NSString*) description {
     ];
 }
 
+// Reads network interface information to the device IP address
 + (NSArray<BNCNetworkInterface *> *)currentInterfaces {
 
     struct ifaddrs *interfaces = NULL;
@@ -49,8 +50,11 @@ - (NSString*) description {
     // Retrieve the current interfaces - returns 0 on success
     if (getifaddrs(&interfaces) != 0) {
         int e = errno;
-        [[BranchLogger shared] logError:[NSString stringWithFormat:@"Can't read ip address: (%d): %s.", e, strerror(e)] error:nil];
-        goto exit;
+        [[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;
     }
 
     // Loop through linked list of interfaces --
@@ -92,7 +96,7 @@ - (NSString*) description {
         }
     }
 
-exit:
+err_free_interfaces:
     if (interfaces) freeifaddrs(interfaces);
     return currentInterfaces;
 }
diff --git a/Sources/BranchSDK/BNCReferringURLUtility.m b/Sources/BranchSDK/BNCReferringURLUtility.m
@@ -79,6 +79,7 @@ - (void)processQueryParameter:(NSURLQueryItem *)item {
         param.validityWindow = [self defaultValidityWindowForParam:name];
     }
     
+    [[BranchLogger shared] logDebug:[NSString stringWithFormat:@"Parsed Referring URL: %@", param] error:nil];
     [self.urlQueryParameters setValue:param forKey:name];
 }
 
@@ -90,6 +91,8 @@ - (void)processMetaQueryParameter:(NSURLQueryItem *)item {
         param.timestamp = [NSDate date];
         param.isDeepLink = YES;
         param.validityWindow = [self defaultValidityWindowForParam:BRANCH_REQUEST_KEY_META_CAMPAIGN_IDS];
+        
+        [[BranchLogger shared] logDebug:[NSString stringWithFormat:@"Parsed Referring URL: %@", param] error:nil];
         [self.urlQueryParameters setValue:param forKey:BRANCH_REQUEST_KEY_META_CAMPAIGN_IDS];
     }
 }
@@ -112,6 +115,8 @@ - (NSDictionary *)dictionaryFromEncodedJsonString:(NSString *)encodedJsonString
         NSDictionary *json = [NSJSONSerialization JSONObjectWithData:jsonData options:0 error:&error];
         if (!error) {
             return json;
+        } else {
+            [[BranchLogger shared] logError:@"Failed to parse Meta AEM JSON" error:error];
         }
     }
     return nil;
@@ -263,7 +268,6 @@ - (NSMutableDictionary *)serializeToJson:(NSMutableDictionary<NSString *, BNCUrl
 }
 
 - (void)checkForAndMigrateOldGbraid {
-        
     if (self.preferenceHelper.referrerGBRAID != nil &&
         self.urlQueryParameters[BRANCH_REQUEST_KEY_REFERRER_GBRAID].value == nil) {
         
@@ -286,7 +290,7 @@ - (void)checkForAndMigrateOldGbraid {
         self.preferenceHelper.referrerGBRAIDValidityWindow = 0;
         self.preferenceHelper.referrerGBRAIDInitDate = nil;
         
-        [[BranchLogger shared] logDebug:@"Updated old Gbraid to new BNCUrlQueryParameter" error:nil];
+        [[BranchLogger shared] logVerbose:@"Migrated old Gbraid to a BNCUrlQueryParameter" error:nil];
     }
 }
 
diff --git a/Sources/BranchSDK/BNCSystemObserver.m b/Sources/BranchSDK/BNCSystemObserver.m
@@ -31,6 +31,7 @@ @implementation BNCSystemObserver
 + (NSString *)appleAttributionToken {
     // token is not available on simulator
     if ([self isSimulator]) {
+        [[BranchLogger shared] logVerbose:[NSString stringWithFormat:@"AppleAttributionToken not available on simulator"] error:nil];
         return nil;
     }
     
@@ -54,7 +55,7 @@ + (NSString *)appleAttributionToken {
         // Apple said this API should respond within 50ms, lets give up after 500 ms
         dispatch_semaphore_wait(semaphore, dispatch_time(DISPATCH_TIME_NOW, (int64_t)(500 * NSEC_PER_MSEC)));
         if (token == nil) {
-            [[BranchLogger shared] logDebug:[NSString stringWithFormat:@"AppleAttributionToken request timed out"] error:nil];
+            [[BranchLogger shared] logError:[NSString stringWithFormat:@"AppleAttributionToken request timed out"] error:nil];
         }
     }
 #endif
@@ -64,6 +65,7 @@ + (NSString *)appleAttributionToken {
 
 + (NSString *)advertiserIdentifier {
     #ifdef BRANCH_EXCLUDE_IDFA_CODE
+    [[BranchLogger shared] logDebug:[NSString stringWithFormat:@"BRANCH_EXCLUDE_IDFA_CODE flag enabled. IDFA is not available"] error:nil];
     return nil;
     
     #else
@@ -80,6 +82,7 @@ + (NSString *)advertiserIdentifier {
                 (sharedManager, advertisingIdentifierSelector);
         uid = [uuid UUIDString];
         if ([uid isEqualToString:@"00000000-0000-0000-0000-000000000000"]) {
+            [[BranchLogger shared] logDebug:[NSString stringWithFormat:@"IDFA is all 0's. Probably running on a simulator or an App Clip."] error:nil];
             uid = nil;
         }
     }
@@ -92,6 +95,7 @@ + (NSString *)attOptedInStatus {
     NSString *statusString = @"unavailable";
 
     #ifdef BRANCH_EXCLUDE_ATT_STATUS_CODE
+    [[BranchLogger shared] logDebug:[NSString stringWithFormat:@"BRANCH_EXCLUDE_IDFA_CODE flag enabled. ATT opt in status unavailable"] error:nil];
     #else
 
     Class ATTrackingManagerClass = NSClassFromString(@"ATTrackingManager");
@@ -128,6 +132,8 @@ + (NSString *)defaultURIScheme {
     for (NSDictionary *urlType in urlTypes) {
         NSArray *urlSchemes = [urlType objectForKey:@"CFBundleURLSchemes"];
         for (NSString *uriScheme in urlSchemes) {
+            
+            // TODO: Add a log to indicate that a URI was ignored due to a match with a known URI format
             if ([uriScheme hasPrefix:@"fb"]) continue;  // Facebook
             if ([uriScheme hasPrefix:@"db"]) continue;  // DB?
             if ([uriScheme hasPrefix:@"twitterkit-"]) continue; // Twitter
@@ -151,6 +157,8 @@ + (NSString *)teamIdentifier {
     if (teamWithDot.length) {
         return [teamWithDot substringToIndex:([teamWithDot length] - 1)];
     }
+    
+    [[BranchLogger shared] logVerbose:@"AppIdentifierPrefix not found in mainBundle" error:nil];
     return nil;
 }
 
diff --git a/Sources/BranchSDK/BNCURLFilter.m b/Sources/BranchSDK/BNCURLFilter.m
@@ -58,7 +58,7 @@ - (void)useDefaultPatternList {
         if (regex && !regexError) {
             [array addObject:regex];
         } else {
-            [[BranchLogger shared] logError:[NSString stringWithFormat:@"Invalid regular expression '%@': %@.", pattern, regexError] error:regexError];
+            [[BranchLogger shared] logError:[NSString stringWithFormat:@"Invalid regular expression '%@'", pattern] error:regexError];
         }
     }
     return array;
@@ -129,13 +129,9 @@ - (BOOL)foundUpdatedURLList:(id<BNCNetworkOperationProtocol>)operation {
     if (statusCode == 404) {
         [[BranchLogger shared] logDebug:@"No update for URL ignore list found." error:nil];
         return NO;
-        
     } else if (statusCode != 200 || error != nil || jsonString == nil) {
-        [[BranchLogger shared] logError:[NSString stringWithFormat:@"Failed to update URL ignore list. error: %@ status: %ld", operation.error, (long)operation.response.statusCode] error:operation.error];
-        [[BranchLogger shared] logDebug: [NSString stringWithFormat:@"URL ignore JSON: %@", jsonString] error:nil];
-
+        [[BranchLogger shared] logWarning:[NSString stringWithFormat:@"Failed to update URL ignore list. error: %@ status: %ld", operation.error, (long)operation.response.statusCode] error:operation.error];
         return NO;
-        
     } else {
         return YES;
     }
@@ -146,19 +142,19 @@ - (nullable NSDictionary *)parseJSONFromData:(NSData *)data {
     NSDictionary *dictionary = [NSJSONSerialization JSONObjectWithData:data options:0 error:&error];
 
     if (error) {
-        [[BranchLogger shared] logError:[NSString stringWithFormat:@"Can't parse URL ignore JSON: %@.", error] error:error];
+        [[BranchLogger shared] logError:@"Failed to parse uri_skip_list" error:error];
         return nil;
     }
     
     NSArray *urls = dictionary[@"uri_skip_list"];
     if (![urls isKindOfClass:NSArray.class]) {
-        [[BranchLogger shared] logError:[NSString stringWithFormat:@"Can't parse URL ignore JSON, uri_skip_list is not a NSArray."] error:nil];
+        [[BranchLogger shared] logError:@"Failed to parse uri_skip_list is not a NSArray" error:nil];
         return nil;
     }
     
     NSNumber *version = dictionary[@"version"];
     if (![version isKindOfClass:NSNumber.class]) {
-        [[BranchLogger shared] logError:[NSString stringWithFormat:@"Can't parse URL ignore JSON, version is not a NSNumber."] error:nil];
+        [[BranchLogger shared] logError:@"Failed to parse uri_skip_list, version is not a NSNumber." error:nil];
         return nil;
     }
     
diff --git a/Sources/BranchSDK/BranchJsonConfig.m b/Sources/BranchSDK/BranchJsonConfig.m
@@ -56,13 +56,12 @@ - (void)loadConfigFile
     NSError *error;
     id object = [NSJSONSerialization JSONObjectWithData:data options:0 error:&error];
     if (!object || error) {
-        [[BranchLogger shared] logError:[NSString stringWithFormat:@"Failed to parse branch.json. Error: %@", error.localizedDescription] error:error];
+        [[BranchLogger shared] logError:@"Failed to parse branch.json" error:error];
         return;
     }
 
     if (![object isKindOfClass:NSDictionary.class]) {
         [[BranchLogger shared] logError:@"Contents of branch.json should be a JSON object." error:nil];
-
         return;
     }
 
@@ -72,11 +71,10 @@ - (void)loadConfigFile
 - (NSData *)configFileContents
 {
     if (!self.configFileURL) return nil;
-    [[BranchLogger shared] logDebug:[NSString stringWithFormat:@"Loading %@", self.configFileURL.pathComponents.lastObject] error:nil];
     NSError *error;
     NSData *data = [NSData dataWithContentsOfURL:self.configFileURL options:0 error:&error];
     if (!data || error) {
-        [[BranchLogger shared] logError:[NSString stringWithFormat:@"Failed to load %@. Error: %@", self.configFileURL, error.localizedDescription] error:error];
+        [[BranchLogger shared] logError:@"Failed to load branch.json" error:error];
         return nil;
     }
     return data;
@@ -109,7 +107,7 @@ - (void)findConfigFile
     }
     
     if (!configFileURL) {
-        [[BranchLogger shared] logDebug:@"No branch.json in app bundle." error:nil];
+        [[BranchLogger shared] logDebug:@"No branch.json in app bundle" error:nil];
         return;
     }
 
diff --git a/Sources/BranchSDK/BranchLastAttributedTouchData.m b/Sources/BranchSDK/BranchLastAttributedTouchData.m
@@ -33,7 +33,7 @@ + (void)requestLastTouchAttributedData:(BNCServerInterface *)serverInterface key
     if (window > -1 && window < 365) {
         request.attributionWindow = window;
     } else {
-        [[BranchLogger shared] logWarning:@"Attribution window is outside the expected range, using 30 days." error:nil];
+        [[BranchLogger shared] logWarning:@"Attribution window is outside the expected range, using 30 days" error:nil];
     }
     
     [request makeRequest:serverInterface key:key callback:^(BNCServerResponse *response, NSError *error) {

Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,7 @@ - (NSString*) description {`
`41`	`41`	`];`
`42`	`42`	`}`
`43`	`43`
	`44`	`+// Reads network interface information to the device IP address`
`44`	`45`	`+ (NSArray<BNCNetworkInterface > )currentInterfaces {`
`45`	`46`
`46`	`47`	`struct ifaddrs *interfaces = NULL;`
`@@ -49,8 +50,11 @@ - (NSString*) description {`
`49`	`50`	`// Retrieve the current interfaces - returns 0 on success`
`50`	`51`	`if (getifaddrs(&interfaces) != 0) {`
`51`	`52`	`int e = errno;`
`52`		`- [[BranchLogger shared] logError:[NSString stringWithFormat:@"Can't read ip address: (%d): %s.", e, strerror(e)] error:nil];`
`53`		`- goto exit;`
	`53`	`+ [[BranchLogger shared] logWarning:[NSString stringWithFormat:@"Failed to read IP Address: (%d): %s", e, strerror(e)] error:nil];`
	`54`	`+`
	`55`	`+ // Error handling in C code is one case where goto can improve readability.`
	`56`	`+ // https://www.kernel.org/doc/html/v4.19/process/coding-style.html`
	`57`	`+ goto err_free_interfaces;`
`54`	`58`	`}`
`55`	`59`
`56`	`60`	`// Loop through linked list of interfaces --`
`@@ -92,7 +96,7 @@ - (NSString*) description {`
`92`	`96`	`}`
`93`	`97`	`}`
`94`	`98`
`95`		`-exit:`
	`99`	`+err_free_interfaces:`
`96`	`100`	`if (interfaces) freeifaddrs(interfaces);`
`97`	`101`	`return currentInterfaces;`
`98`	`102`	`}`
Original file line number	Diff line number	Diff line change
`@@ -79,6 +79,7 @@ - (void)processQueryParameter:(NSURLQueryItem *)item {`
`79`	`79`	`param.validityWindow = [self defaultValidityWindowForParam:name];`
`80`	`80`	`}`
`81`	`81`
	`82`	`+ [[BranchLogger shared] logDebug:[NSString stringWithFormat:@"Parsed Referring URL: %@", param] error:nil];`
`82`	`83`	`[self.urlQueryParameters setValue:param forKey:name];`
`83`	`84`	`}`
`84`	`85`
`@@ -90,6 +91,8 @@ - (void)processMetaQueryParameter:(NSURLQueryItem *)item {`
`90`	`91`	`param.timestamp = [NSDate date];`
`91`	`92`	`param.isDeepLink = YES;`
`92`	`93`	`param.validityWindow = [self defaultValidityWindowForParam:BRANCH_REQUEST_KEY_META_CAMPAIGN_IDS];`
	`94`	`+`
	`95`	`+ [[BranchLogger shared] logDebug:[NSString stringWithFormat:@"Parsed Referring URL: %@", param] error:nil];`
`93`	`96`	`[self.urlQueryParameters setValue:param forKey:BRANCH_REQUEST_KEY_META_CAMPAIGN_IDS];`
`94`	`97`	`}`
`95`	`98`	`}`
`@@ -112,6 +115,8 @@ - (NSDictionary )dictionaryFromEncodedJsonString:(NSString )encodedJsonString`
`112`	`115`	`NSDictionary *json = [NSJSONSerialization JSONObjectWithData:jsonData options:0 error:&error];`
`113`	`116`	`if (!error) {`
`114`	`117`	`return json;`
	`118`	`+ } else {`
	`119`	`+ [[BranchLogger shared] logError:@"Failed to parse Meta AEM JSON" error:error];`
`115`	`120`	`}`
`116`	`121`	`}`
`117`	`122`	`return nil;`
`@@ -263,7 +268,6 @@ - (NSMutableDictionary )serializeToJson:(NSMutableDictionary<NSString , BNCUrl`
`263`	`268`	`}`
`264`	`269`
`265`	`270`	`- (void)checkForAndMigrateOldGbraid {`
`266`		`-`
`267`	`271`	`if (self.preferenceHelper.referrerGBRAID != nil &&`
`268`	`272`	`self.urlQueryParameters[BRANCH_REQUEST_KEY_REFERRER_GBRAID].value == nil) {`
`269`	`273`
`@@ -286,7 +290,7 @@ - (void)checkForAndMigrateOldGbraid {`
`286`	`290`	`self.preferenceHelper.referrerGBRAIDValidityWindow = 0;`
`287`	`291`	`self.preferenceHelper.referrerGBRAIDInitDate = nil;`
`288`	`292`
`289`		`- [[BranchLogger shared] logDebug:@"Updated old Gbraid to new BNCUrlQueryParameter" error:nil];`
	`293`	`+ [[BranchLogger shared] logVerbose:@"Migrated old Gbraid to a BNCUrlQueryParameter" error:nil];`
`290`	`294`	`}`
`291`	`295`	`}`
`292`	`296`
Original file line number	Diff line number	Diff line change
`@@ -56,13 +56,12 @@ - (void)loadConfigFile`
`56`	`56`	`NSError *error;`
`57`	`57`	`id object = [NSJSONSerialization JSONObjectWithData:data options:0 error:&error];`
`58`	`58`	`if (!object \|\| error) {`
`59`		`- [[BranchLogger shared] logError:[NSString stringWithFormat:@"Failed to parse branch.json. Error: %@", error.localizedDescription] error:error];`
	`59`	`+ [[BranchLogger shared] logError:@"Failed to parse branch.json" error:error];`
`60`	`60`	`return;`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`if (![object isKindOfClass:NSDictionary.class]) {`
`64`	`64`	`[[BranchLogger shared] logError:@"Contents of branch.json should be a JSON object." error:nil];`
`65`		`-`
`66`	`65`	`return;`
`67`	`66`	`}`
`68`	`67`
`@@ -72,11 +71,10 @@ - (void)loadConfigFile`
`72`	`71`	`- (NSData *)configFileContents`
`73`	`72`	`{`
`74`	`73`	`if (!self.configFileURL) return nil;`
`75`		`- [[BranchLogger shared] logDebug:[NSString stringWithFormat:@"Loading %@", self.configFileURL.pathComponents.lastObject] error:nil];`
`76`	`74`	`NSError *error;`
`77`	`75`	`NSData *data = [NSData dataWithContentsOfURL:self.configFileURL options:0 error:&error];`
`78`	`76`	`if (!data \|\| error) {`
`79`		`- [[BranchLogger shared] logError:[NSString stringWithFormat:@"Failed to load %@. Error: %@", self.configFileURL, error.localizedDescription] error:error];`
	`77`	`+ [[BranchLogger shared] logError:@"Failed to load branch.json" error:error];`
`80`	`78`	`return nil;`
`81`	`79`	`}`
`82`	`80`	`return data;`
`@@ -109,7 +107,7 @@ - (void)findConfigFile`
`109`	`107`	`}`
`110`	`108`
`111`	`109`	`if (!configFileURL) {`
`112`		`- [[BranchLogger shared] logDebug:@"No branch.json in app bundle." error:nil];`
	`110`	`+ [[BranchLogger shared] logDebug:@"No branch.json in app bundle" error:nil];`
`113`	`111`	`return;`
`114`	`112`	`}`
`115`	`113`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ + (void)requestLastTouchAttributedData:(BNCServerInterface *)serverInterface key`
`33`	`33`	`if (window > -1 && window < 365) {`
`34`	`34`	`request.attributionWindow = window;`
`35`	`35`	`} else {`
`36`		`- [[BranchLogger shared] logWarning:@"Attribution window is outside the expected range, using 30 days." error:nil];`
	`36`	`+ [[BranchLogger shared] logWarning:@"Attribution window is outside the expected range, using 30 days" error:nil];`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`[request makeRequest:serverInterface key:key callback:^(BNCServerResponse response, NSError error) {`