Allow refreshing cache also with granular save.

.github/dependabot.yml

@@ -1,22 +0,0 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
-
-version: 2
-updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-    groups:
-      minor-actions-dependencies:
-        update-types: [minor, patch]
-  
-  - package-ecosystem: "npm"
-    directory: "/"
-    schedule:
-      interval: "daily" 
-    allow:
-    - dependency-type: direct
-    - dependency-type: production

.github/workflows/check-dist.yml

@@ -15,5 +15,3 @@ jobs:
   call-check-dist:
     name: Check dist/
     uses: actions/reusable-workflows/.github/workflows/check-dist.yml@main
-    with:
-      node-version: "20.x"

.github/workflows/close-inactive-issues.yml

@@ -10,7 +10,7 @@ jobs:
       issues: write
       pull-requests: write
     steps:
-      - uses: actions/stale@v9
+      - uses: actions/stale@v3
         with:
           days-before-issue-stale: 200
           days-before-issue-close: 5

.github/workflows/codeql.yml

@@ -17,11 +17,11 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v4
+      uses: actions/checkout@v3
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v3
+      uses: github/codeql-action/init@v2
       # Override language selection by uncommenting this and choosing your languages
       # with:
       #   languages: go, javascript, csharp, python, cpp, java, ruby
@@ -29,7 +29,7 @@ jobs:
     # Autobuild attempts to build any compiled languages (C/C++, C#, Go, or Java).
     # If this step fails, then you should remove it and run the build manually (see below).
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v3
+      uses: github/codeql-action/autobuild@v2
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -43,4 +43,4 @@ jobs:
     #     make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v3
+      uses: github/codeql-action/analyze@v2

.github/workflows/issue-opened-workflow.yml

@@ -14,3 +14,9 @@ jobs:
     - name: add_assignees
       run: |
         curl -X POST -H "Accept: application/vnd.github+json" -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN}}" https://api.github.com/repos/${{github.repository}}/issues/${{ github.event.issue.number}}/assignees -d '{"assignees":["${{steps.oncall.outputs.CURRENT}}"]}'
+
+    - uses: actions/add-to-project@v0.4.0
+      name: Add to Project Board
+      with:
+        project-url: https://github.com/orgs/actions/projects/12                       
+        github-token: ${{ secrets.CACHE_BOARD_TOKEN }}

.github/workflows/pr-opened-workflow.yml

@@ -18,3 +18,9 @@ jobs:
     - name: Add Assignee
       run: |
         curl -X POST -H "Accept: application/vnd.github+json" -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN}}" https://api.github.com/repos/${{github.repository}}/issues/${{ github.event.pull_request.number}}/assignees -d '{"assignees":["${{steps.oncall.outputs.CURRENT}}"]}'    
+
+    - uses: actions/add-to-project@v0.4.0
+      name: Add to Project Board
+      with:
+        project-url: https://github.com/orgs/actions/projects/12                       
+        github-token: ${{ secrets.CACHE_BOARD_TOKEN }}

.github/workflows/publish-immutable-actions.yml

@@ -1,20 +0,0 @@
-name: 'Publish Immutable Action Version'
-
-on:
-  release:
-    types: [published]
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      id-token: write
-      packages: write
-
-    steps:
-      - name: Checking out
-        uses: actions/checkout@v4
-      - name: Publish
-        id: publish
-        uses: actions/publish-immutable-action@0.0.3

.github/workflows/release-new-action-version.yml

@@ -1,28 +0,0 @@
-name: Release new action version
-on:
-  release:
-    types: [released]
-  workflow_dispatch:
-    inputs:
-      TAG_NAME:
-        description: 'Tag name that the major tag will point to'
-        required: true
-
-env:
-  TAG_NAME: ${{ github.event.inputs.TAG_NAME || github.event.release.tag_name }}
-permissions:
-  contents: write
-
-jobs:
-  update_tag:
-    name: Update the major tag to include the ${{ github.event.inputs.TAG_NAME || github.event.release.tag_name }} changes
-    environment:
-      name: releaseNewActionVersion
-    runs-on: ubuntu-latest
-    steps:
-    - name: Update the ${{ env.TAG_NAME }} tag
-      id: update-major-tag
-      uses: actions/publish-action@v0.3.0
-      with:
-        source-tag: ${{ env.TAG_NAME }}
-        slack-webhook: ${{ secrets.SLACK_WEBHOOK }}

.github/workflows/workflow.yml

@@ -20,11 +20,11 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
     - name: Checkout
-      uses: actions/checkout@v4
+      uses: actions/checkout@v3
-    - name: Setup Node.js 20.x
+    - name: Setup Node.js 16.x
-      uses: actions/setup-node@v4
+      uses: actions/setup-node@v3
       with:
-        node-version: 20.x
+        node-version: 16.x
         cache: npm
     - run: npm ci
     - name: Prettier Format Check
@@ -43,7 +43,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
     - name: Checkout
-      uses: actions/checkout@v4
+      uses: actions/checkout@v3
     - name: Generate files in working directory
       shell: bash
       run: __tests__/create-cache-files.sh ${{ runner.os }} test-cache
@@ -66,7 +66,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
     - name: Checkout
