Automatic output tracking misses files a task renames into place, so a cache hit restores nothing

Aperta
  • Qualcosa non va?
#908 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
node.js, rust
Ambito
build-system, tooling

Direzione di ricerca

Start with crates/fspy_preload_unix/src/interceptions/mod.rs to see how filesystem calls are intercepted, then read crates/vt/src/session/cache/archive.rs to understand how recorded outputs are archived. The issue calls out Linux rename, renameat, and renameat2, plus macOS rename and renameat; done means those renames record the destination so a cache hit restores the renamed file or folder contents.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Written by an AI agent (Claude) on behalf of @jasonkuhrt.

Problem

With automatic output tracking, the default when cache.output is omitted or holds { auto: true }, a task that writes its output somewhere else and then renames it into place gets a cache entry without that output. A cache hit then restores nothing.

Writing to a temporary path and renaming is the standard way to replace a file or a folder atomically. TanStack Router's generator writes its route tree this way: a temp file, then rename (safeFileWrite, router-generator/src/generator.ts L1203-L1277). Our own code generators stage a whole folder and rename it over the old one.

Reproduction on vite-plus 1.4.0, with no remote cache:

// vite.config.ts
import { defineConfig } from 'vite-plus';

export default defineConfig({
  run: {
    tasks: {
      generate: {
        command: 'node generate.mjs',
        cache: { input: ['generate.mjs'] },
      },
    },
  },
});

// generate.mjs: stages the output, then renames it into place
import { mkdirSync, renameSync, rmSync, writeFileSync } from 'node:fs';

rmSync('.staging', { recursive: true, force: true });
mkdirSync('.staging');
writeFileSync('.staging/a.ts', 'export const a = 1;\n');
rmSync('generated', { recursive: true, force: true });
renameSync('.staging', 'generated');

$ vp run generate
$ node generate.mjs
$ ls generated
a.ts

$ rm -rf generated
$ vp run generate
vp run: cache hit, 39ms saved.
$ ls generated
ls: generated: No such file or directory      # the hit restored nothing

Replacing the renameSync line with a direct writeFileSync('generated/a.ts', …) makes the same hit restore generated/a.ts.

Cause

fspy records the write to .staging/a.ts. It has no rename interception (fspy_preload_unix/src/interceptions/mod.rs covers access, dirent, open, spawn and stat), so generated/a.ts is never recorded. When outputs are archived, the recorded .staging/a.ts no longer exists and is skipped (archive.rs L29-L34), which leaves the entry empty.

The workaround today is a positive cache.output glob for the destination. But a glob archives whatever matches on disk, including files a previous run left there, so it gives up what automatic tracking gets right.

Proposal: cover the common case, leave the long tail to explicit config

Record a rename's destination as a write:

  • A file renamed to dst: dst is written.
  • A folder renamed to dst: every file under dst is written. These can be collected by walking dst when outputs are archived, instead of tracking each file inside.

Covering rename, renameat and renameat2 on Linux and rename and renameat on macOS should catch nearly every atomic-write tool, since that is how Node's fs.rename and most tools' atomic writers move files.

Deliberately out of scope, where users keep declaring cache.output:

  • RENAME_EXCHANGE;
  • moving files into place with link;
  • platforms or syscalls the interception layer doesn't reach yet.

Cross-filesystem moves need nothing, since they copy and so are already recorded as writes.

Related: #904 covers the cache-hit side, where a hit leaves behind files the cached run did not write.

Lingua principale
Rust
Stelle
485
Fork
51
Merge medio
1g 1h
PR unite (30g)
61

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di voidzero-dev/vite-task

Tutte le issue di voidzero-dev/vite-task

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.