refactor(state): update state storage (#1150)

gitify-app · May 28, 2024 · b18584b · b18584b
1 parent c5e7aa3
commit b18584b
Show file tree

Hide file tree

Showing 16 changed files with 182 additions and 181 deletions.
diff --git a/src/__mocks__/state-mocks.ts b/src/__mocks__/state-mocks.ts
@@ -19,7 +19,7 @@ export const mockUser: GitifyUser = {
   id: 123456789,
 };
 
-export const mockAccounts: AuthState = {
+export const mockAuth: AuthState = {
   token: 'token-123-456',
   enterpriseAccounts: mockEnterpriseAccounts,
   user: mockUser,

diff --git a/src/components/NotificationRow.test.tsx b/src/components/NotificationRow.test.tsx
@@ -1,6 +1,6 @@
 import { fireEvent, render, screen } from '@testing-library/react';
 import { shell } from 'electron';
-import { mockAccounts, mockSettings } from '../__mocks__/state-mocks';
+import { mockAuth, mockSettings } from '../__mocks__/state-mocks';
 import { AppContext } from '../context/App';
 import type { UserType } from '../typesGitHub';
 import { mockSingleNotification } from '../utils/api/__mocks__/response-mocks';
@@ -131,7 +131,7 @@ describe('components/NotificationRow.tsx', () => {
           value={{
             settings: { ...mockSettings, markAsDoneOnOpen: false },
             removeNotificationFromState,
-            accounts: mockAccounts,
+            auth: mockAuth,
           }}
         >
           <NotificationRow {...props} />
@@ -156,7 +156,7 @@ describe('components/NotificationRow.tsx', () => {
           value={{
             settings: { ...mockSettings, markAsDoneOnOpen: false },
             removeNotificationFromState,
-            accounts: mockAccounts,
+            auth: mockAuth,
           }}
         >
           <NotificationRow {...props} />
@@ -181,7 +181,7 @@ describe('components/NotificationRow.tsx', () => {
           value={{
             settings: { ...mockSettings, markAsDoneOnOpen: true },
             markNotificationDone,
-            accounts: mockAccounts,
+            auth: mockAuth,
           }}
         >
           <NotificationRow {...props} />
@@ -205,7 +205,7 @@ describe('components/NotificationRow.tsx', () => {
         <AppContext.Provider
           value={{
             settings: { ...mockSettings, markAsDoneOnOpen: false },
-            accounts: mockAccounts,
+            auth: mockAuth,
           }}
         >
           <AppContext.Provider value={{ markNotificationRead }}>
@@ -230,7 +230,7 @@ describe('components/NotificationRow.tsx', () => {
         <AppContext.Provider
           value={{
             settings: { ...mockSettings },
-            accounts: mockAccounts,
+            auth: mockAuth,
           }}
         >
           <AppContext.Provider value={{ markNotificationDone }}>
@@ -285,7 +285,7 @@ describe('components/NotificationRow.tsx', () => {
         <AppContext.Provider
           value={{
             settings: { ...mockSettings },
-            accounts: mockAccounts,
+            auth: mockAuth,
           }}
         >
           <NotificationRow {...props} />

diff --git a/src/components/NotificationRow.tsx b/src/components/NotificationRow.tsx
@@ -37,7 +37,7 @@ interface IProps {
 export const NotificationRow: FC<IProps> = ({ notification, hostname }) => {
   const {
     settings,
-    accounts,
+    auth: accounts,
     removeNotificationFromState,
     markNotificationRead,
     markNotificationDone,

diff --git a/src/context/App.test.tsx b/src/context/App.test.tsx
@@ -1,7 +1,7 @@
 import { act, fireEvent, render, waitFor } from '@testing-library/react';
 import { useContext } from 'react';
 
-import { mockAccounts, mockSettings } from '../__mocks__/state-mocks';
+import { mockAuth, mockSettings } from '../__mocks__/state-mocks';
 import { useNotifications } from '../hooks/useNotifications';
 import type { AuthState, SettingsState } from '../types';
 import * as apiRequests from '../utils/api/request';
@@ -15,11 +15,11 @@ jest.mock('../hooks/useNotifications');
 
 const customRender = (
   ui,
-  accounts: AuthState = mockAccounts,
+  accounts: AuthState = mockAuth,
   settings: SettingsState = mockSettings,
 ) => {
   return render(
-    <AppContext.Provider value={{ accounts, settings }}>
+    <AppContext.Provider value={{ auth: accounts, settings }}>
       <AppProvider>{ui}</AppProvider>
     </AppContext.Provider>,
   );
@@ -320,9 +320,9 @@ describe('context/App.tsx', () => {
       fireEvent.click(getByText('Test Case'));
     });
 
-    expect(saveStateMock).toHaveBeenCalledWith(
-      { enterpriseAccounts: [], token: null, user: null },
-      {
+    expect(saveStateMock).toHaveBeenCalledWith({
+      auth: { enterpriseAccounts: [], token: null, user: null },
+      settings: {
         participating: true,
         playSound: true,
         showNotifications: true,
@@ -335,7 +335,7 @@ describe('context/App.tsx', () => {
         showAccountHostname: false,
         delayNotificationState: false,
       },
-    );
+    });
   });
 
   it('should call updateSetting and set auto launch(openAtStartup)', async () => {
@@ -365,9 +365,9 @@ describe('context/App.tsx', () => {
 
     expect(setAutoLaunchMock).toHaveBeenCalledWith(true);
 
-    expect(saveStateMock).toHaveBeenCalledWith(
-      { enterpriseAccounts: [], token: null, user: null },
-      {
+    expect(saveStateMock).toHaveBeenCalledWith({
+      auth: { enterpriseAccounts: [], token: null, user: null },
+      settings: {
         participating: false,
         playSound: true,
         showNotifications: true,
@@ -380,6 +380,6 @@ describe('context/App.tsx', () => {
         showAccountHostname: false,
         delayNotificationState: false,
       },
-    );
+    });
   });
 });
diff --git a/src/context/App.tsx b/src/context/App.tsx
@@ -47,7 +47,7 @@ export const defaultSettings: SettingsState = {
 };
 
 interface AppContextState {
-  accounts: AuthState;
+  auth: AuthState;
   isLoggedIn: boolean;
   login: () => void;
   loginEnterprise: (data: AuthOptions) => void;
@@ -136,7 +136,7 @@ export const AppProvider = ({ children }: { children: ReactNode }) => {
 
       const newSettings = { ...settings, [name]: value };
       setSettings(newSettings);
-      saveState(accounts, newSettings);
+      saveState({ auth: accounts, settings: newSettings });
     },
     [accounts, settings],
   );
@@ -152,7 +152,7 @@ export const AppProvider = ({ children }: { children: ReactNode }) => {
     const user = await getUserData(token, hostname);
     const updatedAccounts = addAccount(accounts, token, hostname, user);
     setAccounts(updatedAccounts);
-    saveState(updatedAccounts, settings);
+    saveState({ auth: updatedAccounts, settings });
   }, [accounts, settings]);
 
   const loginEnterprise = useCallback(
@@ -161,7 +161,7 @@ export const AppProvider = ({ children }: { children: ReactNode }) => {
       const { token, hostname } = await getToken(authCode, authOptions);
       const updatedAccounts = addAccount(accounts, token, hostname);
       setAccounts(updatedAccounts);
-      saveState(updatedAccounts, settings);
+      saveState({ auth: updatedAccounts, settings });
     },
     [accounts, settings],
   );
@@ -173,7 +173,7 @@ export const AppProvider = ({ children }: { children: ReactNode }) => {
       const user = await getUserData(token, hostname);
       const updatedAccounts = addAccount(accounts, token, hostname, user);
       setAccounts(updatedAccounts);
-      saveState(updatedAccounts, settings);
+      saveState({ auth: updatedAccounts, settings });
     },
     [accounts, settings],
   );
@@ -186,8 +186,8 @@ export const AppProvider = ({ children }: { children: ReactNode }) => {
   const restoreSettings = useCallback(() => {
     const existing = loadState();
 
-    if (existing.accounts) {
-      setAccounts({ ...defaultAccounts, ...existing.accounts });
+    if (existing.auth) {
+      setAccounts({ ...defaultAccounts, ...existing.auth });
     }
 
     if (existing.settings) {
@@ -234,7 +234,7 @@ export const AppProvider = ({ children }: { children: ReactNode }) => {
   return (
     <AppContext.Provider
       value={{
-        accounts,
+        auth: accounts,
         isLoggedIn,
         login,
         loginEnterprise,

diff --git a/src/hooks/useNotifications.test.ts b/src/hooks/useNotifications.test.ts
@@ -2,7 +2,7 @@ import { act, renderHook, waitFor } from '@testing-library/react';
 import axios, { AxiosError } from 'axios';
 import nock from 'nock';
 
-import { mockAccounts, mockSettings, mockUser } from '../__mocks__/state-mocks';
+import { mockAuth, mockSettings, mockUser } from '../__mocks__/state-mocks';
 import type { AuthState } from '../types';
 import { mockNotificationUser } from '../utils/api/__mocks__/response-mocks';
 import { Errors } from '../utils/constants';
@@ -34,7 +34,7 @@ describe('hooks/useNotifications.ts', () => {
         const { result } = renderHook(() => useNotifications());
 
         act(() => {
-          result.current.fetchNotifications(mockAccounts, {
+          result.current.fetchNotifications(mockAuth, {
             ...mockSettings,
             detailedNotifications: false,
           });
@@ -87,7 +87,7 @@ describe('hooks/useNotifications.ts', () => {
         const { result } = renderHook(() => useNotifications());
 
         act(() => {
-          result.current.fetchNotifications(mockAccounts, mockSettings);
+          result.current.fetchNotifications(mockAuth, mockSettings);
         });
 
         expect(result.current.status).toBe('loading');
@@ -103,7 +103,7 @@ describe('hooks/useNotifications.ts', () => {
     describe('enterprise', () => {
       it('should fetch notifications with success - enterprise only', async () => {
         const accounts: AuthState = {
-          ...mockAccounts,
+          ...mockAuth,
           token: null,
         };
 
@@ -137,7 +137,7 @@ describe('hooks/useNotifications.ts', () => {
 
       it('should fetch notifications with failure - enterprise only', async () => {
         const accounts: AuthState = {
-          ...mockAccounts,
+          ...mockAuth,
           token: null,
         };
 
@@ -168,7 +168,7 @@ describe('hooks/useNotifications.ts', () => {
     describe('github.com', () => {
       it('should fetch notifications with success - github.com only', async () => {
         const accounts: AuthState = {
-          ...mockAccounts,
+          ...mockAuth,
           enterpriseAccounts: [],
           user: mockUser,
         };
@@ -201,7 +201,7 @@ describe('hooks/useNotifications.ts', () => {
 
       it('should fetch notifications with failures - github.com only', async () => {
         const accounts: AuthState = {
-          ...mockAccounts,
+          ...mockAuth,
           enterpriseAccounts: [],
         };
 
@@ -233,7 +233,7 @@ describe('hooks/useNotifications.ts', () => {
     describe('with detailed notifications', () => {
       it('should fetch notifications with success', async () => {
         const accounts: AuthState = {
-          ...mockAccounts,
+          ...mockAuth,
           enterpriseAccounts: [],
           user: mockUser,
         };
@@ -429,7 +429,7 @@ describe('hooks/useNotifications.ts', () => {
       const { result } = renderHook(() => useNotifications());
 
       act(() => {
-        result.current.fetchNotifications(mockAccounts, {
+        result.current.fetchNotifications(mockAuth, {
           ...mockSettings,
           detailedNotifications: false,
         });
@@ -455,7 +455,7 @@ describe('hooks/useNotifications.ts', () => {
     const id = 'notification-123';
 
     describe('github.com', () => {
-      const accounts = { ...mockAccounts, enterpriseAccounts: [] };
+      const accounts = { ...mockAuth, enterpriseAccounts: [] };
       const hostname = 'github.com';
 
       it('should mark a notification as read with success - github.com', async () => {
@@ -506,7 +506,7 @@ describe('hooks/useNotifications.ts', () => {
     });
 
     describe('enterprise', () => {
-      const accounts = { ...mockAccounts, token: null };
+      const accounts = { ...mockAuth, token: null };
       const hostname = 'github.gitify.io';
 
       it('should mark a notification as read with success - enterprise', async () => {
@@ -561,7 +561,7 @@ describe('hooks/useNotifications.ts', () => {
     const id = 'notification-123';
 
     describe('github.com', () => {
-      const accounts = { ...mockAccounts, enterpriseAccounts: [] };
+      const accounts = { ...mockAuth, enterpriseAccounts: [] };
       const hostname = 'github.com';
 
       it('should mark a notification as done with success - github.com', async () => {
@@ -612,7 +612,7 @@ describe('hooks/useNotifications.ts', () => {
     });
 
     describe('enterprise', () => {
-      const accounts = { ...mockAccounts, token: null };
+      const accounts = { ...mockAuth, token: null };
       const hostname = 'github.gitify.io';
 
       it('should mark a notification as done with success - enterprise', async () => {
@@ -667,7 +667,7 @@ describe('hooks/useNotifications.ts', () => {
     const id = 'notification-123';
 
     describe('github.com', () => {
-      const accounts = { ...mockAccounts, enterpriseAccounts: [] };
+      const accounts = { ...mockAuth, enterpriseAccounts: [] };
       const hostname = 'github.com';
 
       it('should unsubscribe from a notification with success - github.com', async () => {
@@ -730,7 +730,7 @@ describe('hooks/useNotifications.ts', () => {
     });
 
     describe('enterprise', () => {
-      const accounts = { ...mockAccounts, token: null };
+      const accounts = { ...mockAuth, token: null };
       const hostname = 'github.gitify.io';
 
       it('should unsubscribe from a notification with success - enterprise', async () => {
@@ -797,7 +797,7 @@ describe('hooks/useNotifications.ts', () => {
     const repoSlug = 'gitify-app/notifications-test';
 
     describe('github.com', () => {
-      const accounts = { ...mockAccounts, enterpriseAccounts: [] };
+      const accounts = { ...mockAuth, enterpriseAccounts: [] };
       const hostname = 'github.com';
 
       it("should mark a repository's notifications as read with success - github.com", async () => {
@@ -848,7 +848,7 @@ describe('hooks/useNotifications.ts', () => {
     });
 
     describe('enterprise', () => {
-      const accounts = { ...mockAccounts, token: null };
+      const accounts = { ...mockAuth, token: null };
       const hostname = 'github.gitify.io';
 
       it("should mark a repository's notifications as read with success - enterprise", async () => {
@@ -904,7 +904,7 @@ describe('hooks/useNotifications.ts', () => {
     const id = 'notification-123';
 
     describe('github.com', () => {
-      const accounts = { ...mockAccounts, enterpriseAccounts: [] };
+      const accounts = { ...mockAuth, enterpriseAccounts: [] };
       const hostname = 'github.com';
 
       it("should mark a repository's notifications as done with success - github.com", async () => {
@@ -955,7 +955,7 @@ describe('hooks/useNotifications.ts', () => {
     });
 
     describe('enterprise', () => {
-      const accounts = { ...mockAccounts, token: null };
+      const accounts = { ...mockAuth, token: null };
       const hostname = 'github.gitify.io';
 
       it("should mark a repository's notifications as done with success - enterprise", async () => {