667 lines
17 KiB
JavaScript
667 lines
17 KiB
JavaScript
/*
|
|
MIT License http://www.opensource.org/licenses/mit-license.php
|
|
Author Tobias Koppers @sokra
|
|
*/
|
|
|
|
"use strict";
|
|
|
|
const ChunkGraph = require("./ChunkGraph");
|
|
const Entrypoint = require("./Entrypoint");
|
|
const { intersect } = require("./util/SetHelpers");
|
|
const SortableSet = require("./util/SortableSet");
|
|
const {
|
|
compareModulesByIdentifier,
|
|
compareChunkGroupsByIndex
|
|
} = require("./util/comparators");
|
|
const { createArrayToSetDeprecationSet } = require("./util/deprecation");
|
|
|
|
/** @typedef {import("webpack-sources").Source} Source */
|
|
/** @typedef {import("./ChunkGraph").ChunkFilterPredicate} ChunkFilterPredicate */
|
|
/** @typedef {import("./ChunkGraph").ChunkModuleMaps} ChunkModuleMaps */
|
|
/** @typedef {import("./ChunkGraph").ChunkSizeOptions} ChunkSizeOptions */
|
|
/** @typedef {import("./ChunkGraph").ModuleFilterPredicate} ModuleFilterPredicate */
|
|
/** @typedef {import("./ChunkGroup")} ChunkGroup */
|
|
/** @typedef {import("./Compilation")} Compilation */
|
|
/** @typedef {import("./Compilation").AssetInfo} AssetInfo */
|
|
/** @typedef {import("./Compilation").PathData} PathData */
|
|
/** @typedef {import("./Module")} Module */
|
|
/** @typedef {import("./ModuleGraph")} ModuleGraph */
|
|
/** @typedef {import("./util/Hash")} Hash */
|
|
|
|
const ChunkFilesSet = createArrayToSetDeprecationSet("chunk.files");
|
|
|
|
/**
|
|
* @typedef {Object} WithId an object who has an id property *
|
|
* @property {string | number} id the id of the object
|
|
*/
|
|
|
|
/**
|
|
* @deprecated
|
|
* @typedef {Object} ChunkMaps
|
|
* @property {Record<string|number, string>} hash
|
|
* @property {Record<string|number, Record<string, string>>} contentHash
|
|
* @property {Record<string|number, string>} name
|
|
*/
|
|
|
|
/**
|
|
* Compare two Modules based on their ids for sorting
|
|
* @param {Module} a module
|
|
* @param {Module} b module
|
|
* @returns {-1|0|1} sort value
|
|
*/
|
|
|
|
let debugId = 1000;
|
|
|
|
/**
|
|
* A Chunk is a unit of encapsulation for Modules.
|
|
* Chunks are "rendered" into bundles that get emitted when the build completes.
|
|
*/
|
|
class Chunk {
|
|
/**
|
|
* @param {string=} name of chunk being created, is optional (for subclasses)
|
|
*/
|
|
constructor(name) {
|
|
/** @type {number | string | null} */
|
|
this.id = null;
|
|
/** @type {(number|string)[] | null} */
|
|
this.ids = null;
|
|
/** @type {number} */
|
|
this.debugId = debugId++;
|
|
/** @type {string} */
|
|
this.name = name;
|
|
/** @type {SortableSet<string>} */
|
|
this.idNameHints = new SortableSet();
|
|
/** @type {boolean} */
|
|
this.preventIntegration = false;
|
|
/** @type {(string | function(PathData, AssetInfo=): string)?} */
|
|
this.filenameTemplate = undefined;
|
|
/** @private @type {SortableSet<ChunkGroup>} */
|
|
this._groups = new SortableSet(undefined, compareChunkGroupsByIndex);
|
|
/** @type {Set<string>} */
|
|
this.files = new ChunkFilesSet();
|
|
/** @type {Set<string>} */
|
|
this.auxiliaryFiles = new Set();
|
|
/** @type {boolean} */
|
|
this.rendered = false;
|
|
/** @type {string=} */
|
|
this.hash = undefined;
|
|
/** @type {Record<string, string>} */
|
|
this.contentHash = Object.create(null);
|
|
/** @type {string=} */
|
|
this.renderedHash = undefined;
|
|
/** @type {string=} */
|
|
this.chunkReason = undefined;
|
|
/** @type {boolean} */
|
|
this.extraAsync = false;
|
|
}
|
|
|
|
// TODO remove in webpack 6
|
|
// BACKWARD-COMPAT START
|
|
get entryModule() {
|
|
const entryModules = Array.from(
|
|
ChunkGraph.getChunkGraphForChunk(
|
|
this,
|
|
"Chunk.entryModule"
|
|
).getChunkEntryModulesIterable(this)
|
|
);
|
|
if (entryModules.length === 0) {
|
|
return undefined;
|
|
} else if (entryModules.length === 1) {
|
|
return entryModules[0];
|
|
} else {
|
|
throw new Error(
|
|
"Module.entryModule: Multiple entry modules are not supported by the deprecated API (Use the new ChunkGroup API)"
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @returns {boolean} true, if the chunk contains an entry module
|
|
*/
|
|
hasEntryModule() {
|
|
return (
|
|
ChunkGraph.getChunkGraphForChunk(
|
|
this,
|
|
"Chunk.hasEntryModule"
|
|
).getNumberOfEntryModules(this) > 0
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @param {Module} module the module
|
|
* @returns {boolean} true, if the chunk could be added
|
|
*/
|
|
addModule(module) {
|
|
const chunkGraph = ChunkGraph.getChunkGraphForChunk(
|
|
this,
|
|
"Chunk.addModule"
|
|
);
|
|
if (chunkGraph.isModuleInChunk(module, this)) return false;
|
|
chunkGraph.connectChunkAndModule(this, module);
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @param {Module} module the module
|
|
* @returns {void}
|
|
*/
|
|
removeModule(module) {
|
|
ChunkGraph.getChunkGraphForChunk(
|
|
this,
|
|
"Chunk.removeModule"
|
|
).disconnectChunkAndModule(this, module);
|
|
}
|
|
|
|
/**
|
|
* @returns {number} the number of module which are contained in this chunk
|
|
*/
|
|
getNumberOfModules() {
|
|
return ChunkGraph.getChunkGraphForChunk(
|
|
this,
|
|
"Chunk.getNumberOfModules"
|
|
).getNumberOfChunkModules(this);
|
|
}
|
|
|
|
get modulesIterable() {
|
|
const chunkGraph = ChunkGraph.getChunkGraphForChunk(
|
|
this,
|
|
"Chunk.modulesIterable"
|
|
);
|
|
return chunkGraph.getOrderedChunkModulesIterable(
|
|
this,
|
|
compareModulesByIdentifier
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @param {Chunk} otherChunk the chunk to compare with
|
|
* @returns {-1|0|1} the comparison result
|
|
*/
|
|
compareTo(otherChunk) {
|
|
const chunkGraph = ChunkGraph.getChunkGraphForChunk(
|
|
this,
|
|
"Chunk.compareTo"
|
|
);
|
|
return chunkGraph.compareChunks(this, otherChunk);
|
|
}
|
|
|
|
/**
|
|
* @param {Module} module the module
|
|
* @returns {boolean} true, if the chunk contains the module
|
|
*/
|
|
containsModule(module) {
|
|
return ChunkGraph.getChunkGraphForChunk(
|
|
this,
|
|
"Chunk.containsModule"
|
|
).isModuleInChunk(module, this);
|
|
}
|
|
|
|
/**
|
|
* @returns {Module[]} the modules for this chunk
|
|
*/
|
|
getModules() {
|
|
return ChunkGraph.getChunkGraphForChunk(
|
|
this,
|
|
"Chunk.getModules"
|
|
).getChunkModules(this);
|
|
}
|
|
|
|
/**
|
|
* @returns {void}
|
|
*/
|
|
remove() {
|
|
const chunkGraph = ChunkGraph.getChunkGraphForChunk(this, "Chunk.remove");
|
|
chunkGraph.disconnectChunk(this);
|
|
this.disconnectFromGroups();
|
|
}
|
|
|
|
/**
|
|
* @param {Module} module the module
|
|
* @param {Chunk} otherChunk the target chunk
|
|
* @returns {void}
|
|
*/
|
|
moveModule(module, otherChunk) {
|
|
const chunkGraph = ChunkGraph.getChunkGraphForChunk(
|
|
this,
|
|
"Chunk.moveModule"
|
|
);
|
|
chunkGraph.disconnectChunkAndModule(this, module);
|
|
chunkGraph.connectChunkAndModule(otherChunk, module);
|
|
}
|
|
|
|
/**
|
|
* @param {Chunk} otherChunk the other chunk
|
|
* @returns {boolean} true, if the specified chunk has been integrated
|
|
*/
|
|
integrate(otherChunk) {
|
|
const chunkGraph = ChunkGraph.getChunkGraphForChunk(
|
|
this,
|
|
"Chunk.integrate"
|
|
);
|
|
if (chunkGraph.canChunksBeIntegrated(this, otherChunk)) {
|
|
chunkGraph.integrateChunks(this, otherChunk);
|
|
return true;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param {Chunk} otherChunk the other chunk
|
|
* @returns {boolean} true, if chunks could be integrated
|
|
*/
|
|
canBeIntegrated(otherChunk) {
|
|
const chunkGraph = ChunkGraph.getChunkGraphForChunk(
|
|
this,
|
|
"Chunk.canBeIntegrated"
|
|
);
|
|
return chunkGraph.canChunksBeIntegrated(this, otherChunk);
|
|
}
|
|
|
|
/**
|
|
* @returns {boolean} true, if this chunk contains no module
|
|
*/
|
|
isEmpty() {
|
|
const chunkGraph = ChunkGraph.getChunkGraphForChunk(this, "Chunk.isEmpty");
|
|
return chunkGraph.getNumberOfChunkModules(this) === 0;
|
|
}
|
|
|
|
/**
|
|
* @returns {number} total size of all modules in this chunk
|
|
*/
|
|
modulesSize() {
|
|
const chunkGraph = ChunkGraph.getChunkGraphForChunk(
|
|
this,
|
|
"Chunk.modulesSize"
|
|
);
|
|
return chunkGraph.getChunkModulesSize(this);
|
|
}
|
|
|
|
/**
|
|
* @param {ChunkSizeOptions} options options object
|
|
* @returns {number} total size of this chunk
|
|
*/
|
|
size(options = {}) {
|
|
const chunkGraph = ChunkGraph.getChunkGraphForChunk(this, "Chunk.size");
|
|
return chunkGraph.getChunkSize(this, options);
|
|
}
|
|
|
|
/**
|
|
* @param {Chunk} otherChunk the other chunk
|
|
* @param {ChunkSizeOptions} options options object
|
|
* @returns {number} total size of the chunk or false if the chunk can't be integrated
|
|
*/
|
|
integratedSize(otherChunk, options) {
|
|
const chunkGraph = ChunkGraph.getChunkGraphForChunk(
|
|
this,
|
|
"Chunk.integratedSize"
|
|
);
|
|
return chunkGraph.getIntegratedChunksSize(this, otherChunk, options);
|
|
}
|
|
|
|
/**
|
|
* @param {ModuleFilterPredicate} filterFn function used to filter modules
|
|
* @returns {ChunkModuleMaps} module map information
|
|
*/
|
|
getChunkModuleMaps(filterFn) {
|
|
const chunkGraph = ChunkGraph.getChunkGraphForChunk(
|
|
this,
|
|
"Chunk.getChunkModuleMaps"
|
|
);
|
|
return chunkGraph.getChunkModuleMaps(this, filterFn);
|
|
}
|
|
|
|
/**
|
|
* @param {ModuleFilterPredicate} filterFn predicate function used to filter modules
|
|
* @param {ChunkFilterPredicate=} filterChunkFn predicate function used to filter chunks
|
|
* @returns {boolean} return true if module exists in graph
|
|
*/
|
|
hasModuleInGraph(filterFn, filterChunkFn) {
|
|
const chunkGraph = ChunkGraph.getChunkGraphForChunk(
|
|
this,
|
|
"Chunk.hasModuleInGraph"
|
|
);
|
|
return chunkGraph.hasModuleInGraph(this, filterFn, filterChunkFn);
|
|
}
|
|
|
|
/**
|
|
* @deprecated
|
|
* @param {boolean} realHash should the full hash or the rendered hash be used
|
|
* @returns {ChunkMaps} the chunk map information
|
|
*/
|
|
getChunkMaps(realHash) {
|
|
/** @type {Record<string|number, string>} */
|
|
const chunkHashMap = Object.create(null);
|
|
/** @type {Record<string|number, Record<string, string>>} */
|
|
const chunkContentHashMap = Object.create(null);
|
|
/** @type {Record<string|number, string>} */
|
|
const chunkNameMap = Object.create(null);
|
|
|
|
for (const chunk of this.getAllAsyncChunks()) {
|
|
chunkHashMap[chunk.id] = realHash ? chunk.hash : chunk.renderedHash;
|
|
for (const key of Object.keys(chunk.contentHash)) {
|
|
if (!chunkContentHashMap[key]) {
|
|
chunkContentHashMap[key] = Object.create(null);
|
|
}
|
|
chunkContentHashMap[key][chunk.id] = chunk.contentHash[key];
|
|
}
|
|
if (chunk.name) {
|
|
chunkNameMap[chunk.id] = chunk.name;
|
|
}
|
|
}
|
|
|
|
return {
|
|
hash: chunkHashMap,
|
|
contentHash: chunkContentHashMap,
|
|
name: chunkNameMap
|
|
};
|
|
}
|
|
// BACKWARD-COMPAT END
|
|
|
|
/**
|
|
* @returns {boolean} whether or not the Chunk will have a runtime
|
|
*/
|
|
hasRuntime() {
|
|
for (const chunkGroup of this._groups) {
|
|
if (
|
|
chunkGroup.isInitial() &&
|
|
chunkGroup instanceof Entrypoint &&
|
|
chunkGroup.getRuntimeChunk() === this
|
|
) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @returns {boolean} whether or not this chunk can be an initial chunk
|
|
*/
|
|
canBeInitial() {
|
|
for (const chunkGroup of this._groups) {
|
|
if (chunkGroup.isInitial()) return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @returns {boolean} whether this chunk can only be an initial chunk
|
|
*/
|
|
isOnlyInitial() {
|
|
if (this._groups.size <= 0) return false;
|
|
for (const chunkGroup of this._groups) {
|
|
if (!chunkGroup.isInitial()) return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @param {ChunkGroup} chunkGroup the chunkGroup the chunk is being added
|
|
* @returns {boolean} returns true if chunk is not apart of chunkGroup and is added successfully
|
|
*/
|
|
addGroup(chunkGroup) {
|
|
if (this._groups.has(chunkGroup)) return false;
|
|
this._groups.add(chunkGroup);
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @param {ChunkGroup} chunkGroup the chunkGroup the chunk is being removed from
|
|
* @returns {boolean} returns true if chunk does exist in chunkGroup and is removed
|
|
*/
|
|
removeGroup(chunkGroup) {
|
|
if (!this._groups.has(chunkGroup)) return false;
|
|
this._groups.delete(chunkGroup);
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @param {ChunkGroup} chunkGroup the chunkGroup to check
|
|
* @returns {boolean} returns true if chunk has chunkGroup reference and exists in chunkGroup
|
|
*/
|
|
isInGroup(chunkGroup) {
|
|
return this._groups.has(chunkGroup);
|
|
}
|
|
|
|
/**
|
|
* @returns {number} the amount of groups said chunk is in
|
|
*/
|
|
getNumberOfGroups() {
|
|
return this._groups.size;
|
|
}
|
|
|
|
/**
|
|
* @returns {Iterable<ChunkGroup>} the chunkGroups that said chunk is referenced in
|
|
*/
|
|
get groupsIterable() {
|
|
this._groups.sort();
|
|
return this._groups;
|
|
}
|
|
|
|
/**
|
|
* @returns {void}
|
|
*/
|
|
disconnectFromGroups() {
|
|
for (const chunkGroup of this._groups) {
|
|
chunkGroup.removeChunk(this);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param {Chunk} newChunk the new chunk that will be split out of, and then chunk raphi twil=
|
|
* @returns {void}
|
|
*/
|
|
split(newChunk) {
|
|
for (const chunkGroup of this._groups) {
|
|
chunkGroup.insertChunk(newChunk, this);
|
|
newChunk.addGroup(chunkGroup);
|
|
}
|
|
for (const idHint of this.idNameHints) {
|
|
newChunk.idNameHints.add(idHint);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param {Hash} hash hash (will be modified)
|
|
* @param {ChunkGraph} chunkGraph the chunk graph
|
|
* @returns {void}
|
|
*/
|
|
updateHash(hash, chunkGraph) {
|
|
hash.update(`${this.id} `);
|
|
hash.update(this.ids ? this.ids.join(",") : "");
|
|
hash.update(`${this.name || ""} `);
|
|
for (const m of chunkGraph.getOrderedChunkModulesIterable(
|
|
this,
|
|
compareModulesByIdentifier
|
|
)) {
|
|
hash.update(chunkGraph.getModuleHash(m));
|
|
}
|
|
const entryModules = chunkGraph.getChunkEntryModulesWithChunkGroupIterable(
|
|
this
|
|
);
|
|
for (const [m, chunkGroup] of entryModules) {
|
|
hash.update("entry");
|
|
hash.update(chunkGraph.getModuleHash(m));
|
|
hash.update(chunkGroup.id);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @returns {Set<Chunk>} a set of all the async chunks
|
|
*/
|
|
getAllAsyncChunks() {
|
|
const queue = new Set();
|
|
const chunks = new Set();
|
|
|
|
const initialChunks = intersect(
|
|
Array.from(this.groupsIterable, g => new Set(g.chunks))
|
|
);
|
|
|
|
for (const chunkGroup of this.groupsIterable) {
|
|
for (const child of chunkGroup.childrenIterable) {
|
|
queue.add(child);
|
|
}
|
|
}
|
|
|
|
for (const chunkGroup of queue) {
|
|
for (const chunk of chunkGroup.chunks) {
|
|
if (!initialChunks.has(chunk)) {
|
|
chunks.add(chunk);
|
|
}
|
|
}
|
|
for (const child of chunkGroup.childrenIterable) {
|
|
queue.add(child);
|
|
}
|
|
}
|
|
|
|
return chunks;
|
|
}
|
|
|
|
/**
|
|
* @returns {Set<Chunk>} a set of all the referenced chunks (including itself)
|
|
*/
|
|
getAllReferencedChunks() {
|
|
const queue = new Set(this.groupsIterable);
|
|
const chunks = new Set();
|
|
|
|
for (const chunkGroup of queue) {
|
|
for (const chunk of chunkGroup.chunks) {
|
|
chunks.add(chunk);
|
|
}
|
|
for (const child of chunkGroup.childrenIterable) {
|
|
queue.add(child);
|
|
}
|
|
}
|
|
|
|
return chunks;
|
|
}
|
|
|
|
/**
|
|
* @returns {boolean} true, if the chunk references async chunks
|
|
*/
|
|
hasAsyncChunks() {
|
|
const queue = new Set();
|
|
|
|
const initialChunks = intersect(
|
|
Array.from(this.groupsIterable, g => new Set(g.chunks))
|
|
);
|
|
|
|
for (const chunkGroup of this.groupsIterable) {
|
|
for (const child of chunkGroup.childrenIterable) {
|
|
queue.add(child);
|
|
}
|
|
}
|
|
|
|
for (const chunkGroup of queue) {
|
|
for (const chunk of chunkGroup.chunks) {
|
|
if (!initialChunks.has(chunk)) {
|
|
return true;
|
|
}
|
|
}
|
|
for (const child of chunkGroup.childrenIterable) {
|
|
queue.add(child);
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @param {ChunkGraph} chunkGraph the chunk graph
|
|
* @param {ChunkFilterPredicate=} filterFn function used to filter chunks
|
|
* @returns {Record<string, (string | number)[]>} a record object of names to lists of child ids(?)
|
|
*/
|
|
getChildIdsByOrders(chunkGraph, filterFn) {
|
|
/** @type {Map<string, {order: number, group: ChunkGroup}[]>} */
|
|
const lists = new Map();
|
|
for (const group of this.groupsIterable) {
|
|
if (group.chunks[group.chunks.length - 1] === this) {
|
|
for (const childGroup of group.childrenIterable) {
|
|
for (const key of Object.keys(childGroup.options)) {
|
|
if (key.endsWith("Order")) {
|
|
const name = key.substr(0, key.length - "Order".length);
|
|
let list = lists.get(name);
|
|
if (list === undefined) {
|
|
list = [];
|
|
lists.set(name, list);
|
|
}
|
|
list.push({
|
|
order: childGroup.options[key],
|
|
group: childGroup
|
|
});
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
/** @type {Record<string, (string | number)[]>} */
|
|
const result = Object.create(null);
|
|
for (const [name, list] of lists) {
|
|
list.sort((a, b) => {
|
|
const cmp = b.order - a.order;
|
|
if (cmp !== 0) return cmp;
|
|
return a.group.compareTo(chunkGraph, b.group);
|
|
});
|
|
/** @type {Set<string | number>} */
|
|
const chunkIdSet = list.reduce((set, item) => {
|
|
for (const chunk of item.group.chunks) {
|
|
if (filterFn && !filterFn(chunk, chunkGraph)) continue;
|
|
set.add(chunk.id);
|
|
}
|
|
return set;
|
|
}, new Set());
|
|
if (chunkIdSet.size > 0) {
|
|
result[name] = Array.from(chunkIdSet);
|
|
}
|
|
}
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* @param {ChunkGraph} chunkGraph the chunk graph
|
|
* @param {boolean=} includeDirectChildren include direct children (by default only children of async children are included)
|
|
* @param {ChunkFilterPredicate=} filterFn function used to filter chunks
|
|
* @returns {Record<string|number, Record<string, (string | number)[]>>} a record object of names to lists of child ids(?) by chunk id
|
|
*/
|
|
getChildIdsByOrdersMap(chunkGraph, includeDirectChildren, filterFn) {
|
|
/** @type {Record<string|number, Record<string, (string | number)[]>>} */
|
|
const chunkMaps = Object.create(null);
|
|
|
|
/**
|
|
* @param {Chunk} chunk a chunk
|
|
* @returns {void}
|
|
*/
|
|
const addChildIdsByOrdersToMap = chunk => {
|
|
const data = chunk.getChildIdsByOrders(chunkGraph, filterFn);
|
|
for (const key of Object.keys(data)) {
|
|
let chunkMap = chunkMaps[key];
|
|
if (chunkMap === undefined) {
|
|
chunkMaps[key] = chunkMap = Object.create(null);
|
|
}
|
|
chunkMap[chunk.id] = data[key];
|
|
}
|
|
};
|
|
|
|
if (includeDirectChildren) {
|
|
/** @type {Set<Chunk>} */
|
|
const chunks = new Set();
|
|
for (const chunkGroup of this.groupsIterable) {
|
|
for (const chunk of chunkGroup.chunks) {
|
|
chunks.add(chunk);
|
|
}
|
|
}
|
|
for (const chunk of chunks) {
|
|
addChildIdsByOrdersToMap(chunk);
|
|
}
|
|
}
|
|
|
|
for (const chunk of this.getAllAsyncChunks()) {
|
|
addChildIdsByOrdersToMap(chunk);
|
|
}
|
|
|
|
return chunkMaps;
|
|
}
|
|
}
|
|
|
|
module.exports = Chunk;
|