refactor(handlers): use notification instead of subject

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

Author: setchy

src/renderer/__mocks__/notifications-mocks.ts

@@ -1,10 +1,5 @@
 import type { AccountNotifications, GitifyError } from '../types';
-import type {
-  Notification,
-  StateType,
-  Subject,
-  SubjectType,
-} from '../typesGitHub';
+import type { Notification, StateType, SubjectType } from '../typesGitHub';
 import {
   mockEnterpriseNotifications,
   mockGitHubNotifications,
@@ -36,18 +31,20 @@ export const mockSingleAccountNotifications: AccountNotifications[] = [
   },
 ];
 
-export function createSubjectMock(mocks: {
+export function mockNotificationWithSubject(mocks: {
   title?: string;
   type?: SubjectType;
   state?: StateType;
-}): Subject {
+}): Notification {
   return {
-    title: mocks.title ?? 'Mock Subject',
-    type: mocks.type ?? ('Unknown' as SubjectType),
-    state: mocks.state ?? ('Unknown' as StateType),
-    url: null,
-    latest_comment_url: null,
-  };
+    subject: {
+      title: mocks.title ?? 'Mock Subject',
+      type: mocks.type ?? ('Unknown' as SubjectType),
+      state: mocks.state ?? ('Unknown' as StateType),
+      url: null,
+      latest_comment_url: null,
+    },
+  } as Notification;
 }
 
 export function mockAccountWithError(error: GitifyError): AccountNotifications {
@@ -58,7 +55,7 @@ export function mockAccountWithError(error: GitifyError): AccountNotifications {
   };
 }
 