-      uses: actions/checkout@v4
+      uses: actions/checkout@v3
     - name: Restore cache
       uses: ./
       with:
@@ -96,7 +96,7 @@ jobs:
       https_proxy: http://squid-proxy:3128
     steps:
     - name: Checkout
-      uses: actions/checkout@v4
+      uses: actions/checkout@v3
     - name: Generate files
       run: __tests__/create-cache-files.sh proxy test-cache
     - name: Save cache
@@ -119,7 +119,7 @@ jobs:
       https_proxy: http://squid-proxy:3128
     steps:
     - name: Checkout
-      uses: actions/checkout@v4
+      uses: actions/checkout@v3
     - name: Restore cache
       uses: ./
       with:

.licensed.yml

@@ -13,10 +13,4 @@ allowed:
 
 reviewed:
   npm:
-  - sax
+  - sax
-  - "@protobuf-ts/plugin-framework" # Apache-2.0
-  - "@protobuf-ts/runtime" # Apache-2.0
-  - fs.realpath # ISC
-  - glob # ISC
-  - prettier # MIT
-  - lodash # MIT

README.md

@@ -3,7 +3,6 @@
 This action allows caching dependencies and build outputs to improve workflow execution time.
 
 >Two other actions are available in addition to the primary `cache` action:
->
 >* [Restore action](./restore/README.md)
 >* [Save action](./save/README.md)
 
