ts-loader icon indicating copy to clipboard operation
ts-loader copied to clipboard

TransformerFactory isn't re-called in webpack watch mode when using pure ts-loader without custom compiler (like ttypescript)

Open artem1458 opened this issue 1 year ago • 3 comments

Detailed Description

I'm writing typescript compiler plugin that is using ts.Program and ts.TypeChecker, when project is runned in webpack watch (serve) mode and without ttypescript compiler - TransformerFactory function is called only once (on the start of webpack process), it's causing problems, because ts.Program.getSourceFiles() always returning initial version of source files, same as ts.TypeChecker always referring to the initial version of project

Expected Behaviour

I see few possible solutions here:

  • Just call TransformerFactory function in watch mode with updated ts.Program instance. Possible problem here is that it could break existing transformers which rely on the fact that this TransformerFactory function will be called only once
  • Create a Proxy that will always refer to the "fresh" ts.Program. I don't see any problems here, because proxies is supported from Node.js >=6, and ts-loader is requires Node.js >=12

Actual Behaviour

TransformerFactory hold reference to the old (outdated) ts.Program instance, and since we're acquiring ts.TypeChecker from the ts.Program - we're also receiving outdated ts.TypeChecker

Steps to Reproduce the Problem

  1. Create transformer that requires access to the ts.Program and/or ts.TypeChecker
  2. Use ts-loader without any custom compilers (like ttypescript)
  3. Run webpack project in watch mode
  4. Make change in any project file. As an example - change type of class constructor property from string to number
  5. Call ts.Program.getSourceFiles() and find file in which change was made, or acquire ts.TypeChecker from the ts.Program, and try to use it to receive type of class constructor property
  6. Using ts.Program.getSourceFiles() check that file content is not changed (identical to initial content of the file)
  7. Using ts.TypeChecker check that type of class constructor property is not changed

Location of a Minimal Repository that Demonstrates the Issue.

https://github.com/artem1458/ts-loader-old-tsprogram-instance

Also, here is the video with reproducing

https://github.com/TypeStrong/ts-loader/assets/33227963/7731ac4e-7eb0-4781-8130-f7c24bdd09bb

artem1458 avatar Jun 15 '23 17:06 artem1458

@johnnyreilly Hey, just find out that everything works fine with getProgram function, but I think if it's expected behaviour - it should be documented

https://github.com/TypeStrong/ts-loader#getcustomtransformers

(program: Program, getProgram: () => Program) => { before?: TransformerFactory<SourceFile>[]; after?: TransformerFactory<SourceFile>[]; afterDeclarations?: TransformerFactory<SourceFile>[]; }

artem1458 avatar Jun 28 '23 13:06 artem1458

Would you like to document it?

johnnyreilly avatar Jun 28 '23 16:06 johnnyreilly

@johnnyreilly Sure!

artem1458 avatar Jul 04 '23 07:07 artem1458