UNPKG

webpack

Version:

Packs ECMAScript/CommonJs/AMD modules for the browser. Allows you to split your codebase into multiple bundles, which can be loaded on demand. Supports loaders to preprocess files, i.e. json, jsx, es7, css, less, ... and your custom stuff.

1,648 lines (1,569 loc) 69 kB
/* MIT License http://www.opensource.org/licenses/mit-license.php Author Tobias Koppers @sokra */ "use strict"; const eslintScope = require("eslint-scope"); const Referencer = require("eslint-scope/lib/referencer"); const { SyncBailHook } = require("tapable"); const { CachedSource, ConcatSource, ReplaceSource } = require("webpack-sources"); const ConcatenationScope = require("../ConcatenationScope"); const { UsageState } = require("../ExportsInfo"); const Module = require("../Module"); const { JAVASCRIPT_TYPE, JAVASCRIPT_TYPES } = require("../ModuleSourceTypeConstants"); const { JAVASCRIPT_MODULE_TYPE_ESM } = require("../ModuleTypeConstants"); const RuntimeGlobals = require("../RuntimeGlobals"); const Template = require("../Template"); const { DEFAULTS } = require("../config/defaults"); const HarmonyImportDependency = require("../dependencies/HarmonyImportDependency"); const { ImportPhaseUtils } = require("../dependencies/ImportPhase"); const JavascriptParser = require("../javascript/JavascriptParser"); const { getMakeDeferredNamespaceModeFromExportsType, getOptimizedDeferredModule } = require("../runtime/MakeDeferredNamespaceObjectRuntime"); const { equals } = require("../util/ArrayHelpers"); const LazySet = require("../util/LazySet"); const { concatComparators } = require("../util/comparators"); const { RESERVED_NAMES, addScopeSymbols, findNewName, getAllReferences, getPathInAst, getUsedNamesInScopeInfo } = require("../util/concatenate"); const createHash = require("../util/createHash"); const { makePathsRelative } = require("../util/identifier"); const makeSerializable = require("../util/makeSerializable"); const propertyAccess = require("../util/propertyAccess"); const { propertyName } = require("../util/propertyName"); const { filterRuntime, intersectRuntime, mergeRuntimeCondition, mergeRuntimeConditionNonFalse, runtimeConditionToString, subtractRuntimeCondition } = require("../util/runtime"); /** @typedef {import("eslint-scope").Reference} Reference */ /** @typedef {import("eslint-scope").Scope} Scope */ /** @typedef {import("eslint-scope").Variable} Variable */ /** @typedef {import("webpack-sources").Source} Source */ /** @typedef {import("../config/defaults").WebpackOptionsNormalizedWithDefaults} WebpackOptions */ /** @typedef {import("../ChunkGraph")} ChunkGraph */ /** @typedef {import("../CodeGenerationResults")} CodeGenerationResults */ /** @typedef {import("../Compilation")} Compilation */ /** @typedef {import("../Dependency").UpdateHashContext} UpdateHashContext */ /** @typedef {import("../DependencyTemplates")} DependencyTemplates */ /** @typedef {import("../ExportsInfo").ExportInfo} ExportInfo */ /** @typedef {import("../Module").BuildCallback} BuildCallback */ /** @typedef {import("../Module").BuildInfo} BuildInfo */ /** @typedef {import("../Module").FileSystemDependencies} FileSystemDependencies */ /** @typedef {import("../Module").BuildMeta} BuildMeta */ /** @typedef {import("../Module").CodeGenerationContext} CodeGenerationContext */ /** @typedef {import("../Module").CodeGenerationResultData} CodeGenerationResultData */ /** @typedef {import("../Module").CodeGenerationResult} CodeGenerationResult */ /** @typedef {import("../Module").LibIdentOptions} LibIdentOptions */ /** @typedef {import("../Module").LibIdent} LibIdent */ /** @typedef {import("../Module").NameForCondition} NameForCondition */ /** @typedef {import("../Module").ReadOnlyRuntimeRequirements} ReadOnlyRuntimeRequirements */ /** @typedef {import("../Module").RuntimeRequirements} RuntimeRequirements */ /** @typedef {import("../Module").SourceTypes} SourceTypes */ /** @typedef {import("../ModuleGraph")} ModuleGraph */ /** @typedef {import("../ModuleGraphConnection")} ModuleGraphConnection */ /** @typedef {import("../ModuleGraphConnection").ConnectionState} ConnectionState */ /** @typedef {import("../RequestShortener")} RequestShortener */ /** @typedef {import("../ResolverFactory").ResolverWithOptions} ResolverWithOptions */ /** @typedef {import("../RuntimeTemplate")} RuntimeTemplate */ /** @typedef {import("../javascript/JavascriptModulesPlugin").ChunkRenderContext} ChunkRenderContext */ /** @typedef {import("../javascript/JavascriptParser").Program} Program */ /** @typedef {import("../javascript/JavascriptParser").Range} Range */ /** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */ /** @typedef {import("../util/Hash")} Hash */ /** @typedef {import("../util/Hash").HashFunction} HashFunction */ /** @typedef {import("../util/concatenate").UsedNames} UsedNames */ /** @typedef {import("../util/concatenate").ScopeInfo} ScopeInfo */ /** @typedef {import("../util/fs").InputFileSystem} InputFileSystem */ /** @typedef {import("../util/identifier").AssociatedObjectForCache} AssociatedObjectForCache */ /** @typedef {import("../util/runtime").RuntimeSpec} RuntimeSpec */ /** * @template T * @typedef {import("../InitFragment")<T>} InitFragment */ /** * @template T * @typedef {import("../util/comparators").Comparator<T>} Comparator */ // fix eslint-scope to support class properties correctly // cspell:word Referencer const ReferencerClass = Referencer; if (!ReferencerClass.prototype.PropertyDefinition) { ReferencerClass.prototype.PropertyDefinition = ReferencerClass.prototype.Property; } /** @typedef {RawBinding | SymbolBinding} Binding */ /** @typedef {string[]} ExportName */ /** * @typedef {object} RawBinding * @property {ModuleInfo} info * @property {string} rawName * @property {string=} comment * @property {ExportName} ids * @property {ExportName} exportName */ /** * @typedef {object} SymbolBinding * @property {ConcatenatedModuleInfo} info * @property {string} name * @property {string=} comment * @property {ExportName} ids * @property {ExportName} exportName */ /** @typedef {ConcatenatedModuleInfo | ExternalModuleInfo} ModuleInfo */ /** @typedef {ConcatenatedModuleInfo | ExternalModuleInfo | ReferenceToModuleInfo} ModuleInfoOrReference */ /** @typedef {Map<string, string>} ExportMap */ /** * @typedef {object} ConcatenatedModuleInfo * @property {"concatenated"} type * @property {Module} module * @property {number} index * @property {Program | undefined} ast * @property {Source | undefined} internalSource * @property {ReplaceSource | undefined} source * @property {InitFragment<ChunkRenderContext>[]=} chunkInitFragments * @property {ReadOnlyRuntimeRequirements | undefined} runtimeRequirements * @property {Scope | undefined} globalScope * @property {Scope | undefined} moduleScope * @property {Map<string, string>} internalNames * @property {ExportMap | undefined} exportMap * @property {ExportMap | undefined} rawExportMap * @property {string=} namespaceExportSymbol * @property {string | undefined} namespaceObjectName * @property {ConcatenationScope | undefined} concatenationScope * @property {boolean} interopNamespaceObjectUsed "default-with-named" namespace * @property {string | undefined} interopNamespaceObjectName "default-with-named" namespace * @property {boolean} interopNamespaceObject2Used "default-only" namespace * @property {string | undefined} interopNamespaceObject2Name "default-only" namespace * @property {boolean} interopDefaultAccessUsed runtime namespace object that detects "__esModule" * @property {string | undefined} interopDefaultAccessName runtime namespace object that detects "__esModule" */ /** * @typedef {object} ExternalModuleInfo * @property {"external"} type * @property {Module} module * @property {RuntimeSpec | boolean} runtimeCondition * @property {NonDeferAccess} nonDeferAccess * @property {number} index * @property {string | undefined} name module.exports / harmony namespace object * @property {string | undefined} deferredName deferred module.exports / harmony namespace object * @property {boolean} deferred the module is deferred at least once * @property {boolean} deferredNamespaceObjectUsed deferred namespace object that being used in a not-analyzable way so it must be materialized * @property {string | undefined} deferredNamespaceObjectName deferred namespace object that being used in a not-analyzable way so it must be materialized * @property {boolean} interopNamespaceObjectUsed "default-with-named" namespace * @property {string | undefined} interopNamespaceObjectName "default-with-named" namespace * @property {boolean} interopNamespaceObject2Used "default-only" namespace * @property {string | undefined} interopNamespaceObject2Name "default-only" namespace * @property {boolean} interopDefaultAccessUsed runtime namespace object that detects "__esModule" * @property {string | undefined} interopDefaultAccessName runtime namespace object that detects "__esModule" */ /** * @typedef {object} ReferenceToModuleInfo * @property {"reference"} type * @property {RuntimeSpec | boolean} runtimeCondition * @property {NonDeferAccess} nonDeferAccess * @property {ModuleInfo} target */ /** * @template T * @param {string} property property * @param {(a: T[keyof T], b: T[keyof T]) => 0 | 1 | -1} comparator comparator * @returns {Comparator<T>} comparator */ const createComparator = (property, comparator) => (a, b) => comparator( a[/** @type {keyof T} */ (property)], b[/** @type {keyof T} */ (property)] ); /** * @param {number} a a * @param {number} b b * @returns {0 | 1 | -1} result */ const compareNumbers = (a, b) => { if (Number.isNaN(a)) { if (!Number.isNaN(b)) { return 1; } } else { if (Number.isNaN(b)) { return -1; } if (a !== b) { return a < b ? -1 : 1; } } return 0; }; const bySourceOrder = createComparator("sourceOrder", compareNumbers); const byRangeStart = createComparator("rangeStart", compareNumbers); /** * @param {Iterable<string>} iterable iterable object * @returns {string} joined iterable object */ const joinIterableWithComma = (iterable) => { // This is more performant than Array.from().join(", ") // as it doesn't create an array let str = ""; let first = true; for (const item of iterable) { if (first) { first = false; } else { str += ", "; } str += item; } return str; }; /** @typedef {boolean} NonDeferAccess */ /** * @param {NonDeferAccess} a a * @param {NonDeferAccess} b b * @returns {NonDeferAccess} merged */ const mergeNonDeferAccess = (a, b) => a || b; /** * @param {NonDeferAccess} a first * @param {NonDeferAccess} b second * @returns {NonDeferAccess} first - second */ const subtractNonDeferAccess = (a, b) => a && !b; /** * @typedef {object} ConcatenationEntry * @property {"concatenated" | "external"} type * @property {Module} module * @property {RuntimeSpec | boolean} runtimeCondition * @property {NonDeferAccess} nonDeferAccess */ /** @typedef {Set<ConcatenatedModuleInfo>} NeededNamespaceObjects */ /** @typedef {Map<Module, ModuleInfo>} ModuleToInfoMap */ /** * @param {ModuleGraph} moduleGraph the module graph * @param {ModuleInfo} info module info * @param {ExportName} exportName exportName * @param {ModuleToInfoMap} moduleToInfoMap moduleToInfoMap * @param {RuntimeSpec} runtime for which runtime * @param {RequestShortener} requestShortener the request shortener * @param {RuntimeTemplate} runtimeTemplate the runtime template * @param {NeededNamespaceObjects} neededNamespaceObjects modules for which a namespace object should be generated * @param {boolean} asCall asCall * @param {boolean} depDeferred the dependency is deferred * @param {boolean | undefined} strictHarmonyModule strictHarmonyModule * @param {boolean | undefined} asiSafe asiSafe * @param {Set<ExportInfo>} alreadyVisited alreadyVisited * @returns {Binding} the final variable */ const getFinalBinding = ( moduleGraph, info, exportName, moduleToInfoMap, runtime, requestShortener, runtimeTemplate, neededNamespaceObjects, asCall, depDeferred, strictHarmonyModule, asiSafe, alreadyVisited = new Set() ) => { const exportsType = info.module.getExportsType( moduleGraph, strictHarmonyModule ); const moduleDeferred = info.type === "external" && info.deferred && !(/** @type {BuildMeta} */ (info.module.buildMeta).async); const deferred = depDeferred && moduleDeferred; if (exportName.length === 0) { switch (exportsType) { case "default-only": if (deferred) info.deferredNamespaceObjectUsed = true; else info.interopNamespaceObject2Used = true; return { info, rawName: /** @type {string} */ ( deferred ? info.deferredNamespaceObjectName : info.interopNamespaceObject2Name ), ids: exportName, exportName }; case "default-with-named": if (deferred) info.deferredNamespaceObjectUsed = true; else info.interopNamespaceObjectUsed = true; return { info, rawName: /** @type {string} */ ( deferred ? info.deferredNamespaceObjectName : info.interopNamespaceObjectName ), ids: exportName, exportName }; case "namespace": case "dynamic": break; default: throw new Error(`Unexpected exportsType ${exportsType}`); } } else { switch (exportsType) { case "namespace": break; case "default-with-named": switch (exportName[0]) { case "default": exportName = exportName.slice(1); break; case "__esModule": return { info, rawName: "/* __esModule */true", ids: exportName.slice(1), exportName }; } break; case "default-only": { const exportId = exportName[0]; if (exportId === "__esModule") { return { info, rawName: "/* __esModule */true", ids: exportName.slice(1), exportName }; } exportName = exportName.slice(1); if (exportId !== "default") { return { info, rawName: "/* non-default import from default-exporting module */undefined", ids: exportName, exportName }; } break; } case "dynamic": switch (exportName[0]) { case "default": { exportName = exportName.slice(1); if (deferred) { return { info, rawName: `${info.deferredName}.a`, ids: exportName, exportName }; } if (moduleDeferred) { return { info, rawName: /** @type {string} */ (info.name), ids: exportName, exportName }; } info.interopDefaultAccessUsed = true; const defaultExport = asCall ? `${info.interopDefaultAccessName}()` : asiSafe ? `(${info.interopDefaultAccessName}())` : asiSafe === false ? `;(${info.interopDefaultAccessName}())` : `${info.interopDefaultAccessName}.a`; return { info, rawName: defaultExport, ids: exportName, exportName }; } case "__esModule": return { info, rawName: "/* __esModule */true", ids: exportName.slice(1), exportName }; } break; default: throw new Error(`Unexpected exportsType ${exportsType}`); } } if (exportName.length === 0) { switch (info.type) { case "concatenated": neededNamespaceObjects.add(info); return { info, rawName: /** @type {NonNullable<ConcatenatedModuleInfo["namespaceObjectName"]>} */ (info.namespaceObjectName), ids: exportName, exportName }; case "external": if (deferred) { info.deferredNamespaceObjectUsed = true; return { info, rawName: /** @type {string} */ (info.deferredNamespaceObjectName), ids: exportName, exportName }; } return { info, rawName: /** @type {NonNullable<ExternalModuleInfo["name"]>} */ (info.name), ids: exportName, exportName }; } } const exportsInfo = moduleGraph.getExportsInfo(info.module); const exportInfo = exportsInfo.getExportInfo(exportName[0]); if (alreadyVisited.has(exportInfo)) { return { info, rawName: "/* circular reexport */ Object(function x() { x() }())", ids: [], exportName }; } alreadyVisited.add(exportInfo); switch (info.type) { case "concatenated": { const exportId = exportName[0]; if (exportInfo.provided === false) { // It's not provided, but it could be on the prototype neededNamespaceObjects.add(info); return { info, rawName: /** @type {string} */ (info.namespaceObjectName), ids: exportName, exportName }; } const directExport = info.exportMap && info.exportMap.get(exportId); if (directExport) { const usedName = /** @type {ExportName} */ ( exportsInfo.getUsedName(exportName, runtime) ); if (!usedName) { return { info, rawName: "/* unused export */ undefined", ids: exportName.slice(1), exportName }; } return { info, name: directExport, ids: usedName.slice(1), exportName }; } const rawExport = info.rawExportMap && info.rawExportMap.get(exportId); if (rawExport) { return { info, rawName: rawExport, ids: exportName.slice(1), exportName }; } const reexport = exportInfo.findTarget(moduleGraph, (module) => moduleToInfoMap.has(module) ); if (reexport === false) { throw new Error( `Target module of reexport from '${info.module.readableIdentifier( requestShortener )}' is not part of the concatenation (export '${exportId}')\nModules in the concatenation:\n${Array.from( moduleToInfoMap, ([m, info]) => ` * ${info.type} ${m.readableIdentifier(requestShortener)}` ).join("\n")}` ); } if (reexport) { const refInfo = moduleToInfoMap.get(reexport.module); return getFinalBinding( moduleGraph, /** @type {ModuleInfo} */ (refInfo), reexport.export ? [...reexport.export, ...exportName.slice(1)] : exportName.slice(1), moduleToInfoMap, runtime, requestShortener, runtimeTemplate, neededNamespaceObjects, asCall, reexport.deferred, /** @type {BuildMeta} */ (info.module.buildMeta).strictHarmonyModule, asiSafe, alreadyVisited ); } if (info.namespaceExportSymbol) { const usedName = /** @type {ExportName} */ ( exportsInfo.getUsedName(exportName, runtime) ); return { info, rawName: /** @type {string} */ (info.namespaceObjectName), ids: usedName, exportName }; } throw new Error( `Cannot get final name for export '${exportName.join( "." )}' of ${info.module.readableIdentifier(requestShortener)}` ); } case "external": { const used = /** @type {ExportName} */ ( exportsInfo.getUsedName(exportName, runtime) ); if (!used) { return { info, rawName: "/* unused export */ undefined", ids: exportName.slice(1), exportName }; } const comment = equals(used, exportName) ? "" : Template.toNormalComment(`${exportName.join(".")}`); return { info, rawName: (deferred ? info.deferredName : info.name) + (deferred ? ".a" : "") + comment, ids: used, exportName }; } } }; /** * @param {ModuleGraph} moduleGraph the module graph * @param {ModuleInfo} info module info * @param {ExportName} exportName exportName * @param {ModuleToInfoMap} moduleToInfoMap moduleToInfoMap * @param {RuntimeSpec} runtime for which runtime * @param {RequestShortener} requestShortener the request shortener * @param {RuntimeTemplate} runtimeTemplate the runtime template * @param {NeededNamespaceObjects} neededNamespaceObjects modules for which a namespace object should be generated * @param {boolean} asCall asCall * @param {boolean} depDeferred the dependency is deferred * @param {boolean | undefined} callContext callContext * @param {boolean | undefined} strictHarmonyModule strictHarmonyModule * @param {boolean | undefined} asiSafe asiSafe * @returns {string} the final name */ const getFinalName = ( moduleGraph, info, exportName, moduleToInfoMap, runtime, requestShortener, runtimeTemplate, neededNamespaceObjects, asCall, depDeferred, callContext, strictHarmonyModule, asiSafe ) => { const binding = getFinalBinding( moduleGraph, info, exportName, moduleToInfoMap, runtime, requestShortener, runtimeTemplate, neededNamespaceObjects, asCall, depDeferred, strictHarmonyModule, asiSafe ); { const { ids, comment } = binding; /** @type {string} */ let reference; /** @type {boolean} */ let isPropertyAccess; if ("rawName" in binding) { reference = `${binding.rawName}${comment || ""}${propertyAccess(ids)}`; isPropertyAccess = ids.length > 0; } else { const { info, name: exportId } = binding; const name = info.internalNames.get(exportId); if (!name) { throw new Error( `The export "${exportId}" in "${info.module.readableIdentifier( requestShortener )}" has no internal name (existing names: ${ Array.from( info.internalNames, ([name, symbol]) => `${name}: ${symbol}` ).join(", ") || "none" })` ); } reference = `${name}${comment || ""}${propertyAccess(ids)}`; isPropertyAccess = ids.length > 1; } if (isPropertyAccess && asCall && callContext === false) { return asiSafe ? `(0,${reference})` : asiSafe === false ? `;(0,${reference})` : `/*#__PURE__*/Object(${reference})`; } return reference; } }; /** * @typedef {object} ConcatenateModuleHooks * @property {SyncBailHook<[ConcatenatedModule, RuntimeSpec[], string, Record<string, string>], boolean>} onDemandExportsGeneration * @property {SyncBailHook<[Partial<ConcatenatedModuleInfo>, ConcatenatedModuleInfo], boolean | void>} concatenatedModuleInfo */ /** @typedef {BuildInfo["topLevelDeclarations"]} TopLevelDeclarations */ /** @type {WeakMap<Compilation, ConcatenateModuleHooks>} */ const compilationHooksMap = new WeakMap(); class ConcatenatedModule extends Module { /** * @param {Module} rootModule the root module of the concatenation * @param {Set<Module>} modules all modules in the concatenation (including the root module) * @param {RuntimeSpec} runtime the runtime * @param {Compilation} compilation the compilation * @param {AssociatedObjectForCache=} associatedObjectForCache object for caching * @param {HashFunction=} hashFunction hash function to use * @returns {ConcatenatedModule} the module */ static create( rootModule, modules, runtime, compilation, associatedObjectForCache, hashFunction = DEFAULTS.HASH_FUNCTION ) { const identifier = ConcatenatedModule._createIdentifier( rootModule, modules, associatedObjectForCache, hashFunction ); return new ConcatenatedModule({ identifier, rootModule, modules, runtime, compilation }); } /** * @param {Compilation} compilation the compilation * @returns {ConcatenateModuleHooks} the attached hooks */ static getCompilationHooks(compilation) { let hooks = compilationHooksMap.get(compilation); if (hooks === undefined) { hooks = { onDemandExportsGeneration: new SyncBailHook([ "module", "runtimes", "exportsFinalName", "exportsSource" ]), concatenatedModuleInfo: new SyncBailHook([ "updatedInfo", "concatenatedModuleInfo" ]) }; compilationHooksMap.set(compilation, hooks); } return hooks; } /** * @param {object} options options * @param {string} options.identifier the identifier of the module * @param {Module} options.rootModule the root module of the concatenation * @param {RuntimeSpec} options.runtime the selected runtime * @param {Set<Module>} options.modules all concatenated modules * @param {Compilation} options.compilation the compilation */ constructor({ identifier, rootModule, modules, runtime, compilation }) { super(JAVASCRIPT_MODULE_TYPE_ESM, null, rootModule && rootModule.layer); // Info from Factory /** @type {string} */ this._identifier = identifier; /** @type {Module} */ this.rootModule = rootModule; /** @type {Set<Module>} */ this._modules = modules; this._runtime = runtime; this.factoryMeta = rootModule && rootModule.factoryMeta; /** @type {Compilation} */ this.compilation = compilation; } /** * Assuming this module is in the cache. Update the (cached) module with * the fresh module from the factory. Usually updates internal references * and properties. * @param {Module} module fresh module * @returns {void} */ updateCacheModule(module) { throw new Error("Must not be called"); } /** * @returns {SourceTypes} types available (do not mutate) */ getSourceTypes() { return JAVASCRIPT_TYPES; } get modules() { return [...this._modules]; } /** * @returns {string} a unique identifier of the module */ identifier() { return this._identifier; } /** * @param {RequestShortener} requestShortener the request shortener * @returns {string} a user readable identifier of the module */ readableIdentifier(requestShortener) { return `${this.rootModule.readableIdentifier( requestShortener )} + ${this._modules.size - 1} modules`; } /** * @param {LibIdentOptions} options options * @returns {LibIdent | null} an identifier for library inclusion */ libIdent(options) { return this.rootModule.libIdent(options); } /** * @returns {NameForCondition | null} absolute path which should be used for condition matching (usually the resource path) */ nameForCondition() { return this.rootModule.nameForCondition(); } /** * @param {ModuleGraph} moduleGraph the module graph * @returns {ConnectionState} how this module should be connected to referencing modules when consumed for side-effects only */ getSideEffectsConnectionState(moduleGraph) { return this.rootModule.getSideEffectsConnectionState(moduleGraph); } /** * @param {WebpackOptions} options webpack options * @param {Compilation} compilation the compilation * @param {ResolverWithOptions} resolver the resolver * @param {InputFileSystem} fs the file system * @param {BuildCallback} callback callback function * @returns {void} */ build(options, compilation, resolver, fs, callback) { const { rootModule } = this; const { moduleArgument, exportsArgument } = /** @type {BuildInfo} */ (rootModule.buildInfo); /** @type {BuildInfo} */ this.buildInfo = { strict: true, cacheable: true, moduleArgument, exportsArgument, fileDependencies: new LazySet(), contextDependencies: new LazySet(), missingDependencies: new LazySet(), topLevelDeclarations: new Set(), assets: undefined }; this.buildMeta = rootModule.buildMeta; this.clearDependenciesAndBlocks(); this.clearWarningsAndErrors(); for (const m of this._modules) { // populate cacheable if (!(/** @type {BuildInfo} */ (m.buildInfo).cacheable)) { this.buildInfo.cacheable = false; } // populate dependencies for (const d of m.dependencies.filter( (dep) => !(dep instanceof HarmonyImportDependency) || !this._modules.has( /** @type {Module} */ (compilation.moduleGraph.getModule(dep)) ) )) { this.dependencies.push(d); } // populate blocks for (const d of m.blocks) { this.blocks.push(d); } // populate warnings const warnings = m.getWarnings(); if (warnings !== undefined) { for (const warning of warnings) { this.addWarning(warning); } } // populate errors const errors = m.getErrors(); if (errors !== undefined) { for (const error of errors) { this.addError(error); } } const { assets, assetsInfo, topLevelDeclarations, needCreateRequire } = /** @type {BuildInfo} */ (m.buildInfo); const buildInfo = this.buildInfo; // populate topLevelDeclarations if (topLevelDeclarations) { const topLevelDeclarations = buildInfo.topLevelDeclarations; if (topLevelDeclarations !== undefined) { for (const decl of topLevelDeclarations) { topLevelDeclarations.add(decl); } } } else { buildInfo.topLevelDeclarations = undefined; } // populate needCreateRequire if (needCreateRequire) { this.buildInfo.needCreateRequire = true; } // populate assets if (assets) { if (buildInfo.assets === undefined) { buildInfo.assets = Object.create(null); } Object.assign( /** @type {NonNullable<BuildInfo["assets"]>} */ (buildInfo.assets), assets ); } if (assetsInfo) { if (buildInfo.assetsInfo === undefined) { buildInfo.assetsInfo = new Map(); } for (const [key, value] of assetsInfo) { buildInfo.assetsInfo.set(key, value); } } } callback(); } /** * @param {string=} type the source type for which the size should be estimated * @returns {number} the estimated size of the module (must be non-zero) */ size(type) { // Guess size from embedded modules let size = 0; for (const module of this._modules) { size += module.size(type); } return size; } /** * @private * @param {Module} rootModule the root of the concatenation * @param {Set<Module>} modulesSet a set of modules which should be concatenated * @param {RuntimeSpec} runtime for this runtime * @param {ModuleGraph} moduleGraph the module graph * @returns {ConcatenationEntry[]} concatenation list */ _createConcatenationList(rootModule, modulesSet, runtime, moduleGraph) { /** @type {ConcatenationEntry[]} */ const list = []; /** @type {Map<Module, { runtimeCondition: RuntimeSpec | true, nonDeferAccess: NonDeferAccess }>} */ const existingEntries = new Map(); /** * @param {Module} module a module * @returns {Iterable<{ connection: ModuleGraphConnection, runtimeCondition: RuntimeSpec | true, nonDeferAccess: NonDeferAccess }>} imported modules in order */ const getConcatenatedImports = (module) => { const connections = [...moduleGraph.getOutgoingConnections(module)]; if (module === rootModule) { for (const c of moduleGraph.getOutgoingConnections(this)) { connections.push(c); } } /** * @type {{ connection: ModuleGraphConnection, sourceOrder: number, rangeStart: number | undefined, defer?: boolean }[]} */ const references = connections .filter((connection) => { if (!(connection.dependency instanceof HarmonyImportDependency)) { return false; } return ( connection && connection.resolvedOriginModule === module && connection.module && connection.isTargetActive(runtime) ); }) .map((connection) => { const dep = /** @type {HarmonyImportDependency} */ (connection.dependency); return { connection, sourceOrder: /** @type {number} */ (dep.sourceOrder), rangeStart: dep.range && dep.range[0], defer: ImportPhaseUtils.isDefer(dep.phase) }; }); /** * bySourceOrder * @example * import a from "a"; // sourceOrder=1 * import b from "b"; // sourceOrder=2 * * byRangeStart * @example * import {a, b} from "a"; // sourceOrder=1 * a.a(); // first range * b.b(); // second range * * If there is no reexport, we have the same source. * If there is reexport, but module has side effects, this will lead to reexport module only. * If there is side-effects-free reexport, we can get simple deterministic result with range start comparison. */ references.sort(concatComparators(bySourceOrder, byRangeStart)); /** @type {Map<Module, { connection: ModuleGraphConnection, runtimeCondition: RuntimeSpec | true, nonDeferAccess: NonDeferAccess }>} */ const referencesMap = new Map(); for (const { connection, defer } of references) { const runtimeCondition = filterRuntime(runtime, (r) => connection.isTargetActive(r) ); if (runtimeCondition === false) continue; const nonDeferAccess = !defer; const module = connection.module; const entry = referencesMap.get(module); if (entry === undefined) { referencesMap.set(module, { connection, runtimeCondition, nonDeferAccess }); continue; } entry.runtimeCondition = mergeRuntimeConditionNonFalse( entry.runtimeCondition, runtimeCondition, runtime ); entry.nonDeferAccess = mergeNonDeferAccess( entry.nonDeferAccess, nonDeferAccess ); } return referencesMap.values(); }; /** * @param {ModuleGraphConnection} connection graph connection * @param {RuntimeSpec | true} runtimeCondition runtime condition * @param {NonDeferAccess} nonDeferAccess non-defer access * @returns {void} */ const enterModule = (connection, runtimeCondition, nonDeferAccess) => { const module = connection.module; if (!module) return; const existingEntry = existingEntries.get(module); if ( existingEntry && existingEntry.runtimeCondition === true && existingEntry.nonDeferAccess === true ) { return; } if (modulesSet.has(module)) { existingEntries.set(module, { runtimeCondition: true, nonDeferAccess: true }); if (runtimeCondition !== true) { throw new Error( `Cannot runtime-conditional concatenate a module (${module.identifier()} in ${this.rootModule.identifier()}, ${runtimeConditionToString( runtimeCondition )}). This should not happen.` ); } if (nonDeferAccess !== true) { throw new Error( `Cannot deferred concatenate a module (${module.identifier()} in ${this.rootModule.identifier()}. This should not happen.` ); } const imports = getConcatenatedImports(module); for (const { connection, runtimeCondition, nonDeferAccess } of imports) { enterModule(connection, runtimeCondition, nonDeferAccess); } list.push({ type: "concatenated", module: connection.module, runtimeCondition, nonDeferAccess }); } else { /** @type {RuntimeSpec | boolean} */ let reducedRuntimeCondition; /** @type {NonDeferAccess} */ let reducedNonDeferAccess; if (existingEntry !== undefined) { reducedRuntimeCondition = subtractRuntimeCondition( runtimeCondition, existingEntry.runtimeCondition, runtime ); reducedNonDeferAccess = subtractNonDeferAccess( nonDeferAccess, existingEntry.nonDeferAccess ); if ( reducedRuntimeCondition === false && reducedNonDeferAccess === false ) { return; } if (reducedRuntimeCondition !== false) { existingEntry.runtimeCondition = mergeRuntimeConditionNonFalse( existingEntry.runtimeCondition, reducedRuntimeCondition, runtime ); } if (reducedNonDeferAccess !== false) { existingEntry.nonDeferAccess = mergeNonDeferAccess( existingEntry.nonDeferAccess, reducedNonDeferAccess ); } } else { reducedRuntimeCondition = runtimeCondition; reducedNonDeferAccess = nonDeferAccess; existingEntries.set(connection.module, { runtimeCondition, nonDeferAccess }); } if (list.length > 0) { const lastItem = list[list.length - 1]; if ( lastItem.type === "external" && lastItem.module === connection.module ) { lastItem.runtimeCondition = mergeRuntimeCondition( lastItem.runtimeCondition, reducedRuntimeCondition, runtime ); lastItem.nonDeferAccess = mergeNonDeferAccess( lastItem.nonDeferAccess, reducedNonDeferAccess ); return; } } list.push({ type: "external", get module() { // We need to use a getter here, because the module in the dependency // could be replaced by some other process (i. e. also replaced with a // concatenated module) return connection.module; }, runtimeCondition: reducedRuntimeCondition, nonDeferAccess: reducedNonDeferAccess }); } }; existingEntries.set(rootModule, { runtimeCondition: true, nonDeferAccess: true }); const imports = getConcatenatedImports(rootModule); for (const { connection, runtimeCondition, nonDeferAccess } of imports) { enterModule(connection, runtimeCondition, nonDeferAccess); } list.push({ type: "concatenated", module: rootModule, runtimeCondition: true, nonDeferAccess: true }); return list; } /** * @param {Module} rootModule the root module of the concatenation * @param {Set<Module>} modules all modules in the concatenation (including the root module) * @param {AssociatedObjectForCache=} associatedObjectForCache object for caching * @param {HashFunction=} hashFunction hash function to use * @returns {string} the identifier */ static _createIdentifier( rootModule, modules, associatedObjectForCache, hashFunction = DEFAULTS.HASH_FUNCTION ) { const cachedMakePathsRelative = makePathsRelative.bindContextCache( /** @type {string} */ (rootModule.context), associatedObjectForCache ); /** @type {string[]} */ const identifiers = []; for (const module of modules) { identifiers.push(cachedMakePathsRelative(module.identifier())); } identifiers.sort(); const hash = createHash(hashFunction); hash.update(identifiers.join(" ")); return `${rootModule.identifier()}|${hash.digest("hex")}`; } /** * @param {FileSystemDependencies} fileDependencies set where file dependencies are added to * @param {FileSystemDependencies} contextDependencies set where context dependencies are added to * @param {FileSystemDependencies} missingDependencies set where missing dependencies are added to * @param {FileSystemDependencies} buildDependencies set where build dependencies are added to */ addCacheDependencies( fileDependencies, contextDependencies, missingDependencies, buildDependencies ) { for (const module of this._modules) { module.addCacheDependencies( fileDependencies, contextDependencies, missingDependencies, buildDependencies ); } } /** * @param {CodeGenerationContext} context context for code generation * @returns {CodeGenerationResult} result */ codeGeneration({ dependencyTemplates, runtimeTemplate, moduleGraph, chunkGraph, runtime: generationRuntime, runtimes, codeGenerationResults }) { const { concatenatedModuleInfo } = ConcatenatedModule.getCompilationHooks( this.compilation ); /** @type {RuntimeRequirements} */ const runtimeRequirements = new Set(); const runtime = intersectRuntime(generationRuntime, this._runtime); const requestShortener = runtimeTemplate.requestShortener; // Meta info for each module const [modulesWithInfo, moduleToInfoMap] = this._getModulesWithInfo( moduleGraph, runtime ); // Set with modules that need a generated namespace object /** @type {NeededNamespaceObjects} */ const neededNamespaceObjects = new Set(); // List of all used names to avoid conflicts const allUsedNames = new Set(RESERVED_NAMES); // Generate source code and analyse scopes // Prepare a ReplaceSource for the final source for (const info of moduleToInfoMap.values()) { this._analyseModule( moduleToInfoMap, info, dependencyTemplates, runtimeTemplate, moduleGraph, chunkGraph, runtime, runtimes, /** @type {CodeGenerationResults} */ (codeGenerationResults), allUsedNames ); } // Updated Top level declarations are created by renaming /** @type {TopLevelDeclarations} */ const topLevelDeclarations = new Set(); // List of additional names in scope for module references /** @type {Map<string, ScopeInfo>} */ const usedNamesInScopeInfo = new Map(); // Set of already checked scopes /** @type {Set<Scope>} */ const ignoredScopes = new Set(); // get all global names for (const info of modulesWithInfo) { if (info.type === "concatenated") { // ignore symbols from moduleScope if (info.moduleScope) { ignoredScopes.add(info.moduleScope); } // The super class expression in class scopes behaves weird // We get ranges of all super class expressions to make // renaming to work correctly /** @typedef {{ range: Range, variables: Variable[] }} ClassInfo */ /** @type {WeakMap<Scope, ClassInfo[]>} */ const superClassCache = new WeakMap(); /** * @param {Scope} scope scope * @returns {ClassInfo[]} result */ const getSuperClassExpressions = (scope) => { const cacheEntry = superClassCache.get(scope); if (cacheEntry !== undefined) return cacheEntry; /** @type {ClassInfo[]} */ const superClassExpressions = []; for (const childScope of scope.childScopes) { if (childScope.type !== "class") continue; const block = childScope.block; if ( (block.type === "ClassDeclaration" || block.type === "ClassExpression") && block.superClass ) { superClassExpressions.push({ range: /** @type {Range} */ (block.superClass.range), variables: childScope.variables }); } } superClassCache.set(scope, superClassExpressions); return superClassExpressions; }; // add global symbols if (info.globalScope) { for (const reference of info.globalScope.through) { const name = reference.identifier.name; if (ConcatenationScope.isModuleReference(name)) { const match = ConcatenationScope.matchModuleReference(name); if (!match) continue; const referencedInfo = modulesWithInfo[match.index]; if (referencedInfo.type === "reference") { throw new Error("Module reference can't point to a reference"); } const binding = getFinalBinding( moduleGraph, referencedInfo, match.ids, moduleToInfoMap, runtime, requestShortener, runtimeTemplate, neededNamespaceObjects, false, match.deferredImport, /** @type {BuildMeta} */ (info.module.buildMeta).strictHarmonyModule, true ); if (!binding.ids) continue; const { usedNames, alreadyCheckedScopes } = getUsedNamesInScopeInfo( usedNamesInScopeInfo, binding.info.module.identifier(), "name" in binding ? binding.name : "" ); for (const expr of getSuperClassExpressions(reference.from)) { if ( expr.range[0] <= /** @type {Range} */ (reference.identifier.range)[0] && expr.range[1] >= /** @type {Range} */ (reference.identifier.range)[1] ) { for (const variable of expr.variables) { usedNames.add(variable.name); } } } addScopeSymbols( reference.from, usedNames, alreadyCheckedScopes, ignoredScopes ); } else { allUsedNames.add(name); } } } } } /** * @param {string} name the name to find a new name for * @param {ConcatenatedModuleInfo} info the info of the module * @param {Reference[]} references the references to the name * @returns {string | undefined} the new name or undefined if the name is not found */ const _findNewName = (name, info, references) => { const { usedNames, alreadyCheckedScopes } = getUsedNamesInScopeInfo( usedNamesInScopeInfo, info.module.identifier(), name ); if (allUsedNames.has(name) || usedNames.has(name)) { for (const ref of references) { addScopeSymbols( ref.from, usedNames, alreadyCheckedScopes, ignoredScopes ); } const newName = findNewName( name, allUsedNames, usedNames, info.module.readableIdentifier(requestShortener) ); allUsedNames.add(newName); info.internalNames.set(name, newName); topLevelDeclarations.add(newName); return newName; } }; /** * @param {string} name the name to find a new name for * @param {ConcatenatedModuleInfo} info the info of the module * @param {Reference[]} references the references to the name * @returns {string | undefined} the new name or undefined if the name is not found */ const _findNewNameForSpecifier = (name, info, references) => { const { usedNames: moduleUsedNames, alreadyCheckedScopes } = getUsedNamesInScopeInfo( usedNamesInScopeInfo, info.module.identifier(), name ); /** @type {UsedNames} */ const referencesUsedNames = new Set(); for (const ref of references) { addScopeSymbols( ref.from, referencesUsedNames, alreadyCheckedScopes, ignoredScopes ); } if (moduleUsedNames.has(name) || referencesUsedNames.has(name)) { const newName = findNewName( name, allUsedNames, new Set([...moduleUsedNames, ...referencesUsedNames]), info.module.readableIdentifier(requestShortener) ); allUsedNames.add(newName); topLevelDeclarations.add(newName); return newName; } }; // generate names for symbols for (const info of moduleToInfoMap.values()) { const { usedNames: namespaceObjectUsedNames } = getUsedNamesInScopeInfo( usedNamesInScopeInfo, info.module.identifier(), "" ); switch (info.type) { case "concatenated": { const variables = /** @type {Scope} */ (info.moduleScope).variables; for (const variable of variables) { const name = variable.name; const references = getAllReferences(variable); const newName = _findNewName(name, info, references); if (newName) { const source = /** @type {ReplaceSource} */ (info.source); const allIdentifiers = new Set([ ...references.map((r) => r.identifier), ...variable.identifiers ]); for (const identifier of allIdentifiers) { const r = /** @type {Range} */ (identifier.range); const path = getPathInAst( /** @type {NonNullable<ConcatenatedModuleInfo["ast"]>} */ (info.ast), identifier ); if (path && path.length > 1) { const maybeProperty = path[1].type === "AssignmentPattern" && path[1].left === path[0] ? path[2] : path[1]; if ( maybeProperty.type === "Property" && maybeProperty.shorthand ) { source.insert(r[1], `: ${newName}`); continue; } } source.replace(r[0], r[1] - 1, newName); } } else { allUsedNames.add(name); info.internalNames.set(name, name); topLevelDeclarations.add(name); } } /** @type {string} */ let namespaceObjectName; if (info.namespaceExportSymbol) { namespaceObjectName = /** @type {string} */ (info.internalNames.get(info.namespaceExportSymbol)); } else { namespaceObjectName = findNewName( "namespaceObject", allUsedNames, namespaceObjectUsedNames, info.module.readableIdentifier(requestShortener) ); allUsedNames.add(namespaceObjectName); } info.namespaceObjectName = namespaceObjectName; topLevelDeclarations.add(namespaceObjectName); break; } case "external": { const externalName = findNewName( "", allUsedNames, namespaceObjectUsedNames, info.module.readableIdentifier(requestShortener) ); allUsedNames.add(externalName); info.name = externalName; topLevelDeclarations.add(externalName); if (info.deferred) { const externalName = findNewName( "deferred", allUsedNames, namespaceObjectUsedNames, info.module.readableIdentifier(requestShortener) ); allUsedNames.add(externalName); info.deferredName = externalName; topLevelDeclarations.add(externalName); const externalNameInterop = findNewName( "deferredNamespaceObject", allUsedNames, namespaceObjectUsedNames, info.module.readableIdentifier(requestShortener) ); allUsedNames.add(externalNameInterop); info.deferredNamespaceObjectName = externalNameInterop; topLevelDeclarations.add(externalNameInterop); } break; } } const buildMeta = /** @type {BuildMeta} */ (info.module.buildMeta); if (buildMeta.exportsType !== "namespace") { const externalNameInterop = findNewName( "namespaceObject", allUsedNames, namespaceObjectUsedNames, info.module.readableIdentifier(requestShortener) ); allUsedNames.add(externalNameInterop); info.interopNamespaceObjectName = externalNameInterop; topLevelDeclarations.add(externalNameInterop); } if ( buildMeta.exportsType === "default" && buildMeta.defaultObject !== "redirect" && info.interopNamespaceObject2Used ) { const externalNameInterop = findNewName( "namespaceObject2", allUsedNames, namespaceObjectUsedNames, info.module.readableIdentifier(requestShortener) ); allUsedNames.add(externalNameInterop); info.interopNamespaceObject2Name = externalNameInterop; topLevelDeclarations.add(externalNameInterop); } if (buildMeta.exportsType === "dynamic" || !buildMeta.exportsType) { const externalNameInterop = findNewName( "default", allUsedNames, namespaceObjectUsedNames, info.module.readableIdentifier(requestShortener) ); allUsedNames.add(externalNameInterop); info.interopDefaultAccessName = externalNameInterop; topLevelDeclarations.add(externalNameInterop); } } // Find and replace references to modules for (const info of moduleToInfoMap.values()) { if (info.type === "concatenated") { const globalScope = /** @type {Scope} */ (info.globalScope); // group references by name /** @type {Map<string, Reference[]>} */ const referencesByName = new Map(); for (const ref