feat(api): implement graphql merge query pattern to reduce api call volume

package.json

@@ -149,4 +149,4 @@
     "*": "biome check --fix --no-errors-on-unmatched",
     "*.{js,ts,tsx}": "pnpm test --findRelatedTests --passWithNoTests --updateSnapshot"
   }
-}
+}

src/renderer/__mocks__/user-mocks.ts

@@ -1,4 +1,5 @@
 import type { GitifyNotificationUser, GitifyUser, Link } from '../types';
+import type { AuthorFieldsFragment } from '../utils/api/graphql/generated/graphql';
 import type { RawUser } from '../utils/api/types';
 
 export const mockGitifyUser: GitifyUser = {
@@ -19,7 +20,7 @@ export function createPartialMockUser(login: string): RawUser {
   return mockUser as RawUser;
 }
 
-export function createMockNotificationUser(
+export function createMockGitifyNotificationUser(
   login: string,
 ): GitifyNotificationUser {
   return {
@@ -29,3 +30,13 @@ export function createMockNotificationUser(
     type: 'User',
   };
 }
+
+/**
+ * Creates a mock author for use in GraphQL response mocks.
+ */
+export function createMockGraphQLAuthor(login: string): AuthorFieldsFragment {
+  return {
+    ...createMockGitifyNotificationUser(login),
+    __typename: 'User',
+  } as AuthorFieldsFragment;
+}

src/renderer/constants.ts

@@ -27,6 +27,16 @@ export const Constants = {
 
   REFRESH_ACCOUNTS_INTERVAL_MS: 60 * 60 * 1000, // 1 hour
 
+  // GraphQL Argument Defaults
+  GRAPHQL_ARGS: {
+    FIRST_LABELS: 100,
+    FIRST_CLOSING_ISSUES: 100,
+    LAST_COMMENTS: 1,
+    LAST_THREADED_COMMENTS: 10,
+    LAST_REPLIES: 10,
+    LAST_REVIEWS: 100,
+  },
+
   // GitHub Docs
   GITHUB_DOCS: {
     OAUTH_URL:

src/renderer/hooks/useNotifications.test.ts

@@ -3,12 +3,8 @@ import { act, renderHook, waitFor } from '@testing-library/react';
 import axios, { AxiosError } from 'axios';
 import nock from 'nock';
 
-import { mockGitHubCloudAccount } from '../__mocks__/account-mocks';
 import { mockAuth, mockSettings, mockState } from '../__mocks__/state-mocks';
-import {
-  mockNotificationUser,
-  mockSingleNotification,
-} from '../utils/api/__mocks__/response-mocks';
+import { mockSingleNotification } from '../utils/api/__mocks__/response-mocks';
 import { Errors } from '../utils/errors';
 import * as logger from '../utils/logger';
 import { useNotifications } from './useNotifications';
@@ -118,204 +114,6 @@ describe('renderer/hooks/useNotifications.ts', () => {
       expect(result.current.notifications[1].notifications.length).toBe(2);
     });
 
-    it('should fetch detailed notifications with success', async () => {
-      const mockRepository = {
-        name: 'notifications-test',
-        full_name: 'gitify-app/notifications-test',
-        html_url: 'https://github.com/gitify-app/notifications-test',
-        owner: {
-          login: 'gitify-app',
-          avatar_url: 'https://avatar.url',
-          type: 'Organization',
-        },
-      };
-
-      const mockNotifications = [
-        {
-          id: '1',
-          unread: true,
-          updated_at: '2024-01-01T00:00:00Z',
-          reason: 'subscribed',
-          subject: {
-            title: 'This is a check suite workflow.',
-            type: 'CheckSuite',
-            url: null,
-            latest_comment_url: null,
-          },
-          repository: mockRepository,
-        },
-        {
-          id: '2',
-          unread: true,
-          updated_at: '2024-02-26T00:00:00Z',
-          reason: 'subscribed',
-          subject: {
-            title: 'This is a Discussion.',
-            type: 'Discussion',
-            url: null,
-            latest_comment_url: null,
-          },
-          repository: mockRepository,
-        },
-        {
-          id: '3',
-          unread: true,
-          updated_at: '2024-01-01T00:00:00Z',
-          reason: 'subscribed',
-          subject: {
-            title: 'This is an Issue.',
-            type: 'Issue',
-            url: 'https://api.github.com/repos/gitify-app/notifications-test/issues/3',
-            latest_comment_url:
-              'https://api.github.com/repos/gitify-app/notifications-test/issues/3/comments',
-          },
-          repository: mockRepository,
-        },
-        {
-          id: '4',
-          unread: true,
-          updated_at: '2024-01-01T00:00:00Z',
-          reason: 'subscribed',
-          subject: {
-            title: 'This is a Pull Request.',
-            type: 'PullRequest',
-            url: 'https://api.github.com/repos/gitify-app/notifications-test/pulls/4',
-            latest_comment_url:
-              'https://api.github.com/repos/gitify-app/notifications-test/issues/4/comments',
-          },
-          repository: mockRepository,
-        },
-        {
-          id: '5',
-          unread: true,
-          updated_at: '2024-01-01T00:00:00Z',
-          reason: 'subscribed',
-          subject: {
-            title: 'This is an invitation.',
-            type: 'RepositoryInvitation',
-            url: null,
-            latest_comment_url: null,
-          },
-          repository: mockRepository,
-        },
-        {
-          id: '6',
-          unread: true,
-          updated_at: '2024-01-01T00:00:00Z',
-          reason: 'subscribed',
-          subject: {
-            title: 'This is a workflow run.',
-            type: 'WorkflowRun',
-            url: null,
-            latest_comment_url: null,
-          },
-          repository: mockRepository,
-        },
-      ];
-
-      nock('https://api.github.com')
-        .get('/notifications?participating=false')
-        .reply(200, mockNotifications);
-
-      nock('https://api.github.com')
-        .post('/graphql')
-        .reply(200, {
-          data: {
-            search: {
-              nodes: [
-                {
-                  title: 'This is a Discussion.',
-                  stateReason: null,
-                  isAnswered: true,
-                  url: 'https://github.com/gitify-app/notifications-test/discussions/612',
-                  author: {
-                    login: 'discussion-creator',
-                    url: 'https://github.com/discussion-creator',
-                    avatar_url:
-                      'https://avatars.githubusercontent.com/u/133795385?s=200&v=4',
-                    type: 'User',
-                  },
-                  comments: {
-                    nodes: [
-                      {
-                        databaseId: 2297637,
-                        createdAt: '2022-03-04T20:39:44Z',
-                        author: {
-                          login: 'comment-user',
-                          url: 'https://github.com/comment-user',
-                          avatar_url:
-                            'https://avatars.githubusercontent.com/u/1?v=4',
-                          type: 'User',
-                        },
-                        replies: {
-                          nodes: [],
-                        },
-                      },
-                    ],
-                  },
-                  labels: null,
-                },
-              ],
-            },
-          },
-        });
-
-      nock('https://api.github.com')
-        .get('/repos/gitify-app/notifications-test/issues/3')
-        .reply(200, {
-          state: 'closed',
-          merged: true,
-          user: mockNotificationUser,
-          labels: [],
-        });
-      nock('https://api.github.com')
-        .get('/repos/gitify-app/notifications-test/issues/3/comments')
-        .reply(200, {
-          user: mockNotificationUser,
-        });
-      nock('https://api.github.com')
-        .get('/repos/gitify-app/notifications-test/pulls/4')
-        .reply(200, {
-          state: 'closed',
-          merged: false,
-          user: mockNotificationUser,
-          labels: [],
-        });
-      nock('https://api.github.com')
-        .get('/repos/gitify-app/notifications-test/pulls/4/reviews')
-        .reply(200, {});
-      nock('https://api.github.com')
-        .get('/repos/gitify-app/notifications-test/issues/4/comments')
-        .reply(200, {
-          user: mockNotificationUser,
-        });
-
-      const { result } = renderHook(() => useNotifications());
-
-      act(() => {
-        result.current.fetchNotifications({
-          auth: {
-            accounts: [mockGitHubCloudAccount],
-          },
-          settings: {
-            ...mockSettings,
-            detailedNotifications: true,
-          },
-        });
-      });
-
-      expect(result.current.status).toBe('loading');
-
-      await waitFor(() => {
-        expect(result.current.status).toBe('success');
-      });
-
-      expect(result.current.notifications[0].account.hostname).toBe(
-        'github.com',
-      );
-      expect(result.current.notifications[0].notifications.length).toBe(6);
-    });
-
     it('should fetch notifications with same failures', async () => {
       const code = AxiosError.ERR_BAD_REQUEST;
       const status = 401;