microsoft / microsoft/TypeScript

createProgram calls host.getSourceFile multiple times

Open
#26,259 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Docs
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

TypeScript Version: 3.1.0-dev.20180807

Search Terms:

Repro

declare let oldProgram: ts.Program;
const originalHost = ts.createCompilerHost(true);
const host = {
  ... originalHost,
  getSourceFile(fileName, ...args) {
    console.log(fileName);
    return originalHost.getSoruceFile(fileName, ...args);
  }
const newProgram = ts.createProgram(oldProgram.getRootFileNames(), oldProgram.getCompilerOptions(), host, oldProgram);

Expected behavior:

Each fileName is logged once.

Actual behavior:

If structureIsReused !== Completely fileNames are logged twice: one time from tryReuseStructureFromOldProgram and another time from findSourceFile. That means these SourceFiles are requested multiple times. This is especially a problem with the default CompilerHost which has no caching. It therefore reads and parses each file multiple times, but only the last one is actually used.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the createProgram repro and trace the calls through tryReuseStructureFromOldProgram and findSourceFile. Verify the behavior with a logging CompilerHost, then ensure each fileName is requested once when reusing a non-complete old program without losing the expected SourceFile behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers, performance
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.