bootstrap: put is_building_snapshot state in IsolateData and introduce ERR_NOT_SUPPORTED_IN_SNAPSHOT #47887

joyeecheung · 2023-05-05T20:20:09Z

bootstrap: put is_building_snapshot state in IsolateData

Previously we modify the CLI options store to indicate whether the
isolate is created for building snapshot, which is a bit hacky and
makes it difficult to tell whether the snapshot is built from the
command line or through other APIs. This patch adds
is_building_snapshot to IsolateData and use this instead when we
need to know whether the isolate is created for building snapshot
(but do not care about where that request is coming from).

bootstrap: throw ERR_NOT_SUPPORTED_IN_SNAPSHOT in unsupported operation

This patch adds a new ERR_NOT_SUPPORTED_IN_SNAPSHOT error and throw
it in the worker constructor.

Previously we modify the CLI options store to indicate whether the isolate is created for building snapshot, which is a bit hacky and makes it difficult to tell whether the snapshot is built from the command line or through other APIs. This patch adds is_building_snapshot to IsolateData and use this instead when we need to know whether the isolate is created for building snapshot (but do not care about where that request is coming from).

This patch adds a new ERR_NOT_SUPPORTED_IN_SNAPSHOT error and throw it in the worker constructor.

nodejs-github-bot · 2023-05-05T20:20:14Z

Review requested:

@nodejs/startup

nodejs-github-bot · 2023-05-05T20:20:36Z

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

src/node_worker.cc

doc/api/errors.md

…operation Co-authored-by: Anna Henningsen <github@addaleax.net>

nodejs-github-bot · 2023-05-06T10:53:26Z

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

BridgeAR · 2023-05-07T11:15:48Z

doc/api/errors.md

@@ -2414,6 +2414,13 @@ error indicates that the idle loop has failed to stop.
 An attempt was made to use operations that can only be used when building
 V8 startup snapshot even though Node.js isn't building one.

+<a id="ERR_NOT_SUPPORTED_IN_SNAPSHOT"></a>
+
+### `ERR_NOT_SUPPORTED_IN_SNAPSHOT`


What about using a more generic ERR_NOT_SUPPORTED error? The concrete description could be part of the message. We have many very specific error codes that likely do not help users all that much.

I don't think a generic ERR_NOT_SUPPORTED would be quite useful in this case. What would one do after checking error.code === ERR_NOT_SUPPORTED? I can imagine the embedder putting a TryCatch around e.g. LoadEnvironment and check for the code being ERR_NOT_SUPPORTED_IN_SNAPSHOT, if that's true, simply give up creating a snapshot (as some kind of optional optimization) and always run the code from scratch, otherwise simply treat it as a proper error (e.g. the code being run is actually buggy) that it cannot handle and fail. ERR_NOT_SUPPORTED would not be enough in this case, and then they'd end up..parsing the error message to see if it's a snapshot failure.

Ping @BridgeAR does that answer the question?

nodejs-github-bot · 2023-05-10T11:42:22Z

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

nodejs-github-bot · 2023-05-23T14:03:33Z

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

nodejs-github-bot · 2023-05-23T17:20:15Z

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

nodejs-github-bot · 2023-05-24T10:59:24Z

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

Previously we modify the CLI options store to indicate whether the isolate is created for building snapshot, which is a bit hacky and makes it difficult to tell whether the snapshot is built from the command line or through other APIs. This patch adds is_building_snapshot to IsolateData and use this instead when we need to know whether the isolate is created for building snapshot (but do not care about where that request is coming from). PR-URL: #47887 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com>

This patch adds a new ERR_NOT_SUPPORTED_IN_SNAPSHOT error and throw it in the worker constructor. PR-URL: #47887 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com>

joyeecheung · 2023-05-24T13:25:32Z

Landed in bcf1dd0...7df2758

Previously we modify the CLI options store to indicate whether the isolate is created for building snapshot, which is a bit hacky and makes it difficult to tell whether the snapshot is built from the command line or through other APIs. This patch adds is_building_snapshot to IsolateData and use this instead when we need to know whether the isolate is created for building snapshot (but do not care about where that request is coming from). PR-URL: #47887 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com>

This patch adds a new ERR_NOT_SUPPORTED_IN_SNAPSHOT error and throw it in the worker constructor. PR-URL: #47887 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com>

Previously we modify the CLI options store to indicate whether the isolate is created for building snapshot, which is a bit hacky and makes it difficult to tell whether the snapshot is built from the command line or through other APIs. This patch adds is_building_snapshot to IsolateData and use this instead when we need to know whether the isolate is created for building snapshot (but do not care about where that request is coming from). PR-URL: nodejs#47887 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com>

This patch adds a new ERR_NOT_SUPPORTED_IN_SNAPSHOT error and throw it in the worker constructor. PR-URL: nodejs#47887 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com>

Previously we modify the CLI options store to indicate whether the isolate is created for building snapshot, which is a bit hacky and makes it difficult to tell whether the snapshot is built from the command line or through other APIs. This patch adds is_building_snapshot to IsolateData and use this instead when we need to know whether the isolate is created for building snapshot (but do not care about where that request is coming from). PR-URL: nodejs#47887 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com>

