Merge pull request #704 from immobiliare/fix/disable-cache-by-default

fix: disable cache by default

Author: antoniomuso

packages/gitlab/config.d.ts

@@ -22,10 +22,23 @@ export interface Config {
         useOAuth?: boolean;
 
         /**
-         * Cache TTL for the Gitlab plugin in ms
-         * @default 5 * 60 * 1000 (5 minutes)
+         * Cache configuration
          * @visibility frontend
          */
-        cacheTTL?: number;
+        cache?: {
+            /**
+             * Enable caching for the Gitlab plugin
+             * @default false
+             * @visibility frontend
+             */
+            enabled?: boolean;
+
+            /**
+             * Cache TTL for the Gitlab plugin in seconds
+             * @default 300
+             * @visibility frontend
+             */
+            ttl?: number;
+        };
     };
 }

packages/gitlab/src/api/GitlabCIClient.test.ts

@@ -43,7 +43,7 @@ describe('GitlabCIClient', () => {
             expect(client.codeOwnersPath).toBe('CODEOWNERS');
             expect(client.readmePath).toBe('README.md');
             expect(client.useOAth).toBe(false);
-            expect(client.cacheTTL).toBe(5 * 60 * 1000);
+            expect(client.cacheTTL).toBe(undefined);
         });
 
         it('should initialize with custom values', () => {
@@ -52,12 +52,16 @@ describe('GitlabCIClient', () => {
                 codeOwnersPath: 'custom/OWNERS',
                 readmePath: 'docs/README.md',
                 useOAuth: true,
-                cacheTTL: 1000,
+                cache: {
+                    enabled: true,
+                    ttl: 1,
+                },
             });
 
             expect(client.codeOwnersPath).toBe('custom/OWNERS');
             expect(client.readmePath).toBe('docs/README.md');
             expect(client.useOAth).toBe(true);
+            expect(client.cacheEnabled).toBe(true);
             expect(client.cacheTTL).toBe(1000);
         });
     });
@@ -244,7 +248,13 @@ describe('GitlabCIClient', () => {
         global.fetch = mockFetch;
 
         beforeEach(() => {
-            client = new GitlabCIClient({ ...defaultOptions, cacheTTL: 1000 });
+            client = new GitlabCIClient({
+                ...defaultOptions,
+                cache: {
+                    enabled: true,
+                    ttl: 1,
+                },
+            });
             mockFetch.mockReset();
         });
 

packages/gitlab/src/api/GitlabCIClient.ts

@@ -32,7 +32,10 @@ export type APIOptions = {
     readmePath?: string;
     gitlabAuthApi: OAuthApi;
     useOAuth?: boolean;
-    cacheTTL?: number;
+    cache?: {
+        enabled?: boolean;
+        ttl?: number;
+    };
     httpFetch?: typeof fetch;
 };
 
@@ -44,7 +47,8 @@ export class GitlabCIClient implements GitlabCIApi {
     codeOwnersPath: string;
     gitlabInstance: string;
     readmePath: string;
-    cacheTTL: number;
+    cacheTTL?: number;
+    cacheEnabled: boolean;
     httpFetch: typeof fetch;
 
     constructor({
@@ -54,7 +58,7 @@ export class GitlabCIClient implements GitlabCIApi {
         readmePath,
         gitlabAuthApi,
         gitlabInstance,
-        cacheTTL,
+        cache,
         useOAuth,
         httpFetch = window.fetch.bind(window),
     }: APIOptions & { gitlabInstance: string }) {
@@ -65,7 +69,11 @@ export class GitlabCIClient implements GitlabCIApi {
         this.identityApi = identityApi;
         this.gitlabAuthApi = gitlabAuthApi;
         this.useOAth = useOAuth ?? false;
-        this.cacheTTL = cacheTTL ?? 5 * 60 * 1000; // 5 minutes cache TTL
+        this.cacheEnabled = cache?.enabled ?? false;
+        // Default TTL is 5 minutes, convert to milliseconds
+        this.cacheTTL = this.cacheEnabled
+            ? (cache?.ttl ?? 60 * 5) * 1000
+            : undefined;
         this.httpFetch = httpFetch;
         this.cleanupExpiredCache();
     }
@@ -77,7 +85,7 @@ export class GitlabCIClient implements GitlabCIApi {
         readmePath,
         gitlabAuthApi,
         useOAuth,
-        cacheTTL,
+        cache,
     }: APIOptions) {
         return {
             build: (gitlabInstance: string) =>
@@ -89,12 +97,13 @@ export class GitlabCIClient implements GitlabCIApi {
                     gitlabInstance,
                     gitlabAuthApi,
                     useOAuth,
-                    cacheTTL,
+                    cache,
                 }),
         };
     }
 
     private cleanupExpiredCache(): void {
+        if (!this.cacheEnabled || !this.cacheTTL) return;
         const now = Date.now();
         for (let i = 0; i < localStorage.length; i++) {
             const key = localStorage.key(i);
@@ -122,6 +131,7 @@ export class GitlabCIClient implements GitlabCIApi {
     }
 
     private getCachedData<T>(key: string): T | undefined {
+        if (!this.cacheEnabled || !this.cacheTTL) return undefined;
         const cached = localStorage.getItem(key);
         if (cached) {
             try {
@@ -138,6 +148,7 @@ export class GitlabCIClient implements GitlabCIApi {
     }
 
     private setCachedData<T>(key: string, data: T): void {
+        if (!this.cacheEnabled) return;
         localStorage.setItem(
             key,
             JSON.stringify({
@@ -156,7 +167,6 @@ export class GitlabCIClient implements GitlabCIApi {
         const cacheKey = this.getCacheKey(path, query, APIkind);
         const cachedData = this.getCachedData<T>(cacheKey);
         if (cachedData) {
-            console.log('hit cache');
             return cachedData;
         }
 

packages/gitlab/src/plugin.ts

@@ -46,7 +46,12 @@ export const gitlabPlugin = createPlugin({
                     ),
                     gitlabAuthApi,
                     useOAuth: configApi.getOptionalBoolean('gitlab.useOAuth'),
-                    cacheTTL: configApi.getOptionalNumber('gitlab.cacheTTL'),
+                    cache: {
+                        enabled: configApi.getOptionalBoolean(
+                            'gitlab.cache.enabled'
+                        ),
+                        ttl: configApi.getOptionalNumber('gitlab.cache.ttl'),
+                    },
                 }),
         }),
     ],