src: introduce node::Realm #44179

legendecas · 2022-08-08T17:27:28Z

To distinguish per-context values from the node::Environment, split
those values to a new node::Realm structure and consolidate
bootstrapping methods with it.

This allows creating multiple realms in a node::Environment. There
can be two kinds of realms:

A principal realm, comes with a host/implementation-defined global
object,
A synthetic realm, is created by the ShadowRealm API and includes a
reduced set of global object properties.

When the changes in this PR are landed with assent, works on migrating
BaseObjects to be per-realm native objects and support built-in modules
in synthetics realms like ShadowRealm can be started.

Refs: #42528

nodejs-github-bot · 2022-08-08T17:27:32Z

Review requested:

@nodejs/gyp
@nodejs/startup

targos · 2022-08-08T18:32:28Z

@nodejs/cpp-reviewers

src/node_realm.h

jasnell · 2022-08-10T13:22:32Z

Initial read through is good. It would be helpful to have a better picture of what the additional coming changes will be. Specifically, how is this going to impact individual BaseObject and internal binding implementation

src/node_realm.cc

src/env-inl.h

src/node_realm.cc

src/env.cc

legendecas · 2022-08-10T16:50:02Z

Initial read through is good. It would be helpful to have a better picture of what the additional coming changes will be. Specifically, how is this going to impact individual BaseObject and internal binding implementation

@jasnell thank you for the suggestion. The overall design of the change can be reviewed at https://docs.google.com/document/d/12_CkX6KbM9kt_lj1pdEgLB8-HQaozkJb7_nwQnHfTTg/edit?usp=sharing. Please feel free to drop a comment there!

legendecas · 2022-08-14T16:58:52Z

Rebased with conflicts resolved and suggestions applied. Please take a look again :)

nodejs-github-bot · 2022-08-15T09:36:46Z

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

legendecas · 2022-08-19T06:01:21Z

@jasnell @joyeecheung would you mind taking a look again? Thank you!

Extract common context embedder tag checks to ContextEmbedderTag so that verifying if a context is a node context doesn't need to access private members of node::Environment. PR-URL: #44258 Refs: #44179 Refs: #44252 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Darshan Sen <raisinten@gmail.com>

src/env.cc

Extract common context embedder tag checks to ContextEmbedderTag so that verifying if a context is a node context doesn't need to access private members of node::Environment. PR-URL: #44258 Refs: #44179 Refs: #44252 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Darshan Sen <raisinten@gmail.com>

legendecas · 2022-09-07T17:12:06Z

Backport to v18.x depends on #44192

Extract common context embedder tag checks to ContextEmbedderTag so that verifying if a context is a node context doesn't need to access private members of node::Environment. PR-URL: nodejs#44258 Refs: nodejs#44179 Refs: nodejs#44252 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Darshan Sen <raisinten@gmail.com>

To distinguish per-context values from the node::Environment, split those values to a new node::Realm structure and consolidate bootstrapping methods with it. PR-URL: nodejs#44179 Refs: nodejs#42528 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

juanarbol · 2022-09-30T04:49:21Z

Backport to v18.x depends on #44192

Applies for v16.x as well.

Extract common context embedder tag checks to ContextEmbedderTag so that verifying if a context is a node context doesn't need to access private members of node::Environment. PR-URL: #44258 Refs: #44179 Refs: #44252 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Darshan Sen <raisinten@gmail.com>

To distinguish per-context values from the node::Environment, split those values to a new node::Realm structure and consolidate bootstrapping methods with it. PR-URL: nodejs#44179 Refs: nodejs#42528 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

To distinguish per-context values from the node::Environment, split those values to a new node::Realm structure and consolidate bootstrapping methods with it. PR-URL: #44179 Refs: #42528 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Extract common context embedder tag checks to ContextEmbedderTag so that verifying if a context is a node context doesn't need to access private members of node::Environment. PR-URL: nodejs/node#44258 Refs: nodejs/node#44179 Refs: nodejs/node#44252 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Darshan Sen <raisinten@gmail.com>

