AggressiveSplittingPlugin.js 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340
  1. /*
  2. MIT License http://www.opensource.org/licenses/mit-license.php
  3. Author Tobias Koppers @sokra
  4. */
  5. "use strict";
  6. const { STAGE_ADVANCED } = require("../OptimizationStages");
  7. const { intersect } = require("../util/SetHelpers");
  8. const {
  9. compareModulesByIdentifier,
  10. compareChunks
  11. } = require("../util/comparators");
  12. const createSchemaValidation = require("../util/create-schema-validation");
  13. const identifierUtils = require("../util/identifier");
  14. /** @typedef {import("../../declarations/plugins/optimize/AggressiveSplittingPlugin").AggressiveSplittingPluginOptions} AggressiveSplittingPluginOptions */
  15. /** @typedef {import("../Chunk")} Chunk */
  16. /** @typedef {import("../ChunkGraph")} ChunkGraph */
  17. /** @typedef {import("../Compiler")} Compiler */
  18. /** @typedef {import("../Module")} Module */
  19. const validate = createSchemaValidation(
  20. require("../../schemas/plugins/optimize/AggressiveSplittingPlugin.check.js"),
  21. () =>
  22. require("../../schemas/plugins/optimize/AggressiveSplittingPlugin.json"),
  23. {
  24. name: "Aggressive Splitting Plugin",
  25. baseDataPath: "options"
  26. }
  27. );
  28. /**
  29. * @param {ChunkGraph} chunkGraph the chunk graph
  30. * @param {Chunk} oldChunk the old chunk
  31. * @param {Chunk} newChunk the new chunk
  32. * @returns {(module: Module) => void} function to move module between chunks
  33. */
  34. const moveModuleBetween = (chunkGraph, oldChunk, newChunk) => module => {
  35. chunkGraph.disconnectChunkAndModule(oldChunk, module);
  36. chunkGraph.connectChunkAndModule(newChunk, module);
  37. };
  38. /**
  39. * @param {ChunkGraph} chunkGraph the chunk graph
  40. * @param {Chunk} chunk the chunk
  41. * @returns {(module: Module) => boolean} filter for entry module
  42. */
  43. const isNotAEntryModule = (chunkGraph, chunk) => module =>
  44. !chunkGraph.isEntryModuleInChunk(module, chunk);
  45. /** @type {WeakSet<Chunk>} */
  46. const recordedChunks = new WeakSet();
  47. const PLUGIN_NAME = "AggressiveSplittingPlugin";
  48. class AggressiveSplittingPlugin {
  49. /**
  50. * @param {AggressiveSplittingPluginOptions=} options options object
  51. */
  52. constructor(options = {}) {
  53. validate(options);
  54. this.options = options;
  55. if (typeof this.options.minSize !== "number") {
  56. this.options.minSize = 30 * 1024;
  57. }
  58. if (typeof this.options.maxSize !== "number") {
  59. this.options.maxSize = 50 * 1024;
  60. }
  61. if (typeof this.options.chunkOverhead !== "number") {
  62. this.options.chunkOverhead = 0;
  63. }
  64. if (typeof this.options.entryChunkMultiplicator !== "number") {
  65. this.options.entryChunkMultiplicator = 1;
  66. }
  67. }
  68. /**
  69. * @param {Chunk} chunk the chunk to test
  70. * @returns {boolean} true if the chunk was recorded
  71. */
  72. static wasChunkRecorded(chunk) {
  73. return recordedChunks.has(chunk);
  74. }
  75. /**
  76. * Apply the plugin
  77. * @param {Compiler} compiler the compiler instance
  78. * @returns {void}
  79. */
  80. apply(compiler) {
  81. compiler.hooks.thisCompilation.tap(PLUGIN_NAME, compilation => {
  82. let needAdditionalSeal = false;
  83. /** @typedef {{ id?: NonNullable<Chunk["id"]>, hash?: NonNullable<Chunk["hash"]>, modules: Module[], size: number }} SplitData */
  84. /** @type {SplitData[]} */
  85. let newSplits;
  86. /** @type {Set<Chunk>} */
  87. let fromAggressiveSplittingSet;
  88. /** @type {Map<Chunk, SplitData>} */
  89. let chunkSplitDataMap;
  90. compilation.hooks.optimize.tap(PLUGIN_NAME, () => {
  91. newSplits = [];
  92. fromAggressiveSplittingSet = new Set();
  93. chunkSplitDataMap = new Map();
  94. });
  95. compilation.hooks.optimizeChunks.tap(
  96. {
  97. name: PLUGIN_NAME,
  98. stage: STAGE_ADVANCED
  99. },
  100. chunks => {
  101. const chunkGraph = compilation.chunkGraph;
  102. // Precompute stuff
  103. const nameToModuleMap = new Map();
  104. const moduleToNameMap = new Map();
  105. const makePathsRelative =
  106. identifierUtils.makePathsRelative.bindContextCache(
  107. compiler.context,
  108. compiler.root
  109. );
  110. for (const m of compilation.modules) {
  111. const name = makePathsRelative(m.identifier());
  112. nameToModuleMap.set(name, m);
  113. moduleToNameMap.set(m, name);
  114. }
  115. // Check used chunk ids
  116. const usedIds = new Set();
  117. for (const chunk of chunks) {
  118. usedIds.add(chunk.id);
  119. }
  120. const recordedSplits =
  121. (compilation.records && compilation.records.aggressiveSplits) || [];
  122. const usedSplits = newSplits
  123. ? recordedSplits.concat(newSplits)
  124. : recordedSplits;
  125. const minSize = /** @type {number} */ (this.options.minSize);
  126. const maxSize = /** @type {number} */ (this.options.maxSize);
  127. /**
  128. * @param {SplitData} splitData split data
  129. * @returns {boolean} true when applied, otherwise false
  130. */
  131. const applySplit = splitData => {
  132. // Cannot split if id is already taken
  133. if (splitData.id !== undefined && usedIds.has(splitData.id)) {
  134. return false;
  135. }
  136. // Get module objects from names
  137. const selectedModules = splitData.modules.map(name =>
  138. nameToModuleMap.get(name)
  139. );
  140. // Does the modules exist at all?
  141. if (!selectedModules.every(Boolean)) return false;
  142. // Check if size matches (faster than waiting for hash)
  143. let size = 0;
  144. for (const m of selectedModules) size += m.size();
  145. if (size !== splitData.size) return false;
  146. // get chunks with all modules
  147. const selectedChunks = intersect(
  148. selectedModules.map(
  149. m => new Set(chunkGraph.getModuleChunksIterable(m))
  150. )
  151. );
  152. // No relevant chunks found
  153. if (selectedChunks.size === 0) return false;
  154. // The found chunk is already the split or similar
  155. if (
  156. selectedChunks.size === 1 &&
  157. chunkGraph.getNumberOfChunkModules(
  158. Array.from(selectedChunks)[0]
  159. ) === selectedModules.length
  160. ) {
  161. const chunk = Array.from(selectedChunks)[0];
  162. if (fromAggressiveSplittingSet.has(chunk)) return false;
  163. fromAggressiveSplittingSet.add(chunk);
  164. chunkSplitDataMap.set(chunk, splitData);
  165. return true;
  166. }
  167. // split the chunk into two parts
  168. const newChunk = compilation.addChunk();
  169. newChunk.chunkReason = "aggressive splitted";
  170. for (const chunk of selectedChunks) {
  171. for (const module of selectedModules) {
  172. moveModuleBetween(chunkGraph, chunk, newChunk)(module);
  173. }
  174. chunk.split(newChunk);
  175. chunk.name = null;
  176. }
  177. fromAggressiveSplittingSet.add(newChunk);
  178. chunkSplitDataMap.set(newChunk, splitData);
  179. if (splitData.id !== null && splitData.id !== undefined) {
  180. newChunk.id = splitData.id;
  181. newChunk.ids = [splitData.id];
  182. }
  183. return true;
  184. };
  185. // try to restore to recorded splitting
  186. let changed = false;
  187. for (let j = 0; j < usedSplits.length; j++) {
  188. const splitData = usedSplits[j];
  189. if (applySplit(splitData)) changed = true;
  190. }
  191. // for any chunk which isn't splitted yet, split it and create a new entry
  192. // start with the biggest chunk
  193. const cmpFn = compareChunks(chunkGraph);
  194. const sortedChunks = Array.from(chunks).sort((a, b) => {
  195. const diff1 =
  196. chunkGraph.getChunkModulesSize(b) -
  197. chunkGraph.getChunkModulesSize(a);
  198. if (diff1) return diff1;
  199. const diff2 =
  200. chunkGraph.getNumberOfChunkModules(a) -
  201. chunkGraph.getNumberOfChunkModules(b);
  202. if (diff2) return diff2;
  203. return cmpFn(a, b);
  204. });
  205. for (const chunk of sortedChunks) {
  206. if (fromAggressiveSplittingSet.has(chunk)) continue;
  207. const size = chunkGraph.getChunkModulesSize(chunk);
  208. if (
  209. size > maxSize &&
  210. chunkGraph.getNumberOfChunkModules(chunk) > 1
  211. ) {
  212. const modules = chunkGraph
  213. .getOrderedChunkModules(chunk, compareModulesByIdentifier)
  214. .filter(isNotAEntryModule(chunkGraph, chunk));
  215. const selectedModules = [];
  216. let selectedModulesSize = 0;
  217. for (let k = 0; k < modules.length; k++) {
  218. const module = modules[k];
  219. const newSize = selectedModulesSize + module.size();
  220. if (newSize > maxSize && selectedModulesSize >= minSize) {
  221. break;
  222. }
  223. selectedModulesSize = newSize;
  224. selectedModules.push(module);
  225. }
  226. if (selectedModules.length === 0) continue;
  227. /** @type {SplitData} */
  228. const splitData = {
  229. modules: selectedModules
  230. .map(m => moduleToNameMap.get(m))
  231. .sort(),
  232. size: selectedModulesSize
  233. };
  234. if (applySplit(splitData)) {
  235. newSplits = (newSplits || []).concat(splitData);
  236. changed = true;
  237. }
  238. }
  239. }
  240. if (changed) return true;
  241. }
  242. );
  243. compilation.hooks.recordHash.tap(PLUGIN_NAME, records => {
  244. // 4. save made splittings to records
  245. const allSplits = new Set();
  246. /** @type {Set<SplitData>} */
  247. const invalidSplits = new Set();
  248. // Check if some splittings are invalid
  249. // We remove invalid splittings and try again
  250. for (const chunk of compilation.chunks) {
  251. const splitData = chunkSplitDataMap.get(chunk);
  252. if (
  253. splitData !== undefined &&
  254. splitData.hash &&
  255. chunk.hash !== splitData.hash
  256. ) {
  257. // Split was successful, but hash doesn't equal
  258. // We can throw away the split since it's useless now
  259. invalidSplits.add(splitData);
  260. }
  261. }
  262. if (invalidSplits.size > 0) {
  263. records.aggressiveSplits =
  264. /** @type {SplitData[]} */
  265. (records.aggressiveSplits).filter(
  266. splitData => !invalidSplits.has(splitData)
  267. );
  268. needAdditionalSeal = true;
  269. } else {
  270. // set hash and id values on all (new) splittings
  271. for (const chunk of compilation.chunks) {
  272. const splitData = chunkSplitDataMap.get(chunk);
  273. if (splitData !== undefined) {
  274. splitData.hash =
  275. /** @type {NonNullable<Chunk["hash"]>} */
  276. (chunk.hash);
  277. splitData.id =
  278. /** @type {NonNullable<Chunk["id"]>} */
  279. (chunk.id);
  280. allSplits.add(splitData);
  281. // set flag for stats
  282. recordedChunks.add(chunk);
  283. }
  284. }
  285. // Also add all unused historical splits (after the used ones)
  286. // They can still be used in some future compilation
  287. const recordedSplits =
  288. compilation.records && compilation.records.aggressiveSplits;
  289. if (recordedSplits) {
  290. for (const splitData of recordedSplits) {
  291. if (!invalidSplits.has(splitData)) allSplits.add(splitData);
  292. }
  293. }
  294. // record all splits
  295. records.aggressiveSplits = Array.from(allSplits);
  296. needAdditionalSeal = false;
  297. }
  298. });
  299. compilation.hooks.needAdditionalSeal.tap(PLUGIN_NAME, () => {
  300. if (needAdditionalSeal) {
  301. needAdditionalSeal = false;
  302. return true;
  303. }
  304. });
  305. });
  306. }
  307. }
  308. module.exports = AggressiveSplittingPlugin;