Repository navigation
feat(run): list every command, config and env change of a cache miss - #961
Merged
wan9chi merged 1 commit intoNov 9, 2026
Merged
Conversation
fspy benchmarklinuxmacoswindows |
wan9chi
force-pushed
the
claude/dry-run-03-every-key-change
branch
2 times, most recently
from
November 7, 2026 11:59
e3fd6f4 to
62e016e
Compare
wan9chi
commented
Nov 7, 2026
| /// variants, then by name or path, then by how it changed. Env names | ||
| /// compare by the platform's rules, so on Windows a tool's `getEnv('a')` | ||
| /// and a query matching `A` name the same env. | ||
| fn order_key(&self) -> (u8, OrderName<'_>, u8) { |
Member
Author
There was a problem hiding this comment.
Can this replaced by deriving Ord/PartialOrd?
Member
Author
There was a problem hiding this comment.
Not without changing behaviour. Derived Ord would compare Env's EnvMismatch variant before the name, and File's kind before its path, so -v would no longer list files in path order. It also compares env names as bytes, while order_key uses EnvName's platform rules: on Windows probe_env and PROBE_ENV must sort together for dedup_by to list them once (env_changes_dedupe_by_platform_rules). Making derive work would mean reordering File's fields and reshaping Env around an EnvName key, which touches the display and JSON code, so I've kept order_key.
wan9chi
force-pushed
the
claude/dry-run-03-every-key-change
branch
from
November 7, 2026 14:54
62e016e to
d213e38
Compare
wan9chi
force-pushed
the
claude/dry-run-03-every-key-change
branch
from
November 7, 2026 15:06
d213e38 to
1c6931e
Compare
wan9chi
force-pushed
the
claude/dry-run-03-every-key-change
branch
from
November 7, 2026 17:18
1c6931e to
af53a83
Compare
wan9chi
force-pushed
the
claude/dry-run-03-every-key-change
branch
from
November 7, 2026 18:38
af53a83 to
74d91f8
Compare
A miss reported one reason. When an env var a tool tracks and a file
changed together, the summary named only the file. When a task's `input`
and `output` settings both changed, it named only `input`.
A miss is now `CacheMiss::Changed(Comparison { changes })`, which lists
every change to the command (program, args, cwd), the task's cache
settings (`input`, `output`, `untrackedEnv`) and its envs (`cache.env`,
tracked envs and tracked queries). Files still stop at the first change
the check finds. Changes are sorted by kind, then by name or path, and
duplicates, such as an env two tracked queries match, are dropped.
- The inline reason is the first change, so it changes only where the
kind order differs from the old priority, such as a program change
alongside an env change. Several env changes still read as
`envs 'A', 'B' changed`.
- The detailed summary prints one change per line, aligned under the
first, instead of `; `-joined spawn changes. An `output` change now
reads `output configuration changed` there, not `input ...`.
- The saved summary holds the list, so a `last-summary.json` from an
earlier version gets the existing "different version" message.
- Each tracked env and query is compared on its own, so one that can't be
compared, such as a value that isn't UTF-8, doesn't hide another's
change: once something changed, it's a miss, as before, not a failed
lookup.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
wan9chi
force-pushed
the
claude/dry-run-03-every-key-change
branch
from
November 9, 2026 10:43
74d91f8 to
ba4db44
Compare
wan9chi
added a commit
that referenced
this pull request
Nov 9, 2026
## Motivation Before starting a long run, there's no way to see which tasks would come from the cache and which would run, or why one would miss, without running them (#791, voidzero-dev/vite-plus#2848). [The dry-run RFC](https://github.com/voidzero-dev/vite-task/blob/main/docs/rfcs/dry-run.md) specifies `vp run --dry-run` for this. This is the first PR of the stack that implements it: the text output. The PRs above it add every change of a miss (#961), `-v` (#963), `--json` (#966, #967), `unknown` (#968) and `-vv` (#969). This supersedes #792 by @lifeiscontent, whose write-free lookup and test scenario it builds on, so it credits them as co-author. Closes #791. ## Changes `vp run --dry-run` plans the run and checks the cache as a real run does, the remote cache included, then prints each command's line and the summary. It runs nothing and records nothing. The cache is opened as in a real run, but no entry is written, a hit's outputs aren't downloaded or restored, and `last-summary.json` isn't written, so `--last-details` still shows the last real run. ``` $ vp run --dry-run test $ vtt print-file src/a.txt ◉ cache hit $ vtt print tested --- vp run: 1/2 cache hit (50%), nothing was run. ``` - A dry run goes through the real run's lookup and spawn path, which skips each step that would write or run: recording a local hit, downloading a remote hit, replaying a hit, and spawning the command. - Each line is a real run's, without `, executing` or `, replaying`, and with no blank line between commands. `--log` is ignored, since it only shapes task output: `--dry-run` and `--log` move from `RunFlags`, which selects tasks, to `RunCommand`, and resolve to a `RunMode` of `Real { log }` or `Dry`, so a dry run can't carry a log mode. - The summary follows a real run's rules, with "nothing was run" in place of the successful count and the time saved, and without the `--last-details` hint. The detailed summary (`-v`) has no ✓ or exit codes. Real run, unchanged: ``` vp run: 1/2 cache hit (50%), 2/2 successful. (Run `vp run --last-details` for full details) │ │ │ │ │ │ │ │ │ └─ tasks │ │ │ └─ tasks that succeeded │ │ └─ cache hit rate │ └─ tasks └─ cache hits ``` Dry run: ``` vp run: 1/2 cache hit (50%), nothing was run. │ │ │ │ │ └─ cache hit rate │ └─ tasks └─ cache hits ``` - A cache lookup error is printed under its command and stops the dry run, as it stops a real run, and both exit 1. Real runs stopped but exited 0 before, since the summary only counted tasks that started; a task that fails before it starts now fails the run. Otherwise a dry run exits 0 once planning succeeds. - A nested `vp run --dry-run` isn't inlined. It's started as a process that prints its own dry run, so an enclosing dry run doesn't start it. - Without a task, `--dry-run` is an error, like `vp run -v`. After the task name, it's passed to the task, like any other flag. - RFC: the summary and cache-error rules are written down, and the sentence about the first changed file being the first in path order is removed. Without `-v`, the file check stops at whichever changed file it finds first. 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Medium Risk** > Touches cache lookup, remote fetch, spawn, and exit-code paths across the runner; mistakes could skip real execution side effects or mis-report failures, though behavior is gated on `RunKind::Dry`. > > **Overview** > Adds **`vp run --dry-run`**, which plans the task graph and performs full cache lookups (including remote) but **does not** spawn processes, replay outputs, download remote archives, write cache entries, or persist `last-summary.json`. > > The CLI introduces **`RunMode`/`RunKind`**: `--dry-run` and `--log` move onto `RunCommand` (dry runs always use interleaved output). Execution and cache layers thread `RunKind` through lookup, spawn, and reporters so dry runs short-circuit after reporting cache status (`WouldSpawn` / `DryRun` not-updated reasons). > > **Output and summary** match a real run’s command lines and cache indicators, but omit `, executing` / `, replaying`, skip extra blank lines, use **“nothing was run”** instead of success/saved time, and omit the `--last-details` hint. **`-v`** detailed summaries drop exit icons and saved-time wording for hits. > > **Bugfix:** runs now **exit 1** when a task’s cache cannot be checked (e.g. DB unreadable), including failures before `start()`; nested `vp run --dry-run` is not inlined. Changelog and dry-run RFC/e2e snapshots document the behavior. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit 3010605. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> Co-authored-by: Aaron Reisman <aaron@lifeiscontent.net> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
fengmk2
added a commit
to voidzero-dev/vite-plus
that referenced
this pull request
Nov 11, 2026
Vite+ 1.6.0 caches `vp run` tasks that rewrite files they read, previews runs with `vp run --dry-run` and JSON output, lets `vp check --continue-on-error` report every failed check, and sets `VP_USER_AGENT` for the tools that `vp` starts. ### Features - `vp run` caches tasks that read files they also write, such as `tsdown --exports` rewriting `package.json` or `tsc --incremental` reading and writing `tsconfig.tsbuildinfo`. The files a task writes, and folders that hold only those files, may be missing on the next run, as on a fresh clone, and a cache hit restores them with the task's outputs, including the symbolic links the task created ([docs](https://viteplus.dev/guide/automatic-data-tracking#rebuildable-inputs)) ([vite-task#913](voidzero-dev/vite-task#913), [vite-task#914](voidzero-dev/vite-task#914), [vite-task#915](voidzero-dev/vite-task#915), [vite-task#916](voidzero-dev/vite-task#916), [vite-task#917](voidzero-dev/vite-task#917), [vite-task#918](voidzero-dev/vite-task#918)), by @wan9chi. - `vp run --dry-run` shows each command that a run would start and whether it would hit the cache, without running anything or writing to the cache. `vp run --json` prints every package and task in the workspace, and `vp run --dry-run --json` prints the run plan with each step's cache status, as one JSON document for scripts, CI, and coding agents. `vp run -v` lists every change behind a cache miss, including each changed input file, and `-vv` also lists the unchanged inputs and the outputs that a hit restores ([docs](https://viteplus.dev/guide/run#dry-runs-and-json-output)) ([vite-task#948](voidzero-dev/vite-task#948), [vite-task#960](voidzero-dev/vite-task#960), [vite-task#961](voidzero-dev/vite-task#961), [vite-task#963](voidzero-dev/vite-task#963), [vite-task#966](voidzero-dev/vite-task#966), [vite-task#967](voidzero-dev/vite-task#967), [vite-task#968](voidzero-dev/vite-task#968), [vite-task#969](voidzero-dev/vite-task#969)), by @wan9chi. - `vp check --continue-on-error` runs the remaining enabled checks after a failure, so one run reports formatting, lint, and type errors together, and exits with the status of the first failed check. Without the flag, `vp check` still stops at the first failed check ([#3367](#3367)), by @chbaefront. - `vp`, `vpr`, and `vpx` set `VP_USER_AGENT=vp/<version>` for their child processes, so tools can detect that Vite+ started them. When the global CLI delegates to a project's local CLI, the local version is reported ([docs](https://viteplus.dev/guide/global-cli#vp-user-agent)) ([#1958](#1958)), by @fengmk2. - First part of `VP_ENV_FORBIDDEN=1`, for systems such as NixOS that provide Node.js and package managers themselves: with it set, Vite+ never downloads a Node.js or package-manager version, shims and `vpx` use only the system tools on `PATH`, and installers and `vp upgrade` use the system `node` and `pnpm` for Vite+'s own dependencies. In this release, commands that delegate to a package manager, such as `vp install` and `vp run`, fail with `DisabledByEnvForbidden` while it is set. A follow-up change is planned to cover them and document the variable ([#3233](#3233)), by @myuron. - Upgrade the bundled Oxfmt and Oxlint ([#3416](#3416)), by @voidzero-guard[bot]: - `oxfmt@0.76.0` to `oxfmt@0.78.0`. Oxfmt formats Vue files with its own formatter instead of Prettier, so the output for Vue templates can change. It also fixes Tailwind class sorting in several layouts, Less escapes and `%` selectors, and TypeScript in Astro files. - `oxlint@1.91.0` to `oxlint@1.93.0` and `oxlint-tsgolint@7.0.2005` to `oxlint-tsgolint@7.0.2006`. `no-redeclare` gets an `ignoreDeclarationMerge` option, and `promise/prefer-catch` offers a suggestion. - Oxlint and Oxfmt resolve an unset or relative `root` in `vite.config.ts` from the directory of the config file instead of the current directory, so editor integrations in multi-root workspaces load the correct project. - Vite+ installs its own dependencies during setup and `vp upgrade` with `pnpm@10.34.9` (was `pnpm@10.34.7`). - The new Oxfmt and Oxlint can flag code that passed before. If your CI runs `vp check`, run `vp check --fix --continue-on-error` after you upgrade: it formats files, applies the available lint fixes, formats again, and reports every error that remains. For example, `unicorn/prefer-type-error` now also reports a `throw` in an `if` branch without braces, and this command rewrites it. ### Fixes & Enhancements - While a Vite+ spinner is visible, such as `Installing global packages` in `vp install -g`, Vite+ hides the cursor and discards typed keys. Pressing Enter no longer leaves copies of the spinner row, and typed text no longer runs in the shell after the command ends. Ctrl+C during a spinner now ends the command with the usual signal status instead of exit code 0, and the global package spinners show the elapsed time ([#3373](#3373), [#3417](#3417)), by @jong-kyung and @fengmk2. - `vp run` loads a package's `vite.config.*` only when the run reaches one of that package's tasks. A run in one package no longer waits for the configs of other packages, a broken config in another package no longer fails it, and `vp run <task>` in a package that does not define the task reports `Task "<task>" not found` instead of another package's config error ([vite-task#944](voidzero-dev/vite-task#944), [vite-task#988](voidzero-dev/vite-task#988)), by @wan9chi. - `vp run nope#build`, where no workspace package has the name `nope`, fails with `Package 'nope' not found in the workspace` and exits with code 1, instead of running nothing and exiting with code 0. A short name that matches several scoped packages fails as ambiguous ([vite-task#984](voidzero-dev/vite-task#984)), by @wan9chi. - Folder listings no longer skip entries named `dist`, so a `dist` folder that appears or disappears in a folder a task lists makes the next run a cache miss. Exclusions in a task's `input`, such as `"!dist/**"`, now also apply to the folders that the task lists. In a new monorepo from `vp create`, every task hits the cache from the third `vp run ready`, because the first build creates the `dist` folders ([vite-task#919](voidzero-dev/vite-task#919), [vite-task#941](voidzero-dev/vite-task#941)), by @wan9chi. - Fewer unnecessary cache misses and cache failures in `vp run`: on Windows, files that a task deletes or moves are no longer among its inputs. Tasks that read `node_modules/.vite/task-cache`, as Parcel and Gatsby do, hit the cache. A task that writes outside the workspace through `..`, like `cp -r dist ../site`, no longer fails with `Cache update failed` ([vite-task#937](voidzero-dev/vite-task#937), [vite-task#940](voidzero-dev/vite-task#940), [vite-task#980](voidzero-dev/vite-task#980)), by @wan9chi. - A cache hit restores the symbolic links that a task's `output` globs match as links, instead of dropping them ([vite-task#885](voidzero-dev/vite-task#885)), by @jasonkuhrt. - When several tasks become ready at the same time, `vp run` checks their cache entries in parallel, so cache hits start sooner ([vite-task#982](voidzero-dev/vite-task#982)), by @wan9chi. - On macOS, task commands that use `sh` or `bash` behave as on Linux: a `while read` loop with a redirect under `set -e` no longer exits the script, an `EXIT` trap sees the exit status, so a failed task is no longer reported as successful, and `$BASH` is set ([vite-task#939](voidzero-dev/vite-task#939)), by @lifeiscontent. - The helper files that `vp run` writes to the system temp directory go in one folder that only the current user can write to, such as `/tmp/vp_run-1000` on Linux. On Linux, a different Vite+ version run by another user no longer fails ([vite-task#947](voidzero-dev/vite-task#947), [vite-task#974](voidzero-dev/vite-task#974)), by @wan9chi. - A `getEnvs` query from `@voidzero-dev/vite-task-client` that matches every name (`{ prefix: '' }` or `*`) returns nothing and no longer adds every environment variable to the cache key ([vite-task#976](voidzero-dev/vite-task#976)), by @wan9chi. - `vp migrate` no longer writes package specs that the package manager cannot resolve, such as a `@vitest/*` `catalog:` reference without a catalog entry or a top-level catalog on Bun before 1.2.21. Bun projects with an empty `workspaces` field get catalog references, and child packages with a plain `vite-plus` range get the same concrete version as the root when the project cannot use catalogs ([#3397](#3397)), by @jong-kyung. - `vp create` uses the package manager version that `VP_PACKAGE_MANAGER` selects for the generated settings, the installation, and its summary. Standalone pnpm projects get `packages: ['.']` in an existing `pnpm-workspace.yaml` only for pnpm before 10.5.0 ([#3197](#3197)), by @evan-lc and @fengmk2. - `vp` sends a `User-Agent` header on all HTTP requests, so Node.js mirrors that reject requests without one, such as `mirrors.aliyun.com`, work ([#3425](#3425)), by @naokihaba. - `vp env pin` prints `Updated` when it overwrites an existing `.node-version` or `.nvmrc` file and `Created` when it writes a new one ([#3377](#3377)), by @CheHyeonYeong. ### Docs - Describe rebuildable inputs in the Automatic Data Tracking guide, and dry runs, JSON output, and `-vv` in the `vp run` guide ([#3419](#3419), [#3421](#3421)), by @wan9chi. ### Chore - Bump vite-task to `cb1ea8d`, with its user-facing changes listed above, and list `--dry-run`, `--json`, and `-vv` in `vp run --help` ([#3418](#3418)), by @wan9chi. - The daily dependency upgrade also updates the pnpm version that the installers pin, after it checks the release integrity ([#3407](#3407)), by @fengmk2. - Warm up the monorepo cache check in the `vp create` CI job under pnpm and Bun ([#3423](#3423)), by @wan9chi. - Remove an unused CI job that the required `done` check did not cover ([#3403](#3403)), by @jong-kyung. - Remove an incorrect comment about export pattern order in the CLI build script ([#3405](#3405)), by @alexicum. ### Bundled Versions | Tool | Version | Source | Changelog | | --------------- | ---------- | ---------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | vite | `8.3.7` | [`5def936`](vitejs/vite@5def936) | unchanged | | rolldown | `1.2.18` | [`f9a49d6`](rolldown/rolldown@f9a49d6) | unchanged | | oxc-node | `1.0.1` | [`7ff14c3`](oxc-project/oxc-node@7ff14c3) | unchanged | | tsdown | `0.23.4` | [npm](https://npmx.dev/package/tsdown/v/0.23.4) | unchanged | | vitest | `5.1.0` | [npm](https://npmx.dev/package/vitest/v/5.1.0) | unchanged | | oxlint | `1.93.0` | [npm](https://npmx.dev/package/oxlint/v/1.93.0) | [1.92.0](https://github.com/oxc-project/oxc/releases/tag/oxlint_v1.92.0), [1.93.0](https://github.com/oxc-project/oxc/releases/tag/oxlint_v1.93.0) | | oxlint-tsgolint | `7.0.2006` | [npm](https://npmx.dev/package/oxlint-tsgolint/v/7.0.2006) | [7.0.2006](https://github.com/oxc-project/tsgolint/releases/tag/v7.0.2006) | | oxfmt | `0.78.0` | [npm](https://npmx.dev/package/oxfmt/v/0.78.0) | [0.77.0](https://github.com/oxc-project/oxc/releases/tag/oxfmt_v0.77.0), [0.78.0](https://github.com/oxc-project/oxc/releases/tag/oxfmt_v0.78.0) | ### Upgrade ```bash vp upgrade ``` If `vp upgrade` must download Node.js and `VP_NODE_DIST_MIRROR` points to a mirror that rejects requests without a `User-Agent` header, such as `mirrors.aliyun.com`, unset it or point it to another mirror for this upgrade. The installed `vp` downloads Node.js and does not send the header yet. ### New Contributors @alexicum, @evan-lc, @CheHyeonYeong **Full Changelog**: v1.5.1...v1.6.0 --- For a stable release, complete the `HomebrewFormula/vp.rb` update after publication by merging the generated `release/homebrew-v1.6.0` PR. Merging this PR will trigger the release workflow. --------- Co-authored-by: voidzero-guard[bot] <278573678+voidzero-guard[bot]@users.noreply.github.com> Co-authored-by: MK (fengmk2) <fengmk2@gmail.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
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.
Motivation
A cache miss reports one reason. When an env var a tool tracks and a file changed together, the summary named only the file. When a task's
inputandoutputsettings changed together, it named onlyinput. To know whether reverting a change is enough for a hit, you need every change. The dry-run RFC lists command, config and env changes in full, and--dry-run --json(#966) will report them.Changes
A miss is now
CacheMiss::Changed(Comparison { changes }). It lists every change to:input,output,untrackedEnv;cache.env, tracked envs and tracked queries.Files still stop at the first change the check finds, until
-vchanges that in #963. Changes are sorted by kind, then by name or path. Duplicates, such as an env that two tracked queries match, are dropped.The inline reason is the first change. It changes only where the kind order differs from the old priority, such as a program change alongside an env change. Several env changes still read as
envs 'A', 'B' changed.The detailed summary prints one change per line, aligned under the first, instead of joining spawn changes with
;. Anoutputchange now readsoutput configuration changedthere, notinput configuration changed.Before:
After:
The saved summary holds the list, so
vp run --last-detailsgives alast-summary.jsonfrom an earlier version the existing "different version" message.Each tracked env and query is compared on its own. If one can't be compared, such as a value that isn't UTF-8, another's change still makes it a miss, as before, rather than a failed lookup.
🤖 Generated with Claude Code
Note
Medium Risk
Touches core cache validation and persisted summary format; behavior is clearer but miss detection and reporting paths changed across local and remote lookups.
Overview
Cache miss reporting now collects every difference between the current run and a stored entry, not only the first failure. Misses use
CacheMiss::Changedwith a sorted, deduplicatedVec<Change>covering command fields (program,args,cwd), cache settings (input,output,untrackedEnv), fingerprinted and runner-tracked env changes, and still at most one file change (first detected).User-facing output: the inline line uses the first change in kind order (multiple envs still collapse to
envs 'A', 'B' changed).vp run --verbose/--last-detailsprint each change on its own indented line instead of joining spawn deltas with;.outputchanges are labeled separately frominput.Implementation: validation, remote cache resolution, and post-run fingerprint checks were refactored to accumulate
Changevalues; persistedlast-summary.jsonstores the full list (older summaries no longer load cleanly). E2e fixtures cover combined input/output config and multi-env misses.Reviewed by Cursor Bugbot for commit ba4db44. Bugbot is set up for automated code reviews on this repo. Configure here.