12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241 |
- /*
- MIT License http://www.opensource.org/licenses/mit-license.php
- Author Tobias Koppers @sokra
- */
- "use strict";
- const { OriginalSource, RawSource } = require("webpack-sources");
- const AsyncDependenciesBlock = require("./AsyncDependenciesBlock");
- const { makeWebpackError } = require("./HookWebpackError");
- const Module = require("./Module");
- const { JAVASCRIPT_MODULE_TYPE_DYNAMIC } = require("./ModuleTypeConstants");
- const RuntimeGlobals = require("./RuntimeGlobals");
- const Template = require("./Template");
- const WebpackError = require("./WebpackError");
- const {
- compareLocations,
- concatComparators,
- compareSelect,
- keepOriginalOrder,
- compareModulesById
- } = require("./util/comparators");
- const {
- contextify,
- parseResource,
- makePathsRelative
- } = require("./util/identifier");
- const makeSerializable = require("./util/makeSerializable");
- /** @typedef {import("webpack-sources").Source} Source */
- /** @typedef {import("../declarations/WebpackOptions").WebpackOptionsNormalized} WebpackOptions */
- /** @typedef {import("./Chunk")} Chunk */
- /** @typedef {import("./ChunkGraph")} ChunkGraph */
- /** @typedef {import("./ChunkGraph").ModuleId} ModuleId */
- /** @typedef {import("./ChunkGroup").RawChunkGroupOptions} RawChunkGroupOptions */
- /** @typedef {import("./Compilation")} Compilation */
- /** @typedef {import("./Dependency")} Dependency */
- /** @typedef {import("./DependencyTemplates")} DependencyTemplates */
- /** @typedef {import("./Module").BuildInfo} BuildInfo */
- /** @typedef {import("./Module").BuildMeta} BuildMeta */
- /** @typedef {import("./Module").CodeGenerationContext} CodeGenerationContext */
- /** @typedef {import("./Module").CodeGenerationResult} CodeGenerationResult */
- /** @typedef {import("./Module").LibIdentOptions} LibIdentOptions */
- /** @typedef {import("./Module").NeedBuildContext} NeedBuildContext */
- /** @typedef {import("./Module").SourceTypes} SourceTypes */
- /** @typedef {import("./ModuleGraph")} ModuleGraph */
- /** @typedef {import("./RequestShortener")} RequestShortener */
- /** @typedef {import("./ResolverFactory").ResolverWithOptions} ResolverWithOptions */
- /** @typedef {import("./RuntimeTemplate")} RuntimeTemplate */
- /** @typedef {import("./dependencies/ContextElementDependency")} ContextElementDependency */
- /** @typedef {import("./javascript/JavascriptParser").ImportAttributes} ImportAttributes */
- /** @typedef {import("./serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
- /** @typedef {import("./serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
- /** @template T @typedef {import("./util/LazySet")<T>} LazySet<T> */
- /** @typedef {import("./util/fs").InputFileSystem} InputFileSystem */
- /** @typedef {"sync" | "eager" | "weak" | "async-weak" | "lazy" | "lazy-once"} ContextMode Context mode */
- /**
- * @typedef {object} ContextOptions
- * @property {ContextMode} mode
- * @property {boolean} recursive
- * @property {RegExp} regExp
- * @property {"strict"|boolean=} namespaceObject
- * @property {string=} addon
- * @property {string=} chunkName
- * @property {RegExp=} include
- * @property {RegExp=} exclude
- * @property {RawChunkGroupOptions=} groupOptions
- * @property {string=} typePrefix
- * @property {string=} category
- * @property {(string[][] | null)=} referencedExports exports referenced from modules (won't be mangled)
- * @property {string=} layer
- * @property {ImportAttributes=} attributes
- */
- /**
- * @typedef {object} ContextModuleOptionsExtras
- * @property {false|string|string[]} resource
- * @property {string=} resourceQuery
- * @property {string=} resourceFragment
- * @property {TODO} resolveOptions
- */
- /** @typedef {ContextOptions & ContextModuleOptionsExtras} ContextModuleOptions */
- /**
- * @callback ResolveDependenciesCallback
- * @param {(Error | null)=} err
- * @param {ContextElementDependency[]=} dependencies
- */
- /**
- * @callback ResolveDependencies
- * @param {InputFileSystem} fs
- * @param {ContextModuleOptions} options
- * @param {ResolveDependenciesCallback} callback
- */
- /** @typedef {1 | 3 | 7 | 9} FakeMapType */
- /** @typedef {Map<string, string | number> | FakeMapType} FakeMap */
- const SNAPSHOT_OPTIONS = { timestamp: true };
- const TYPES = new Set(["javascript"]);
- class ContextModule extends Module {
- /**
- * @param {ResolveDependencies} resolveDependencies function to get dependencies in this context
- * @param {ContextModuleOptions} options options object
- */
- constructor(resolveDependencies, options) {
- if (!options || typeof options.resource === "string") {
- const parsed = parseResource(
- options ? /** @type {string} */ (options.resource) : ""
- );
- const resource = parsed.path;
- const resourceQuery = (options && options.resourceQuery) || parsed.query;
- const resourceFragment =
- (options && options.resourceFragment) || parsed.fragment;
- const layer = options && options.layer;
- super(JAVASCRIPT_MODULE_TYPE_DYNAMIC, resource, layer);
- /** @type {ContextModuleOptions} */
- this.options = {
- ...options,
- resource,
- resourceQuery,
- resourceFragment
- };
- } else {
- super(JAVASCRIPT_MODULE_TYPE_DYNAMIC, undefined, options.layer);
- /** @type {ContextModuleOptions} */
- this.options = {
- ...options,
- resource: options.resource,
- resourceQuery: options.resourceQuery || "",
- resourceFragment: options.resourceFragment || ""
- };
- }
- // Info from Factory
- /** @type {ResolveDependencies | undefined} */
- this.resolveDependencies = resolveDependencies;
- if (options && options.resolveOptions !== undefined) {
- this.resolveOptions = options.resolveOptions;
- }
- if (options && typeof options.mode !== "string") {
- throw new Error("options.mode is a required option");
- }
- this._identifier = this._createIdentifier();
- this._forceBuild = true;
- }
- /**
- * @returns {SourceTypes} types available (do not mutate)
- */
- getSourceTypes() {
- return TYPES;
- }
- /**
- * 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) {
- const m = /** @type {ContextModule} */ (module);
- this.resolveDependencies = m.resolveDependencies;
- this.options = m.options;
- }
- /**
- * Assuming this module is in the cache. Remove internal references to allow freeing some memory.
- */
- cleanupForCache() {
- super.cleanupForCache();
- this.resolveDependencies = undefined;
- }
- /**
- * @private
- * @param {RegExp} regexString RegExp as a string
- * @param {boolean=} stripSlash do we need to strip a slsh
- * @returns {string} pretty RegExp
- */
- _prettyRegExp(regexString, stripSlash = true) {
- const str = stripSlash
- ? regexString.source + regexString.flags
- : regexString + "";
- return str.replace(/!/g, "%21").replace(/\|/g, "%7C");
- }
- _createIdentifier() {
- let identifier =
- this.context ||
- (typeof this.options.resource === "string" ||
- this.options.resource === false
- ? `${this.options.resource}`
- : this.options.resource.join("|"));
- if (this.options.resourceQuery) {
- identifier += `|${this.options.resourceQuery}`;
- }
- if (this.options.resourceFragment) {
- identifier += `|${this.options.resourceFragment}`;
- }
- if (this.options.mode) {
- identifier += `|${this.options.mode}`;
- }
- if (!this.options.recursive) {
- identifier += "|nonrecursive";
- }
- if (this.options.addon) {
- identifier += `|${this.options.addon}`;
- }
- if (this.options.regExp) {
- identifier += `|${this._prettyRegExp(this.options.regExp, false)}`;
- }
- if (this.options.include) {
- identifier += `|include: ${this._prettyRegExp(
- this.options.include,
- false
- )}`;
- }
- if (this.options.exclude) {
- identifier += `|exclude: ${this._prettyRegExp(
- this.options.exclude,
- false
- )}`;
- }
- if (this.options.referencedExports) {
- identifier += `|referencedExports: ${JSON.stringify(
- this.options.referencedExports
- )}`;
- }
- if (this.options.chunkName) {
- identifier += `|chunkName: ${this.options.chunkName}`;
- }
- if (this.options.groupOptions) {
- identifier += `|groupOptions: ${JSON.stringify(
- this.options.groupOptions
- )}`;
- }
- if (this.options.namespaceObject === "strict") {
- identifier += "|strict namespace object";
- } else if (this.options.namespaceObject) {
- identifier += "|namespace object";
- }
- if (this.layer) {
- identifier += `|layer: ${this.layer}`;
- }
- return identifier;
- }
- /**
- * @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) {
- let identifier;
- if (this.context) {
- identifier = requestShortener.shorten(this.context) + "/";
- } else if (
- typeof this.options.resource === "string" ||
- this.options.resource === false
- ) {
- identifier = requestShortener.shorten(`${this.options.resource}`) + "/";
- } else {
- identifier = this.options.resource
- .map(r => requestShortener.shorten(r) + "/")
- .join(" ");
- }
- if (this.options.resourceQuery) {
- identifier += ` ${this.options.resourceQuery}`;
- }
- if (this.options.mode) {
- identifier += ` ${this.options.mode}`;
- }
- if (!this.options.recursive) {
- identifier += " nonrecursive";
- }
- if (this.options.addon) {
- identifier += ` ${requestShortener.shorten(this.options.addon)}`;
- }
- if (this.options.regExp) {
- identifier += ` ${this._prettyRegExp(this.options.regExp)}`;
- }
- if (this.options.include) {
- identifier += ` include: ${this._prettyRegExp(this.options.include)}`;
- }
- if (this.options.exclude) {
- identifier += ` exclude: ${this._prettyRegExp(this.options.exclude)}`;
- }
- if (this.options.referencedExports) {
- identifier += ` referencedExports: ${this.options.referencedExports
- .map(e => e.join("."))
- .join(", ")}`;
- }
- if (this.options.chunkName) {
- identifier += ` chunkName: ${this.options.chunkName}`;
- }
- if (this.options.groupOptions) {
- const groupOptions = this.options.groupOptions;
- for (const key of Object.keys(groupOptions)) {
- identifier += ` ${key}: ${
- groupOptions[/** @type {keyof RawChunkGroupOptions} */ (key)]
- }`;
- }
- }
- if (this.options.namespaceObject === "strict") {
- identifier += " strict namespace object";
- } else if (this.options.namespaceObject) {
- identifier += " namespace object";
- }
- return identifier;
- }
- /**
- * @param {LibIdentOptions} options options
- * @returns {string | null} an identifier for library inclusion
- */
- libIdent(options) {
- let identifier;
- if (this.context) {
- identifier = contextify(
- options.context,
- this.context,
- options.associatedObjectForCache
- );
- } else if (typeof this.options.resource === "string") {
- identifier = contextify(
- options.context,
- this.options.resource,
- options.associatedObjectForCache
- );
- } else if (this.options.resource === false) {
- identifier = "false";
- } else {
- identifier = this.options.resource
- .map(res =>
- contextify(options.context, res, options.associatedObjectForCache)
- )
- .join(" ");
- }
- if (this.layer) identifier = `(${this.layer})/${identifier}`;
- if (this.options.mode) {
- identifier += ` ${this.options.mode}`;
- }
- if (this.options.recursive) {
- identifier += " recursive";
- }
- if (this.options.addon) {
- identifier += ` ${contextify(
- options.context,
- this.options.addon,
- options.associatedObjectForCache
- )}`;
- }
- if (this.options.regExp) {
- identifier += ` ${this._prettyRegExp(this.options.regExp)}`;
- }
- if (this.options.include) {
- identifier += ` include: ${this._prettyRegExp(this.options.include)}`;
- }
- if (this.options.exclude) {
- identifier += ` exclude: ${this._prettyRegExp(this.options.exclude)}`;
- }
- if (this.options.referencedExports) {
- identifier += ` referencedExports: ${this.options.referencedExports
- .map(e => e.join("."))
- .join(", ")}`;
- }
- return identifier;
- }
- /**
- * @returns {void}
- */
- invalidateBuild() {
- this._forceBuild = true;
- }
- /**
- * @param {NeedBuildContext} context context info
- * @param {function((WebpackError | null)=, boolean=): void} callback callback function, returns true, if the module needs a rebuild
- * @returns {void}
- */
- needBuild({ fileSystemInfo }, callback) {
- // build if enforced
- if (this._forceBuild) return callback(null, true);
- const buildInfo = /** @type {BuildInfo} */ (this.buildInfo);
- // always build when we have no snapshot and context
- if (!buildInfo.snapshot)
- return callback(null, Boolean(this.context || this.options.resource));
- fileSystemInfo.checkSnapshotValid(buildInfo.snapshot, (err, valid) => {
- callback(err, !valid);
- });
- }
- /**
- * @param {WebpackOptions} options webpack options
- * @param {Compilation} compilation the compilation
- * @param {ResolverWithOptions} resolver the resolver
- * @param {InputFileSystem} fs the file system
- * @param {function(WebpackError=): void} callback callback function
- * @returns {void}
- */
- build(options, compilation, resolver, fs, callback) {
- this._forceBuild = false;
- /** @type {BuildMeta} */
- this.buildMeta = {
- exportsType: "default",
- defaultObject: "redirect-warn"
- };
- this.buildInfo = {
- snapshot: undefined
- };
- this.dependencies.length = 0;
- this.blocks.length = 0;
- const startTime = Date.now();
- /** @type {ResolveDependencies} */
- (this.resolveDependencies)(fs, this.options, (err, dependencies) => {
- if (err) {
- return callback(
- makeWebpackError(err, "ContextModule.resolveDependencies")
- );
- }
- // abort if something failed
- // this will create an empty context
- if (!dependencies) {
- callback();
- return;
- }
- // enhance dependencies with meta info
- for (const dep of dependencies) {
- dep.loc = {
- name: dep.userRequest
- };
- dep.request = this.options.addon + dep.request;
- }
- dependencies.sort(
- concatComparators(
- compareSelect(a => a.loc, compareLocations),
- keepOriginalOrder(this.dependencies)
- )
- );
- if (this.options.mode === "sync" || this.options.mode === "eager") {
- // if we have an sync or eager context
- // just add all dependencies and continue
- this.dependencies = dependencies;
- } else if (this.options.mode === "lazy-once") {
- // for the lazy-once mode create a new async dependency block
- // and add that block to this context
- if (dependencies.length > 0) {
- const block = new AsyncDependenciesBlock({
- ...this.options.groupOptions,
- name: this.options.chunkName
- });
- for (const dep of dependencies) {
- block.addDependency(dep);
- }
- this.addBlock(block);
- }
- } else if (
- this.options.mode === "weak" ||
- this.options.mode === "async-weak"
- ) {
- // we mark all dependencies as weak
- for (const dep of dependencies) {
- dep.weak = true;
- }
- this.dependencies = dependencies;
- } else if (this.options.mode === "lazy") {
- // if we are lazy create a new async dependency block per dependency
- // and add all blocks to this context
- let index = 0;
- for (const dep of dependencies) {
- let chunkName = this.options.chunkName;
- if (chunkName) {
- if (!/\[(index|request)\]/.test(chunkName)) {
- chunkName += "[index]";
- }
- chunkName = chunkName.replace(/\[index\]/g, `${index++}`);
- chunkName = chunkName.replace(
- /\[request\]/g,
- Template.toPath(dep.userRequest)
- );
- }
- const block = new AsyncDependenciesBlock(
- {
- ...this.options.groupOptions,
- name: chunkName
- },
- dep.loc,
- dep.userRequest
- );
- block.addDependency(dep);
- this.addBlock(block);
- }
- } else {
- callback(
- new WebpackError(`Unsupported mode "${this.options.mode}" in context`)
- );
- return;
- }
- if (!this.context && !this.options.resource) return callback();
- compilation.fileSystemInfo.createSnapshot(
- startTime,
- null,
- this.context
- ? [this.context]
- : typeof this.options.resource === "string"
- ? [this.options.resource]
- : /** @type {string[]} */ (this.options.resource),
- null,
- SNAPSHOT_OPTIONS,
- (err, snapshot) => {
- if (err) return callback(err);
- /** @type {BuildInfo} */
- (this.buildInfo).snapshot = snapshot;
- callback();
- }
- );
- });
- }
- /**
- * @param {LazySet<string>} fileDependencies set where file dependencies are added to
- * @param {LazySet<string>} contextDependencies set where context dependencies are added to
- * @param {LazySet<string>} missingDependencies set where missing dependencies are added to
- * @param {LazySet<string>} buildDependencies set where build dependencies are added to
- */
- addCacheDependencies(
- fileDependencies,
- contextDependencies,
- missingDependencies,
- buildDependencies
- ) {
- if (this.context) {
- contextDependencies.add(this.context);
- } else if (typeof this.options.resource === "string") {
- contextDependencies.add(this.options.resource);
- } else if (this.options.resource === false) {
- return;
- } else {
- for (const res of this.options.resource) contextDependencies.add(res);
- }
- }
- /**
- * @param {Dependency[]} dependencies all dependencies
- * @param {ChunkGraph} chunkGraph chunk graph
- * @returns {Map<string, string | number>} map with user requests
- */
- getUserRequestMap(dependencies, chunkGraph) {
- const moduleGraph = chunkGraph.moduleGraph;
- // if we filter first we get a new array
- // therefore we don't need to create a clone of dependencies explicitly
- // therefore the order of this is !important!
- const sortedDependencies =
- /** @type {ContextElementDependency[]} */
- (dependencies)
- .filter(dependency => moduleGraph.getModule(dependency))
- .sort((a, b) => {
- if (a.userRequest === b.userRequest) {
- return 0;
- }
- return a.userRequest < b.userRequest ? -1 : 1;
- });
- const map = Object.create(null);
- for (const dep of sortedDependencies) {
- const module = /** @type {Module} */ (moduleGraph.getModule(dep));
- map[dep.userRequest] = chunkGraph.getModuleId(module);
- }
- return map;
- }
- /**
- * @param {Dependency[]} dependencies all dependencies
- * @param {ChunkGraph} chunkGraph chunk graph
- * @returns {FakeMap} fake map
- */
- getFakeMap(dependencies, chunkGraph) {
- if (!this.options.namespaceObject) {
- return 9;
- }
- const moduleGraph = chunkGraph.moduleGraph;
- // bitfield
- let hasType = 0;
- const comparator = compareModulesById(chunkGraph);
- // if we filter first we get a new array
- // therefore we don't need to create a clone of dependencies explicitly
- // therefore the order of this is !important!
- const sortedModules = dependencies
- .map(
- dependency => /** @type {Module} */ (moduleGraph.getModule(dependency))
- )
- .filter(Boolean)
- .sort(comparator);
- const fakeMap = Object.create(null);
- for (const module of sortedModules) {
- const exportsType = module.getExportsType(
- moduleGraph,
- this.options.namespaceObject === "strict"
- );
- const id = chunkGraph.getModuleId(module);
- switch (exportsType) {
- case "namespace":
- fakeMap[id] = 9;
- hasType |= 1;
- break;
- case "dynamic":
- fakeMap[id] = 7;
- hasType |= 2;
- break;
- case "default-only":
- fakeMap[id] = 1;
- hasType |= 4;
- break;
- case "default-with-named":
- fakeMap[id] = 3;
- hasType |= 8;
- break;
- default:
- throw new Error(`Unexpected exports type ${exportsType}`);
- }
- }
- if (hasType === 1) {
- return 9;
- }
- if (hasType === 2) {
- return 7;
- }
- if (hasType === 4) {
- return 1;
- }
- if (hasType === 8) {
- return 3;
- }
- if (hasType === 0) {
- return 9;
- }
- return fakeMap;
- }
- /**
- * @param {FakeMap} fakeMap fake map
- * @returns {string} fake map init statement
- */
- getFakeMapInitStatement(fakeMap) {
- return typeof fakeMap === "object"
- ? `var fakeMap = ${JSON.stringify(fakeMap, null, "\t")};`
- : "";
- }
- /**
- * @param {FakeMapType} type type
- * @param {boolean=} asyncModule is async module
- * @returns {string} return result
- */
- getReturn(type, asyncModule) {
- if (type === 9) {
- return `${RuntimeGlobals.require}(id)`;
- }
- return `${RuntimeGlobals.createFakeNamespaceObject}(id, ${type}${
- asyncModule ? " | 16" : ""
- })`;
- }
- /**
- * @param {FakeMap} fakeMap fake map
- * @param {boolean=} asyncModule us async module
- * @param {string=} fakeMapDataExpression fake map data expression
- * @returns {string} module object source
- */
- getReturnModuleObjectSource(
- fakeMap,
- asyncModule,
- fakeMapDataExpression = "fakeMap[id]"
- ) {
- if (typeof fakeMap === "number") {
- return `return ${this.getReturn(fakeMap, asyncModule)};`;
- }
- return `return ${
- RuntimeGlobals.createFakeNamespaceObject
- }(id, ${fakeMapDataExpression}${asyncModule ? " | 16" : ""})`;
- }
- /**
- * @param {Dependency[]} dependencies dependencies
- * @param {ModuleId} id module id
- * @param {ChunkGraph} chunkGraph the chunk graph
- * @returns {string} source code
- */
- getSyncSource(dependencies, id, chunkGraph) {
- const map = this.getUserRequestMap(dependencies, chunkGraph);
- const fakeMap = this.getFakeMap(dependencies, chunkGraph);
- const returnModuleObject = this.getReturnModuleObjectSource(fakeMap);
- return `var map = ${JSON.stringify(map, null, "\t")};
- ${this.getFakeMapInitStatement(fakeMap)}
- function webpackContext(req) {
- var id = webpackContextResolve(req);
- ${returnModuleObject}
- }
- function webpackContextResolve(req) {
- if(!${RuntimeGlobals.hasOwnProperty}(map, req)) {
- var e = new Error("Cannot find module '" + req + "'");
- e.code = 'MODULE_NOT_FOUND';
- throw e;
- }
- return map[req];
- }
- webpackContext.keys = function webpackContextKeys() {
- return Object.keys(map);
- };
- webpackContext.resolve = webpackContextResolve;
- module.exports = webpackContext;
- webpackContext.id = ${JSON.stringify(id)};`;
- }
- /**
- * @param {Dependency[]} dependencies dependencies
- * @param {ModuleId} id module id
- * @param {ChunkGraph} chunkGraph the chunk graph
- * @returns {string} source code
- */
- getWeakSyncSource(dependencies, id, chunkGraph) {
- const map = this.getUserRequestMap(dependencies, chunkGraph);
- const fakeMap = this.getFakeMap(dependencies, chunkGraph);
- const returnModuleObject = this.getReturnModuleObjectSource(fakeMap);
- return `var map = ${JSON.stringify(map, null, "\t")};
- ${this.getFakeMapInitStatement(fakeMap)}
- function webpackContext(req) {
- var id = webpackContextResolve(req);
- if(!${RuntimeGlobals.moduleFactories}[id]) {
- var e = new Error("Module '" + req + "' ('" + id + "') is not available (weak dependency)");
- e.code = 'MODULE_NOT_FOUND';
- throw e;
- }
- ${returnModuleObject}
- }
- function webpackContextResolve(req) {
- if(!${RuntimeGlobals.hasOwnProperty}(map, req)) {
- var e = new Error("Cannot find module '" + req + "'");
- e.code = 'MODULE_NOT_FOUND';
- throw e;
- }
- return map[req];
- }
- webpackContext.keys = function webpackContextKeys() {
- return Object.keys(map);
- };
- webpackContext.resolve = webpackContextResolve;
- webpackContext.id = ${JSON.stringify(id)};
- module.exports = webpackContext;`;
- }
- /**
- * @param {Dependency[]} dependencies dependencies
- * @param {ModuleId} id module id
- * @param {object} context context
- * @param {ChunkGraph} context.chunkGraph the chunk graph
- * @param {RuntimeTemplate} context.runtimeTemplate the chunk graph
- * @returns {string} source code
- */
- getAsyncWeakSource(dependencies, id, { chunkGraph, runtimeTemplate }) {
- const arrow = runtimeTemplate.supportsArrowFunction();
- const map = this.getUserRequestMap(dependencies, chunkGraph);
- const fakeMap = this.getFakeMap(dependencies, chunkGraph);
- const returnModuleObject = this.getReturnModuleObjectSource(fakeMap, true);
- return `var map = ${JSON.stringify(map, null, "\t")};
- ${this.getFakeMapInitStatement(fakeMap)}
- function webpackAsyncContext(req) {
- return webpackAsyncContextResolve(req).then(${
- arrow ? "id =>" : "function(id)"
- } {
- if(!${RuntimeGlobals.moduleFactories}[id]) {
- var e = new Error("Module '" + req + "' ('" + id + "') is not available (weak dependency)");
- e.code = 'MODULE_NOT_FOUND';
- throw e;
- }
- ${returnModuleObject}
- });
- }
- function webpackAsyncContextResolve(req) {
- // Here Promise.resolve().then() is used instead of new Promise() to prevent
- // uncaught exception popping up in devtools
- return Promise.resolve().then(${arrow ? "() =>" : "function()"} {
- if(!${RuntimeGlobals.hasOwnProperty}(map, req)) {
- var e = new Error("Cannot find module '" + req + "'");
- e.code = 'MODULE_NOT_FOUND';
- throw e;
- }
- return map[req];
- });
- }
- webpackAsyncContext.keys = ${runtimeTemplate.returningFunction(
- "Object.keys(map)"
- )};
- webpackAsyncContext.resolve = webpackAsyncContextResolve;
- webpackAsyncContext.id = ${JSON.stringify(id)};
- module.exports = webpackAsyncContext;`;
- }
- /**
- * @param {Dependency[]} dependencies dependencies
- * @param {ModuleId} id module id
- * @param {object} context context
- * @param {ChunkGraph} context.chunkGraph the chunk graph
- * @param {RuntimeTemplate} context.runtimeTemplate the chunk graph
- * @returns {string} source code
- */
- getEagerSource(dependencies, id, { chunkGraph, runtimeTemplate }) {
- const arrow = runtimeTemplate.supportsArrowFunction();
- const map = this.getUserRequestMap(dependencies, chunkGraph);
- const fakeMap = this.getFakeMap(dependencies, chunkGraph);
- const thenFunction =
- fakeMap !== 9
- ? `${arrow ? "id =>" : "function(id)"} {
- ${this.getReturnModuleObjectSource(fakeMap, true)}
- }`
- : RuntimeGlobals.require;
- return `var map = ${JSON.stringify(map, null, "\t")};
- ${this.getFakeMapInitStatement(fakeMap)}
- function webpackAsyncContext(req) {
- return webpackAsyncContextResolve(req).then(${thenFunction});
- }
- function webpackAsyncContextResolve(req) {
- // Here Promise.resolve().then() is used instead of new Promise() to prevent
- // uncaught exception popping up in devtools
- return Promise.resolve().then(${arrow ? "() =>" : "function()"} {
- if(!${RuntimeGlobals.hasOwnProperty}(map, req)) {
- var e = new Error("Cannot find module '" + req + "'");
- e.code = 'MODULE_NOT_FOUND';
- throw e;
- }
- return map[req];
- });
- }
- webpackAsyncContext.keys = ${runtimeTemplate.returningFunction(
- "Object.keys(map)"
- )};
- webpackAsyncContext.resolve = webpackAsyncContextResolve;
- webpackAsyncContext.id = ${JSON.stringify(id)};
- module.exports = webpackAsyncContext;`;
- }
- /**
- * @param {AsyncDependenciesBlock} block block
- * @param {Dependency[]} dependencies dependencies
- * @param {ModuleId} id module id
- * @param {object} options options object
- * @param {RuntimeTemplate} options.runtimeTemplate the runtime template
- * @param {ChunkGraph} options.chunkGraph the chunk graph
- * @returns {string} source code
- */
- getLazyOnceSource(block, dependencies, id, { runtimeTemplate, chunkGraph }) {
- const promise = runtimeTemplate.blockPromise({
- chunkGraph,
- block,
- message: "lazy-once context",
- runtimeRequirements: new Set()
- });
- const arrow = runtimeTemplate.supportsArrowFunction();
- const map = this.getUserRequestMap(dependencies, chunkGraph);
- const fakeMap = this.getFakeMap(dependencies, chunkGraph);
- const thenFunction =
- fakeMap !== 9
- ? `${arrow ? "id =>" : "function(id)"} {
- ${this.getReturnModuleObjectSource(fakeMap, true)};
- }`
- : RuntimeGlobals.require;
- return `var map = ${JSON.stringify(map, null, "\t")};
- ${this.getFakeMapInitStatement(fakeMap)}
- function webpackAsyncContext(req) {
- return webpackAsyncContextResolve(req).then(${thenFunction});
- }
- function webpackAsyncContextResolve(req) {
- return ${promise}.then(${arrow ? "() =>" : "function()"} {
- if(!${RuntimeGlobals.hasOwnProperty}(map, req)) {
- var e = new Error("Cannot find module '" + req + "'");
- e.code = 'MODULE_NOT_FOUND';
- throw e;
- }
- return map[req];
- });
- }
- webpackAsyncContext.keys = ${runtimeTemplate.returningFunction(
- "Object.keys(map)"
- )};
- webpackAsyncContext.resolve = webpackAsyncContextResolve;
- webpackAsyncContext.id = ${JSON.stringify(id)};
- module.exports = webpackAsyncContext;`;
- }
- /**
- * @param {AsyncDependenciesBlock[]} blocks blocks
- * @param {ModuleId} id module id
- * @param {object} context context
- * @param {ChunkGraph} context.chunkGraph the chunk graph
- * @param {RuntimeTemplate} context.runtimeTemplate the chunk graph
- * @returns {string} source code
- */
- getLazySource(blocks, id, { chunkGraph, runtimeTemplate }) {
- const moduleGraph = chunkGraph.moduleGraph;
- const arrow = runtimeTemplate.supportsArrowFunction();
- let hasMultipleOrNoChunks = false;
- let hasNoChunk = true;
- const fakeMap = this.getFakeMap(
- blocks.map(b => b.dependencies[0]),
- chunkGraph
- );
- const hasFakeMap = typeof fakeMap === "object";
- const items = blocks
- .map(block => {
- const dependency =
- /** @type {ContextElementDependency} */
- (block.dependencies[0]);
- return {
- dependency: dependency,
- module: /** @type {Module} */ (moduleGraph.getModule(dependency)),
- block: block,
- userRequest: dependency.userRequest,
- chunks: undefined
- };
- })
- .filter(item => item.module);
- for (const item of items) {
- const chunkGroup = chunkGraph.getBlockChunkGroup(item.block);
- const chunks = (chunkGroup && chunkGroup.chunks) || [];
- item.chunks = chunks;
- if (chunks.length > 0) {
- hasNoChunk = false;
- }
- if (chunks.length !== 1) {
- hasMultipleOrNoChunks = true;
- }
- }
- const shortMode = hasNoChunk && !hasFakeMap;
- const sortedItems = items.sort((a, b) => {
- if (a.userRequest === b.userRequest) return 0;
- return a.userRequest < b.userRequest ? -1 : 1;
- });
- const map = Object.create(null);
- for (const item of sortedItems) {
- const moduleId = chunkGraph.getModuleId(item.module);
- if (shortMode) {
- map[item.userRequest] = moduleId;
- } else {
- const arrayStart = [moduleId];
- if (hasFakeMap) {
- arrayStart.push(fakeMap[moduleId]);
- }
- map[item.userRequest] = arrayStart.concat(
- item.chunks.map(chunk => chunk.id)
- );
- }
- }
- const chunksStartPosition = hasFakeMap ? 2 : 1;
- const requestPrefix = hasNoChunk
- ? "Promise.resolve()"
- : hasMultipleOrNoChunks
- ? `Promise.all(ids.slice(${chunksStartPosition}).map(${RuntimeGlobals.ensureChunk}))`
- : `${RuntimeGlobals.ensureChunk}(ids[${chunksStartPosition}])`;
- const returnModuleObject = this.getReturnModuleObjectSource(
- fakeMap,
- true,
- shortMode ? "invalid" : "ids[1]"
- );
- const webpackAsyncContext =
- requestPrefix === "Promise.resolve()"
- ? `
- function webpackAsyncContext(req) {
- return Promise.resolve().then(${arrow ? "() =>" : "function()"} {
- if(!${RuntimeGlobals.hasOwnProperty}(map, req)) {
- var e = new Error("Cannot find module '" + req + "'");
- e.code = 'MODULE_NOT_FOUND';
- throw e;
- }
- ${shortMode ? "var id = map[req];" : "var ids = map[req], id = ids[0];"}
- ${returnModuleObject}
- });
- }`
- : `function webpackAsyncContext(req) {
- if(!${RuntimeGlobals.hasOwnProperty}(map, req)) {
- return Promise.resolve().then(${arrow ? "() =>" : "function()"} {
- var e = new Error("Cannot find module '" + req + "'");
- e.code = 'MODULE_NOT_FOUND';
- throw e;
- });
- }
- var ids = map[req], id = ids[0];
- return ${requestPrefix}.then(${arrow ? "() =>" : "function()"} {
- ${returnModuleObject}
- });
- }`;
- return `var map = ${JSON.stringify(map, null, "\t")};
- ${webpackAsyncContext}
- webpackAsyncContext.keys = ${runtimeTemplate.returningFunction(
- "Object.keys(map)"
- )};
- webpackAsyncContext.id = ${JSON.stringify(id)};
- module.exports = webpackAsyncContext;`;
- }
- /**
- * @param {ModuleId} id module id
- * @param {RuntimeTemplate} runtimeTemplate runtime template
- * @returns {string} source for empty async context
- */
- getSourceForEmptyContext(id, runtimeTemplate) {
- return `function webpackEmptyContext(req) {
- var e = new Error("Cannot find module '" + req + "'");
- e.code = 'MODULE_NOT_FOUND';
- throw e;
- }
- webpackEmptyContext.keys = ${runtimeTemplate.returningFunction("[]")};
- webpackEmptyContext.resolve = webpackEmptyContext;
- webpackEmptyContext.id = ${JSON.stringify(id)};
- module.exports = webpackEmptyContext;`;
- }
- /**
- * @param {ModuleId} id module id
- * @param {RuntimeTemplate} runtimeTemplate runtime template
- * @returns {string} source for empty async context
- */
- getSourceForEmptyAsyncContext(id, runtimeTemplate) {
- const arrow = runtimeTemplate.supportsArrowFunction();
- return `function webpackEmptyAsyncContext(req) {
- // Here Promise.resolve().then() is used instead of new Promise() to prevent
- // uncaught exception popping up in devtools
- return Promise.resolve().then(${arrow ? "() =>" : "function()"} {
- var e = new Error("Cannot find module '" + req + "'");
- e.code = 'MODULE_NOT_FOUND';
- throw e;
- });
- }
- webpackEmptyAsyncContext.keys = ${runtimeTemplate.returningFunction("[]")};
- webpackEmptyAsyncContext.resolve = webpackEmptyAsyncContext;
- webpackEmptyAsyncContext.id = ${JSON.stringify(id)};
- module.exports = webpackEmptyAsyncContext;`;
- }
- /**
- * @param {string} asyncMode module mode
- * @param {CodeGenerationContext} context context info
- * @returns {string} the source code
- */
- getSourceString(asyncMode, { runtimeTemplate, chunkGraph }) {
- const id = chunkGraph.getModuleId(this);
- if (asyncMode === "lazy") {
- if (this.blocks && this.blocks.length > 0) {
- return this.getLazySource(this.blocks, id, {
- runtimeTemplate,
- chunkGraph
- });
- }
- return this.getSourceForEmptyAsyncContext(id, runtimeTemplate);
- }
- if (asyncMode === "eager") {
- if (this.dependencies && this.dependencies.length > 0) {
- return this.getEagerSource(this.dependencies, id, {
- chunkGraph,
- runtimeTemplate
- });
- }
- return this.getSourceForEmptyAsyncContext(id, runtimeTemplate);
- }
- if (asyncMode === "lazy-once") {
- const block = this.blocks[0];
- if (block) {
- return this.getLazyOnceSource(block, block.dependencies, id, {
- runtimeTemplate,
- chunkGraph
- });
- }
- return this.getSourceForEmptyAsyncContext(id, runtimeTemplate);
- }
- if (asyncMode === "async-weak") {
- if (this.dependencies && this.dependencies.length > 0) {
- return this.getAsyncWeakSource(this.dependencies, id, {
- chunkGraph,
- runtimeTemplate
- });
- }
- return this.getSourceForEmptyAsyncContext(id, runtimeTemplate);
- }
- if (asyncMode === "weak") {
- if (this.dependencies && this.dependencies.length > 0) {
- return this.getWeakSyncSource(this.dependencies, id, chunkGraph);
- }
- }
- if (this.dependencies && this.dependencies.length > 0) {
- return this.getSyncSource(this.dependencies, id, chunkGraph);
- }
- return this.getSourceForEmptyContext(id, runtimeTemplate);
- }
- /**
- * @param {string} sourceString source content
- * @param {Compilation=} compilation the compilation
- * @returns {Source} generated source
- */
- getSource(sourceString, compilation) {
- if (this.useSourceMap || this.useSimpleSourceMap) {
- return new OriginalSource(
- sourceString,
- `webpack://${makePathsRelative(
- (compilation && compilation.compiler.context) || "",
- this.identifier(),
- compilation && compilation.compiler.root
- )}`
- );
- }
- return new RawSource(sourceString);
- }
- /**
- * @param {CodeGenerationContext} context context for code generation
- * @returns {CodeGenerationResult} result
- */
- codeGeneration(context) {
- const { chunkGraph, compilation } = context;
- const sources = new Map();
- sources.set(
- "javascript",
- this.getSource(
- this.getSourceString(this.options.mode, context),
- compilation
- )
- );
- const set = new Set();
- const allDeps =
- this.dependencies.length > 0
- ? /** @type {ContextElementDependency[]} */ (this.dependencies).slice()
- : [];
- for (const block of this.blocks)
- for (const dep of block.dependencies)
- allDeps.push(/** @type {ContextElementDependency} */ (dep));
- set.add(RuntimeGlobals.module);
- set.add(RuntimeGlobals.hasOwnProperty);
- if (allDeps.length > 0) {
- const asyncMode = this.options.mode;
- set.add(RuntimeGlobals.require);
- if (asyncMode === "weak") {
- set.add(RuntimeGlobals.moduleFactories);
- } else if (asyncMode === "async-weak") {
- set.add(RuntimeGlobals.moduleFactories);
- set.add(RuntimeGlobals.ensureChunk);
- } else if (asyncMode === "lazy" || asyncMode === "lazy-once") {
- set.add(RuntimeGlobals.ensureChunk);
- }
- if (this.getFakeMap(allDeps, chunkGraph) !== 9) {
- set.add(RuntimeGlobals.createFakeNamespaceObject);
- }
- }
- return {
- sources,
- runtimeRequirements: set
- };
- }
- /**
- * @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) {
- // base penalty
- let size = 160;
- // if we don't have dependencies we stop here.
- for (const dependency of this.dependencies) {
- const element = /** @type {ContextElementDependency} */ (dependency);
- size += 5 + element.userRequest.length;
- }
- return size;
- }
- /**
- * @param {ObjectSerializerContext} context context
- */
- serialize(context) {
- const { write } = context;
- write(this._identifier);
- write(this._forceBuild);
- super.serialize(context);
- }
- /**
- * @param {ObjectDeserializerContext} context context
- */
- deserialize(context) {
- const { read } = context;
- this._identifier = read();
- this._forceBuild = read();
- super.deserialize(context);
- }
- }
- makeSerializable(ContextModule, "webpack/lib/ContextModule");
- module.exports = ContextModule;
|