feat: option to ignore cache in ElectronVersions.create (#80)

electron · Apr 27, 2023 · 3b61627 · 3b61627
1 parent e440735
commit 3b61627
Show file tree

Hide file tree

Showing 3 changed files with 68 additions and 9 deletions.
diff --git a/etc/fiddle-core.api.md b/etc/fiddle-core.api.md
@@ -93,6 +93,7 @@ export class ElectronVersions extends BaseVersions {
 
 // @public (undocumented)
 export interface ElectronVersionsCreateOptions {
+    ignoreCache?: boolean;
     initialVersions?: unknown;
 }
 

diff --git a/src/versions.ts b/src/versions.ts
@@ -73,6 +73,9 @@ export interface Versions {
 export interface ElectronVersionsCreateOptions {
   /** Initial versions to use if there is no cache. When provided, no initial fetch is done */
   initialVersions?: unknown;
+
+  /** Ignore the cache even if it exists and is fresh */
+  ignoreCache?: boolean;
 }
 
 export function compareVersions(a: SemVer, b: SemVer): number {
@@ -306,17 +309,19 @@ export class ElectronVersions extends BaseVersions {
     const d = debug('fiddle-core:ElectronVersions:create');
     const { versionsCache } = { ...DefaultPaths, ...paths };
 
-    let versions: unknown;
+    // Use initialVersions instead if provided, and don't fetch if so
+    let versions = options.initialVersions;
     let staleCache = false;
     const now = Date.now();
-    try {
-      const st = await fs.stat(versionsCache);
-      versions = await fs.readJson(versionsCache);
-      staleCache = !ElectronVersions.isCacheFresh(st.mtimeMs, now);
-    } catch (err) {
-      d('cache file missing or cannot be read', err);
-      // Use initialVersions instead if provided, and don't fetch
-      versions = options.initialVersions;
+
+    if (!options.ignoreCache) {
+      try {
+        const st = await fs.stat(versionsCache);
+        versions = await fs.readJson(versionsCache);
+        staleCache = !ElectronVersions.isCacheFresh(st.mtimeMs, now);
+      } catch (err) {
+        d('cache file missing or cannot be read', err);
+      }
     }
 
     if (!versions || staleCache) {

diff --git a/tests/versions.test.ts b/tests/versions.test.ts
@@ -391,6 +391,59 @@ describe('ElectronVersions', () => {
       );
       expect(versions.length).toBe(1);
     });
+
+    it('does not use cache if options.ignoreCache is true', async () => {
+      await fs.outputJSON(versionsCache, [
+        {
+          version: '0.23.0',
+        },
+      ]);
+      const scope = nockScope.get('/releases.json').reply(
+        200,
+        JSON.stringify([
+          {
+            version: '0.23.0',
+          },
+          {
+            version: '0.23.1',
+          },
+          {
+            version: '0.23.2',
+          },
+        ]),
+        {
+          'Content-Type': 'application/json',
+        },
+      );
+      const { versions } = await ElectronVersions.create(
+        { versionsCache },
+        { ignoreCache: true },
+      );
+      expect(scope.isDone());
+      expect(versions.length).toBe(3);
+    });
+
+    it('uses options.initialVersions if cache available but options.ignoreCache is true', async () => {
+      await fs.outputJSON(versionsCache, [
+        {
+          version: '0.23.0',
+        },
+      ]);
+      expect(nockScope.isDone()); // No mocks
+      const initialVersions = [
+        {
+          version: '0.23.0',
+        },
+        {
+          version: '0.23.1',
+        },
+      ];
+      const { versions } = await ElectronVersions.create(
+        { versionsCache },
+        { initialVersions, ignoreCache: true },
+      );
+      expect(versions.length).toBe(2);
+    });
   });
 
   describe('.fetch', () => {