AsyncWebAssemblyJavascriptGenerator.js 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311
  1. /*
  2. MIT License http://www.opensource.org/licenses/mit-license.php
  3. Author Tobias Koppers @sokra
  4. */
  5. "use strict";
  6. const { RawSource } = require("webpack-sources");
  7. const Generator = require("../Generator");
  8. const InitFragment = require("../InitFragment");
  9. const { WEBASSEMBLY_TYPES } = require("../ModuleSourceTypeConstants");
  10. const RuntimeGlobals = require("../RuntimeGlobals");
  11. const Template = require("../Template");
  12. const WebAssemblyImportDependency = require("../dependencies/WebAssemblyImportDependency");
  13. /** @import { Source } from "webpack-sources" */
  14. /** @import AsyncWasmModule from "./AsyncWasmModule" */
  15. /** @import { GenerateContext } from "../Generator" */
  16. /** @import Module, { SourceType, SourceTypes } from "../Module" */
  17. /** @import NormalModule from "../NormalModule" */
  18. /**
  19. * Represents the async web assembly javascript generator runtime component.
  20. * @typedef {{ request: string, importVar: string, dependency: WebAssemblyImportDependency }} ImportObjRequestItem
  21. */
  22. class AsyncWebAssemblyJavascriptGenerator extends Generator {
  23. /**
  24. * Returns the source types available for this module.
  25. * @param {NormalModule} module fresh module
  26. * @returns {SourceTypes} available types (do not mutate)
  27. */
  28. getTypes(module) {
  29. return WEBASSEMBLY_TYPES;
  30. }
  31. /**
  32. * Returns the estimated size for the requested source type.
  33. * @param {NormalModule} module the module
  34. * @param {SourceType=} type source type
  35. * @returns {number} estimate size of the module
  36. */
  37. getSize(module, type) {
  38. // it's only estimated so this number is probably fine
  39. // Example: m.exports=s.v(e,_.id,"6db474f11db19c35388a")
  40. if (/** @type {AsyncWasmModule} */ (module).phase === "source") {
  41. return 44;
  42. }
  43. return 40 + module.dependencies.length * 10;
  44. }
  45. /**
  46. * Generates generated code for this runtime module.
  47. * @param {NormalModule} module module for which the code should be generated
  48. * @param {GenerateContext} generateContext context for generate
  49. * @returns {Source | null} generated code
  50. */
  51. generate(module, generateContext) {
  52. const {
  53. runtimeTemplate,
  54. chunkGraph,
  55. moduleGraph,
  56. runtimeRequirements,
  57. runtime
  58. } = generateContext;
  59. // Check if this is a source phase import
  60. if (/** @type {AsyncWasmModule} */ (module).phase === "source") {
  61. return this._generateSourcePhase(module, generateContext);
  62. }
  63. const analyzableUrl = runtimeTemplate.supportsAnalyzable(
  64. "wasm",
  65. chunkGraph,
  66. module,
  67. runtime
  68. )
  69. ? runtimeTemplate.getAnalyzableWasmUrl(
  70. module,
  71. chunkGraph,
  72. runtime,
  73. runtimeRequirements
  74. )
  75. : null;
  76. runtimeRequirements.add(RuntimeGlobals.module);
  77. if (analyzableUrl === null) {
  78. runtimeRequirements.add(RuntimeGlobals.moduleId);
  79. }
  80. runtimeRequirements.add(RuntimeGlobals.exports);
  81. runtimeRequirements.add(RuntimeGlobals.instantiateWasm);
  82. /** @type {InitFragment<GenerateContext>[]} */
  83. const initFragments = [];
  84. /** @type {Map<Module, ImportObjRequestItem>} */
  85. const depModules = new Map();
  86. /** @type {Map<string, WebAssemblyImportDependency[]>} */
  87. const wasmDepsByRequest = new Map();
  88. for (const dep of module.dependencies) {
  89. if (dep instanceof WebAssemblyImportDependency) {
  90. const module = /** @type {Module} */ (moduleGraph.getModule(dep));
  91. if (!depModules.has(module)) {
  92. depModules.set(module, {
  93. request: dep.request,
  94. importVar: `WEBPACK_IMPORTED_MODULE_${depModules.size}`,
  95. dependency: dep
  96. });
  97. }
  98. let list = wasmDepsByRequest.get(dep.request);
  99. if (list === undefined) {
  100. list = [];
  101. wasmDepsByRequest.set(dep.request, list);
  102. }
  103. list.push(dep);
  104. }
  105. }
  106. /** @type {string[]} */
  107. const promises = [];
  108. const importStatements = Array.from(
  109. depModules,
  110. ([importedModule, { request, importVar, dependency }]) => {
  111. if (moduleGraph.isAsync(importedModule)) {
  112. promises.push(importVar);
  113. }
  114. return runtimeTemplate.importStatement({
  115. update: false,
  116. module: importedModule,
  117. moduleGraph,
  118. chunkGraph,
  119. request,
  120. originModule: module,
  121. importVar,
  122. runtimeRequirements,
  123. dependency
  124. });
  125. }
  126. );
  127. const importsCode = importStatements.map(([x]) => x).join("");
  128. const importsCompatCode = importStatements.map(([_, x]) => x).join("");
  129. const importObjRequestItems = Array.from(
  130. wasmDepsByRequest,
  131. ([request, deps]) => {
  132. const exportItems = deps.map((dep) => {
  133. const importedModule =
  134. /** @type {Module} */
  135. (moduleGraph.getModule(dep));
  136. const importVar =
  137. /** @type {ImportObjRequestItem} */
  138. (depModules.get(importedModule)).importVar;
  139. return `${JSON.stringify(
  140. dep.name
  141. )}: ${runtimeTemplate.exportFromImport({
  142. moduleGraph,
  143. module: importedModule,
  144. chunkGraph,
  145. request,
  146. exportName: dep.name,
  147. originModule: module,
  148. asiSafe: true,
  149. isCall: false,
  150. callContext: false,
  151. defaultInterop: true,
  152. importVar,
  153. initFragments,
  154. runtime,
  155. runtimeRequirements,
  156. dependency: dep
  157. })}`;
  158. });
  159. return Template.asString([
  160. `${JSON.stringify(request)}: {`,
  161. Template.indent(exportItems.join(",\n")),
  162. "}"
  163. ]);
  164. }
  165. );
  166. const importsObj =
  167. importObjRequestItems.length > 0
  168. ? Template.asString([
  169. "{",
  170. Template.indent(importObjRequestItems.join(",\n")),
  171. "}"
  172. ])
  173. : undefined;
  174. const locator =
  175. analyzableUrl === null
  176. ? `${module.moduleArgument}.id, ${JSON.stringify(
  177. chunkGraph.getRenderedModuleHash(module, runtime)
  178. )}`
  179. : analyzableUrl;
  180. const instantiateCall = `${RuntimeGlobals.instantiateWasm}(${
  181. module.exportsArgument
  182. }, ${locator}${importsObj ? `, ${importsObj})` : ")"}`;
  183. if (promises.length > 0) {
  184. runtimeRequirements.add(RuntimeGlobals.asyncModule);
  185. }
  186. const source = new RawSource(
  187. promises.length > 0
  188. ? Template.asString([
  189. `var __webpack_instantiate__ = ${runtimeTemplate.basicFunction(
  190. `[${promises.join(", ")}]`,
  191. `${importsCompatCode}return ${instantiateCall};`
  192. )}`,
  193. `${RuntimeGlobals.asyncModule}(${
  194. module.moduleArgument
  195. }, async ${runtimeTemplate.basicFunction(
  196. "__webpack_handle_async_dependencies__, __webpack_async_result__",
  197. [
  198. "try {",
  199. importsCode,
  200. `var __webpack_async_dependencies__ = __webpack_handle_async_dependencies__([${promises.join(
  201. ", "
  202. )}]);`,
  203. `var [${promises.join(
  204. ", "
  205. )}] = __webpack_async_dependencies__.then ? (await __webpack_async_dependencies__)() : __webpack_async_dependencies__;`,
  206. `${importsCompatCode}await ${instantiateCall};`,
  207. "__webpack_async_result__();",
  208. "} catch(e) { __webpack_async_result__(e); }"
  209. ]
  210. )}, 1);`
  211. ])
  212. : `${importsCode}${importsCompatCode}module.exports = ${instantiateCall};`
  213. );
  214. return InitFragment.addToSource(source, initFragments, generateContext);
  215. }
  216. /**
  217. * Generate code for source phase import (returns WebAssembly.Module)
  218. * @param {NormalModule} module module for which the code should be generated
  219. * @param {GenerateContext} generateContext context for generate
  220. * @returns {Source} generated code
  221. */
  222. _generateSourcePhase(module, generateContext) {
  223. const { chunkGraph, runtimeTemplate, runtimeRequirements, runtime } =
  224. generateContext;
  225. const analyzableUrl = runtimeTemplate.supportsAnalyzable(
  226. "wasm",
  227. chunkGraph,
  228. module,
  229. runtime
  230. )
  231. ? runtimeTemplate.getAnalyzableWasmUrl(
  232. module,
  233. chunkGraph,
  234. runtime,
  235. runtimeRequirements
  236. )
  237. : null;
  238. runtimeRequirements.add(RuntimeGlobals.module);
  239. if (analyzableUrl === null) {
  240. runtimeRequirements.add(RuntimeGlobals.moduleId);
  241. }
  242. runtimeRequirements.add(RuntimeGlobals.exports);
  243. runtimeRequirements.add(RuntimeGlobals.compileWasm);
  244. runtimeRequirements.add(RuntimeGlobals.asyncModule);
  245. runtimeRequirements.add(RuntimeGlobals.definePropertyGetters);
  246. // Source phase: export default WebAssembly.Module (via compileWasm)
  247. const compileCall = `${RuntimeGlobals.compileWasm}(${
  248. analyzableUrl === null
  249. ? `${module.moduleArgument}.id, ${JSON.stringify(
  250. chunkGraph.getRenderedModuleHash(module, runtime)
  251. )}`
  252. : analyzableUrl
  253. })`;
  254. // Use async module wrapper to handle the Promise from compileWasm
  255. return new RawSource(
  256. Template.asString([
  257. `${RuntimeGlobals.asyncModule}(${
  258. module.moduleArgument
  259. }, async ${runtimeTemplate.basicFunction(
  260. "__webpack_handle_async_dependencies__, __webpack_async_result__",
  261. [
  262. "try {",
  263. `var __webpack_wasm_module__ = await ${compileCall};`,
  264. `${RuntimeGlobals.definePropertyGetters}(${module.exportsArgument}, { "default": ${runtimeTemplate.returningFunction("__webpack_wasm_module__")} });`,
  265. "__webpack_async_result__();",
  266. "} catch(e) { __webpack_async_result__(e); }"
  267. ]
  268. )}, 1);`
  269. ])
  270. );
  271. }
  272. /**
  273. * Generates fallback output for the provided error condition.
  274. * @param {Error} error the error
  275. * @param {NormalModule} module module for which the code should be generated
  276. * @param {GenerateContext} generateContext context for generate
  277. * @returns {Source | null} generated code
  278. */
  279. generateError(error, module, generateContext) {
  280. return new RawSource(
  281. Generator.throwBuildErrorCode(error, "WebAssembly.CompileError")
  282. );
  283. }
  284. }
  285. module.exports = AsyncWebAssemblyJavascriptGenerator;