node-report: meld into core #22712

gireeshpunathil · 2018-09-05T15:51:04Z

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

This PR adds the the process.report tool.

When enabled, node-report significantly helps root cause various types of problems, including support issues sent to the various repos of the Node.js organization
The requirement of explicitly adding the dependency to node-report in users' applications often represents a blocker to adoption and thus cancels 1) benefits

No new functionalities have been added, changes that are required for melding it as a built-in capability has been affected on the module version of node-report (https://github.com/nodejs/node-report)

Changes at a glance:

opt-in feature for auto-generation of report through --report-events
APIs exposed through util module. APIs are enabled by default.
opt-out at configure time through --without-node-report
only minimal refactoring to natively merge the module
tests covering all the APIs and report generating events
a new page for node-report in the document section

Refs: #19661
Refs: #18760
Refs: nodejs/node-report#103

additional /cc

@rnchamberlain : original author of this component
@richardlau : previous work on merging this into core
@mhdawson : orignal requirement raiser through nodejs/node-report#110
@nodejs/diagnostics : in relation to nodejs/TSC#586
@jasnell @rvagg @joyeecheung : in relation to their specific requirements on interfaces /defaults (#19661)

nodejs-github-bot · 2018-09-05T15:51:16Z

@gireeshpunathil build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/802/pipeline

doc/api/node_report.md

AUTHORS

doc/api/node_report.md

doc/api/util.md

src/node_config.cc

src/node_options.cc

src/node_report_module.cc

src/node_util.cc

test/node-report/helper.js

jasnell

Good start. Needs a bit of work. Left some initial comments.

richardlau

Thanks @gireeshpunathil! Did a cursory glance over and left some comments. Will follow up with a proper technical review.

Docs should note that this feature is experimental (at least initially). I also have a preference for calling the report diagnostics report (or something similar) instead of node-report in core as I find the node- prefix redundant.

doc/api/node_report.md

doc/api/util.md

src/node_options.cc

test/node-report/helper.js

node.gyp

doc/api/util.md

src/node_report.h

misterdjules · 2018-09-05T18:16:53Z

@gireeshpunathil

Make node-report part of core runtime, to satisfy its tier1 status
on diagnostic tooling

What part of the tier1 status requires something to be part of Node.js' core?

doc/api/node_report.md

src/node_report.h

src/node_report.cc

src/node_report_module.cc

src/node_report_utils.cc

addaleax · 2019-01-19T00:13:09Z

For releasers: This was landed in 01cd219...55e0ad9

We also may want to add a note to the entry for the first commit in the changelog, because the commit title tells very little about the change itself.

gireeshpunathil · 2019-01-19T02:06:45Z

@addaleax - thnx, can I know where? (to the bottom of 4f67973 ?) and what? (general description about the report, or the changed files, or something else?)

addaleax · 2019-01-19T06:51:37Z

@gireeshpunathil I don’t know where – I think here is fine? And basically I’m just looking for a very short description of the commit that would fit into our one-line changelog, to explain the commit message title, e.g. (This commit adds the the process.report tool)?

gireeshpunathil · 2019-01-19T07:55:34Z

added the one liner to the head or the PR description, as well as to the bottom of the main commit.

Make node-report part of core runtime because: 1. When enabled, node-report significantly helps root cause various types of problems, including support issues sent to the various repos of the Node.js organization. 2. The requirement of explicitly adding the dependency to node-report in user applications often represents a blocker to adoption. Major deviation from the module version of the node-report is that the report is generated in JSON format, as opposed to human readable text. No new functionalities have been added, changes that are required for melding it as a built-in capability has been affected on the module version of node-report (https://github.com/nodejs/node-report) Co-authored-by: Bidisha Pyne <[email protected]> Co-authored-by: Howard Hellyer <[email protected]> Co-authored-by: Jeremiah Senkpiel <[email protected]> Co-authored-by: Julian Alimin <[email protected]> Co-authored-by: Lakshmi Swetha Gopireddy <[email protected]> Co-authored-by: Manusaporn Treerungroj <[email protected]> Co-authored-by: Michael Dawson <[email protected]> Co-authored-by: Richard Chamberlain <[email protected]> Co-authored-by: Richard Lau <[email protected]> Co-authored-by: Sam Roberts <[email protected]> Co-authored-by: Vipin Menon <[email protected]> PR-URL: #22712 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]>

a separate section added for node-report at top level main documentation added to doc/api/report.md API documentation added to doc/api/process.md PR-URL: #22712 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]>

One test per each API, so that additional tests in future are modular. test/common/report.js contain common functions that tests leverage. PR-URL: #22712 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]>

Notable Changes: * events: * For unhandled `error` events with an argument that is not an `Error` object, the resulting exeption will have more information about the argument. #25621 * child_process: * When the `maxBuffer` option is passed, `stdout` and `stderr` will be truncated rather than unavailable in case of an error. #24951 * policy: * Experimental support for module integrity checks through a manifest file is implemented now. #23834 * n-api: * The `napi_threadsafe_function` feature is now stable. #25556 * report: * An experimental diagnostic API for capturing process state is available as `process.report` and through command line flags. #22712 * tls: * `tls.connect()` takes a `timeout` option analogous to the `net.connect()` one. #25517 * worker: * `process.umask()` is available as a read-only function inside Worker threads now. #25526 * An `execArgv` option that supports a subset of Node.js command line options is supported now. #25467 PR-URL: #25687

process.on('somesignal', ...) semantics expect the process to catch the signal and invoke the associated handler. `setupSignalHandlers` perform the additional task of preparing the libuv signal handler and associate it with the event handler. It is possible that by the time this is setup there could be pre-existing registrations that pre-date this setup in the boot sequence. So rearm pre-existing signal event registrations to get upto speed. Ref: #22712 (comment) PR-URL: #24651 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Franziska Hinkelmann <[email protected]> Reviewed-By: Joyee Cheung <[email protected]>

Remove `Node report in core` from Current list of initiatives, as this is achieved. Report has landed. Refs: nodejs/node#22712

Remove `Node report in core` from Current list of initiatives, as this is achieved. Report has landed. Refs: nodejs/node#22712 PR-URL: nodejs#286 Reviewed-By: Ali Ijaz Sheikh <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Michael Dawson <[email protected]>

nodejs-github-bot added the lib / src Issues and PRs related to general changes in the lib or src directory. label Sep 5, 2018

gireeshpunathil requested a review from addaleax September 5, 2018 15:51

gireeshpunathil requested review from BridgeAR and bnoordhuis September 5, 2018 15:51

mcollina reviewed Sep 5, 2018

View reviewed changes

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