Skip to content

perf: Fix caching in config loaders #19042

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nzakas merged 9 commits into from
Oct 28, 2024
Merged

perf: Fix caching in config loaders #19042

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
aa6d0bf
perf: Fix caching in `LegacyConfigLoader`
mdjermanovic Oct 22, 2024
1fae7b7
add comment
mdjermanovic Oct 22, 2024
f3005cb
refactor
mdjermanovic Oct 23, 2024
26a4c88
refactor
mdjermanovic Oct 23, 2024
39bbcad
fix caching in `ConfigLoader`
mdjermanovic Oct 23, 2024
3e88b9c
add test
mdjermanovic Oct 23, 2024
e4fb551
add test for `getCachedConfigArrayForPath`
mdjermanovic Oct 24, 2024
c8631a4
add unit tests, remove eslint tests
mdjermanovic Oct 25, 2024
8b1481e
update error messages for promises in sync methods
mdjermanovic Oct 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
refactor
  • Loading branch information
@mdjermanovic
mdjermanovic committed Oct 23, 2024
commit 26a4c88011573bb8a4d5163c113aaeacd16e35d5
28 changes: 12 additions & 16 deletions lib/config/config-loader.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -565,20 +565,14 @@ class LegacyConfigLoader extends ConfigLoader {
* The cached config file path for this instance.
* @type {Promise<{configFilePath:string,basePath:string}|undefined>}
*/
#configFilePathPromise;
#configFilePath;

/**
* The cached config array for this instance.
* @type {FlatConfigArray}
* @type {FlatConfigArray|Promise<FlatConfigArray>}
*/
#configArray;

/**
* The cached config array for this instance.
* @type {Promise<FlatConfigArray>}
*/
#configArrayPromise;

/**
* Creates a new instance.
* @param {ConfigLoaderOptions} options The options to use when loading configuration files.
Expand All @@ -597,15 +591,15 @@ class LegacyConfigLoader extends ConfigLoader {
* the config file.
*/
#locateConfigFileToUse() {
if (!this.#configFilePathPromise) {
this.#configFilePathPromise = locateConfigFileToUse({
if (!this.#configFilePath) {
this.#configFilePath = locateConfigFileToUse({
useConfigFile: this.#options.configFile,
cwd: this.#options.cwd,
allowTS: this.#options.allowTS
});
}

return this.#configFilePathPromise;
return this.#configFilePath;
}

/**
Expand All @@ -622,12 +616,10 @@ class LegacyConfigLoader extends ConfigLoader {
}

// ensure `calculateConfigArray` is called only once
if (!this.#configArrayPromise) {
this.#configArrayPromise = calculateConfigArray(configFilePath, basePath, this.#options);
}
this.#configArray = calculateConfigArray(configFilePath, basePath, this.#options);

// Cache the config array for this instance. This is primarely needed for the sync `getCachedConfigArrayForPath` method.
this.#configArray = await this.#configArrayPromise;
// Unwrap the promise. This is primarely for the sync `getCachedConfigArrayForPath` method.
this.#configArray = await this.#configArray;

return this.#configArray;
}
Expand Down Expand Up @@ -692,6 +684,10 @@ class LegacyConfigLoader extends ConfigLoader {
throw new Error(`Could not find config file for ${dirPath}`);
}

if (typeof this.#configArray.then === "function") {
throw new Error(`Config array for ${dirPath} has not yet been calculated`);
}

return this.#configArray;
}
}
Expand Down