module: change return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback - #65375

Open
caiolima wants to merge 3 commits into
nodejs:mainfrom
caiolima:prepare-evaluation-steps
Open

module: change return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback#65375
caiolima wants to merge 3 commits into
nodejs:mainfrom
caiolima:prepare-evaluation-steps

Conversation

@caiolima

Copy link
Copy Markdown
Contributor

This PR doesn't change any behavior, and the motivation is to properly align with new V8 Synthetic Module API changes introduced by https://chromium-review.googlesource.com/c/v8/v8/+/8131138 and https://chromium-review.googlesource.com/c/v8/v8/+/8223168. The core of this change is to make clear on return type of SyntheticModuleEvaluationSteps that it should be a MaybeLocal<Promise> instead of MaybeLocal<Value>. The latter API will be removed soon from V8.

The PR is including the backport of both commits mentioned above and they are combined here to allow the change on Node side without causing compilation issues. Current code already always return a Promise, so the effective change is just the return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback.

Original commit message:
[api][module] Return a Promise from Module::Evaluate()
Module evaluation always produces a Promise, but the public API exposed
the result as MaybeLocal<Value>, and for synthetic modules it could even
hand back the raw, non-Promise value returned by the embedder's
evaluation steps. Embedders therefore had to defensively cast the
result, and the actual contract was invisible in the type system.
This CL makes the contract explicit:
- SyntheticModule::Evaluate() now returns the top-level capability
Promise instead of the raw value produced by the evaluation steps, so
the completion value is always a Promise, matching source text
modules and the documented behavior.
- SyntheticModule::Evaluate() nows CHECK if callback result from
EvaluationSteps is a Promise. The reasoning behind it is that
the behavior for an embedder that relies on non-promise result
was already inconsistent, given the first call would return the
result form callback (an arbitrary Local<Value>), but subsequent
calls for module->Evaluate() would return the capability with
`undefined` as result.
- Module::Evaluate() and their variant now returns
`MaybeDirectHandle<JSPromise>` to be more explicit by the return
type.
Bug: 531396274
Change-Id: Ifbfed4f849bb47d8db1e022bfb750d9ad2d6308b
Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/8131138
Reviewed-by: Camillo Bruni <cbruni@chromium.org>
Commit-Queue: Caio Lima <caiolima@igalia.com>
Reviewed-by: Olivier Flückiger <olivf@chromium.org>
Cr-Commit-Position: refs/heads/main@{#109010}
Refs: v8/v8@e778593
Co-authored-by: Caio Lima <caiolima@igalia.com>
Original commit message:
[api][module] Type-check synthetic module evaluation steps
Synthetic module evaluation steps are required to return a Promise,
which becomes the module's top-level capability. Their signature
returned a MaybeLocal<Value> though, so that requirement was only
enforced by a CHECK in SyntheticModule::Evaluate().
SyntheticModuleEvaluationSteps now returns a MaybeLocal<Promise>, with a
matching CreateSyntheticModule() overload. The old signature remains
available as LegacySyntheticModuleEvaluationSteps so that embedders can
be migrated in a separate CL; it will be
deprecated and then removed once embedders migrate.
d8 and the existing tests move to the Promise-returning version,
with one cctest checking the legacy version.
Bug: 545375591
Change-Id: Id55db730678455f81394bf8a68f66f93d22f5547
Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/8223168
Reviewed-by: Olivier Flückiger <olivf@chromium.org>
Reviewed-by: Igor Sheludko <ishell@chromium.org>
Commit-Queue: Caio Lima <caiolima@igalia.com>
Cr-Commit-Position: refs/heads/main@{#109273}
Refs: v8/v8@970d651
Co-authored-by: Caio Lima <caiolima@igalia.com>
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/gyp
  • @nodejs/loaders
  • @nodejs/security-wg
  • @nodejs/v8-update
  • @nodejs/vm

@nodejs-github-botnodejs-github-bot added lib / src Issues and PRs involving general changes in the lib/ or src/ directories. needs-ci PRs that need a full CI run. labels Aug 18, 2026
V8_DEPRECATE_SOON(
"Use the CreateSyntheticModule overload whose evaluation_steps return a "
"MaybeLocal<Promise>")
static Local<Module> CreateSyntheticModule(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This becomes dead-code here once we migrate ModuleWrap::SyntheticModuleEvaluationStepsCallback to return MaybeLocal<Promise>. I'm keeping it here just to have minimal difference from original V8 commit.

}

START_ALLOW_USE_DEPRECATED()
Local<Module> Module::CreateSyntheticModule(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

ditto about dead-code.

@codecov

codecovBot commented Aug 18, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 50.00000% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.12%. Comparing base (3781ebc) to head (579df3c).
⚠️ Report is 22 commits behind head on main.

Files with missing linesPatch %Lines
src/module_wrap.cc50.00%2 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #65375 +/- ##
=======================================
Coverage 90.11% 90.12% =======================================
Files 752 752 Lines 251820 251861 +41 Branches 47351 47363 +12 =======================================
+ Hits 226923 226982 +59 - Misses 16223 16226 +3 + Partials 8674 8653 -21 
Files with missing linesCoverage Δ
src/module_wrap.h52.94% <ø> (ø)
src/module_wrap.cc74.21% <50.00%> (ø)

... and 47 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@caiolima

Copy link
Copy Markdown
ContributorAuthor

As a reference, this is the change on Blink without the need of backports: https://chromium-review.googlesource.com/c/chromium/src/+/8257345

* If IsGraphAsync() is false, the returned Promise is settled.
*/
V8_WARN_UNUSED_RESULT MaybeLocal<Value> Evaluate(Local<Context> context);
V8_WARN_UNUSED_RESULT MaybeLocal<Promise> Evaluate(Local<Context> context);

@joyeecheungjoyeecheungAug 18, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This would break the ABI - I think if we want to backport to 22-26, this would need to be a duplicate method with a different name. Otherwise this needs to be dont-land-on-v26.x etc. and mostly just expediting things a bit more over #65161

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I'm not planning to backport, given it doesn't change pretty much anything in practice. The goal here is to make sure that we will be able to remove the callback that returns MaybeLocal<Value> eventually.

@joyeecheungjoyeecheung added dont-land-on-v24.x PRs that should not land on the v24.x-staging branch and should not be released in v24.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-v26.x PRs that should not land on the v26.x-staging branch and should not be released in v26.x. labels Aug 18, 2026
@joyeecheungjoyeecheung added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 18, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 18, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@joyeecheung

Copy link
Copy Markdown
Member

@caiolima Another commit has bumped the V8 embedder version, can you rebase and resolve the merge conflict?

@caiolima

Copy link
Copy Markdown
ContributorAuthor

@caiolima Another commit has bumped the V8 embedder version, can you rebase and resolve the merge conflict?

Sure. I'll do it. Thanks for the heads up.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dont-land-on-v22.xPRs that should not land on the v22.x-staging branch and should not be released in v22.x.dont-land-on-v24.xPRs that should not land on the v24.x-staging branch and should not be released in v24.x.dont-land-on-v26.xPRs that should not land on the v26.x-staging branch and should not be released in v26.x.lib / srcIssues and PRs involving general changes in the lib/ or src/ directories.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@caiolima@nodejs-github-bot@joyeecheung
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks"); } } catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); } })(); (function(){ try { var __m = "github.com"; var __re = new RegExp('^' + "github\\.com" + '
Skip to content

module: change return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback - #65375

Open
caiolima wants to merge 3 commits into
nodejs:mainfrom
caiolima:prepare-evaluation-steps
Open

module: change return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback#65375
caiolima wants to merge 3 commits into
nodejs:mainfrom
caiolima:prepare-evaluation-steps

Conversation

@caiolima

Copy link
Copy Markdown
Contributor

This PR doesn't change any behavior, and the motivation is to properly align with new V8 Synthetic Module API changes introduced by https://chromium-review.googlesource.com/c/v8/v8/+/8131138 and https://chromium-review.googlesource.com/c/v8/v8/+/8223168. The core of this change is to make clear on return type of SyntheticModuleEvaluationSteps that it should be a MaybeLocal<Promise> instead of MaybeLocal<Value>. The latter API will be removed soon from V8.

The PR is including the backport of both commits mentioned above and they are combined here to allow the change on Node side without causing compilation issues. Current code already always return a Promise, so the effective change is just the return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback.

Original commit message:
[api][module] Return a Promise from Module::Evaluate()
Module evaluation always produces a Promise, but the public API exposed
the result as MaybeLocal<Value>, and for synthetic modules it could even
hand back the raw, non-Promise value returned by the embedder's
evaluation steps. Embedders therefore had to defensively cast the
result, and the actual contract was invisible in the type system.
This CL makes the contract explicit:
- SyntheticModule::Evaluate() now returns the top-level capability
Promise instead of the raw value produced by the evaluation steps, so
the completion value is always a Promise, matching source text
modules and the documented behavior.
- SyntheticModule::Evaluate() nows CHECK if callback result from
EvaluationSteps is a Promise. The reasoning behind it is that
the behavior for an embedder that relies on non-promise result
was already inconsistent, given the first call would return the
result form callback (an arbitrary Local<Value>), but subsequent
calls for module->Evaluate() would return the capability with
`undefined` as result.
- Module::Evaluate() and their variant now returns
`MaybeDirectHandle<JSPromise>` to be more explicit by the return
type.
Bug: 531396274
Change-Id: Ifbfed4f849bb47d8db1e022bfb750d9ad2d6308b
Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/8131138
Reviewed-by: Camillo Bruni <cbruni@chromium.org>
Commit-Queue: Caio Lima <caiolima@igalia.com>
Reviewed-by: Olivier Flückiger <olivf@chromium.org>
Cr-Commit-Position: refs/heads/main@{#109010}
Refs: v8/v8@e778593
Co-authored-by: Caio Lima <caiolima@igalia.com>
Original commit message:
[api][module] Type-check synthetic module evaluation steps
Synthetic module evaluation steps are required to return a Promise,
which becomes the module's top-level capability. Their signature
returned a MaybeLocal<Value> though, so that requirement was only
enforced by a CHECK in SyntheticModule::Evaluate().
SyntheticModuleEvaluationSteps now returns a MaybeLocal<Promise>, with a
matching CreateSyntheticModule() overload. The old signature remains
available as LegacySyntheticModuleEvaluationSteps so that embedders can
be migrated in a separate CL; it will be
deprecated and then removed once embedders migrate.
d8 and the existing tests move to the Promise-returning version,
with one cctest checking the legacy version.
Bug: 545375591
Change-Id: Id55db730678455f81394bf8a68f66f93d22f5547
Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/8223168
Reviewed-by: Olivier Flückiger <olivf@chromium.org>
Reviewed-by: Igor Sheludko <ishell@chromium.org>
Commit-Queue: Caio Lima <caiolima@igalia.com>
Cr-Commit-Position: refs/heads/main@{#109273}
Refs: v8/v8@970d651
Co-authored-by: Caio Lima <caiolima@igalia.com>
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/gyp
  • @nodejs/loaders
  • @nodejs/security-wg
  • @nodejs/v8-update
  • @nodejs/vm

@nodejs-github-botnodejs-github-bot added lib / src Issues and PRs involving general changes in the lib/ or src/ directories. needs-ci PRs that need a full CI run. labels Aug 18, 2026
V8_DEPRECATE_SOON(
"Use the CreateSyntheticModule overload whose evaluation_steps return a "
"MaybeLocal<Promise>")
static Local<Module> CreateSyntheticModule(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This becomes dead-code here once we migrate ModuleWrap::SyntheticModuleEvaluationStepsCallback to return MaybeLocal<Promise>. I'm keeping it here just to have minimal difference from original V8 commit.

}

START_ALLOW_USE_DEPRECATED()
Local<Module> Module::CreateSyntheticModule(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

ditto about dead-code.

@codecov

codecovBot commented Aug 18, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 50.00000% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.12%. Comparing base (3781ebc) to head (579df3c).
⚠️ Report is 22 commits behind head on main.

Files with missing linesPatch %Lines
src/module_wrap.cc50.00%2 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #65375 +/- ##
=======================================
Coverage 90.11% 90.12% =======================================
Files 752 752 Lines 251820 251861 +41 Branches 47351 47363 +12 =======================================
+ Hits 226923 226982 +59 - Misses 16223 16226 +3 + Partials 8674 8653 -21 
Files with missing linesCoverage Δ
src/module_wrap.h52.94% <ø> (ø)
src/module_wrap.cc74.21% <50.00%> (ø)

... and 47 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@caiolima

Copy link
Copy Markdown
ContributorAuthor

As a reference, this is the change on Blink without the need of backports: https://chromium-review.googlesource.com/c/chromium/src/+/8257345

* If IsGraphAsync() is false, the returned Promise is settled.
*/
V8_WARN_UNUSED_RESULT MaybeLocal<Value> Evaluate(Local<Context> context);
V8_WARN_UNUSED_RESULT MaybeLocal<Promise> Evaluate(Local<Context> context);

@joyeecheungjoyeecheungAug 18, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This would break the ABI - I think if we want to backport to 22-26, this would need to be a duplicate method with a different name. Otherwise this needs to be dont-land-on-v26.x etc. and mostly just expediting things a bit more over #65161

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I'm not planning to backport, given it doesn't change pretty much anything in practice. The goal here is to make sure that we will be able to remove the callback that returns MaybeLocal<Value> eventually.

@joyeecheungjoyeecheung added dont-land-on-v24.x PRs that should not land on the v24.x-staging branch and should not be released in v24.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-v26.x PRs that should not land on the v26.x-staging branch and should not be released in v26.x. labels Aug 18, 2026
@joyeecheungjoyeecheung added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 18, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 18, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@joyeecheung

Copy link
Copy Markdown
Member

@caiolima Another commit has bumped the V8 embedder version, can you rebase and resolve the merge conflict?

@caiolima

Copy link
Copy Markdown
ContributorAuthor

@caiolima Another commit has bumped the V8 embedder version, can you rebase and resolve the merge conflict?

Sure. I'll do it. Thanks for the heads up.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dont-land-on-v22.xPRs that should not land on the v22.x-staging branch and should not be released in v22.x.dont-land-on-v24.xPRs that should not land on the v24.x-staging branch and should not be released in v24.x.dont-land-on-v26.xPRs that should not land on the v26.x-staging branch and should not be released in v26.x.lib / srcIssues and PRs involving general changes in the lib/ or src/ directories.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@caiolima@nodejs-github-bot@joyeecheung
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

module: change return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback - #65375

Open
caiolima wants to merge 3 commits into
nodejs:mainfrom
caiolima:prepare-evaluation-steps
Open

module: change return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback#65375
caiolima wants to merge 3 commits into
nodejs:mainfrom
caiolima:prepare-evaluation-steps

Conversation

@caiolima

Copy link
Copy Markdown
Contributor

This PR doesn't change any behavior, and the motivation is to properly align with new V8 Synthetic Module API changes introduced by https://chromium-review.googlesource.com/c/v8/v8/+/8131138 and https://chromium-review.googlesource.com/c/v8/v8/+/8223168. The core of this change is to make clear on return type of SyntheticModuleEvaluationSteps that it should be a MaybeLocal<Promise> instead of MaybeLocal<Value>. The latter API will be removed soon from V8.

The PR is including the backport of both commits mentioned above and they are combined here to allow the change on Node side without causing compilation issues. Current code already always return a Promise, so the effective change is just the return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback.

Original commit message:
[api][module] Return a Promise from Module::Evaluate()
Module evaluation always produces a Promise, but the public API exposed
the result as MaybeLocal<Value>, and for synthetic modules it could even
hand back the raw, non-Promise value returned by the embedder's
evaluation steps. Embedders therefore had to defensively cast the
result, and the actual contract was invisible in the type system.
This CL makes the contract explicit:
- SyntheticModule::Evaluate() now returns the top-level capability
Promise instead of the raw value produced by the evaluation steps, so
the completion value is always a Promise, matching source text
modules and the documented behavior.
- SyntheticModule::Evaluate() nows CHECK if callback result from
EvaluationSteps is a Promise. The reasoning behind it is that
the behavior for an embedder that relies on non-promise result
was already inconsistent, given the first call would return the
result form callback (an arbitrary Local<Value>), but subsequent
calls for module->Evaluate() would return the capability with
`undefined` as result.
- Module::Evaluate() and their variant now returns
`MaybeDirectHandle<JSPromise>` to be more explicit by the return
type.
Bug: 531396274
Change-Id: Ifbfed4f849bb47d8db1e022bfb750d9ad2d6308b
Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/8131138
Reviewed-by: Camillo Bruni <cbruni@chromium.org>
Commit-Queue: Caio Lima <caiolima@igalia.com>
Reviewed-by: Olivier Flückiger <olivf@chromium.org>
Cr-Commit-Position: refs/heads/main@{#109010}
Refs: v8/v8@e778593
Co-authored-by: Caio Lima <caiolima@igalia.com>
Original commit message:
[api][module] Type-check synthetic module evaluation steps
Synthetic module evaluation steps are required to return a Promise,
which becomes the module's top-level capability. Their signature
returned a MaybeLocal<Value> though, so that requirement was only
enforced by a CHECK in SyntheticModule::Evaluate().
SyntheticModuleEvaluationSteps now returns a MaybeLocal<Promise>, with a
matching CreateSyntheticModule() overload. The old signature remains
available as LegacySyntheticModuleEvaluationSteps so that embedders can
be migrated in a separate CL; it will be
deprecated and then removed once embedders migrate.
d8 and the existing tests move to the Promise-returning version,
with one cctest checking the legacy version.
Bug: 545375591
Change-Id: Id55db730678455f81394bf8a68f66f93d22f5547
Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/8223168
Reviewed-by: Olivier Flückiger <olivf@chromium.org>
Reviewed-by: Igor Sheludko <ishell@chromium.org>
Commit-Queue: Caio Lima <caiolima@igalia.com>
Cr-Commit-Position: refs/heads/main@{#109273}
Refs: v8/v8@970d651
Co-authored-by: Caio Lima <caiolima@igalia.com>
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/gyp
  • @nodejs/loaders
  • @nodejs/security-wg
  • @nodejs/v8-update
  • @nodejs/vm

@nodejs-github-botnodejs-github-bot added lib / src Issues and PRs involving general changes in the lib/ or src/ directories. needs-ci PRs that need a full CI run. labels Aug 18, 2026
V8_DEPRECATE_SOON(
"Use the CreateSyntheticModule overload whose evaluation_steps return a "
"MaybeLocal<Promise>")
static Local<Module> CreateSyntheticModule(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This becomes dead-code here once we migrate ModuleWrap::SyntheticModuleEvaluationStepsCallback to return MaybeLocal<Promise>. I'm keeping it here just to have minimal difference from original V8 commit.

}

START_ALLOW_USE_DEPRECATED()
Local<Module> Module::CreateSyntheticModule(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

ditto about dead-code.

@codecov

codecovBot commented Aug 18, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 50.00000% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.12%. Comparing base (3781ebc) to head (579df3c).
⚠️ Report is 22 commits behind head on main.

Files with missing linesPatch %Lines
src/module_wrap.cc50.00%2 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #65375 +/- ##
=======================================
Coverage 90.11% 90.12% =======================================
Files 752 752 Lines 251820 251861 +41 Branches 47351 47363 +12 =======================================
+ Hits 226923 226982 +59 - Misses 16223 16226 +3 + Partials 8674 8653 -21 
Files with missing linesCoverage Δ
src/module_wrap.h52.94% <ø> (ø)
src/module_wrap.cc74.21% <50.00%> (ø)

... and 47 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@caiolima

Copy link
Copy Markdown
ContributorAuthor

As a reference, this is the change on Blink without the need of backports: https://chromium-review.googlesource.com/c/chromium/src/+/8257345

* If IsGraphAsync() is false, the returned Promise is settled.
*/
V8_WARN_UNUSED_RESULT MaybeLocal<Value> Evaluate(Local<Context> context);
V8_WARN_UNUSED_RESULT MaybeLocal<Promise> Evaluate(Local<Context> context);

@joyeecheungjoyeecheungAug 18, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This would break the ABI - I think if we want to backport to 22-26, this would need to be a duplicate method with a different name. Otherwise this needs to be dont-land-on-v26.x etc. and mostly just expediting things a bit more over #65161

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I'm not planning to backport, given it doesn't change pretty much anything in practice. The goal here is to make sure that we will be able to remove the callback that returns MaybeLocal<Value> eventually.

@joyeecheungjoyeecheung added dont-land-on-v24.x PRs that should not land on the v24.x-staging branch and should not be released in v24.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-v26.x PRs that should not land on the v26.x-staging branch and should not be released in v26.x. labels Aug 18, 2026
@joyeecheungjoyeecheung added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 18, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 18, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@joyeecheung

Copy link
Copy Markdown
Member

@caiolima Another commit has bumped the V8 embedder version, can you rebase and resolve the merge conflict?

@caiolima

Copy link
Copy Markdown
ContributorAuthor

@caiolima Another commit has bumped the V8 embedder version, can you rebase and resolve the merge conflict?

Sure. I'll do it. Thanks for the heads up.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dont-land-on-v22.xPRs that should not land on the v22.x-staging branch and should not be released in v22.x.dont-land-on-v24.xPRs that should not land on the v24.x-staging branch and should not be released in v24.x.dont-land-on-v26.xPRs that should not land on the v26.x-staging branch and should not be released in v26.x.lib / srcIssues and PRs involving general changes in the lib/ or src/ directories.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@caiolima@nodejs-github-bot@joyeecheung
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length \u003e 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

module: change return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback - #65375

Open
caiolima wants to merge 3 commits into
nodejs:mainfrom
caiolima:prepare-evaluation-steps
Open

module: change return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback#65375
caiolima wants to merge 3 commits into
nodejs:mainfrom
caiolima:prepare-evaluation-steps

Conversation

@caiolima

Copy link
Copy Markdown
Contributor

This PR doesn't change any behavior, and the motivation is to properly align with new V8 Synthetic Module API changes introduced by https://chromium-review.googlesource.com/c/v8/v8/+/8131138 and https://chromium-review.googlesource.com/c/v8/v8/+/8223168. The core of this change is to make clear on return type of SyntheticModuleEvaluationSteps that it should be a MaybeLocal<Promise> instead of MaybeLocal<Value>. The latter API will be removed soon from V8.

The PR is including the backport of both commits mentioned above and they are combined here to allow the change on Node side without causing compilation issues. Current code already always return a Promise, so the effective change is just the return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback.

Original commit message:
[api][module] Return a Promise from Module::Evaluate()
Module evaluation always produces a Promise, but the public API exposed
the result as MaybeLocal<Value>, and for synthetic modules it could even
hand back the raw, non-Promise value returned by the embedder's
evaluation steps. Embedders therefore had to defensively cast the
result, and the actual contract was invisible in the type system.
This CL makes the contract explicit:
- SyntheticModule::Evaluate() now returns the top-level capability
Promise instead of the raw value produced by the evaluation steps, so
the completion value is always a Promise, matching source text
modules and the documented behavior.
- SyntheticModule::Evaluate() nows CHECK if callback result from
EvaluationSteps is a Promise. The reasoning behind it is that
the behavior for an embedder that relies on non-promise result
was already inconsistent, given the first call would return the
result form callback (an arbitrary Local<Value>), but subsequent
calls for module->Evaluate() would return the capability with
`undefined` as result.
- Module::Evaluate() and their variant now returns
`MaybeDirectHandle<JSPromise>` to be more explicit by the return
type.
Bug: 531396274
Change-Id: Ifbfed4f849bb47d8db1e022bfb750d9ad2d6308b
Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/8131138
Reviewed-by: Camillo Bruni <cbruni@chromium.org>
Commit-Queue: Caio Lima <caiolima@igalia.com>
Reviewed-by: Olivier Flückiger <olivf@chromium.org>
Cr-Commit-Position: refs/heads/main@{#109010}
Refs: v8/v8@e778593
Co-authored-by: Caio Lima <caiolima@igalia.com>
Original commit message:
[api][module] Type-check synthetic module evaluation steps
Synthetic module evaluation steps are required to return a Promise,
which becomes the module's top-level capability. Their signature
returned a MaybeLocal<Value> though, so that requirement was only
enforced by a CHECK in SyntheticModule::Evaluate().
SyntheticModuleEvaluationSteps now returns a MaybeLocal<Promise>, with a
matching CreateSyntheticModule() overload. The old signature remains
available as LegacySyntheticModuleEvaluationSteps so that embedders can
be migrated in a separate CL; it will be
deprecated and then removed once embedders migrate.
d8 and the existing tests move to the Promise-returning version,
with one cctest checking the legacy version.
Bug: 545375591
Change-Id: Id55db730678455f81394bf8a68f66f93d22f5547
Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/8223168
Reviewed-by: Olivier Flückiger <olivf@chromium.org>
Reviewed-by: Igor Sheludko <ishell@chromium.org>
Commit-Queue: Caio Lima <caiolima@igalia.com>
Cr-Commit-Position: refs/heads/main@{#109273}
Refs: v8/v8@970d651
Co-authored-by: Caio Lima <caiolima@igalia.com>
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/gyp
  • @nodejs/loaders
  • @nodejs/security-wg
  • @nodejs/v8-update
  • @nodejs/vm

@nodejs-github-botnodejs-github-bot added lib / src Issues and PRs involving general changes in the lib/ or src/ directories. needs-ci PRs that need a full CI run. labels Aug 18, 2026
V8_DEPRECATE_SOON(
"Use the CreateSyntheticModule overload whose evaluation_steps return a "
"MaybeLocal<Promise>")
static Local<Module> CreateSyntheticModule(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This becomes dead-code here once we migrate ModuleWrap::SyntheticModuleEvaluationStepsCallback to return MaybeLocal<Promise>. I'm keeping it here just to have minimal difference from original V8 commit.

}

START_ALLOW_USE_DEPRECATED()
Local<Module> Module::CreateSyntheticModule(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

ditto about dead-code.

@codecov

codecovBot commented Aug 18, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 50.00000% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.12%. Comparing base (3781ebc) to head (579df3c).
⚠️ Report is 22 commits behind head on main.

Files with missing linesPatch %Lines
src/module_wrap.cc50.00%2 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #65375 +/- ##
=======================================
Coverage 90.11% 90.12% =======================================
Files 752 752 Lines 251820 251861 +41 Branches 47351 47363 +12 =======================================
+ Hits 226923 226982 +59 - Misses 16223 16226 +3 + Partials 8674 8653 -21 
Files with missing linesCoverage Δ
src/module_wrap.h52.94% <ø> (ø)
src/module_wrap.cc74.21% <50.00%> (ø)

... and 47 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@caiolima

Copy link
Copy Markdown
ContributorAuthor

As a reference, this is the change on Blink without the need of backports: https://chromium-review.googlesource.com/c/chromium/src/+/8257345

* If IsGraphAsync() is false, the returned Promise is settled.
*/
V8_WARN_UNUSED_RESULT MaybeLocal<Value> Evaluate(Local<Context> context);
V8_WARN_UNUSED_RESULT MaybeLocal<Promise> Evaluate(Local<Context> context);

@joyeecheungjoyeecheungAug 18, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This would break the ABI - I think if we want to backport to 22-26, this would need to be a duplicate method with a different name. Otherwise this needs to be dont-land-on-v26.x etc. and mostly just expediting things a bit more over #65161

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I'm not planning to backport, given it doesn't change pretty much anything in practice. The goal here is to make sure that we will be able to remove the callback that returns MaybeLocal<Value> eventually.

@joyeecheungjoyeecheung added dont-land-on-v24.x PRs that should not land on the v24.x-staging branch and should not be released in v24.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-v26.x PRs that should not land on the v26.x-staging branch and should not be released in v26.x. labels Aug 18, 2026
@joyeecheungjoyeecheung added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 18, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 18, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@joyeecheung

Copy link
Copy Markdown
Member

@caiolima Another commit has bumped the V8 embedder version, can you rebase and resolve the merge conflict?

@caiolima

Copy link
Copy Markdown
ContributorAuthor

@caiolima Another commit has bumped the V8 embedder version, can you rebase and resolve the merge conflict?

Sure. I'll do it. Thanks for the heads up.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dont-land-on-v22.xPRs that should not land on the v22.x-staging branch and should not be released in v22.x.dont-land-on-v24.xPRs that should not land on the v24.x-staging branch and should not be released in v24.x.dont-land-on-v26.xPRs that should not land on the v26.x-staging branch and should not be released in v26.x.lib / srcIssues and PRs involving general changes in the lib/ or src/ directories.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@caiolima@nodejs-github-bot@joyeecheung
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

module: change return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback - #65375

Open
caiolima wants to merge 3 commits into
nodejs:mainfrom
caiolima:prepare-evaluation-steps
Open

module: change return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback#65375
caiolima wants to merge 3 commits into
nodejs:mainfrom
caiolima:prepare-evaluation-steps

Conversation

@caiolima

Copy link
Copy Markdown
Contributor

This PR doesn't change any behavior, and the motivation is to properly align with new V8 Synthetic Module API changes introduced by https://chromium-review.googlesource.com/c/v8/v8/+/8131138 and https://chromium-review.googlesource.com/c/v8/v8/+/8223168. The core of this change is to make clear on return type of SyntheticModuleEvaluationSteps that it should be a MaybeLocal<Promise> instead of MaybeLocal<Value>. The latter API will be removed soon from V8.

The PR is including the backport of both commits mentioned above and they are combined here to allow the change on Node side without causing compilation issues. Current code already always return a Promise, so the effective change is just the return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback.

Original commit message:
[api][module] Return a Promise from Module::Evaluate()
Module evaluation always produces a Promise, but the public API exposed
the result as MaybeLocal<Value>, and for synthetic modules it could even
hand back the raw, non-Promise value returned by the embedder's
evaluation steps. Embedders therefore had to defensively cast the
result, and the actual contract was invisible in the type system.
This CL makes the contract explicit:
- SyntheticModule::Evaluate() now returns the top-level capability
Promise instead of the raw value produced by the evaluation steps, so
the completion value is always a Promise, matching source text
modules and the documented behavior.
- SyntheticModule::Evaluate() nows CHECK if callback result from
EvaluationSteps is a Promise. The reasoning behind it is that
the behavior for an embedder that relies on non-promise result
was already inconsistent, given the first call would return the
result form callback (an arbitrary Local<Value>), but subsequent
calls for module->Evaluate() would return the capability with
`undefined` as result.
- Module::Evaluate() and their variant now returns
`MaybeDirectHandle<JSPromise>` to be more explicit by the return
type.
Bug: 531396274
Change-Id: Ifbfed4f849bb47d8db1e022bfb750d9ad2d6308b
Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/8131138
Reviewed-by: Camillo Bruni <cbruni@chromium.org>
Commit-Queue: Caio Lima <caiolima@igalia.com>
Reviewed-by: Olivier Flückiger <olivf@chromium.org>
Cr-Commit-Position: refs/heads/main@{#109010}
Refs: v8/v8@e778593
Co-authored-by: Caio Lima <caiolima@igalia.com>
Original commit message:
[api][module] Type-check synthetic module evaluation steps
Synthetic module evaluation steps are required to return a Promise,
which becomes the module's top-level capability. Their signature
returned a MaybeLocal<Value> though, so that requirement was only
enforced by a CHECK in SyntheticModule::Evaluate().
SyntheticModuleEvaluationSteps now returns a MaybeLocal<Promise>, with a
matching CreateSyntheticModule() overload. The old signature remains
available as LegacySyntheticModuleEvaluationSteps so that embedders can
be migrated in a separate CL; it will be
deprecated and then removed once embedders migrate.
d8 and the existing tests move to the Promise-returning version,
with one cctest checking the legacy version.
Bug: 545375591
Change-Id: Id55db730678455f81394bf8a68f66f93d22f5547
Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/8223168
Reviewed-by: Olivier Flückiger <olivf@chromium.org>
Reviewed-by: Igor Sheludko <ishell@chromium.org>
Commit-Queue: Caio Lima <caiolima@igalia.com>
Cr-Commit-Position: refs/heads/main@{#109273}
Refs: v8/v8@970d651
Co-authored-by: Caio Lima <caiolima@igalia.com>
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/gyp
  • @nodejs/loaders
  • @nodejs/security-wg
  • @nodejs/v8-update
  • @nodejs/vm

@nodejs-github-botnodejs-github-bot added lib / src Issues and PRs involving general changes in the lib/ or src/ directories. needs-ci PRs that need a full CI run. labels Aug 18, 2026
V8_DEPRECATE_SOON(
"Use the CreateSyntheticModule overload whose evaluation_steps return a "
"MaybeLocal<Promise>")
static Local<Module> CreateSyntheticModule(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This becomes dead-code here once we migrate ModuleWrap::SyntheticModuleEvaluationStepsCallback to return MaybeLocal<Promise>. I'm keeping it here just to have minimal difference from original V8 commit.

}

START_ALLOW_USE_DEPRECATED()
Local<Module> Module::CreateSyntheticModule(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

ditto about dead-code.

@codecov

codecovBot commented Aug 18, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 50.00000% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.12%. Comparing base (3781ebc) to head (579df3c).
⚠️ Report is 22 commits behind head on main.

Files with missing linesPatch %Lines
src/module_wrap.cc50.00%2 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #65375 +/- ##
=======================================
Coverage 90.11% 90.12% =======================================
Files 752 752 Lines 251820 251861 +41 Branches 47351 47363 +12 =======================================
+ Hits 226923 226982 +59 - Misses 16223 16226 +3 + Partials 8674 8653 -21 
Files with missing linesCoverage Δ
src/module_wrap.h52.94% <ø> (ø)
src/module_wrap.cc74.21% <50.00%> (ø)

... and 47 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@caiolima

Copy link
Copy Markdown
ContributorAuthor

As a reference, this is the change on Blink without the need of backports: https://chromium-review.googlesource.com/c/chromium/src/+/8257345

* If IsGraphAsync() is false, the returned Promise is settled.
*/
V8_WARN_UNUSED_RESULT MaybeLocal<Value> Evaluate(Local<Context> context);
V8_WARN_UNUSED_RESULT MaybeLocal<Promise> Evaluate(Local<Context> context);

@joyeecheungjoyeecheungAug 18, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This would break the ABI - I think if we want to backport to 22-26, this would need to be a duplicate method with a different name. Otherwise this needs to be dont-land-on-v26.x etc. and mostly just expediting things a bit more over #65161

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I'm not planning to backport, given it doesn't change pretty much anything in practice. The goal here is to make sure that we will be able to remove the callback that returns MaybeLocal<Value> eventually.

@joyeecheungjoyeecheung added dont-land-on-v24.x PRs that should not land on the v24.x-staging branch and should not be released in v24.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-v26.x PRs that should not land on the v26.x-staging branch and should not be released in v26.x. labels Aug 18, 2026
@joyeecheungjoyeecheung added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 18, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 18, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@joyeecheung

Copy link
Copy Markdown
Member

@caiolima Another commit has bumped the V8 embedder version, can you rebase and resolve the merge conflict?

@caiolima

Copy link
Copy Markdown
ContributorAuthor

@caiolima Another commit has bumped the V8 embedder version, can you rebase and resolve the merge conflict?

Sure. I'll do it. Thanks for the heads up.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dont-land-on-v22.xPRs that should not land on the v22.x-staging branch and should not be released in v22.x.dont-land-on-v24.xPRs that should not land on the v24.x-staging branch and should not be released in v24.x.dont-land-on-v26.xPRs that should not land on the v26.x-staging branch and should not be released in v26.x.lib / srcIssues and PRs involving general changes in the lib/ or src/ directories.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@caiolima@nodejs-github-bot@joyeecheung
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

module: change return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback - #65375

Open
caiolima wants to merge 3 commits into
nodejs:mainfrom
caiolima:prepare-evaluation-steps
Open

module: change return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback#65375
caiolima wants to merge 3 commits into
nodejs:mainfrom
caiolima:prepare-evaluation-steps

Conversation

@caiolima

Copy link
Copy Markdown
Contributor

This PR doesn't change any behavior, and the motivation is to properly align with new V8 Synthetic Module API changes introduced by https://chromium-review.googlesource.com/c/v8/v8/+/8131138 and https://chromium-review.googlesource.com/c/v8/v8/+/8223168. The core of this change is to make clear on return type of SyntheticModuleEvaluationSteps that it should be a MaybeLocal<Promise> instead of MaybeLocal<Value>. The latter API will be removed soon from V8.

The PR is including the backport of both commits mentioned above and they are combined here to allow the change on Node side without causing compilation issues. Current code already always return a Promise, so the effective change is just the return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback.

Original commit message:
[api][module] Return a Promise from Module::Evaluate()
Module evaluation always produces a Promise, but the public API exposed
the result as MaybeLocal<Value>, and for synthetic modules it could even
hand back the raw, non-Promise value returned by the embedder's
evaluation steps. Embedders therefore had to defensively cast the
result, and the actual contract was invisible in the type system.
This CL makes the contract explicit:
- SyntheticModule::Evaluate() now returns the top-level capability
Promise instead of the raw value produced by the evaluation steps, so
the completion value is always a Promise, matching source text
modules and the documented behavior.
- SyntheticModule::Evaluate() nows CHECK if callback result from
EvaluationSteps is a Promise. The reasoning behind it is that
the behavior for an embedder that relies on non-promise result
was already inconsistent, given the first call would return the
result form callback (an arbitrary Local<Value>), but subsequent
calls for module->Evaluate() would return the capability with
`undefined` as result.
- Module::Evaluate() and their variant now returns
`MaybeDirectHandle<JSPromise>` to be more explicit by the return
type.
Bug: 531396274
Change-Id: Ifbfed4f849bb47d8db1e022bfb750d9ad2d6308b
Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/8131138
Reviewed-by: Camillo Bruni <cbruni@chromium.org>
Commit-Queue: Caio Lima <caiolima@igalia.com>
Reviewed-by: Olivier Flückiger <olivf@chromium.org>
Cr-Commit-Position: refs/heads/main@{#109010}
Refs: v8/v8@e778593
Co-authored-by: Caio Lima <caiolima@igalia.com>
Original commit message:
[api][module] Type-check synthetic module evaluation steps
Synthetic module evaluation steps are required to return a Promise,
which becomes the module's top-level capability. Their signature
returned a MaybeLocal<Value> though, so that requirement was only
enforced by a CHECK in SyntheticModule::Evaluate().
SyntheticModuleEvaluationSteps now returns a MaybeLocal<Promise>, with a
matching CreateSyntheticModule() overload. The old signature remains
available as LegacySyntheticModuleEvaluationSteps so that embedders can
be migrated in a separate CL; it will be
deprecated and then removed once embedders migrate.
d8 and the existing tests move to the Promise-returning version,
with one cctest checking the legacy version.
Bug: 545375591
Change-Id: Id55db730678455f81394bf8a68f66f93d22f5547
Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/8223168
Reviewed-by: Olivier Flückiger <olivf@chromium.org>
Reviewed-by: Igor Sheludko <ishell@chromium.org>
Commit-Queue: Caio Lima <caiolima@igalia.com>
Cr-Commit-Position: refs/heads/main@{#109273}
Refs: v8/v8@970d651
Co-authored-by: Caio Lima <caiolima@igalia.com>
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/gyp
  • @nodejs/loaders
  • @nodejs/security-wg
  • @nodejs/v8-update
  • @nodejs/vm

@nodejs-github-botnodejs-github-bot added lib / src Issues and PRs involving general changes in the lib/ or src/ directories. needs-ci PRs that need a full CI run. labels Aug 18, 2026
V8_DEPRECATE_SOON(
"Use the CreateSyntheticModule overload whose evaluation_steps return a "
"MaybeLocal<Promise>")
static Local<Module> CreateSyntheticModule(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This becomes dead-code here once we migrate ModuleWrap::SyntheticModuleEvaluationStepsCallback to return MaybeLocal<Promise>. I'm keeping it here just to have minimal difference from original V8 commit.

}

START_ALLOW_USE_DEPRECATED()
Local<Module> Module::CreateSyntheticModule(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

ditto about dead-code.

@codecov

codecovBot commented Aug 18, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 50.00000% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.12%. Comparing base (3781ebc) to head (579df3c).
⚠️ Report is 22 commits behind head on main.

Files with missing linesPatch %Lines
src/module_wrap.cc50.00%2 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #65375 +/- ##
=======================================
Coverage 90.11% 90.12% =======================================
Files 752 752 Lines 251820 251861 +41 Branches 47351 47363 +12 =======================================
+ Hits 226923 226982 +59 - Misses 16223 16226 +3 + Partials 8674 8653 -21 
Files with missing linesCoverage Δ
src/module_wrap.h52.94% <ø> (ø)
src/module_wrap.cc74.21% <50.00%> (ø)

... and 47 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@caiolima

Copy link
Copy Markdown
ContributorAuthor

As a reference, this is the change on Blink without the need of backports: https://chromium-review.googlesource.com/c/chromium/src/+/8257345

* If IsGraphAsync() is false, the returned Promise is settled.
*/
V8_WARN_UNUSED_RESULT MaybeLocal<Value> Evaluate(Local<Context> context);
V8_WARN_UNUSED_RESULT MaybeLocal<Promise> Evaluate(Local<Context> context);

@joyeecheungjoyeecheungAug 18, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This would break the ABI - I think if we want to backport to 22-26, this would need to be a duplicate method with a different name. Otherwise this needs to be dont-land-on-v26.x etc. and mostly just expediting things a bit more over #65161

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I'm not planning to backport, given it doesn't change pretty much anything in practice. The goal here is to make sure that we will be able to remove the callback that returns MaybeLocal<Value> eventually.

@joyeecheungjoyeecheung added dont-land-on-v24.x PRs that should not land on the v24.x-staging branch and should not be released in v24.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-v26.x PRs that should not land on the v26.x-staging branch and should not be released in v26.x. labels Aug 18, 2026
@joyeecheungjoyeecheung added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 18, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 18, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@joyeecheung

Copy link
Copy Markdown
Member

@caiolima Another commit has bumped the V8 embedder version, can you rebase and resolve the merge conflict?

@caiolima

Copy link
Copy Markdown
ContributorAuthor

@caiolima Another commit has bumped the V8 embedder version, can you rebase and resolve the merge conflict?

Sure. I'll do it. Thanks for the heads up.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dont-land-on-v22.xPRs that should not land on the v22.x-staging branch and should not be released in v22.x.dont-land-on-v24.xPRs that should not land on the v24.x-staging branch and should not be released in v24.x.dont-land-on-v26.xPRs that should not land on the v26.x-staging branch and should not be released in v26.x.lib / srcIssues and PRs involving general changes in the lib/ or src/ directories.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@caiolima@nodejs-github-bot@joyeecheung
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

module: change return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback - #65375

Open
caiolima wants to merge 3 commits into
nodejs:mainfrom
caiolima:prepare-evaluation-steps
Open

module: change return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback#65375
caiolima wants to merge 3 commits into
nodejs:mainfrom
caiolima:prepare-evaluation-steps

Conversation

@caiolima

Copy link
Copy Markdown
Contributor

This PR doesn't change any behavior, and the motivation is to properly align with new V8 Synthetic Module API changes introduced by https://chromium-review.googlesource.com/c/v8/v8/+/8131138 and https://chromium-review.googlesource.com/c/v8/v8/+/8223168. The core of this change is to make clear on return type of SyntheticModuleEvaluationSteps that it should be a MaybeLocal<Promise> instead of MaybeLocal<Value>. The latter API will be removed soon from V8.

The PR is including the backport of both commits mentioned above and they are combined here to allow the change on Node side without causing compilation issues. Current code already always return a Promise, so the effective change is just the return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback.

Original commit message:
[api][module] Return a Promise from Module::Evaluate()
Module evaluation always produces a Promise, but the public API exposed
the result as MaybeLocal<Value>, and for synthetic modules it could even
hand back the raw, non-Promise value returned by the embedder's
evaluation steps. Embedders therefore had to defensively cast the
result, and the actual contract was invisible in the type system.
This CL makes the contract explicit:
- SyntheticModule::Evaluate() now returns the top-level capability
Promise instead of the raw value produced by the evaluation steps, so
the completion value is always a Promise, matching source text
modules and the documented behavior.
- SyntheticModule::Evaluate() nows CHECK if callback result from
EvaluationSteps is a Promise. The reasoning behind it is that
the behavior for an embedder that relies on non-promise result
was already inconsistent, given the first call would return the
result form callback (an arbitrary Local<Value>), but subsequent
calls for module->Evaluate() would return the capability with
`undefined` as result.
- Module::Evaluate() and their variant now returns
`MaybeDirectHandle<JSPromise>` to be more explicit by the return
type.
Bug: 531396274
Change-Id: Ifbfed4f849bb47d8db1e022bfb750d9ad2d6308b
Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/8131138
Reviewed-by: Camillo Bruni <cbruni@chromium.org>
Commit-Queue: Caio Lima <caiolima@igalia.com>
Reviewed-by: Olivier Flückiger <olivf@chromium.org>
Cr-Commit-Position: refs/heads/main@{#109010}
Refs: v8/v8@e778593
Co-authored-by: Caio Lima <caiolima@igalia.com>
Original commit message:
[api][module] Type-check synthetic module evaluation steps
Synthetic module evaluation steps are required to return a Promise,
which becomes the module's top-level capability. Their signature
returned a MaybeLocal<Value> though, so that requirement was only
enforced by a CHECK in SyntheticModule::Evaluate().
SyntheticModuleEvaluationSteps now returns a MaybeLocal<Promise>, with a
matching CreateSyntheticModule() overload. The old signature remains
available as LegacySyntheticModuleEvaluationSteps so that embedders can
be migrated in a separate CL; it will be
deprecated and then removed once embedders migrate.
d8 and the existing tests move to the Promise-returning version,
with one cctest checking the legacy version.
Bug: 545375591
Change-Id: Id55db730678455f81394bf8a68f66f93d22f5547
Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/8223168
Reviewed-by: Olivier Flückiger <olivf@chromium.org>
Reviewed-by: Igor Sheludko <ishell@chromium.org>
Commit-Queue: Caio Lima <caiolima@igalia.com>
Cr-Commit-Position: refs/heads/main@{#109273}
Refs: v8/v8@970d651
Co-authored-by: Caio Lima <caiolima@igalia.com>
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/gyp
  • @nodejs/loaders
  • @nodejs/security-wg
  • @nodejs/v8-update
  • @nodejs/vm

@nodejs-github-botnodejs-github-bot added lib / src Issues and PRs involving general changes in the lib/ or src/ directories. needs-ci PRs that need a full CI run. labels Aug 18, 2026
V8_DEPRECATE_SOON(
"Use the CreateSyntheticModule overload whose evaluation_steps return a "
"MaybeLocal<Promise>")
static Local<Module> CreateSyntheticModule(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This becomes dead-code here once we migrate ModuleWrap::SyntheticModuleEvaluationStepsCallback to return MaybeLocal<Promise>. I'm keeping it here just to have minimal difference from original V8 commit.

}

START_ALLOW_USE_DEPRECATED()
Local<Module> Module::CreateSyntheticModule(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

ditto about dead-code.

@codecov

codecovBot commented Aug 18, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 50.00000% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.12%. Comparing base (3781ebc) to head (579df3c).
⚠️ Report is 22 commits behind head on main.

Files with missing linesPatch %Lines
src/module_wrap.cc50.00%2 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #65375 +/- ##
=======================================
Coverage 90.11% 90.12% =======================================
Files 752 752 Lines 251820 251861 +41 Branches 47351 47363 +12 =======================================
+ Hits 226923 226982 +59 - Misses 16223 16226 +3 + Partials 8674 8653 -21 
Files with missing linesCoverage Δ
src/module_wrap.h52.94% <ø> (ø)
src/module_wrap.cc74.21% <50.00%> (ø)

... and 47 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@caiolima

Copy link
Copy Markdown
ContributorAuthor

As a reference, this is the change on Blink without the need of backports: https://chromium-review.googlesource.com/c/chromium/src/+/8257345

* If IsGraphAsync() is false, the returned Promise is settled.
*/
V8_WARN_UNUSED_RESULT MaybeLocal<Value> Evaluate(Local<Context> context);
V8_WARN_UNUSED_RESULT MaybeLocal<Promise> Evaluate(Local<Context> context);

@joyeecheungjoyeecheungAug 18, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This would break the ABI - I think if we want to backport to 22-26, this would need to be a duplicate method with a different name. Otherwise this needs to be dont-land-on-v26.x etc. and mostly just expediting things a bit more over #65161

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I'm not planning to backport, given it doesn't change pretty much anything in practice. The goal here is to make sure that we will be able to remove the callback that returns MaybeLocal<Value> eventually.

@joyeecheungjoyeecheung added dont-land-on-v24.x PRs that should not land on the v24.x-staging branch and should not be released in v24.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-v26.x PRs that should not land on the v26.x-staging branch and should not be released in v26.x. labels Aug 18, 2026
@joyeecheungjoyeecheung added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 18, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 18, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@joyeecheung

Copy link
Copy Markdown
Member

@caiolima Another commit has bumped the V8 embedder version, can you rebase and resolve the merge conflict?

@caiolima

Copy link
Copy Markdown
ContributorAuthor

@caiolima Another commit has bumped the V8 embedder version, can you rebase and resolve the merge conflict?

Sure. I'll do it. Thanks for the heads up.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dont-land-on-v22.xPRs that should not land on the v22.x-staging branch and should not be released in v22.x.dont-land-on-v24.xPRs that should not land on the v24.x-staging branch and should not be released in v24.x.dont-land-on-v26.xPRs that should not land on the v26.x-staging branch and should not be released in v26.x.lib / srcIssues and PRs involving general changes in the lib/ or src/ directories.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@caiolima@nodejs-github-bot@joyeecheung
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

module: change return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback - #65375

Open
caiolima wants to merge 3 commits into
nodejs:mainfrom
caiolima:prepare-evaluation-steps
Open

module: change return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback#65375
caiolima wants to merge 3 commits into
nodejs:mainfrom
caiolima:prepare-evaluation-steps

Conversation

@caiolima

Copy link
Copy Markdown
Contributor

This PR doesn't change any behavior, and the motivation is to properly align with new V8 Synthetic Module API changes introduced by https://chromium-review.googlesource.com/c/v8/v8/+/8131138 and https://chromium-review.googlesource.com/c/v8/v8/+/8223168. The core of this change is to make clear on return type of SyntheticModuleEvaluationSteps that it should be a MaybeLocal<Promise> instead of MaybeLocal<Value>. The latter API will be removed soon from V8.

The PR is including the backport of both commits mentioned above and they are combined here to allow the change on Node side without causing compilation issues. Current code already always return a Promise, so the effective change is just the return type for ModuleWrap::SyntheticModuleEvaluationStepsCallback.

Original commit message:
[api][module] Return a Promise from Module::Evaluate()
Module evaluation always produces a Promise, but the public API exposed
the result as MaybeLocal<Value>, and for synthetic modules it could even
hand back the raw, non-Promise value returned by the embedder's
evaluation steps. Embedders therefore had to defensively cast the
result, and the actual contract was invisible in the type system.
This CL makes the contract explicit:
- SyntheticModule::Evaluate() now returns the top-level capability
Promise instead of the raw value produced by the evaluation steps, so
the completion value is always a Promise, matching source text
modules and the documented behavior.
- SyntheticModule::Evaluate() nows CHECK if callback result from
EvaluationSteps is a Promise. The reasoning behind it is that
the behavior for an embedder that relies on non-promise result
was already inconsistent, given the first call would return the
result form callback (an arbitrary Local<Value>), but subsequent
calls for module->Evaluate() would return the capability with
`undefined` as result.
- Module::Evaluate() and their variant now returns
`MaybeDirectHandle<JSPromise>` to be more explicit by the return
type.
Bug: 531396274
Change-Id: Ifbfed4f849bb47d8db1e022bfb750d9ad2d6308b
Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/8131138
Reviewed-by: Camillo Bruni <cbruni@chromium.org>
Commit-Queue: Caio Lima <caiolima@igalia.com>
Reviewed-by: Olivier Flückiger <olivf@chromium.org>
Cr-Commit-Position: refs/heads/main@{#109010}
Refs: v8/v8@e778593
Co-authored-by: Caio Lima <caiolima@igalia.com>
Original commit message:
[api][module] Type-check synthetic module evaluation steps
Synthetic module evaluation steps are required to return a Promise,
which becomes the module's top-level capability. Their signature
returned a MaybeLocal<Value> though, so that requirement was only
enforced by a CHECK in SyntheticModule::Evaluate().
SyntheticModuleEvaluationSteps now returns a MaybeLocal<Promise>, with a
matching CreateSyntheticModule() overload. The old signature remains
available as LegacySyntheticModuleEvaluationSteps so that embedders can
be migrated in a separate CL; it will be
deprecated and then removed once embedders migrate.
d8 and the existing tests move to the Promise-returning version,
with one cctest checking the legacy version.
Bug: 545375591
Change-Id: Id55db730678455f81394bf8a68f66f93d22f5547
Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/8223168
Reviewed-by: Olivier Flückiger <olivf@chromium.org>
Reviewed-by: Igor Sheludko <ishell@chromium.org>
Commit-Queue: Caio Lima <caiolima@igalia.com>
Cr-Commit-Position: refs/heads/main@{#109273}
Refs: v8/v8@970d651
Co-authored-by: Caio Lima <caiolima@igalia.com>
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/gyp
  • @nodejs/loaders
  • @nodejs/security-wg
  • @nodejs/v8-update
  • @nodejs/vm

@nodejs-github-botnodejs-github-bot added lib / src Issues and PRs involving general changes in the lib/ or src/ directories. needs-ci PRs that need a full CI run. labels Aug 18, 2026
V8_DEPRECATE_SOON(
"Use the CreateSyntheticModule overload whose evaluation_steps return a "
"MaybeLocal<Promise>")
static Local<Module> CreateSyntheticModule(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This becomes dead-code here once we migrate ModuleWrap::SyntheticModuleEvaluationStepsCallback to return MaybeLocal<Promise>. I'm keeping it here just to have minimal difference from original V8 commit.

}

START_ALLOW_USE_DEPRECATED()
Local<Module> Module::CreateSyntheticModule(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

ditto about dead-code.

@codecov

codecovBot commented Aug 18, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 50.00000% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.12%. Comparing base (3781ebc) to head (579df3c).
⚠️ Report is 22 commits behind head on main.

Files with missing linesPatch %Lines
src/module_wrap.cc50.00%2 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #65375 +/- ##
=======================================
Coverage 90.11% 90.12% =======================================
Files 752 752 Lines 251820 251861 +41 Branches 47351 47363 +12 =======================================
+ Hits 226923 226982 +59 - Misses 16223 16226 +3 + Partials 8674 8653 -21 
Files with missing linesCoverage Δ
src/module_wrap.h52.94% <ø> (ø)
src/module_wrap.cc74.21% <50.00%> (ø)

... and 47 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@caiolima

Copy link
Copy Markdown
ContributorAuthor

As a reference, this is the change on Blink without the need of backports: https://chromium-review.googlesource.com/c/chromium/src/+/8257345

* If IsGraphAsync() is false, the returned Promise is settled.
*/
V8_WARN_UNUSED_RESULT MaybeLocal<Value> Evaluate(Local<Context> context);
V8_WARN_UNUSED_RESULT MaybeLocal<Promise> Evaluate(Local<Context> context);

@joyeecheungjoyeecheungAug 18, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This would break the ABI - I think if we want to backport to 22-26, this would need to be a duplicate method with a different name. Otherwise this needs to be dont-land-on-v26.x etc. and mostly just expediting things a bit more over #65161

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I'm not planning to backport, given it doesn't change pretty much anything in practice. The goal here is to make sure that we will be able to remove the callback that returns MaybeLocal<Value> eventually.

@joyeecheungjoyeecheung added dont-land-on-v24.x PRs that should not land on the v24.x-staging branch and should not be released in v24.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-v26.x PRs that should not land on the v26.x-staging branch and should not be released in v26.x. labels Aug 18, 2026
@joyeecheungjoyeecheung added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 18, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 18, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@joyeecheung

Copy link
Copy Markdown
Member

@caiolima Another commit has bumped the V8 embedder version, can you rebase and resolve the merge conflict?

@caiolima

Copy link
Copy Markdown
ContributorAuthor

@caiolima Another commit has bumped the V8 embedder version, can you rebase and resolve the merge conflict?

Sure. I'll do it. Thanks for the heads up.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dont-land-on-v22.xPRs that should not land on the v22.x-staging branch and should not be released in v22.x.dont-land-on-v24.xPRs that should not land on the v24.x-staging branch and should not be released in v24.x.dont-land-on-v26.xPRs that should not land on the v26.x-staging branch and should not be released in v26.x.lib / srcIssues and PRs involving general changes in the lib/ or src/ directories.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@caiolima@nodejs-github-bot@joyeecheung