Add error handling for saving and restoring cache (#618)

actions · Mar 10, 2023 · 03eb867 · 03eb867
1 parent b41aaf9
commit 03eb867
Show file tree

Hide file tree

Showing 8 changed files with 695 additions and 1,057 deletions.
diff --git a/.licenses/npm/@actions/cache.dep.yml b/.licenses/npm/@actions/cache.dep.yml
diff --git a/.licenses/npm/@azure/abort-controller.dep.yml b/.licenses/npm/@azure/abort-controller.dep.yml
diff --git a/__tests__/cache-save.test.ts b/__tests__/cache-save.test.ts
@@ -225,7 +225,7 @@ describe('run', () => {
       expect(setFailedSpy).not.toHaveBeenCalled();
     });
 
-    it('saves with error from toolkit, should fail workflow', async () => {
+    it('saves with error from toolkit, should not fail the workflow', async () => {
       inputs['cache'] = 'npm';
       getStateSpy.mockImplementation((name: string) => {
         if (name === State.STATE_CACHE_PRIMARY_KEY) {
@@ -247,7 +247,7 @@ describe('run', () => {
       expect(getStateSpy).toHaveBeenCalledTimes(3);
       expect(infoSpy).not.toHaveBeenCalledWith();
       expect(saveCacheSpy).toHaveBeenCalled();
-      expect(setFailedSpy).toHaveBeenCalled();
+      expect(setFailedSpy).not.toHaveBeenCalled();
     });
   });
 

diff --git a/dist/cache-save/index.js b/dist/cache-save/index.js
diff --git a/dist/setup/index.js b/dist/setup/index.js
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/cache-distributions/cache-distributor.ts b/src/cache-distributions/cache-distributor.ts
@@ -39,13 +39,18 @@ abstract class CacheDistributor {
     const cachePath = await this.getCacheGlobalDirectories();
 
     core.saveState(State.CACHE_PATHS, cachePath);
-    core.saveState(State.STATE_CACHE_PRIMARY_KEY, primaryKey);
 
-    const matchedKey = await cache.restoreCache(
-      cachePath,
-      primaryKey,
-      restoreKey
-    );
+    let matchedKey: string | undefined;
+    try {
+      matchedKey = await cache.restoreCache(cachePath, primaryKey, restoreKey);
+    } catch (err) {
+      const message = (err as Error).message;
+      core.info(`[warning]${message}`);
+      core.setOutput('cache-hit', false);
+      return;
+    }
+
+    core.saveState(State.STATE_CACHE_PRIMARY_KEY, primaryKey);
 
     await this.handleLoadedCache();
 

diff --git a/src/cache-save.ts b/src/cache-save.ts
@@ -43,7 +43,16 @@ async function saveCache(packageManager: string) {
     return;
   }
 
-  const cacheId = await cache.saveCache(cachePaths, primaryKey);
+  let cacheId = 0;
+
+  try {
+    cacheId = await cache.saveCache(cachePaths, primaryKey);
+  } catch (err) {
+    const message = (err as Error).message;
+    core.info(`[warning]${message}`);
+    return;
+  }
+
   if (cacheId == -1) {
     return;
   }