refactor(logging): improve details in logs (#1681)

Signed-off-by: Adam Setch <[email protected]>

Author: setchy

src/main/first-run.ts

@@ -48,8 +48,8 @@ function isFirstRun() {
     }
 
     fs.writeFileSync(configPath, '');
-  } catch (error) {
-    log.error('First run: Unable to write firstRun file', error);
+  } catch (err) {
+    log.error('First run: Unable to write firstRun file', err);
   }
 
   return true;

src/renderer/hooks/useNotifications.ts

@@ -121,7 +121,10 @@ export const useNotifications = (): NotificationsState => {
         setNotifications(updatedNotifications);
         setTrayIconColor(updatedNotifications);
       } catch (err) {
-        log.error('Error occurred while marking notification as read', err);
+        log.error(
+          '[markNotificationsAsRead]: Error occurred while marking notifications as read',
+          err,
+        );
       }
 
       setStatus('success');
@@ -155,7 +158,10 @@ export const useNotifications = (): NotificationsState => {
         setNotifications(updatedNotifications);
         setTrayIconColor(updatedNotifications);
       } catch (err) {
-        log.error('Error occurred while marking notifications as done', err);
+        log.error(
+          '[markNotificationsAsDone]: error occurred while marking notifications as done',
+          err,
+        );
       }
 
       setStatus('success');
@@ -181,7 +187,7 @@ export const useNotifications = (): NotificationsState => {
         }
       } catch (err) {
         log.error(
-          'Error occurred while unsubscribing from notification thread',
+          '[unsubscribeNotification]: error occurred while unsubscribing from notification thread',
           err,
         );
       }

src/renderer/utils/api/client.ts

@@ -217,7 +217,11 @@ export async function getHtmlUrl(url: Link, token: Token): Promise<string> {
     const response = (await apiRequestAuth(url, 'GET', token)).data;
     return response.html_url;
   } catch (err) {
-    log.error('Error occurred while fetching notification html url', err);
+    log.error(
+      '[getHtmlUrl]: error occurred while fetching html url for',
+      url,
+      err,
+    );
   }
 }
 
@@ -268,7 +272,8 @@ export async function getLatestDiscussion(
     );
   } catch (err) {
     log.error(
-      'Error occurred while fetching notification latest discussion',
+      '[getLatestDiscussion]: failed to fetch latest discussion for notification',
+      `[${notification.subject.type}]: ${notification.subject.title} for repository ${notification.repository.full_name}`,
       err,
     );
   }

src/renderer/utils/api/request.ts

@@ -72,9 +72,9 @@ export async function apiRequestAuth(
 
       nextUrl = getNextURLFromLinkHeader(response);
     }
-  } catch (error) {
-    log.error('API request failed:', error);
-    throw error;
+  } catch (err) {
+    log.error('[apiRequestAuth]: API request failed:', err);
+    throw err;
   }
 
   return {

src/renderer/utils/auth/utils.ts

@@ -169,8 +169,12 @@ export async function refreshAccount(account: Account): Promise<Account> {
     account.version = extractHostVersion(
       res.headers['x-github-enterprise-version'],
     );
-  } catch (error) {
-    log.error('Failed to refresh account', error);
+  } catch (err) {
+    log.error(
+      '[refreshAccount]: failed to refresh account for user',
+      account.user.login,
+      err,
+    );
   }
 
   return account;

src/renderer/utils/helpers.ts

@@ -152,9 +152,14 @@ export async function generateGitHubWebUrl(
     }
   } catch (err) {
     log.error(
-      'Error occurred while attempting to get a specific notification URL.  Will fall back to defaults',
+      '[generateGitHubWebUrl]: failed to resolve specific notification html url for',
+      `[${notification.subject.type}]: ${notification.subject.title} for repository ${notification.repository.full_name}`,
       err,
     );
+    log.warn(
+      'Will fall back to opening repository root url for',
+      notification.repository.full_name,
+    );
   }
 
   url.searchParams.set(

src/renderer/utils/notifications.ts

@@ -156,15 +156,15 @@ export async function getAllNotifications(
             notifications: notifications,
             error: null,
           };
-        } catch (error) {
+        } catch (err) {
           log.error(
-            'Error occurred while fetching account notifications',
-            error,
+            '[getAllNotifications]: error occurred while fetching account notifications',
+            err,
           );
           return {
             account: accountNotifications.account,
             notifications: [],
-            error: determineFailureType(error),
+            error: determineFailureType(err),
           };
         }
       }),
@@ -187,11 +187,13 @@ export async function enrichNotifications(
 
       try {
         additionalSubjectDetails = await getGitifySubjectDetails(notification);
-      } catch (error) {
-        log.warn(
-          `Error occurred while enriching notification ${notification.subject.title} for repository ${notification.repository.full_name}. Continuing with base notification`,
-          error,
+      } catch (err) {
+        log.error(
+          '[enrichNotifications] failed to enrich notification details for',
+          `[${notification.subject.type}]: ${notification.subject.title} for repository ${notification.repository.full_name}`,
+          err,
         );
+        log.warn('Continuing with base notification details');
       }
 
       return {

src/renderer/utils/subject.test.ts

@@ -1160,6 +1160,10 @@ describe('renderer/utils/subject.ts', () => {
           type: 'Issue',
           url: 'https://api.github.com/repos/gitify-app/notifications-test/issues/1' as Link,
         });
+        const mockRepository = {
+          full_name: 'gitify-app/notifications-test',
+        } as Repository;
+        mockNotification.repository = mockRepository;
 
         nock('https://api.github.com')
           .get('/repos/gitify-app/notifications-test/issues/1')
@@ -1168,7 +1172,8 @@ describe('renderer/utils/subject.ts', () => {
         await getGitifySubjectDetails(mockNotification);
 
         expect(logErrorSpy).toHaveBeenCalledWith(
-          'Error occurred while fetching details for Issue notification: This issue will throw an error',
+          '[getGitifySubjectDetails]: failed to fetch details for notification for',
+          '[Issue]: This issue will throw an error for repository gitify-app/notifications-test',
           mockError,
         );
       });

src/renderer/utils/subject.ts

@@ -50,7 +50,8 @@ export async function getGitifySubjectDetails(
     }
   } catch (err) {
     log.error(
-      `Error occurred while fetching details for ${notification.subject.type} notification: ${notification.subject.title}`,
+      '[getGitifySubjectDetails]: failed to fetch details for notification for',
+      `[${notification.subject.type}]: ${notification.subject.title} for repository ${notification.repository.full_name}`,
       err,
     );
   }