src: add public API for managing NodePlatform #16981

zcbenz · 2017-11-13T03:00:18Z

In embedders like Electron, we need to control when to use v8::Platform and when not, and to make Node work correctly we have to create NodePlatform manually sometimes. So this requires the ability to manage NodePlatform in embedders, while currently the interface of NodePlatform is not exported.

This pull request add public APIs for creating/destroying NodePlatform, which follows the pattern of the APIs managing node::Environment.

/cc @refack @bnoordhuis

addaleax · 2017-11-13T03:07:29Z

src/node.h

@@ -244,6 +250,12 @@ NODE_EXTERN Environment* CreateEnvironment(IsolateData* isolate_data,
 NODE_EXTERN void LoadEnvironment(Environment* env);
 NODE_EXTERN void FreeEnvironment(Environment* env);

+NODE_EXTERN NodePlatform* CreatePlatform(


This can just use the MultiIsolatePlatform class declared right above, right? No need to explicitly reference NodePlatform in the API.

(Plus I think embedders want to call DrainBackgroundTasks() + CancelPendingDelayedTasks() at the end of an Isolate’s lifetime anyway?)

I didn't realize there is MultiIsolatePlatform, I was working on Node v8.7. Will do the change.

And do you think we should export MultiIsolatePlatform?

You mean, with NODE_EXTERN? I guess … didn’t really think of that. It should only be relevant to embedders, though

Hmm it is impossible to export MultiIsolatePlatform anyway, the v8::Platform is not exported.

bnoordhuis · 2017-11-13T12:02:29Z

@zcbenz Can you explain why/when exactly a NodePlatform is needed? Are there things you can't do with CreateIsolateData() + a custom MultiIsolatePlatform?

zcbenz · 2017-11-14T05:59:03Z

@bnoordhuis We need NodePlatform when we want to enable v8 inspector for the main process in Electron, it is not needed in renderer process where we have Chromium's devtools.

While it is possible to reimplement NodePlatform in Electron, it seems an unnecessary task when we can just reuse Node's code, and we don't want to have too much code relying on Node's C++ interface, it changes a lot and makes it harder to upgrade Node in Electron.

bnoordhuis · 2017-11-14T09:41:54Z

@zcbenz I don't quite understand. NodePlatform isn't coupled to the V8 inspector. What does it do that V8's DefaultPlatform doesn't do and is difficult to write from scratch?

zcbenz · 2017-11-15T01:25:23Z

@bnoordhuis We use the inspector agent shipped with node, the default v8 platform used to work, but after upgrading to recent versions of node, we have to use NodePlatform to make things work with electron. I did not look into the root cause.

bnoordhuis · 2017-11-15T12:08:36Z

@zcbenz Okay, I think I understand now. The behavior you see (or rather: don't see) probably isn't so much the introduction of NodePlatform but the fact that we stopped calling v8::platform::PumpMessageLoop(). We can probably fix that.

Do you call node::Start() or node::Init() or does electron control the event loop in the setup you describe?

addaleax · 2017-11-19T12:39:26Z

@bnoordhuis Do you object to this landing? I think it’s a good idea regardless of whether it’s possible to do this or not; it certainly makes embedding Node easier.

bnoordhuis · 2017-11-19T12:58:43Z

The PR was opened as a workaround for a bug. From that perspective: we should fix the bug, not merge the workaround.

Whether it makes embedding easier, I don't know. I assume most "serious" embedders will want more control over the v8::Platform so this PR would only be useful for simple embeddings.

No one requested that, AFAIK, and I don't like landing features that don't have users.

addaleax · 2017-11-19T13:03:13Z

No one requested that, AFAIK, and I don't like landing features that don't have users.

Well, that is in part because our embedding story isn’t great to begin with, and issues like this are part of that … ;)

Basically what I’m thinking is, we’re going to support this anyway, so we might as well expose it to embedders, even if it’s just helping lower the barrier to get reasonable code running. And as an extra, using our platform will yield a bit more isolation from requirement changes in upstream V8.

(But, yes, we obviously should fix that bug.)

addaleax · 2017-11-19T13:22:50Z

CI: https://ci.nodejs.org/job/node-test-commit/14143/

bnoordhuis · 2017-11-19T13:23:57Z

even if it’s just helping lower the barrier to get reasonable code running

I don't disagree but can you think of a plausible scenario where rolling your own Platform is a step too far but v8::platform::CreateDefaultPlatform() doesn't cut it?

That's why I asked questions. I figured there must be more to it than ease of use.

zcbenz · 2017-11-20T00:50:13Z

Do you call node::Start() or node::Init() or does electron control the event loop in the setup you describe?

@bnoordhuis node::Init() is called in Electron, but we explicitly the ParseArgs() call, this is how Electron started the node inspector agent:
https://github.com/electron/electron/blob/master/atom/browser/node_debugger.cc

joyeecheung · 2017-11-21T21:06:00Z

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

PR-URL: #16981 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

jasnell · 2017-11-22T17:28:55Z

Landed in 2728112

bnoordhuis · 2017-11-22T17:57:31Z

@jasnell That's a little premature, wouldn't you say? This PR isn't an actual fix for the issue that electron is experiencing.

jasnell · 2017-11-22T18:00:58Z

Possibly, definitely my apologies if so. I did not see any hard objections, it passed CI, it had sign off so I made an assumption. We can certainly revisit if necessary. :-)

zcbenz · 2018-01-17T01:32:35Z

@gibfahn Yeah it would be helpful, we did backport this patch ourselves for electron's node fork.

gibfahn · 2018-01-18T16:57:49Z

Okay, I'll take off the baking label, we'll look at including it in the next minor.

MylesBorins · 2018-08-02T14:30:57Z

@codebytere could you backport this to v8.x?

PR-URL: #16981 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

Notable Changes: * async_hooks: - rename PromiseWrap.parentId (Ali Ijaz Sheikh) #18633 - remove runtime deprecation (Ali Ijaz Sheikh) #19517 - deprecate unsafe emit{Before,After} (Ali Ijaz Sheikh) #18513 * cluster: - add cwd to cluster.settings (cjihrig) #18399 - support windowsHide option for workers (Todd Wong) #17412 * crypto: - allow passing null as IV unless required (Tobias Nießen) #18644 * deps: - upgrade npm to 6.2.0 (Kat Marchán) #21592 - upgrade libuv to 1.19.2 (cjihrig) #18918 - Upgrade node-inspect to 1.11.5 (Jan Krems) #21055 * fs,net: - support as and as+ flags in stringToFlags() (Sarat Addepalli) #18801 - emit 'ready' for fs streams and sockets (Sameer Srivastava) #19408 * http, http2: - add options to http.createServer() (Peter Marton) #15752 - add 103 Early Hints status code (Yosuke Furukawa) #16644 - add http fallback options to .createServer (Peter Marton) #15752 * n-api: - take n-api out of experimental (Michael Dawson) #19262 * perf_hooks: - add warning when too many entries in the timeline (James M Snell) #18087 * src: - add public API for managing NodePlatform (Cheng Zhao) #16981 - allow --perf-(basic-)?prof in NODE\_OPTIONS (Leko) #17600 - node internals' postmortem metadata (Matheus Marchini) #14901 * tls: - expose Finished messages in TLSSocket (Anton Salikhmetov) #19102 * **trace_events**: - add file pattern cli option (Andreas Madsen) #18480 * util: - implement util.getSystemErrorName() (Joyee Cheung) #18186 PR-URL: #21593

Notable Changes: * async_hooks: - rename PromiseWrap.parentId (Ali Ijaz Sheikh) nodejs#18633 - remove runtime deprecation (Ali Ijaz Sheikh) nodejs#19517 - deprecate unsafe emit{Before,After} (Ali Ijaz Sheikh) nodejs#18513 * cluster: - add cwd to cluster.settings (cjihrig) nodejs#18399 - support windowsHide option for workers (Todd Wong) nodejs#17412 * crypto: - allow passing null as IV unless required (Tobias Nießen) nodejs#18644 * deps: - upgrade npm to 6.2.0 (Kat Marchán) nodejs#21592 - upgrade libuv to 1.19.2 (cjihrig) nodejs#18918 - Upgrade node-inspect to 1.11.5 (Jan Krems) nodejs#21055 * fs,net: - support as and as+ flags in stringToFlags() (Sarat Addepalli) nodejs#18801 - emit 'ready' for fs streams and sockets (Sameer Srivastava) nodejs#19408 * http, http2: - add options to http.createServer() (Peter Marton) nodejs#15752 - add 103 Early Hints status code (Yosuke Furukawa) nodejs#16644 - add http fallback options to .createServer (Peter Marton) nodejs#15752 * n-api: - take n-api out of experimental (Michael Dawson) nodejs#19262 * perf_hooks: - add warning when too many entries in the timeline (James M Snell) nodejs#18087 * src: - add public API for managing NodePlatform (Cheng Zhao) nodejs#16981 - allow --perf-(basic-)?prof in NODE\_OPTIONS (Leko) nodejs#17600 - node internals' postmortem metadata (Matheus Marchini) nodejs#14901 * tls: - expose Finished messages in TLSSocket (Anton Salikhmetov) nodejs#19102 * **trace_events**: - add file pattern cli option (Andreas Madsen) nodejs#18480 * util: - implement util.getSystemErrorName() (Joyee Cheung) nodejs#18186 PR-URL: nodejs#21593

Notable Changes: * async_hooks: - rename PromiseWrap.parentId (Ali Ijaz Sheikh) #18633 - remove runtime deprecation (Ali Ijaz Sheikh) #19517 - deprecate unsafe emit{Before,After} (Ali Ijaz Sheikh) #18513 * cluster: - add cwd to cluster.settings (cjihrig) #18399 - support windowsHide option for workers (Todd Wong) #17412 * crypto: - allow passing null as IV unless required (Tobias Nießen) #18644 * deps: - upgrade npm to 6.4.1 (Kat Marchán) #22591 - upgrade libuv to 1.19.2 (cjihrig) #18918 - Upgrade node-inspect to 1.11.5 (Jan Krems) #21055 * fs,net: - support as and as+ flags in stringToFlags() (Sarat Addepalli) #18801 - emit 'ready' for fs streams and sockets (Sameer Srivastava) #19408 * http, http2: - add options to http.createServer() (Peter Marton) #15752 - add 103 Early Hints status code (Yosuke Furukawa) #16644 - add http fallback options to .createServer (Peter Marton) #15752 * n-api: - take n-api out of experimental (Michael Dawson) #19262 * perf_hooks: - add warning when too many entries in the timeline (James M Snell) #18087 * src: - add public API for managing NodePlatform (Cheng Zhao) #16981 - allow --perf-(basic-)?prof in NODE\_OPTIONS (Leko) #17600 - node internals' postmortem metadata (Matheus Marchini) #14901 * tls: - expose Finished messages in TLSSocket (Anton Salikhmetov) #19102 * **trace_events**: - add file pattern cli option (Andreas Madsen) #18480 * util: - implement util.getSystemErrorName() (Joyee Cheung) #18186 PR-URL: #21593

Notable Changes: * async_hooks: - rename PromiseWrap.parentId (Ali Ijaz Sheikh) #18633 - remove runtime deprecation (Ali Ijaz Sheikh) #19517 - deprecate unsafe emit{Before,After} (Ali Ijaz Sheikh) #18513 * cluster: - add cwd to cluster.settings (cjihrig) #18399 - support windowsHide option for workers (Todd Wong) #17412 * crypto: - allow passing null as IV unless required (Tobias Nießen) #18644 * deps: - upgrade npm to 6.2.0 (Kat Marchán) #21592 - upgrade libuv to 1.19.2 (cjihrig) #18918 - Upgrade node-inspect to 1.11.5 (Jan Krems) #21055 * fs,net: - support as and as+ flags in stringToFlags() (Sarat Addepalli) #18801 - emit 'ready' for fs streams and sockets (Sameer Srivastava) #19408 * http, http2: - add options to http.createServer() (Peter Marton) #15752 - add 103 Early Hints status code (Yosuke Furukawa) #16644 - add http fallback options to .createServer (Peter Marton) #15752 * n-api: - take n-api out of experimental (Michael Dawson) #19262 * perf_hooks: - add warning when too many entries in the timeline (James M Snell) #18087 * src: - add public API for managing NodePlatform (Cheng Zhao) #16981 - allow --perf-(basic-)?prof in NODE\_OPTIONS (Leko) #17600 - node internals' postmortem metadata (Matheus Marchini) #14901 * tls: - expose Finished messages in TLSSocket (Anton Salikhmetov) #19102 * **trace_events**: - add file pattern cli option (Andreas Madsen) #18480 * util: - implement util.getSystemErrorName() (Joyee Cheung) #18186 PR-URL: #21593

nodejs-github-bot added the c++ Issues and PRs that require attention from people who are familiar with C++. label Nov 13, 2017

addaleax self-requested a review November 13, 2017 03:02

addaleax reviewed Nov 13, 2017

View reviewed changes

zcbenz force-pushed the export-node-platform branch from 8dac00b to 71d50ce Compare November 13, 2017 03:30

addaleax approved these changes Nov 13, 2017

View reviewed changes

addaleax added embedding Issues and PRs related to embedding Node.js in another project. semver-minor PRs that contain new features and should be released in the next minor version. labels Nov 13, 2017

src: add public API for managing NodePlatform

0e84e56

zcbenz force-pushed the export-node-platform branch from 71d50ce to 0e84e56 Compare November 13, 2017 03:33

zcbenz mentioned this pull request Nov 13, 2017

[WIP] Upgrade to Chromium 61 electron/electron#10213

Merged

42 tasks

refack approved these changes Nov 13, 2017

View reviewed changes

jasnell approved these changes Nov 13, 2017

View reviewed changes

cjihrig approved these changes Nov 15, 2017

View reviewed changes

jasnell closed this Nov 22, 2017

gibfahn removed the baking-for-lts PRs that need to wait before landing in a LTS release. label Jan 18, 2018

MylesBorins added the backport-requested-v8.x label Aug 2, 2018

This was referenced Aug 2, 2018

[v8.x backport] src: add public API for managing NodePlatform #22092

Closed

[v8.x backport] src: add public API for managing NodePlatform #22098

Closed

MylesBorins added backported-to-v8.x and removed backport-requested-v8.x labels Aug 7, 2018

MylesBorins mentioned this pull request Aug 16, 2018

v8.12.0 proposal #21593

Merged

davisjam mentioned this pull request Sep 6, 2018

WIP: Pluggable thread pool #22631

Closed

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

src: add public API for managing NodePlatform #16981

src: add public API for managing NodePlatform #16981

zcbenz commented Nov 13, 2017

addaleax Nov 13, 2017

zcbenz Nov 13, 2017

addaleax Nov 13, 2017

zcbenz Nov 13, 2017

bnoordhuis commented Nov 13, 2017

zcbenz commented Nov 14, 2017

bnoordhuis commented Nov 14, 2017

zcbenz commented Nov 15, 2017

bnoordhuis commented Nov 15, 2017

addaleax commented Nov 19, 2017

bnoordhuis commented Nov 19, 2017

addaleax commented Nov 19, 2017

addaleax commented Nov 19, 2017

bnoordhuis commented Nov 19, 2017

zcbenz commented Nov 20, 2017

joyeecheung commented Nov 21, 2017

jasnell commented Nov 22, 2017

bnoordhuis commented Nov 22, 2017

jasnell commented Nov 22, 2017

zcbenz commented Jan 17, 2018

gibfahn commented Jan 18, 2018

MylesBorins commented Aug 2, 2018

src: add public API for managing NodePlatform #16981

src: add public API for managing NodePlatform #16981

Conversation

zcbenz commented Nov 13, 2017

addaleax Nov 13, 2017

Choose a reason for hiding this comment

zcbenz Nov 13, 2017

Choose a reason for hiding this comment

addaleax Nov 13, 2017

Choose a reason for hiding this comment

zcbenz Nov 13, 2017

Choose a reason for hiding this comment

bnoordhuis commented Nov 13, 2017

zcbenz commented Nov 14, 2017

bnoordhuis commented Nov 14, 2017

zcbenz commented Nov 15, 2017

bnoordhuis commented Nov 15, 2017

addaleax commented Nov 19, 2017

bnoordhuis commented Nov 19, 2017

addaleax commented Nov 19, 2017

addaleax commented Nov 19, 2017

bnoordhuis commented Nov 19, 2017

zcbenz commented Nov 20, 2017

joyeecheung commented Nov 21, 2017

jasnell commented Nov 22, 2017

bnoordhuis commented Nov 22, 2017

jasnell commented Nov 22, 2017

zcbenz commented Jan 17, 2018

gibfahn commented Jan 18, 2018

MylesBorins commented Aug 2, 2018