feat: add path validation options to restore action#1761
Open
jasongin wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds client-side path validation wiring for cache restores, exposing new inputs to control validation strictness and how integrity failures are handled, alongside a toolkit upgrade and expanded test coverage.
Changes:
- Add new inputs
strict-pathsandfail-on-cache-invalid, forward them into@actions/cache.restoreCache, and handleCacheIntegrityError. - Upgrade
@actions/cachedependency and adjust Jest to work with the toolkit’s ESM-only packaging via a CJS stub. - Add/extend unit tests plus an E2E workflow and a detailed test plan for path validation.
Show a summary per file
| File | Description |
|---|---|
| tsconfig.json | Excludes __tests__ from TS compilation. |
| src/utils/testUtils.ts | Adds test helpers for new inputs. |
| src/utils/actionUtils.ts | Adds input parsing for strict-paths. |
| src/restoreImpl.ts | Forwards validation mode to toolkit and handles integrity errors. |
| src/constants.ts | Adds new input constants for the action. |
| restore/action.yml | Documents new inputs for the restore-only action. |
| restore/README.md | Documents new inputs and behavior. |
| package.json | Bumps action version and upgrades @actions/cache. |
| jest.config.js | Redirects @actions/cache imports to a local CJS stub for tests. |
| docs/path-validation-test-plan.md | Adds a test plan and local development notes for path validation. |
| action.yml | Documents new inputs for the main action. |
| tests/restoreOnly.test.ts | Updates restore-only tests to expect pathValidation. |
| tests/restoreImpl.test.ts | Adds/updates tests for pathValidation wiring and integrity handling. |
| tests/restore.test.ts | Updates restore tests to expect pathValidation. |
| tests/e2e/save-poisoned-cache.mjs | Adds helper to upload a “poisoned” cache during E2E runs. |
| tests/actionUtils.test.ts | Adds tests for getPathValidationInput(). |
| tests/mocks/actions-cache.ts | Adds a CJS-compatible stub surface for @actions/cache in Jest. |
| RELEASES.md | Adds 5.1.0 release notes for the new feature set. |
| README.md | Documents new inputs and their security implications. |
| .github/workflows/path-validation-e2e.yml | Adds a manual E2E workflow matrix for path validation behavior. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 18/25 changed files
- Comments generated: 7
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
feat: path validation for restored caches
Wires the new path validation from
@actions/cacheinto the action so workflows are protected against some forms of cache poisoning that plant archive entries (or symlink/hardlink targets) resolving outside the declaredpathinputs — e.g.../../etc/..., absolute paths, UNC paths, or symlinks pointing into the runner's workspace.The
actions/cacheaction defaults tostrict-paths: warnfor now, so existing workflows get logging automatically without any risk of change to cache extraction. Switching toerroropts into pre-extraction rejection of poisoned archives. We should plan to change the default toerrorin a future major-version update to the action.New inputs (on both
cacheandcache/restore)strict-pathsoff/warn/errorwarn(eventuallyerror)off= no path validation.warn= pre-scan, log a workflow warning, extract anyway.error= pre-scan, reject without extracting.fail-on-cache-invalidfalsestrict-paths: error.true→ fail the step.false→ treat the rejected cache as a cache miss (nocache-hitoutput, downstreamif:checks behave identically to a normal miss).Implementation
getPathValidationInput()parses and normalizes the input (case-insensitive, typo-safe fallback towarn).pathValidationin theDownloadOptionsobject passed tocache.restoreCache(...), and wraps the call in a try/catch:err.name === "CacheIntegrityError"+.coderead off the error object (intentionally notinstanceof, so the check survives the CJS/ESM stub seam between Jest and the bundled runtime).fail-on-cache-invalid: true→ rethrow as a decorated error.logWarningand return;cache-hitis deliberately left unset so the discard is indistinguishable from a normal cache miss.Inputsenum entries.setInputsplumbed for the new inputs.Dependency / version
@actions/cache:^5.0.5→^6.1.0(introduces the validation surface; brings intar@^7.5.15).Tests
getPathValidationInput(defaults, case folding, unknown-value fallback, env-var resolution).fail-on-cache-invalid→ rethrow, non-integrity errors propagate unchanged, parse-error and missing-.codevariants, and the assertion thatcache-hitis never set when an integrity error is rethrown.getPathValidationInputspied viajest.requireActual(the default auto-mock returnsundefined, which would silently pass thanks to deep-equality quirks).@actions/cache@6is ESM-only and Jest's CJS resolver can't load it directly. Production builds are fine (bundled by@vercel/ncc, which handles ESM deps), but tests need a CJS-compatible surface, so the PR adds tests/mocks/actions-cache.ts — a CJS stub wired up viamoduleNameMapperin jest.config.js. All types are re-exported from the real@actions/cachepackage viaimport type, and every runtime value is annotatedtypeof Cache.X, so any signature drift in the real package fails the build.E2E workflow
Added .github/workflows/path-validation-e2e.yml — a matrix that saves a legitimate cache, saves a poisoned one via the toolkit's internal APIs, and exercises all three
strict-pathsvalues across Ubuntu / macOS / Windows runners. Trigger isworkflow_dispatchonly, since the 39-job matrix is too expensive to run on every PR.Bundled dist
All four ncc bundles (restore, save,
restore-only,save-only) regenerated against the new toolkit. Diff is large but mechanical.Depends on
@actions/[email protected]from actions/toolkit#2414Follow-ups (not in this PR)
strict-pathsdefault fromwarntoerrorin a future major version.strict-paths: erroradoption guide for high-trust workflows.