Skip to content

esm: Source Phase Imports for WebAssembly #56919

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 8 commits into from

Conversation

guybedford
Copy link
Contributor

@guybedford guybedford commented Feb 5, 2025

This implements the Stage 3 Source Phase Imports proposal for Node.js (with latest specification at tc39/ecma262#3492), based on the new V8 parser and module loading APIs for this feature.

Phases in the module pipeline represent the ability to load uninstantiated modules (and in future with import defer, unexecuted modules as well).

While we are still waiting for progression on https://github.com/tc39/proposal-esm-phase-imports for JS Source Phase objects, this implements only the WebAssembly source phase per the Wasm ESM Integration Phase 3 proposal (https://github.com/webassembly/esm-integration).

This PR adds support both for dynamic and static source phase syntax:

import source mod1 from './mod.wasm';
const mod2 = await import.source('./mod.wasm');

This allows obtaining a Wasm module through the ESM integration, without it being instantiated through the Node.js resolver, to permit custom instantiations:

import source mod from './mod.wasm';

const instance = await WebAssembly.instantiate(mod, imports);

The dynamic source phase support is a one-line TODO, which is pending #56842. When this lands the skipped tests have been tested against that branch to fully pass.

When a source phase representation for a module is not available, a new ERR_SOURCE_PHASE_NOT_DEFINED SyntaxError is thrown as per the standard.

The VM API is updated to take a string phase argument as its last argument, although the ability to define source phase representations for virtual modules is not currently supported, and left as a future integration point. Perhaps this will simplify with ESM Phase Imports in future as well allowing handles to modules outside of the VM graph.

Resolves #53178.

@nodejs/loaders

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/loaders
  • @nodejs/startup
  • @nodejs/vm

@nodejs-github-bot nodejs-github-bot added lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels Feb 5, 2025
@guybedford guybedford force-pushed the source-phase-imports branch 2 times, most recently from c485531 to 8b3ce05 Compare February 5, 2025 02:31
@guybedford guybedford changed the title esm: Support Source Phase Imports for WebAssembly esm: Source Phase Imports for WebAssembly Feb 5, 2025
Copy link

codecov bot commented Feb 5, 2025

Codecov Report

Attention: Patch coverage is 83.85965% with 46 lines in your changes missing coverage. Please review.

Project coverage is 90.24%. Comparing base (1a6bef2) to head (f18b561).
Report is 10 commits behind head on main.

Files with missing lines Patch % Lines
src/module_wrap.cc 59.52% 23 Missing and 11 partials ⚠️
lib/internal/modules/esm/loader.js 87.50% 3 Missing and 1 partial ⚠️
lib/internal/modules/esm/module_job.js 95.45% 4 Missing ⚠️
lib/internal/vm/module.js 85.71% 3 Missing ⚠️
lib/repl.js 75.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #56919      +/-   ##
==========================================
- Coverage   90.26%   90.24%   -0.03%     
==========================================
  Files         630      630              
  Lines      184690   184891     +201     
  Branches    36142    36173      +31     
==========================================
+ Hits       166712   166854     +142     
- Misses      11021    11064      +43     
- Partials     6957     6973      +16     
Files with missing lines Coverage Δ
lib/internal/modules/cjs/loader.js 98.26% <100.00%> (ø)
lib/internal/modules/esm/translators.js 91.51% <100.00%> (+0.06%) ⬆️
lib/internal/modules/esm/utils.js 98.91% <100.00%> (+0.01%) ⬆️
lib/internal/modules/run_main.js 97.60% <100.00%> (ø)
lib/internal/process/execution.js 94.79% <100.00%> (-0.16%) ⬇️
lib/internal/vm.js 100.00% <100.00%> (ø)
src/module_wrap.h 0.00% <ø> (ø)
src/node.cc 74.06% <100.00%> (+0.10%) ⬆️
src/node_errors.h 87.50% <100.00%> (+2.20%) ⬆️
lib/repl.js 94.90% <75.00%> (-0.05%) ⬇️
... and 4 more

... and 25 files with indirect coverage changes

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@mcollina mcollina added the request-ci Add this label to start a Jenkins CI on a PR. label Feb 5, 2025
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Feb 5, 2025
@nodejs-github-bot
Copy link
Collaborator

@marco-ippolito marco-ippolito added esm Issues and PRs related to the ECMAScript Modules implementation. wasm Issues and PRs related to WebAssembly. labels Feb 5, 2025
@targos targos added dont-land-on-v18.x PRs that should not land on the v18.x-staging branch and should not be released in v18.x. dont-land-on-v20.x PRs that should not land on the v20.x-staging branch and should not be released in v20.x. dont-land-on-v22.x PRs that should not land on the v22.x-staging branch and should not be released in v22.x. dont-land-on-v23.x PRs that should not land on the v23.x-staging branch and should not be released in v23.x. semver-minor PRs that contain new features and should be released in the next minor version. labels Feb 5, 2025
@legendecas legendecas linked an issue Feb 5, 2025 that may be closed by this pull request
@sbc100
Copy link

sbc100 commented Feb 19, 2025

I'm working on corresponding patch to emscripten to enable source phase imports: emscripten-core/emscripten#23175

As such, I would love to see this patch landed so we can start testing it!

@nodejs-github-bot

This comment was marked as outdated.

@nodejs-github-bot
Copy link
Collaborator

@nodejs-github-bot
Copy link
Collaborator

guybedford added a commit that referenced this pull request Feb 28, 2025
PR-URL: #56919
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Stephen Belanger <[email protected]>
@guybedford
Copy link
Contributor Author

Landed in db4dcc0.

@guybedford guybedford closed this Feb 28, 2025
@guybedford guybedford deleted the source-phase-imports branch February 28, 2025 20:02
sbc100 added a commit to sbc100/emscripten that referenced this pull request Mar 3, 2025
Now that node support has been landed we can test this, at least
against the latest node canary builds.

See nodejs/node#56919

Fixes: emscripten-core#23047
sbc100 added a commit to sbc100/emscripten that referenced this pull request Mar 3, 2025
Now that node support has been landed we can test this, at least
against the latest node canary builds.

See nodejs/node#56919

Fixes: emscripten-core#23047
sbc100 added a commit to sbc100/emscripten that referenced this pull request Mar 4, 2025
Now that node support has been landed we can test this, at least
against the latest node canary builds.

See nodejs/node#56919

Fixes: emscripten-core#23047
sbc100 added a commit to sbc100/emscripten that referenced this pull request Mar 4, 2025
Now that node support has been landed we can test this, at least
against the latest node canary builds.

See nodejs/node#56919

Fixes: emscripten-core#23047
sbc100 added a commit to emscripten-core/emscripten that referenced this pull request Mar 4, 2025
Now that node support has been landed we can test this, at least
against the latest node canary builds.
    
See nodejs/node#56919
    
Fixes: #23047
RafaelGSS pushed a commit that referenced this pull request Apr 1, 2025
PR-URL: #56919
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Stephen Belanger <[email protected]>
RafaelGSS pushed a commit that referenced this pull request Apr 1, 2025
PR-URL: #56919
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Stephen Belanger <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dont-land-on-v18.x PRs that should not land on the v18.x-staging branch and should not be released in v18.x. dont-land-on-v20.x PRs that should not land on the v20.x-staging branch and should not be released in v20.x. dont-land-on-v22.x PRs that should not land on the v22.x-staging branch and should not be released in v22.x. dont-land-on-v23.x PRs that should not land on the v23.x-staging branch and should not be released in v23.x. esm Issues and PRs related to the ECMAScript Modules implementation. lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. semver-minor PRs that contain new features and should be released in the next minor version. wasm Issues and PRs related to WebAssembly.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

WebAssembly source phase imports Tracking issue: latest ESM Integration support
10 participants