webpack 5.76.1 → 5.88.0

package/lib/javascript/JavascriptModulesPlugin.js

@@ -18,6 +18,12 @@ const Compilation = require("../Compilation");
 const { tryRunOrWebpackError } = require("../HookWebpackError");
 const HotUpdateChunk = require("../HotUpdateChunk");
 const InitFragment = require("../InitFragment");
+const {
+	JAVASCRIPT_MODULE_TYPE_AUTO,
+	JAVASCRIPT_MODULE_TYPE_DYNAMIC,
+	JAVASCRIPT_MODULE_TYPE_ESM,
+	WEBPACK_MODULE_TYPE_RUNTIME
+} = require("../ModuleTypeConstants");
 const RuntimeGlobals = require("../RuntimeGlobals");
 const Template = require("../Template");
 const { last, someInIterable } = require("../util/IterableHelpers");
@@ -124,8 +130,8 @@ const printGeneratedCodeForStack = (module, code) => {
  * @property {SyncWaterfallHook<[Source, Module, StartupRenderContext]>} renderStartup
  * @property {SyncWaterfallHook<[string, RenderBootstrapContext]>} renderRequire
  * @property {SyncBailHook<[Module, RenderBootstrapContext], string>} inlineInRuntimeBailout
- * @property {SyncBailHook<[Module, RenderContext], string>} embedInRuntimeBailout
- * @property {SyncBailHook<[RenderContext], string>} strictRuntimeBailout
+ * @property {SyncBailHook<[Module, RenderContext], string | void>} embedInRuntimeBailout
+ * @property {SyncBailHook<[RenderContext], string | void>} strictRuntimeBailout
  * @property {SyncHook<[Chunk, Hash, ChunkHashContext]>} chunkHash
  * @property {SyncBailHook<[Chunk, RenderContext], boolean>} useSourceMap
  */
@@ -133,6 +139,8 @@ const printGeneratedCodeForStack = (module, code) => {
 /** @type {WeakMap<Compilation, CompilationHooks>} */
 const compilationHooksMap = new WeakMap();
 
+const PLUGIN_NAME = "JavascriptModulesPlugin";
+
 class JavascriptModulesPlugin {
 	/**
 	 * @param {Compilation} compilation the compilation
@@ -196,154 +204,147 @@ class JavascriptModulesPlugin {
 	 */
 	apply(compiler) {
 		compiler.hooks.compilation.tap(
-			"JavascriptModulesPlugin",
+			PLUGIN_NAME,
 			(compilation, { normalModuleFactory }) => {
 				const hooks = JavascriptModulesPlugin.getCompilationHooks(compilation);
 				normalModuleFactory.hooks.createParser
-					.for("javascript/auto")
-					.tap("JavascriptModulesPlugin", options => {
+					.for(JAVASCRIPT_MODULE_TYPE_AUTO)
+					.tap(PLUGIN_NAME, options => {
 						return new JavascriptParser("auto");
 					});
 				normalModuleFactory.hooks.createParser
-					.for("javascript/dynamic")
-					.tap("JavascriptModulesPlugin", options => {
+					.for(JAVASCRIPT_MODULE_TYPE_DYNAMIC)
+					.tap(PLUGIN_NAME, options => {
 						return new JavascriptParser("script");
 					});
 				normalModuleFactory.hooks.createParser
-					.for("javascript/esm")
-					.tap("JavascriptModulesPlugin", options => {
+					.for(JAVASCRIPT_MODULE_TYPE_ESM)
+					.tap(PLUGIN_NAME, options => {
 						return new JavascriptParser("module");
 					});
 				normalModuleFactory.hooks.createGenerator
-					.for("javascript/auto")
-					.tap("JavascriptModulesPlugin", () => {
+					.for(JAVASCRIPT_MODULE_TYPE_AUTO)
+					.tap(PLUGIN_NAME, () => {
 						return new JavascriptGenerator();
 					});
 				normalModuleFactory.hooks.createGenerator
-					.for("javascript/dynamic")
-					.tap("JavascriptModulesPlugin", () => {
+					.for(JAVASCRIPT_MODULE_TYPE_DYNAMIC)
+					.tap(PLUGIN_NAME, () => {
 						return new JavascriptGenerator();
 					});
 				normalModuleFactory.hooks.createGenerator
-					.for("javascript/esm")
-					.tap("JavascriptModulesPlugin", () => {
+					.for(JAVASCRIPT_MODULE_TYPE_ESM)
+					.tap(PLUGIN_NAME, () => {
 						return new JavascriptGenerator();
 					});
-				compilation.hooks.renderManifest.tap(
-					"JavascriptModulesPlugin",
-					(result, options) => {
-						const {
-							hash,
-							chunk,
-							chunkGraph,
-							moduleGraph,
-							runtimeTemplate,
-							dependencyTemplates,
-							outputOptions,
-							codeGenerationResults
-						} = options;
+				compilation.hooks.renderManifest.tap(PLUGIN_NAME, (result, options) => {
+					const {
+						hash,
+						chunk,
+						chunkGraph,
+						moduleGraph,
+						runtimeTemplate,
+						dependencyTemplates,
+						outputOptions,
+						codeGenerationResults
+					} = options;
 
-						const hotUpdateChunk =
-							chunk instanceof HotUpdateChunk ? chunk : null;
+					const hotUpdateChunk = chunk instanceof HotUpdateChunk ? chunk : null;
 
-						let render;
-						const filenameTemplate =
-							JavascriptModulesPlugin.getChunkFilenameTemplate(
-								chunk,
-								outputOptions
+					let render;
+					const filenameTemplate =
+						JavascriptModulesPlugin.getChunkFilenameTemplate(
+							chunk,
+							outputOptions
+						);
+					if (hotUpdateChunk) {
+						render = () =>
+							this.renderChunk(
+								{
+									chunk,
+									dependencyTemplates,
+									runtimeTemplate,
+									moduleGraph,
+									chunkGraph,
+									codeGenerationResults,
+									strictMode: runtimeTemplate.isModule()
+								},
+								hooks
 							);
-						if (hotUpdateChunk) {
-							render = () =>
-								this.renderChunk(
-									{
-										chunk,
-										dependencyTemplates,
-										runtimeTemplate,
-										moduleGraph,
-										chunkGraph,
-										codeGenerationResults,
-										strictMode: runtimeTemplate.isModule()
-									},
-									hooks
-								);
-						} else if (chunk.hasRuntime()) {
-							render = () =>
-								this.renderMain(
-									{
-										hash,
-										chunk,
-										dependencyTemplates,
-										runtimeTemplate,
-										moduleGraph,
-										chunkGraph,
-										codeGenerationResults,
-										strictMode: runtimeTemplate.isModule()
-									},
-									hooks,
-									compilation
-								);
-						} else {
-							if (!chunkHasJs(chunk, chunkGraph)) {
-								return result;
-							}
-
-							render = () =>
-								this.renderChunk(
-									{
-										chunk,
-										dependencyTemplates,
-										runtimeTemplate,
-										moduleGraph,
-										chunkGraph,
-										codeGenerationResults,
-										strictMode: runtimeTemplate.isModule()
-									},
-									hooks
-								);
+					} else if (chunk.hasRuntime()) {
+						render = () =>
+							this.renderMain(
+								{
+									hash,
+									chunk,
+									dependencyTemplates,
+									runtimeTemplate,
+									moduleGraph,
+									chunkGraph,
+									codeGenerationResults,
+									strictMode: runtimeTemplate.isModule()
+								},
+								hooks,
+								compilation
+							);
+					} else {
+						if (!chunkHasJs(chunk, chunkGraph)) {
+							return result;
 						}
 
-						result.push({
-							render,
-							filenameTemplate,
-							pathOptions: {
-								hash,
-								runtime: chunk.runtime,
-								chunk,
-								contentHashType: "javascript"
-							},
-							info: {
-								javascriptModule: compilation.runtimeTemplate.isModule()
-							},
-							identifier: hotUpdateChunk
-								? `hotupdatechunk${chunk.id}`
-								: `chunk${chunk.id}`,
-							hash: chunk.contentHash.javascript
-						});
-
-						return result;
-					}
-				);
-				compilation.hooks.chunkHash.tap(
-					"JavascriptModulesPlugin",
-					(chunk, hash, context) => {
-						hooks.chunkHash.call(chunk, hash, context);
-						if (chunk.hasRuntime()) {
-							this.updateHashWithBootstrap(
-								hash,
+						render = () =>
+							this.renderChunk(
 								{
-									hash: "0000",
 									chunk,
-									codeGenerationResults: context.codeGenerationResults,
-									chunkGraph: context.chunkGraph,
-									moduleGraph: context.moduleGraph,
-									runtimeTemplate: context.runtimeTemplate
+									dependencyTemplates,
+									runtimeTemplate,
+									moduleGraph,
+									chunkGraph,
+									codeGenerationResults,
+									strictMode: runtimeTemplate.isModule()
 								},
 								hooks
 							);
-						}
 					}
-				);
-				compilation.hooks.contentHash.tap("JavascriptModulesPlugin", chunk => {
+
+					result.push({
+						render,
+						filenameTemplate,
+						pathOptions: {
+							hash,
+							runtime: chunk.runtime,
+							chunk,
+							contentHashType: "javascript"
+						},
+						info: {
+							javascriptModule: compilation.runtimeTemplate.isModule()
+						},
+						identifier: hotUpdateChunk
+							? `hotupdatechunk${chunk.id}`
+							: `chunk${chunk.id}`,
+						hash: chunk.contentHash.javascript
+					});
+
+					return result;
+				});
+				compilation.hooks.chunkHash.tap(PLUGIN_NAME, (chunk, hash, context) => {
+					hooks.chunkHash.call(chunk, hash, context);
+					if (chunk.hasRuntime()) {
+						this.updateHashWithBootstrap(
+							hash,
+							{
+								hash: "0000",
+								chunk,
+								codeGenerationResults: context.codeGenerationResults,
+								chunkGraph: context.chunkGraph,
+								moduleGraph: context.moduleGraph,
+								runtimeTemplate: context.runtimeTemplate
+							},
+							hooks
+						);
+					}
+				});
+				compilation.hooks.contentHash.tap(PLUGIN_NAME, chunk => {
 					const {
 						chunkGraph,
 						codeGenerationResults,
@@ -394,7 +395,7 @@ class JavascriptModulesPlugin {
 					}
 					const runtimeModules = chunkGraph.getChunkModulesIterableBySourceType(
 						chunk,
-						"runtime"
+						WEBPACK_MODULE_TYPE_RUNTIME
 					);
 					if (runtimeModules) {
 						const xor = new StringXor();
@@ -410,7 +411,7 @@ class JavascriptModulesPlugin {
 					);
 				});
 				compilation.hooks.additionalTreeRuntimeRequirements.tap(
-					"JavascriptModulesPlugin",
+					PLUGIN_NAME,
 					(chunk, set, { chunkGraph }) => {
 						if (
 							!set.has(RuntimeGlobals.startupNoDefault) &&
@@ -421,58 +422,51 @@ class JavascriptModulesPlugin {
 						}
 					}
 				);
-				compilation.hooks.executeModule.tap(
-					"JavascriptModulesPlugin",
-					(options, context) => {
-						const source =
-							options.codeGenerationResult.sources.get("javascript");
-						if (source === undefined) return;
-						const { module, moduleObject } = options;
-						const code = source.source();
+				compilation.hooks.executeModule.tap(PLUGIN_NAME, (options, context) => {
+					const source = options.codeGenerationResult.sources.get("javascript");
+					if (source === undefined) return;
+					const { module, moduleObject } = options;
+					const code = source.source();
 
-						const fn = vm.runInThisContext(
-							`(function(${module.moduleArgument}, ${module.exportsArgument}, __webpack_require__) {\n${code}\n/**/})`,
-							{
-								filename: module.identifier(),
-								lineOffset: -1
-							}
-						);
-						try {
-							fn.call(
-								moduleObject.exports,
-								moduleObject,
-								moduleObject.exports,
-								context.__webpack_require__
-							);
-						} catch (e) {
-							e.stack += printGeneratedCodeForStack(options.module, code);
-							throw e;
+					const fn = vm.runInThisContext(
+						`(function(${module.moduleArgument}, ${module.exportsArgument}, ${RuntimeGlobals.require}) {\n${code}\n/**/})`,
+						{
+							filename: module.identifier(),
+							lineOffset: -1
 						}
+					);
+					try {
+						fn.call(
+							moduleObject.exports,
+							moduleObject,
+							moduleObject.exports,
+							context.__webpack_require__
+						);
+					} catch (e) {
+						e.stack += printGeneratedCodeForStack(options.module, code);
+						throw e;
 					}
-				);
-				compilation.hooks.executeModule.tap(
-					"JavascriptModulesPlugin",
-					(options, context) => {
-						const source = options.codeGenerationResult.sources.get("runtime");
-						if (source === undefined) return;
-						let code = source.source();
-						if (typeof code !== "string") code = code.toString();
+				});
+				compilation.hooks.executeModule.tap(PLUGIN_NAME, (options, context) => {
+					const source = options.codeGenerationResult.sources.get("runtime");
+					if (source === undefined) return;
+					let code = source.source();
+					if (typeof code !== "string") code = code.toString();
 
-						const fn = vm.runInThisContext(
-							`(function(__webpack_require__) {\n${code}\n/**/})`,
-							{
-								filename: options.module.identifier(),
-								lineOffset: -1
-							}
-						);
-						try {
-							fn.call(null, context.__webpack_require__);
-						} catch (e) {
-							e.stack += printGeneratedCodeForStack(options.module, code);
-							throw e;
+					const fn = vm.runInThisContext(
+						`(function(${RuntimeGlobals.require}) {\n${code}\n/**/})`,
+						{
+							filename: options.module.identifier(),
+							lineOffset: -1
 						}
+					);
+					try {
+						fn.call(null, context.__webpack_require__);
+					} catch (e) {
+						e.stack += printGeneratedCodeForStack(options.module, code);
+						throw e;
 					}
-				);
+				});
 			}
 		);
 	}
@@ -563,7 +557,7 @@ class JavascriptModulesPlugin {
 								? module.exportsArgument
 								: "__unused_webpack_" + module.exportsArgument
 						);
-					if (needRequire) args.push("__webpack_require__");
+					if (needRequire) args.push(RuntimeGlobals.require);
 					if (!needThisAsExports && runtimeTemplate.supportsArrowFunction()) {
 						factorySource.add("/***/ ((" + args.join(", ") + ") => {\n\n");
 					} else {
@@ -697,6 +691,7 @@ class JavascriptModulesPlugin {
 		);
 
 		const hasEntryModules = chunkGraph.getNumberOfEntryModules(chunk) > 0;
+		/** @type {Set<Module> | undefined} */
 		let inlinedModules;
 		if (bootstrap.allowInlineStartup && hasEntryModules) {
 			inlinedModules = new Set(chunkGraph.getChunkEntryModulesIterable(chunk));
@@ -738,7 +733,9 @@ class JavascriptModulesPlugin {
 		const chunkModules = Template.renderChunkModules(
 			chunkRenderContext,
 			inlinedModules
-				? allModules.filter(m => !inlinedModules.has(m))
+				? allModules.filter(
+						m => !(/** @type {Set<Module>} */ (inlinedModules).has(m))
+				  )
 				: allModules,
 			module => this.renderModule(module, chunkRenderContext, hooks, true),
 			prefix
@@ -804,7 +801,7 @@ class JavascriptModulesPlugin {
 			}
 			const lastInlinedModule = last(inlinedModules);
 			const startupSource = new ConcatSource();
-			startupSource.add(`var __webpack_exports__ = {};\n`);
+			startupSource.add(`var ${RuntimeGlobals.exports} = {};\n`);
 			for (const m of inlinedModules) {
 				const renderedModule = this.renderModule(
 					m,
@@ -820,7 +817,7 @@ class JavascriptModulesPlugin {
 					);
 					const exports = runtimeRequirements.has(RuntimeGlobals.exports);
 					const webpackExports =
-						exports && m.exportsArgument === "__webpack_exports__";
+						exports && m.exportsArgument === RuntimeGlobals.exports;
 					let iife = innerStrict
 						? "it need to be in strict mode."
 						: inlinedModules.size > 1
@@ -852,9 +849,9 @@ class JavascriptModulesPlugin {
 					if (exports) {
 						if (m !== lastInlinedModule)
 							startupSource.add(`var ${m.exportsArgument} = {};\n`);
-						else if (m.exportsArgument !== "__webpack_exports__")
+						else if (m.exportsArgument !== RuntimeGlobals.exports)
 							startupSource.add(
-								`var ${m.exportsArgument} = __webpack_exports__;\n`
+								`var ${m.exportsArgument} = ${RuntimeGlobals.exports};\n`
 							);
 					}
 					startupSource.add(renderedModule);
@@ -863,7 +860,7 @@ class JavascriptModulesPlugin {
 			}
 			if (runtimeRequirements.has(RuntimeGlobals.onChunksLoaded)) {
 				startupSource.add(
-					`__webpack_exports__ = ${RuntimeGlobals.onChunksLoaded}(__webpack_exports__);\n`
+					`${RuntimeGlobals.exports} = ${RuntimeGlobals.onChunksLoaded}(${RuntimeGlobals.exports});\n`
 				);
 			}
 			source.add(
@@ -915,7 +912,7 @@ class JavascriptModulesPlugin {
 			hasEntryModules &&
 			runtimeRequirements.has(RuntimeGlobals.returnExportsFromRuntime)
 		) {
-			source.add(`${prefix}return __webpack_exports__;\n`);
+			source.add(`${prefix}return ${RuntimeGlobals.exports};\n`);
 		}
 		if (iife) {
 			source.add("/******/ })()\n");
@@ -940,6 +937,7 @@ class JavascriptModulesPlugin {
 				"JavascriptModulesPlugin error: JavascriptModulesPlugin.getCompilationHooks().renderContent plugins should return something"
 			);
 		}
+
 		finalSource = InitFragment.addToSource(
 			finalSource,
 			chunkRenderContext.chunkInitFragments,
@@ -1044,13 +1042,13 @@ class JavascriptModulesPlugin {
 
 		if (useRequire) {
 			buf.push("// The require function");
-			buf.push(`function __webpack_require__(moduleId) {`);
+			buf.push(`function ${RuntimeGlobals.require}(moduleId) {`);
 			buf.push(Template.indent(this.renderRequire(renderContext, hooks)));
 			buf.push("}");
 			buf.push("");
 		} else if (runtimeRequirements.has(RuntimeGlobals.requireScope)) {
 			buf.push("// The require scope");
-			buf.push("var __webpack_require__ = {};");
+			buf.push(`var ${RuntimeGlobals.require} = {};`);
 			buf.push("");
 		}
 
@@ -1164,32 +1162,32 @@ class JavascriptModulesPlugin {
 					}
 					if (chunks.length > 0) {
 						buf2.push(
-							`${i === 0 ? "var __webpack_exports__ = " : ""}${
+							`${i === 0 ? `var ${RuntimeGlobals.exports} = ` : ""}${
 								RuntimeGlobals.onChunksLoaded
 							}(undefined, ${JSON.stringify(
 								chunks.map(c => c.id)
 							)}, ${runtimeTemplate.returningFunction(
-								`__webpack_require__(${moduleIdExpr})`
+								`${RuntimeGlobals.require}(${moduleIdExpr})`
 							)})`
 						);
 					} else if (useRequire) {
 						buf2.push(
-							`${
-								i === 0 ? "var __webpack_exports__ = " : ""
-							}__webpack_require__(${moduleIdExpr});`
+							`${i === 0 ? `var ${RuntimeGlobals.exports} = ` : ""}${
+								RuntimeGlobals.require
+							}(${moduleIdExpr});`
 						);
 					} else {
-						if (i === 0) buf2.push("var __webpack_exports__ = {};");
+						if (i === 0) buf2.push(`var ${RuntimeGlobals.exports} = {};`);
 						if (requireScopeUsed) {
 							buf2.push(
 								`__webpack_modules__[${moduleIdExpr}](0, ${
-									i === 0 ? "__webpack_exports__" : "{}"
-								}, __webpack_require__);`
+									i === 0 ? RuntimeGlobals.exports : "{}"
+								}, ${RuntimeGlobals.require});`
 							);
 						} else if (entryRuntimeRequirements.has(RuntimeGlobals.exports)) {
 							buf2.push(
 								`__webpack_modules__[${moduleIdExpr}](0, ${
-									i === 0 ? "__webpack_exports__" : "{}"
+									i === 0 ? RuntimeGlobals.exports : "{}"
 								});`
 							);
 						} else {
@@ -1199,7 +1197,7 @@ class JavascriptModulesPlugin {
 				}
 				if (runtimeRequirements.has(RuntimeGlobals.onChunksLoaded)) {
 					buf2.push(
-						`__webpack_exports__ = ${RuntimeGlobals.onChunksLoaded}(__webpack_exports__);`
+						`${RuntimeGlobals.exports} = ${RuntimeGlobals.onChunksLoaded}(${RuntimeGlobals.exports});`
 					);
 				}
 				if (
@@ -1212,13 +1210,13 @@ class JavascriptModulesPlugin {
 					buf.push(
 						`${RuntimeGlobals.startup} = ${runtimeTemplate.basicFunction("", [
 							...buf2,
-							"return __webpack_exports__;"
+							`return ${RuntimeGlobals.exports};`
 						])};`
 					);
 					buf.push("");
 					startup.push("// run startup");
 					startup.push(
-						`var __webpack_exports__ = ${RuntimeGlobals.startup}();`
+						`var ${RuntimeGlobals.exports} = ${RuntimeGlobals.startup}();`
 					);
 				} else if (runtimeRequirements.has(RuntimeGlobals.startupOnlyBefore)) {
 					buf.push("// the startup function");
@@ -1266,7 +1264,9 @@ class JavascriptModulesPlugin {
 				`${RuntimeGlobals.startup} = ${runtimeTemplate.emptyFunction()};`
 			);
 			startup.push("// run startup");
-			startup.push(`var __webpack_exports__ = ${RuntimeGlobals.startup}();`);
+			startup.push(
+				`var ${RuntimeGlobals.exports} = ${RuntimeGlobals.startup}();`
+			);
 		}
 		return result;
 	}
@@ -1287,17 +1287,17 @@ class JavascriptModulesPlugin {
 			RuntimeGlobals.interceptModuleExecution
 		)
 			? Template.asString([
-					"var execOptions = { id: moduleId, module: module, factory: __webpack_modules__[moduleId], require: __webpack_require__ };",
+					`var execOptions = { id: moduleId, module: module, factory: __webpack_modules__[moduleId], require: ${RuntimeGlobals.require} };`,
 					`${RuntimeGlobals.interceptModuleExecution}.forEach(function(handler) { handler(execOptions); });`,
 					"module = execOptions.module;",
 					"execOptions.factory.call(module.exports, module, module.exports, execOptions.require);"
 			  ])
 			: runtimeRequirements.has(RuntimeGlobals.thisAsExports)
 			? Template.asString([
-					"__webpack_modules__[moduleId].call(module.exports, module, module.exports, __webpack_require__);"
+					`__webpack_modules__[moduleId].call(module.exports, module, module.exports, ${RuntimeGlobals.require});`
 			  ])
 			: Template.asString([
-					"__webpack_modules__[moduleId](module, module.exports, __webpack_require__);"
+					`__webpack_modules__[moduleId](module, module.exports, ${RuntimeGlobals.require});`
 			  ]);
 		const needModuleId = runtimeRequirements.has(RuntimeGlobals.moduleId);
 		const needModuleLoaded = runtimeRequirements.has(
@@ -1352,7 +1352,7 @@ class JavascriptModulesPlugin {
 				? Template.asString([
 						"",
 						"// Flag the module as loaded",
-						"module.loaded = true;",
+						`${RuntimeGlobals.moduleLoaded} = true;`,
 						""
 				  ])
 				: "",