[api-extractor] Reuse TypeScript's module-resolution results to avoid realpath/lstat storm when resolving external package names
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 52/100
- Tipo di issue
- Refactoring
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Tranquilla
- Stack tecnologico
- node.js, typescript
- Ambito
- performance, tooling
Direzione di ricerca
Start at DeclarationReferenceGenerator._getPackageName, then inspect Collector, AstSymbolTable, and TypeScriptInternals.ts for program-resolution access. Include module and type-reference resolutions, verify packageId and resolvedFileName matching, and run the acceptance-test projects to confirm byte-identical API reports while preserving the filesystem fallback.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Summary
During analysis, DeclarationReferenceGenerator._getPackageName(sourceFile) calls PackageJsonLookup.tryLoadNodePackageJsonFor(sourceFile.fileName) once per external source file. That path (PackageJsonLookup._tryLoadNodePackageJsonInner) calls FileSystem.getRealPath() (Node fs.realpathSync → an lstat per path segment, following symlinks) before the content cache can help, and the upward folder walk in _tryGetPackageFolderFor does it at each directory level. In pnpm workspaces (a node_modules symlink farm) this produces a large lstat storm and shows up as a significant chunk of api-extractor CPU time in profiles.
This was noticed while profiling the type-check optimization in https://github.com/microsoft/rushstack/pull/5891 — after removing the whole-program semantic check, realpathSync→lstat inside FileSystem.getRealPath → tryLoadNodePackageJsonFor was the next-largest chunk.
Insight
TypeScript already resolved every one of these modules during program construction and recorded the answer. Each ResolvedModuleFull carries:
resolvedFileName— the already-realpath'd target (TS paid thelstatcost once, cached), andpackageId.name— the bare package name, which is exactly what_getPackageNamereconstructs via the filesystem walk (packageId.subModuleNameholds the sub-path separately).
Proof of concept
Probing the @rushstack/mcp-server program via the (internal) program.forEachResolvedModule(cb):
resolutions: total=1111, withPackageId=1103, uniqueFiles=258
@modelcontextprotocol/sdk <= @modelcontextprotocol/sdk/dist/esm/server/mcp.d.ts
zod <= zod/index.d.cts
...
99.3% of resolutions carry packageId, and packageId.name came back as the bare package name even for non-index files.
Proposed design
- Build a
Map<resolvedFileName, packageId.name>once (e.g. offCollector/AstSymbolTable) via the internalprogram.forEachResolvedModule(...). Type-reference-directive resolutions (forEachResolvedTypeReferenceDirective) also carrypackageIdand should be included. - In
_getPackageName, consult the map first (keyed bysourceFile.fileName) — zero filesystem access for the common case. - Fall back to
tryLoadNodePackageJsonForon a miss (the ~0.7% withoutpackageId, or files reached via other means), preserving today's exact behavior.
forEachResolvedModule / getResolvedModule are TypeScript internals (not in the public .d.ts), but api-extractor already accesses TS internals via TypeScriptInternals.ts, so this is consistent with existing patterns.
Caveats to validate
packageId.namesemantics — the TS doc comment hints it may include a subpath in some cases; the PoC showed bare names, but this needs verification against@typespackages and deep imports vs. the existingpackageJson.namebehavior.- Key matching —
resolvedFileNamemust equal the program'ssourceFile.fileName(generally true;preserveSymlinksis the edge case). - Correctness — must produce byte-identical API reports across all acceptance-test projects. The fast-path-with-fallback design keeps this low-risk.
Related
- Follow-up to #5891 (type-check pass optimization).
- Also worth checking
SourceMapper.getRealPathusage for the same treatment.
- Lingua principale
- TypeScript
- Stelle
- 6.5k
- Fork
- 708
- Merge medio
- 4g 13h
- PR unite (30g)
- 62
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di microsoft/rushstack
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
Tutte le issue di microsoft/rushstack
Issue simili
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
-
Crush Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
catppuccin/catppuccin#3125 ·
-
Add a SECURITY.md Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
ElementsProject/cln-application#167 · 1 commento · 1 reazione ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
Quantco/pnpm-licenses#17 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100