Skip to content

node-report: meld into core#22712

Merged
gireeshpunathil merged 3 commits intonodejs:masterfrom
gireeshpunathil:nrmerge
Jan 18, 2019
Merged

node-report: meld into core#22712
gireeshpunathil merged 3 commits intonodejs:masterfrom
gireeshpunathil:nrmerge

Conversation

@gireeshpunathil
Copy link
Copy Markdown
Member

@gireeshpunathil gireeshpunathil commented Sep 5, 2018

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

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

c++ Issues and PRs that require attention from people who are familiar with C++. experimental Issues and PRs related to experimental features. lib / src Issues and PRs related to general changes in the lib or src directory. notable-change PRs with changes that should be highlighted in changelogs. report Issues and PRs related to process.report. semver-minor PRs that contain new features and should be released in the next minor version.

Projects

None yet

Development

Successfully merging this pull request may close these issues.