| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168 |
- /*
- MIT License http://www.opensource.org/licenses/mit-license.php
- Author Alexander Akait @alexander-akait
- */
- "use strict";
- const { WEBASSEMBLY_MODULE_TYPE_ASYNC } = require("../ModuleTypeConstants");
- const RuntimeGlobals = require("../RuntimeGlobals");
- const Template = require("../Template");
- const { usesFullHashDigest } = require("../TemplatedPathPlugin");
- const AsyncWasmCompileRuntimeModule = require("../wasm-async/AsyncWasmCompileRuntimeModule");
- const AsyncWasmLoadingRuntimeModule = require("../wasm-async/AsyncWasmLoadingRuntimeModule");
- /** @import Chunk from "../Chunk" */
- /** @import Compiler from "../Compiler" */
- /** @import { RuntimeSpec } from "../util/runtime" */
- const PLUGIN_NAME = "UniversalCompileAsyncWasmPlugin";
- /**
- * Enables async WebAssembly loading that works in both browser-like and Node.js
- * environments by selecting the appropriate binary-loading strategy at runtime.
- */
- class UniversalCompileAsyncWasmPlugin {
- /**
- * Registers compilation hooks that attach the universal async wasm runtime
- * to chunks using `wasmLoading: "universal"`.
- * @param {Compiler} compiler the compiler instance
- * @returns {void}
- */
- apply(compiler) {
- compiler.hooks.thisCompilation.tap(PLUGIN_NAME, (compilation) => {
- const globalWasmLoading = compilation.outputOptions.wasmLoading;
- /**
- * Determines whether the chunk should use the universal async wasm
- * loading backend.
- * @param {Chunk} chunk chunk
- * @returns {boolean} true, if wasm loading is enabled for the chunk
- */
- const isEnabledForChunk = (chunk) => {
- const options = chunk.getEntryOptions();
- const wasmLoading =
- options && options.wasmLoading !== undefined
- ? options.wasmLoading
- : globalWasmLoading;
- return wasmLoading === "universal";
- };
- const generateBeforeStreaming = () =>
- Template.asString([
- "if (!useFetch) {",
- Template.indent(["return fallback();"]),
- "}"
- ]);
- /**
- * Generates setup code that decides whether the current environment can
- * use `fetch` and captures the wasm module URL.
- * @param {string} path path
- * @returns {string} code
- */
- const generateBeforeLoadBinaryCode = (path) =>
- Template.asString([
- `var useFetch = ${compilation.runtimeTemplate.isWebLikePlatformExpression()};`,
- `var wasmUrl = ${path};`
- ]);
- // `wasmUrl` already holds a complete `URL` when the call site bakes it. Read that
- // per call: it depends on parse results, so it is not settled while the plugin
- // is being applied.
- /**
- * @param {RuntimeSpec} runtime the runtime this loader serves
- * @returns {string} the argument to hand the reader
- */
- const wasmUrlArg = (runtime) =>
- compilation.runtimeTemplate.supportsAnalyzable(
- "wasm",
- undefined,
- undefined,
- runtime
- )
- ? "wasmUrl"
- : compilation.runtimeTemplate.importMetaUrl("wasmUrl");
- /**
- * Generates the runtime expression that fetches the binary in browsers
- * or reads it from the filesystem in Node.js.
- * @type {(path: string, runtime: RuntimeSpec) => string}
- */
- const generateLoadBinaryCode = (path, runtime) =>
- Template.asString([
- "(useFetch",
- Template.indent([`? fetch(${wasmUrlArg(runtime)})`]),
- Template.indent([
- ": Promise.all([import('fs'), import('url')]).then(([{ readFile }, { URL }]) => new Promise((resolve, reject) => {",
- Template.indent([
- `readFile(${wasmUrlArg(runtime)}, (err, buffer) => {`,
- Template.indent([
- "if (err) return reject(err);",
- "",
- "// Fake fetch response",
- "resolve({",
- Template.indent(["arrayBuffer() { return buffer; }"]),
- "});"
- ]),
- "});"
- ]),
- "})))"
- ])
- ]);
- compilation.hooks.runtimeRequirementInTree
- .for(RuntimeGlobals.instantiateWasm)
- .tap(PLUGIN_NAME, (chunk, set, { chunkGraph }) => {
- if (!isEnabledForChunk(chunk)) return;
- if (
- !chunkGraph.hasModuleInGraph(
- chunk,
- (m) => m.type === WEBASSEMBLY_MODULE_TYPE_ASYNC
- )
- ) {
- return;
- }
- compilation.addRuntimeModule(
- chunk,
- new AsyncWasmLoadingRuntimeModule({
- fullHashDigest: usesFullHashDigest(
- /** @type {string} */ (
- compilation.outputOptions.webassemblyModuleFilename
- )
- ),
- generateBeforeLoadBinaryCode,
- generateLoadBinaryCode,
- generateBeforeInstantiateStreaming: generateBeforeStreaming,
- supportsStreaming: true
- })
- );
- });
- compilation.hooks.runtimeRequirementInTree
- .for(RuntimeGlobals.compileWasm)
- .tap(PLUGIN_NAME, (chunk, set, { chunkGraph }) => {
- if (!isEnabledForChunk(chunk)) return;
- if (
- !chunkGraph.hasModuleInGraph(
- chunk,
- (m) => m.type === WEBASSEMBLY_MODULE_TYPE_ASYNC
- )
- ) {
- return;
- }
- compilation.addRuntimeModule(
- chunk,
- new AsyncWasmCompileRuntimeModule({
- fullHashDigest: usesFullHashDigest(
- /** @type {string} */ (
- compilation.outputOptions.webassemblyModuleFilename
- )
- ),
- generateBeforeLoadBinaryCode,
- generateLoadBinaryCode,
- generateBeforeCompileStreaming: generateBeforeStreaming,
- supportsStreaming: true
- })
- );
- });
- });
- }
- }
- module.exports = UniversalCompileAsyncWasmPlugin;
|