Handle file versioning little better in tsc --watch mode #21693
Conversation
sheetalkamat
force-pushed
the
fileChangeThroughDeleteAndCreate
branch
from
43eafb2
to
32b0352
Compare
This ensures that when file is deleted and re-created, the file version isnt same to ensure emits correctly Fixes #21444
sheetalkamat
force-pushed
the
fileChangeThroughDeleteAndCreate
branch
from
32b0352
to
2684784
Compare
| resolutionCache.invalidateResolutionOfFile(path); | ||
| if (isFileMissingOnHost(hostSourceFile)) { | ||
| // The next version, lets set it as presence unknown file | ||
| sourceFilesCache.set(path, { version: Number(hostSourceFile) + 1 }); |
There was a problem hiding this comment.
can we make it a number instead of a string since we are using it as a version?
There was a problem hiding this comment.
Done. Earlier i was wondering if i should do that given we do checks like if (hostSourceFile). But now that we have initial version starting at 1 makes it easier to do that switch
There was a problem hiding this comment.
so we do not need the call to Number?
| @@ -721,10 +744,10 @@ namespace ts { | |||
| // there was version update and new source file was created. | |||
| if (hostSourceFileInfo) { | |||
| // record the missing file paths so they can be removed later if watchers arent tracking them | |||
| if (isString(hostSourceFileInfo)) { | |||
| if (isFileMissingOnHost(hostSourceFileInfo)) { | |||
There was a problem hiding this comment.
these functions should return a user-defined type guards to avoid the casts below.
There was a problem hiding this comment.
In the line below the hostSourceFile could be FilePresenceUnknownOnHost or FileMayBePresentOnHost . It is kind of redundant to check if isFilePresentOnHost since it only checks if sourceFile is present on the host and the next check is going to check if sourceFile === oldSourceFile (oldSourceFile is never undefined). Hence the cast
|
I confirm it fixes #21444 |
|
@mhegazy Ready for merge pending your approval |
|
Please port to release-2.7 as well. |
|
Tested on a (slow) Windows 7 with quite a few corporate virus scanners running: Thanks for this fix! |
Root cause:
Earlier the source file cache use to either have { version, sourceFile, fileWatcher } or string.
string meant file is on present on the disk and we wont go ahead and create source file at all for these whenever asked for new source file.
During watch callback, especially during wild card directory callback, if the file wasnt present on the disk, we would just remove the entry from cache.. So in below sequence the file version didnt change even though the content had changed:
Fix:
Now whenever the file callback is invoked, and cache has file as missing, instead of removing the entry, we would create a temp entry that represents that file may be on the disk = { version++ }
This ensures that next time program is able to find the file on the disk and create new source file, it wont have initial version. Thus when creating new source file from oldProgram, if the file is changed, it would always have different version than the oldSourceFile from oldProgram.
Fixes #21444