refactor: extract all loggers to helper

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

Author: setchy

src/main/utils.ts

@@ -43,7 +43,11 @@ export function openLogsDirectory() {
   const logDirectory = path.dirname(log.transports.file?.getFile()?.path);
 
   if (!logDirectory) {
-    logError('openLogsDirectory', 'Could not find log directory!');
+    logError(
+      'openLogsDirectory',
+      'Could not find log directory!',
+      new Error('Directory not found'),
+    );
     return;
   }
 

src/shared/logger.test.ts

@@ -21,17 +21,17 @@ describe('renderer/utils/logger.ts', () => {
       logInfo('foo', 'bar');
 
       expect(logInfoSpy).toHaveBeenCalledTimes(1);
-      expect(logInfoSpy).toHaveBeenCalledWith('[foo]:', 'bar');
+      expect(logInfoSpy).toHaveBeenCalledWith('[foo]', 'bar');
     });
 
     it('log info with notification', () => {
       logInfo('foo', 'bar', mockSingleNotification);
 
       expect(logInfoSpy).toHaveBeenCalledTimes(1);
       expect(logInfoSpy).toHaveBeenCalledWith(
-        '[foo]:',
+        '[foo]',
         'bar',
-        '[Issue]: I am a robot and this is a test! for repository gitify-app/notifications-test',
+        '[Issue >> gitify-app/notifications-test >> I am a robot and this is a test!]',
       );
     });
   });
@@ -41,17 +41,17 @@ describe('renderer/utils/logger.ts', () => {
       logWarn('foo', 'bar');
 
       expect(logWarnSpy).toHaveBeenCalledTimes(1);
-      expect(logWarnSpy).toHaveBeenCalledWith('[foo]:', 'bar');
+      expect(logWarnSpy).toHaveBeenCalledWith('[foo]', 'bar');
     });
 
     it('log warn with notification', () => {
       logWarn('foo', 'bar', mockSingleNotification);
 
       expect(logWarnSpy).toHaveBeenCalledTimes(1);
       expect(logWarnSpy).toHaveBeenCalledWith(
-        '[foo]:',
+        '[foo]',
         'bar',
-        '[Issue]: I am a robot and this is a test! for repository gitify-app/notifications-test',
+        '[Issue >> gitify-app/notifications-test >> I am a robot and this is a test!]',
       );
     });
   });
@@ -61,17 +61,17 @@ describe('renderer/utils/logger.ts', () => {
       logError('foo', 'bar', mockError);
 
       expect(logErrorSpy).toHaveBeenCalledTimes(1);
-      expect(logErrorSpy).toHaveBeenCalledWith('[foo]:', 'bar', mockError);
+      expect(logErrorSpy).toHaveBeenCalledWith('[foo]', 'bar', mockError);
     });
 
     it('log error with notification', () => {
       logError('foo', 'bar', mockError, mockSingleNotification);
 
       expect(logErrorSpy).toHaveBeenCalledTimes(1);
       expect(logErrorSpy).toHaveBeenCalledWith(
-        '[foo]:',
+        '[foo]',
         'bar',
-        '[Issue]: I am a robot and this is a test! for repository gitify-app/notifications-test',
+        '[Issue >> gitify-app/notifications-test >> I am a robot and this is a test!]',
         mockError,
       );
     });

src/shared/logger.ts

@@ -10,11 +10,11 @@ function logMessage(
   err?: Error,
   notification?: Notification,
 ) {
-  const args: (string | Error)[] = [`[${type}]:`, message];
+  const args: (string | Error)[] = [`[${type}]`, message];
 
   if (notification) {
     args.push(
-      `[${notification.subject.type}]: ${notification.subject.title} for repository ${notification.repository.full_name}`,
+      `[${notification.subject.type} >> ${notification.repository.full_name} >> ${notification.subject.title}]`,
     );
   }
 
@@ -44,7 +44,7 @@ export function logWarn(
 export function logError(
   type: string,
   message: string,
-  err?: Error,
+  err: Error,
   notification?: Notification,
 ) {
   logMessage(log.error, type, message, err, notification);