refactor: test suites

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

Author: setchy

src/preload/index.test.ts

@@ -75,7 +75,9 @@ describe('preload/index', () => {
 
   it('exposes api on window when context isolation disabled', async () => {
     await importPreload();
+
     const w = window as unknown as { gitify: Record<string, unknown> };
+
     expect(w.gitify).toBeDefined();
     expect(exposeInMainWorld).not.toHaveBeenCalled();
   });
@@ -84,16 +86,20 @@ describe('preload/index', () => {
     (process as unknown as { contextIsolated?: boolean }).contextIsolated =
       true;
     await importPreload();
+
     expect(exposeInMainWorld).toHaveBeenCalledTimes(1);
+
     const [key, api] = exposeInMainWorld.mock.calls[0];
     expect(key).toBe('gitify');
     expect(api).toHaveProperty('openExternalLink');
   });
 
   it('tray.updateColor sends correct events', async () => {
     await importPreload();
+
     const api = (window as unknown as { gitify: TestApi }).gitify; // casting only in test boundary
     api.tray.updateColor(-1);
+
     expect(sendMainEvent).toHaveBeenNthCalledWith(
       1,
       EVENTS.UPDATE_ICON_COLOR,
@@ -103,8 +109,10 @@ describe('preload/index', () => {
 
   it('openExternalLink sends event with payload', async () => {
     await importPreload();
+
     const api = (window as unknown as { gitify: TestApi }).gitify;
     api.openExternalLink('https://example.com', true);
+
     expect(sendMainEvent).toHaveBeenCalledWith(EVENTS.OPEN_EXTERNAL, {
       url: 'https://example.com',
       activate: true,
@@ -114,60 +122,79 @@ describe('preload/index', () => {
   it('app.version returns dev in development', async () => {
     const originalEnv = process.env.NODE_ENV;
     process.env.NODE_ENV = 'development';
+
     await importPreload();
+
     const api = (window as unknown as { gitify: TestApi }).gitify;
+
     await expect(api.app.version()).resolves.toBe('dev');
     process.env.NODE_ENV = originalEnv;
   });
 
   it('app.version prefixes production version', async () => {
     const originalEnv = process.env.NODE_ENV;
     process.env.NODE_ENV = 'production';
+
     invokeMainEvent.mockResolvedValueOnce('1.2.3');
+
     await importPreload();
+
     const api = (window as unknown as { gitify: TestApi }).gitify;
+
     await expect(api.app.version()).resolves.toBe('v1.2.3');
     process.env.NODE_ENV = originalEnv;
   });
 
   it('onSystemThemeUpdate registers listener', async () => {
     await importPreload();
+
     const api = (window as unknown as { gitify: TestApi }).gitify;
     const callback = jest.fn();
     api.onSystemThemeUpdate(callback);
+
     expect(onRendererEvent).toHaveBeenCalledWith(
       EVENTS.UPDATE_THEME,
       expect.any(Function),
     );
+
     // Simulate event
     const listener = onRendererEvent.mock.calls[0][1];
     listener({}, 'dark');
+
     expect(callback).toHaveBeenCalledWith('dark');
   });
 
   it('raiseNativeNotification without url calls app.show', async () => {
     await importPreload();
+
     const api = (window as unknown as { gitify: TestApi }).gitify;
     api.app.show = jest.fn();
+
     const notification = api.raiseNativeNotification(
       'Title',
       'Body',
     ) as MockNotification;
+
     notification.triggerClick();
+
     expect(api.app.show).toHaveBeenCalled();
   });
 
   it('raiseNativeNotification with url hides app then opens link', async () => {
     await importPreload();
+
     const api = (window as unknown as { gitify: TestApi }).gitify;
     api.app.hide = jest.fn();
     api.openExternalLink = jest.fn();
+
     const notification = api.raiseNativeNotification(
       'Title',
       'Body',
       'https://x',
     ) as MockNotification;
+
     notification.triggerClick();
+
     expect(api.app.hide).toHaveBeenCalled();
     expect(api.openExternalLink).toHaveBeenCalledWith('https://x', true);
   });

src/renderer/components/Sidebar.test.tsx

@@ -15,7 +15,7 @@ jest.mock('react-router-dom', () => ({
 
 describe('renderer/components/Sidebar.tsx', () => {
   const mockFetchNotifications = jest.fn();
-  const mockOpenExternalLink = jest
+  const openExternalLinkSpy = jest
     .spyOn(comms, 'openExternalLink')
     .mockImplementation();
 
@@ -61,7 +61,8 @@ describe('renderer/components/Sidebar.tsx', () => {
 
     await userEvent.click(screen.getByTestId('sidebar-home'));
 
-    expect(mockNavigate).toHaveBeenNthCalledWith(1, '/', { replace: true });
+    expect(mockNavigate).toHaveBeenCalledTimes(1);
+    expect(mockNavigate).toHaveBeenCalledWith('/', { replace: true });
   });
 
   describe('notifications icon', () => {
@@ -77,8 +78,8 @@ describe('renderer/components/Sidebar.tsx', () => {
 
       await userEvent.click(screen.getByTestId('sidebar-notifications'));
 
-      expect(mockOpenExternalLink).toHaveBeenCalledTimes(1);
-      expect(mockOpenExternalLink).toHaveBeenCalledWith(
+      expect(openExternalLinkSpy).toHaveBeenCalledTimes(1);
+      expect(openExternalLinkSpy).toHaveBeenCalledWith(
         'https://github.com/notifications',
       );
     });
@@ -125,7 +126,8 @@ describe('renderer/components/Sidebar.tsx', () => {
 
       await userEvent.click(screen.getByTestId('sidebar-filter-notifications'));
 
-      expect(mockNavigate).toHaveBeenNthCalledWith(1, '/filters');
+      expect(mockNavigate).toHaveBeenCalledTimes(1);
+      expect(mockNavigate).toHaveBeenCalledWith('/filters');
     });
 
     it('go to the home if filters path already shown', async () => {
@@ -140,7 +142,8 @@ describe('renderer/components/Sidebar.tsx', () => {
 
       await userEvent.click(screen.getByTestId('sidebar-filter-notifications'));
 
-      expect(mockNavigate).toHaveBeenNthCalledWith(1, '/', { replace: true });
+      expect(mockNavigate).toHaveBeenCalledTimes(1);
+      expect(mockNavigate).toHaveBeenCalledWith('/', { replace: true });
     });
   });
 
@@ -158,8 +161,8 @@ describe('renderer/components/Sidebar.tsx', () => {
 
       await userEvent.click(screen.getByTestId('sidebar-my-issues'));
 
-      expect(mockOpenExternalLink).toHaveBeenCalledTimes(1);
-      expect(mockOpenExternalLink).toHaveBeenCalledWith(
+      expect(openExternalLinkSpy).toHaveBeenCalledTimes(1);
+      expect(openExternalLinkSpy).toHaveBeenCalledWith(
         'https://github.com/issues',
       );
     });
@@ -177,8 +180,8 @@ describe('renderer/components/Sidebar.tsx', () => {
 
       await userEvent.click(screen.getByTestId('sidebar-my-pull-requests'));
 
-      expect(mockOpenExternalLink).toHaveBeenCalledTimes(1);
-      expect(mockOpenExternalLink).toHaveBeenCalledWith(
+      expect(openExternalLinkSpy).toHaveBeenCalledTimes(1);
+      expect(openExternalLinkSpy).toHaveBeenCalledWith(
         'https://github.com/pulls',
       );
     });
@@ -235,7 +238,8 @@ describe('renderer/components/Sidebar.tsx', () => {
 
       await userEvent.click(screen.getByTestId('sidebar-settings'));
 
-      expect(mockNavigate).toHaveBeenNthCalledWith(1, '/settings');
+      expect(mockNavigate).toHaveBeenCalledTimes(1);
+      expect(mockNavigate).toHaveBeenCalledWith('/settings');
     });
 
     it('go to the home if settings path already shown', async () => {
@@ -252,12 +256,13 @@ describe('renderer/components/Sidebar.tsx', () => {
       await userEvent.click(screen.getByTestId('sidebar-settings'));
 
       expect(mockFetchNotifications).toHaveBeenCalledTimes(1);
-      expect(mockNavigate).toHaveBeenNthCalledWith(1, '/', { replace: true });
+      expect(mockNavigate).toHaveBeenCalledTimes(1);
+      expect(mockNavigate).toHaveBeenCalledWith('/', { replace: true });
     });
   });
 
   it('should quit the app', async () => {
-    const mockQuitApp = jest.spyOn(comms, 'quitApp');
+    const quitAppSpy = jest.spyOn(comms, 'quitApp').mockImplementation();
 
     renderWithAppContext(
       <MemoryRouter>
@@ -270,6 +275,6 @@ describe('renderer/components/Sidebar.tsx', () => {
 
     await userEvent.click(screen.getByTestId('sidebar-quit'));
 
-    expect(mockQuitApp).toHaveBeenCalledTimes(1);
+    expect(quitAppSpy).toHaveBeenCalledTimes(1);
   });
 });

src/renderer/components/notifications/AccountNotifications.test.tsx

@@ -113,7 +113,7 @@ describe('renderer/components/notifications/AccountNotifications.tsx', () => {
   });
 
   it('should open profile when clicked', async () => {
-    const mockOpenAccountProfile = jest
+    const openAccountProfileSpy = jest
       .spyOn(links, 'openAccountProfile')
       .mockImplementation();
 
@@ -128,12 +128,12 @@ describe('renderer/components/notifications/AccountNotifications.tsx', () => {
 
     await userEvent.click(screen.getByTestId('account-profile'));
 
-    expect(mockOpenAccountProfile).toHaveBeenCalledTimes(1);
-    expect(mockOpenAccountProfile).toHaveBeenCalledWith(mockGitHubCloudAccount);
+    expect(openAccountProfileSpy).toHaveBeenCalledTimes(1);
+    expect(openAccountProfileSpy).toHaveBeenCalledWith(mockGitHubCloudAccount);
   });
 
   it('should open my issues when clicked', async () => {
-    const mockOpenGitHubIssues = jest
+    const openGitHubIssuesSpy = jest
       .spyOn(links, 'openGitHubIssues')
       .mockImplementation();
 
@@ -148,14 +148,14 @@ describe('renderer/components/notifications/AccountNotifications.tsx', () => {
 
     await userEvent.click(screen.getByTestId('account-issues'));
 
-    expect(mockOpenGitHubIssues).toHaveBeenCalledTimes(1);
-    expect(mockOpenGitHubIssues).toHaveBeenCalledWith(
+    expect(openGitHubIssuesSpy).toHaveBeenCalledTimes(1);
+    expect(openGitHubIssuesSpy).toHaveBeenCalledWith(
       mockGitHubCloudAccount.hostname,
     );
   });
 
   it('should open my pull requests when clicked', async () => {
-    const mockOpenGitHubPulls = jest
+    const openGitHubPullsSpy = jest
       .spyOn(links, 'openGitHubPulls')
       .mockImplementation();
 
@@ -170,8 +170,8 @@ describe('renderer/components/notifications/AccountNotifications.tsx', () => {
 
     await userEvent.click(screen.getByTestId('account-pull-requests'));
 
-    expect(mockOpenGitHubPulls).toHaveBeenCalledTimes(1);
-    expect(mockOpenGitHubPulls).toHaveBeenCalledWith(
+    expect(openGitHubPullsSpy).toHaveBeenCalledTimes(1);
+    expect(openGitHubPullsSpy).toHaveBeenCalledWith(
       mockGitHubCloudAccount.hostname,
     );
   });

src/renderer/components/notifications/NotificationFooter.test.tsx

@@ -10,15 +10,15 @@ import * as comms from '../../utils/comms';
 import { NotificationFooter } from './NotificationFooter';
 
 describe('renderer/components/notifications/NotificationFooter.tsx', () => {
+  jest
+    .spyOn(globalThis.Date, 'now')
+    .mockImplementation(() => new Date('2024').valueOf());
+
   afterEach(() => {
     jest.clearAllMocks();
   });
 
   it('should render itself & its children', async () => {
-    jest
-      .spyOn(globalThis.Date, 'now')
-      .mockImplementation(() => new Date('2024').valueOf());
-
     const props = {
       notification: mockSingleNotification,
     };
@@ -29,10 +29,6 @@ describe('renderer/components/notifications/NotificationFooter.tsx', () => {
   });
 
   it('should render itself & its children when last_read_at is null', async () => {
-    jest
-      .spyOn(globalThis.Date, 'now')
-      .mockImplementation(() => new Date('2024').valueOf());
-
     const mockNotification = mockSingleNotification;
     mockNotification.last_read_at = null;
 
@@ -47,10 +43,6 @@ describe('renderer/components/notifications/NotificationFooter.tsx', () => {
 
   describe('security alerts should use github icon for avatar', () => {
     it('Repository Dependabot Alerts Thread', async () => {
-      jest
-        .spyOn(globalThis.Date, 'now')
-        .mockImplementation(() => new Date('2024').valueOf());
-
       const mockNotification = mockSingleNotification;
       mockNotification.subject.type = 'RepositoryDependabotAlertsThread';
 
@@ -64,10 +56,6 @@ describe('renderer/components/notifications/NotificationFooter.tsx', () => {
     });
 
     it('Repository Vulnerability Alert', async () => {
-      jest
-        .spyOn(globalThis.Date, 'now')
-        .mockImplementation(() => new Date('2024').valueOf());
-
       const mockNotification = mockSingleNotification;
       mockNotification.subject.type = 'RepositoryVulnerabilityAlert';
 
@@ -82,10 +70,6 @@ describe('renderer/components/notifications/NotificationFooter.tsx', () => {
   });
 
   it('should default to known avatar if no user found', async () => {
-    jest
-      .spyOn(globalThis.Date, 'now')
-      .mockImplementation(() => new Date('2024').valueOf());
-
     const mockNotification = mockSingleNotification;
     mockNotification.subject.user = null;
 
@@ -99,7 +83,7 @@ describe('renderer/components/notifications/NotificationFooter.tsx', () => {
   });
 
   it('should open notification user profile', async () => {
-    const mockOpenExternalLink = jest
+    const openExternalLinkSpy = jest
       .spyOn(comms, 'openExternalLink')
       .mockImplementation();
 
@@ -125,8 +109,8 @@ describe('renderer/components/notifications/NotificationFooter.tsx', () => {
 
     await userEvent.click(screen.getByTestId('view-profile'));
 
-    expect(mockOpenExternalLink).toHaveBeenCalledTimes(1);
-    expect(mockOpenExternalLink).toHaveBeenCalledWith(
+    expect(openExternalLinkSpy).toHaveBeenCalledTimes(1);
+    expect(openExternalLinkSpy).toHaveBeenCalledWith(
       props.notification.subject.user.html_url,
     );
   });

src/renderer/components/notifications/NotificationHeader.test.tsx

@@ -71,7 +71,7 @@ describe('renderer/components/notifications/NotificationHeader.tsx', () => {
   });
 
   it('should open notification user profile - group by date', async () => {
-    const mockOpenExternalLink = jest
+    const openExternalLinkSpy = jest
       .spyOn(comms, 'openExternalLink')
       .mockImplementation();
 
@@ -85,8 +85,8 @@ describe('renderer/components/notifications/NotificationHeader.tsx', () => {
 
     await userEvent.click(screen.getByTestId('view-repository'));
 
-    expect(mockOpenExternalLink).toHaveBeenCalledTimes(1);
-    expect(mockOpenExternalLink).toHaveBeenCalledWith(
+    expect(openExternalLinkSpy).toHaveBeenCalledTimes(1);
+    expect(openExternalLinkSpy).toHaveBeenCalledWith(
       props.notification.repository.html_url,
     );
   });