Cache service v2

* fix: cache-hit output

* fix: Output chache hit timing

* fix: Output chache hit timing

---------

Co-authored-by: Josh Gross <joshmgross@github.com>

README.md

@@ -91,7 +91,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Cache Primes
       id: cache-primes
@@ -122,7 +122,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Restore cached Primes
       id: cache-primes-restore
@@ -229,7 +229,7 @@ Example:
 
 ```yaml
 steps:
-  - uses: actions/checkout@v3
+  - uses: actions/checkout@v4
 
   - uses: actions/cache@v4
     id: cache
@@ -259,7 +259,7 @@ jobs:
   build-linux:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Cache Primes
         id: cache-primes
@@ -286,7 +286,7 @@ jobs:
   build-windows:
     runs-on: windows-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Cache Primes
         id: cache-primes

__tests__/restore.test.ts

@@ -260,7 +260,7 @@ test("Fail restore when fail on cache miss is enabled and primary + restore keys
     );
 
     expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key);
-    expect(setCacheHitOutputMock).toHaveBeenCalledTimes(0);
+    expect(setCacheHitOutputMock).toHaveBeenCalledTimes(1);
 
     expect(failedMock).toHaveBeenCalledWith(
         `Failed to restore cache entry. Exiting as fail-on-cache-miss is set. Input key: ${key}`

__tests__/restoreOnly.test.ts

@@ -86,7 +86,8 @@ test("restore with no cache found", async () => {
     );
 
     expect(outputMock).toHaveBeenCalledWith("cache-primary-key", key);
-    expect(outputMock).toHaveBeenCalledTimes(1);
+    expect(outputMock).toHaveBeenCalledWith("cache-hit", "false");
+    expect(outputMock).toHaveBeenCalledTimes(2);
     expect(failedMock).toHaveBeenCalledTimes(0);
 
     expect(infoMock).toHaveBeenCalledWith(

examples.md

@@ -513,6 +513,7 @@ jobs:
 ```yaml
 - name: Get pip cache dir
   id: pip-cache
+  shell: bash
   run: |
     echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
 

package-lock.json

@@ -10,9 +10,9 @@
       "license": "MIT",
       "dependencies": {
         "@actions/cache": "file:/workspaces/toolkit/packages/cache",
-        "@actions/core": "file:/workspaces/toolkit/packages/core",
-        "@actions/exec": "file:/workspaces/toolkit/packages/exec",
-        "@actions/io": "file:/workspaces/toolkit/packages/io"
+        "@actions/core": "^1.10.0",
+        "@actions/exec": "^1.1.1",
+        "@actions/io": "^1.1.2"
       },
       "devDependencies": {
         "@types/jest": "^27.5.2",
@@ -35,41 +35,6 @@
         "typescript": "^4.9.3"
       }
     },
-    "../toolkit": {
-      "name": "root",
-      "dependencies": {
-        "@actions/artifact": "^2.1.7",
-        "@actions/attest": "^1.2.1",
-        "@actions/cache": "^3.2.4",
-        "@actions/core": "^1.10.1",
-        "@actions/exec": "^1.1.1",
-        "@actions/github": "^6.0.0",
-        "@actions/glob": "^0.4.0",
-        "@actions/http-client": "^2.2.1",
-        "@actions/io": "^1.1.3",
-        "@actions/tool-cache": "^2.0.1",
-        "tunnel": "^0.0.6",
-        "undici": "^6.18.1"
-      },
-      "devDependencies": {
-        "@types/jest": "^29.5.4",
-        "@types/node": "^20.5.7",
-        "@types/signale": "^1.4.1",
-        "concurrently": "^6.1.0",
-        "eslint": "^8.0.1",
-        "eslint-config-prettier": "^8.9.0",
-        "eslint-plugin-github": "^4.9.2",
-        "eslint-plugin-jest": "^27.2.3",
-        "eslint-plugin-prettier": "^5.0.0",
-        "flow-bin": "^0.115.0",
-        "jest": "^29.6.4",
-        "lerna": "^6.4.1",
-        "nx": "16.6.0",
-        "prettier": "^3.0.0",
-        "ts-jest": "^29.1.1",
-        "typescript": "^5.2.2"
-      }
-    },
     "../toolkit/packages/cache": {
       "name": "@actions/cache",
       "version": "3.2.4",
@@ -107,12 +72,6 @@
         "@types/uuid": "^8.3.4"
       }
     },
-    "../toolkit/packages/core/src": {
-      "extraneous": true
-    },
-    "../toolkit/packages/core/src/lib": {
-      "extraneous": true
-    },
     "../toolkit/packages/exec": {
       "name": "@actions/exec",
       "version": "1.1.1",
@@ -126,9 +85,6 @@
       "version": "1.1.3",
       "license": "MIT"
     },
-    "../workspaces/toolkit": {
-      "extraneous": true
-    },
     "node_modules/@actions/cache": {
       "resolved": "../toolkit/packages/cache",
       "link": true

package.json

@@ -24,9 +24,9 @@
   "license": "MIT",
   "dependencies": {
     "@actions/cache": "file:/workspaces/toolkit/packages/cache",
-    "@actions/core": "file:/workspaces/toolkit/packages/core",
-    "@actions/exec": "file:/workspaces/toolkit/packages/exec",
-    "@actions/io": "file:/workspaces/toolkit/packages/io"
+    "@actions/core": "^1.10.0",
+    "@actions/exec": "^1.1.1",
+    "@actions/io": "^1.1.2"
   },
   "devDependencies": {
     "@types/jest": "^27.5.2",
@@ -48,4 +48,4 @@
     "ts-jest": "^28.0.8",
     "typescript": "^4.9.3"
   }
-}
+}

src/restoreImpl.ts

@@ -22,8 +22,7 @@ export async function restoreImpl(
         // Validate inputs, this can cause task failure
         if (!utils.isValidEvent()) {
             utils.logWarning(
-                `Event Validation Error: The event type ${
-                    process.env[Events.Key]
+                `Event Validation Error: The event type ${process.env[Events.Key]
                 } is not supported because it's not tied to a branch or tag ref.`
             );
             return;
@@ -51,6 +50,7 @@ export async function restoreImpl(
         );
 
         if (!cacheKey) {
+            core.setOutput(Outputs.CacheHit, false.toString());
             if (failOnCacheMiss) {
                 throw new Error(
                     `Failed to restore cache entry. Exiting as fail-on-cache-miss is set. Input key: ${primaryKey}`
@@ -62,7 +62,6 @@ export async function restoreImpl(
                     ...restoreKeys
                 ].join(", ")}`
             );
-
             return;
         }