webpack 5.97.1 → 5.104.1

package/lib/javascript/CommonJsChunkFormatPlugin.js

@@ -9,18 +9,20 @@ const { ConcatSource, RawSource } = require("webpack-sources");
 const RuntimeGlobals = require("../RuntimeGlobals");
 const Template = require("../Template");
 const { getUndoPath } = require("../util/identifier");
+const {
+	createChunkHashHandler,
+	getChunkInfo
+} = require("./ChunkFormatHelpers");
 const {
 	getChunkFilenameTemplate,
 	getCompilationHooks
 } = require("./JavascriptModulesPlugin");
-const {
-	generateEntryStartup,
-	updateHashForEntryStartup
-} = require("./StartupHelpers");
+const { generateEntryStartup } = require("./StartupHelpers");
 
 /** @typedef {import("../Chunk")} Chunk */
 /** @typedef {import("../Compiler")} Compiler */
-/** @typedef {import("../Entrypoint")} Entrypoint */
+
+const PLUGIN_NAME = "CommonJsChunkFormatPlugin";
 
 class CommonJsChunkFormatPlugin {
 	/**
@@ -29,146 +31,117 @@ class CommonJsChunkFormatPlugin {
 	 * @returns {void}
 	 */
 	apply(compiler) {
-		compiler.hooks.thisCompilation.tap(
-			"CommonJsChunkFormatPlugin",
-			compilation => {
-				compilation.hooks.additionalChunkRuntimeRequirements.tap(
-					"CommonJsChunkFormatPlugin",
-					(chunk, set, { chunkGraph }) => {
-						if (chunk.hasRuntime()) return;
-						if (chunkGraph.getNumberOfEntryModules(chunk) > 0) {
-							set.add(RuntimeGlobals.require);
-							set.add(RuntimeGlobals.startupEntrypoint);
-							set.add(RuntimeGlobals.externalInstallChunk);
-						}
+		compiler.hooks.thisCompilation.tap(PLUGIN_NAME, (compilation) => {
+			compilation.hooks.additionalChunkRuntimeRequirements.tap(
+				PLUGIN_NAME,
+				(chunk, set, { chunkGraph }) => {
+					if (chunk.hasRuntime()) return;
+					if (chunkGraph.getNumberOfEntryModules(chunk) > 0) {
+						set.add(RuntimeGlobals.require);
+						set.add(RuntimeGlobals.startupEntrypoint);
+						set.add(RuntimeGlobals.externalInstallChunk);
 					}
-				);
-				const hooks = getCompilationHooks(compilation);
-				hooks.renderChunk.tap(
-					"CommonJsChunkFormatPlugin",
-					(modules, renderContext) => {
-						const { chunk, chunkGraph, runtimeTemplate } = renderContext;
-						const source = new ConcatSource();
-						source.add(`exports.id = ${JSON.stringify(chunk.id)};\n`);
-						source.add(`exports.ids = ${JSON.stringify(chunk.ids)};\n`);
-						source.add("exports.modules = ");
-						source.add(modules);
-						source.add(";\n");
-						const runtimeModules =
-							chunkGraph.getChunkRuntimeModulesInOrder(chunk);
-						if (runtimeModules.length > 0) {
-							source.add("exports.runtime =\n");
-							source.add(
-								Template.renderChunkRuntimeModules(
-									runtimeModules,
-									renderContext
-								)
-							);
-						}
-						const entries = Array.from(
-							chunkGraph.getChunkEntryModulesWithChunkGroupIterable(chunk)
-						);
-						if (entries.length > 0) {
-							const runtimeChunk =
-								/** @type {Entrypoint} */
-								(entries[0][1]).getRuntimeChunk();
-							const currentOutputName = compilation
-								.getPath(
-									getChunkFilenameTemplate(chunk, compilation.outputOptions),
-									{
-										chunk,
-										contentHashType: "javascript"
-									}
-								)
-								.replace(/^\/+/g, "")
-								.split("/");
-							const runtimeOutputName = compilation
-								.getPath(
-									getChunkFilenameTemplate(
-										/** @type {Chunk} */
-										(runtimeChunk),
-										compilation.outputOptions
-									),
-									{
-										chunk: /** @type {Chunk} */ (runtimeChunk),
-										contentHashType: "javascript"
-									}
-								)
-								.replace(/^\/+/g, "")
-								.split("/");
-
-							// remove common parts
-							while (
-								currentOutputName.length > 1 &&
-								runtimeOutputName.length > 1 &&
-								currentOutputName[0] === runtimeOutputName[0]
-							) {
-								currentOutputName.shift();
-								runtimeOutputName.shift();
+				}
+			);
+			const hooks = getCompilationHooks(compilation);
+			hooks.renderChunk.tap(PLUGIN_NAME, (modules, renderContext) => {
+				const { chunk, chunkGraph, runtimeTemplate } = renderContext;
+				const source = new ConcatSource();
+				source.add(`exports.id = ${JSON.stringify(chunk.id)};\n`);
+				source.add(`exports.ids = ${JSON.stringify(chunk.ids)};\n`);
+				source.add("exports.modules = ");
+				source.add(modules);
+				source.add(";\n");
+				const runtimeModules = chunkGraph.getChunkRuntimeModulesInOrder(chunk);
+				if (runtimeModules.length > 0) {
+					source.add("exports.runtime =\n");
+					source.add(
+						Template.renderChunkRuntimeModules(runtimeModules, renderContext)
+					);
+				}
+				const { entries, runtimeChunk } = getChunkInfo(chunk, chunkGraph);
+				if (runtimeChunk) {
+					const currentOutputName = compilation
+						.getPath(
+							getChunkFilenameTemplate(chunk, compilation.outputOptions),
+							{
+								chunk,
+								contentHashType: "javascript"
+							}
+						)
+						.replace(/^\/+/g, "")
+						.split("/");
+					const runtimeOutputName = compilation
+						.getPath(
+							getChunkFilenameTemplate(
+								/** @type {Chunk} */
+								(runtimeChunk),
+								compilation.outputOptions
+							),
+							{
+								chunk: /** @type {Chunk} */ (runtimeChunk),
+								contentHashType: "javascript"
 							}
-							const last = runtimeOutputName.join("/");
-							// create final path
-							const runtimePath =
-								getUndoPath(currentOutputName.join("/"), last, true) + last;
+						)
+						.replace(/^\/+/g, "")
+						.split("/");
 
-							const entrySource = new ConcatSource();
-							entrySource.add(
-								`(${
-									runtimeTemplate.supportsArrowFunction()
-										? "() => "
-										: "function() "
-								}{\n`
-							);
-							entrySource.add("var exports = {};\n");
-							entrySource.add(source);
-							entrySource.add(";\n\n// load runtime\n");
-							entrySource.add(
-								`var ${RuntimeGlobals.require} = require(${JSON.stringify(
-									runtimePath
-								)});\n`
-							);
-							entrySource.add(
-								`${RuntimeGlobals.externalInstallChunk}(exports);\n`
-							);
-							const startupSource = new RawSource(
-								generateEntryStartup(
-									chunkGraph,
-									runtimeTemplate,
-									entries,
-									chunk,
-									false
-								)
-							);
-							entrySource.add(
-								hooks.renderStartup.call(
-									startupSource,
-									entries[entries.length - 1][0],
-									{
-										...renderContext,
-										inlined: false
-									}
-								)
-							);
-							entrySource.add("\n})()");
-							return entrySource;
-						}
-						return source;
+					// remove common parts
+					while (
+						currentOutputName.length > 1 &&
+						runtimeOutputName.length > 1 &&
+						currentOutputName[0] === runtimeOutputName[0]
+					) {
+						currentOutputName.shift();
+						runtimeOutputName.shift();
 					}
-				);
-				hooks.chunkHash.tap(
-					"CommonJsChunkFormatPlugin",
-					(chunk, hash, { chunkGraph }) => {
-						if (chunk.hasRuntime()) return;
-						hash.update("CommonJsChunkFormatPlugin");
-						hash.update("1");
-						const entries = Array.from(
-							chunkGraph.getChunkEntryModulesWithChunkGroupIterable(chunk)
-						);
-						updateHashForEntryStartup(hash, chunkGraph, entries, chunk);
-					}
-				);
-			}
-		);
+					const last = runtimeOutputName.join("/");
+					// create final path
+					const runtimePath =
+						getUndoPath(currentOutputName.join("/"), last, true) + last;
+
+					const entrySource = new ConcatSource();
+					entrySource.add(
+						`(${
+							runtimeTemplate.supportsArrowFunction() ? "() => " : "function() "
+						}{\n`
+					);
+					entrySource.add("var exports = {};\n");
+					entrySource.add(source);
+					entrySource.add(";\n\n// load runtime\n");
+					entrySource.add(
+						`var ${RuntimeGlobals.require} = require(${JSON.stringify(
+							runtimePath
+						)});\n`
+					);
+					entrySource.add(`${RuntimeGlobals.externalInstallChunk}(exports);\n`);
+					const startupSource = new RawSource(
+						generateEntryStartup(
+							chunkGraph,
+							runtimeTemplate,
+							entries,
+							chunk,
+							false
+						)
+					);
+					entrySource.add(
+						hooks.renderStartup.call(
+							startupSource,
+							entries[entries.length - 1][0],
+							{
+								...renderContext,
+								inlined: false
+							}
+						)
+					);
+					entrySource.add("\n})()");
+					return entrySource;
+				}
+				return source;
+			});
+
+			hooks.chunkHash.tap(PLUGIN_NAME, createChunkHashHandler(PLUGIN_NAME));
+		});
 	}
 }
 

package/lib/javascript/EnableChunkLoadingPlugin.js

@@ -15,7 +15,7 @@ const enabledTypes = new WeakMap();
  * @param {Compiler} compiler compiler
  * @returns {Set<ChunkLoadingType>} enabled types
  */
-const getEnabledTypes = compiler => {
+const getEnabledTypes = (compiler) => {
 	let set = enabledTypes.get(compiler);
 	if (set === undefined) {
 		set = new Set();
@@ -53,9 +53,7 @@ class EnableChunkLoadingPlugin {
 					"EnableChunkLoadingPlugin need to be used to enable this type of chunk loading. " +
 					'This usually happens through the "output.enabledChunkLoadingTypes" option. ' +
 					'If you are using a function as entry which sets "chunkLoading", you need to add all potential chunk loading types to "output.enabledChunkLoadingTypes". ' +
-					`These types are enabled: ${Array.from(
-						getEnabledTypes(compiler)
-					).join(", ")}`
+					`These types are enabled: ${[...getEnabledTypes(compiler)].join(", ")}`
 			);
 		}
 	}
@@ -77,17 +75,20 @@ class EnableChunkLoadingPlugin {
 			switch (type) {
 				case "jsonp": {
 					const JsonpChunkLoadingPlugin = require("../web/JsonpChunkLoadingPlugin");
+
 					new JsonpChunkLoadingPlugin().apply(compiler);
 					break;
 				}
 				case "import-scripts": {
 					const ImportScriptsChunkLoadingPlugin = require("../webworker/ImportScriptsChunkLoadingPlugin");
+
 					new ImportScriptsChunkLoadingPlugin().apply(compiler);
 					break;
 				}
 				case "require": {
 					// @ts-expect-error https://github.com/microsoft/TypeScript/issues/41697
 					const CommonJsChunkLoadingPlugin = require("../node/CommonJsChunkLoadingPlugin");
+
 					new CommonJsChunkLoadingPlugin({
 						asyncChunkLoading: false
 					}).apply(compiler);
@@ -96,6 +97,7 @@ class EnableChunkLoadingPlugin {
 				case "async-node": {
 					// @ts-expect-error https://github.com/microsoft/TypeScript/issues/41697
 					const CommonJsChunkLoadingPlugin = require("../node/CommonJsChunkLoadingPlugin");
+
 					new CommonJsChunkLoadingPlugin({
 						asyncChunkLoading: true
 					}).apply(compiler);
@@ -104,6 +106,7 @@ class EnableChunkLoadingPlugin {
 				case "import":
 				case "universal": {
 					const ModuleChunkLoadingPlugin = require("../esm/ModuleChunkLoadingPlugin");
+
 					new ModuleChunkLoadingPlugin().apply(compiler);
 					break;
 				}

package/lib/javascript/JavascriptGenerator.js

@@ -9,21 +9,33 @@ const util = require("util");
 const { RawSource, ReplaceSource } = require("webpack-sources");
 const Generator = require("../Generator");
 const InitFragment = require("../InitFragment");
-const { JS_TYPES } = require("../ModuleSourceTypesConstants");
+const { JAVASCRIPT_TYPES } = require("../ModuleSourceTypeConstants");
 const HarmonyCompatibilityDependency = require("../dependencies/HarmonyCompatibilityDependency");
 
 /** @typedef {import("webpack-sources").Source} Source */
+/** @typedef {import("../Compilation").DependencyConstructor} DependencyConstructor */
 /** @typedef {import("../DependenciesBlock")} DependenciesBlock */
 /** @typedef {import("../Dependency")} Dependency */
 /** @typedef {import("../DependencyTemplate")} DependencyTemplate */
 /** @typedef {import("../DependencyTemplate").DependencyTemplateContext} DependencyTemplateContext */
-/** @typedef {import("../DependencyTemplates")} DependencyTemplates */
 /** @typedef {import("../Generator").GenerateContext} GenerateContext */
 /** @typedef {import("../Module")} Module */
 /** @typedef {import("../Module").ConcatenationBailoutReasonContext} ConcatenationBailoutReasonContext */
+/** @typedef {import("../Module").SourceType} SourceType */
 /** @typedef {import("../Module").SourceTypes} SourceTypes */
 /** @typedef {import("../NormalModule")} NormalModule */
-/** @typedef {import("../RuntimeTemplate")} RuntimeTemplate */
+
+const DEFAULT_SOURCE = {
+	source() {
+		return new RawSource("throw new Error('No source available');");
+	},
+	/**
+	 * @returns {number} size of the DEFAULT_SOURCE.source()
+	 */
+	size() {
+		return 39;
+	}
+};
 
 // TODO: clean up this file
 // replace with newer constructs
@@ -36,7 +48,7 @@ const deprecatedGetInitFragments = util.deprecate(
 	 * @returns {InitFragment<GenerateContext>[]} init fragments
 	 */
 	(template, dependency, templateContext) =>
-		/** @type {DependencyTemplate & { getInitFragments: function(Dependency, DependencyTemplateContext): InitFragment<GenerateContext>[] }} */
+		/** @type {DependencyTemplate & { getInitFragments: (dependency: Dependency, dependencyTemplateContext: DependencyTemplateContext) => InitFragment<GenerateContext>[] }} */
 		(template).getInitFragments(dependency, templateContext),
 	"DependencyTemplate.getInitFragment is deprecated (use apply(dep, source, { initFragments }) instead)",
 	"DEP_WEBPACK_JAVASCRIPT_GENERATOR_GET_INIT_FRAGMENTS"
@@ -48,18 +60,18 @@ class JavascriptGenerator extends Generator {
 	 * @returns {SourceTypes} available types (do not mutate)
 	 */
 	getTypes(module) {
-		return JS_TYPES;
+		return JAVASCRIPT_TYPES;
 	}
 
 	/**
 	 * @param {NormalModule} module the module
-	 * @param {string=} type source type
+	 * @param {SourceType=} type source type
 	 * @returns {number} estimate size of the module
 	 */
 	getSize(module, type) {
 		const originalSource = module.originalSource();
 		if (!originalSource) {
-			return 39;
+			return DEFAULT_SOURCE.size();
 		}
 		return originalSource.size();
 	}
@@ -76,7 +88,7 @@ class JavascriptGenerator extends Generator {
 			module.buildMeta.exportsType !== "namespace" ||
 			module.presentationalDependencies === undefined ||
 			!module.presentationalDependencies.some(
-				d => d instanceof HarmonyCompatibilityDependency
+				(d) => d instanceof HarmonyCompatibilityDependency
 			)
 		) {
 			return "Module is not an ECMAScript module";
@@ -90,97 +102,6 @@ class JavascriptGenerator extends Generator {
 		}
 	}
 
-	/**
-	 * @param {NormalModule} module module for which the code should be generated
-	 * @param {GenerateContext} generateContext context for generate
-	 * @returns {Source | null} generated code
-	 */
-	generate(module, generateContext) {
-		const originalSource = module.originalSource();
-		if (!originalSource) {
-			return new RawSource("throw new Error('No source available');");
-		}
-
-		const source = new ReplaceSource(originalSource);
-		/** @type {InitFragment<GenerateContext>[]} */
-		const initFragments = [];
-
-		this.sourceModule(module, initFragments, source, generateContext);
-
-		return InitFragment.addToSource(source, initFragments, generateContext);
-	}
-
-	/**
-	 * @param {Module} module the module to generate
-	 * @param {InitFragment<GenerateContext>[]} initFragments mutable list of init fragments
-	 * @param {ReplaceSource} source the current replace source which can be modified
-	 * @param {GenerateContext} generateContext the generateContext
-	 * @returns {void}
-	 */
-	sourceModule(module, initFragments, source, generateContext) {
-		for (const dependency of module.dependencies) {
-			this.sourceDependency(
-				module,
-				dependency,
-				initFragments,
-				source,
-				generateContext
-			);
-		}
-
-		if (module.presentationalDependencies !== undefined) {
-			for (const dependency of module.presentationalDependencies) {
-				this.sourceDependency(
-					module,
-					dependency,
-					initFragments,
-					source,
-					generateContext
-				);
-			}
-		}
-
-		for (const childBlock of module.blocks) {
-			this.sourceBlock(
-				module,
-				childBlock,
-				initFragments,
-				source,
-				generateContext
-			);
-		}
-	}
-
-	/**
-	 * @param {Module} module the module to generate
-	 * @param {DependenciesBlock} block the dependencies block which will be processed
-	 * @param {InitFragment<GenerateContext>[]} initFragments mutable list of init fragments
-	 * @param {ReplaceSource} source the current replace source which can be modified
-	 * @param {GenerateContext} generateContext the generateContext
-	 * @returns {void}
-	 */
-	sourceBlock(module, block, initFragments, source, generateContext) {
-		for (const dependency of block.dependencies) {
-			this.sourceDependency(
-				module,
-				dependency,
-				initFragments,
-				source,
-				generateContext
-			);
-		}
-
-		for (const childBlock of block.blocks) {
-			this.sourceBlock(
-				module,
-				childBlock,
-				initFragments,
-				source,
-				generateContext
-			);
-		}
-	}
-
 	/**
 	 * @param {Module} module the current module
 	 * @param {Dependency} dependency the dependency to generate
@@ -191,7 +112,7 @@ class JavascriptGenerator extends Generator {
 	 */
 	sourceDependency(module, dependency, initFragments, source, generateContext) {
 		const constructor =
-			/** @type {new (...args: EXPECTED_ANY[]) => Dependency} */
+			/** @type {DependencyConstructor} */
 			(dependency.constructor);
 		const template = generateContext.dependencyTemplates.get(constructor);
 		if (!template) {
@@ -250,6 +171,107 @@ class JavascriptGenerator extends Generator {
 			}
 		}
 	}
+
+	/**
+	 * @param {Module} module the module to generate
+	 * @param {DependenciesBlock} block the dependencies block which will be processed
+	 * @param {InitFragment<GenerateContext>[]} initFragments mutable list of init fragments
+	 * @param {ReplaceSource} source the current replace source which can be modified
+	 * @param {GenerateContext} generateContext the generateContext
+	 * @returns {void}
+	 */
+	sourceBlock(module, block, initFragments, source, generateContext) {
+		for (const dependency of block.dependencies) {
+			this.sourceDependency(
+				module,
+				dependency,
+				initFragments,
+				source,
+				generateContext
+			);
+		}
+
+		for (const childBlock of block.blocks) {
+			this.sourceBlock(
+				module,
+				childBlock,
+				initFragments,
+				source,
+				generateContext
+			);
+		}
+	}
+
+	/**
+	 * @param {Module} module the module to generate
+	 * @param {InitFragment<GenerateContext>[]} initFragments mutable list of init fragments
+	 * @param {ReplaceSource} source the current replace source which can be modified
+	 * @param {GenerateContext} generateContext the generateContext
+	 * @returns {void}
+	 */
+	sourceModule(module, initFragments, source, generateContext) {
+		for (const dependency of module.dependencies) {
+			this.sourceDependency(
+				module,
+				dependency,
+				initFragments,
+				source,
+				generateContext
+			);
+		}
+
+		if (module.presentationalDependencies !== undefined) {
+			for (const dependency of module.presentationalDependencies) {
+				this.sourceDependency(
+					module,
+					dependency,
+					initFragments,
+					source,
+					generateContext
+				);
+			}
+		}
+
+		for (const childBlock of module.blocks) {
+			this.sourceBlock(
+				module,
+				childBlock,
+				initFragments,
+				source,
+				generateContext
+			);
+		}
+	}
+
+	/**
+	 * @param {NormalModule} module module for which the code should be generated
+	 * @param {GenerateContext} generateContext context for generate
+	 * @returns {Source | null} generated code
+	 */
+	generate(module, generateContext) {
+		const originalSource = module.originalSource();
+		if (!originalSource) {
+			return DEFAULT_SOURCE.source();
+		}
+
+		const source = new ReplaceSource(originalSource);
+		/** @type {InitFragment<GenerateContext>[]} */
+		const initFragments = [];
+
+		this.sourceModule(module, initFragments, source, generateContext);
+
+		return InitFragment.addToSource(source, initFragments, generateContext);
+	}
+
+	/**
+	 * @param {Error} error the error
+	 * @param {NormalModule} module module for which the code should be generated
+	 * @param {GenerateContext} generateContext context for generate
+	 * @returns {Source | null} generated code
+	 */
+	generateError(error, module, generateContext) {
+		return new RawSource(`throw new Error(${JSON.stringify(error.message)});`);
+	}
 }
 
 module.exports = JavascriptGenerator;