feat: axios-cache-interceptor

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

Author: setchy

src/renderer/components/Sidebar.tsx

@@ -16,7 +16,7 @@ import { APPLICATION } from '../../shared/constants';
 
 import { Constants } from '../constants';
 import { AppContext } from '../context/App';
-import { clearApiCache } from '../utils/api/request';
+import { clearFullApiCache } from '../utils/api/request';
 import { quitApp } from '../utils/comms';
 import {
   openGitHubIssues,
@@ -65,7 +65,7 @@ export const Sidebar: FC = () => {
     navigate('/', { replace: true });
 
     // Clear client cache so we fetch fresh data when user manually refreshes
-    clearApiCache();
+    clearFullApiCache();
     fetchNotifications();
   };
 

src/renderer/context/App.tsx

@@ -28,7 +28,7 @@ import type {
 import { FetchType } from '../types';
 import type { Notification } from '../typesGitHub';
 import { headNotifications } from '../utils/api/client';
-import { clearApiCache } from '../utils/api/request';
+import { clearFullApiCache } from '../utils/api/request';
 import type {
   LoginOAuthAppOptions,
   LoginPersonalAccessTokenOptions,
@@ -136,7 +136,7 @@ export const AppProvider = ({ children }: { children: ReactNode }) => {
 
   // biome-ignore lint/correctness/useExhaustiveDependencies: We only want fetchNotifications to be called for particular state changes
   useEffect(() => {
-    clearApiCache();
+    clearFullApiCache();
     fetchNotifications({ auth, settings });
   }, [
     auth.accounts,

src/renderer/utils/api/request.ts

@@ -8,23 +8,30 @@ import { buildKeyGenerator, setupCache } from 'axios-cache-interceptor';
 
 import type { Account, Link, Token } from '../../types';
 import { decryptValue } from '../comms';
-import { rendererLogError  } from '../logger';
+import { rendererLogError } from '../logger';
 import { getNextURLFromLinkHeader } from './utils';
 
 type AxiosRequestConfigWithAccount = AxiosRequestConfig & { account: Account };
 
+// const MUTATION_HTTP_METHODS: Set<Method> = new Set(['PATCH', 'PUT', 'DELETE']);
+
 const instance = Axios.create();
 const axios = setupCache(instance, {
   location: 'client',
 
+  // Respect ETags and cache headers from GitHub API
+  interpretHeader: true,
+
+  // Set a reasonable TTL to ensure cache freshness (60 seconds)
+  // This ensures external changes (GitHub web/mobile) are picked up periodically
+  // ttl: 1000 * 60, // 60 seconds
+
   cachePredicate: {
-    ignoreUrls: [
-      '/login/oauth/access_token',
-      // '/notifications',
-      // '/api/v3/notifications',
-    ],
+    ignoreUrls: ['/login/oauth/access_token'],
   },
 
+  methods: ['get'],
+
   generateKey: buildKeyGenerator((request: AxiosRequestConfigWithAccount) => {
     return {
       method: request.method,
@@ -34,6 +41,24 @@ const axios = setupCache(instance, {
   }),
 });
 
+// Invalidate cache on mutating requests (PATCH, PUT, DELETE)
+// Only clears cache entries for the same account that made the mutation
+// axios.interceptors.response.use(
+//   async (response) => {
+//     const method = response.config.method?.toUpperCase() as Method;
+//     const config = response.config as AxiosRequestConfigWithAccount;
+
+//     if (MUTATION_HTTP_METHODS.has(method) && config.account) {
+//       await clearFullApiCache();
+//     }
+//     return response;
+//   },
+//   (error: Error) => {
+//     // Pass through errors without clearing cache
+//     return Promise.reject(error);
+//   },
+// );
+
 /**
  * Perform an unauthenticated API request
  *
@@ -139,10 +164,10 @@ async function getHeaders(token?: Token) {
   return headers;
 }
 
-export async function clearApiCache(): Promise<void> {
-  try {
-    axios.storage.clear();
-  } catch (err) {
-    rendererLogError('clearApiCache', 'Failed to clear API cache', err);
-  }
+export async function clearFullApiCache(): Promise<void> {
+  // try {
+  //   axios.storage.clear();
+  // } catch (err) {
+  //   rendererLogError('clearFullApiCache', 'Failed to clear API cache', err);
+  // }
 }