|
| 1 | +'use strict'; |
| 2 | + |
| 3 | +const{ emitExperimentalWarning }=require('internal/util'); |
| 4 | +const{ |
| 5 | +ERR_INVALID_ARG_TYPE, |
| 6 | +ERR_SYNTHETIC}=require('internal/errors').codes; |
| 7 | + |
| 8 | +exports.setup=function(){ |
| 9 | +constREPORTEVENTS=1; |
| 10 | +constREPORTSIGNAL=2; |
| 11 | +constREPORTFILENAME=3; |
| 12 | +constREPORTPATH=4; |
| 13 | +constREPORTVERBOSE=5; |
| 14 | +if(internalBinding('config').hasReport){ |
| 15 | +// If report is enabled, extract the binding and |
| 16 | +// wrap the APIs with thin layers, with some error checks. |
| 17 | +// user options can come in from CLI / ENV / API. |
| 18 | +// CLI and ENV is intercepted in C++ and the API call here (JS). |
| 19 | +// So sync up with both sides as appropriate - initially from |
| 20 | +// C++ to JS and from JS to C++ whenever the API is called. |
| 21 | +// Some events are controlled purely from JS (signal | exception) |
| 22 | +// and some from C++ (fatalerror) so this sync-up is essential for |
| 23 | +// correct behavior and alignment with the supplied tunables. |
| 24 | +constnr=internalBinding('report'); |
| 25 | + |
| 26 | +// Keep it un-exposed; lest programs play with it |
| 27 | +// leaving us with a lot of unwanted sanity checks. |
| 28 | +letconfig={ |
| 29 | +events: [], |
| 30 | +signal: 'SIGUSR2', |
| 31 | +filename: '', |
| 32 | +path: '', |
| 33 | +verbose: false |
| 34 | +}; |
| 35 | +constreport={ |
| 36 | +setDiagnosticReportOptions(options){ |
| 37 | +emitExperimentalWarning('report'); |
| 38 | +// Reuse the null and undefined checks. Save |
| 39 | +// space when dealing with large number of arguments. |
| 40 | +constlist=parseOptions(options); |
| 41 | + |
| 42 | +// Flush the stale entries from report, as |
| 43 | +// we are refreshing it, items that the users did not |
| 44 | +// touch may be hanging around stale otherwise. |
| 45 | +config={}; |
| 46 | + |
| 47 | +// The parseOption method returns an array that include |
| 48 | +// the indices at which valid params are present. |
| 49 | +list.forEach((i)=>{ |
| 50 | +switch(i){ |
| 51 | +caseREPORTEVENTS: |
| 52 | +if(Array.isArray(options.events)) |
| 53 | +config.events=options.events; |
| 54 | +else |
| 55 | +thrownewERR_INVALID_ARG_TYPE('events', |
| 56 | +'Array', |
| 57 | +options.events); |
| 58 | +break; |
| 59 | +caseREPORTSIGNAL: |
| 60 | +if(typeofoptions.signal!=='string'){ |
| 61 | +thrownewERR_INVALID_ARG_TYPE('signal', |
| 62 | +'String', |
| 63 | +options.signal); |
| 64 | +} |
| 65 | +process.removeListener(config.signal,handleSignal); |
| 66 | +if(config.events.includes('signal')) |
| 67 | +process.on(options.signal,handleSignal); |
| 68 | +config.signal=options.signal; |
| 69 | +break; |
| 70 | +caseREPORTFILENAME: |
| 71 | +if(typeofoptions.filename!=='string'){ |
| 72 | +thrownewERR_INVALID_ARG_TYPE('filename', |
| 73 | +'String', |
| 74 | +options.filename); |
| 75 | +} |
| 76 | +config.filename=options.filename; |
| 77 | +break; |
| 78 | +caseREPORTPATH: |
| 79 | +if(typeofoptions.path!=='string') |
| 80 | +thrownewERR_INVALID_ARG_TYPE('path','String',options.path); |
| 81 | +config.path=options.path; |
| 82 | +break; |
| 83 | +caseREPORTVERBOSE: |
| 84 | +if(typeofoptions.verbose!=='string'&& |
| 85 | +typeofoptions.verbose!=='boolean'){ |
| 86 | +thrownewERR_INVALID_ARG_TYPE('verbose', |
| 87 | +'Booelan | String'+ |
| 88 | +' (true|false|yes|no)', |
| 89 | +options.verbose); |
| 90 | +} |
| 91 | +config.verbose=options.verbose; |
| 92 | +break; |
| 93 | +} |
| 94 | +}); |
| 95 | +// Upload this new config to C++ land |
| 96 | +nr.syncConfig(config,true); |
| 97 | +}, |
| 98 | + |
| 99 | + |
| 100 | +triggerReport(file,err){ |
| 101 | +emitExperimentalWarning('report'); |
| 102 | +if(err==null){ |
| 103 | +if(file==null){ |
| 104 | +returnnr.triggerReport(newERR_SYNTHETIC( |
| 105 | +'JavaScript Callstack').stack); |
| 106 | +} |
| 107 | +if(typeoffile!=='string') |
| 108 | +thrownewERR_INVALID_ARG_TYPE('file','String',file); |
| 109 | +returnnr.triggerReport(file,newERR_SYNTHETIC( |
| 110 | +'JavaScript Callstack').stack); |
| 111 | +} |
| 112 | +if(typeoferr!=='object') |
| 113 | +thrownewERR_INVALID_ARG_TYPE('err','Object',err); |
| 114 | +if(file==null) |
| 115 | +returnnr.triggerReport(err.stack); |
| 116 | +if(typeoffile!=='string') |
| 117 | +thrownewERR_INVALID_ARG_TYPE('file','String',file); |
| 118 | +returnnr.triggerReport(file,err.stack); |
| 119 | +}, |
| 120 | +getReport(err){ |
| 121 | +emitExperimentalWarning('report'); |
| 122 | +if(err==null){ |
| 123 | +returnnr.getReport(newERR_SYNTHETIC('JavaScript Callstack').stack); |
| 124 | +}elseif(typeoferr!=='object'){ |
| 125 | +thrownewERR_INVALID_ARG_TYPE('err','Objct',err); |
| 126 | +}else{ |
| 127 | +returnnr.getReport(err.stack); |
| 128 | +} |
| 129 | +} |
| 130 | +}; |
| 131 | + |
| 132 | +// Download the CLI / ENV config into JS land. |
| 133 | +nr.syncConfig(config,false); |
| 134 | + |
| 135 | +functionhandleSignal(signo){ |
| 136 | +if(typeofsigno!=='string') |
| 137 | +signo=config.signal; |
| 138 | +nr.onUserSignal(signo); |
| 139 | +} |
| 140 | + |
| 141 | +if(config.events.includes('signal')){ |
| 142 | +process.on(config.signal,handleSignal); |
| 143 | +} |
| 144 | + |
| 145 | +functionparseOptions(obj){ |
| 146 | +constlist=[]; |
| 147 | +if(obj==null) |
| 148 | +returnlist; |
| 149 | +if(obj.events!=null) |
| 150 | +list.push(REPORTEVENTS); |
| 151 | +if(obj.signal!=null) |
| 152 | +list.push(REPORTSIGNAL); |
| 153 | +if(obj.filename!=null) |
| 154 | +list.push(REPORTFILENAME); |
| 155 | +if(obj.path!=null) |
| 156 | +list.push(REPORTPATH); |
| 157 | +if(obj.verbose!=null) |
| 158 | +list.push(REPORTVERBOSE); |
| 159 | +returnlist; |
| 160 | +} |
| 161 | +process.report=report; |
| 162 | +} |
| 163 | +}; |
0 commit comments