Added cache for some FS operations while compile #829
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,15 +14,23 @@ import { | |
| Webpack | ||
| } from './interfaces'; | ||
|
|
||
| export type Action = () => void; | ||
|
|
||
| export interface ServiceHostWhichMayBeCacheable { | ||
| servicesHost: typescript.LanguageServiceHost; | ||
| clearCache: Action | null; | ||
| } | ||
|
|
||
| /** | ||
| * Create the TypeScript language service | ||
| */ | ||
| export function makeServicesHost( | ||
| scriptRegex: RegExp, | ||
| log: logger.Logger, | ||
| loader: Webpack, | ||
| instance: TSInstance, | ||
| enableFileCaching: boolean | ||
| ): ServiceHostWhichMayBeCacheable { | ||
| const { | ||
| compiler, | ||
| compilerOptions, | ||
|
|
@@ -52,9 +60,12 @@ export function makeServicesHost( | |
| const moduleResolutionHost: ModuleResolutionHost = { | ||
| fileExists, | ||
| readFile: readFileWithFallback, | ||
| realpath: compiler.sys.realpath, | ||
| directoryExists: compiler.sys.directoryExists | ||
| }; | ||
|
|
||
| const clearCache = enableFileCaching ? addCache(moduleResolutionHost) : null; | ||
|
|
||
| // loader.context seems to work fine on Linux / Mac regardless causes problems for @types resolution on Windows for TypeScript < 2.3 | ||
| const getCurrentDirectory = () => loader.context; | ||
|
|
||
|
|
@@ -97,13 +108,15 @@ export function makeServicesHost( | |
| /** | ||
| * For @types expansion, these two functions are needed. | ||
| */ | ||
| directoryExists: moduleResolutionHost.directoryExists, | ||
|
|
||
| useCaseSensitiveFileNames: () => compiler.sys.useCaseSensitiveFileNames, | ||
|
|
||
| realpath: moduleResolutionHost.realpath, | ||
|
|
||
| // The following three methods are necessary for @types resolution from TS 2.4.1 onwards see: https://github.com/Microsoft/TypeScript/issues/16772 | ||
| fileExists: moduleResolutionHost.fileExists, | ||
| readFile: moduleResolutionHost.readFile, | ||
| readDirectory: compiler.sys.readDirectory, | ||
|
There was a problem hiding this comment. was there a reason that There was a problem hiding this comment. Nope. I didn't see this function in the profiler before and I don't think that it can reduce perf, but if you want - I can check and provide the stats. There was a problem hiding this comment. If you could check that'd be awesome. I'm currently working on tweaking the test packs so they can be made to work against a variety of There was a problem hiding this comment.
Unfortunately for now I'm away from work and cannot check it. I'll do it in next couple of days and will provide here results. There was a problem hiding this comment. @johnnyreilly I just checked |
||
|
|
||
| getCurrentDirectory, | ||
|
|
@@ -137,7 +150,7 @@ export function makeServicesHost( | |
| getCustomTransformers: () => instance.transformers | ||
| }; | ||
|
|
||
| return { servicesHost, clearCache }; | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -509,3 +522,49 @@ function populateDependencyGraphs( | |
| ] = true; | ||
| }); | ||
| } | ||
|
|
||
| function addCache(servicesHost: typescript.ModuleResolutionHost) { | ||
| const clearCacheFuncs: Action[] = []; | ||
|
|
||
| type CachedProperty = Extract< | ||
| keyof typescript.ModuleResolutionHost, | ||
| 'fileExists' | 'directoryExists' | 'realpath' | ||
| >; | ||
| const cachedProperties: CachedProperty[] = [ | ||
| 'fileExists', | ||
| 'directoryExists', | ||
| 'realpath' | ||
| ]; | ||
|
|
||
| cachedProperties.forEach((propertyToCache: CachedProperty) => { | ||
| const origFn = servicesHost[propertyToCache]; | ||
| if (origFn !== undefined) { | ||
| const cache = createCache<ReturnType<typeof origFn>>(origFn); | ||
| servicesHost[ | ||
| propertyToCache | ||
| ] = cache.cached as typescript.ModuleResolutionHost[CachedProperty]; | ||
| clearCacheFuncs.push(cache.clear); | ||
| } | ||
| }); | ||
|
|
||
| return () => clearCacheFuncs.forEach(clear => clear()); | ||
| } | ||
|
|
||
timocov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| function createCache<TOut>(func: (arg: string) => TOut) { | ||
| const cache = new Map<string, TOut>(); | ||
| return { | ||
| clear: () => { | ||
| cache.clear(); | ||
| }, | ||
| cached: (arg: string) => { | ||
| let res = cache.get(arg); | ||
| if (res !== undefined) { | ||
| return res; | ||
| } | ||
|
|
||
| res = func(arg); | ||
| cache.set(arg, res); | ||
| return res; | ||
| } | ||
| }; | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We didn't have
realpathbefore I think; I'm just curious; what is it used for?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To resolve path to original one. For example, if you have symlink.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah - we've had since we added symlink support here: https://github.com/TypeStrong/ts-loader/pull/774/files
We just didn't supply it to the
LanguageServiceHostuntil now though. I'm kind of surprised we didn't get a compilation error previously 🤔There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm, interesting. Perhaps microsoft/TypeScript#12020 (comment) (and the whole PR) is related to this.