WebAssemblyInInitialChunkError.js 3.3 KB

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