Remote cache keys always include the OS and architecture, so a task whose outputs are the same on every platform can't share entries between macOS and Linux

Ouverte
  • Quelque chose ne va pas ?
#926 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
32/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Active
Stack technique
rust, wasm
Domaine
build-system, cli, devtools

Piste de recherche

Start with encode_header and decode_key in crates/vt/src/session/cache/remote.rs (around lines 395-423), which build the OS and ARCH header that every remote key carries. Then read EnabledCacheConfig in crates/vt_graph/src/config/user.rs (around lines 246-256) to see where a per-task remote setting would go. Done means a task with the setting gets keys with empty os and arch, while its fallback decoding and the local cache keep working. The issue also depends on the unreleased remote cache work in #820 and on the open design of keys in #778 and #717, so check those before starting.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

remote cache

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 (key and secondary_key) carry a header with empty os and arch strings. 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 (#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.
Langage dominant
Rust
Étoiles
485
Forks
51
Merge moyen
23 h 20 min
PR mergées (30 j)
56

Préparer son environnement

Ouvrir dans Codespaces

Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de voidzero-dev/vite-task

Toutes les issues de voidzero-dev/vite-task

Issues similaires

Plus d'issues Rust

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.