Merge pull request #15157 from markjm/markjm/watch-mode-profile-plugin

sokra · web-flow · commit bc80a83a7a67 · 2022-01-18T07:20:30.000+01:00
Fix ProfilingPlugin for watch scenarios
diff --git a/lib/debug/ProfilingPlugin.js b/lib/debug/ProfilingPlugin.js
@@ -123,9 +123,7 @@ class Profiler {
  * @returns {Trace} The trace object
  */
 const createTrace = (fs, outputPath) => {
-	const trace = new Tracer({
-		noStream: true
-	});
+	const trace = new Tracer();
 	const profiler = new Profiler(inspector);
 	if (/\/|\\/.test(outputPath)) {
 		const dirPath = dirname(fs, outputPath);
@@ -173,6 +171,7 @@ const createTrace = (fs, outputPath) => {
 		counter,
 		profiler,
 		end: callback => {
+			trace.push("]");
 			// Wait until the write stream finishes.
 			fsStream.on("close", () => {
 				callback();
@@ -242,10 +241,10 @@ class ProfilingPlugin {
 				stage: Infinity
 			},
 			(stats, callback) => {
+				if (compiler.watchMode) return callback();
 				tracer.profiler.stopProfiling().then(parsedResults => {
 					if (parsedResults === undefined) {
 						tracer.profiler.destroy();
-						tracer.trace.flush();
 						tracer.end(callback);
 						return;
 					}
@@ -293,7 +292,6 @@ class ProfilingPlugin {
 					});
 
 					tracer.profiler.destroy();
-					tracer.trace.flush();
 					tracer.end(callback);
 				});
 			}
@@ -346,11 +344,15 @@ const interceptAllJavascriptModulesPluginHooks = (compilation, tracer) => {
 
 const makeInterceptorFor = (instance, tracer) => hookName => ({
 	register: ({ name, type, context, fn }) => {
-		const newFn = makeNewProfiledTapFn(hookName, tracer, {
-			name,
-			type,
-			fn
-		});
+		const newFn =
+			// Don't tap our own hooks to ensure stream can close cleanly
+			name === pluginName
+				? fn
+				: makeNewProfiledTapFn(hookName, tracer, {
+						name,
+						type,
+						fn
+				  });
 		return {
 			name,
 			type,
diff --git a/test/WatchTestCases.template.js b/test/WatchTestCases.template.js
@@ -396,7 +396,7 @@ const describeCases = config => {
 																done
 															)
 														) {
-															compiler.close();
+															compiler.close(() => {});
 															return;
 														}
 														compiler.close(done);
diff --git a/test/watchCases/plugins/profiling-plugin/0/index.js b/test/watchCases/plugins/profiling-plugin/0/index.js
@@ -0,0 +1,3 @@
+it("compiles", function() {
+	expect(WATCH_STEP).toBe("0");
+})
diff --git a/test/watchCases/plugins/profiling-plugin/1/index.js b/test/watchCases/plugins/profiling-plugin/1/index.js
@@ -0,0 +1,3 @@
+it("should not crash on recompile", function() {
+	expect(WATCH_STEP).toBe("1");
+})
diff --git a/test/watchCases/plugins/profiling-plugin/deprecations.js b/test/watchCases/plugins/profiling-plugin/deprecations.js
@@ -0,0 +1,3 @@
+module.exports = [
+	{ code: /DEP_WEBPACK_COMPILATION_NORMAL_MODULE_LOADER_HOOK/ }
+];
diff --git a/test/watchCases/plugins/profiling-plugin/webpack.config.js b/test/watchCases/plugins/profiling-plugin/webpack.config.js
@@ -0,0 +1,6 @@
+var webpack = require("../../../../");
+
+/** @type {import("../../../../").Configuration} */
+module.exports = {
+	plugins: [new webpack.debug.ProfilingPlugin()]
+};

Original file line number	Diff line number	Diff line change
`@@ -396,7 +396,7 @@ const describeCases = config => {`
`396`	`396`	`done`
`397`	`397`	`)`
`398`	`398`	`) {`
`399`		`- compiler.close();`
	`399`	`+ compiler.close(() => {});`
`400`	`400`	`return;`
`401`	`401`	`}`
`402`	`402`	`compiler.close(done);`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+it("compiles", function() {`
	`2`	`+ expect(WATCH_STEP).toBe("0");`
	`3`	`+})`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+it("should not crash on recompile", function() {`
	`2`	`+ expect(WATCH_STEP).toBe("1");`
	`3`	`+})`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module.exports = [`
	`2`	`+ { code: /DEP_WEBPACK_COMPILATION_NORMAL_MODULE_LOADER_HOOK/ }`
	`3`	`+];`