feat(api): use conditional requests and fetch all inbox notifications (#1414)

* feat: conditional request

* feat: conditional request

* feat: conditional request

* feat: conditional request

* rename util fn

* Merge branch 'main' into feature/conditional-request

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

* feat: fetch all records

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

* feat: add notification setting to control fetching all

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

* feat: add notification setting to control fetching all

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

* Update src/components/settings/NotificationSettings.tsx

Co-authored-by: Afonso Jorge Ramos <[email protected]>

* Update src/components/settings/NotificationSettings.tsx

Co-authored-by: Afonso Jorge Ramos <[email protected]>

---------

Signed-off-by: Adam Setch <[email protected]>
Co-authored-by: Afonso Jorge Ramos <[email protected]>

Author: setchy

src/__mocks__/state-mocks.ts

@@ -85,6 +85,7 @@ const mockAppearanceSettings = {
 
 const mockNotificationSettings = {
   groupBy: GroupBy.REPOSITORY,
+  fetchAllNotifications: true,
   participating: false,
   markAsDoneOnOpen: false,
   markAsDoneOnUnsubscribe: false,

src/components/settings/NotificationSettings.test.tsx

@@ -34,6 +34,32 @@ describe('routes/components/settings/NotificationSettings.tsx', () => {
     expect(updateSetting).toHaveBeenCalledTimes(1);
     expect(updateSetting).toHaveBeenCalledWith('groupBy', 'DATE');
   });
+
+  it('should toggle the fetchAllNotifications checkbox', async () => {
+    await act(async () => {
+      render(
+        <AppContext.Provider
+          value={{
+            auth: mockAuth,
+            settings: mockSettings,
+            updateSetting,
+          }}
+        >
+          <MemoryRouter>
+            <NotificationSettings />
+          </MemoryRouter>
+        </AppContext.Provider>,
+      );
+    });
+
+    fireEvent.click(screen.getByLabelText('Fetch all notifications'), {
+      target: { checked: true },
+    });
+
+    expect(updateSetting).toHaveBeenCalledTimes(1);
+    expect(updateSetting).toHaveBeenCalledWith('fetchAllNotifications', false);
+  });
+
   it('should toggle the showOnlyParticipating checkbox', async () => {
     await act(async () => {
       render(

src/components/settings/NotificationSettings.tsx

@@ -25,6 +25,26 @@ export const NotificationSettings: FC = () => {
           updateSetting('groupBy', evt.target.value as GroupBy);
         }}
       />
+      <Checkbox
+        name="fetchAllNotifications"
+        label="Fetch all notifications"
+        checked={settings.fetchAllNotifications}
+        onChange={(evt) =>
+          updateSetting('fetchAllNotifications', evt.target.checked)
+        }
+        tooltip={
+          <div>
+            <div className="pb-3">
+              When <em>checked</em>, Gitify will fetch <strong>all</strong>{' '}
+              notifications from your inbox.
+            </div>
+            <div>
+              When <em>unchecked</em>, Gitify will only fetch the first page of
+              notifications (max 50 records per GitHub account)
+            </div>
+          </div>
+        }
+      />
       <Checkbox
         name="showOnlyParticipating"
         label="Show only participating"

src/context/App.tsx

@@ -66,6 +66,7 @@ const defaultAppearanceSettings = {
 
 const defaultNotificationSettings = {
   groupBy: GroupBy.REPOSITORY,
+  fetchAllNotifications: true,
   participating: false,
   markAsDoneOnOpen: false,
   markAsDoneOnUnsubscribe: false,

src/hooks/useNotifications.test.ts

@@ -298,7 +298,7 @@ describe('hooks/useNotifications.ts', () => {
       });
 
       expect(result.current.globalError).toBe(Errors.BAD_CREDENTIALS);
-      expect(logErrorSpy).toHaveBeenCalledTimes(2);
+      expect(logErrorSpy).toHaveBeenCalledTimes(4);
     });
 
     it('should fetch notifications with different failures', async () => {
@@ -341,7 +341,7 @@ describe('hooks/useNotifications.ts', () => {
       });
 
       expect(result.current.globalError).toBeNull();
-      expect(logErrorSpy).toHaveBeenCalledTimes(2);
+      expect(logErrorSpy).toHaveBeenCalledTimes(4);
     });
   });
 

src/routes/__snapshots__/Settings.test.tsx.snap

@@ -76,6 +76,7 @@ interface AppearanceSettingsState {
 
 interface NotificationSettingsState {
   groupBy: GroupBy;
+  fetchAllNotifications: boolean;
   participating: boolean;
   markAsDoneOnOpen: boolean;
   markAsDoneOnUnsubscribe: boolean;

src/types.ts

@@ -83,11 +83,32 @@ describe('utils/api/client.ts', () => {
   });
 
   describe('listNotificationsForAuthenticatedUser', () => {
-    const mockSettings: Partial<SettingsState> = {
-      participating: true,
-    };
+    it('should list notifications for user - github cloud - fetchAllNotifications true', async () => {
+      const mockSettings: Partial<SettingsState> = {
+        participating: true,
+        fetchAllNotifications: true,
+      };
+
+      await listNotificationsForAuthenticatedUser(
+        mockGitHubCloudAccount,
+        mockSettings as SettingsState,
+      );
+
+      expect(axios).toHaveBeenCalledWith({
+        url: 'https://api.github.com/notifications?participating=true',
+        method: 'GET',
+        data: {},
+      });
+
+      expect(axios.defaults.headers.common).toMatchSnapshot();
+    });
+
+    it('should list notifications for user - github cloud - fetchAllNotifications false', async () => {
+      const mockSettings: Partial<SettingsState> = {
+        participating: true,
+        fetchAllNotifications: false,
+      };
 
-    it('should list notifications for user - github cloud', async () => {
       await listNotificationsForAuthenticatedUser(
         mockGitHubCloudAccount,
         mockSettings as SettingsState,
@@ -103,6 +124,10 @@ describe('utils/api/client.ts', () => {
     });
 
     it('should list notifications for user - github enterprise server', async () => {
+      const mockSettings: Partial<SettingsState> = {
+        participating: true,
+      };
+
       await listNotificationsForAuthenticatedUser(
         mockGitHubEnterpriseServerAccount,
         mockSettings as SettingsState,

src/utils/api/__snapshots__/client.test.ts.snap

@@ -69,8 +69,13 @@ export function listNotificationsForAuthenticatedUser(
   const url = getGitHubAPIBaseUrl(account.hostname);
   url.pathname += 'notifications';
   url.searchParams.append('participating', String(settings.participating));
-
-  return apiRequestAuth(url.toString() as Link, 'GET', account.token);
+  return apiRequestAuth(
+    url.toString() as Link,
+    'GET',
+    account.token,
+    {},
+    settings.fetchAllNotifications,
+  );
 }
 
 /**