WebAssemblyInInitialChunkError.js 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  1. /*
  2. MIT License http://www.opensource.org/licenses/mit-license.php
  3. */
  4. "use strict";
  5. const WebpackError = require("../WebpackError");
  6. /** @typedef {import("../ChunkGraph")} ChunkGraph */
  7. /** @typedef {import("../Module")} Module */
  8. /** @typedef {import("../ModuleGraph")} ModuleGraph */
  9. /** @typedef {import("../RequestShortener")} RequestShortener */
  10. /**
  11. * @param {Module} module module to get chains from
  12. * @param {ModuleGraph} moduleGraph the module graph
  13. * @param {ChunkGraph} chunkGraph the chunk graph
  14. * @param {RequestShortener} requestShortener to make readable identifiers
  15. * @returns {string[]} all chains to the module
  16. */
  17. const getInitialModuleChains = (
  18. module,
  19. moduleGraph,
  20. chunkGraph,
  21. requestShortener
  22. ) => {
  23. const queue = [
  24. { head: module, message: module.readableIdentifier(requestShortener) }
  25. ];
  26. /** @type {Set<string>} */
  27. const results = new Set();
  28. /** @type {Set<string>} */
  29. const incompleteResults = new Set();
  30. /** @type {Set<Module>} */
  31. const visitedModules = new Set();
  32. for (const chain of queue) {
  33. const { head, message } = chain;
  34. let final = true;
  35. /** @type {Set<Module>} */
  36. const alreadyReferencedModules = new Set();
  37. for (const connection of moduleGraph.getIncomingConnections(head)) {
  38. const newHead = connection.originModule;
  39. if (newHead) {
  40. if (
  41. !chunkGraph.getModuleChunks(newHead).some((c) => c.canBeInitial())
  42. ) {
  43. continue;
  44. }
  45. final = false;
  46. if (alreadyReferencedModules.has(newHead)) continue;
  47. alreadyReferencedModules.add(newHead);
  48. const moduleName = newHead.readableIdentifier(requestShortener);
  49. const detail = connection.explanation
  50. ? ` (${connection.explanation})`
  51. : "";
  52. const newMessage = `${moduleName}${detail} --> ${message}`;
  53. if (visitedModules.has(newHead)) {
  54. incompleteResults.add(`... --> ${newMessage}`);
  55. continue;
  56. }
  57. visitedModules.add(newHead);
  58. queue.push({
  59. head: newHead,
  60. message: newMessage
  61. });
  62. } else {
  63. final = false;
  64. const newMessage = connection.explanation
  65. ? `(${connection.explanation}) --> ${message}`
  66. : message;
  67. results.add(newMessage);
  68. }
  69. }
  70. if (final) {
  71. results.add(message);
  72. }
  73. }
  74. for (const result of incompleteResults) {
  75. results.add(result);
  76. }
  77. return [...results];
  78. };
  79. module.exports = class WebAssemblyInInitialChunkError extends WebpackError {
  80. /**
  81. * @param {Module} module WASM module
  82. * @param {ModuleGraph} moduleGraph the module graph
  83. * @param {ChunkGraph} chunkGraph the chunk graph
  84. * @param {RequestShortener} requestShortener request shortener
  85. */
  86. constructor(module, moduleGraph, chunkGraph, requestShortener) {
  87. const moduleChains = getInitialModuleChains(
  88. module,
  89. moduleGraph,
  90. chunkGraph,
  91. requestShortener
  92. );
  93. const message = `WebAssembly module is included in initial chunk.
  94. This is not allowed, because WebAssembly download and compilation must happen asynchronous.
  95. Add an async split point (i. e. import()) somewhere between your entrypoint and the WebAssembly module:
  96. ${moduleChains.map((s) => `* ${s}`).join("\n")}`;
  97. super(message);
  98. this.name = "WebAssemblyInInitialChunkError";
  99. this.hideStack = true;
  100. this.module = module;
  101. }
  102. };