githubmirror/webpack

test/ConfigTestCases.template.js
646 строк19 KB
Alexander Akait
test: fail config cache tests when the filesystem cache fails (#21251)
23 июн 2026, 16:01
23 июн 2026, 16:01053f2dc
"use strict";

require("./helpers/warmup-webpack");

/** @typedef {Record<string, EXPECTED_ANY>} Env */
/** @typedef {{ testPath: string }} TestOptions */
/**
 * @typedef {object} SuiteConfig
 * @property {string} name suite name
 * @property {import("../").FileCacheOptions=} cache filesystem cache options
 */
/**
 * @typedef {object} TestConfig
 * @property {((i: number, options: import("../").Configuration) => string | undefined)=} findBundle
 * @property {number=} timeout
 * @property {boolean=} noTests
 * @property {(() => void)=} beforeExecute
 * @property {((options: import("../").Configuration) => void)=} afterExecute
 * @property {((scope: EXPECTED_ANY, options: import("../").Configuration, target: EXPECTED_ANY) => void)=} moduleScope
 */

const path = require("path");
const fs = require("graceful-fs");
/** @type {{ sync: (p: string) => void }} */
const rimraf = require("rimraf");
const { parseResource } = require("../lib/util/identifier");
const checkArrayExpectation = require("./checkArrayExpectation");
const { TestRunner } = require("./harness/runner");
const { registerPerCaseSnapshotHooks } = require("./harness/snapshot");
const captureStdio = require("./helpers/captureStdio");
const createLazyTestEnv = require("./helpers/createLazyTestEnv");
const deprecationTracking = require("./helpers/deprecationTracking");
const filterInfraStructureErrors = require("./helpers/infrastructureLogErrors");
const prepareOptions = require("./helpers/prepareOptions");
const supportsObjectHasOwn = require("./helpers/supportsObjectHasOwn");
const supportsOptionalChaining = require("./helpers/supportsOptionalChaining");

const casesPath = path.join(__dirname, "configCases");
const categories = fs.readdirSync(casesPath).map((cat) => ({
	name: cat,
	tests: fs
		.readdirSync(path.join(casesPath, cat))
		.filter((folder) => !folder.startsWith("_"))
		.sort()
}));

/**
 * @param {string[]} appendTarget log collector
 * @param {string[]} appendErrors warn/error collector
 * @returns {EXPECTED_ANY} logger object
 */
const createLogger = (appendTarget, appendErrors) => ({
	log: (/** @type {string} */ l) => appendTarget.push(l),
	debug: (/** @type {string} */ l) => appendTarget.push(l),
	trace: (/** @type {string} */ l) => appendTarget.push(l),
	info: (/** @type {string} */ l) => appendTarget.push(l),
	// Collect warn/error separately: every infrastructure warning/error must be
	// declared in the case's infrastructure-log.js or the test fails, so a cache
	// store/restore failure can't slip through unnoticed.
	warn: (/** @type {string} */ l, /** @type {EXPECTED_ANY[]} */ ...args) => {
		appendErrors.push(l);
		console.warn(l, ...args);
	},
	error: (/** @type {string} */ l, /** @type {EXPECTED_ANY[]} */ ...args) => {
		appendErrors.push(l);
		console.error(l, ...args);
	},
	logTime: () => {},
	group: () => {},
	groupCollapsed: () => {},
	groupEnd: () => {},
	profile: () => {},
	profileEnd: () => {},
	clear: () => {},
	status: () => {}
});

/**
 * @param {SuiteConfig} config suite config
 */
const describeCases = (config) => {
	describe(config.name, () => {
		/** @type {ReturnType<typeof captureStdio>} */
		let stderr;

		beforeEach(() => {
			stderr = captureStdio(process.stderr, true);
		});

		afterEach(() => {
			stderr.restore();
		});

		jest.setTimeout(20000);

		for (const category of categories) {
			// eslint-disable-next-line no-loop-func
			describe(category.name, () => {
				for (const testName of category.tests) {
					// eslint-disable-next-line no-loop-func
					describe(testName, () => {
						const testDirectory = path.join(casesPath, category.name, testName);
						const filterPath = path.join(testDirectory, "test.filter.js");
						if (fs.existsSync(filterPath) && !require(filterPath)(config)) {
							// eslint-disable-next-line jest/no-disabled-tests
							describe.skip(testName, () => {
								it("filtered", () => {});
							});

							return;
						}
						/** @type {string[]} */
						const infraStructureLog = [];
						/** @type {string[]} */
						const infraStructureErrors = [];
						const outBaseDir = path.join(__dirname, "js");
						const testSubPath = path.join(config.name, category.name, testName);
						const outputDirectory = path.join(outBaseDir, testSubPath);
						const cacheDirectory = path.join(outBaseDir, ".cache", testSubPath);
						/** @type {import("../").Configuration} */
						let options;
						/** @type {import("../").Configuration[]} */
						let optionsArr;
						/** @type {TestConfig} */
						let testConfig;

						registerPerCaseSnapshotHooks(testDirectory, config.name);

						beforeAll(async () => {
							options = /** @type {import("../").Configuration} */ (
								await prepareOptions(
									require(path.join(testDirectory, "webpack.config.js")),
									{ testPath: outputDirectory }
								)
							);
							optionsArr = [...(Array.isArray(options) ? options : [options])];
							for (const [idx, options] of optionsArr.entries()) {
								if (!options.context) options.context = testDirectory;
								if (!options.mode) options.mode = "production";
								if (!options.optimization) options.optimization = {};
								if (options.optimization.minimize === undefined) {
									options.optimization.minimize = false;
								}
								if (options.optimization.minimizer === undefined) {
									options.optimization.minimizer = [
										new (require("minimizer-webpack-plugin"))({
											parallel: false
										})
									];
								}
								if (!options.entry) options.entry = "./index.js";
								if (!options.target) options.target = "async-node";
								if (!options.output) options.output = {};
								// generated runtime runs in this Node.js process; avoid `?.` on
								// Node < 14 (skip `ecmaVersion` cases asserting derived environment)
								if (
									category.name !== "ecmaVersion" &&
									!supportsOptionalChaining()
								) {
									if (!options.output.environment) {
										options.output.environment = {};
									}
									if (
										options.output.environment.optionalChaining === undefined
									) {
										options.output.environment.optionalChaining = false;
									}
								}
								// generated runtime runs in this Node.js process; avoid
								// `Object.hasOwn` on Node < 16.9
								if (
									category.name !== "ecmaVersion" &&
									!supportsObjectHasOwn()
								) {
									if (!options.output.environment) {
										options.output.environment = {};
									}
									if (options.output.environment.hasOwn === undefined) {
										options.output.environment.hasOwn = false;
									}
								}
								if (!options.output.path) options.output.path = outputDirectory;
								if (typeof options.output.pathinfo === "undefined") {
									options.output.pathinfo = true;
								}
								if (
									typeof options.output.strictModuleResolution === "undefined"
								) {
									options.output.strictModuleResolution = true;
								}
								if (!options.output.filename) {
									options.output.filename = `bundle${idx}${
										options.experiments && options.experiments.outputModule
											? ".mjs"
											: ".js"
									}`;
								}
								if (config.cache) {
									options.cache = {
										cacheDirectory,
										name:
											options.cache && options.cache !== true
												? /** @type {import("../").FileCacheOptions} */ (
														options.cache
													).name
												: `config-${idx}`,
										...config.cache
									};
								}
								if (config.cache) {
									options.infrastructureLogging = {
										debug: true,
										console: createLogger(
											infraStructureLog,
											infraStructureErrors
										)
									};
								}
								if (!options.snapshot) options.snapshot = {};
								if (!options.snapshot.managedPaths) {
									options.snapshot.managedPaths = [
										path.resolve(__dirname, "../node_modules")
									];
								}
							}
							testConfig = {
								findBundle(i, options) {
									const output = /** @type {EXPECTED_ANY} */ (options.output);
									const ext = path.extname(
										parseResource(/** @type {string} */ (output.filename)).path
									);
									if (
										fs.existsSync(
											path.join(
												/** @type {string} */ (output.path),
												`bundle${i}${ext}`
											)
										)
									) {
										return `./bundle${i}${ext}`;
									}
								},
								timeout: 30000
							};
							try {
								// try to load a test file
								testConfig = Object.assign(
									testConfig,
									require(path.join(testDirectory, "test.config.js"))
								);
							} catch (_err) {
								// ignored
							}
							if (testConfig.timeout) setDefaultTimeout(testConfig.timeout);
						});

						// eslint-disable-next-line jest/no-duplicate-hooks
						beforeAll(() => {
							rimraf.sync(cacheDirectory);
						});

						afterAll(() => {
							// cleanup
							options = /** @type {EXPECTED_ANY} */ (undefined);
							optionsArr = /** @type {EXPECTED_ANY} */ (undefined);
							testConfig = /** @type {EXPECTED_ANY} */ (undefined);
						});

						/**
						 * @param {Error} err error
						 * @param {(err?: Error) => void} done done callback
						 */
						const handleFatalError = (err, done) => {
							const fakeStats = {
								errors: [
									{
										message: err.message,
										stack: err.stack
									}
								]
							};
							if (
								checkArrayExpectation(
									testDirectory,
									fakeStats,
									"error",
									"Error",
									options,
									done
								)
							) {
								return;
							}
							// Wait for uncaught errors to occur
							setTimeout(done, 200);
						};
						if (config.cache) {
							it(`${testName} should pre-compile to fill disk cache (1st)`, (done) => {
								rimraf.sync(outputDirectory);
								fs.mkdirSync(outputDirectory, { recursive: true });
								infraStructureLog.length = 0;
								infraStructureErrors.length = 0;
								const deprecationTracker = deprecationTracking.start();

								const compiler = require("..")(options);

								compiler.run((err) => {
									deprecationTracker();
									if (err) return handleFatalError(err, done);
									// Check after close: the disk cache is stored during close,
									// so store failures (warnings) only surface afterwards.
									compiler.close((closeErr) => {
										if (closeErr) return handleFatalError(closeErr, done);
										const infrastructureLogging = stderr.toString();
										if (infrastructureLogging) {
											return done(
												new Error(
													`Errors/Warnings during build:\n${infrastructureLogging}`
												)
											);
										}
										const infrastructureLogErrors = [
											...filterInfraStructureErrors(infraStructureLog, {
												run: 1,
												options
											}),
											...infraStructureErrors.map((message) => ({ message }))
										];
										if (
											infrastructureLogErrors.length &&
											checkArrayExpectation(
												testDirectory,
												{ infrastructureLogs: infrastructureLogErrors },
												"infrastructureLog",
												"infrastructure-log",
												"InfrastructureLog",
												options,
												done
											)
										) {
											return;
										}
										done();
									});
								});
							}, 60000);

							it(`${testName} should pre-compile to fill disk cache (2nd)`, (done) => {
								rimraf.sync(outputDirectory);
								fs.mkdirSync(outputDirectory, { recursive: true });
								infraStructureLog.length = 0;
								infraStructureErrors.length = 0;
								const deprecationTracker = deprecationTracking.start();

								const compiler = require("..")(options);

								compiler.run((err, stats) => {
									deprecationTracker();
									if (err) {
										return handleFatalError(/** @type {Error} */ (err), done);
									}
									const { modules, children, errorsCount } =
										/** @type {import("../").Stats} */ (stats).toJson({
											all: false,
											modules: true,
											errorsCount: true
										});
									if (errorsCount === 0) {
										const allModules = children
											? children.reduce(
													(all, { modules }) => [
														...all,
														.../** @type {import("../").StatsModule[]} */ (
															modules || []
														)
													],
													/** @type {import("../").StatsModule[]} */ (
														modules || []
													)
												)
											: modules;
										if (
											/** @type {import("../").StatsModule[]} */ (
												allModules
											).some((m) => m.type !== "cached modules" && !m.cached)
										) {
											return done(
												new Error(
													`Some modules were not cached:\n${
														/** @type {import("../").Stats} */ (stats).toString(
															{
																all: false,
																modules: true,
																modulesSpace: 100
															}
														)
													}`
												)
											);
										}
									}
									// Check after close: the disk cache is stored during close,
									// so store failures (warnings) only surface afterwards.
									compiler.close((closeErr) => {
										if (closeErr) return handleFatalError(closeErr, done);
										if (errorsCount === 0) {
											const infrastructureLogging = stderr.toString();
											if (infrastructureLogging) {
												return done(
													new Error(
														`Errors/Warnings during build:\n${infrastructureLogging}`
													)
												);
											}
										}
										const infrastructureLogErrors = [
											...filterInfraStructureErrors(infraStructureLog, {
												run: 2,
												options
											}),
											...infraStructureErrors.map((message) => ({ message }))
										];
										if (
											infrastructureLogErrors.length &&
											checkArrayExpectation(
												testDirectory,
												{ infrastructureLogs: infrastructureLogErrors },
												"infrastructureLog",
												"infrastructure-log",
												"InfrastructureLog",
												options,
												done
											)
										) {
											return;
										}
										done();
									});
								});
							}, 40000);
						}

						it(`${testName} should compile`, (done) => {
							rimraf.sync(outputDirectory);
							fs.mkdirSync(outputDirectory, { recursive: true });
							infraStructureLog.length = 0;
							const deprecationTracker = deprecationTracking.start();
							const onCompiled = (
								/** @type {Error | null} */ err,
								/** @type {import("../").Stats} */ stats
							) => {
								const deprecations = deprecationTracker();
								if (err) return handleFatalError(err, done);
								const statOptions = {
									preset: "verbose",
									colors: false
								};
								fs.mkdirSync(outputDirectory, { recursive: true });
								fs.writeFileSync(
									path.join(outputDirectory, "stats.txt"),
									stats.toString(statOptions),
									"utf8"
								);
								const jsonStats = stats.toJson({
									errorDetails: true
								});
								fs.writeFileSync(
									path.join(outputDirectory, "stats.json"),
									JSON.stringify(jsonStats, null, 2),
									"utf8"
								);
								if (
									checkArrayExpectation(
										testDirectory,
										jsonStats,
										"error",
										"Error",
										options,
										done
									)
								) {
									return;
								}
								if (
									checkArrayExpectation(
										testDirectory,
										jsonStats,
										"warning",
										"Warning",
										options,
										done
									)
								) {
									return;
								}
								const infrastructureLogging = stderr.toString();
								if (infrastructureLogging) {
									return done(
										new Error(
											`Errors/Warnings during build:\n${infrastructureLogging}`
										)
									);
								}
								if (
									checkArrayExpectation(
										testDirectory,
										{ deprecations },
										"deprecation",
										"Deprecation",
										options,
										done
									)
								) {
									return;
								}
								const infrastructureLogErrors = [
									...filterInfraStructureErrors(infraStructureLog, {
										run: 3,
										options
									}),
									...infraStructureErrors.map((message) => ({ message }))
								];
								if (
									infrastructureLogErrors.length &&
									checkArrayExpectation(
										testDirectory,
										{ infrastructureLogs: infrastructureLogErrors },
										"infrastructureLog",
										"infrastructure-log",
										"InfrastructureLog",
										options,
										done
									)
								) {
									return;
								}

								if (testConfig.noTests) return process.nextTick(done);
								if (testConfig.beforeExecute) testConfig.beforeExecute();
								const { filesCount, results } = TestRunner.runBundles({
									optionsArr,
									outputDirectory,
									testConfig,
									category,
									testName,
									setupRunner: ({ runner, index, target }) => {
										runner.mergeModuleScope({
											it: _it,
											beforeEach: _beforeEach,
											afterEach: _afterEach,
											__STATS__: jsonStats,
											__STATS_I__: index
										});
										if (testConfig.moduleScope) {
											testConfig.moduleScope(
												runner._moduleScope,
												optionsArr[index],
												target
											);
										}
									},
									getBundlePaths: (i, options) =>
										/** @type {NonNullable<TestConfig["findBundle"]>} */ (
											testConfig.findBundle
										)(i, options)
								});
								// give a free pass to compilation that generated an error
								if (
									!(/** @type {EXPECTED_ANY[]} */ (jsonStats.errors).length) &&
									filesCount !== optionsArr.length
								) {
									return done(
										new Error(
											"Should have found at least one bundle file per webpack config"
										)
									);
								}
								Promise.all(results)
									.then(() => {
										if (testConfig.afterExecute) {
											testConfig.afterExecute(options);
										}
										for (const key of Object.keys(global)) {
											if (key.includes("webpack")) {
												delete (
													/** @type {Record<string, unknown>} */ (global)[key]
												);
											}
										}
										if (getNumberOfTests() < filesCount) {
											return done(new Error("No tests exported by test case"));
										}
										done();
									})
									.catch(done);
							};
							if (config.cache) {
								try {
									const compiler = require("..")(options);

									compiler.run((err) => {
										if (err) {
											return handleFatalError(/** @type {Error} */ (err), done);
										}
										compiler.run((error, stats) => {
											compiler.close((err) => {
												if (err) {
													return handleFatalError(
														/** @type {Error} */ (err),
														done
													);
												}
												onCompiled(
													/** @type {Error | null} */ (error),
													/** @type {import("../").Stats} */ (stats)
												);
											});
										});
									});
								} catch (err) {
									handleFatalError(/** @type {Error} */ (err), done);
								}
							} else {
								require("..")(
									options,
									/** @type {EXPECTED_ANY} */ (onCompiled)
								);
							}
						}, 30000);

						const {
							it: _it,
							beforeEach: _beforeEach,
							afterEach: _afterEach,
							setDefaultTimeout,
							getNumberOfTests
						} = createLazyTestEnv(10000);
					});
				}
			});
		}
	});
};

// eslint-disable-next-line jest/no-export
module.exports.describeCases = describeCases;