Skip to content

node-report: meld into core

Rodrigo Muino Tomonari requested to merge github/fork/gireeshpunathil/nrmerge into master
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.

  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 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 (closed) Refs: https://github.com/nodejs/node-report/issues/103

additional /cc

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

Merge request reports