feat: improved multi-compiler cache location and validating it

lib/MultiCompiler.js

@@ -11,6 +11,7 @@ const { SyncHook, MultiHook } = require("tapable");
 const ConcurrentCompilationError = require("./ConcurrentCompilationError");
 const MultiStats = require("./MultiStats");
 const MultiWatching = require("./MultiWatching");
+const WebpackError = require("./WebpackError");
 const ArrayQueue = require("./util/ArrayQueue");
 
 /** @template T @typedef {import("tapable").AsyncSeriesHook<T>} AsyncSeriesHook<T> */
@@ -109,6 +110,40 @@ module.exports = class MultiCompiler {
 				}
 			});
 		}
+		this._validateCompilersOptions();
+	}
+
+	_validateCompilersOptions() {
+		if (this.compilers.length < 2) return;
+		/**
+		 * @param {Compiler} compiler compiler
+		 * @param {WebpackError} warning warning
+		 */
+		const addWarning = (compiler, warning) => {
+			compiler.hooks.thisCompilation.tap("MultiCompiler", compilation => {
+				compilation.warnings.push(warning);
+			});
+		};
+		const cacheNames = new Set();
+		for (const compiler of this.compilers) {
+			if (compiler.options.cache && "name" in compiler.options.cache) {
+				const name = compiler.options.cache.name;
+				if (cacheNames.has(name)) {
+					addWarning(
+						compiler,
+						new WebpackError(
+							`${
+								compiler.name
+									? `Compiler with name "${compiler.name}" doesn't use unique cache name. `
+									: ""
+							}Please set unique "cache.name" option. Name "${name}" already used.`
+						)
+					);
+				} else {
+					cacheNames.add(name);
+				}
+			}
+		}
 	}
 
 	get options() {

lib/config/defaults.js

@@ -27,7 +27,8 @@ const {
 	getDefaultTarget
 } = require("./target");
 
-/** @typedef {import("../../declarations/WebpackOptions").CacheOptionsNormalized} CacheOptions */
+/** @typedef {import("../../declarations/WebpackOptions").CacheOptions} CacheOptions */
+/** @typedef {import("../../declarations/WebpackOptions").CacheOptionsNormalized} CacheOptionsNormalized */
 /** @typedef {import("../../declarations/WebpackOptions").Context} Context */
 /** @typedef {import("../../declarations/WebpackOptions").CssGeneratorOptions} CssGeneratorOptions */
 /** @typedef {import("../../declarations/WebpackOptions").CssParserOptions} CssParserOptions */
@@ -60,12 +61,14 @@ const {
 /** @typedef {import("../../declarations/WebpackOptions").RuleSetRules} RuleSetRules */
 /** @typedef {import("../../declarations/WebpackOptions").SnapshotOptions} SnapshotOptions */
 /** @typedef {import("../../declarations/WebpackOptions").Target} Target */
-/** @typedef {import("../../declarations/WebpackOptions").WebpackOptionsNormalized} WebpackOptions */
+/** @typedef {import("../../declarations/WebpackOptions").WebpackOptions} WebpackOptions */
+/** @typedef {import("../../declarations/WebpackOptions").WebpackOptionsNormalized} WebpackOptionsNormalized */
 /** @typedef {import("../Compiler")} Compiler */
 /** @typedef {import("../Module")} Module */
 /** @typedef {import("./target").TargetProperties} TargetProperties */
 
 const NODE_MODULES_REGEXP = /[\\/]node_modules[\\/]/i;
+const DEFAULT_CACHE_NAME = "default";
 
 /**
  * Sets a constant default value when undefined
@@ -137,7 +140,7 @@ const A = (obj, prop, factory) => {
 };
 
 /**
- * @param {WebpackOptions} options options to be modified
+ * @param {WebpackOptionsNormalized} options options to be modified
  * @returns {void}
  */
 const applyWebpackOptionsBaseDefaults = options => {
@@ -146,10 +149,11 @@ const applyWebpackOptionsBaseDefaults = options => {
 };
 
 /**
- * @param {WebpackOptions} options options to be modified
+ * @param {WebpackOptionsNormalized} options options to be modified
+ * @param {number} [compilerIndex] index of compiler
  * @returns {void}
  */
-const applyWebpackOptionsDefaults = options => {
+const applyWebpackOptionsDefaults = (options, compilerIndex) => {
 	F(options, "context", () => process.cwd());
 	F(options, "target", () => {
 		return getDefaultTarget(/** @type {string} */ (options.context));
@@ -201,10 +205,11 @@ const applyWebpackOptionsDefaults = options => {
 		development ? { type: /** @type {"memory"} */ ("memory") } : false
 	);
 	applyCacheDefaults(options.cache, {
-		name: name || "default",
+		name: name || DEFAULT_CACHE_NAME,
 		mode: mode || "production",
 		development,
-		cacheUnaffected: options.experiments.cacheUnaffected
+		cacheUnaffected: options.experiments.cacheUnaffected,
+		compilerIndex
 	});
 	const cache = !!options.cache;
 
@@ -251,7 +256,9 @@ const applyWebpackOptionsDefaults = options => {
 	});
 
 	applyLoaderDefaults(
-		/** @type {NonNullable<WebpackOptions["loader"]>} */ (options.loader),
+		/** @type {NonNullable<WebpackOptionsNormalized["loader"]>} */ (
+			options.loader
+		),
 		{ targetProperties, environment: options.output.environment }
 	);
 
@@ -268,7 +275,7 @@ const applyWebpackOptionsDefaults = options => {
 
 	applyNodeDefaults(options.node, {
 		futureDefaults:
-			/** @type {NonNullable<WebpackOptions["experiments"]["futureDefaults"]>} */
+			/** @type {NonNullable<WebpackOptionsNormalized["experiments"]["futureDefaults"]>} */
 			(options.experiments.futureDefaults),
 		outputModule: options.output.module,
 		targetProperties
@@ -282,7 +289,7 @@ const applyWebpackOptionsDefaults = options => {
 			: false
 	);
 	applyPerformanceDefaults(
-		/** @type {NonNullable<WebpackOptions["performance"]>} */
+		/** @type {NonNullable<WebpackOptionsNormalized["performance"]>} */
 		(options.performance),
 		{
 			production
@@ -354,22 +361,27 @@ const applyExperimentsDefaults = (
 };
 
 /**
- * @param {CacheOptions} cache options
+ * @param {CacheOptionsNormalized} cache options
  * @param {Object} options options
  * @param {string} options.name name
  * @param {Mode} options.mode mode
  * @param {boolean} options.development is development mode
+ * @param {number} [options.compilerIndex] index of compiler
  * @param {Experiments["cacheUnaffected"]} options.cacheUnaffected the cacheUnaffected experiment is enabled
  * @returns {void}
  */
 const applyCacheDefaults = (
 	cache,
-	{ name, mode, development, cacheUnaffected }
+	{ name, mode, development, cacheUnaffected, compilerIndex }
 ) => {
 	if (cache === false) return;
 	switch (cache.type) {
 		case "filesystem":
-			F(cache, "name", () => name + "-" + mode);
+			F(cache, "name", () =>
+				compilerIndex !== undefined
+					? `${name + "-" + mode}__compiler${compilerIndex + 1}__`
+					: name + "-" + mode
+			);
 			D(cache, "version", "");
 			F(cache, "cacheDirectory", () => {
 				const cwd = process.cwd();

lib/webpack.js

@@ -42,7 +42,9 @@ const getValidateSchema = memoize(() => require("./validateSchema"));
  * @returns {MultiCompiler} a multi-compiler
  */
 const createMultiCompiler = (childOptions, options) => {
-	const compilers = childOptions.map(options => createCompiler(options));
+	const compilers = childOptions.map((options, index) =>
+		createCompiler(options, index)
+	);
 	const compiler = new MultiCompiler(compilers, options);
 	for (const childCompiler of compilers) {
 		if (childCompiler.options.dependencies) {
@@ -57,9 +59,10 @@ const createMultiCompiler = (childOptions, options) => {
 
 /**
  * @param {WebpackOptions} rawOptions options object
+ * @param {number} [compilerIndex] index of compiler
  * @returns {Compiler} a compiler
  */
-const createCompiler = rawOptions => {
+const createCompiler = (rawOptions, compilerIndex) => {
 	const options = getNormalizedWebpackOptions(rawOptions);
 	applyWebpackOptionsBaseDefaults(options);
 	const compiler = new Compiler(
@@ -79,7 +82,7 @@ const createCompiler = rawOptions => {
 			}
 		}
 	}
-	applyWebpackOptionsDefaults(options);
+	applyWebpackOptionsDefaults(options, compilerIndex);
 	compiler.hooks.environment.call();
 	compiler.hooks.afterEnvironment.call();
 	new WebpackOptionsApply().process(options, compiler);

test/ConfigTestCases.template.js

@@ -66,7 +66,7 @@ const describeCases = config => {
 					describe(testName, function () {
 						const testDirectory = path.join(casesPath, category.name, testName);
 						const filterPath = path.join(testDirectory, "test.filter.js");
-						if (fs.existsSync(filterPath) && !require(filterPath)()) {
+						if (fs.existsSync(filterPath) && !require(filterPath)(config)) {
 							describe.skip(testName, () => {
 								it("filtered", () => {});
 							});
@@ -113,9 +113,14 @@ const describeCases = config => {
 								if (config.cache) {
 									options.cache = {
 										cacheDirectory,
-										name: `config-${idx}`,
+										name:
+											options.cache && options.cache !== true
+												? options.cache.name
+												: `config-${idx}`,
 										...config.cache
 									};
+								}
+								if (config.cache) {
 									options.infrastructureLogging = {
 										debug: true,
 										console: createLogger(infraStructureLog)

test/StatsTestCases.basictest.js

@@ -78,6 +78,17 @@ describe("StatsTestCases", () => {
 				if (!options.optimization) options.optimization = {};
 				if (options.optimization.minimize === undefined)
 					options.optimization.minimize = false;
+				if (
+					options.cache &&
+					options.cache !== true &&
+					options.cache.type === "filesystem"
+				) {
+					options.cache.cacheDirectory = path.resolve(
+						outputBase,
+						".cache",
+						testName
+					);
+				}
 			});
 			const c = webpack(options);
 			const compilers = c.compilers ? c.compilers : [c];

test/configCases/cache-filesystem/multicompiler-mode-cache-1/index.js

@@ -0,0 +1 @@
+it("should build", () => {});

test/configCases/cache-filesystem/multicompiler-mode-cache-1/test.filter.js

@@ -0,0 +1 @@
+module.exports = config => config.cache;

test/configCases/cache-filesystem/multicompiler-mode-cache-1/webpack.config.js

@@ -0,0 +1,33 @@
+"use strict";
+
+// default settings. should just work
+
+/** @type {import("../../../../").Configuration} */
+module.exports = [
+	{
+		mode: "production",
+		entry: "./index",
+		cache: {
+			type: "filesystem",
+			name: "name2"
+		}
+	},
+	{
+		mode: "production",
+		entry: "./index",
+		cache: {
+			type: "filesystem",
+			name: "name1"
+		}
+	},
+	{
+		mode: "production",
+		entry: "./index",
+		cache: true
+	},
+	{
+		mode: "production",
+		entry: "./index",
+		cache: true
+	}
+];

test/configCases/cache-filesystem/multicompiler-mode-cache-2/index.js

@@ -0,0 +1 @@
+it("should build", () => {});

test/configCases/cache-filesystem/multicompiler-mode-cache-2/test.filter.js

@@ -0,0 +1 @@
+module.exports = config => config.cache;

test/configCases/cache-filesystem/multicompiler-mode-cache-2/webpack.config.js

@@ -0,0 +1,29 @@
+"use strict";
+
+// no cache names
+
+/** @type {import("../../../../").Configuration} */
+module.exports = [
+	{
+		mode: "production",
+		entry: "./index",
+		cache: {
+			type: "filesystem"
+		}
+	},
+	{
+		mode: "production",
+		entry: "./index",
+		cache: {
+			type: "filesystem"
+		}
+	},
+	{
+		name: "3rd compiler",
+		mode: "production",
+		entry: "./index",
+		cache: {
+			type: "filesystem"
+		}
+	}
+];

test/configCases/cache-filesystem/multicompiler-mode-cache-3/index.js

@@ -0,0 +1 @@
+it("should build", () => {});

test/configCases/cache-filesystem/multicompiler-mode-cache-3/test.filter.js

@@ -0,0 +1 @@
+module.exports = config => config.cache;

test/configCases/cache-filesystem/multicompiler-mode-cache-3/warnings.js

@@ -0,0 +1,4 @@
+module.exports = [
+	/Please set unique "cache\.name" option/,
+	/Compiler with name "3rd compiler" doesn't use unique cache name/
+];

test/configCases/cache-filesystem/multicompiler-mode-cache-3/webpack.config.js

@@ -0,0 +1,32 @@
+"use strict";
+
+// with explicit cache names
+
+/** @type {import("../../../../").Configuration} */
+module.exports = [
+	{
+		mode: "production",
+		entry: "./index",
+		cache: {
+			name: "filesystem",
+			type: "filesystem"
+		}
+	},
+	{
+		mode: "production",
+		entry: "./index",
+		cache: {
+			name: "filesystem",
+			type: "filesystem"
+		}
+	},
+	{
+		name: "3rd compiler",
+		mode: "production",
+		entry: "./index",
+		cache: {
+			name: "filesystem",
+			type: "filesystem"
+		}
+	}
+];

test/configCases/cache-filesystem/multicompiler-mode-cache-4/index.js

@@ -0,0 +1 @@
+it("should build", () => {});

test/configCases/cache-filesystem/multicompiler-mode-cache-4/test.filter.js

@@ -0,0 +1 @@
+module.exports = config => config.cache;

test/configCases/cache-filesystem/multicompiler-mode-cache-4/warnings.js

@@ -0,0 +1 @@
+module.exports = [/Please set unique "cache\.name" option/];

test/configCases/cache-filesystem/multicompiler-mode-cache-4/webpack.config.js

@@ -0,0 +1,23 @@
+"use strict";
+
+// with explicit cache names
+
+/** @type {import("../../../../").Configuration} */
+module.exports = [
+	{
+		mode: "production",
+		entry: "./index",
+		cache: {
+			name: "default",
+			type: "filesystem"
+		}
+	},
+	{
+		mode: "production",
+		entry: "./index",
+		cache: {
+			name: "default",
+			type: "filesystem"
+		}
+	}
+];

test/configCases/cache-filesystem/multicompiler-mode-cache-5/index.js

@@ -0,0 +1 @@
+it("should build", () => {});

test/configCases/cache-filesystem/multicompiler-mode-cache-5/test.filter.js

@@ -0,0 +1 @@
+module.exports = config => config.cache;