src: expose WriteNodeReport to embedders

[codebytere]

Refs electron/electron#43774

This PR allows creating Node.js diagnostic reports from Electron signal handlers. It's currently used by Electron's Utility Process to support error events.

cc @deepak1556

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.23%. Comparing base (2cec716) to head (76a7ec4).
Report is 28 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #55076   +/-   ##
=======================================
  Coverage   88.23%   88.23%           
=======================================
  Files         652      652           
  Lines      183911   183920    +9     
  Branches    35858    35863    +5     
=======================================
+ Hits       162271   162290   +19     
  Misses      14916    14916           
+ Partials     6724     6714   -10     

Files with missing lines	Coverage Δ
src/node_report.cc	93.15% <100.00%> (ø)
src/node_report.h	100.00% <ø> (ø)

... and 24 files with indirect coverage changes

[nodejs-github-bot]

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

[joyeecheung]

I don't know about the report stuff too well, but the current API looks a bit too verbose to expose to node.h and we might end up changing the signature for some internal use (which would make it semver-major). Are all of the parameters needed by Electron? Can we expose a simplified version of it with only the bits that need to be customized to be exposed as parameters in the public API?

[joyeecheung]

Also we can consider taking a struct for the parameters, that'll allow us to add more parameters without making the public API changes semver-major due to ABI compatibility breakage.

[deepak1556]

Thanks @codebytere for starting this thread!

@joyeecheung you are right not all parameters are needed today, we would like to capture diagnostics from FatalErrorCallback and eventually might extend it to OOMErrorCallback both of which only need the following params,

Isolate* isolate,
Environment* env,
const char* message,
const char* trigger,
std::ostream& out

Also having an extendable way to exclude parts of the report maybe via enum would be helpful,

enum ExcludeFlags : uint32_t {
  kNativeStacks = 0,
  kNetworkInterfaces = 1 << 0,
...
};

For example in our case nativeStacks doesn't offer much value since we don't have any debug symbols in the build and the crashdumps generated by https://chromium.googlesource.com/crashpad/crashpad/+/main/README.md would be our source of truth.

[addaleax]

but the current API looks a bit too verbose to expose to node.h

@joyeecheung I agree with this but just to be clear, that's not what this PR is doing – we're not really providing any guarantees, neither ABI nor API stability, to Electron here. This is just making an internal API accessible when using NODE_WANT_INTERNALS.

(I do think that Electron should put some effort into stopping to do that. But there have been PRs like this for years and I don't think expect any changes here.)

[joyeecheung]

I agree with this but just to be clear, that's not what this PR is doing

Oh right, I misread, this is adding it to node_report.h, not node.h

[joyeecheung]

LGTM if this makes it easier for Electron to resolve conflicts. Though I agree with @addaleax that reducing the usage of NODE_WANT_INTERNALS would be ideal.

[legendecas]

There is a node::GetNodeReport public API in node.h already. It should provide the functionality.

[deepak1556]

Thanks @legendecas, somehow I missed that. It is sufficient for our use case.