mirror of https://github.com/webpack/webpack.git
511 lines
16 KiB
JavaScript
511 lines
16 KiB
JavaScript
/*
|
|
MIT License http://www.opensource.org/licenses/mit-license.php
|
|
Author Tobias Koppers @sokra
|
|
*/
|
|
"use strict";
|
|
const path = require("path");
|
|
const util = require("util");
|
|
const Module = require("./Module");
|
|
const OriginalSource = require("webpack-sources").OriginalSource;
|
|
const RawSource = require("webpack-sources").RawSource;
|
|
const AsyncDependenciesBlock = require("./AsyncDependenciesBlock");
|
|
const DepBlockHelpers = require("./dependencies/DepBlockHelpers");
|
|
const Template = require("./Template");
|
|
|
|
class ContextModule extends Module {
|
|
// type ContextMode = "sync" | "eager" | "weak" | "async-weak" | "lazy" | "lazy-once"
|
|
// type ContextOptions = { resource: string, recursive: boolean, regExp: RegExp, addon?: string, mode?: ContextMode, chunkName?: string, include?: RegExp, exclude?: RegExp }
|
|
// resolveDependencies: (fs: FS, options: ContextOptions, (err: Error?, dependencies: Dependency[]) => void) => void
|
|
// options: ContextOptions
|
|
constructor(resolveDependencies, options) {
|
|
super();
|
|
|
|
// Info from Factory
|
|
this.resolveDependencies = resolveDependencies;
|
|
let resource, resourceQuery;
|
|
const queryIdx = options.resource.indexOf("?");
|
|
if(queryIdx >= 0) {
|
|
resource = options.resource.substr(0, queryIdx);
|
|
resourceQuery = options.resource.substr(queryIdx);
|
|
} else {
|
|
resource = options.resource;
|
|
resourceQuery = "";
|
|
}
|
|
this.options = Object.assign({}, options, {
|
|
resource: resource,
|
|
resourceQuery: resourceQuery
|
|
});
|
|
this.context = this.options.resource;
|
|
|
|
// Info from Build
|
|
this.builtTime = undefined;
|
|
this.contextDependencies = new Set([this.context]);
|
|
|
|
if(typeof options.mode !== "string")
|
|
throw new Error("options.mode is a required option");
|
|
}
|
|
|
|
prettyRegExp(regexString) {
|
|
// remove the "/" at the front and the beginning
|
|
// "/foo/" -> "foo"
|
|
return regexString.substring(1, regexString.length - 1);
|
|
}
|
|
|
|
contextify(context, request) {
|
|
return request.split("!").map(subrequest => {
|
|
let rp = path.relative(context, subrequest);
|
|
if(path.sep === "\\")
|
|
rp = rp.replace(/\\/g, "/");
|
|
if(rp.indexOf("../") !== 0)
|
|
rp = "./" + rp;
|
|
return rp;
|
|
}).join("!");
|
|
}
|
|
|
|
identifier() {
|
|
let identifier = this.context;
|
|
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.options.regExp}`;
|
|
if(this.options.include)
|
|
identifier += ` include: ${this.options.include}`;
|
|
if(this.options.exclude)
|
|
identifier += ` exclude: ${this.options.exclude}`;
|
|
|
|
return identifier;
|
|
}
|
|
|
|
readableIdentifier(requestShortener) {
|
|
let identifier = requestShortener.shorten(this.context);
|
|
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 + "")}`;
|
|
|
|
return identifier;
|
|
}
|
|
|
|
libIdent(options) {
|
|
let identifier = this.contextify(options.context, this.context);
|
|
if(this.options.mode)
|
|
identifier += ` ${this.options.mode}`;
|
|
if(this.options.recursive)
|
|
identifier += " recursive";
|
|
if(this.options.addon)
|
|
identifier += ` ${this.contextify(options.context, 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 + "")}`;
|
|
|
|
return identifier;
|
|
}
|
|
|
|
needRebuild(fileTimestamps, contextTimestamps) {
|
|
const ts = contextTimestamps[this.context];
|
|
if(!ts) {
|
|
return true;
|
|
}
|
|
|
|
return ts >= this.builtTime;
|
|
}
|
|
|
|
build(options, compilation, resolver, fs, callback) {
|
|
this.built = true;
|
|
this.builtTime = Date.now();
|
|
this.resolveDependencies(fs, this.options, (err, dependencies) => {
|
|
if(err) return callback(err);
|
|
|
|
// Reset children
|
|
this.dependencies.length = 0;
|
|
this.blocks.length = 0;
|
|
|
|
// abort if something failed
|
|
// this will create an empty context
|
|
if(!dependencies) {
|
|
callback();
|
|
return;
|
|
}
|
|
|
|
// enhance dependencies with meta info
|
|
dependencies.forEach(dep => {
|
|
dep.loc = dep.userRequest;
|
|
dep.request = this.options.addon + dep.request;
|
|
});
|
|
|
|
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.chunkName, this);
|
|
dependencies.forEach(dep => {
|
|
block.addDependency(dep);
|
|
});
|
|
this.addBlock(block);
|
|
}
|
|
|
|
} else if(this.options.mode === "weak" || this.options.mode === "async-weak") {
|
|
|
|
// we mark all dependencies as weak
|
|
dependencies.forEach(dep => 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
|
|
dependencies.forEach((dep, idx) => {
|
|
let chunkName = this.options.chunkName;
|
|
if(chunkName) {
|
|
if(!/\[(index|request)\]/.test(chunkName))
|
|
chunkName += "[index]";
|
|
chunkName = chunkName.replace(/\[index\]/g, idx);
|
|
chunkName = chunkName.replace(/\[request\]/g, Template.toPath(dep.userRequest));
|
|
}
|
|
const block = new AsyncDependenciesBlock(chunkName, dep.module, dep.loc);
|
|
block.addDependency(dep);
|
|
this.addBlock(block);
|
|
});
|
|
} else {
|
|
callback(new Error(`Unsupported mode "${this.options.mode}" in context`));
|
|
return;
|
|
}
|
|
callback();
|
|
});
|
|
}
|
|
|
|
getUserRequestMap(dependencies) {
|
|
// if we filter first we get a new array
|
|
// therefor we dont need to create a clone of dependencies explicitly
|
|
// therefore the order of this is !important!
|
|
return dependencies
|
|
.filter(dependency => dependency.module)
|
|
.sort((a, b) => {
|
|
if(a.userRequest === b.userRequest) {
|
|
return 0;
|
|
}
|
|
return a.userRequest < b.userRequest ? -1 : 1;
|
|
}).reduce((map, dep) => {
|
|
map[dep.userRequest] = dep.module.id;
|
|
return map;
|
|
}, Object.create(null));
|
|
}
|
|
|
|
getSyncSource(dependencies, id) {
|
|
const map = this.getUserRequestMap(dependencies);
|
|
return `var map = ${JSON.stringify(map, null, "\t")};
|
|
function webpackContext(req) {
|
|
return __webpack_require__(webpackContextResolve(req));
|
|
};
|
|
function webpackContextResolve(req) {
|
|
var id = map[req];
|
|
if(!(id + 1)) // check for number or string
|
|
throw new Error("Cannot find module '" + req + "'.");
|
|
return id;
|
|
};
|
|
webpackContext.keys = function webpackContextKeys() {
|
|
return Object.keys(map);
|
|
};
|
|
webpackContext.resolve = webpackContextResolve;
|
|
module.exports = webpackContext;
|
|
webpackContext.id = ${JSON.stringify(id)};`;
|
|
}
|
|
|
|
getWeakSyncSource(dependencies, id) {
|
|
const map = this.getUserRequestMap(dependencies);
|
|
return `var map = ${JSON.stringify(map, null, "\t")};
|
|
function webpackContext(req) {
|
|
var id = webpackContextResolve(req);
|
|
if(!__webpack_require__.m[id])
|
|
throw new Error("Module '" + req + "' ('" + id + "') is not available (weak dependency)");
|
|
return __webpack_require__(id);
|
|
};
|
|
function webpackContextResolve(req) {
|
|
var id = map[req];
|
|
if(!(id + 1)) // check for number or string
|
|
throw new Error("Cannot find module '" + req + "'.");
|
|
return id;
|
|
};
|
|
webpackContext.keys = function webpackContextKeys() {
|
|
return Object.keys(map);
|
|
};
|
|
webpackContext.resolve = webpackContextResolve;
|
|
webpackContext.id = ${JSON.stringify(id)};
|
|
module.exports = webpackContext;`;
|
|
}
|
|
|
|
getAsyncWeakSource(dependencies, id) {
|
|
const map = this.getUserRequestMap(dependencies);
|
|
|
|
return `var map = ${JSON.stringify(map, null, "\t")};
|
|
function webpackAsyncContext(req) {
|
|
return webpackAsyncContextResolve(req).then(function(id) {
|
|
if(!__webpack_require__.m[id])
|
|
throw new Error("Module '" + req + "' ('" + id + "') is not available (weak dependency)");
|
|
return __webpack_require__(id);
|
|
});
|
|
};
|
|
function webpackAsyncContextResolve(req) {
|
|
// Here Promise.resolve().then() is used instead of new Promise() to prevent
|
|
// uncatched exception popping up in devtools
|
|
return Promise.resolve().then(function() {
|
|
var id = map[req];
|
|
if(!(id + 1)) // check for number or string
|
|
throw new Error("Cannot find module '" + req + "'.");
|
|
return id;
|
|
});
|
|
};
|
|
webpackAsyncContext.keys = function webpackAsyncContextKeys() {
|
|
return Object.keys(map);
|
|
};
|
|
webpackAsyncContext.resolve = webpackAsyncContextResolve;
|
|
webpackAsyncContext.id = ${JSON.stringify(id)};
|
|
module.exports = webpackAsyncContext;`;
|
|
}
|
|
|
|
getEagerSource(dependencies, id) {
|
|
const map = this.getUserRequestMap(dependencies);
|
|
return `var map = ${JSON.stringify(map, null, "\t")};
|
|
function webpackAsyncContext(req) {
|
|
return webpackAsyncContextResolve(req).then(__webpack_require__);
|
|
};
|
|
function webpackAsyncContextResolve(req) {
|
|
// Here Promise.resolve().then() is used instead of new Promise() to prevent
|
|
// uncatched exception popping up in devtools
|
|
return Promise.resolve().then(function() {
|
|
var id = map[req];
|
|
if(!(id + 1)) // check for number or string
|
|
throw new Error("Cannot find module '" + req + "'.");
|
|
return id;
|
|
});
|
|
};
|
|
webpackAsyncContext.keys = function webpackAsyncContextKeys() {
|
|
return Object.keys(map);
|
|
};
|
|
webpackAsyncContext.resolve = webpackAsyncContextResolve;
|
|
webpackAsyncContext.id = ${JSON.stringify(id)};
|
|
module.exports = webpackAsyncContext;`;
|
|
}
|
|
|
|
getLazyOnceSource(block, dependencies, id, outputOptions, requestShortener) {
|
|
const promise = DepBlockHelpers.getDepBlockPromise(block, outputOptions, requestShortener, "lazy-once context");
|
|
const map = this.getUserRequestMap(dependencies);
|
|
return `var map = ${JSON.stringify(map, null, "\t")};
|
|
function webpackAsyncContext(req) {
|
|
return webpackAsyncContextResolve(req).then(__webpack_require__);
|
|
};
|
|
function webpackAsyncContextResolve(req) {
|
|
return ${promise}.then(function() {
|
|
var id = map[req];
|
|
if(!(id + 1)) // check for number or string
|
|
throw new Error("Cannot find module '" + req + "'.");
|
|
return id;
|
|
});
|
|
};
|
|
webpackAsyncContext.keys = function webpackAsyncContextKeys() {
|
|
return Object.keys(map);
|
|
};
|
|
webpackAsyncContext.resolve = webpackAsyncContextResolve;
|
|
webpackAsyncContext.id = ${JSON.stringify(id)};
|
|
module.exports = webpackAsyncContext;`;
|
|
}
|
|
|
|
getLazySource(blocks, id) {
|
|
let hasMultipleOrNoChunks = false;
|
|
const map = blocks
|
|
.filter(block => block.dependencies[0].module)
|
|
.map((block) => ({
|
|
dependency: block.dependencies[0],
|
|
block: block,
|
|
userRequest: block.dependencies[0].userRequest
|
|
})).sort((a, b) => {
|
|
if(a.userRequest === b.userRequest) return 0;
|
|
return a.userRequest < b.userRequest ? -1 : 1;
|
|
}).reduce((map, item) => {
|
|
const chunks = item.block.chunks || [];
|
|
if(chunks.length !== 1) {
|
|
hasMultipleOrNoChunks = true;
|
|
}
|
|
map[item.userRequest] = [item.dependency.module.id]
|
|
.concat(chunks.map(chunk => chunk.id));
|
|
|
|
return map;
|
|
}, Object.create(null));
|
|
|
|
const requestPrefix = hasMultipleOrNoChunks ?
|
|
"Promise.all(ids.slice(1).map(__webpack_require__.e))" :
|
|
"__webpack_require__.e(ids[1])";
|
|
|
|
return `var map = ${JSON.stringify(map, null, "\t")};
|
|
function webpackAsyncContext(req) {
|
|
var ids = map[req];
|
|
if(!ids)
|
|
return Promise.reject(new Error("Cannot find module '" + req + "'."));
|
|
return ${requestPrefix}.then(function() {
|
|
return __webpack_require__(ids[0]);
|
|
});
|
|
};
|
|
webpackAsyncContext.keys = function webpackAsyncContextKeys() {
|
|
return Object.keys(map);
|
|
};
|
|
webpackAsyncContext.id = ${JSON.stringify(id)};
|
|
module.exports = webpackAsyncContext;`;
|
|
}
|
|
|
|
getSourceForEmptyContext(id) {
|
|
return `function webpackEmptyContext(req) {
|
|
throw new Error("Cannot find module '" + req + "'.");
|
|
}
|
|
webpackEmptyContext.keys = function() { return []; };
|
|
webpackEmptyContext.resolve = webpackEmptyContext;
|
|
module.exports = webpackEmptyContext;
|
|
webpackEmptyContext.id = ${JSON.stringify(id)};`;
|
|
}
|
|
|
|
getSourceForEmptyAsyncContext(id) {
|
|
return `function webpackEmptyAsyncContext(req) {
|
|
// Here Promise.resolve().then() is used instead of new Promise() to prevent
|
|
// uncatched exception popping up in devtools
|
|
return Promise.resolve().then(function() {
|
|
throw new Error("Cannot find module '" + req + "'.");
|
|
});
|
|
}
|
|
webpackEmptyAsyncContext.keys = function() { return []; };
|
|
webpackEmptyAsyncContext.resolve = webpackEmptyAsyncContext;
|
|
module.exports = webpackEmptyAsyncContext;
|
|
webpackEmptyAsyncContext.id = ${JSON.stringify(id)};`;
|
|
}
|
|
|
|
getSourceString(asyncMode, outputOptions, requestShortener) {
|
|
if(asyncMode === "lazy") {
|
|
if(this.blocks && this.blocks.length > 0) {
|
|
return this.getLazySource(this.blocks, this.id);
|
|
}
|
|
return this.getSourceForEmptyAsyncContext(this.id);
|
|
}
|
|
if(asyncMode === "eager") {
|
|
if(this.dependencies && this.dependencies.length > 0) {
|
|
return this.getEagerSource(this.dependencies, this.id);
|
|
}
|
|
return this.getSourceForEmptyAsyncContext(this.id);
|
|
}
|
|
if(asyncMode === "lazy-once") {
|
|
const block = this.blocks[0];
|
|
if(block) {
|
|
return this.getLazyOnceSource(block, block.dependencies, this.id, outputOptions, requestShortener);
|
|
}
|
|
return this.getSourceForEmptyAsyncContext(this.id);
|
|
}
|
|
if(asyncMode === "async-weak") {
|
|
if(this.dependencies && this.dependencies.length > 0) {
|
|
return this.getAsyncWeakSource(this.dependencies, this.id);
|
|
}
|
|
return this.getSourceForEmptyAsyncContext(this.id);
|
|
}
|
|
if(asyncMode === "weak") {
|
|
if(this.dependencies && this.dependencies.length > 0) {
|
|
return this.getWeakSyncSource(this.dependencies, this.id);
|
|
}
|
|
}
|
|
if(this.dependencies && this.dependencies.length > 0) {
|
|
return this.getSyncSource(this.dependencies, this.id);
|
|
}
|
|
return this.getSourceForEmptyContext(this.id);
|
|
}
|
|
|
|
getSource(sourceString) {
|
|
if(this.useSourceMap) {
|
|
return new OriginalSource(sourceString, this.identifier());
|
|
}
|
|
return new RawSource(sourceString);
|
|
}
|
|
|
|
source(dependencyTemplates, outputOptions, requestShortener) {
|
|
return this.getSource(
|
|
this.getSourceString(this.options.mode, outputOptions, requestShortener)
|
|
);
|
|
}
|
|
|
|
size() {
|
|
// base penalty
|
|
const initialSize = 160;
|
|
|
|
// if we dont have dependencies we stop here.
|
|
return this.dependencies
|
|
.reduce((size, dependency) => size + 5 + dependency.userRequest.length, initialSize);
|
|
}
|
|
}
|
|
|
|
Object.defineProperty(ContextModule.prototype, "recursive", {
|
|
configurable: false,
|
|
get: util.deprecate(function() {
|
|
return this.options.recursive;
|
|
}, "ContextModule.recursive has been moved to ContextModule.options.recursive"),
|
|
set: util.deprecate(function(value) {
|
|
this.options.recursive = value;
|
|
}, "ContextModule.recursive has been moved to ContextModule.options.recursive")
|
|
});
|
|
|
|
Object.defineProperty(ContextModule.prototype, "regExp", {
|
|
configurable: false,
|
|
get: util.deprecate(function() {
|
|
return this.options.regExp;
|
|
}, "ContextModule.regExp has been moved to ContextModule.options.regExp"),
|
|
set: util.deprecate(function(value) {
|
|
this.options.regExp = value;
|
|
}, "ContextModule.regExp has been moved to ContextModule.options.regExp")
|
|
});
|
|
|
|
Object.defineProperty(ContextModule.prototype, "addon", {
|
|
configurable: false,
|
|
get: util.deprecate(function() {
|
|
return this.options.addon;
|
|
}, "ContextModule.addon has been moved to ContextModule.options.addon"),
|
|
set: util.deprecate(function(value) {
|
|
this.options.addon = value;
|
|
}, "ContextModule.addon has been moved to ContextModule.options.addon")
|
|
});
|
|
|
|
Object.defineProperty(ContextModule.prototype, "async", {
|
|
configurable: false,
|
|
get: util.deprecate(function() {
|
|
return this.options.mode;
|
|
}, "ContextModule.async has been moved to ContextModule.options.mode"),
|
|
set: util.deprecate(function(value) {
|
|
this.options.mode = value;
|
|
}, "ContextModule.async has been moved to ContextModule.options.mode")
|
|
});
|
|
|
|
Object.defineProperty(ContextModule.prototype, "chunkName", {
|
|
configurable: false,
|
|
get: util.deprecate(function() {
|
|
return this.options.chunkName;
|
|
}, "ContextModule.chunkName has been moved to ContextModule.options.chunkName"),
|
|
set: util.deprecate(function(value) {
|
|
this.options.chunkName = value;
|
|
}, "ContextModule.chunkName has been moved to ContextModule.options.chunkName")
|
|
});
|
|
|
|
module.exports = ContextModule;
|