Merge pull request #1 from prncevince/prncevince/reeval

Add boolean inputs to:

* reevaluate cache's primary key
* only restore the cache (not save it)

.github/workflows/workflow.yml

@@ -53,6 +53,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macOS-latest]
+        reeval: [false, true]
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
@@ -67,10 +68,36 @@ jobs:
     - name: Save cache
       uses: ./
       with:
-        key: test-${{ runner.os }}-${{ github.run_id }}
+        reeval: ${{ matrix.reeval }}
+        key: test-${{ runner.os }}-${{ github.run_id }}-${{ matrix.reeval }}
         path: |
           test-cache
           ~/test-cache
+  test-only-restore:
+    needs: test-save
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macOS-latest]
+      fail-fast: false
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+    - name: Restore cache
+      uses: ./
+      with:
+        only-restore: true
+        reeval: ${{ matrix.reeval }}
+        key: test-${{ runner.os }}-${{ github.run_id }}-${{ matrix.reeval }}
+        path: |
+          test-cache
+          ~/test-cache
+    - name: Verify cache files in working directory
+      shell: bash
+      run: __tests__/verify-cache-files.sh ${{ runner.os }} test-cache
+    - name: Verify cache files outside working directory
+      shell: bash
+      run: __tests__/verify-cache-files.sh ${{ runner.os }} ~/test-cache
   test-restore:
     needs: test-save
     strategy:
@@ -84,7 +111,8 @@ jobs:
     - name: Restore cache
       uses: ./
       with:
-        key: test-${{ runner.os }}-${{ github.run_id }}
+        reeval: ${{ matrix.reeval }}
+        key: test-${{ runner.os }}-${{ github.run_id }}-${{ matrix.reeval }}
         path: |
           test-cache
           ~/test-cache
@@ -97,6 +125,9 @@ jobs:
 
   # End to end with proxy
   test-proxy-save:
+    strategy:
+      matrix:
+        reeval: [false, true]
     runs-on: ubuntu-latest
     container:
       image: ubuntu:latest
@@ -116,10 +147,14 @@ jobs:
     - name: Save cache
       uses: ./
       with:
-        key: test-proxy-${{ github.run_id }}
+        reeval: ${{ matrix.reeval }}
+        key: test-proxy-${{ github.run_id }}-${{ matrix.reeval }}
         path: test-cache
-  test-proxy-restore:
+  test-proxy-only-restore:
     needs: test-proxy-save
+    strategy:
+      matrix:
+        reeval: [false, true]
     runs-on: ubuntu-latest
     container:
       image: ubuntu:latest
@@ -137,7 +172,36 @@ jobs:
     - name: Restore cache
       uses: ./
       with:
-        key: test-proxy-${{ github.run_id }}
+        only-restore: true
+        reeval: ${{ matrix.reeval }}
+        key: test-proxy-${{ github.run_id }}-${{ matrix.reeval }}
+        path: test-cache
+    - name: Verify cache
+      run: __tests__/verify-cache-files.sh proxy test-cache
+  test-proxy-restore:
+    needs: test-proxy-save
+    strategy:
+      matrix:
+        reeval: [false, true]
+    runs-on: ubuntu-latest
+    container:
+      image: ubuntu:latest
+      options: --dns 127.0.0.1
+    services:
+      squid-proxy:
+        image: datadog/squid:latest
+        ports:
+          - 3128:3128
+    env:
+      https_proxy: http://squid-proxy:3128
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+    - name: Restore cache
+      uses: ./
+      with:
+        reeval: ${{ matrix.reeval }}
+        key: test-proxy-${{ github.run_id }}-${{ matrix.reeval }}
         path: test-cache
     - name: Verify cache
       run: __tests__/verify-cache-files.sh proxy test-cache

.gitignore

@@ -94,3 +94,6 @@ typings/
 
 # Text editor files
 .vscode/
+
+# OS
+.DS_Store

action.yml

@@ -14,6 +14,14 @@ inputs:
   upload-chunk-size:
     description: 'The chunk size used to split up large files during upload, in bytes'
     required: false
+  reeval:
+    description: "Boolean. Whether to reevaluate the key argument in post. Set to TRUE if you would like your cache key set after your job's steps are complete."
+    required: false
+    default: false
+  only-restore:
+    description: 'Boolean. Whether to only perform cache restoration and NOT the save post run step.'
+    required: false
+    default: false
 outputs:
   cache-hit:
     description: 'A boolean value to indicate an exact match was found for the primary key'

