Skip to content

src: create BaseObject with node::Realm - #44348

Closed
legendecas wants to merge 2 commits into
nodejs:mainfrom
legendecas:shadow-realm/base-object
Closed

src: create BaseObject with node::Realm#44348
legendecas wants to merge 2 commits into
nodejs:mainfrom
legendecas:shadow-realm/base-object

Conversation

@legendecas

@legendecaslegendecas commented Aug 22, 2022

Copy link
Copy Markdown
Member

BaseObjects are wrappers around JS objects. These objects should be
created in a node::Realm and destroyed when their associated realm is
cleaning up.

BaseObjects created in a realm should also be serialized associated to
that realm when creating the startup snapshot.

Refs: #42528

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/gyp
  • @nodejs/startup

@nodejs-github-botnodejs-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 22, 2022
@legendecaslegendecas added blocked PRs that are blocked by other issues or PRs. 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. and removed 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 22, 2022
@legendecas
legendecasforce-pushed the shadow-realm/base-object branch 2 times, most recently from 6409c74 to d482ddbCompareAugust 24, 2022 16:45
@legendecas

Copy link
Copy Markdown
MemberAuthor

Extracted CleanupHooksCallback refactoring to #44379.

legendecas added a commit that referenced this pull request Sep 7, 2022
Each Realm tracks its own cleanup hooks and drains the hooks when it is
going to be destroyed.
Moves the implementations of the cleanup queue to its own class so that
it can be used in `node::Realm` too.
PR-URL: #44379
Refs: #44348
Refs: #42528
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
@legendecas
legendecasforce-pushed the shadow-realm/base-object branch from d482ddb to f78a5d7CompareSeptember 7, 2022 17:06
@legendecaslegendecas removed the blocked PRs that are blocked by other issues or PRs. label Sep 7, 2022
@legendecas
legendecasforce-pushed the shadow-realm/base-object branch from f78a5d7 to 068a99cCompareSeptember 8, 2022 18:14
BaseObject is a wrapper around JS objects. These objects should be
created in a node::Realm and destroyed when their associated realm is
cleaning up.
@legendecas
legendecasforce-pushed the shadow-realm/base-object branch from 068a99c to 85cbe8dCompareSeptember 13, 2022 16:46
@legendecas

Copy link
Copy Markdown
MemberAuthor

Rebased and resolved conflicts.

@legendecaslegendecas added the request-ci Add this label to start a Jenkins CI on a PR. label Sep 14, 2022
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Sep 14, 2022
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Comment threadsrc/api/embed_helpers.cc Outdated

env->PrintInfoForSnapshotIfDebug();
env->VerifyNoStrongBaseObjects();
env->principal_realm()->VerifyNoStrongBaseObjects();

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.

I wonder if it's a good time now to introduce a list of realms in the env and do a env->ForEachRealm() in places like this, so we don't have to update everything again later other than adding more realms to the list..

@legendecaslegendecasSep 20, 2022

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Yeah, thank you for the suggestion, it makes sense to me. Updated.

Comment threadsrc/base_object.cc Outdated
Comment threadsrc/node_realm.cc
// for these criteria. Currently, we only do so when explicitly instructed to
// or when in debug mode (where --verify-base-objects is always-on).

if (!env()->options()->verify_base_objects) return;

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.

I wonder if it's necessary to introduce per-realm options (maybe not in this PR, though)

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I believe it is a good idea to distinguish per-realm options. I've added a TODO comment here. Thank you for the suggestion.

@juanarbol

Copy link
Copy Markdown
Member

This depends on #44179; marking this a backport-blocked for the v16.x release branch.

@danielleadams

Copy link
Copy Markdown
Contributor

Hi @legendecas, do you mind backporting this to v18.x-staging? Thank you.

@RafaelGSS

RafaelGSS commented Oct 5, 2022

Copy link
Copy Markdown
Member

@danielleadams I think it's already there 6878448 since the previous release.

@legendecas

legendecas commented Oct 5, 2022

Copy link
Copy Markdown
MemberAuthor

@RafaelGSS6878448 is not the commit of this PR. It's #44379. The commit is referencing this PR :p

@danielleadams yeah, I can submit a backport to v18.

@legendecas

Copy link
Copy Markdown
MemberAuthor

@danielleadams just realized that #44348 (comment) mentioned this depends on #44179. I'm marking this as backport-blocked-v18.x the same as v16 backporting.

