123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326 |
- /*
- MIT License http://www.opensource.org/licenses/mit-license.php
- Author Tobias Koppers @sokra
- */
- "use strict";
- const { getContext } = require("loader-runner");
- const asyncLib = require("neo-async");
- const {
- AsyncSeriesBailHook,
- SyncWaterfallHook,
- SyncBailHook,
- SyncHook,
- HookMap
- } = require("tapable");
- const ChunkGraph = require("./ChunkGraph");
- const Module = require("./Module");
- const ModuleFactory = require("./ModuleFactory");
- const ModuleGraph = require("./ModuleGraph");
- const { JAVASCRIPT_MODULE_TYPE_AUTO } = require("./ModuleTypeConstants");
- const NormalModule = require("./NormalModule");
- const BasicEffectRulePlugin = require("./rules/BasicEffectRulePlugin");
- const BasicMatcherRulePlugin = require("./rules/BasicMatcherRulePlugin");
- const ObjectMatcherRulePlugin = require("./rules/ObjectMatcherRulePlugin");
- const RuleSetCompiler = require("./rules/RuleSetCompiler");
- const UseEffectRulePlugin = require("./rules/UseEffectRulePlugin");
- const LazySet = require("./util/LazySet");
- const { getScheme } = require("./util/URLAbsoluteSpecifier");
- const { cachedCleverMerge, cachedSetProperty } = require("./util/cleverMerge");
- const { join } = require("./util/fs");
- const {
- parseResource,
- parseResourceWithoutFragment
- } = require("./util/identifier");
- /** @typedef {import("../declarations/WebpackOptions").ModuleOptionsNormalized} ModuleOptions */
- /** @typedef {import("../declarations/WebpackOptions").RuleSetRule} RuleSetRule */
- /** @typedef {import("./Generator")} Generator */
- /** @typedef {import("./ModuleFactory").ModuleFactoryCreateData} ModuleFactoryCreateData */
- /** @typedef {import("./ModuleFactory").ModuleFactoryCreateDataContextInfo} ModuleFactoryCreateDataContextInfo */
- /** @typedef {import("./ModuleFactory").ModuleFactoryResult} ModuleFactoryResult */
- /** @typedef {import("./NormalModule").GeneratorOptions} GeneratorOptions */
- /** @typedef {import("./NormalModule").LoaderItem} LoaderItem */
- /** @typedef {import("./NormalModule").NormalModuleCreateData} NormalModuleCreateData */
- /** @typedef {import("./NormalModule").ParserOptions} ParserOptions */
- /** @typedef {import("./Parser")} Parser */
- /** @typedef {import("./ResolverFactory")} ResolverFactory */
- /** @typedef {import("./ResolverFactory").ResolveContext} ResolveContext */
- /** @typedef {import("./ResolverFactory").ResolveRequest} ResolveRequest */
- /** @typedef {import("./ResolverFactory").ResolverWithOptions} ResolverWithOptions */
- /** @typedef {import("./dependencies/ModuleDependency")} ModuleDependency */
- /** @typedef {import("./util/fs").InputFileSystem} InputFileSystem */
- /** @typedef {Pick<RuleSetRule, 'type' | 'sideEffects' | 'parser' | 'generator' | 'resolve' | 'layer'>} ModuleSettings */
- /** @typedef {Partial<NormalModuleCreateData & { settings: ModuleSettings }>} CreateData */
- /**
- * @typedef {object} ResolveData
- * @property {ModuleFactoryCreateData["contextInfo"]} contextInfo
- * @property {ModuleFactoryCreateData["resolveOptions"]} resolveOptions
- * @property {string} context
- * @property {string} request
- * @property {Record<string, any> | undefined} assertions
- * @property {ModuleDependency[]} dependencies
- * @property {string} dependencyType
- * @property {CreateData} createData
- * @property {LazySet<string>} fileDependencies
- * @property {LazySet<string>} missingDependencies
- * @property {LazySet<string>} contextDependencies
- * @property {Module=} ignoredModule
- * @property {boolean} cacheable allow to use the unsafe cache
- */
- /**
- * @typedef {object} ResourceData
- * @property {string} resource
- * @property {string=} path
- * @property {string=} query
- * @property {string=} fragment
- * @property {string=} context
- */
- /** @typedef {ResourceData & { data: Record<string, any> }} ResourceDataWithData */
- /**
- * @typedef {object} ParsedLoaderRequest
- * @property {string} loader loader
- * @property {string|undefined} options options
- */
- /**
- * @template T
- * @callback Callback
- * @param {(Error | null)=} err
- * @param {T=} stats
- * @returns {void}
- */
- const EMPTY_RESOLVE_OPTIONS = {};
- /** @type {ParserOptions} */
- const EMPTY_PARSER_OPTIONS = {};
- /** @type {GeneratorOptions} */
- const EMPTY_GENERATOR_OPTIONS = {};
- /** @type {ParsedLoaderRequest[]} */
- const EMPTY_ELEMENTS = [];
- const MATCH_RESOURCE_REGEX = /^([^!]+)!=!/;
- const LEADING_DOT_EXTENSION_REGEX = /^[^.]/;
- /**
- * @param {LoaderItem} data data
- * @returns {string} ident
- */
- const loaderToIdent = data => {
- if (!data.options) {
- return data.loader;
- }
- if (typeof data.options === "string") {
- return `${data.loader}?${data.options}`;
- }
- if (typeof data.options !== "object") {
- throw new Error("loader options must be string or object");
- }
- if (data.ident) {
- return `${data.loader}??${data.ident}`;
- }
- return `${data.loader}?${JSON.stringify(data.options)}`;
- };
- /**
- * @param {LoaderItem[]} loaders loaders
- * @param {string} resource resource
- * @returns {string} stringified loaders and resource
- */
- const stringifyLoadersAndResource = (loaders, resource) => {
- let str = "";
- for (const loader of loaders) {
- str += `${loaderToIdent(loader)}!`;
- }
- return str + resource;
- };
- /**
- * @param {number} times times
- * @param {(err?: null | Error) => void} callback callback
- * @returns {(err?: null | Error) => void} callback
- */
- const needCalls = (times, callback) => err => {
- if (--times === 0) {
- return callback(err);
- }
- if (err && times > 0) {
- times = Number.NaN;
- return callback(err);
- }
- };
- /**
- * @template T
- * @template O
- * @param {T} globalOptions global options
- * @param {string} type type
- * @param {O} localOptions local options
- * @returns {T & O | T | O} result
- */
- const mergeGlobalOptions = (globalOptions, type, localOptions) => {
- const parts = type.split("/");
- let result;
- let current = "";
- for (const part of parts) {
- current = current ? `${current}/${part}` : part;
- const options =
- /** @type {T} */
- (globalOptions[/** @type {keyof T} */ (current)]);
- if (typeof options === "object") {
- result =
- result === undefined ? options : cachedCleverMerge(result, options);
- }
- }
- if (result === undefined) {
- return localOptions;
- }
- return cachedCleverMerge(result, localOptions);
- };
- // TODO webpack 6 remove
- /**
- * @param {string} name name
- * @param {TODO} hook hook
- * @returns {string} result
- */
- const deprecationChangedHookMessage = (name, hook) => {
- const names = hook.taps
- .map(
- /**
- * @param {TODO} tapped tapped
- * @returns {string} name
- */
- tapped => tapped.name
- )
- .join(", ");
- return (
- `NormalModuleFactory.${name} (${names}) is no longer a waterfall hook, but a bailing hook instead. ` +
- "Do not return the passed object, but modify it instead. " +
- "Returning false will ignore the request and results in no module created."
- );
- };
- const ruleSetCompiler = new RuleSetCompiler([
- new BasicMatcherRulePlugin("test", "resource"),
- new BasicMatcherRulePlugin("scheme"),
- new BasicMatcherRulePlugin("mimetype"),
- new BasicMatcherRulePlugin("dependency"),
- new BasicMatcherRulePlugin("include", "resource"),
- new BasicMatcherRulePlugin("exclude", "resource", true),
- new BasicMatcherRulePlugin("resource"),
- new BasicMatcherRulePlugin("resourceQuery"),
- new BasicMatcherRulePlugin("resourceFragment"),
- new BasicMatcherRulePlugin("realResource"),
- new BasicMatcherRulePlugin("issuer"),
- new BasicMatcherRulePlugin("compiler"),
- new BasicMatcherRulePlugin("issuerLayer"),
- new ObjectMatcherRulePlugin("assert", "assertions", value => {
- if (value) {
- return /** @type {any} */ (value)._isLegacyAssert !== undefined;
- }
- return false;
- }),
- new ObjectMatcherRulePlugin("with", "assertions", value => {
- if (value) {
- return !(/** @type {any} */ (value)._isLegacyAssert);
- }
- return false;
- }),
- new ObjectMatcherRulePlugin("descriptionData"),
- new BasicEffectRulePlugin("type"),
- new BasicEffectRulePlugin("sideEffects"),
- new BasicEffectRulePlugin("parser"),
- new BasicEffectRulePlugin("resolve"),
- new BasicEffectRulePlugin("generator"),
- new BasicEffectRulePlugin("layer"),
- new UseEffectRulePlugin()
- ]);
- class NormalModuleFactory extends ModuleFactory {
- /**
- * @param {object} param params
- * @param {string=} param.context context
- * @param {InputFileSystem} param.fs file system
- * @param {ResolverFactory} param.resolverFactory resolverFactory
- * @param {ModuleOptions} param.options options
- * @param {object} param.associatedObjectForCache an object to which the cache will be attached
- * @param {boolean=} param.layers enable layers
- */
- constructor({
- context,
- fs,
- resolverFactory,
- options,
- associatedObjectForCache,
- layers = false
- }) {
- super();
- this.hooks = Object.freeze({
- /** @type {AsyncSeriesBailHook<[ResolveData], Module | false | void>} */
- resolve: new AsyncSeriesBailHook(["resolveData"]),
- /** @type {HookMap<AsyncSeriesBailHook<[ResourceDataWithData, ResolveData], true | void>>} */
- resolveForScheme: new HookMap(
- () => new AsyncSeriesBailHook(["resourceData", "resolveData"])
- ),
- /** @type {HookMap<AsyncSeriesBailHook<[ResourceDataWithData, ResolveData], true | void>>} */
- resolveInScheme: new HookMap(
- () => new AsyncSeriesBailHook(["resourceData", "resolveData"])
- ),
- /** @type {AsyncSeriesBailHook<[ResolveData], Module | undefined>} */
- factorize: new AsyncSeriesBailHook(["resolveData"]),
- /** @type {AsyncSeriesBailHook<[ResolveData], false | void>} */
- beforeResolve: new AsyncSeriesBailHook(["resolveData"]),
- /** @type {AsyncSeriesBailHook<[ResolveData], false | void>} */
- afterResolve: new AsyncSeriesBailHook(["resolveData"]),
- /** @type {AsyncSeriesBailHook<[ResolveData["createData"], ResolveData], Module | void>} */
- createModule: new AsyncSeriesBailHook(["createData", "resolveData"]),
- /** @type {SyncWaterfallHook<[Module, ResolveData["createData"], ResolveData]>} */
- module: new SyncWaterfallHook(["module", "createData", "resolveData"]),
- /** @type {HookMap<SyncBailHook<[ParserOptions], Parser | void>>} */
- createParser: new HookMap(() => new SyncBailHook(["parserOptions"])),
- /** @type {HookMap<SyncBailHook<[TODO, ParserOptions], void>>} */
- parser: new HookMap(() => new SyncHook(["parser", "parserOptions"])),
- /** @type {HookMap<SyncBailHook<[GeneratorOptions], Generator | void>>} */
- createGenerator: new HookMap(
- () => new SyncBailHook(["generatorOptions"])
- ),
- /** @type {HookMap<SyncBailHook<[TODO, GeneratorOptions], void>>} */
- generator: new HookMap(
- () => new SyncHook(["generator", "generatorOptions"])
- ),
- /** @type {HookMap<SyncBailHook<[TODO, ResolveData], Module | void>>} */
- createModuleClass: new HookMap(
- () => new SyncBailHook(["createData", "resolveData"])
- )
- });
- this.resolverFactory = resolverFactory;
- this.ruleSet = ruleSetCompiler.compile([
- {
- rules: options.defaultRules
- },
- {
- rules: options.rules
- }
- ]);
- this.context = context || "";
- this.fs = fs;
- this._globalParserOptions = options.parser;
- this._globalGeneratorOptions = options.generator;
- /** @type {Map<string, WeakMap<object, Parser>>} */
- this.parserCache = new Map();
- /** @type {Map<string, WeakMap<object, Generator>>} */
- this.generatorCache = new Map();
- /** @type {Set<Module>} */
- this._restoredUnsafeCacheEntries = new Set();
- const cacheParseResource = parseResource.bindCache(
- associatedObjectForCache
- );
- const cachedParseResourceWithoutFragment =
- parseResourceWithoutFragment.bindCache(associatedObjectForCache);
- this._parseResourceWithoutFragment = cachedParseResourceWithoutFragment;
- this.hooks.factorize.tapAsync(
- {
- name: "NormalModuleFactory",
- stage: 100
- },
- (resolveData, callback) => {
- this.hooks.resolve.callAsync(resolveData, (err, result) => {
- if (err) return callback(err);
- // Ignored
- if (result === false) return callback();
- // direct module
- if (result instanceof Module) return callback(null, result);
- if (typeof result === "object")
- throw new Error(
- `${deprecationChangedHookMessage(
- "resolve",
- this.hooks.resolve
- )} Returning a Module object will result in this module used as result.`
- );
- this.hooks.afterResolve.callAsync(resolveData, (err, result) => {
- if (err) return callback(err);
- if (typeof result === "object")
- throw new Error(
- deprecationChangedHookMessage(
- "afterResolve",
- this.hooks.afterResolve
- )
- );
- // Ignored
- if (result === false) return callback();
- const createData = resolveData.createData;
- this.hooks.createModule.callAsync(
- createData,
- resolveData,
- (err, createdModule) => {
- if (!createdModule) {
- if (!resolveData.request) {
- return callback(new Error("Empty dependency (no request)"));
- }
- // TODO webpack 6 make it required and move javascript/wasm/asset properties to own module
- createdModule = this.hooks.createModuleClass
- .for(
- /** @type {ModuleSettings} */
- (createData.settings).type
- )
- .call(createData, resolveData);
- if (!createdModule) {
- createdModule = /** @type {Module} */ (
- new NormalModule(
- /** @type {NormalModuleCreateData} */
- (createData)
- )
- );
- }
- }
- createdModule = this.hooks.module.call(
- createdModule,
- createData,
- resolveData
- );
- return callback(null, createdModule);
- }
- );
- });
- });
- }
- );
- this.hooks.resolve.tapAsync(
- {
- name: "NormalModuleFactory",
- stage: 100
- },
- (data, callback) => {
- const {
- contextInfo,
- context,
- dependencies,
- dependencyType,
- request,
- assertions,
- resolveOptions,
- fileDependencies,
- missingDependencies,
- contextDependencies
- } = data;
- const loaderResolver = this.getResolver("loader");
- /** @type {ResourceData | undefined} */
- let matchResourceData;
- /** @type {string} */
- let unresolvedResource;
- /** @type {ParsedLoaderRequest[]} */
- let elements;
- let noPreAutoLoaders = false;
- let noAutoLoaders = false;
- let noPrePostAutoLoaders = false;
- const contextScheme = getScheme(context);
- /** @type {string | undefined} */
- let scheme = getScheme(request);
- if (!scheme) {
- /** @type {string} */
- let requestWithoutMatchResource = request;
- const matchResourceMatch = MATCH_RESOURCE_REGEX.exec(request);
- if (matchResourceMatch) {
- let matchResource = matchResourceMatch[1];
- if (matchResource.charCodeAt(0) === 46) {
- // 46 === ".", 47 === "/"
- const secondChar = matchResource.charCodeAt(1);
- if (
- secondChar === 47 ||
- (secondChar === 46 && matchResource.charCodeAt(2) === 47)
- ) {
- // if matchResources startsWith ../ or ./
- matchResource = join(this.fs, context, matchResource);
- }
- }
- matchResourceData = {
- resource: matchResource,
- ...cacheParseResource(matchResource)
- };
- requestWithoutMatchResource = request.slice(
- matchResourceMatch[0].length
- );
- }
- scheme = getScheme(requestWithoutMatchResource);
- if (!scheme && !contextScheme) {
- const firstChar = requestWithoutMatchResource.charCodeAt(0);
- const secondChar = requestWithoutMatchResource.charCodeAt(1);
- noPreAutoLoaders = firstChar === 45 && secondChar === 33; // startsWith "-!"
- noAutoLoaders = noPreAutoLoaders || firstChar === 33; // startsWith "!"
- noPrePostAutoLoaders = firstChar === 33 && secondChar === 33; // startsWith "!!";
- const rawElements = requestWithoutMatchResource
- .slice(
- noPreAutoLoaders || noPrePostAutoLoaders
- ? 2
- : noAutoLoaders
- ? 1
- : 0
- )
- .split(/!+/);
- unresolvedResource = /** @type {string} */ (rawElements.pop());
- elements = rawElements.map(el => {
- const { path, query } = cachedParseResourceWithoutFragment(el);
- return {
- loader: path,
- options: query ? query.slice(1) : undefined
- };
- });
- scheme = getScheme(unresolvedResource);
- } else {
- unresolvedResource = requestWithoutMatchResource;
- elements = EMPTY_ELEMENTS;
- }
- } else {
- unresolvedResource = request;
- elements = EMPTY_ELEMENTS;
- }
- /** @type {ResolveContext} */
- const resolveContext = {
- fileDependencies,
- missingDependencies,
- contextDependencies
- };
- /** @type {ResourceDataWithData} */
- let resourceData;
- /** @type {undefined | LoaderItem[]} */
- let loaders;
- const continueCallback = needCalls(2, err => {
- if (err) return callback(err);
- // translate option idents
- try {
- for (const item of /** @type {LoaderItem[]} */ (loaders)) {
- if (typeof item.options === "string" && item.options[0] === "?") {
- const ident = item.options.slice(1);
- if (ident === "[[missing ident]]") {
- throw new Error(
- "No ident is provided by referenced loader. " +
- "When using a function for Rule.use in config you need to " +
- "provide an 'ident' property for referenced loader options."
- );
- }
- item.options = this.ruleSet.references.get(ident);
- if (item.options === undefined) {
- throw new Error(
- "Invalid ident is provided by referenced loader"
- );
- }
- item.ident = ident;
- }
- }
- } catch (identErr) {
- return callback(/** @type {Error} */ (identErr));
- }
- if (!resourceData) {
- // ignored
- return callback(null, dependencies[0].createIgnoredModule(context));
- }
- const userRequest =
- (matchResourceData !== undefined
- ? `${matchResourceData.resource}!=!`
- : "") +
- stringifyLoadersAndResource(
- /** @type {LoaderItem[]} */ (loaders),
- resourceData.resource
- );
- /** @type {ModuleSettings} */
- const settings = {};
- const useLoadersPost = [];
- const useLoaders = [];
- const useLoadersPre = [];
- // handle .webpack[] suffix
- let resource;
- let match;
- if (
- matchResourceData &&
- typeof (resource = matchResourceData.resource) === "string" &&
- (match = /\.webpack\[([^\]]+)\]$/.exec(resource))
- ) {
- settings.type = match[1];
- matchResourceData.resource = matchResourceData.resource.slice(
- 0,
- -settings.type.length - 10
- );
- } else {
- settings.type = JAVASCRIPT_MODULE_TYPE_AUTO;
- const resourceDataForRules = matchResourceData || resourceData;
- const result = this.ruleSet.exec({
- resource: resourceDataForRules.path,
- realResource: resourceData.path,
- resourceQuery: resourceDataForRules.query,
- resourceFragment: resourceDataForRules.fragment,
- scheme,
- assertions,
- mimetype: matchResourceData
- ? ""
- : resourceData.data.mimetype || "",
- dependency: dependencyType,
- descriptionData: matchResourceData
- ? undefined
- : resourceData.data.descriptionFileData,
- issuer: contextInfo.issuer,
- compiler: contextInfo.compiler,
- issuerLayer: contextInfo.issuerLayer || ""
- });
- for (const r of result) {
- // https://github.com/webpack/webpack/issues/16466
- // if a request exists PrePostAutoLoaders, should disable modifying Rule.type
- if (r.type === "type" && noPrePostAutoLoaders) {
- continue;
- }
- if (r.type === "use") {
- if (!noAutoLoaders && !noPrePostAutoLoaders) {
- useLoaders.push(r.value);
- }
- } else if (r.type === "use-post") {
- if (!noPrePostAutoLoaders) {
- useLoadersPost.push(r.value);
- }
- } else if (r.type === "use-pre") {
- if (!noPreAutoLoaders && !noPrePostAutoLoaders) {
- useLoadersPre.push(r.value);
- }
- } else if (
- typeof r.value === "object" &&
- r.value !== null &&
- typeof settings[
- /** @type {keyof ModuleSettings} */ (r.type)
- ] === "object" &&
- settings[/** @type {keyof ModuleSettings} */ (r.type)] !== null
- ) {
- settings[r.type] = cachedCleverMerge(
- settings[/** @type {keyof ModuleSettings} */ (r.type)],
- r.value
- );
- } else {
- settings[r.type] = r.value;
- }
- }
- }
- /** @type {undefined | LoaderItem[]} */
- let postLoaders;
- /** @type {undefined | LoaderItem[]} */
- let normalLoaders;
- /** @type {undefined | LoaderItem[]} */
- let preLoaders;
- const continueCallback = needCalls(3, err => {
- if (err) {
- return callback(err);
- }
- const allLoaders = /** @type {LoaderItem[]} */ (postLoaders);
- if (matchResourceData === undefined) {
- for (const loader of /** @type {LoaderItem[]} */ (loaders))
- allLoaders.push(loader);
- for (const loader of /** @type {LoaderItem[]} */ (normalLoaders))
- allLoaders.push(loader);
- } else {
- for (const loader of /** @type {LoaderItem[]} */ (normalLoaders))
- allLoaders.push(loader);
- for (const loader of /** @type {LoaderItem[]} */ (loaders))
- allLoaders.push(loader);
- }
- for (const loader of /** @type {LoaderItem[]} */ (preLoaders))
- allLoaders.push(loader);
- const type = /** @type {string} */ (settings.type);
- const resolveOptions = settings.resolve;
- const layer = settings.layer;
- if (layer !== undefined && !layers) {
- return callback(
- new Error(
- "'Rule.layer' is only allowed when 'experiments.layers' is enabled"
- )
- );
- }
- try {
- Object.assign(data.createData, {
- layer:
- layer === undefined ? contextInfo.issuerLayer || null : layer,
- request: stringifyLoadersAndResource(
- allLoaders,
- resourceData.resource
- ),
- userRequest,
- rawRequest: request,
- loaders: allLoaders,
- resource: resourceData.resource,
- context:
- resourceData.context || getContext(resourceData.resource),
- matchResource: matchResourceData
- ? matchResourceData.resource
- : undefined,
- resourceResolveData: resourceData.data,
- settings,
- type,
- parser: this.getParser(type, settings.parser),
- parserOptions: settings.parser,
- generator: this.getGenerator(type, settings.generator),
- generatorOptions: settings.generator,
- resolveOptions
- });
- } catch (createDataErr) {
- return callback(/** @type {Error} */ (createDataErr));
- }
- callback();
- });
- this.resolveRequestArray(
- contextInfo,
- this.context,
- useLoadersPost,
- loaderResolver,
- resolveContext,
- (err, result) => {
- postLoaders = result;
- continueCallback(err);
- }
- );
- this.resolveRequestArray(
- contextInfo,
- this.context,
- useLoaders,
- loaderResolver,
- resolveContext,
- (err, result) => {
- normalLoaders = result;
- continueCallback(err);
- }
- );
- this.resolveRequestArray(
- contextInfo,
- this.context,
- useLoadersPre,
- loaderResolver,
- resolveContext,
- (err, result) => {
- preLoaders = result;
- continueCallback(err);
- }
- );
- });
- this.resolveRequestArray(
- contextInfo,
- contextScheme ? this.context : context,
- /** @type {LoaderItem[]} */ (elements),
- loaderResolver,
- resolveContext,
- (err, result) => {
- if (err) return continueCallback(err);
- loaders = result;
- continueCallback();
- }
- );
- /**
- * @param {string} context context
- */
- const defaultResolve = context => {
- if (/^($|\?)/.test(unresolvedResource)) {
- resourceData = {
- resource: unresolvedResource,
- data: {},
- ...cacheParseResource(unresolvedResource)
- };
- continueCallback();
- }
- // resource without scheme and with path
- else {
- const normalResolver = this.getResolver(
- "normal",
- dependencyType
- ? cachedSetProperty(
- resolveOptions || EMPTY_RESOLVE_OPTIONS,
- "dependencyType",
- dependencyType
- )
- : resolveOptions
- );
- this.resolveResource(
- contextInfo,
- context,
- unresolvedResource,
- normalResolver,
- resolveContext,
- (err, _resolvedResource, resolvedResourceResolveData) => {
- if (err) return continueCallback(err);
- if (_resolvedResource !== false) {
- const resolvedResource =
- /** @type {string} */
- (_resolvedResource);
- resourceData = {
- resource: resolvedResource,
- data:
- /** @type {ResolveRequest} */
- (resolvedResourceResolveData),
- ...cacheParseResource(resolvedResource)
- };
- }
- continueCallback();
- }
- );
- }
- };
- // resource with scheme
- if (scheme) {
- resourceData = {
- resource: unresolvedResource,
- data: {},
- path: undefined,
- query: undefined,
- fragment: undefined,
- context: undefined
- };
- this.hooks.resolveForScheme
- .for(scheme)
- .callAsync(resourceData, data, err => {
- if (err) return continueCallback(err);
- continueCallback();
- });
- }
- // resource within scheme
- else if (contextScheme) {
- resourceData = {
- resource: unresolvedResource,
- data: {},
- path: undefined,
- query: undefined,
- fragment: undefined,
- context: undefined
- };
- this.hooks.resolveInScheme
- .for(contextScheme)
- .callAsync(resourceData, data, (err, handled) => {
- if (err) return continueCallback(err);
- if (!handled) return defaultResolve(this.context);
- continueCallback();
- });
- }
- // resource without scheme and without path
- else defaultResolve(context);
- }
- );
- }
- cleanupForCache() {
- for (const module of this._restoredUnsafeCacheEntries) {
- ChunkGraph.clearChunkGraphForModule(module);
- ModuleGraph.clearModuleGraphForModule(module);
- module.cleanupForCache();
- }
- }
- /**
- * @param {ModuleFactoryCreateData} data data object
- * @param {function((Error | null)=, ModuleFactoryResult=): void} callback callback
- * @returns {void}
- */
- create(data, callback) {
- const dependencies = /** @type {ModuleDependency[]} */ (data.dependencies);
- const context = data.context || this.context;
- const resolveOptions = data.resolveOptions || EMPTY_RESOLVE_OPTIONS;
- const dependency = dependencies[0];
- const request = dependency.request;
- const assertions = dependency.assertions;
- const contextInfo = data.contextInfo;
- const fileDependencies = new LazySet();
- const missingDependencies = new LazySet();
- const contextDependencies = new LazySet();
- const dependencyType =
- (dependencies.length > 0 && dependencies[0].category) || "";
- /** @type {ResolveData} */
- const resolveData = {
- contextInfo,
- resolveOptions,
- context,
- request,
- assertions,
- dependencies,
- dependencyType,
- fileDependencies,
- missingDependencies,
- contextDependencies,
- createData: {},
- cacheable: true
- };
- this.hooks.beforeResolve.callAsync(resolveData, (err, result) => {
- if (err) {
- return callback(err, {
- fileDependencies,
- missingDependencies,
- contextDependencies,
- cacheable: false
- });
- }
- // Ignored
- if (result === false) {
- /** @type {ModuleFactoryResult} * */
- const factoryResult = {
- fileDependencies,
- missingDependencies,
- contextDependencies,
- cacheable: resolveData.cacheable
- };
- if (resolveData.ignoredModule) {
- factoryResult.module = resolveData.ignoredModule;
- }
- return callback(null, factoryResult);
- }
- if (typeof result === "object")
- throw new Error(
- deprecationChangedHookMessage(
- "beforeResolve",
- this.hooks.beforeResolve
- )
- );
- this.hooks.factorize.callAsync(resolveData, (err, module) => {
- if (err) {
- return callback(err, {
- fileDependencies,
- missingDependencies,
- contextDependencies,
- cacheable: false
- });
- }
- /** @type {ModuleFactoryResult} * */
- const factoryResult = {
- module,
- fileDependencies,
- missingDependencies,
- contextDependencies,
- cacheable: resolveData.cacheable
- };
- callback(null, factoryResult);
- });
- });
- }
- /**
- * @param {ModuleFactoryCreateDataContextInfo} contextInfo context info
- * @param {string} context context
- * @param {string} unresolvedResource unresolved resource
- * @param {ResolverWithOptions} resolver resolver
- * @param {ResolveContext} resolveContext resolver context
- * @param {(err: null | Error, res?: string | false, req?: ResolveRequest) => void} callback callback
- */
- resolveResource(
- contextInfo,
- context,
- unresolvedResource,
- resolver,
- resolveContext,
- callback
- ) {
- resolver.resolve(
- contextInfo,
- context,
- unresolvedResource,
- resolveContext,
- (err, resolvedResource, resolvedResourceResolveData) => {
- if (err) {
- return this._resolveResourceErrorHints(
- err,
- contextInfo,
- context,
- unresolvedResource,
- resolver,
- resolveContext,
- (err2, hints) => {
- if (err2) {
- err.message += `
- A fatal error happened during resolving additional hints for this error: ${err2.message}`;
- err.stack += `
- A fatal error happened during resolving additional hints for this error:
- ${err2.stack}`;
- return callback(err);
- }
- if (hints && hints.length > 0) {
- err.message += `
- ${hints.join("\n\n")}`;
- }
- // Check if the extension is missing a leading dot (e.g. "js" instead of ".js")
- let appendResolveExtensionsHint = false;
- const specifiedExtensions = Array.from(
- resolver.options.extensions
- );
- const expectedExtensions = specifiedExtensions.map(extension => {
- if (LEADING_DOT_EXTENSION_REGEX.test(extension)) {
- appendResolveExtensionsHint = true;
- return `.${extension}`;
- }
- return extension;
- });
- if (appendResolveExtensionsHint) {
- err.message += `\nDid you miss the leading dot in 'resolve.extensions'? Did you mean '${JSON.stringify(
- expectedExtensions
- )}' instead of '${JSON.stringify(specifiedExtensions)}'?`;
- }
- callback(err);
- }
- );
- }
- callback(err, resolvedResource, resolvedResourceResolveData);
- }
- );
- }
- /**
- * @param {Error} error error
- * @param {ModuleFactoryCreateDataContextInfo} contextInfo context info
- * @param {string} context context
- * @param {string} unresolvedResource unresolved resource
- * @param {ResolverWithOptions} resolver resolver
- * @param {ResolveContext} resolveContext resolver context
- * @param {Callback<string[]>} callback callback
- * @private
- */
- _resolveResourceErrorHints(
- error,
- contextInfo,
- context,
- unresolvedResource,
- resolver,
- resolveContext,
- callback
- ) {
- asyncLib.parallel(
- [
- callback => {
- if (!resolver.options.fullySpecified) return callback();
- resolver
- .withOptions({
- fullySpecified: false
- })
- .resolve(
- contextInfo,
- context,
- unresolvedResource,
- resolveContext,
- (err, resolvedResource) => {
- if (!err && resolvedResource) {
- const resource = parseResource(resolvedResource).path.replace(
- /^.*[\\/]/,
- ""
- );
- return callback(
- null,
- `Did you mean '${resource}'?
- BREAKING CHANGE: The request '${unresolvedResource}' failed to resolve only because it was resolved as fully specified
- (probably because the origin is strict EcmaScript Module, e. g. a module with javascript mimetype, a '*.mjs' file, or a '*.js' file where the package.json contains '"type": "module"').
- The extension in the request is mandatory for it to be fully specified.
- Add the extension to the request.`
- );
- }
- callback();
- }
- );
- },
- callback => {
- if (!resolver.options.enforceExtension) return callback();
- resolver
- .withOptions({
- enforceExtension: false,
- extensions: []
- })
- .resolve(
- contextInfo,
- context,
- unresolvedResource,
- resolveContext,
- (err, resolvedResource) => {
- if (!err && resolvedResource) {
- let hint = "";
- const match = /(\.[^.]+)(\?|$)/.exec(unresolvedResource);
- if (match) {
- const fixedRequest = unresolvedResource.replace(
- /(\.[^.]+)(\?|$)/,
- "$2"
- );
- hint = resolver.options.extensions.has(match[1])
- ? `Did you mean '${fixedRequest}'?`
- : `Did you mean '${fixedRequest}'? Also note that '${match[1]}' is not in 'resolve.extensions' yet and need to be added for this to work?`;
- } else {
- hint =
- "Did you mean to omit the extension or to remove 'resolve.enforceExtension'?";
- }
- return callback(
- null,
- `The request '${unresolvedResource}' failed to resolve only because 'resolve.enforceExtension' was specified.
- ${hint}
- Including the extension in the request is no longer possible. Did you mean to enforce including the extension in requests with 'resolve.extensions: []' instead?`
- );
- }
- callback();
- }
- );
- },
- callback => {
- if (
- /^\.\.?\//.test(unresolvedResource) ||
- resolver.options.preferRelative
- ) {
- return callback();
- }
- resolver.resolve(
- contextInfo,
- context,
- `./${unresolvedResource}`,
- resolveContext,
- (err, resolvedResource) => {
- if (err || !resolvedResource) return callback();
- const moduleDirectories = resolver.options.modules
- .map(m => (Array.isArray(m) ? m.join(", ") : m))
- .join(", ");
- callback(
- null,
- `Did you mean './${unresolvedResource}'?
- Requests that should resolve in the current directory need to start with './'.
- Requests that start with a name are treated as module requests and resolve within module directories (${moduleDirectories}).
- If changing the source code is not an option there is also a resolve options called 'preferRelative' which tries to resolve these kind of requests in the current directory too.`
- );
- }
- );
- }
- ],
- (err, hints) => {
- if (err) return callback(err);
- callback(null, /** @type {string[]} */ (hints).filter(Boolean));
- }
- );
- }
- /**
- * @param {ModuleFactoryCreateDataContextInfo} contextInfo context info
- * @param {string} context context
- * @param {LoaderItem[]} array array
- * @param {ResolverWithOptions} resolver resolver
- * @param {ResolveContext} resolveContext resolve context
- * @param {Callback<LoaderItem[]>} callback callback
- * @returns {void} result
- */
- resolveRequestArray(
- contextInfo,
- context,
- array,
- resolver,
- resolveContext,
- callback
- ) {
- // LoaderItem
- if (array.length === 0) return callback(null, array);
- asyncLib.map(
- array,
- (item, callback) => {
- resolver.resolve(
- contextInfo,
- context,
- item.loader,
- resolveContext,
- (err, result, resolveRequest) => {
- if (
- err &&
- /^[^/]*$/.test(item.loader) &&
- !item.loader.endsWith("-loader")
- ) {
- return resolver.resolve(
- contextInfo,
- context,
- `${item.loader}-loader`,
- resolveContext,
- err2 => {
- if (!err2) {
- err.message =
- `${err.message}\n` +
- "BREAKING CHANGE: It's no longer allowed to omit the '-loader' suffix when using loaders.\n" +
- ` You need to specify '${item.loader}-loader' instead of '${item.loader}',\n` +
- " see https://webpack.js.org/migrate/3/#automatic-loader-module-name-extension-removed";
- }
- callback(err);
- }
- );
- }
- if (err) return callback(err);
- const parsedResult = this._parseResourceWithoutFragment(
- /** @type {string} */ (result)
- );
- const type = /\.mjs$/i.test(parsedResult.path)
- ? "module"
- : /\.cjs$/i.test(parsedResult.path)
- ? "commonjs"
- : /** @type {ResolveRequest} */
- (resolveRequest).descriptionFileData === undefined
- ? undefined
- : /** @type {ResolveRequest} */
- (resolveRequest).descriptionFileData.type;
- const resolved = {
- loader: parsedResult.path,
- type,
- options:
- item.options === undefined
- ? parsedResult.query
- ? parsedResult.query.slice(1)
- : undefined
- : item.options,
- ident:
- item.options === undefined
- ? undefined
- : /** @type {string} */ (item.ident)
- };
- return callback(null, /** @type {LoaderItem} */ (resolved));
- }
- );
- },
- /** @type {Callback<TODO>} */ (callback)
- );
- }
- /**
- * @param {string} type type
- * @param {ParserOptions} parserOptions parser options
- * @returns {Parser} parser
- */
- getParser(type, parserOptions = EMPTY_PARSER_OPTIONS) {
- let cache = this.parserCache.get(type);
- if (cache === undefined) {
- cache = new WeakMap();
- this.parserCache.set(type, cache);
- }
- let parser = cache.get(parserOptions);
- if (parser === undefined) {
- parser = this.createParser(type, parserOptions);
- cache.set(parserOptions, parser);
- }
- return parser;
- }
- /**
- * @param {string} type type
- * @param {ParserOptions} parserOptions parser options
- * @returns {Parser} parser
- */
- createParser(type, parserOptions = {}) {
- parserOptions = mergeGlobalOptions(
- this._globalParserOptions,
- type,
- parserOptions
- );
- const parser = this.hooks.createParser.for(type).call(parserOptions);
- if (!parser) {
- throw new Error(`No parser registered for ${type}`);
- }
- this.hooks.parser.for(type).call(parser, parserOptions);
- return parser;
- }
- /**
- * @param {string} type type of generator
- * @param {GeneratorOptions} generatorOptions generator options
- * @returns {Generator} generator
- */
- getGenerator(type, generatorOptions = EMPTY_GENERATOR_OPTIONS) {
- let cache = this.generatorCache.get(type);
- if (cache === undefined) {
- cache = new WeakMap();
- this.generatorCache.set(type, cache);
- }
- let generator = cache.get(generatorOptions);
- if (generator === undefined) {
- generator = this.createGenerator(type, generatorOptions);
- cache.set(generatorOptions, generator);
- }
- return generator;
- }
- /**
- * @param {string} type type of generator
- * @param {GeneratorOptions} generatorOptions generator options
- * @returns {Generator} generator
- */
- createGenerator(type, generatorOptions = {}) {
- generatorOptions = mergeGlobalOptions(
- this._globalGeneratorOptions,
- type,
- generatorOptions
- );
- const generator = this.hooks.createGenerator
- .for(type)
- .call(generatorOptions);
- if (!generator) {
- throw new Error(`No generator registered for ${type}`);
- }
- this.hooks.generator.for(type).call(generator, generatorOptions);
- return generator;
- }
- /**
- * @param {Parameters<ResolverFactory["get"]>[0]} type type of resolver
- * @param {Parameters<ResolverFactory["get"]>[1]=} resolveOptions options
- * @returns {ReturnType<ResolverFactory["get"]>} the resolver
- */
- getResolver(type, resolveOptions) {
- return this.resolverFactory.get(type, resolveOptions);
- }
- }
- module.exports = NormalModuleFactory;
|