Repository navigation
Description
Written by an AI agent (Claude) on behalf of @jasonkuhrt.
Remote caching is still unreleased (#820), and cache.remote is hidden from the public types until then (crates/vt_graph/src/config/user.rs:254-256 at a3c087a7, the revision Vite+ 1.4.0 pins). So this is a request for its shape while that can still change.
What happens
Every remote key starts with a header holding the cache schema version, std::env::consts::OS and std::env::consts::ARCH (crates/vt/src/session/cache/remote.rs:395-416). The module doc says: "Platforms share an endpoint's namespace, but their keys differ" (remote.rs:12-14).
So an entry that Linux CI stored is never fetched on a developer's Mac, even for a task whose outputs are the same everywhere, such as a code generator that runs on Node. No task can opt out.
The case that motivates it
Our CI runs on Linux and our developers use macOS. To share entries anyway, our server rewrites each key's header to a platform-free one on every fetch and store. That depends on the key's private encoding (wincode's layout of KeyHeader), and it treats every task as platform-independent, which is wrong for any task that isn't.
The ask
A remote setting on a task that shares its entries across platforms:
tasks: {
generate: {
command: 'node generate.ts',
cache: { remote: { crossPlatform: true } },
},
}remote takes true, false or an object, and true means {}.
What it means in each case:
- Its remote keys (
keyandsecondary_key) carry a header with emptyosandarchstrings. No platform Vite Task runs on has an empty name, so these keys can't equal any platform's. The schema version stays. - Decoding: a fallback match's key is decoded with the same header (
decode_key,remote.rs:418-423), so a fallback's miss reason still works. - The local cache is unaffected.
- A fetched entry is validated against the fetching machine's inputs, as every entry is.
- The rest of the key still has to match: the program, the arguments, the working directory, the environment, and the input and output globs. A task whose arguments hold absolute paths still won't share (Cache keys record absolute pnpm-store paths through
args, so built-in-tool verdicts cannot cross machines #717). - A task wrongly marked: if what makes its output platform-specific is something Vite Task tracks, such as a native binary read from the workspace, its entries never validate on the other platform. With one entry per key (#778), each platform's store also replaces the other's, so it hits less than it does today. If nothing it tracks differs (it branches on
process.platform, or runs a system binary outside the workspace), its entries validate and restore the other platform's outputs, as with any input a task doesn't track. That's why it's an opt-in declaration per task. - Turning it on or off changes the task's remote keys once.
- Default: off, so today's keys are unchanged.
Where it goes: encode_header (remote.rs:403-409) and decode_key take the task's setting, which lives in remote on EnabledCacheConfig (user.rs:246-256).
Alternatives considered
- Rewrite the header on the server, as we do today: it depends on a private encoding, and it applies to every task at once.
- A workspace-wide setting: that's too coarse, since a workspace usually has both kinds of task.
Metadata
Metadata
Assignees
Labels
Type
Fields
Priority
Activity