To distinguish per-context values from the node::Environment, split those values to a new node::Realm structure and consolidate bootstrapping methods with it. PR-URL: #44179 Refs: #42528 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

- nodejs/node#44179 - nodejs/node#44193

* chore: bump node in DEPS to v18.13.0 * child_process: validate arguments for null bytes nodejs/node#44782 * bootstrap: merge main thread and worker thread initializations nodejs/node#44869 * module: ensure relative requires work from deleted directories nodejs/node#42384 * src: add support for externally shared js builtins nodejs/node#44000 * lib: disambiguate `native module` to `binding` nodejs/node#45673 * test: convert test-debugger-pid to async/await nodejs/node#45179 * deps: upgrade to libuv 1.44.2 nodejs/node#42340 * src: fix cppgc incompatibility in v8 nodejs/node#43521 * src: use qualified `std::move` call in node_http2 nodejs/node#45555 * build: fix env.h for cpp20 nodejs/node#45516 * test: remove experimental-wasm-threads flag nodejs/node#45074 * src: iwyu in cleanup_queue.cc nodejs/node#44983 * src: add missing include for `std::all_of` nodejs/node#45541 * deps: update ICU to 72.1 nodejs/node#45068 * chore: fixup patch indices * chore: remove errant semicolons - nodejs/node#44179 - nodejs/node#44193 * src: add support for externally shared js builtins nodejs/node#44376 * chore: add missing GN filenames * deps: update nghttp2 to 1.51.0 nodejs/node#45537 * chore: disable more Node.js snapshot tests The Snapshot feature is currently disabled * chore: disable ICU timezone tests Node.js uses a different version of ICU than Electron so they will often be out of sync. * chore: disable threadpool event tracing test Event tracing is not enabled in embedded Node.js * chore: fixup patch indices * chore: comments from review Co-authored-by: electron-roller[bot] <84116207+electron-roller[bot]@users.noreply.github.com> Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>

To distinguish per-context values from the node::Environment, split those values to a new node::Realm structure and consolidate bootstrapping methods with it. PR-URL: nodejs#44179 Refs: nodejs#42528 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

* chore: bump node in DEPS to v18.13.0 * child_process: validate arguments for null bytes nodejs/node#44782 * bootstrap: merge main thread and worker thread initializations nodejs/node#44869 * module: ensure relative requires work from deleted directories nodejs/node#42384 * src: add support for externally shared js builtins nodejs/node#44000 * lib: disambiguate `native module` to `binding` nodejs/node#45673 * test: convert test-debugger-pid to async/await nodejs/node#45179 * deps: upgrade to libuv 1.44.2 nodejs/node#42340 * src: fix cppgc incompatibility in v8 nodejs/node#43521 * src: use qualified `std::move` call in node_http2 nodejs/node#45555 * build: fix env.h for cpp20 nodejs/node#45516 * test: remove experimental-wasm-threads flag nodejs/node#45074 * src: iwyu in cleanup_queue.cc nodejs/node#44983 * src: add missing include for `std::all_of` nodejs/node#45541 * deps: update ICU to 72.1 nodejs/node#45068 * chore: fixup patch indices * chore: remove errant semicolons - nodejs/node#44179 - nodejs/node#44193 * src: add support for externally shared js builtins nodejs/node#44376 * chore: add missing GN filenames * deps: update nghttp2 to 1.51.0 nodejs/node#45537 * chore: disable more Node.js snapshot tests The Snapshot feature is currently disabled * chore: disable ICU timezone tests Node.js uses a different version of ICU than Electron so they will often be out of sync. * chore: disable threadpool event tracing test Event tracing is not enabled in embedded Node.js * chore: fixup patch indices * chore: comments from review Co-authored-by: electron-roller[bot] <84116207+electron-roller[bot]@users.noreply.github.com> Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. 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 Aug 8, 2022

legendecas force-pushed the shadow-realm/node-realm branch 2 times, most recently from 8ede7d7 to afb9113 Compare August 8, 2022 18:11

legendecas marked this pull request as ready for review August 8, 2022 18:11

