move to shared folder

setchy · setchy · commit d3c1530700c7 · 2024-12-29T17:31:57.000+01:00
Signed-off-by: Adam Setch &lt;adam.setch@outlook.com&gt;
diff --git a/src/main/first-run.ts b/src/main/first-run.ts
@@ -1,7 +1,8 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import { app, dialog } from 'electron';
-import log from 'electron-log';
+
+import { logError } from '../shared/logger';
 
 export async function onFirstRunMaybe() {
   if (isFirstRun()) {
@@ -49,7 +50,7 @@ function isFirstRun() {
 
     fs.writeFileSync(configPath, '');
   } catch (err) {
-    log.error('First run: Unable to write firstRun file', err);
+    logError('isFirstRun', 'Unable to write firstRun file', err);
   }
 
   return true;
diff --git a/src/main/updater.ts b/src/main/updater.ts
@@ -2,6 +2,8 @@ import log from 'electron-log';
 import { autoUpdater } from 'electron-updater';
 import type { Menubar } from 'menubar';
 import { updateElectronApp } from 'update-electron-app';
+
+import { logError, logInfo } from '../shared/logger';
 import type MenuBuilder from './menu';
 
 export default class Updater {
@@ -18,29 +20,29 @@ export default class Updater {
     });
 
     autoUpdater.on('checking-for-update', () => {
-      log.info('Auto Updater: Checking for update');
+      logInfo('auto updater', 'Checking for update');
       this.menuBuilder.setCheckForUpdatesMenuEnabled(false);
     });
 
-    autoUpdater.on('error', (error) => {
-      log.error('Auto Updater: error checking for update', error);
+    autoUpdater.on('error', (err) => {
+      logError('auto updater', 'Error checking for update', err);
       this.menuBuilder.setCheckForUpdatesMenuEnabled(true);
     });
 
     autoUpdater.on('update-available', () => {
-      log.info('Auto Updater: New update available');
+      logInfo('auto updater', 'New update available');
       menuBuilder.setUpdateAvailableMenuEnabled(true);
       this.menubar.tray.setToolTip('Gitify\nA new update is available');
     });
 
     autoUpdater.on('update-downloaded', () => {
-      log.info('Auto Updater: Update downloaded');
+      logInfo('auto updater', 'Update downloaded');
       menuBuilder.setUpdateReadyForInstallMenuEnabled(true);
       this.menubar.tray.setToolTip('Gitify\nA new update is ready to install');
     });
 
     autoUpdater.on('update-not-available', () => {
-      log.info('Auto Updater: update not available');
+      logInfo('auto updater', 'Update not available');
       this.menuBuilder.setCheckForUpdatesMenuEnabled(true);
     });
   }
diff --git a/src/main/utils.ts b/src/main/utils.ts
@@ -5,14 +5,16 @@ import { dialog, shell } from 'electron';
 import log from 'electron-log';
 import type { Menubar } from 'menubar';
 
+import { logError, logInfo } from '../shared/logger';
+
 export function takeScreenshot(mb: Menubar) {
   const date = new Date();
   const dateStr = date.toISOString().replace(/:/g, '-');
 
   const capturedPicFilePath = `${os.homedir()}/${dateStr}-gitify-screenshot.png`;
   mb.window.capturePage().then((img) => {
     fs.writeFile(capturedPicFilePath, img.toPNG(), () =>
-      log.info(`Screenshot saved ${capturedPicFilePath}`),
+      logInfo('takeScreenshot', `Screenshot saved ${capturedPicFilePath}`),
     );
   });
 }
@@ -41,7 +43,7 @@ export function openLogsDirectory() {
   const logDirectory = path.dirname(log.transports.file?.getFile()?.path);
 
   if (!logDirectory) {
-    log.error('Could not find log directory!');
+    logError('openLogsDirectory', 'Could not find log directory!');
     return;
   }
 
diff --git a/src/renderer/hooks/useNotifications.test.ts b/src/renderer/hooks/useNotifications.test.ts
@@ -2,6 +2,7 @@ import { act, renderHook, waitFor } from '@testing-library/react';
 import axios, { AxiosError } from 'axios';
 import nock from 'nock';
 
+import * as logger from '../../shared/logger';
 import {
   mockAuth,
   mockGitHubCloudAccount,
@@ -13,7 +14,6 @@ import {
   mockSingleNotification,
 } from '../utils/api/__mocks__/response-mocks';
 import { Errors } from '../utils/errors';
-import * as logger from '../utils/logger';
 import { useNotifications } from './useNotifications';
 
 describe('renderer/hooks/useNotifications.ts', () => {
diff --git a/src/renderer/hooks/useNotifications.ts b/src/renderer/hooks/useNotifications.ts
@@ -1,4 +1,6 @@
 import { useCallback, useState } from 'react';
+
+import { logError } from '../../shared/logger';
 import type {
   Account,
   AccountNotifications,
@@ -13,7 +15,6 @@ import {
   markNotificationThreadAsRead,
 } from '../utils/api/client';
 import { isMarkAsDoneFeatureSupported } from '../utils/features';
-import { logError } from '../utils/logger';
 import {
   getAllNotifications,
   setTrayIconColor,
diff --git a/src/renderer/routes/Accounts.tsx b/src/renderer/routes/Accounts.tsx
@@ -10,9 +10,10 @@ import {
   StarIcon,
   SyncIcon,
 } from '@primer/octicons-react';
-
 import { type FC, useCallback, useContext } from 'react';
 import { useNavigate } from 'react-router-dom';
+
+import { logError } from '../../shared/logger';
 import { Header } from '../components/Header';
 import { AuthMethodIcon } from '../components/icons/AuthMethodIcon';
 import { AvatarIcon } from '../components/icons/AvatarIcon';
@@ -29,7 +30,6 @@ import {
   openDeveloperSettings,
   openHost,
 } from '../utils/links';
-import { logError } from '../utils/logger';
 import { saveState } from '../utils/storage';
 
 export const AccountsRoute: FC = () => {
diff --git a/src/renderer/routes/Login.tsx b/src/renderer/routes/Login.tsx
@@ -1,12 +1,13 @@
 import { KeyIcon, MarkGithubIcon, PersonIcon } from '@primer/octicons-react';
 import { type FC, useCallback, useContext, useEffect } from 'react';
 import { useNavigate } from 'react-router-dom';
+
+import { logError } from '../../shared/logger';
 import { Button } from '../components/buttons/Button';
 import { LogoIcon } from '../components/icons/LogoIcon';
 import { AppContext } from '../context/App';
 import { Size } from '../types';
 import { showWindow } from '../utils/comms';
-import { logError } from '../utils/logger';
 
 export const LoginRoute: FC = () => {
   const navigate = useNavigate();
diff --git a/src/renderer/routes/LoginWithOAuthApp.tsx b/src/renderer/routes/LoginWithOAuthApp.tsx
@@ -2,6 +2,8 @@ import { BookIcon, PersonIcon, SignInIcon } from '@primer/octicons-react';
 import { type FC, useCallback, useContext } from 'react';
 import { Form, type FormRenderProps } from 'react-final-form';
 import { useNavigate } from 'react-router-dom';
+
+import { logError } from '../../shared/logger';
 import { Header } from '../components/Header';
 import { Button } from '../components/buttons/Button';
 import { FieldInput } from '../components/fields/FieldInput';
@@ -21,7 +23,6 @@ import {
   isValidToken,
 } from '../utils/auth/utils';
 import { Constants } from '../utils/constants';
-import { logError } from '../utils/logger';
 
 interface IValues {
   hostname?: Hostname;
diff --git a/src/renderer/routes/LoginWithPersonalAccessToken.tsx b/src/renderer/routes/LoginWithPersonalAccessToken.tsx
@@ -2,6 +2,8 @@ import { BookIcon, KeyIcon, SignInIcon } from '@primer/octicons-react';
 import { type FC, useCallback, useContext, useState } from 'react';
 import { Form, type FormRenderProps } from 'react-final-form';
 import { useNavigate } from 'react-router-dom';
+
+import { logError } from '../../shared/logger';
 import { Header } from '../components/Header';
 import { Button } from '../components/buttons/Button';
 import { FieldInput } from '../components/fields/FieldInput';
@@ -14,7 +16,6 @@ import {
   isValidToken,
 } from '../utils/auth/utils';
 import { Constants } from '../utils/constants';
-import { logError } from '../utils/logger';
 
 interface IValues {
   token?: Token;
diff --git a/src/renderer/utils/api/client.test.ts b/src/renderer/utils/api/client.test.ts
@@ -1,11 +1,11 @@
 import axios, { type AxiosPromise, type AxiosResponse } from 'axios';
+import * as logger from '../../../shared/logger';
 import {
   mockGitHubCloudAccount,
   mockGitHubEnterpriseServerAccount,
   mockToken,
 } from '../../__mocks__/state-mocks';
 import type { Hostname, Link, SettingsState, Token } from '../../types';
-import * as logger from '../logger';
 import {
   getAuthenticatedUser,
   getHtmlUrl,
diff --git a/src/renderer/utils/api/client.ts b/src/renderer/utils/api/client.ts
@@ -1,5 +1,7 @@
 import type { AxiosPromise } from 'axios';
 import { print } from 'graphql/language/printer';
+
+import { logError } from '../../../shared/logger';
 import type {
   Account,
   Hostname,
@@ -22,7 +24,6 @@ import type {
   UserDetails,
 } from '../../typesGitHub';
 import { isAnsweredDiscussionFeatureSupported } from '../features';
-import { logError } from '../logger';
 import { QUERY_SEARCH_DISCUSSIONS } from './graphql/discussions';
 import { formatAsGitHubSearchSyntax } from './graphql/utils';
 import { apiRequestAuth } from './request';
diff --git a/src/renderer/utils/api/request.ts b/src/renderer/utils/api/request.ts
@@ -3,8 +3,9 @@ import axios, {
   type AxiosPromise,
   type Method,
 } from 'axios';
+
+import { logError } from '../../../shared/logger';
 import type { Link, Token } from '../../types';
-import { logError } from '../logger';
 import { getNextURLFromLinkHeader } from './utils';
 
 /**
diff --git a/src/renderer/utils/auth/migration.ts b/src/renderer/utils/auth/migration.ts
@@ -1,6 +1,6 @@
+import { logInfo } from '../../../shared/logger';
 import type { Account, AuthState } from '../../types';
 import { Constants } from '../constants';
-import { logInfo } from '../logger';
 import { loadState, saveState } from '../storage';
 import { getUserData } from './utils';
 
diff --git a/src/renderer/utils/auth/utils.ts b/src/renderer/utils/auth/utils.ts
@@ -1,6 +1,8 @@
 import { BrowserWindow } from '@electron/remote';
 import { format } from 'date-fns';
 import semver from 'semver';
+
+import { logError } from '../../../shared/logger';
 import type {
   Account,
   AuthCode,
@@ -16,7 +18,6 @@ import { getAuthenticatedUser } from '../api/client';
 import { apiRequest } from '../api/request';
 import { Constants } from '../constants';
 import { getPlatformFromHostname } from '../helpers';
-import { logError } from '../logger';
 import type { AuthMethod, AuthResponse, AuthTokenResponse } from './types';
 
 // TODO - Refactor our OAuth2 flow to use system browser and local app gitify://callback - see #485 #561 #654
diff --git a/src/renderer/utils/helpers.test.ts b/src/renderer/utils/helpers.test.ts
@@ -6,6 +6,7 @@ import {
   ChevronLeftIcon,
   ChevronRightIcon,
 } from '@primer/octicons-react';
+import * as logger from '../../shared/logger';
 import { defaultSettings } from '../context/App';
 import type { Hostname, Link, SettingsState } from '../types';
 import type { SubjectType } from '../typesGitHub';
@@ -14,7 +15,6 @@ import {
   mockSingleNotification,
 } from './api/__mocks__/response-mocks';
 import * as apiRequests from './api/request';
-import * as logger from './logger';
 
 import {
   formatForDisplay,
diff --git a/src/renderer/utils/helpers.ts b/src/renderer/utils/helpers.ts
@@ -4,13 +4,14 @@ import {
   ChevronRightIcon,
 } from '@primer/octicons-react';
 import { formatDistanceToNowStrict, parseISO } from 'date-fns';
+
+import { logError, logWarn } from '../../shared/logger';
 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, logWarn } from './logger';
 import {
   getCheckSuiteAttributes,
   getLatestDiscussionComment,
diff --git a/src/renderer/utils/notifications.ts b/src/renderer/utils/notifications.ts
@@ -1,4 +1,6 @@
 import path from 'node:path';
+
+import { logError, logWarn } from '../../shared/logger';
 import type {
   AccountNotifications,
   GitifyState,
@@ -11,7 +13,6 @@ import { getAccountUUID } from './auth/utils';
 import { hideWindow, showWindow, updateTrayIcon } from './comms';
 import { Constants } from './constants';
 import { openNotification } from './links';
-import { logError, logWarn } from './logger';
 import { isWindows } from './platform';
 import { getGitifySubjectDetails } from './subject';
 
diff --git a/src/renderer/utils/subject.test.ts b/src/renderer/utils/subject.test.ts
@@ -31,7 +31,7 @@ const mockDiscussionAuthor: DiscussionAuthor = {
   avatar_url: 'https://avatars.githubusercontent.com/u/123456789?v=4' as Link,
   type: 'User',
 };
-import * as logger from './logger';
+import * as logger from '../../shared/logger';
 
 describe('renderer/utils/subject.ts', () => {
   beforeEach(() => {
diff --git a/src/renderer/utils/subject.ts b/src/renderer/utils/subject.ts
@@ -1,3 +1,4 @@
+import { logError } from '../../shared/logger';
 import type { Link } from '../types';
 import type {
   CheckSuiteAttributes,
@@ -24,7 +25,6 @@ import {
   getPullRequestReviews,
   getRelease,
 } from './api/client';
-import { logError } from './logger';
 
 export async function getGitifySubjectDetails(
   notification: Notification,
diff --git a/src/shared/logger.test.ts b/src/shared/logger.test.ts
@@ -1,5 +1,6 @@
 import log from 'electron-log';
-import { mockSingleNotification } from './api/__mocks__/response-mocks';
+
+import { mockSingleNotification } from '../renderer/utils/api/__mocks__/response-mocks';
 import { logError, logInfo, logWarn } from './logger';
 
 describe('renderer/utils/logger.ts', () => {
diff --git a/src/shared/logger.ts b/src/shared/logger.ts
@@ -1,5 +1,6 @@
 import log from 'electron-log';
-import type { Notification } from '../typesGitHub';
+
+import type { Notification } from '../renderer/typesGitHub';
 
 function logMessage(
   // biome-ignore lint/suspicious/noExplicitAny: <explanation>
@@ -43,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);