This patch adds a new ERR_NOT_SUPPORTED_IN_SNAPSHOT error and throw it in the worker constructor. PR-URL: nodejs#47887 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com>

* nodejs/node#47887 * nodejs/node#49684 * nodejs/node#44193

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

joyeecheung added 2 commits May 5, 2023 22:01

bootstrap: throw ERR_NOT_SUPPORTED_IN_SNAPSHOT in unsupported operation

368a793

This patch adds a new ERR_NOT_SUPPORTED_IN_SNAPSHOT error and throw it in the worker constructor.

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 May 5, 2023

anonrig reviewed May 5, 2023

View reviewed changes

src/node_worker.cc Show resolved Hide resolved

addaleax approved these changes May 5, 2023

View reviewed changes

doc/api/errors.md Outdated Show resolved Hide resolved

fixup! bootstrap: throw ERR_NOT_SUPPORTED_IN_SNAPSHOT in unsupported …

87ca62d

…operation Co-authored-by: Anna Henningsen <github@addaleax.net>

github-actions bot mentioned this pull request May 7, 2023

CI Reliability 2023-05-07 nodejs/reliability#558

Open

27 tasks

BridgeAR reviewed May 7, 2023

View reviewed changes

This was referenced May 8, 2023

CI Reliability 2023-05-08 nodejs/reliability#559

Open

CI Reliability 2023-05-09 nodejs/reliability#560

Open

CI Reliability 2023-05-10 nodejs/reliability#561

Open

jasnell approved these changes May 10, 2023

View reviewed changes

legendecas approved these changes May 10, 2023

View reviewed changes

This was referenced May 11, 2023

CI Reliability 2023-05-11 nodejs/reliability#562

Open

CI Reliability 2023-05-12 nodejs/reliability#563

Open

CI Reliability 2023-05-13 nodejs/reliability#564

Open

github-actions bot mentioned this pull request May 24, 2023

CI Reliability 2023-05-24 nodejs/reliability#575

Open

19 tasks

joyeecheung closed this May 24, 2023

github-actions bot mentioned this pull request May 31, 2023

CI Reliability 2023-05-31 nodejs/reliability#582

Open

22 tasks

targos mentioned this pull request Jun 4, 2023

v20.3.0 release proposal #48332

Merged

danielleadams added the backport-requested-v18.x PRs awaiting manual backport to the v18.x-staging branch. label Jun 30, 2023

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

test: disable snapshot tests

e4dfd3e

* nodejs/node#47887 * nodejs/node#49684 * nodejs/node#44193

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

test: disable snapshot tests

eb973d2

* nodejs/node#47887 * nodejs/node#49684 * nodejs/node#44193

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

test: disable snapshot tests

9ca751c

* nodejs/node#47887 * nodejs/node#49684 * nodejs/node#44193

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

test: disable snapshot tests

1325650

* nodejs/node#47887 * nodejs/node#49684 * nodejs/node#44193

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

test: disable snapshot tests

ce67ba1

* nodejs/node#47887 * nodejs/node#49684 * nodejs/node#44193

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

bootstrap: put is_building_snapshot state in IsolateData and introduce ERR_NOT_SUPPORTED_IN_SNAPSHOT #47887

bootstrap: put is_building_snapshot state in IsolateData and introduce ERR_NOT_SUPPORTED_IN_SNAPSHOT #47887

joyeecheung commented May 5, 2023 •

edited

Loading

nodejs-github-bot commented May 5, 2023

nodejs-github-bot commented May 5, 2023

nodejs-github-bot commented May 6, 2023

BridgeAR May 7, 2023

joyeecheung May 8, 2023 •

edited

Loading

joyeecheung May 18, 2023

nodejs-github-bot commented May 10, 2023

nodejs-github-bot commented May 23, 2023

nodejs-github-bot commented May 23, 2023

nodejs-github-bot commented May 24, 2023

joyeecheung commented May 24, 2023

bootstrap: put is_building_snapshot state in IsolateData and introduce ERR_NOT_SUPPORTED_IN_SNAPSHOT #47887

bootstrap: put is_building_snapshot state in IsolateData and introduce ERR_NOT_SUPPORTED_IN_SNAPSHOT #47887

Conversation

joyeecheung commented May 5, 2023 • edited Loading

bootstrap: put is_building_snapshot state in IsolateData

bootstrap: throw ERR_NOT_SUPPORTED_IN_SNAPSHOT in unsupported operation

nodejs-github-bot commented May 5, 2023

nodejs-github-bot commented May 5, 2023

nodejs-github-bot commented May 6, 2023

BridgeAR May 7, 2023

Choose a reason for hiding this comment

joyeecheung May 8, 2023 • edited Loading

Choose a reason for hiding this comment

joyeecheung May 18, 2023

Choose a reason for hiding this comment

nodejs-github-bot commented May 10, 2023

nodejs-github-bot commented May 23, 2023

nodejs-github-bot commented May 23, 2023

nodejs-github-bot commented May 24, 2023

joyeecheung commented May 24, 2023

joyeecheung commented May 5, 2023 •

edited

Loading

joyeecheung May 8, 2023 •

edited

Loading