dist/restore/index.js

@@ -4607,7 +4607,9 @@ exports.RefKey = exports.Events = exports.State = exports.Outputs = exports.Inpu
 var Inputs;
 (function (Inputs) {
     Inputs["Key"] = "key";
+    Inputs["OnlyRestore"] = "only-restore";
     Inputs["Path"] = "path";
+    Inputs["Reeval"] = "reeval";
     Inputs["RestoreKeys"] = "restore-keys";
     Inputs["UploadChunkSize"] = "upload-chunk-size";
 })(Inputs = exports.Inputs || (exports.Inputs = {}));

dist/save/index.js

@@ -4607,7 +4607,9 @@ exports.RefKey = exports.Events = exports.State = exports.Outputs = exports.Inpu
 var Inputs;
 (function (Inputs) {
     Inputs["Key"] = "key";
+    Inputs["OnlyRestore"] = "only-restore";
     Inputs["Path"] = "path";
+    Inputs["Reeval"] = "reeval";
     Inputs["RestoreKeys"] = "restore-keys";
     Inputs["UploadChunkSize"] = "upload-chunk-size";
 })(Inputs = exports.Inputs || (exports.Inputs = {}));
@@ -46770,6 +46772,8 @@ const utils = __importStar(__webpack_require__(443));
 process.on("uncaughtException", e => utils.logWarning(e.message));
 function run() {
     return __awaiter(this, void 0, void 0, function* () {
+        const save = !core.getBooleanInput(constants_1.Inputs.OnlyRestore);
+        if (save) {
             try {
                 if (!utils.isCacheFeatureAvailable()) {
                     return;
@@ -46779,8 +46783,16 @@ function run() {
                     return;
                 }
                 const state = utils.getCacheState();
-            // Inputs are re-evaluted before the post action, so we want the original key used for restore
+                let primaryKey = "";
-            const primaryKey = core.getState(constants_1.State.CachePrimaryKey);
+                const reeval = core.getBooleanInput(constants_1.Inputs.Reeval);
+                if (!reeval) {
+                    // Inputs are reevaluted before the post action, so we want the original key used for restore
+                    primaryKey = core.getState(constants_1.State.CachePrimaryKey);
+                }
+                else {
+                    // choose to reevaluate primary key
+                    primaryKey = core.getInput(constants_1.Inputs.Key, { required: true });
+                }
                 if (!primaryKey) {
                     utils.logWarning(`Error retrieving key from state.`);
                     return;
@@ -46814,6 +46826,7 @@ function run() {
             catch (error) {
                 utils.logWarning(error.message);
             }
+        }
     });
 }
 run();

src/constants.ts

@@ -1,6 +1,8 @@
 export enum Inputs {
     Key = "key",
+    OnlyRestore = "only-restore",
     Path = "path",
+    Reeval = "reeval",
     RestoreKeys = "restore-keys",
     UploadChunkSize = "upload-chunk-size"
 }

src/save.ts

@@ -10,6 +10,8 @@ import * as utils from "./utils/actionUtils";
 process.on("uncaughtException", e => utils.logWarning(e.message));
 
 async function run(): Promise<void> {
+    const save = !core.getBooleanInput(Inputs.OnlyRestore);
+    if (save) {
         try {
             if (!utils.isCacheFeatureAvailable()) {
                 return;
@@ -26,8 +28,15 @@ async function run(): Promise<void> {
 
             const state = utils.getCacheState();
 
-        // Inputs are re-evaluted before the post action, so we want the original key used for restore
+            let primaryKey = "";
-        const primaryKey = core.getState(State.CachePrimaryKey);
+            const reeval = core.getBooleanInput(Inputs.Reeval);
+            if (!reeval) {
+                // Inputs are reevaluted before the post action, so we want the original key used for restore
+                primaryKey = core.getState(State.CachePrimaryKey);
+            } else {
+                // choose to reevaluate primary key
+                primaryKey = core.getInput(Inputs.Key, { required: true });
+            }
             if (!primaryKey) {
                 utils.logWarning(`Error retrieving key from state.`);
                 return;
@@ -62,6 +71,7 @@ async function run(): Promise<void> {
         } catch (error: unknown) {
             utils.logWarning((error as Error).message);
         }
+    }
 }
 
 run();