-export function createMockNotificationForRepoName(
+export function mockNotificationWithRepoName(
   id: string,
   repoFullName: string | null,
 ): Notification {

src/renderer/components/notifications/NotificationRow.tsx

@@ -63,8 +63,8 @@ export const NotificationRow: FC<INotificationRow> = ({
   };
 
   const handler = createNotificationHandler(notification);
-  const NotificationIcon = handler.iconType(notification.subject);
-  const iconColor = handler.iconColor(notification.subject);
+  const NotificationIcon = handler.iconType(notification);
+  const iconColor = handler.iconColor(notification);
   const notificationType = handler.formattedNotificationType(notification);
   const notificationNumber = handler.formattedNotificationNumber(notification);
   const notificationTitle = handler.formattedNotificationTitle(notification);

src/renderer/utils/notifications/group.test.ts

@@ -1,4 +1,4 @@
-import { createMockNotificationForRepoName } from '../../__mocks__/notifications-mocks';
+import { mockNotificationWithRepoName } from '../../__mocks__/notifications-mocks';
 import { mockSettings } from '../../__mocks__/state-mocks';
 import { GroupBy } from '../../types';
 import type { Notification } from '../../typesGitHub';
@@ -24,9 +24,9 @@ describe('renderer/utils/notifications/group.ts', () => {
   describe('groupNotificationsByRepository', () => {
     it('groups notifications by repository full_name', () => {
       const notifications: Notification[] = [
-        createMockNotificationForRepoName('1', 'owner/repo-a'),
-        createMockNotificationForRepoName('2', 'owner/repo-b'),
-        createMockNotificationForRepoName('3', 'owner/repo-a'),
+        mockNotificationWithRepoName('1', 'owner/repo-a'),
+        mockNotificationWithRepoName('2', 'owner/repo-b'),
+        mockNotificationWithRepoName('3', 'owner/repo-a'),
       ];
 
       const result = groupNotificationsByRepository(notifications);
@@ -38,10 +38,10 @@ describe('renderer/utils/notifications/group.ts', () => {
 
     it('preserves first-seen repository order', () => {
       const notifications: Notification[] = [
-        createMockNotificationForRepoName('1', 'owner/repo-c'),
-        createMockNotificationForRepoName('2', 'owner/repo-a'),
-        createMockNotificationForRepoName('3', 'owner/repo-b'),
-        createMockNotificationForRepoName('4', 'owner/repo-a'),
+        mockNotificationWithRepoName('1', 'owner/repo-c'),
+        mockNotificationWithRepoName('2', 'owner/repo-a'),
+        mockNotificationWithRepoName('3', 'owner/repo-b'),
+        mockNotificationWithRepoName('4', 'owner/repo-a'),
       ];
 
       const result = groupNotificationsByRepository(notifications);
@@ -52,9 +52,9 @@ describe('renderer/utils/notifications/group.ts', () => {
 
     it('skips notifications without repository data', () => {
       const notifications: Notification[] = [
-        createMockNotificationForRepoName('1', 'owner/repo-a'),
-        createMockNotificationForRepoName('2', null),
-        createMockNotificationForRepoName('3', 'owner/repo-a'),
+        mockNotificationWithRepoName('1', 'owner/repo-a'),
+        mockNotificationWithRepoName('2', null),
+        mockNotificationWithRepoName('3', 'owner/repo-a'),
       ];
 
       const result = groupNotificationsByRepository(notifications);
@@ -73,8 +73,8 @@ describe('renderer/utils/notifications/group.ts', () => {
 
     it('returns empty map when all notifications lack repository data', () => {
       const notifications: Notification[] = [
-        createMockNotificationForRepoName('1', null),
-        createMockNotificationForRepoName('2', null),
+        mockNotificationWithRepoName('1', null),
+        mockNotificationWithRepoName('2', null),
       ];
 
       const result = groupNotificationsByRepository(notifications);
@@ -87,10 +87,10 @@ describe('renderer/utils/notifications/group.ts', () => {
     it('returns repository-grouped order when groupBy is REPOSITORY', () => {
       const settings = { ...mockSettings, groupBy: GroupBy.REPOSITORY };
       const notifications: Notification[] = [
-        createMockNotificationForRepoName('1', 'owner/repo-b'),
-        createMockNotificationForRepoName('2', 'owner/repo-a'),
-        createMockNotificationForRepoName('3', 'owner/repo-b'),
-        createMockNotificationForRepoName('4', 'owner/repo-a'),
+        mockNotificationWithRepoName('1', 'owner/repo-b'),
+        mockNotificationWithRepoName('2', 'owner/repo-a'),
+        mockNotificationWithRepoName('3', 'owner/repo-b'),
+        mockNotificationWithRepoName('4', 'owner/repo-a'),
       ];
 
       const result = getFlattenedNotificationsByRepo(notifications, settings);
@@ -102,9 +102,9 @@ describe('renderer/utils/notifications/group.ts', () => {
     it('returns natural account order when groupBy is DATE', () => {
       const settings = { ...mockSettings, groupBy: GroupBy.DATE };
       const notifications: Notification[] = [
-        createMockNotificationForRepoName('1', 'owner/repo-b'),
-        createMockNotificationForRepoName('2', 'owner/repo-a'),
-        createMockNotificationForRepoName('3', 'owner/repo-b'),
+        mockNotificationWithRepoName('1', 'owner/repo-b'),
+        mockNotificationWithRepoName('2', 'owner/repo-a'),
+        mockNotificationWithRepoName('3', 'owner/repo-b'),
       ];
 
       const result = getFlattenedNotificationsByRepo(notifications, settings);
@@ -125,9 +125,9 @@ describe('renderer/utils/notifications/group.ts', () => {
     it('handles notifications without repository data when grouped', () => {
       const settings = { ...mockSettings, groupBy: GroupBy.REPOSITORY };
       const notifications: Notification[] = [
-        createMockNotificationForRepoName('1', 'owner/repo-a'),
-        createMockNotificationForRepoName('2', null),
-        createMockNotificationForRepoName('3', 'owner/repo-a'),
+        mockNotificationWithRepoName('1', 'owner/repo-a'),
+        mockNotificationWithRepoName('2', null),
+        mockNotificationWithRepoName('3', 'owner/repo-a'),
       ];
 
       const result = getFlattenedNotificationsByRepo(notifications, settings);
@@ -139,9 +139,9 @@ describe('renderer/utils/notifications/group.ts', () => {
     it('preserves notifications without repository data when not grouped', () => {
       const settings = { ...mockSettings, groupBy: GroupBy.DATE };
       const notifications: Notification[] = [
-        createMockNotificationForRepoName('1', 'owner/repo-a'),
-        createMockNotificationForRepoName('2', null),
-        createMockNotificationForRepoName('3', 'owner/repo-a'),
+        mockNotificationWithRepoName('1', 'owner/repo-a'),
+        mockNotificationWithRepoName('2', null),
+        mockNotificationWithRepoName('3', 'owner/repo-a'),
       ];
 
       const result = getFlattenedNotificationsByRepo(notifications, settings);

src/renderer/utils/notifications/handlers/checkSuite.test.ts

@@ -1,4 +1,4 @@
-import { createSubjectMock } from '../../../__mocks__/notifications-mocks';
+import { mockNotificationWithSubject } from '../../../__mocks__/notifications-mocks';
 import { partialMockNotification } from '../../../__mocks__/partial-mocks';
 import { mockSettings } from '../../../__mocks__/state-mocks';
 import { checkSuiteHandler, getCheckSuiteAttributes } from './checkSuite';
@@ -139,13 +139,13 @@ describe('renderer/utils/notifications/handlers/checkSuite.ts', () => {
   it('iconType', () => {
     expect(
       checkSuiteHandler.iconType(
-        createSubjectMock({ type: 'CheckSuite', state: null }),
+        mockNotificationWithSubject({ type: 'CheckSuite', state: null }),
       ).displayName,
     ).toBe('RocketIcon');
 
     expect(
       checkSuiteHandler.iconType(
-        createSubjectMock({
+        mockNotificationWithSubject({
           type: 'CheckSuite',
           state: 'cancelled',
         }),
@@ -154,7 +154,7 @@ describe('renderer/utils/notifications/handlers/checkSuite.ts', () => {
 
     expect(
       checkSuiteHandler.iconType(
-        createSubjectMock({
+        mockNotificationWithSubject({
           type: 'CheckSuite',
           state: 'failure',
         }),
@@ -163,7 +163,7 @@ describe('renderer/utils/notifications/handlers/checkSuite.ts', () => {
 
     expect(
       checkSuiteHandler.iconType(
-        createSubjectMock({
+        mockNotificationWithSubject({
           type: 'CheckSuite',
           state: 'skipped',
         }),
@@ -172,7 +172,7 @@ describe('renderer/utils/notifications/handlers/checkSuite.ts', () => {
 
     expect(
       checkSuiteHandler.iconType(
-        createSubjectMock({
+        mockNotificationWithSubject({
           type: 'CheckSuite',
           state: 'success',
         }),

src/renderer/utils/notifications/handlers/checkSuite.ts

@@ -15,7 +15,6 @@ import type {
   CheckSuiteStatus,
   GitifySubject,
   Notification,
-  Subject,
 } from '../../../typesGitHub';
 import { DefaultHandler } from './default';
 
@@ -38,8 +37,8 @@ class CheckSuiteHandler extends DefaultHandler {
     return null;
   }
 
-  iconType(subject: Subject): FC<OcticonProps> | null {
-    switch (subject.state) {
+  iconType(notification: Notification): FC<OcticonProps> | null {
+    switch (notification.subject.state) {
       case 'cancelled':
         return StopIcon;
       case 'failure':

src/renderer/utils/notifications/handlers/commit.test.ts

@@ -1,7 +1,7 @@
 import axios from 'axios';
 import nock from 'nock';
 
-import { createSubjectMock } from '../../../__mocks__/notifications-mocks';
+import { mockNotificationWithSubject } from '../../../__mocks__/notifications-mocks';
 import {
   partialMockNotification,
   partialMockUser,
@@ -99,7 +99,8 @@ describe('renderer/utils/notifications/handlers/commit.ts', () => {
 
   it('iconType', () => {
     expect(
-      commitHandler.iconType(createSubjectMock({ type: 'Commit' })).displayName,
+      commitHandler.iconType(mockNotificationWithSubject({ type: 'Commit' }))
+        .displayName,
     ).toBe('GitCommitIcon');
   });
 });

src/renderer/utils/notifications/handlers/commit.ts

@@ -8,7 +8,6 @@ import type {
   GitifySubject,
   Notification,
   StateType,
-  Subject,
   User,
 } from '../../../typesGitHub';
 import { getCommit, getCommitComment } from '../../api/client';
@@ -55,7 +54,7 @@ class CommitHandler extends DefaultHandler {
     };
   }
 
-  iconType(_subject: Subject): FC<OcticonProps> | null {
+  iconType(_notification: Notification): FC<OcticonProps> | null {
     return GitCommitIcon;
   }
 }

src/renderer/utils/notifications/handlers/default.test.ts

@@ -1,4 +1,4 @@
-import { createSubjectMock } from '../../../__mocks__/notifications-mocks';
+import { mockNotificationWithSubject } from '../../../__mocks__/notifications-mocks';
 import { partialMockNotification } from '../../../__mocks__/partial-mocks';
 import { mockSettings } from '../../../__mocks__/state-mocks';
 import { IconColor } from '../../../types';
@@ -24,9 +24,9 @@ describe('renderer/utils/notifications/handlers/default.ts', () => {
   });
 
   it('iconType', () => {
-    expect(defaultHandler.iconType(createSubjectMock({})).displayName).toBe(
-      'QuestionIcon',
-    );
+    expect(
+      defaultHandler.iconType(mockNotificationWithSubject({})).displayName,
+    ).toBe('QuestionIcon');
   });
 
   describe('iconColor', () => {
@@ -50,7 +50,7 @@ describe('renderer/utils/notifications/handlers/default.ts', () => {
     ];
 
     it.each(cases)('returns correct color for state %s', (state, expected) => {
-      const subject = createSubjectMock({ state });
+      const subject = mockNotificationWithSubject({ state });
       expect(defaultHandler.iconColor(subject)).toBe(expected);
     });
   });

src/renderer/utils/notifications/handlers/default.ts

@@ -8,7 +8,6 @@ import { IconColor } from '../../../types';
 import type {
   GitifySubject,
   Notification,
-  Subject,
   SubjectType,
 } from '../../../typesGitHub';
 import type { NotificationTypeHandler } from './types';
@@ -24,12 +23,12 @@ export class DefaultHandler implements NotificationTypeHandler {
     return null;
   }
 
-  iconType(_subject: Subject): FC<OcticonProps> | null {
+  iconType(_notification: Notification): FC<OcticonProps> | null {
     return QuestionIcon;
   }
 
-  iconColor(subject: Subject): IconColor {
-    switch (subject.state) {
+  iconColor(notification: Notification): IconColor {
+    switch (notification.subject.state) {
       case 'open':
       case 'reopened':
       case 'ANSWERED':

src/renderer/utils/notifications/handlers/discussion.test.ts

@@ -1,7 +1,7 @@
 import axios from 'axios';
 import nock from 'nock';
 
-import { createSubjectMock } from '../../../__mocks__/notifications-mocks';
+import { mockNotificationWithSubject } from '../../../__mocks__/notifications-mocks';
 import { partialMockNotification } from '../../../__mocks__/partial-mocks';
 import { mockSettings } from '../../../__mocks__/state-mocks';
 import type { Link } from '../../../types';
@@ -281,25 +281,26 @@ describe('renderer/utils/notifications/handlers/discussion.ts', () => {
 
   it('iconType', () => {
     expect(
-      discussionHandler.iconType(createSubjectMock({ type: 'Discussion' }))
-        .displayName,
+      discussionHandler.iconType(
+        mockNotificationWithSubject({ type: 'Discussion' }),
+      ).displayName,
     ).toBe('CommentDiscussionIcon');
 
     expect(
       discussionHandler.iconType(
-        createSubjectMock({ type: 'Discussion', state: 'DUPLICATE' }),
+        mockNotificationWithSubject({ type: 'Discussion', state: 'DUPLICATE' }),
       ).displayName,
     ).toBe('DiscussionDuplicateIcon');
 
     expect(
       discussionHandler.iconType(
-        createSubjectMock({ type: 'Discussion', state: 'OUTDATED' }),
+        mockNotificationWithSubject({ type: 'Discussion', state: 'OUTDATED' }),
       ).displayName,
     ).toBe('DiscussionOutdatedIcon');
 
     expect(
       discussionHandler.iconType(
-        createSubjectMock({ type: 'Discussion', state: 'RESOLVED' }),
+        mockNotificationWithSubject({ type: 'Discussion', state: 'RESOLVED' }),
       ).displayName,
     ).toBe('DiscussionClosedIcon');
   });