Build crashes on files a plugin adds to event.files after the prepare phase

Aperta Adatta ai principianti
  • Qualcosa non va?
#1,806 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à
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
78/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
typescript
Ambito
build-system

Direzione di ricerca

Inizia in Program.build(), soprattutto nel ciclo di pulizia che chiama undoAll() su event.files dopo la serializzazione. Riproduci il problema aggiungendo un file tramite l’hook afterPrepareProgram documentato, quindi verifica che la build termini senza un TypeError. Il lavoro è completato quando i file aggiunti in ritardo non causano più il crash della pulizia.

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

Descrizione

Program.build() ends by undoing edits on every file it built:

for (const file of event.files) {
    file.editor.undoAll();
}

Editors are assigned during prepare(), so any file a plugin pushes onto event.files after that point has no editor, and the build throws TypeError: Cannot read properties of undefined (reading 'undoAll').

This is reachable from a supported hook. afterPrepareProgram receives event.files and is documented as mutable, but a file added there misses editor assignment and crashes the build it was added to.

Where I hit it: rooibos generates its code-coverage component from data collected during prepareFile, so it can't be registered any earlier than afterPrepareProgram. Working around it by assigning an editor ourselves:

const file = program.setFile(entry, contents);
file.editor ??= new Editor();

That works, but it depends on a build-internal detail that plugins shouldn't need to know about.

Suggested fix — either guard the cleanup loop:

file.editor?.undoAll();

or assign an editor in the same loop that serializes, so late additions are covered. The guard alone is enough to stop the crash.

Seen on 1.0.0-alpha.53; the cleanup loop is unguarded on master as well.

Lingua principale
TypeScript
Stelle
212
Fork
72
Merge medio
3g 3h
PR unite (30g)
63

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 rokucommunity/brighterscript

Tutte le issue di rokucommunity/brighterscript

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.