webpack 5.59.0 → 5.94.0

package/lib/debug/ProfilingPlugin.js

@@ -5,12 +5,27 @@
 "use strict";
 
 const { Tracer } = require("chrome-trace-event");
+const {
+	JAVASCRIPT_MODULE_TYPE_AUTO,
+	JAVASCRIPT_MODULE_TYPE_DYNAMIC,
+	JAVASCRIPT_MODULE_TYPE_ESM,
+	WEBASSEMBLY_MODULE_TYPE_ASYNC,
+	WEBASSEMBLY_MODULE_TYPE_SYNC,
+	JSON_MODULE_TYPE
+} = require("../ModuleTypeConstants");
 const createSchemaValidation = require("../util/create-schema-validation");
 const { dirname, mkdirpSync } = require("../util/fs");
 
 /** @typedef {import("../../declarations/plugins/debug/ProfilingPlugin").ProfilingPluginOptions} ProfilingPluginOptions */
+/** @typedef {import("../Compilation")} Compilation */
+/** @typedef {import("../Compiler")} Compiler */
+/** @typedef {import("../ContextModuleFactory")} ContextModuleFactory */
+/** @typedef {import("../ModuleFactory")} ModuleFactory */
+/** @typedef {import("../NormalModuleFactory")} NormalModuleFactory */
 /** @typedef {import("../util/fs").IntermediateFileSystem} IntermediateFileSystem */
 
+/** @typedef {TODO} Inspector */
+
 const validate = createSchemaValidation(
 	require("../../schemas/plugins/debug/ProfilingPlugin.check.js"),
 	() => require("../../schemas/plugins/debug/ProfilingPlugin.json"),
@@ -19,16 +34,21 @@ const validate = createSchemaValidation(
 		baseDataPath: "options"
 	}
 );
-let inspector = undefined;
+
+/** @type {Inspector | undefined} */
+let inspector;
 
 try {
-	// eslint-disable-next-line node/no-unsupported-features/node-builtins
+	// eslint-disable-next-line n/no-unsupported-features/node-builtins
 	inspector = require("inspector");
-} catch (e) {
+} catch (_err) {
 	console.log("Unable to CPU profile in < node 8.0");
 }
 
 class Profiler {
+	/**
+	 * @param {Inspector} inspector inspector
+	 */
 	constructor(inspector) {
 		this.session = undefined;
 		this.inspector = inspector;
@@ -64,10 +84,15 @@ class Profiler {
 		]);
 	}
 
