Merge pull request #15356 from webpack/fix/issues-15177

sokra · web-flow · commit 0d38e5785e5e · 2022-02-10T12:28:01.000+01:00
fix serialization in ContextElementDependency
diff --git a/lib/dependencies/ContextElementDependency.js b/lib/dependencies/ContextElementDependency.js
@@ -53,12 +53,18 @@ class ContextElementDependency extends ModuleDependency {
 	}
 
 	serialize(context) {
-		context.write(this.referencedExports);
+		const { write } = context;
+		write(this._typePrefix);
+		write(this._category);
+		write(this.referencedExports);
 		super.serialize(context);
 	}
 
 	deserialize(context) {
-		this.referencedExports = context.read();
+		const { read } = context;
+		this._typePrefix = read();
+		this._category = read();
+		this.referencedExports = read();
 		super.deserialize(context);
 	}
 }
diff --git a/test/ConfigCacheTestCases.longtest.js b/test/ConfigCacheTestCases.longtest.js
@@ -1,7 +1,42 @@
-const { describeCases } = require("./ConfigTestCases.template");
+const { describeCases, logErrors } = require("./ConfigTestCases.template");
 
 describeCases({
 	name: "ConfigCacheTestCases",
+	infrastructureLogErrors: {
+		allowList: [
+			{
+				//  Pack got invalid because of write to: Compilation/modules|/home/runner/work/webpack/webpack/test/configCases/wasm/missing-wasm-experiment/wasm.wasm
+				category: "wasm",
+				test: "missing-wasm-experiment"
+			},
+			{
+				//  Pack got invalid because of write to: RealContentHashPlugin|analyse|index.html
+				category: "process-assets",
+				test: "html-plugin"
+			},
+			{
+				//  Pack got invalid because of write to: Compilation/modules|/home/runner/work/webpack/webpack/test/cases/parsing/context/templates/dump-file.txt
+				category: "parsing",
+				test: "context"
+			},
+			{
+				// Pack got invalid because of write to: Compilation/modules|/home/runner/work/webpack/webpack/test/configCases/loaders/options/loader-1.js??ruleSet[1].rules[9]!/home/runner/work/webpack/webpack/test/configCases/loaders/options/error1.js
+				category: "loaders",
+				test: "options"
+			},
+			{
+				// Pack got invalid because of write to: TerserWebpackPlugin|bundle0.js
+				category: "assets",
+				test: "delete-asset"
+			},
+			{
+				// Pack got invalid because of write to: webpack.HttpUriPlugin|https://raw.githubusercontent.com//webpack//webpack//main/CODE_OF_CONDUCT.md
+				category: "asset-modules",
+				test: "http-url"
+			}
+		],
+		filter: [logErrors.PERSISTENCE_CACHE_INVALIDATE_ERROR]
+	},
 	cache: {
 		type: "filesystem",
 		buildDependencies: {
diff --git a/test/ConfigTestCases.template.js b/test/ConfigTestCases.template.js
@@ -18,6 +18,17 @@ const { parseResource } = require("../lib/util/identifier");
 const captureStdio = require("./helpers/captureStdio");
 const asModule = require("./helpers/asModule");
 
+const PERSISTENCE_CACHE_INVALIDATE_ERROR = (log, config) => {
+	if (config.run < 2) return;
+	const match =
+		/^\[webpack\.cache\.PackFileCacheStrategy\] Pack got invalid because of write to:(.+)$/.exec(
+			log
+		);
+	if (match) {
+		return `Pack got invalid because of write to: ${match[1].trim()}`;
+	}
+};
+
 const casesPath = path.join(__dirname, "configCases");
 const categories = fs.readdirSync(casesPath).map(cat => {
 	return {
@@ -29,7 +40,53 @@ const categories = fs.readdirSync(casesPath).map(cat => {
 	};
 });
 
+const createLogger = appendTarget => {
+	return {
+		log: l => appendTarget.push(l),
+		debug: l => appendTarget.push(l),
+		trace: l => appendTarget.push(l),
+		info: l => appendTarget.push(l),
+		warn: console.warn.bind(console),
+		error: console.error.bind(console),
+		logTime: () => {},
+		group: () => {},
+		groupCollapsed: () => {},
+		groupEnd: () => {},
+		profile: () => {},
+		profileEnd: () => {},
+		clear: () => {},
+		status: () => {}
+	};
+};
+
+const returnLogError = (logs, errorsFilter, config) => {
+	for (const log of logs) {
+		for (const filter of errorsFilter) {
+			const result = filter(log, config);
+			if (result) {
+				return new Error(result);
+			}
+		}
+	}
+};
+
 const describeCases = config => {
+	let allowErrorsMap;
+	if (config.infrastructureLogErrors) {
+		allowErrorsMap = new Map();
+		if (config.infrastructureLogErrors.allowList) {
+			for (const { category, test } of config.infrastructureLogErrors
+				.allowList) {
+				let byCategory = allowErrorsMap.get(category);
+				if (!byCategory) {
+					byCategory = new Set();
+					allowErrorsMap.set(category, byCategory);
+				}
+				byCategory.add(test);
+			}
+		}
+	}
+
 	describe(config.name, () => {
 		let stderr;
 		beforeEach(() => {
@@ -44,6 +101,11 @@ const describeCases = config => {
 			// eslint-disable-next-line no-loop-func
 			describe(category.name, () => {
 				for (const testName of category.tests) {
+					const inAllowErrorsList = () => {
+						const byCategory = allowErrorsMap.get(category.name);
+						if (!byCategory) return false;
+						return byCategory.has(testName);
+					};
 					// eslint-disable-next-line no-loop-func
 					describe(testName, function () {
 						const testDirectory = path.join(casesPath, category.name, testName);
@@ -54,6 +116,7 @@ const describeCases = config => {
 							});
 							return;
 						}
+						const infraStructureLog = [];
 						const outBaseDir = path.join(__dirname, "js");
 						const testSubPath = path.join(config.name, category.name, testName);
 						const outputDirectory = path.join(outBaseDir, testSubPath);
@@ -97,6 +160,10 @@ const describeCases = config => {
 										name: `config-${idx}`,
 										...config.cache
 									};
+									options.infrastructureLogging = {
+										debug: true,
+										console: createLogger(infraStructureLog)
+									};
 								}
 								if (!options.snapshot) options.snapshot = {};
 								if (!options.snapshot.managedPaths) {
@@ -168,6 +235,7 @@ const describeCases = config => {
 							it(`${testName} should pre-compile to fill disk cache (1st)`, done => {
 								rimraf.sync(outputDirectory);
 								fs.mkdirSync(outputDirectory, { recursive: true });
+								infraStructureLog.length = 0;
 								const deprecationTracker = deprecationTracking.start();
 								require("..")(options, err => {
 									deprecationTracker();
@@ -180,13 +248,29 @@ const describeCases = config => {
 											)
 										);
 									}
+									if (config.infrastructureLogErrors) {
+										if (!inAllowErrorsList()) {
+											const error = returnLogError(
+												infraStructureLog,
+												Array.isArray(config.infrastructureLogErrors.filter)
+													? config.infrastructureLogErrors.filter
+													: [config.infrastructureLogErrors.filter],
+												{
+													run: 1,
+													options
+												}
+											);
+											if (error) return done(error);
+										}
+									}
 									if (err) return handleFatalError(err, done);
 									done();
 								});
 							}, 60000);
 							it(`${testName} should pre-compile to fill disk cache (2nd)`, done => {
 								rimraf.sync(outputDirectory);
 								fs.mkdirSync(outputDirectory, { recursive: true });
+								infraStructureLog.length = 0;
 								const deprecationTracker = deprecationTracking.start();
 								require("..")(options, (err, stats) => {
 									deprecationTracker();
@@ -228,13 +312,29 @@ const describeCases = config => {
 											);
 										}
 									}
+									if (config.infrastructureLogErrors) {
+										if (!inAllowErrorsList()) {
+											const error = returnLogError(
+												infraStructureLog,
+												Array.isArray(config.infrastructureLogErrors.filter)
+													? config.infrastructureLogErrors.filter
+													: [config.infrastructureLogErrors.filter],
+												{
+													run: 2,
+													options
+												}
+											);
+											if (error) return done(error);
+										}
+									}
 									done();
 								});
 							}, 40000);
 						}
 						it(`${testName} should compile`, done => {
 							rimraf.sync(outputDirectory);
 							fs.mkdirSync(outputDirectory, { recursive: true });
+							infraStructureLog.length = 0;
 							const deprecationTracker = deprecationTracking.start();
 							const onCompiled = (err, stats) => {
 								const deprecations = deprecationTracker();
@@ -298,6 +398,21 @@ const describeCases = config => {
 								) {
 									return;
 								}
+								if (config.infrastructureLogErrors) {
+									if (!inAllowErrorsList()) {
+										const error = returnLogError(
+											infraStructureLog,
+											Array.isArray(config.infrastructureLogErrors.filter)
+												? config.infrastructureLogErrors.filter
+												: [config.infrastructureLogErrors.filter],
+											{
+												run: 3,
+												options
+											}
+										);
+										if (error) return done(error);
+									}
+								}
 
 								let filesCount = 0;
 
@@ -623,3 +738,6 @@ const describeCases = config => {
 };
 
 exports.describeCases = describeCases;
+exports.logErrors = {
+	PERSISTENCE_CACHE_INVALIDATE_ERROR
+};

Original file line number	Diff line number	Diff line change
`@@ -53,12 +53,18 @@ class ContextElementDependency extends ModuleDependency {`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`serialize(context) {`
`56`		`- context.write(this.referencedExports);`
	`56`	`+ const { write } = context;`
	`57`	`+ write(this._typePrefix);`
	`58`	`+ write(this._category);`
	`59`	`+ write(this.referencedExports);`
`57`	`60`	`super.serialize(context);`
`58`	`61`	`}`
`59`	`62`
`60`	`63`	`deserialize(context) {`
`61`		`- this.referencedExports = context.read();`
	`64`	`+ const { read } = context;`
	`65`	`+ this._typePrefix = read();`
	`66`	`+ this._category = read();`
	`67`	`+ this.referencedExports = read();`
`62`	`68`	`super.deserialize(context);`
`63`	`69`	`}`
`64`	`70`	`}`