feat(filter): avoid further enrichment if state not visible

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

Author: setchy

src/renderer/utils/subject.test.ts

@@ -239,6 +239,22 @@ describe('renderer/utils/subject.ts', () => {
           },
         });
       });
+
+      it('return early if commit state filtered', async () => {
+        const mockNotification = partialMockNotification({
+          title: 'This is a commit with comments',
+          type: 'Commit',
+          url: 'https://api.github.com/repos/gitify-app/notifications-test/commits/d2a86d80e3d24ea9510d5de6c147e53c30f313a8' as Link,
+          latest_comment_url: null,
+        });
+
+        const result = await getGitifySubjectDetails(mockNotification, {
+          ...mockSettings,
+          filterStates: ['closed'],
+        });
+
+        expect(result).toEqual(null);
+      });
     });
 
     describe('Discussions', () => {
@@ -1270,6 +1286,23 @@ describe('renderer/utils/subject.ts', () => {
           },
         });
       });
+
+      it('return early if release state filtered', async () => {
+        const mockNotification = partialMockNotification({
+          title: 'This is a mock release',
+          type: 'Release',
+          url: 'https://api.github.com/repos/gitify-app/notifications-test/releases/1' as Link,
+          latest_comment_url:
+            'https://api.github.com/repos/gitify-app/notifications-test/releases/1' as Link,
+        });
+
+        const result = await getGitifySubjectDetails(mockNotification, {
+          ...mockSettings,
+          filterStates: ['closed'],
+        });
+
+        expect(result).toEqual(null);
+      });
     });
 
     describe('WorkflowRuns - GitHub Actions', () => {

src/renderer/utils/subject.ts

@@ -11,6 +11,7 @@ import type {
   PullRequest,
   PullRequestReview,
   PullRequestStateType,
+  StateType,
   SubjectUser,
   User,
   WorkflowRunAttributes,
@@ -36,15 +37,15 @@ export async function getGitifySubjectDetails(
       case 'CheckSuite':
         return getGitifySubjectForCheckSuite(notification);
       case 'Commit':
-        return getGitifySubjectForCommit(notification);
+        return getGitifySubjectForCommit(notification, settings);
       case 'Discussion':
         return await getGitifySubjectForDiscussion(notification, settings);
       case 'Issue':
         return await getGitifySubjectForIssue(notification, settings);
       case 'PullRequest':
         return await getGitifySubjectForPullRequest(notification, settings);
       case 'Release':
-        return await getGitifySubjectForRelease(notification);
+        return await getGitifySubjectForRelease(notification, settings);
       case 'WorkflowRun':
         return getGitifySubjectForWorkflowRun(notification);
       default:
@@ -122,8 +123,15 @@ function getGitifySubjectForCheckSuite(
 
 async function getGitifySubjectForCommit(
   notification: Notification,
+  settings: SettingsState,
 ): Promise<GitifySubject> {
   let user: User;
+  const commitState: StateType = null; // Commit notifications are stateless
+
+  // Return early if this notification would be hidden by filters
+  if (isStateFilteredOut(commitState, settings)) {
+    return null;
+  }
 
   if (notification.subject.latest_comment_url) {
     const commitComment = (
@@ -143,7 +151,7 @@ async function getGitifySubjectForCommit(
   }
 
   return {
-    state: null,
+    state: commitState,
     user: getSubjectUser([user]),
   };
 }
@@ -373,13 +381,21 @@ export function parseLinkedIssuesFromPr(pr: PullRequest): string[] {
 
 async function getGitifySubjectForRelease(
   notification: Notification,
+  settings: SettingsState,
 ): Promise<GitifySubject> {
+  const releaseState: StateType = null; // Release notifications are stateless
+
+  // Return early if this notification would be hidden by filters
+  if (isStateFilteredOut(releaseState, settings)) {
+    return null;
+  }
+
   const release = (
     await getRelease(notification.subject.url, notification.account.token)
   ).data;
 
   return {
-    state: null,
+    state: releaseState,
     user: getSubjectUser([release.author]),
   };
 }