Fail when cache local path does not exist when trying to cache

astral-sh · Nov 23, 2024 · 70e4429 · 70e4429
1 parent 691a091
commit 70e4429
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 30 deletions.
diff --git a/.github/workflows/test-cache.yml b/.github/workflows/test-cache.yml
@@ -21,7 +21,7 @@ jobs:
         uses: ./
         with:
           enable-cache: true
-          cache-suffix: ${{ github.run_id }}-${{ github.run_attempt }}
+          cache-suffix: ${{ github.run_id }}-${{ github.run_attempt }}-test-setup-cache
       - run: uv sync
         working-directory: __tests__/fixtures/uv-project
   test-restore-cache:
@@ -37,7 +37,7 @@ jobs:
         uses: ./
         with:
           enable-cache: true
-          cache-suffix: ${{ github.run_id }}-${{ github.run_attempt }}
+          cache-suffix: ${{ github.run_id }}-${{ github.run_attempt }}-test-setup-cache
       - name: Cache was hit
         run: |
           if [ "$CACHE_HIT" != "true" ]; then
@@ -59,7 +59,7 @@ jobs:
           cache-dependency-glob: |
             __tests__/fixtures/uv-project/uv.lock
             **/pyproject.toml
-          cache-suffix: ${{ github.run_id }}-${{ github.run_attempt }}
+          cache-suffix: ${{ github.run_id }}-${{ github.run_attempt }}-test-setup-cache-dependency-glob
       - run: uv sync
         working-directory: __tests__/fixtures/uv-project
   test-restore-cache-dependency-glob:
@@ -79,7 +79,7 @@ jobs:
           cache-dependency-glob: |
             __tests__/fixtures/uv-project/uv.lock
             **/pyproject.toml
-          cache-suffix: ${{ github.run_id }}-${{ github.run_attempt }}
+          cache-suffix: ${{ github.run_id }}-${{ github.run_attempt }}-test-setup-cache-dependency-glob
       - name: Cache was not hit
         run: |
           if [ "$CACHE_HIT" == "true" ]; then
@@ -96,7 +96,7 @@ jobs:
         uses: ./
         with:
           enable-cache: true
-          cache-suffix: ${{ github.run_id }}-${{ github.run_attempt }}
+          cache-suffix: ${{ github.run_id }}-${{ github.run_attempt }}-test-setup-cache-local
           cache-local-path: /tmp/uv-cache
       - run: uv sync
         working-directory: __tests__/fixtures/uv-project
@@ -110,7 +110,7 @@ jobs:
         uses: ./
         with:
           enable-cache: true
-          cache-suffix: ${{ github.run_id }}-${{ github.run_attempt }}
+          cache-suffix: ${{ github.run_id }}-${{ github.run_attempt }}-test-setup-cache-local
           cache-local-path: /tmp/uv-cache
       - name: Cache was hit
         run: |
@@ -122,38 +122,38 @@ jobs:
       - run: uv sync
         working-directory: __tests__/fixtures/uv-project
 
-  prepare-tilde-expansion-tests:
+  test-tilde-expansion-cache-local-path:
     runs-on: selfhosted-ubuntu-arm64
     steps:
+      - uses: actions/checkout@v4
       - name: Create cache directory
         run: mkdir -p ~/uv-cache
         shell: bash
-      - name: Create cache dependency glob file
-        run: touch ~/uv-cache.glob
-        shell: bash
-
-  test-tilde-expansion-cache-local-path:
-    needs: prepare-tilde-expansion-tests
-    runs-on: selfhosted-ubuntu-arm64
-    steps:
-      - uses: actions/checkout@v4
       - name: Setup with cache
         uses: ./
         with:
-          enable-cache: true
           cache-local-path: ~/uv-cache/cache-local-path
+      - run: uv sync
+        working-directory: __tests__/fixtures/uv-project
 
   test-tilde-expansion-cache-dependency-glob:
-    needs: prepare-tilde-expansion-tests
     runs-on: selfhosted-ubuntu-arm64
     steps:
       - uses: actions/checkout@v4
+      - name: Create cache directory
+        run: mkdir -p ~/uv-cache
+        shell: bash
+      - name: Create cache dependency glob file
+        run: touch ~/uv-cache.glob
+        shell: bash
       - name: Setup with cache
         uses: ./
         with:
           enable-cache: true
           cache-local-path: ~/uv-cache/cache-dependency-glob
           cache-dependency-glob: "~/uv-cache.glob"
+      - run: uv sync
+        working-directory: __tests__/fixtures/uv-project
 
   cleanup-tilde-expansion-tests:
     needs:

diff --git a/dist/save-cache/index.js b/dist/save-cache/index.js
diff --git a/src/save-cache.ts b/src/save-cache.ts
@@ -1,6 +1,7 @@
 import * as cache from "@actions/cache";
 import * as core from "@actions/core";
 import * as exec from "@actions/exec";
+import * as fs from "node:fs";
 import {
   STATE_CACHE_MATCHED_KEY,
   STATE_CACHE_KEY,
@@ -15,17 +16,17 @@ export async function run(): Promise<void> {
   try {
     if (enableCache) {
       await saveCache();
+      // node will stay alive if any promises are not resolved,
+      // which is a possibility if HTTP requests are dangling
+      // due to retries or timeouts. We know that if we got here
+      // that all promises that we care about have successfully
+      // resolved, so simply exit with success.
+      process.exit(0);
     }
   } catch (error) {
     const err = error as Error;
     core.setFailed(err.message);
   }
-  // node will stay alive if any promises are not resolved,
-  // which is a possibility if HTTP requests are dangling
-  // due to retries or timeouts. We know that if we got here
-  // that all promises that we care about have successfully
-  // resolved, so simply exit with success.
-  process.exit(0);
 }
 
 async function saveCache(): Promise<void> {
@@ -46,6 +47,11 @@ async function saveCache(): Promise<void> {
   }
 
   core.info(`Saving cache path: ${cacheLocalPath}`);
+  if (!fs.existsSync(cacheLocalPath)) {
+    throw new Error(
+      `Cache path ${cacheLocalPath} does not exist on disk. This likely indicates that there are no dependencies to cache. Consider disabling the cache input if it is not needed.`,
+    );
+  }
   await cache.saveCache([cacheLocalPath], cacheKey);
 
   core.info(`cache saved with the key: ${cacheKey}`);