uid index rebuilt per check and scripts re-read outside the per-run cache

Aperta
#126 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
1-2 giorni
Idoneità per principianti
48/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
godot, typescript

Direzione di ricerca

Start with src/project/files.ts:14-59 to understand the per-run read cache, then trace the listed call sites in src/scenes/validate.ts, uids.ts and scene-graph.ts. Add a projectReport test that counts fs.readFileSync calls, as suggested, and use it to check the acceptance criteria: each file is read at most once per report run and no module-global file cache remains.

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

Descrizione

performance severity: medium

Summary

The per-run "one walk, one read" index (#87) is bypassed in three places:

  • The uid index is rebuilt by each check.
  • Scripts are re-read in connection and registry checks.
  • scene-graph.ts keeps its own process-global script cache, which is never evicted.

On a modern Godot 4.4+ project, report performs about 17.9k file reads for 6.5k files.

Where

  • src/scenes/validate.ts:73-76, :184, :238, :315 (lazyUidIndex(root) is created separately in validateScenes, validateProjectConfig and validateRegistries)
  • src/scenes/uids.ts:16-31 (buildUidIndex walks the whole tree and reads every .tscn/.tres in full, only to use the first 512 characters)
  • src/scenes/scene-graph.ts:148-163 (scriptInfo: module-global scriptCache keyed by absolute path, validated by mtime and size, never evicted; one statSync per [connection])
  • src/scenes/validate.ts:233, :290-297, :333, :361 (project.godot, readClassName and registry .tres files are read with readFileSync instead of readSource)
  • Compare src/project/files.ts:14-59

Details

Measured on a synthetic project with 3000 .gd (each with a .uid sidecar), 300 .tscn and 200 registry .tres files, with run/main_scene="uid://...":

Read count Files Reads
.uid 3000 9000
.tscn 300 1200
.tres 200 800
.gd (validate-scenes) 3000 5700, plus 2701 statSync calls

readClassName reads the same script once per registry entry. Building the uid index alone costs about 1.4 s. Rebuilding it pushes report from about 22 s to about 25 s (roughly 12%).

The global scriptCache behaves differently from everything else in a long-lived MCP server. It holds entries for every project seen, and it misses edits that keep the same mtime and size.

Impact

report and project_report time grows with asset and connection counts, and is worst on Windows and network filesystems. New checks have to choose between three caching models.

Suggested fix

  1. Add a test that counts reads per projectReport (spy on fs.readFileSync) and records today's number.
  2. Memoise the uid index in the per-run index (keyed by cfg and root, like readSource), and read only the head of .tscn/.tres files, or reuse readSource content.
  3. Route scriptInfo, readClassName, project.godot and the registry .tres reads through readSource. Delete the module-global scriptCache, or move it into the per-run index.
  4. Lower the read count asserted in the step-1 test.

Acceptance criteria

  • Each file is read at most once per report run.
  • No module-global file cache remains.

Filed by repo-audit/full-audit at e836036. Severity: medium. Effort: M. audit-key: performance|src/scenes/validate.ts|lazyUidIndex

Lingua principale
TypeScript
Stelle
0
Fork
6
Merge medio
1g 21h
PR unite (30g)
8

Preparare l'ambiente

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 TMHSDigital/godot-correctness-mcp

Tutte le issue di TMHSDigital/godot-correctness-mcp

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.