legendecas force-pushed the shadow-realm/node-realm branch 3 times, most recently from 4516d05 to 3179ee1 Compare August 9, 2022 17:46

jasnell reviewed Aug 10, 2022

View reviewed changes

src/node_realm.h Show resolved Hide resolved

joyeecheung reviewed Aug 10, 2022

View reviewed changes

src/node_realm.cc Outdated Show resolved Hide resolved

src/env-inl.h Outdated Show resolved Hide resolved

src/node_realm.cc Show resolved Hide resolved

src/env.cc Outdated Show resolved Hide resolved

src/env.cc Outdated Show resolved Hide resolved

legendecas force-pushed the shadow-realm/node-realm branch from 730654c to 4d66626 Compare August 14, 2022 16:58

legendecas added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 15, 2022

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 15, 2022

joyeecheung mentioned this pull request Aug 17, 2022

vm: include vm context in the embedded snapshot #44252

Closed

legendecas mentioned this pull request Aug 17, 2022

src: extract common context embedder tag checks #44258

Closed

joyeecheung reviewed Aug 19, 2022

View reviewed changes

src/env.cc Outdated Show resolved Hide resolved

legendecas force-pushed the shadow-realm/node-realm branch from fa568fd to dde0e9e Compare August 22, 2022 07:06

legendecas mentioned this pull request Aug 22, 2022

src: create BaseObject with node::Realm #44348

Closed

legendecas force-pushed the shadow-realm/node-realm branch from dde0e9e to 0a297ff Compare August 24, 2022 16:18

legendecas added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 24, 2022

RafaelGSS added the backport-requested-v18.x PRs awaiting manual backport to the v18.x-staging branch. label Sep 5, 2022

legendecas mentioned this pull request Sep 7, 2022

Node.js Technical Steering Committee (TSC) Meeting 2022-09-07 nodejs/TSC#1280

Closed

juanarbol added the backport-requested-v16.x label Sep 30, 2022

RafaelGSS mentioned this pull request Oct 14, 2022

2022-10-18, Version 19.0.0 (Current) #44626

Merged

joyeecheung mentioned this pull request Oct 14, 2022

src: consolidate exit codes in the code base #44746

Merged

joyeecheung mentioned this pull request Oct 14, 2022

[v18.x] backport various patches of internal refactorings for snapshot and realms #45007

Closed

legendecas added the realm Issues and PRs related to the ShadowRealm API and node::Realm label Dec 26, 2022

danielleadams mentioned this pull request Dec 30, 2022

v18.13.0 release proposal #46025

Merged

codebytere added a commit to electron/electron that referenced this pull request Jan 9, 2023

chore: remove errant semicolons

d44581f

- nodejs/node#44179 - nodejs/node#44193

juanarbol mentioned this pull request Jan 26, 2023

src: make BuiltinLoader threadsafe and non-global #45942

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

src: introduce node::Realm #44179

src: introduce node::Realm #44179

legendecas commented Aug 8, 2022 •

edited

nodejs-github-bot commented Aug 8, 2022

targos commented Aug 8, 2022

jasnell commented Aug 10, 2022

legendecas commented Aug 10, 2022 •

edited

legendecas commented Aug 14, 2022

nodejs-github-bot commented Aug 15, 2022

legendecas commented Aug 19, 2022

legendecas commented Sep 7, 2022

juanarbol commented Sep 30, 2022

src: introduce node::Realm #44179

src: introduce node::Realm #44179

Conversation

legendecas commented Aug 8, 2022 • edited

nodejs-github-bot commented Aug 8, 2022

targos commented Aug 8, 2022

jasnell commented Aug 10, 2022

legendecas commented Aug 10, 2022 • edited

legendecas commented Aug 14, 2022

nodejs-github-bot commented Aug 15, 2022

legendecas commented Aug 19, 2022

legendecas commented Sep 7, 2022

juanarbol commented Sep 30, 2022

legendecas commented Aug 8, 2022 •

edited

legendecas commented Aug 10, 2022 •

edited