refactor: extract all loggers to helper

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

Author: setchy

src/renderer/utils/auth/migration.ts

@@ -1,6 +1,6 @@
-import log from 'electron-log';
 import type { Account, AuthState } from '../../types';
 import { Constants } from '../constants';
+import { logInfo } from '../logger';
 import { loadState, saveState } from '../storage';
 import { getUserData } from './utils';
 
@@ -16,15 +16,22 @@ export async function migrateAuthenticatedAccounts() {
     return;
   }
 
-  log.info('Account Migration: Commencing authenticated accounts migration');
+  logInfo(
+    'migrateAuthenticatedAccounts',
+    'Commencing authenticated accounts migration',
+  );
 
   const migratedAccounts = await convertAccounts(existing.auth);
 
   saveState({
     auth: { ...existing.auth, accounts: migratedAccounts },
     settings: existing.settings,
   });
-  log.info('Account Migration: Authenticated accounts migration complete');
+
+  logInfo(
+    'migrateAuthenticatedAccounts',
+    'Authenticated accounts migration complete',
+  );
 }
 
 export function hasAccountsToMigrate(existingAuthState: AuthState): boolean {

src/renderer/utils/helpers.ts

@@ -4,14 +4,13 @@ import {
   ChevronRightIcon,
 } from '@primer/octicons-react';
 import { formatDistanceToNowStrict, parseISO } from 'date-fns';
-import log from 'electron-log';
 import { defaultSettings } from '../context/App';
 import type { Chevron, Hostname, Link, SettingsState } from '../types';
 import type { Notification } from '../typesGitHub';
 import { getHtmlUrl, getLatestDiscussion } from './api/client';
 import type { PlatformType } from './auth/types';
 import { Constants } from './constants';
-import { logError } from './logger';
+import { logError, logWarn } from './logger';
 import {
   getCheckSuiteAttributes,
   getLatestDiscussionComment,
@@ -159,9 +158,9 @@ export async function generateGitHubWebUrl(
       notification,
     );
 
-    log.warn(
-      'Will fall back to opening repository root url for',
-      notification.repository.full_name,
+    logWarn(
+      'generateGitHubWebUrl',
+      `Falling back to repository root url: ${notification.repository.full_name}`,
     );
   }
 

src/renderer/utils/logger.test.ts

@@ -1,30 +1,78 @@
 import log from 'electron-log';
 import { mockSingleNotification } from './api/__mocks__/response-mocks';
-import { logError } from './logger';
+import { logError, logInfo, logWarn } from './logger';
 
 describe('renderer/utils/logger.ts', () => {
+  const logInfoSpy = jest.spyOn(log, 'info').mockImplementation();
+  const logWarnSpy = jest.spyOn(log, 'warn').mockImplementation();
   const logErrorSpy = jest.spyOn(log, 'error').mockImplementation();
+
   const mockError = new Error('baz');
 
   beforeEach(() => {
+    logInfoSpy.mockReset();
+    logWarnSpy.mockReset();
     logErrorSpy.mockReset();
   });
 
-  it('log error without notification', () => {
-    logError('foo', 'bar', mockError);
+  describe('logInfo', () => {
+    it('log info without notification', () => {
+      logInfo('foo', 'bar');
+
+      expect(logInfoSpy).toHaveBeenCalledTimes(1);
+      expect(logInfoSpy).toHaveBeenCalledWith('[foo]:', 'bar');
+    });
+
+    it('log info with notification', () => {
+      logInfo('foo', 'bar', mockSingleNotification);
+
+      expect(logInfoSpy).toHaveBeenCalledTimes(1);
+      expect(logInfoSpy).toHaveBeenCalledWith(
+        '[foo]:',
+        'bar',
+        '[Issue]: I am a robot and this is a test! for repository gitify-app/notifications-test',
+      );
+    });
+  });
+
+  describe('logWarn', () => {
+    it('log warn without notification', () => {
+      logWarn('foo', 'bar');
+
+      expect(logWarnSpy).toHaveBeenCalledTimes(1);
+      expect(logWarnSpy).toHaveBeenCalledWith('[foo]:', 'bar');
+    });
+
+    it('log warn with notification', () => {
+      logWarn('foo', 'bar', mockSingleNotification);
 
-    expect(logErrorSpy).toHaveBeenCalledTimes(1);
-    expect(logErrorSpy).toHaveBeenCalledWith('[foo]: bar', mockError);
+      expect(logWarnSpy).toHaveBeenCalledTimes(1);
+      expect(logWarnSpy).toHaveBeenCalledWith(
+        '[foo]:',
+        'bar',
+        '[Issue]: I am a robot and this is a test! for repository gitify-app/notifications-test',
+      );
+    });
   });
 
-  it('log error with notification', () => {
-    logError('foo', 'bar', mockError, mockSingleNotification);
+  describe('logError', () => {
+    it('log error without notification', () => {
+      logError('foo', 'bar', mockError);
+
+      expect(logErrorSpy).toHaveBeenCalledTimes(1);
+      expect(logErrorSpy).toHaveBeenCalledWith('[foo]:', 'bar', mockError);
+    });
+
+    it('log error with notification', () => {
+      logError('foo', 'bar', mockError, mockSingleNotification);
 
-    expect(logErrorSpy).toHaveBeenCalledTimes(1);
-    expect(logErrorSpy).toHaveBeenCalledWith(
-      '[foo]: bar',
-      '[Issue]: I am a robot and this is a test! for repository gitify-app/notifications-test',
-      mockError,
-    );
+      expect(logErrorSpy).toHaveBeenCalledTimes(1);
+      expect(logErrorSpy).toHaveBeenCalledWith(
+        '[foo]:',
+        'bar',
+        '[Issue]: I am a robot and this is a test! for repository gitify-app/notifications-test',
+        mockError,
+      );
+    });
   });
 });

src/renderer/utils/logger.ts

@@ -1,19 +1,55 @@
 import log from 'electron-log';
 import type { Notification } from '../typesGitHub';
 
-export function logError(
+function logMessage(
+  // biome-ignore lint/suspicious/noExplicitAny: <explanation>
+  logFunction: (...params: any[]) => void,
   type: string,
   message: string,
-  err: Error,
+  err?: Error,
   notification?: Notification,
 ) {
-  if (notification) {
-    log.error(
-      `[${type}]: ${message}`,
+  if (notification && err) {
+    logFunction(
+      `[${type}]:`,
+      message,
       `[${notification.subject.type}]: ${notification.subject.title} for repository ${notification.repository.full_name}`,
       err,
     );
+  } else if (notification) {
+    logFunction(
+      `[${type}]:`,
+      message,
+      `[${notification.subject.type}]: ${notification.subject.title} for repository ${notification.repository.full_name}`,
+    );
+  } else if (err) {
+    logFunction(`[${type}]:`, message, err);
   } else {
-    log.error(`[${type}]: ${message}`, err);
+    logFunction(`[${type}]:`, message);
   }
 }
+
+export function logInfo(
+  type: string,
+  message: string,
+  notification?: Notification,
+) {
+  logMessage(log.info, type, message, null, notification);
+}
+
+export function logWarn(
+  type: string,
+  message: string,
+  notification?: Notification,
+) {
+  logMessage(log.warn, type, message, null, notification);
+}
+
+export function logError(
+  type: string,
+  message: string,
+  err: Error,
+  notification?: Notification,
+) {
+  logMessage(log.error, type, message, err, notification);
+}

src/renderer/utils/notifications.ts

@@ -1,5 +1,4 @@
 import path from 'node:path';
-import log from 'electron-log';
 import type {
   AccountNotifications,
   GitifyState,
@@ -12,7 +11,7 @@ import { getAccountUUID } from './auth/utils';
 import { hideWindow, showWindow, updateTrayIcon } from './comms';
 import { Constants } from './constants';
 import { openNotification } from './links';
-import { logError } from './logger';
+import { logError, logWarn } from './logger';
 import { isWindows } from './platform';
 import { getGitifySubjectDetails } from './subject';
 
@@ -198,7 +197,10 @@ export async function enrichNotifications(
           notification,
         );
 
-        log.warn('Continuing with base notification details');
+        logWarn(
+          'enrichNotifications',
+          'Continuing with base notification details',
+        );
       }
 
       return {