esm: --experimental-wasm-modules integration support #27659

guybedford · 2019-05-12T15:54:27Z

This PR provides support for node --experimental-modules --experimental-wasm-modules to support the ES module integration of WebAssembly modules through eg import './module.wasm'.

The semantics match the proposed ES module integration semantics for Web Assembly as specified in https://github.com/webassembly/esm-integration.

At the previous modules group meeting we got consensus approval for upstreaming this feature under the --experimental-wasm-modules flag.

//cc @nodejs/modules

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

nodejs-github-bot · 2019-05-12T15:54:30Z

Lite-CI: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/3491

littledan

Note that this is slightly different than the standards track semantics, as it doesn't take a turn on the event loop during Instantiation. However, I don't expect this to affect most programs. I would also encourage you to write several more tests before landing.

littledan · 2019-05-12T16:00:51Z

lib/internal/modules/esm/translators.js

+  const exports = WebAssembly.Module.exports(compiled).map(({ name }) => name);
+
+  return createDynamicModule(imports, exports, url, (reflect) => {
+    const { exports } = new WebAssembly.Instance(compiled, reflect.imports);


In a cycle-closing edge, will reflect.imports usually be an empty object? If so, this will be basically the right semantics.

On the unexecuted cycle edge, reflect.imports would contain all the imported module namespaces, with their named exports, but all of those named exports would be undefined. Function exports would be supported in cycles here though just like ES modules.

Actually cycles would throw for any accesses to uninitialized let bindings on the namespaces, since these would be in TDZ.

To summarize:

Unexecuted cycle edge with function exports: fine - function is defined

Unexecuted cycle edge with let binding: throws - TDZ error

And specifically these errors are only thrown if the WASM module actually attempts to access the given binding.

Right, so in particular, Wasm exports should always act like const bindings, and all imports are accessed during Instantiate (in the ESM evaluate phase). Does this implementation do that?

yep! reflect.imports is namespace objects so the imports are accessed directly.

devsnek

please upload a wat source for simple.wasm with a comment in the top with the command used to produce simple.wasm

example: https://github.com/nodejs/node/blob/master/test/fixtures/shared-memory.wat

test/es-module/test-esm-wasm.mjs

ljharb

How might one have an entry point that's directly in wasm, without the need for an ESM wrapper?
how might one consume wasm modules in CJS?

devsnek · 2019-05-12T17:47:52Z

@ljharb

How might one have an entry point that's directly in wasm, without the need for an ESM wrapper?

declare a wasm start function in your wasm module

this reminds me, @guybedford can you make a test which verifies that start functions run at the correct time?

how might one consume wasm modules in CJS?

at the moment, import()

ljharb · 2019-05-12T17:56:19Z

@devsnek so node somethingWithStart.wasm will work?

I'll rephrase the question - how might one synchronously consume wasm modules in cjs?

devsnek · 2019-05-12T17:58:51Z

@ljharb

so node somethingWithStart.wasm will work?

yes

how might one synchronously consume wasm modules in cjs

not possible atm. if require(esm) happens that would work i guess.

doc/api/esm.md

src/node_options.cc

test/fixtures/es-modules/simple.wat

devsnek

actually... can you add a test that verifies that the wasm start function runs during the evaluate phase? in wat, you can specify it with (start $funcname)

guybedford · 2019-05-12T22:25:38Z

Sure, I've added a start function test.

MylesBorins

LGTM

Trott · 2019-05-13T22:10:05Z

doc/api/esm.md

-CommonJS loader. Additional formats such as _"wasm"_ or _"addon"_ can be
-extended in future updates.
+CommonJS loader. Additional formats such as _"addon"_ can be extended in future
+updates.


There's one additional mention of the non-existent --entry-type CLI flag 7 lines below this one. Is this the right PR to remove or update that material?

xtuc

Nice work @guybedford!

doc/api/esm.md

nodejs-github-bot · 2019-05-16T23:49:00Z

CI: https://ci.nodejs.org/job/node-test-pull-request/23154/

guybedford · 2019-05-17T00:25:51Z

Landed in bbc254d.

PR-URL: #27659 Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Myles Borins <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>

Notable changes: * esm: * Added the `--experimental-wasm-modules` flag to support WebAssembly modules (Myles Borins & Guy Bedford) #27659 * process: * Log errors using `util.inspect` in case of fatal exceptions (Ruben Bridgewater) #27243 * repl: * Add `process.on('uncaughtException')` support (Ruben Bridgewater) #27151 * stream: * Implemented `Readable.from` async iterator utility (Guy Bedford) #27660 * tls: * Expose built-in root certificates (Ben Noordhuis) #26415 * Support `net.Server` options (Luigi Pinca) #27665 * Expose `keylog` event on TLSSocket (Alba Mendez) #27654 * worker: * Added the ability to unshift messages from the `MessagePort` (Anna Henningsen) #27294 PR-URL: #27799

vitaly-t · 2019-05-22T15:45:34Z

Ahem, very interesting! 😄

Any guidelines or examples on how to start playing with it in Node.js?

florisdh · 2019-05-31T11:58:42Z

I've created an example project using '--experimental-wasm-modules' for those who're interested.

https://github.com/florisdh/node-wasm

PR-URL: #27948 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Guy Bedford <[email protected]> Reviewed-By: Shingo Inoue <[email protected]> Reviewed-By: James M Snell <[email protected]>

nodejs-github-bot added the lib / src Issues and PRs related to general changes in the lib or src directory. label May 12, 2019

guybedford mentioned this pull request May 12, 2019

esm: experimental wasm modules nodejs/ecmascript-modules#46

Closed

littledan approved these changes May 12, 2019

View reviewed changes

devsnek suggested changes May 12, 2019

View reviewed changes

devsnek reviewed May 12, 2019

View reviewed changes

test/es-module/test-esm-wasm.mjs Outdated Show resolved Hide resolved

ljharb reviewed May 12, 2019

View reviewed changes

guybedford requested a review from devsnek May 12, 2019 20:57

targos approved these changes May 12, 2019

View reviewed changes

doc/api/esm.md Outdated Show resolved Hide resolved

src/node_options.cc Show resolved Hide resolved

devsnek reviewed May 12, 2019

View reviewed changes

test/fixtures/es-modules/simple.wat Show resolved Hide resolved

devsnek approved these changes May 12, 2019

View reviewed changes

devsnek suggested changes May 12, 2019

View reviewed changes

guybedford requested a review from devsnek May 12, 2019 22:25

devsnek approved these changes May 12, 2019

View reviewed changes

MylesBorins approved these changes May 13, 2019

View reviewed changes

Trott reviewed May 13, 2019

View reviewed changes

xtuc approved these changes May 14, 2019

View reviewed changes

xtuc reviewed May 14, 2019

View reviewed changes

doc/api/esm.md Outdated Show resolved Hide resolved

RReverser reviewed May 14, 2019

View reviewed changes

doc/api/esm.md Outdated Show resolved Hide resolved

benjamingr approved these changes May 14, 2019

View reviewed changes

esm: --experimental-wasm-modules integration support

acbf59a

guybedford force-pushed the wasm-modules branch from 0353cbc to acbf59a Compare May 16, 2019 23:47

guybedford closed this May 17, 2019

BridgeAR mentioned this pull request May 21, 2019

v12.3.0 proposal #27799

Merged

4 tasks

targos added the semver-minor PRs that contain new features and should be released in the next minor version. label May 21, 2019

BethGriggs added the dont-land-on-v10.x label Aug 20, 2019

MylesBorins mentioned this pull request Jan 6, 2021

wasm modules jstime/jstime#84

Open

hi-ogawa mentioned this pull request Feb 7, 2024

feat(vm): support wasm module vitest-dev/vitest#5131

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

esm: --experimental-wasm-modules integration support #27659

esm: --experimental-wasm-modules integration support #27659

guybedford commented May 12, 2019

nodejs-github-bot commented May 12, 2019

littledan left a comment

littledan May 12, 2019

guybedford May 12, 2019

guybedford May 12, 2019

guybedford May 12, 2019

guybedford May 12, 2019

littledan May 12, 2019

devsnek May 12, 2019

devsnek left a comment •

edited

Loading

ljharb left a comment

devsnek commented May 12, 2019 •

edited

Loading

ljharb commented May 12, 2019

devsnek commented May 12, 2019

devsnek left a comment •

edited

Loading

guybedford commented May 12, 2019

MylesBorins left a comment

Trott May 13, 2019

xtuc left a comment

nodejs-github-bot commented May 16, 2019

guybedford commented May 17, 2019

vitaly-t commented May 22, 2019 •

edited

Loading

florisdh commented May 31, 2019

esm: --experimental-wasm-modules integration support #27659

esm: --experimental-wasm-modules integration support #27659

Conversation

guybedford commented May 12, 2019

Checklist

nodejs-github-bot commented May 12, 2019

littledan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

devsnek left a comment • edited Loading

Choose a reason for hiding this comment

ljharb left a comment

Choose a reason for hiding this comment

devsnek commented May 12, 2019 • edited Loading

ljharb commented May 12, 2019

devsnek commented May 12, 2019

devsnek left a comment • edited Loading

Choose a reason for hiding this comment

guybedford commented May 12, 2019

MylesBorins left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xtuc left a comment

Choose a reason for hiding this comment

nodejs-github-bot commented May 16, 2019

guybedford commented May 17, 2019

vitaly-t commented May 22, 2019 • edited Loading

florisdh commented May 31, 2019

devsnek left a comment •

edited

Loading

devsnek commented May 12, 2019 •

edited

Loading

devsnek left a comment •

edited

Loading

vitaly-t commented May 22, 2019 •

edited

Loading