simplify state filtering

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

Author: setchy

src/renderer/utils/notifications/filters/state.test.ts

@@ -1,3 +1,4 @@
+import type { FilterStateType, GitifyNotificationState } from '../../../types';
 import type { Notification } from '../../../typesGitHub';
 import { stateFilter } from './state';
 
@@ -6,56 +7,52 @@ describe('renderer/utils/notifications/filters/state.ts', () => {
     jest.clearAllMocks();
   });
 
-  it('can filter by notification states', () => {
-    const mockPartialNotification = {
-      subject: {
-        state: 'OPEN',
-      },
+  describe('can filter by notification states', () => {
+    const mockNotification = {
+      subject: { state: 'OPEN' },
     } as Partial<Notification> as Notification;
 
-    // Open states
-    mockPartialNotification.subject.state = 'OPEN';
-    expect(
-      stateFilter.filterNotification(mockPartialNotification, 'open'),
-    ).toBe(true);
-
-    mockPartialNotification.subject.state = 'REOPENED';
-    expect(
-      stateFilter.filterNotification(mockPartialNotification, 'open'),
-    ).toBe(true);
-
-    // Closed states
-    mockPartialNotification.subject.state = 'CLOSED';
-    expect(
-      stateFilter.filterNotification(mockPartialNotification, 'closed'),
-    ).toBe(true);
-
-    mockPartialNotification.subject.state = 'COMPLETED';
-    expect(
-      stateFilter.filterNotification(mockPartialNotification, 'closed'),
-    ).toBe(true);
-
-    mockPartialNotification.subject.state = 'NOT_PLANNED';
-    expect(
-      stateFilter.filterNotification(mockPartialNotification, 'closed'),
-    ).toBe(true);
-
-    // Merged states
-    mockPartialNotification.subject.state = 'MERGED';
-    expect(
-      stateFilter.filterNotification(mockPartialNotification, 'merged'),
-    ).toBe(true);
-
-    // Draft states
-    mockPartialNotification.subject.state = 'DRAFT';
-    expect(
-      stateFilter.filterNotification(mockPartialNotification, 'draft'),
-    ).toBe(true);
-
-    // Other states
-    mockPartialNotification.subject.state = 'OUTDATED';
-    expect(
-      stateFilter.filterNotification(mockPartialNotification, 'other'),
-    ).toBe(true);
+    const cases = {
+      OPEN: 'open',
+      REOPENED: 'open',
+
+      CLOSED: 'closed',
+      COMPLETED: 'closed',
+      DUPLICATE: 'closed',
+      NOT_PLANNED: 'closed',
+      RESOLVED: 'closed',
+
+      MERGED: 'merged',
+      DRAFT: 'draft',
+
+      // Discussion-specific
+      ANSWERED: 'other',
+      OUTDATED: 'other',
+
+      // Check suite / workflow states
+      ACTION_REQUIRED: 'other',
+      CANCELLED: 'other',
+      FAILURE: 'other',
+      IN_PROGRESS: 'other',
+      PENDING: 'other',
+      QUEUED: 'other',
+      REQUESTED: 'other',
+      SKIPPED: 'other',
+      STALE: 'other',
+      SUCCESS: 'other',
+      TIMED_OUT: 'other',
+      WAITING: 'other',
+    } satisfies Record<GitifyNotificationState, FilterStateType>;
+
+    it.each(
+      Object.entries(cases) as Array<
+        [GitifyNotificationState, FilterStateType]
+      >,
+    )('filter notification with state %s as %s', (notificationState, expectedFilter) => {
+      mockNotification.subject.state = notificationState;
+      expect(
+        stateFilter.filterNotification(mockNotification, expectedFilter),
+      ).toBe(true);
+    });
   });
 });

src/renderer/utils/notifications/filters/state.ts

@@ -21,7 +21,7 @@ const STATE_TYPE_DETAILS: Record<FilterStateType, TypeDetails> = {
   },
   closed: {
     title: 'Closed',
-    description: 'Closed, completed or not planned',
+    description: 'Closed, completed, duplicate, resolved or not planned',
   },
   other: {
     title: 'Other',
@@ -64,32 +64,29 @@ export const stateFilter: Filter<FilterStateType> = {
     notification: Notification,
     stateType: FilterStateType,
   ): boolean {
-    const allOpenStates: GitifyNotificationState[] = ['OPEN', 'REOPENED'];
-    const allClosedStates: GitifyNotificationState[] = [
-      'CLOSED',
-      'COMPLETED',
-      'NOT_PLANNED',
-    ];
-    const allMergedStates: GitifyNotificationState[] = ['MERGED'];
-    const allDraftStates: GitifyNotificationState[] = ['DRAFT'];
-    const allFilterableStates = [
-      ...allOpenStates,
-      ...allClosedStates,
-      ...allMergedStates,
-      ...allDraftStates,
-    ];
-
-    switch (stateType) {
-      case 'open':
-        return allOpenStates.includes(notification.subject?.state);
-      case 'closed':
-        return allClosedStates.includes(notification.subject?.state);
-      case 'merged':
-        return allMergedStates.includes(notification.subject?.state);
-      case 'draft':
-        return allDraftStates.includes(notification.subject?.state);
-      default:
-        return !allFilterableStates.includes(notification.subject?.state);
-    }
+    const mapped = mapStateToFilter(notification.subject?.state);
+    return stateType === mapped;
   },
 };
+
+function mapStateToFilter(
+  state: GitifyNotificationState | null | undefined,
+): FilterStateType {
+  switch (state) {
+    case 'OPEN':
+    case 'REOPENED':
+      return 'open';
+    case 'CLOSED':
+    case 'COMPLETED':
+    case 'DUPLICATE':
+    case 'NOT_PLANNED':
+    case 'RESOLVED':
+      return 'closed';
+    case 'MERGED':
+      return 'merged';
+    case 'DRAFT':
+      return 'draft';
+    default:
+      return 'other';
+  }
+}

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

@@ -11,28 +11,26 @@ import { releaseHandler } from './release';
 import { repositoryDependabotAlertsThreadHandler } from './repositoryDependabotAlertsThread';
 import { repositoryInvitationHandler } from './repositoryInvitation';
 import { repositoryVulnerabilityAlertHandler } from './repositoryVulnerabilityAlert';
+import type { NotificationTypeHandler } from './types';
 import { workflowRunHandler } from './workflowRun';
 
 describe('renderer/utils/notifications/handlers/index.ts', () => {
   describe('createNotificationHandler', () => {
-    const cases: Array<[SubjectType, object]> = [
-      ['CheckSuite', checkSuiteHandler],
-      ['Commit', commitHandler],
-      ['Discussion', discussionHandler],
-      ['Issue', issueHandler],
-      ['PullRequest', pullRequestHandler],
-      ['Release', releaseHandler],
-      [
-        'RepositoryDependabotAlertsThread',
-        repositoryDependabotAlertsThreadHandler,
-      ],
-      ['RepositoryInvitation', repositoryInvitationHandler],
-      ['RepositoryVulnerabilityAlert', repositoryVulnerabilityAlertHandler],
-      ['WorkflowRun', workflowRunHandler],
-    ];
+    const cases = {
+      CheckSuite: checkSuiteHandler,
+      Commit: commitHandler,
+      Discussion: discussionHandler,
+      Issue: issueHandler,
+      PullRequest: pullRequestHandler,
+      Release: releaseHandler,
+      RepositoryDependabotAlertsThread: repositoryDependabotAlertsThreadHandler,
+      RepositoryInvitation: repositoryInvitationHandler,
+      RepositoryVulnerabilityAlert: repositoryVulnerabilityAlertHandler,
+      WorkflowRun: workflowRunHandler,
+    } satisfies Record<SubjectType, NotificationTypeHandler>;
 
     it.each(
-      cases,
+      Object.entries(cases) as Array<[SubjectType, NotificationTypeHandler]>,
     )('returns expected handler instance for %s', (type, expected) => {
       const notification = createPartialMockNotification({ type });
       const handler = createNotificationHandler(notification);