From ffa75be48044255ed49a822a7a61a2a130123a4a Mon Sep 17 00:00:00 2001 From: Andreu Botella Date: Sat, 3 Jul 2021 23:33:36 +0200 Subject: feat: enable WebAssembly.instantiateStreaming and wasm async compilation (#11200) The WebAssembly streaming APIs used to be enabled, but used to take buffer sources as their first argument (see #6154 and #7259). This change re-enables them, requiring a Promise instead, as well as enabling asynchronous compilation of WebAssembly modules. --- cli/dts/lib.deno.shared_globals.d.ts | 24 +++++++++++ cli/tests/deno_dom_0.1.3-alpha2.wasm | Bin 0 -> 616631 bytes cli/tests/unit/wasm_test.ts | 80 +++++++++++++++++++++++++++++++++++ 3 files changed, 104 insertions(+) create mode 100644 cli/tests/deno_dom_0.1.3-alpha2.wasm create mode 100644 cli/tests/unit/wasm_test.ts (limited to 'cli') diff --git a/cli/dts/lib.deno.shared_globals.d.ts b/cli/dts/lib.deno.shared_globals.d.ts index be35fae01..849f9f835 100644 --- a/cli/dts/lib.deno.shared_globals.d.ts +++ b/cli/dts/lib.deno.shared_globals.d.ts @@ -224,6 +224,18 @@ declare namespace WebAssembly { */ export function compile(bytes: BufferSource): Promise; + /** + * The `WebAssembly.compileStreaming()` function compiles a `WebAssembly.Module` + * directly from a streamed underlying source. This function is useful if it is + * necessary to a compile a module before it can be instantiated (otherwise, the + * `WebAssembly.instantiateStreaming()` function should be used). + * + * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/compileStreaming) + */ + export function compileStreaming( + source: Response | Promise, + ): Promise; + /** * The WebAssembly.instantiate() function allows you to compile and instantiate * WebAssembly code. @@ -255,6 +267,18 @@ declare namespace WebAssembly { importObject?: Imports, ): Promise; + /** + * The `WebAssembly.instantiateStreaming()` function compiles and instantiates a + * WebAssembly module directly from a streamed underlying source. This is the most + * efficient, optimized way to load wasm code. + * + * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/instantiateStreaming) + */ + export function instantiateStreaming( + response: Response | PromiseLike, + importObject?: Imports, + ): Promise; + /** * The `WebAssembly.validate()` function validates a given typed array of * WebAssembly binary code, returning whether the bytes form a valid wasm diff --git a/cli/tests/deno_dom_0.1.3-alpha2.wasm b/cli/tests/deno_dom_0.1.3-alpha2.wasm new file mode 100644 index 000000000..6dd9d0e91 Binary files /dev/null and b/cli/tests/deno_dom_0.1.3-alpha2.wasm differ diff --git a/cli/tests/unit/wasm_test.ts b/cli/tests/unit/wasm_test.ts new file mode 100644 index 000000000..27391cbf2 --- /dev/null +++ b/cli/tests/unit/wasm_test.ts @@ -0,0 +1,80 @@ +import { + assert, + assertEquals, + assertThrowsAsync, + unitTest, +} from "./test_util.ts"; + +// The following blob can be created by taking the following s-expr and pass +// it through wat2wasm. +// (module +// (func $add (param $a i32) (param $b i32) (result i32) +// local.get $a +// local.get $b +// i32.add) +// (export "add" (func $add)) +// ) +// deno-fmt-ignore +const simpleWasm = new Uint8Array([ + 0x00, 0x61, 0x73, 0x6d, 0x01, 0x00, 0x00, 0x00, 0x01, 0x07, 0x01, 0x60, + 0x02, 0x7f, 0x7f, 0x01, 0x7f, 0x03, 0x02, 0x01, 0x00, 0x07, 0x07, 0x01, + 0x03, 0x61, 0x64, 0x64, 0x00, 0x00, 0x0a, 0x09, 0x01, 0x07, 0x00, 0x20, + 0x00, 0x20, 0x01, 0x6a, 0x0b +]); + +unitTest(async function wasmInstantiateWorksWithBuffer(): Promise { + const { module, instance } = await WebAssembly.instantiate(simpleWasm); + assertEquals(WebAssembly.Module.exports(module), [{ + name: "add", + kind: "function", + }]); + assertEquals(WebAssembly.Module.imports(module), []); + assert(typeof instance.exports.add === "function"); + const add = instance.exports.add as (a: number, b: number) => number; + assertEquals(add(1, 3), 4); +}); + +// V8's default implementation of `WebAssembly.instantiateStreaming()` if you +// don't set the WASM streaming callback, is to take a byte source. Here we +// check that our implementation of the callback disallows it. +unitTest( + async function wasmInstantiateStreamingFailsWithBuffer(): Promise { + await assertThrowsAsync(async () => { + await WebAssembly.instantiateStreaming( + // Bypassing the type system + simpleWasm as unknown as Promise, + ); + }, TypeError); + }, +); + +unitTest(async function wasmInstantiateStreaming(): Promise { + let isomorphic = ""; + for (const byte of simpleWasm) { + isomorphic += String.fromCharCode(byte); + } + const base64Url = "data:application/wasm;base64," + btoa(isomorphic); + + const { module, instance } = await WebAssembly.instantiateStreaming( + fetch(base64Url), + ); + assertEquals(WebAssembly.Module.exports(module), [{ + name: "add", + kind: "function", + }]); + assertEquals(WebAssembly.Module.imports(module), []); + assert(typeof instance.exports.add === "function"); + const add = instance.exports.add as (a: number, b: number) => number; + assertEquals(add(1, 3), 4); +}); + +unitTest( + { perms: { net: true } }, + async function wasmStreamingNonTrivial(): Promise { + // deno-dom's WASM file is a real-world non-trivial case that gave us + // trouble when implementing this. + await WebAssembly.instantiateStreaming(fetch( + "http://localhost:4545/cli/tests/deno_dom_0.1.3-alpha2.wasm", + )); + }, +); -- cgit v1.2.3