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

オープン
  • 何か問題がありますか？
#926 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
32/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
rust, wasm
領域
build-system, cli, devtools

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.
主要言語
Rust
スター
485
フォーク
51
平均マージ
23時間 20分
マージ済み PR（30日）
56

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

voidzero-dev/vite-task のほかの issue

voidzero-dev/vite-task の issue をすべて見る

似ている issue

Rust の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。