+	/**
+	 * @param {string} method method name
+	 * @param {object} [params] params
+	 * @returns {Promise<TODO>} Promise for the result
+	 */
 	sendCommand(method, params) {
 		if (this.hasSession()) {
 			return new Promise((res, rej) => {
-				return this.session.post(method, params, (err, params) => {
+				this.session.post(method, params, (err, params) => {
 					if (err !== null) {
 						rej(err);
 					} else {
@@ -75,9 +100,8 @@ class Profiler {
 					}
 				});
 			});
-		} else {
-			return Promise.resolve();
 		}
+		return Promise.resolve();
 	}
 
 	destroy() {
@@ -92,6 +116,8 @@ class Profiler {
 		return this.sendCommand("Profiler.stop").then(({ profile }) => {
 			const hrtime = process.hrtime();
 			const endTime = hrtime[0] * 1000000 + Math.round(hrtime[1] / 1000);
+			// Avoid coverage problems due indirect changes
+			/* istanbul ignore next */
 			if (profile.startTime < this._startTime || profile.endTime > endTime) {
 				// In some cases timestamps mismatch and we need to adjust them
 				// Both process.hrtime and the inspector timestamps claim to be relative
@@ -110,7 +136,7 @@ class Profiler {
 
 /**
  * an object that wraps Tracer and Profiler with a counter
- * @typedef {Object} Trace
+ * @typedef {object} Trace
  * @property {Tracer} trace instance of Tracer
  * @property {number} counter Counter
  * @property {Profiler} profiler instance of Profiler
@@ -123,10 +149,8 @@ class Profiler {
  * @returns {Trace} The trace object
  */
 const createTrace = (fs, outputPath) => {
-	const trace = new Tracer({
-		noStream: true
-	});
-	const profiler = new Profiler(inspector);
+	const trace = new Tracer();
+	const profiler = new Profiler(/** @type {Inspector} */ (inspector));
 	if (/\/|\\/.test(outputPath)) {
 		const dirPath = dirname(fs, outputPath);
 		mkdirpSync(fs, dirPath);
@@ -173,6 +197,7 @@ const createTrace = (fs, outputPath) => {
 		counter,
 		profiler,
 		end: callback => {
+			trace.push("]");
 			// Wait until the write stream finishes.
 			fsStream.on("close", () => {
 				callback();
@@ -183,7 +208,7 @@ const createTrace = (fs, outputPath) => {
 	};
 };
 
-const pluginName = "ProfilingPlugin";
+const PLUGIN_NAME = "ProfilingPlugin";
 
 class ProfilingPlugin {
 	/**
@@ -194,28 +219,37 @@ class ProfilingPlugin {
 		this.outputPath = options.outputPath || "events.json";
 	}
 
+	/**
+	 * Apply the plugin
+	 * @param {Compiler} compiler the compiler instance
+	 * @returns {void}
+	 */
 	apply(compiler) {
 		const tracer = createTrace(
-			compiler.intermediateFileSystem,
+			/** @type {IntermediateFileSystem} */
+			(compiler.intermediateFileSystem),
 			this.outputPath
 		);
 		tracer.profiler.startProfiling();
 
 		// Compiler Hooks
-		Object.keys(compiler.hooks).forEach(hookName => {
-			compiler.hooks[hookName].intercept(
-				makeInterceptorFor("Compiler", tracer)(hookName)
-			);
-		});
+		for (const hookName of Object.keys(compiler.hooks)) {
+			const hook =
+				compiler.hooks[/** @type {keyof Compiler["hooks"]} */ (hookName)];
+			if (hook) {
+				hook.intercept(makeInterceptorFor("Compiler", tracer)(hookName));
+			}
+		}
 
-		Object.keys(compiler.resolverFactory.hooks).forEach(hookName => {
-			compiler.resolverFactory.hooks[hookName].intercept(
-				makeInterceptorFor("Resolver", tracer)(hookName)
-			);
-		});
+		for (const hookName of Object.keys(compiler.resolverFactory.hooks)) {
+			const hook = compiler.resolverFactory.hooks[hookName];
+			if (hook) {
+				hook.intercept(makeInterceptorFor("Resolver", tracer)(hookName));
+			}
+		}
 
 		compiler.hooks.compilation.tap(
-			pluginName,
+			PLUGIN_NAME,
 			(compilation, { normalModuleFactory, contextModuleFactory }) => {
 				interceptAllHooksFor(compilation, tracer, "Compilation");
 				interceptAllHooksFor(
@@ -236,14 +270,14 @@ class ProfilingPlugin {
 		// We need to write out the CPU profile when we are all done.
 		compiler.hooks.done.tapAsync(
 			{
-				name: pluginName,
+				name: PLUGIN_NAME,
 				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;
 					}
@@ -257,7 +291,9 @@ class ProfilingPlugin {
 						cat: ["toplevel"],
 						ts: cpuStartTime,
 						args: {
+							// eslint-disable-next-line camelcase
 							src_file: "../../ipc/ipc_moji_bootstrap.cc",
+							// eslint-disable-next-line camelcase
 							src_func: "Accept"
 						}
 					});
@@ -291,7 +327,6 @@ class ProfilingPlugin {
 					});
 
 					tracer.profiler.destroy();
-					tracer.trace.flush();
 					tracer.end(callback);
 				});
 			}
@@ -299,36 +334,49 @@ class ProfilingPlugin {
 	}
 }
 
+/**
+ * @param {any} instance instance
+ * @param {Trace} tracer tracer
+ * @param {string} logLabel log label
+ */
 const interceptAllHooksFor = (instance, tracer, logLabel) => {
 	if (Reflect.has(instance, "hooks")) {
-		Object.keys(instance.hooks).forEach(hookName => {
+		for (const hookName of Object.keys(instance.hooks)) {
 			const hook = instance.hooks[hookName];
-			if (!hook._fakeHook) {
+			if (hook && !hook._fakeHook) {
 				hook.intercept(makeInterceptorFor(logLabel, tracer)(hookName));
 			}
-		});
+		}
 	}
 };
 
+/**
+ * @param {NormalModuleFactory} moduleFactory normal module factory
+ * @param {Trace} tracer tracer
+ */
 const interceptAllParserHooks = (moduleFactory, tracer) => {
 	const moduleTypes = [
-		"javascript/auto",
-		"javascript/dynamic",
-		"javascript/esm",
-		"json",
-		"webassembly/async",
-		"webassembly/sync"
+		JAVASCRIPT_MODULE_TYPE_AUTO,
+		JAVASCRIPT_MODULE_TYPE_DYNAMIC,
+		JAVASCRIPT_MODULE_TYPE_ESM,
+		JSON_MODULE_TYPE,
+		WEBASSEMBLY_MODULE_TYPE_ASYNC,
+		WEBASSEMBLY_MODULE_TYPE_SYNC
 	];
 
-	moduleTypes.forEach(moduleType => {
+	for (const moduleType of moduleTypes) {
 		moduleFactory.hooks.parser
 			.for(moduleType)
-			.tap("ProfilingPlugin", (parser, parserOpts) => {
+			.tap(PLUGIN_NAME, (parser, parserOpts) => {
 				interceptAllHooksFor(parser, tracer, "Parser");
 			});
-	});
+	}
 };
 
+/**
+ * @param {Compilation} compilation compilation
+ * @param {Trace} tracer tracer
+ */
 const interceptAllJavascriptModulesPluginHooks = (compilation, tracer) => {
 	interceptAllHooksFor(
 		{
@@ -343,18 +391,18 @@ const interceptAllJavascriptModulesPluginHooks = (compilation, tracer) => {
 };
 
 const makeInterceptorFor = (instance, tracer) => hookName => ({
-	register: ({ name, type, context, fn }) => {
-		const newFn = makeNewProfiledTapFn(hookName, tracer, {
-			name,
-			type,
-			fn
-		});
-		return {
-			name,
-			type,
-			context,
-			fn: newFn
-		};
+	register: tapInfo => {
+		const { name, type, fn } = tapInfo;
+		const newFn =
+			// Don't tap our own hooks to ensure stream can close cleanly
+			name === PLUGIN_NAME
+				? fn
+				: makeNewProfiledTapFn(hookName, tracer, {
+						name,
+						type,
+						fn
+					});
+		return { ...tapInfo, fn: newFn };
 	}
 });
 
@@ -415,7 +463,7 @@ const makeNewProfiledTapFn = (hookName, tracer, { name, type, fn }) => {
 				const id = ++tracer.counter;
 				// Do not instrument ourself due to the CPU
 				// profile needing to be the last event in the trace.
-				if (name === pluginName) {
+				if (name === PLUGIN_NAME) {
 					return fn(...args);
 				}
 
@@ -427,13 +475,13 @@ const makeNewProfiledTapFn = (hookName, tracer, { name, type, fn }) => {
 				let r;
 				try {
 					r = fn(...args);
-				} catch (error) {
+				} catch (err) {
 					tracer.trace.end({
 						name,
 						id,
 						cat: defaultCategory
 					});
-					throw error;
+					throw err;
 				}
 				tracer.trace.end({
 					name,

package/lib/dependencies/AMDDefineDependency.js

@@ -12,12 +12,15 @@ const NullDependency = require("./NullDependency");
 /** @typedef {import("webpack-sources").ReplaceSource} ReplaceSource */
 /** @typedef {import("../Dependency")} Dependency */
 /** @typedef {import("../DependencyTemplate").DependencyTemplateContext} DependencyTemplateContext */
+/** @typedef {import("../javascript/JavascriptParser").Range} Range */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
 
 /** @type {Record<string, { definition: string, content: string, requests: string[] }>} */
 const DEFINITIONS = {
 	f: {
 		definition: "var __WEBPACK_AMD_DEFINE_RESULT__;",
-		content: `!(__WEBPACK_AMD_DEFINE_RESULT__ = (#).call(exports, __webpack_require__, exports, module),
+		content: `!(__WEBPACK_AMD_DEFINE_RESULT__ = (#).call(exports, ${RuntimeGlobals.require}, exports, module),
 		__WEBPACK_AMD_DEFINE_RESULT__ !== undefined && (module.exports = __WEBPACK_AMD_DEFINE_RESULT__))`,
 		requests: [
 			RuntimeGlobals.require,
@@ -35,7 +38,7 @@ const DEFINITIONS = {
 			"var __WEBPACK_AMD_DEFINE_FACTORY__, __WEBPACK_AMD_DEFINE_RESULT__;",
 		content: `!(__WEBPACK_AMD_DEFINE_FACTORY__ = (#),
 		__WEBPACK_AMD_DEFINE_RESULT__ = (typeof __WEBPACK_AMD_DEFINE_FACTORY__ === 'function' ?
-		(__WEBPACK_AMD_DEFINE_FACTORY__.call(exports, __webpack_require__, exports, module)) :
+		(__WEBPACK_AMD_DEFINE_FACTORY__.call(exports, ${RuntimeGlobals.require}, exports, module)) :
 		__WEBPACK_AMD_DEFINE_FACTORY__),
 		__WEBPACK_AMD_DEFINE_RESULT__ !== undefined && (module.exports = __WEBPACK_AMD_DEFINE_RESULT__))`,
 		requests: [
@@ -67,8 +70,7 @@ const DEFINITIONS = {
 	},
 	lf: {
 		definition: "var XXX, XXXmodule;",
-		content:
-			"!(XXXmodule = { id: YYY, exports: {}, loaded: false }, XXX = (#).call(XXXmodule.exports, __webpack_require__, XXXmodule.exports, XXXmodule), XXXmodule.loaded = true, XXX === undefined && (XXX = XXXmodule.exports))",
+		content: `!(XXXmodule = { id: YYY, exports: {}, loaded: false }, XXX = (#).call(XXXmodule.exports, ${RuntimeGlobals.require}, XXXmodule.exports, XXXmodule), XXXmodule.loaded = true, XXX === undefined && (XXX = XXXmodule.exports))`,
 		requests: [RuntimeGlobals.require, RuntimeGlobals.module]
 	},
 	lo: {
@@ -78,8 +80,7 @@ const DEFINITIONS = {
 	},
 	lof: {
 		definition: "var XXX, XXXfactory, XXXmodule;",
-		content:
-			"!(XXXfactory = (#), (typeof XXXfactory === 'function' ? ((XXXmodule = { id: YYY, exports: {}, loaded: false }), (XXX = XXXfactory.call(XXXmodule.exports, __webpack_require__, XXXmodule.exports, XXXmodule)), (XXXmodule.loaded = true), XXX === undefined && (XXX = XXXmodule.exports)) : XXX = XXXfactory))",
+		content: `!(XXXfactory = (#), (typeof XXXfactory === 'function' ? ((XXXmodule = { id: YYY, exports: {}, loaded: false }), (XXX = XXXfactory.call(XXXmodule.exports, ${RuntimeGlobals.require}, XXXmodule.exports, XXXmodule)), (XXXmodule.loaded = true), XXX === undefined && (XXX = XXXmodule.exports)) : XXX = XXXfactory))`,
 		requests: [RuntimeGlobals.require, RuntimeGlobals.module]
 	},
 	laf: {
@@ -105,6 +106,13 @@ const DEFINITIONS = {
 };
 
 class AMDDefineDependency extends NullDependency {
+	/**
+	 * @param {Range} range range
+	 * @param {Range | null} arrayRange array range
+	 * @param {Range | null} functionRange function range
+	 * @param {Range | null} objectRange object range
+	 * @param {string | null} namedModule true, when define is called with a name
+	 */
 	constructor(range, arrayRange, functionRange, objectRange, namedModule) {
 		super();
 		this.range = range;
@@ -119,6 +127,9 @@ class AMDDefineDependency extends NullDependency {
 		return "amd define";
 	}
 
+	/**
+	 * @param {ObjectSerializerContext} context context
+	 */
 	serialize(context) {
 		const { write } = context;
 		write(this.range);
@@ -130,6 +141,9 @@ class AMDDefineDependency extends NullDependency {
 		super.serialize(context);
 	}
 
+	/**
+	 * @param {ObjectDeserializerContext} context context
+	 */
 	deserialize(context) {
 		const { read } = context;
 		this.range = read();
@@ -166,6 +180,10 @@ AMDDefineDependency.Template = class AMDDefineDependencyTemplate extends (
 		this.replace(dep, source, definition, content);
 	}
 
+	/**
+	 * @param {AMDDefineDependency} dependency dependency
+	 * @returns {string} variable name
+	 */
 	localModuleVar(dependency) {
 		return (
 			dependency.localModule &&
@@ -174,6 +192,10 @@ AMDDefineDependency.Template = class AMDDefineDependencyTemplate extends (
 		);
 	}
 
+	/**
+	 * @param {AMDDefineDependency} dependency dependency
+	 * @returns {string} branch
+	 */
 	branch(dependency) {
 		const localModuleVar = this.localModuleVar(dependency) ? "l" : "";
 		const arrayRange = dependency.arrayRange ? "a" : "";
@@ -182,6 +204,12 @@ AMDDefineDependency.Template = class AMDDefineDependencyTemplate extends (
 		return localModuleVar + arrayRange + objectRange + functionRange;
 	}
 
+	/**
+	 * @param {AMDDefineDependency} dependency dependency
+	 * @param {ReplaceSource} source source
+	 * @param {string} definition definition
+	 * @param {string} text text
+	 */
 	replace(dependency, source, definition, text) {
 		const localModuleVar = this.localModuleVar(dependency);
 		if (localModuleVar) {
@@ -202,18 +230,34 @@ AMDDefineDependency.Template = class AMDDefineDependencyTemplate extends (
 
 		let current = dependency.range[0];
 		if (dependency.arrayRange) {
-			source.replace(current, dependency.arrayRange[0] - 1, texts.shift());
+			source.replace(
+				current,
+				dependency.arrayRange[0] - 1,
+				/** @type {string} */ (texts.shift())
+			);
 			current = dependency.arrayRange[1];
 		}
 
 		if (dependency.objectRange) {
-			source.replace(current, dependency.objectRange[0] - 1, texts.shift());
+			source.replace(
+				current,
+				dependency.objectRange[0] - 1,
+				/** @type {string} */ (texts.shift())
+			);
 			current = dependency.objectRange[1];
 		} else if (dependency.functionRange) {
-			source.replace(current, dependency.functionRange[0] - 1, texts.shift());
+			source.replace(
+				current,
+				dependency.functionRange[0] - 1,
+				/** @type {string} */ (texts.shift())
+			);
 			current = dependency.functionRange[1];
 		}
-		source.replace(current, dependency.range[1] - 1, texts.shift());
+		source.replace(
+			current,
+			dependency.range[1] - 1,
+			/** @type {string} */ (texts.shift())
+		);
 		if (texts.length > 0) throw new Error("Implementation error");
 	}
 };