@@ -15,31 +14,9 @@ See ["Caching dependencies to speed up workflows"](https://docs.github.com/en/ac
 
 ## What's New
 
-### ⚠️ Important changes
-
-The cache backend service has been rewritten from the ground up for improved performance and reliability. [actions/cache](https://github.com/actions/cache) now integrates with the new cache service (v2) APIs.
-
-The new service will gradually roll out as of **February 1st, 2025**. The legacy service will also be sunset on the same date. Changes in these release are **fully backward compatible**.
-
-**We are deprecating some versions of this action**. We recommend upgrading to version `v4` or `v3` as soon as possible before **February 1st, 2025.** (Upgrade instructions below).
-
-If you are using pinned SHAs, please use the SHAs of versions `v4.2.0` or `v3.4.0`
-
-If you do not upgrade, all workflow runs using any of the deprecated [actions/cache](https://github.com/actions/cache) will fail.
-
-Upgrading to the recommended versions will not break your workflows.
-
-Read more about the change & access the migration guide: [reference to the announcement](https://github.com/actions/cache/discussions/1510).
-
-### v4
-
-* Integrated with the new cache service (v2) APIs.
-* Updated to node 20
-
 ### v3
 
 * Added a workaround to allow updating/refreshing existing caches, via the `refresh-cache` option and requiring a valid Github API token.
-* Integrated with the new cache service (v2) APIs.
 * Added support for caching in GHES 3.5+.
 * Fixed download issue for files > 2GB during restore.
 * Updated the minimum runner version support from node 12 -> node 16.
@@ -73,7 +50,7 @@ If you are using a `self-hosted` Windows runner, `GNU tar` and `zstd` are requir
 
 * `key` - An explicit key for a cache entry. See [creating a cache key](#creating-a-cache-key).
 * `path` - A list of files, directories, and wildcard patterns to cache and restore. See [`@actions/glob`](https://github.com/actions/toolkit/tree/main/packages/glob) for supported patterns.
-* `restore-keys` - An ordered multiline string listing the prefix-matched keys, that are used for restoring stale cache if no cache hit occurred for key.
+* `restore-keys` - An ordered list of prefix-matched keys to use for restoring stale cache if no cache hit occurred for key.
 * `enableCrossOsArchive` - An optional boolean when enabled, allows Windows runners to save or restore caches that can be restored or saved respectively on other platforms. Default: `false`
 * `fail-on-cache-miss` - Fail the workflow if cache entry is not found. Default: `false`
 * `lookup-only` - If true, only checks if cache entry exists and skips download. Does not change save cache behavior. Default: `false`
@@ -86,9 +63,9 @@ If you are using a `self-hosted` Windows runner, `GNU tar` and `zstd` are requir
 
 ### Outputs
 
-* `cache-hit` - A string value to indicate an exact match was found for the key.
+* `cache-hit` - A boolean value to indicate an exact match was found for the key.
-  * If there's a cache hit, this will be 'true' or 'false' to indicate if there's an exact match for `key`.
+
-  * If there's a cache miss, this will be an empty string.
+    > **Note** `cache-hit` will only be set to `true` when a cache hit occurs for the exact `key` match. For a partial key match via `restore-keys` or a cache miss, it will be set to `false`.
 
 See [Skipping steps based on cache-hit](#skipping-steps-based-on-cache-hit) for info on using this output
 
@@ -112,11 +89,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v3
 
     - name: Cache Primes
       id: cache-primes
-      uses: actions/cache@v4
+      uses: actions/cache@v3
       with:
         path: prime-numbers
         key: ${{ runner.os }}-primes
@@ -143,11 +120,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v3
 
     - name: Restore cached Primes
       id: cache-primes-restore
-      uses: actions/cache/restore@v4
+      uses: actions/cache/restore@v3
       with:
         path: |
           path/to/dependencies
@@ -158,7 +135,7 @@ jobs:
     .
     - name: Save Primes
       id: cache-primes-save
-      uses: actions/cache/save@v4
+      uses: actions/cache/save@v3
       with:
         path: |
           path/to/dependencies
@@ -179,7 +156,6 @@ Every programming language and framework has its own way of caching.
 
 See [Examples](examples.md) for a list of `actions/cache` implementations for use with:
 
-* [Bun](./examples.md#bun)
 * [C# - NuGet](./examples.md#c---nuget)
 * [Clojure - Lein Deps](./examples.md#clojure---lein-deps)
 * [D - DUB](./examples.md#d---dub)
@@ -213,7 +189,7 @@ A cache key can include any of the contexts, functions, literals, and operators
 For example, using the [`hashFiles`](https://docs.github.com/en/actions/learn-github-actions/expressions#hashfiles) function allows you to create a new cache when dependencies change.
 
 ```yaml
-  - uses: actions/cache@v4
+  - uses: actions/cache@v3
     with:
       path: |
         path/to/dependencies
@@ -231,7 +207,7 @@ Additionally, you can use arbitrary command output in a cache key, such as a dat
       echo "date=$(/bin/date -u "+%Y%m%d")" >> $GITHUB_OUTPUT
     shell: bash
 
-  - uses: actions/cache@v4
+  - uses: actions/cache@v3
     with:
       path: path/to/dependencies
       key: ${{ runner.os }}-${{ steps.get-date.outputs.date }}-${{ hashFiles('**/lockfiles') }}
@@ -251,9 +227,9 @@ Example:
 
 ```yaml
 steps:
-  - uses: actions/checkout@v4
+  - uses: actions/checkout@v3
 
-  - uses: actions/cache@v4
+  - uses: actions/cache@v3
     id: cache
     with:
       path: path/to/dependencies
@@ -281,11 +257,11 @@ jobs:
   build-linux:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
 
       - name: Cache Primes
         id: cache-primes
-        uses: actions/cache@v4
+        uses: actions/cache@v3
         with:
           path: prime-numbers
           key: primes
@@ -296,7 +272,7 @@ jobs:
 
       - name: Cache Numbers
         id: cache-numbers
-        uses: actions/cache@v4
+        uses: actions/cache@v3
         with:
           path: numbers
           key: primes
@@ -308,11 +284,11 @@ jobs:
   build-windows:
     runs-on: windows-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
 
       - name: Cache Primes
         id: cache-primes
-        uses: actions/cache@v4
+        uses: actions/cache@v3
         with:
           path: prime-numbers
           key: primes

RELEASES.md

@@ -1,86 +1,77 @@
 # Releases
 
-### 4.2.0
+### 3.0.0
 
-TLDR; The cache backend service has been rewritten from the ground up for improved performance and reliability. [actions/cache](https://github.com/actions/cache) now integrates with the new cache service (v2) APIs.
+- Updated minimum runner version support from node 12 -> node 16
 
-The new service will gradually roll out as of **February 1st, 2025**. The legacy service will also be sunset on the same date. Changes in these release are **fully backward compatible**.
+### 3.0.1
 
-**We are deprecating some versions of this action**. We recommend upgrading to version `v4` or `v3` as soon as possible before **February 1st, 2025.** (Upgrade instructions below).
+- Added support for caching from GHES 3.5.
+- Fixed download issue for files > 2GB during restore.
 
-If you are using pinned SHAs, please use the SHAs of versions `v4.2.0` or `v3.4.0`
+### 3.0.2
 
-If you do not upgrade, all workflow runs using any of the deprecated [actions/cache](https://github.com/actions/cache) will fail.
+- Added support for dynamic cache size cap on GHES.
 
-Upgrading to the recommended versions will not break your workflows.
+### 3.0.3
 
-### 4.1.2
+- Fixed avoiding empty cache save when no files are available for caching. ([issue](https://github.com/actions/cache/issues/624))
 
-- Add GitHub Enterprise Cloud instances hostname filters to inform API endpoint choices - [#1474](https://github.com/actions/cache/pull/1474)
+### 3.0.4
-- Security fix: Bump braces from 3.0.2 to 3.0.3 - [#1475](https://github.com/actions/cache/pull/1475)
 
-### 4.1.1
+- Fixed tar creation error while trying to create tar with path as `~/` home folder on `ubuntu-latest`. ([issue](https://github.com/actions/cache/issues/689))
 
-- Restore original behavior of `cache-hit` output - [#1467](https://github.com/actions/cache/pull/1467)
+### 3.0.5
 
-### 4.1.0
+- Removed error handling by consuming actions/cache 3.0 toolkit, Now cache server error handling will be done by toolkit. ([PR](https://github.com/actions/cache/pull/834))
 
-- Ensure `cache-hit` output is set when a cache is missed - [#1404](https://github.com/actions/cache/pull/1404)
+### 3.0.6
-- Deprecate `save-always` input - [#1452](https://github.com/actions/cache/pull/1452)
 
-### 4.0.2
+- Fixed [#809](https://github.com/actions/cache/issues/809) - zstd -d: no such file or directory error
+- Fixed [#833](https://github.com/actions/cache/issues/833) - cache doesn't work with github workspace directory
 
-- Fixed restore `fail-on-cache-miss` not working.
+### 3.0.7
 
-### 4.0.1
+- Fixed [#810](https://github.com/actions/cache/issues/810) - download stuck issue. A new timeout is introduced in the download process to abort the download if it gets stuck and doesn't finish within an hour.
 
-- Updated `isGhes` check
+### 3.0.8
 
-### 4.0.0
+- Fix zstd not working for windows on gnu tar in issues [#888](https://github.com/actions/cache/issues/888) and [#891](https://github.com/actions/cache/issues/891).
+- Allowing users to provide a custom timeout as input for aborting download of a cache segment using an environment variable `SEGMENT_DOWNLOAD_TIMEOUT_MINS`. Default is 60 minutes.
 
-- Updated minimum runner version support from node 12 -> node 20
+### 3.0.9
 
-### 3.4.0
+- Enhanced the warning message for cache unavailablity in case of GHES.
 
-- Integrated with the new cache service (v2) APIs
+### 3.0.10
 
-### 3.3.3
+- Fix a bug with sorting inputs.
+- Update definition for restore-keys in README.md
 
-- Updates @actions/cache to v3.2.3 to fix accidental mutated path arguments to `getCacheVersion` [actions/toolkit#1378](https://github.com/actions/toolkit/pull/1378)
+### 3.0.11
-- Additional audit fixes of npm package(s)
 
-### 3.3.2
+- Update toolkit version to 3.0.5 to include `@actions/core@^1.10.0`
+- Update `@actions/cache` to use updated `saveState` and `setOutput` functions from `@actions/core@^1.10.0`
 
-- Fixes bug with Azure SDK causing blob downloads to get stuck.
+### 3.1.0-beta.1
 
-### 3.3.1
+- Update `@actions/cache` on windows to use gnu tar and zstd by default and fallback to bsdtar and zstd if gnu tar is not available. ([issue](https://github.com/actions/cache/issues/984))
 
-- Reduced segment size to 128MB and segment timeout to 10 minutes to fail fast in case the cache download is stuck.
+### 3.1.0-beta.2
 
-### 3.3.0
+- Added support for fallback to gzip to restore old caches on windows.
 
-- Added option to lookup cache without downloading it.
+### 3.1.0-beta.3
 
-### 3.2.6
+- Bug fixes for bsdtar fallback if gnutar not available and gzip fallback if cache saved using old cache action on windows.
 
-- Fix zstd not being used after zstd version upgrade to 1.5.4 on hosted runners.
+### 3.2.0-beta.1
 
-### 3.2.5
+- Added two new actions - [restore](restore/action.yml) and [save](save/action.yml) for granular control on cache.
 
-- Added fix to prevent from setting MYSYS environment variable globally.
+### 3.2.0
 
-### 3.2.4
+- Released the two new actions - [restore](restore/action.yml) and [save](save/action.yml) for granular control on cache
-
-- Added option to fail job on cache miss.
-
-### 3.2.3
-
-- Support cross os caching on Windows as an opt-in feature.
-- Fix issue with symlink restoration on Windows for cross-os caches.
-
-### 3.2.2
-
-- Reverted the changes made in 3.2.1 to use gnu tar and zstd by default on windows.
 
 ### 3.2.1
 
@@ -88,75 +79,31 @@ Upgrading to the recommended versions will not break your workflows.
 - Added support for fallback to gzip to restore old caches on windows.
 - Added logs for cache version in case of a cache miss.
 
-### 3.2.0
+### 3.2.2
 
-- Released the two new actions - [restore](restore/action.yml) and [save](save/action.yml) for granular control on cache
+- Reverted the changes made in 3.2.1 to use gnu tar and zstd by default on windows.
 
-### 3.2.0-beta.1
+### 3.2.3
 
-- Added two new actions - [restore](restore/action.yml) and [save](save/action.yml) for granular control on cache.
+- Support cross os caching on Windows as an opt-in feature.
+- Fix issue with symlink restoration on Windows for cross-os caches.
 
-### 3.1.0-beta.3
+### 3.2.4
 
-- Bug fixes for bsdtar fallback if gnutar not available and gzip fallback if cache saved using old cache action on windows.
+- Added option to fail job on cache miss.
 
-### 3.1.0-beta.2
+### 3.2.5
 
-- Added support for fallback to gzip to restore old caches on windows.
+- Added fix to prevent from setting MYSYS environment variable globally.
 
-### 3.1.0-beta.1
+### 3.2.6
 
-- Update `@actions/cache` on windows to use gnu tar and zstd by default and fallback to bsdtar and zstd if gnu tar is not available. ([issue](https://github.com/actions/cache/issues/984))
+- Fix zstd not being used after zstd version upgrade to 1.5.4 on hosted runners.
 
-### 3.0.11
+### 3.3.0
 
-- Update toolkit version to 3.0.5 to include `@actions/core@^1.10.0`
+- Added option to lookup cache without downloading it.
-- Update `@actions/cache` to use updated `saveState` and `setOutput` functions from `@actions/core@^1.10.0`
 
-### 3.0.10
+### 3.3.1
 
-- Fix a bug with sorting inputs.
+- Reduced segment size to 128MB and segment timeout to 10 minutes to fail fast in case the cache download is stuck.
-- Update definition for restore-keys in README.md
-
-### 3.0.9
-
-- Enhanced the warning message for cache unavailablity in case of GHES.
-
-### 3.0.8
-
-- Fix zstd not working for windows on gnu tar in issues [#888](https://github.com/actions/cache/issues/888) and [#891](https://github.com/actions/cache/issues/891).
-- Allowing users to provide a custom timeout as input for aborting download of a cache segment using an environment variable `SEGMENT_DOWNLOAD_TIMEOUT_MINS`. Default is 60 minutes.
-
-### 3.0.7
-
-- Fixed [#810](https://github.com/actions/cache/issues/810) - download stuck issue. A new timeout is introduced in the download process to abort the download if it gets stuck and doesn't finish within an hour.
-
-### 3.0.6
-
-- Fixed [#809](https://github.com/actions/cache/issues/809) - zstd -d: no such file or directory error
-- Fixed [#833](https://github.com/actions/cache/issues/833) - cache doesn't work with github workspace directory
-
-### 3.0.5
-
-- Removed error handling by consuming actions/cache 3.0 toolkit, Now cache server error handling will be done by toolkit. ([PR](https://github.com/actions/cache/pull/834))
-
-### 3.0.4
-
-- Fixed tar creation error while trying to create tar with path as `~/` home folder on `ubuntu-latest`. ([issue](https://github.com/actions/cache/issues/689))
-
-### 3.0.3
-
-- Fixed avoiding empty cache save when no files are available for caching. ([issue](https://github.com/actions/cache/issues/624))
-
-### 3.0.2
-
-- Added support for dynamic cache size cap on GHES.
-
-### 3.0.1
-
-- Added support for caching from GHES 3.5.
-- Fixed download issue for files > 2GB during restore.
-
-### 3.0.0
-
-- Updated minimum runner version support from node 12 -> node 16

__tests__/actionUtils.test.ts

@@ -1,5 +1,6 @@
 import * as cache from "@actions/cache";
 import * as core from "@actions/core";
+import { RequestError } from "@octokit/request-error";
 import nock from "nock";
 
 import { Events, RefKey } from "../src/constants";
@@ -9,10 +10,7 @@ import * as testUtils from "../src/utils/testUtils";
 jest.mock("@actions/core");
 jest.mock("@actions/cache");
 
-let pristineEnv: NodeJS.ProcessEnv;
-
 beforeAll(() => {
-    pristineEnv = process.env;
     nock.disableNetConnect();
     jest.spyOn(core, "getInput").mockImplementation((name, options) => {
         return jest.requireActual("@actions/core").getInput(name, options);
@@ -22,9 +20,7 @@ beforeAll(() => {
     });
 });
 
-beforeEach(() => {
+afterEach(() => {
-    jest.resetModules();
-    process.env = pristineEnv;
     delete process.env[Events.Key];
     delete process.env[RefKey];
     delete process.env["GITHUB_REPOSITORY"];
@@ -33,7 +29,6 @@ beforeEach(() => {
 });
 
 afterAll(() => {
-    process.env = pristineEnv;
     testUtils.mockServer.close();
     nock.enableNetConnect();
 });
@@ -213,7 +208,7 @@ test("getInputAsBool throws if required and value missing", () => {
     ).toThrowError();
 });
 
-test("deleteCacheByKey produces 'HttpError: 404' when cache is not found.", async () => {
+test("deleteCacheByKey returns 'HttpError: 404' when cache is not found.", async () => {
     const event = Events.Push;
 
     process.env["GITHUB_REPOSITORY"] = "owner/repo";
@@ -231,73 +226,14 @@ test("deleteCacheByKey produces 'HttpError: 404' when cache is not found.", asyn
     expect(logWarningMock).toHaveBeenCalledWith(
         expect.stringMatching(/404: Not Found/i)
     );
-    expect(response).toBe(undefined);
+    expect(response).toBeInstanceOf(RequestError);
+    expect(response).toMatchObject({
+        name: "HttpError",
+        status: 404
+    });
 });
 
-test("deleteCacheByKey does not delete anything if it finds more than one entry for the given key.", async () => {
+test("deleteCacheByKey returns 'HttpError: 401' on an invalid non-mocked request.", async () => {
-    const event = Events.Push;
-
-    process.env["GITHUB_REPOSITORY"] = "owner/repo";
-    process.env["GITHUB_TOKEN"] =
-        "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";
-    process.env["GITHUB_ACTION"] = "__owner___run-repo";
-    process.env[Events.Key] = event;
-    process.env[RefKey] = "";
-    const logWarningMock = jest.spyOn(actionUtils, "logWarning");
-    const response = await actionUtils.deleteCacheByKey(
-        testUtils.failureCacheKey,
-        "owner",
-        "repo"
-    );
-    expect(logWarningMock).toHaveBeenCalledWith(
-        `More than one cache entry found for key ${testUtils.failureCacheKey}`
-    );
-    expect(response).toBe(undefined);
-});
-
-test("deleteCacheByKey does not delete anything if the key matches a cache belonging to another ref.", async () => {
-    const event = Events.Push;
-
-    process.env["GITHUB_REPOSITORY"] = "owner/repo";
-    process.env["GITHUB_TOKEN"] =
-        "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";
-    process.env["GITHUB_ACTION"] = "__owner___run-repo";
-    process.env[Events.Key] = event;
-    process.env[RefKey] = "ref/heads/feature";
-    const logWarningMock = jest.spyOn(actionUtils, "logWarning");
-    const response = await actionUtils.deleteCacheByKey(
-        testUtils.wrongRefCacheKey,
-        "owner",
-        "repo"
-    );
-    expect(logWarningMock).toHaveBeenCalledWith(
-        `No cache entries for key ${testUtils.wrongRefCacheKey} belong to gitref ${process.env[RefKey]}.`
-    );
-    expect(response).toBe(undefined);
-});
-
-test("deleteCacheByKey produces 'HttpError: 404' when cache is not found.", async () => {
-    const event = Events.Push;
-
-    process.env["GITHUB_REPOSITORY"] = "owner/repo";
-    process.env["GITHUB_TOKEN"] =
-        "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";
-    process.env["GITHUB_ACTION"] = "__owner___run-repo";
-    process.env[Events.Key] = event;
-    process.env[RefKey] = "ref/heads/feature";
-    const logWarningMock = jest.spyOn(actionUtils, "logWarning");
-    const response = await actionUtils.deleteCacheByKey(
-        testUtils.failureCacheKey,
-        "owner",
-        "repo"
-    );
-    expect(logWarningMock).toHaveBeenCalledWith(
-        expect.stringMatching(/404: Not Found/i)
-    );
-    expect(response).toBe(undefined);
-});
-
-test("deleteCacheByKey produces 'HttpError: 401' on an invalid non-mocked request.", async () => {
     const event = Events.Push;
 
     process.env["GITHUB_REPOSITORY"] = "owner/repo";
@@ -316,11 +252,15 @@ test("deleteCacheByKey produces 'HttpError: 401' on an invalid non-mocked reques
     expect(logWarningMock).toHaveBeenCalledWith(
         expect.stringMatching(/401: Bad Credentials/i)
     );
-    expect(response).toBe(undefined);
+    expect(response).toBeInstanceOf(RequestError);
+    expect(response).toMatchObject({
+        name: "HttpError",
+        status: 401
+    });
     nock.disableNetConnect();
 });
 
-test("deleteCacheByKey returns 204 / No Content when successful.", async () => {
+test("deleteCacheByKey returns matched cache data when successful.", async () => {
     const event = Events.Push;
 
     process.env["GITHUB_REPOSITORY"] = "owner/repo";
@@ -330,13 +270,29 @@ test("deleteCacheByKey returns 204 / No Content when successful.", async () => {
     process.env[Events.Key] = event;
     process.env[RefKey] = "ref/heads/feature";
 
+    const expectedResponse = {
+        id: expect.any(Number),
+        ref: expect.any(String),
+        key: expect.any(String),
+        version: expect.any(String),
+        last_accessed_at: expect.any(String),
+        created_at: expect.any(String),
+        size_in_bytes: expect.any(Number)
+    };
     const logWarningMock = jest.spyOn(actionUtils, "logWarning");
     const response = await actionUtils.deleteCacheByKey(
         testUtils.successCacheKey,
         "owner",
         "repo"
     );
-    expect(response).toBe(204);
+    expect(response).toMatchObject({
+        data: expect.objectContaining({
+            total_count: expect.any(Number),
+            actions_caches: expect.arrayContaining([
+                expect.objectContaining(expectedResponse)
+            ])
+        })
+    });
     expect(logWarningMock).toHaveBeenCalledTimes(0);
 });
 
@@ -377,28 +333,3 @@ test("isCacheFeatureAvailable for ac disabled on dotcom", () => {
         delete process.env["GITHUB_SERVER_URL"];
     }
 });
-
-test("isGhes returns false when the GITHUB_SERVER_URL environment variable is not defined", async () => {
-    delete process.env["GITHUB_SERVER_URL"];
-    expect(actionUtils.isGhes()).toBeFalsy();
-});
-
-test("isGhes returns false when the GITHUB_SERVER_URL environment variable is set to github.com", async () => {
-    process.env["GITHUB_SERVER_URL"] = "https://github.com";
-    expect(actionUtils.isGhes()).toBeFalsy();
-});
-
-test("isGhes returns false when the GITHUB_SERVER_URL environment variable is set to a GitHub Enterprise Cloud-style URL", async () => {
-    process.env["GITHUB_SERVER_URL"] = "https://contoso.ghe.com";
-    expect(actionUtils.isGhes()).toBeFalsy();
-});
-
-test("isGhes returns false when the GITHUB_SERVER_URL environment variable has a .localhost suffix", async () => {
-    process.env["GITHUB_SERVER_URL"] = "https://mock-github.localhost";
-    expect(actionUtils.isGhes()).toBeFalsy();
-});
-
-test("isGhes returns true when the GITHUB_SERVER_URL environment variable is set to some other URL", async () => {
-    process.env["GITHUB_SERVER_URL"] = "https://src.onpremise.fabrikam.com";
-    expect(actionUtils.isGhes()).toBeTruthy();
-});

__tests__/restore.test.ts

@@ -3,7 +3,7 @@ import * as core from "@actions/core";
 import nock from "nock";
 
 import { Events, RefKey } from "../src/constants";
-import { restoreRun } from "../src/restoreImpl";
+import run from "../src/restore";
 import * as actionUtils from "../src/utils/actionUtils";
 import * as testUtils from "../src/utils/testUtils";
 
@@ -77,7 +77,7 @@ test("restore with no cache found", async () => {
             return Promise.resolve(undefined);
         });
 
-    await restoreRun();
+    await run();
 
     expect(restoreCacheMock).toHaveBeenCalledTimes(1);
     expect(restoreCacheMock).toHaveBeenCalledWith(
@@ -120,7 +120,7 @@ test("restore with restore keys and no cache found", async () => {
             return Promise.resolve(undefined);
         });
 
-    await restoreRun();
+    await run();
 
     expect(restoreCacheMock).toHaveBeenCalledTimes(1);
     expect(restoreCacheMock).toHaveBeenCalledWith(
@@ -162,7 +162,7 @@ test("restore with cache found for key", async () => {
             return Promise.resolve(key);
         });
 
-    await restoreRun();
+    await run();
 
     expect(restoreCacheMock).toHaveBeenCalledTimes(1);
     expect(restoreCacheMock).toHaveBeenCalledWith(
@@ -207,7 +207,7 @@ test("restore with cache found for restore key", async () => {
             return Promise.resolve(restoreKey);
         });
 
-    await restoreRun();
+    await run();
 
     expect(restoreCacheMock).toHaveBeenCalledTimes(1);
     expect(restoreCacheMock).toHaveBeenCalledWith(
@@ -252,7 +252,7 @@ test("Fail restore when fail on cache miss is enabled and primary + restore keys
             return Promise.resolve(undefined);
         });
 
-    await restoreRun();
+    await run();
 
     expect(restoreCacheMock).toHaveBeenCalledTimes(1);
     expect(restoreCacheMock).toHaveBeenCalledWith(
@@ -295,7 +295,7 @@ test("restore when fail on cache miss is enabled and primary key doesn't match r
             return Promise.resolve(restoreKey);
         });
 
-    await restoreRun();
+    await run();
 
     expect(restoreCacheMock).toHaveBeenCalledTimes(1);
     expect(restoreCacheMock).toHaveBeenCalledWith(
@@ -341,7 +341,7 @@ test("restore with fail on cache miss disabled and no cache found", async () =>
             return Promise.resolve(undefined);
         });
 
-    await restoreRun();
+    await run();
 
     expect(restoreCacheMock).toHaveBeenCalledTimes(1);
     expect(restoreCacheMock).toHaveBeenCalledWith(

__tests__/restoreImpl.test.ts

@@ -3,7 +3,7 @@ import * as core from "@actions/core";
 import nock from "nock";
 
 import { Events, Inputs, RefKey } from "../src/constants";
-import { restoreImpl } from "../src/restoreImpl";
+import run from "../src/restoreImpl";
 import { StateProvider } from "../src/stateProvider";
 import * as actionUtils from "../src/utils/actionUtils";
 import * as testUtils from "../src/utils/testUtils";
@@ -66,7 +66,7 @@ test("restore with invalid event outputs warning", async () => {
     const invalidEvent = "commit_comment";
     process.env[Events.Key] = invalidEvent;
     delete process.env[RefKey];
-    await restoreImpl(new StateProvider());
+    await run(new StateProvider());
     expect(logWarningMock).toHaveBeenCalledWith(
         `Event Validation Error: The event type ${invalidEvent} is not supported because it's not tied to a branch or tag ref.`
     );
@@ -82,7 +82,7 @@ test("restore without AC available should no-op", async () => {
     const restoreCacheMock = jest.spyOn(cache, "restoreCache");
     const setCacheHitOutputMock = jest.spyOn(core, "setOutput");
 
-    await restoreImpl(new StateProvider());
+    await run(new StateProvider());
 
     expect(restoreCacheMock).toHaveBeenCalledTimes(0);
     expect(setCacheHitOutputMock).toHaveBeenCalledTimes(1);
@@ -98,7 +98,7 @@ test("restore on GHES without AC available should no-op", async () => {
     const restoreCacheMock = jest.spyOn(cache, "restoreCache");
     const setCacheHitOutputMock = jest.spyOn(core, "setOutput");
 
-    await restoreImpl(new StateProvider());
+    await run(new StateProvider());
 
     expect(restoreCacheMock).toHaveBeenCalledTimes(0);
     expect(setCacheHitOutputMock).toHaveBeenCalledTimes(1);
@@ -125,7 +125,7 @@ test("restore on GHES with AC available ", async () => {
             return Promise.resolve(key);
         });
 
-    await restoreImpl(new StateProvider());
+    await run(new StateProvider());
 
     expect(restoreCacheMock).toHaveBeenCalledTimes(1);
     expect(restoreCacheMock).toHaveBeenCalledWith(
@@ -149,7 +149,7 @@ test("restore on GHES with AC available ", async () => {
 test("restore with no path should fail", async () => {
     const failedMock = jest.spyOn(core, "setFailed");
     const restoreCacheMock = jest.spyOn(cache, "restoreCache");
-    await restoreImpl(new StateProvider());
+    await run(new StateProvider());
     expect(restoreCacheMock).toHaveBeenCalledTimes(0);
     // this input isn't necessary for restore b/c tarball contains entries relative to workspace
     expect(failedMock).not.toHaveBeenCalledWith(
@@ -161,7 +161,7 @@ test("restore with no key", async () => {
     testUtils.setInput(Inputs.Path, "node_modules");
     const failedMock = jest.spyOn(core, "setFailed");
     const restoreCacheMock = jest.spyOn(cache, "restoreCache");
-    await restoreImpl(new StateProvider());
+    await run(new StateProvider());
     expect(restoreCacheMock).toHaveBeenCalledTimes(0);
     expect(failedMock).toHaveBeenCalledWith(
         "Input required and not supplied: key"
@@ -180,7 +180,7 @@ test("restore with too many keys should fail", async () => {
     });
     const failedMock = jest.spyOn(core, "setFailed");
     const restoreCacheMock = jest.spyOn(cache, "restoreCache");
-    await restoreImpl(new StateProvider());
+    await run(new StateProvider());
     expect(restoreCacheMock).toHaveBeenCalledTimes(1);
     expect(restoreCacheMock).toHaveBeenCalledWith(
         [path],
@@ -206,7 +206,7 @@ test("restore with large key should fail", async () => {
     });
     const failedMock = jest.spyOn(core, "setFailed");
     const restoreCacheMock = jest.spyOn(cache, "restoreCache");
-    await restoreImpl(new StateProvider());
+    await run(new StateProvider());
     expect(restoreCacheMock).toHaveBeenCalledTimes(1);
     expect(restoreCacheMock).toHaveBeenCalledWith(
         [path],
@@ -232,7 +232,7 @@ test("restore with invalid key should fail", async () => {
     });
     const failedMock = jest.spyOn(core, "setFailed");
     const restoreCacheMock = jest.spyOn(cache, "restoreCache");
-    await restoreImpl(new StateProvider());
+    await run(new StateProvider());
     expect(restoreCacheMock).toHaveBeenCalledTimes(1);
     expect(restoreCacheMock).toHaveBeenCalledWith(
         [path],
@@ -266,7 +266,7 @@ test("restore with no cache found", async () => {
             return Promise.resolve(undefined);
         });
 
-    await restoreImpl(new StateProvider());
+    await run(new StateProvider());
 
     expect(restoreCacheMock).toHaveBeenCalledTimes(1);
     expect(restoreCacheMock).toHaveBeenCalledWith(
@@ -307,7 +307,7 @@ test("restore with restore keys and no cache found", async () => {
             return Promise.resolve(undefined);
         });
 
-    await restoreImpl(new StateProvider());
+    await run(new StateProvider());
 
     expect(restoreCacheMock).toHaveBeenCalledTimes(1);
     expect(restoreCacheMock).toHaveBeenCalledWith(
@@ -347,7 +347,7 @@ test("restore with cache found for key", async () => {
             return Promise.resolve(key);
         });
 
-    await restoreImpl(new StateProvider());
+    await run(new StateProvider());
 
     expect(restoreCacheMock).toHaveBeenCalledTimes(1);
     expect(restoreCacheMock).toHaveBeenCalledWith(
@@ -389,7 +389,7 @@ test("restore with cache found for restore key", async () => {
             return Promise.resolve(restoreKey);
         });
 
-    await restoreImpl(new StateProvider());
+    await run(new StateProvider());
 
     expect(restoreCacheMock).toHaveBeenCalledTimes(1);
     expect(restoreCacheMock).toHaveBeenCalledWith(
@@ -430,7 +430,7 @@ test("restore with lookup-only set", async () => {
             return Promise.resolve(key);
         });
 
-    await restoreImpl(new StateProvider());
+    await run(new StateProvider());
 
     expect(restoreCacheMock).toHaveBeenCalledTimes(1);
     expect(restoreCacheMock).toHaveBeenCalledWith(
@@ -455,19 +455,3 @@ test("restore with lookup-only set", async () => {
     );
     expect(failedMock).toHaveBeenCalledTimes(0);
 });
-
-test("restore failure with earlyExit should call process exit", async () => {
-    testUtils.setInput(Inputs.Path, "node_modules");
-    const failedMock = jest.spyOn(core, "setFailed");
-    const restoreCacheMock = jest.spyOn(cache, "restoreCache");
-    const processExitMock = jest.spyOn(process, "exit").mockImplementation();
-
-    // call restoreImpl with `earlyExit` set to true
-    await restoreImpl(new StateProvider(), true);
-
-    expect(restoreCacheMock).toHaveBeenCalledTimes(0);
-    expect(failedMock).toHaveBeenCalledWith(
-        "Input required and not supplied: key"
-    );
-    expect(processExitMock).toHaveBeenCalledWith(1);
-});