joyeecheung pushed a commit to joyeecheung/node that referenced this pull request Oct 18, 2022
BaseObject is a wrapper around JS objects. These objects should be
created in a node::Realm and destroyed when their associated realm is
cleaning up.
PR-URL: nodejs#44348
Refs: nodejs#42528
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
joyeecheung pushed a commit that referenced this pull request Nov 1, 2022
BaseObject is a wrapper around JS objects. These objects should be
created in a node::Realm and destroyed when their associated realm is
cleaning up.
PR-URL: #44348
Refs: #42528
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
juanarbol pushed a commit that referenced this pull request Nov 4, 2022
BaseObject is a wrapper around JS objects. These objects should be
created in a node::Realm and destroyed when their associated realm is
cleaning up.
PR-URL: #44348
Refs: #42528
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
@legendecaslegendecas added the realm Issues and PRs related to the ShadowRealm API and node::Realm label Dec 26, 2022
danielleadams pushed a commit that referenced this pull request Jan 3, 2023
BaseObject is a wrapper around JS objects. These objects should be
created in a node::Realm and destroyed when their associated realm is
cleaning up.
PR-URL: #44348
Refs: #42528
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
codebytere added a commit to electron/electron that referenced this pull request Nov 6, 2023
codebytere added a commit to electron/electron that referenced this pull request Nov 14, 2023
codebytere added a commit to electron/electron that referenced this pull request Nov 15, 2023
codebytere added a commit to electron/electron that referenced this pull request Nov 16, 2023
codebytere added a commit to electron/electron that referenced this pull request Nov 21, 2023
codebytere added a commit to electron/electron that referenced this pull request Nov 22, 2023
codebytere added a commit to electron/electron that referenced this pull request Nov 28, 2023
codebytere added a commit to electron/electron that referenced this pull request Nov 29, 2023
jkleinsc pushed a commit to electron/electron that referenced this pull request Nov 30, 2023
* chore: upgrade to Node.js v20
* src: allow embedders to override NODE_MODULE_VERSION
nodejs/node#49279
* src: fix missing trailing ,
nodejs/node#46909
* src,tools: initialize cppgc
nodejs/node#45704
* tools: allow passing absolute path of config.gypi in js2c
nodejs/node#49162
* tools: port js2c.py to C++
nodejs/node#46997
* doc,lib: disambiguate the old term, NativeModule
nodejs/node#45673
* chore: fixup Node.js BSSL tests
* nodejs/node#49492
* nodejs/node#44498
* deps: upgrade to libuv 1.45.0
nodejs/node#48078
* deps: update V8 to 10.7
nodejs/node#44741
* test: use gcUntil() in test-v8-serialize-leak
nodejs/node#49168
* module: make CJS load from ESM loader
nodejs/node#47999
* src: make BuiltinLoader threadsafe and non-global
nodejs/node#45942
* chore: address changes to CJS/ESM loading
* module: make CJS load from ESM loader (nodejs/node#47999)
* lib: improve esm resolve performance (nodejs/node#46652)
* bootstrap: optimize modules loaded in the built-in snapshot
nodejs/node#45849
* test: mark test-runner-output as flaky
nodejs/node#49854
* lib: lazy-load deps in modules/run_main.js
nodejs/node#45849
* url: use private properties for brand check
nodejs/node#46904
* test: refactor `test-node-output-errors`
nodejs/node#48992
* assert: deprecate callTracker
nodejs/node#47740
* src: cast v8::Object::GetInternalField() return value to v8::Value
nodejs/node#48943
* test: adapt test-v8-stats for V8 update
nodejs/node#45230
* tls: ensure TLS Sockets are closed if the underlying wrap closesnodejs/node#49327
* test: deflake test-tls-socket-closenodejs/node#49575
* net: fix crash due to simultaneous close/shutdown on JS Stream Sockets
nodejs/node#49400
* net: use asserts in JS Socket Stream to catch races in future
nodejs/node#49400
* lib: fix BroadcastChannel initialization location
nodejs/node#46864
* src: create BaseObject with node::Realm
nodejs/node#44348
* src: implement DataQueue and non-memory resident Blob
nodejs/node#45258
* sea: add support for V8 bytecode-only caching
nodejs/node#48191
* chore: fixup patch indices
* gyp: put filenames in variables
nodejs/node#46965
* build: modify js2c.py into GN executable
* fix: (WIP) handle string replacement of fs -> original-fs
* [v20.x] backport vm-related memory fixesnodejs/node#49874
* src: make BuiltinLoader threadsafe and non-global
nodejs/node#45942
* src: avoid copying string in fs_permission
nodejs/node#47746
* look upon my works ye mighty
and dispair
* chore: patch cleanup
* [api] Remove AllCan Read/Write
https://chromium-review.googlesource.com/c/v8/v8/+/5006387
* fix: missing include for NODE_EXTERN
* chore: fixup patch indices
* fix: fail properly when js2c fails in Node.js
* build: fix js2c root_gen_dir
* fix: lib/fs.js -> lib/original-fs.js
* build: fix original-fs file xforms
* fixup! module: make CJS load from ESM loader
* build: get rid of CppHeap for now
* build: add patch to prevent extra fs lookup on esm load
* build: greatly simplify js2c modifications
Moves our original-fs modifications back into a super simple python script action, wires up the output of that action into our call to js2c
* chore: update to handle moved internal/modules/helpers file
* test: update @types/node test
* feat: enable preventing cppgc heap creation
* feat: optionally prevent calling V8::EnableWebAssemblyTrapHandler
* fix: no cppgc initialization in the renderer
* gyp: put filenames in variables
nodejs/node#46965
* test: disable single executable tests
* fix: nan tests failing on node headers missing file
* tls,http2: send fatal alert on ALPN mismatch
nodejs/node#44031
* test: disable snapshot tests
* nodejs/node#47887
* nodejs/node#49684
* nodejs/node#44193
* build: use deps/v8 for v8/tools
Node.js hard depends on these in their builtins
* test: fix edge snapshot stack traces
nodejs/node#49659
* build: remove js2c //base dep
* build: use electron_js2c_toolchain to build node_js2c
* fix: don't create SafeSet outside packageResolve
Fixes failure in parallel/test-require-delete-array-iterator:
=== release test-require-delete-array-iterator ===
Path: parallel/test-require-delete-array-iterator
node:internal/per_context/primordials:426
constructor(i) { super(i); } // eslint-disable-line no-useless-constructor
^
TypeError: object is not iterable (cannot read property Symbol(Symbol.iterator))
at new Set (<anonymous>)
at new SafeSet (node:internal/per_context/primordials:426:22)
* fix: failing crashReporter tests on Linux
These were failing because our change from node::InitializeNodeWithArgs to
node::InitializeOncePerProcess meant that we now inadvertently called
PlatformInit, which reset signal handling. This meant that our intentional
crash function ElectronBindings::Crash no longer worked and the renderer process
no longer crashed when process.crash() was called. We don't want to use Node.js'
default signal handling in the renderer process, so we disable it by passing
kNoDefaultSignalHandling to node::InitializeOncePerProcess.
* build: only create cppgc heap on non-32 bit platforms
* chore: clean up util:CompileAndCall
* src: fix compatility with upcoming V8 12.1 APIs
nodejs/node#50709
* fix: use thread_local BuiltinLoader
* chore: fixup v8 patch indices
---------
Co-authored-by: Keeley Hammond <vertedinde@electronjs.org>
Co-authored-by: Samuel Attard <marshallofsound@electronjs.org>
MrHuangJser pushed a commit to MrHuangJser/electron that referenced this pull request Dec 11, 2023
* chore: upgrade to Node.js v20
* src: allow embedders to override NODE_MODULE_VERSION
nodejs/node#49279
* src: fix missing trailing ,
nodejs/node#46909
* src,tools: initialize cppgc
nodejs/node#45704
* tools: allow passing absolute path of config.gypi in js2c
nodejs/node#49162
* tools: port js2c.py to C++
nodejs/node#46997
* doc,lib: disambiguate the old term, NativeModule
nodejs/node#45673
* chore: fixup Node.js BSSL tests
* nodejs/node#49492
* nodejs/node#44498
* deps: upgrade to libuv 1.45.0
nodejs/node#48078
* deps: update V8 to 10.7
nodejs/node#44741
* test: use gcUntil() in test-v8-serialize-leak
nodejs/node#49168
* module: make CJS load from ESM loader
nodejs/node#47999
* src: make BuiltinLoader threadsafe and non-global
nodejs/node#45942
* chore: address changes to CJS/ESM loading
* module: make CJS load from ESM loader (nodejs/node#47999)
* lib: improve esm resolve performance (nodejs/node#46652)
* bootstrap: optimize modules loaded in the built-in snapshot
nodejs/node#45849
* test: mark test-runner-output as flaky
nodejs/node#49854
* lib: lazy-load deps in modules/run_main.js
nodejs/node#45849
* url: use private properties for brand check
nodejs/node#46904
* test: refactor `test-node-output-errors`
nodejs/node#48992
* assert: deprecate callTracker
nodejs/node#47740
* src: cast v8::Object::GetInternalField() return value to v8::Value
nodejs/node#48943
* test: adapt test-v8-stats for V8 update
nodejs/node#45230
* tls: ensure TLS Sockets are closed if the underlying wrap closesnodejs/node#49327
* test: deflake test-tls-socket-closenodejs/node#49575
* net: fix crash due to simultaneous close/shutdown on JS Stream Sockets
nodejs/node#49400
* net: use asserts in JS Socket Stream to catch races in future
nodejs/node#49400
* lib: fix BroadcastChannel initialization location
nodejs/node#46864
* src: create BaseObject with node::Realm
nodejs/node#44348
* src: implement DataQueue and non-memory resident Blob
nodejs/node#45258
* sea: add support for V8 bytecode-only caching
nodejs/node#48191
* chore: fixup patch indices
* gyp: put filenames in variables
nodejs/node#46965
* build: modify js2c.py into GN executable
* fix: (WIP) handle string replacement of fs -> original-fs
* [v20.x] backport vm-related memory fixesnodejs/node#49874
* src: make BuiltinLoader threadsafe and non-global
nodejs/node#45942
* src: avoid copying string in fs_permission
nodejs/node#47746
* look upon my works ye mighty
and dispair
* chore: patch cleanup
* [api] Remove AllCan Read/Write
https://chromium-review.googlesource.com/c/v8/v8/+/5006387
* fix: missing include for NODE_EXTERN
* chore: fixup patch indices
* fix: fail properly when js2c fails in Node.js
* build: fix js2c root_gen_dir
* fix: lib/fs.js -> lib/original-fs.js
* build: fix original-fs file xforms
* fixup! module: make CJS load from ESM loader
* build: get rid of CppHeap for now
* build: add patch to prevent extra fs lookup on esm load
* build: greatly simplify js2c modifications
Moves our original-fs modifications back into a super simple python script action, wires up the output of that action into our call to js2c
* chore: update to handle moved internal/modules/helpers file
* test: update @types/node test
* feat: enable preventing cppgc heap creation
* feat: optionally prevent calling V8::EnableWebAssemblyTrapHandler
* fix: no cppgc initialization in the renderer
* gyp: put filenames in variables
nodejs/node#46965
* test: disable single executable tests
* fix: nan tests failing on node headers missing file
* tls,http2: send fatal alert on ALPN mismatch
nodejs/node#44031
* test: disable snapshot tests
* nodejs/node#47887
* nodejs/node#49684
* nodejs/node#44193
* build: use deps/v8 for v8/tools
Node.js hard depends on these in their builtins
* test: fix edge snapshot stack traces
nodejs/node#49659
* build: remove js2c //base dep
* build: use electron_js2c_toolchain to build node_js2c
* fix: don't create SafeSet outside packageResolve
Fixes failure in parallel/test-require-delete-array-iterator:
=== release test-require-delete-array-iterator ===
Path: parallel/test-require-delete-array-iterator
node:internal/per_context/primordials:426
constructor(i) { super(i); } // eslint-disable-line no-useless-constructor
^
TypeError: object is not iterable (cannot read property Symbol(Symbol.iterator))
at new Set (<anonymous>)
at new SafeSet (node:internal/per_context/primordials:426:22)
* fix: failing crashReporter tests on Linux
These were failing because our change from node::InitializeNodeWithArgs to
node::InitializeOncePerProcess meant that we now inadvertently called
PlatformInit, which reset signal handling. This meant that our intentional
crash function ElectronBindings::Crash no longer worked and the renderer process
no longer crashed when process.crash() was called. We don't want to use Node.js'
default signal handling in the renderer process, so we disable it by passing
kNoDefaultSignalHandling to node::InitializeOncePerProcess.
* build: only create cppgc heap on non-32 bit platforms
* chore: clean up util:CompileAndCall
* src: fix compatility with upcoming V8 12.1 APIs
nodejs/node#50709
* fix: use thread_local BuiltinLoader
* chore: fixup v8 patch indices
---------
Co-authored-by: Keeley Hammond <vertedinde@electronjs.org>
Co-authored-by: Samuel Attard <marshallofsound@electronjs.org>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

c++Issues and PRs that require attention from people who are familiar with C++.lib / srcIssues and PRs related to general changes in the lib or src directory.needs-ciPRs that need a full CI run.realmIssues and PRs related to the ShadowRealm API and node::Realm

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@legendecas@nodejs-github-bot@juanarbol@danielleadams@RafaelGSS@joyeecheung