src: create BaseObject with node::Realm #44348

legendecas · 2022-08-22T17:28:35Z

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 · 2022-08-22T17:28:39Z

Review requested:

@nodejs/gyp
@nodejs/startup

legendecas · 2022-08-25T03:43:16Z

Extracted CleanupHooksCallback refactoring to #44379.

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>

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 · 2022-09-14T02:06:59Z

Rebased and resolved conflicts.

nodejs-github-bot · 2022-09-14T02:41:43Z

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

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: nodejs#44379 Refs: nodejs#44348 Refs: nodejs#42528 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

joyeecheung · 2022-09-16T02:48:40Z

src/api/embed_helpers.cc

@@ -68,7 +68,7 @@ Maybe<int> SpinEventLoop(Environment* env) {
  env->set_snapshot_serialize_callback(Local<Function>());

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


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..

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

src/base_object.cc

joyeecheung · 2022-09-16T03:01:08Z

src/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;


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

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 · 2022-10-04T00:58:16Z

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

danielleadams · 2022-10-05T11:04:15Z

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

RafaelGSS · 2022-10-05T13:45:07Z

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

legendecas · 2022-10-05T16:01:22Z

@RafaelGSS 6878448 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 · 2022-10-07T16:14:32Z

@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.

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>

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>

nodejs/node#44348

* 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 closes nodejs/node#49327 * test: deflake test-tls-socket-close nodejs/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 fixes nodejs/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>

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 22, 2022

legendecas force-pushed the shadow-realm/base-object branch 2 times, most recently from 6409c74 to d482ddb Compare August 24, 2022 16:45

legendecas mentioned this pull request Aug 24, 2022

src: consolidate environment cleanup queue #44379

Closed

legendecas mentioned this pull request Sep 7, 2022

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

Closed

legendecas force-pushed the shadow-realm/base-object branch from d482ddb to f78a5d7 Compare September 7, 2022 17:06

legendecas removed the blocked PRs that are blocked by other issues or PRs. label Sep 7, 2022

legendecas force-pushed the shadow-realm/base-object branch from f78a5d7 to 068a99c Compare September 8, 2022 18:14

src: create BaseObject with node::Realm

85cbe8d

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 force-pushed the shadow-realm/base-object branch from 068a99c to 85cbe8d Compare September 13, 2022 16:46

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

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

github-actions bot mentioned this pull request Sep 15, 2022

CI Reliability 2022-09-15 nodejs/reliability#379

Open

29 tasks

github-actions bot mentioned this pull request Sep 16, 2022

CI Reliability 2022-09-16 nodejs/reliability#380

Open

23 tasks

joyeecheung reviewed Sep 16, 2022

View reviewed changes

This was referenced Sep 28, 2022

CI Reliability 2022-09-28 nodejs/reliability#387

Open

CI Reliability 2022-09-29 nodejs/reliability#388

Open

juanarbol added the backport-blocked-v16.x label Oct 4, 2022

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

legendecas added backport-blocked-v18.x PRs that should land on the v18.x-staging branch but are blocked by another PR's pending backport. and removed backport-requested-v18.x PRs awaiting manual backport to the v18.x-staging branch. labels Oct 7, 2022

RafaelGSS mentioned this pull request Oct 14, 2022

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

Merged

This was referenced Oct 14, 2022

src: consolidate exit codes in the code base #44746

Merged

[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 Nov 6, 2023

src: create BaseObject with node::Realm

0acb8d9

nodejs/node#44348

codebytere added a commit to electron/electron that referenced this pull request Nov 14, 2023

src: create BaseObject with node::Realm

d9d430e

nodejs/node#44348

codebytere added a commit to electron/electron that referenced this pull request Nov 15, 2023

src: create BaseObject with node::Realm

1fa25f7

nodejs/node#44348

codebytere added a commit to electron/electron that referenced this pull request Nov 16, 2023

src: create BaseObject with node::Realm

5cb6fde

nodejs/node#44348

codebytere added a commit to electron/electron that referenced this pull request Nov 21, 2023

src: create BaseObject with node::Realm

ff1edad

nodejs/node#44348

codebytere added a commit to electron/electron that referenced this pull request Nov 22, 2023

src: create BaseObject with node::Realm

b22db4b

nodejs/node#44348

codebytere added a commit to electron/electron that referenced this pull request Nov 28, 2023

src: create BaseObject with node::Realm

f39ba29

nodejs/node#44348

codebytere added a commit to electron/electron that referenced this pull request Nov 29, 2023

src: create BaseObject with node::Realm

20310ae

nodejs/node#44348

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

src: create BaseObject with node::Realm #44348

src: create BaseObject with node::Realm #44348

legendecas commented Aug 22, 2022 •

edited

nodejs-github-bot commented Aug 22, 2022

legendecas commented Aug 25, 2022

legendecas commented Sep 14, 2022

nodejs-github-bot commented Sep 14, 2022

joyeecheung Sep 16, 2022

legendecas Sep 20, 2022 •

edited

joyeecheung Sep 16, 2022

legendecas Sep 20, 2022

juanarbol commented Oct 4, 2022

danielleadams commented Oct 5, 2022

RafaelGSS commented Oct 5, 2022 •

edited

legendecas commented Oct 5, 2022 •

edited

legendecas commented Oct 7, 2022

src: create BaseObject with node::Realm #44348

src: create BaseObject with node::Realm #44348

Conversation

legendecas commented Aug 22, 2022 • edited

nodejs-github-bot commented Aug 22, 2022

legendecas commented Aug 25, 2022

legendecas commented Sep 14, 2022

nodejs-github-bot commented Sep 14, 2022

joyeecheung Sep 16, 2022

Choose a reason for hiding this comment

legendecas Sep 20, 2022 • edited

Choose a reason for hiding this comment

joyeecheung Sep 16, 2022

Choose a reason for hiding this comment

legendecas Sep 20, 2022

Choose a reason for hiding this comment

juanarbol commented Oct 4, 2022

danielleadams commented Oct 5, 2022

RafaelGSS commented Oct 5, 2022 • edited

legendecas commented Oct 5, 2022 • edited

legendecas commented Oct 7, 2022

legendecas commented Aug 22, 2022 •

edited

legendecas Sep 20, 2022 •

edited

RafaelGSS commented Oct 5, 2022 •

edited

legendecas commented Oct 5, 2022 •

edited