lib: stop using prepareStackTrace

PR-URL: #29777
Reviewed-By: Ben Coe <bencoe@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

Author: devsnek

lib/assert.js

@@ -23,13 +23,16 @@
 const{ Object }=primordials;
 
 const{ Buffer }=require('buffer');
-const{codes: {
-ERR_AMBIGUOUS_ARGUMENT,
-ERR_INVALID_ARG_TYPE,
-ERR_INVALID_ARG_VALUE,
-ERR_INVALID_RETURN_VALUE,
-ERR_MISSING_ARGS
-}}=require('internal/errors');
+const{
+codes: {
+ERR_AMBIGUOUS_ARGUMENT,
+ERR_INVALID_ARG_TYPE,
+ERR_INVALID_ARG_VALUE,
+ERR_INVALID_RETURN_VALUE,
+ERR_MISSING_ARGS,
+},
+ overrideStackTrace,
+}=require('internal/errors');
 constAssertionError=require('internal/assert/assertion_error');
 const{ openSync, closeSync, readSync }=require('fs');
 const{ inspect }=require('internal/util/inspect');
@@ -261,10 +264,8 @@ function getErrMessage(message, fn) {
 Error.captureStackTrace(err,fn);
 Error.stackTraceLimit=tmpLimit;
 
-consttmpPrepare=Error.prepareStackTrace;
-Error.prepareStackTrace=(_,stack)=>stack;
+overrideStackTrace.set(err,(_,stack)=>stack);
 constcall=err.stack[0];
-Error.prepareStackTrace=tmpPrepare;
 
 constfilename=call.getFileName();
 constline=call.getLineNumber()-1;

lib/internal/errors.js

@@ -21,9 +21,18 @@ const { kMaxLength } = internalBinding('buffer');
 
 constMainContextError=Error;
 constErrorToString=Error.prototype.toString;
-// Polyfill of V8's Error.prepareStackTrace API.
-// https://crbug.com/v8/7848
+constoverrideStackTrace=newWeakMap();
 constprepareStackTrace=(globalThis,error,trace)=>{
+// API for node internals to override error stack formatting
+// without interfering with userland code.
+if(overrideStackTrace.has(error)){
+constf=overrideStackTrace.get(error);
+overrideStackTrace.delete(error);
+returnf(error,trace);
+}
+
+// Polyfill of V8's Error.prepareStackTrace API.
+// https://crbug.com/v8/7848
 // `globalThis` is the global that contains the constructor which
 // created `error`.
 if(typeofglobalThis.Error.prepareStackTrace==='function'){
@@ -36,6 +45,11 @@ const prepareStackTrace = (globalThis, error, trace) => {
 returnMainContextError.prepareStackTrace(error,trace);
 }
 
+// Normal error formatting:
+//
+// Error: Message
+// at function (file)
+// at file
 consterrorString=ErrorToString.call(error);
 if(trace.length===0){
 returnerrorString;
@@ -675,6 +689,7 @@ module.exports = {
 // This is exported only to facilitate testing.
  E,
  prepareStackTrace,
+ overrideStackTrace,
  kEnhanceStackBeforeInspector,
  fatalExceptionStackEnhancers
 };

lib/internal/util.js

@@ -7,7 +7,8 @@ const {
 ERR_NO_CRYPTO,
 ERR_UNKNOWN_SIGNAL
 },
- uvErrmapGet
+ uvErrmapGet,
+ overrideStackTrace,
 }=require('internal/errors');
 const{ signals }=internalBinding('constants').os;
 const{
@@ -338,15 +339,13 @@ function isInsideNodeModules() {
 // side-effect-free. Since this is currently only used for a deprecated API,
 // the perf implications should be okay.
 getStructuredStack=runInNewContext(`(function() {
- Error.prepareStackTrace = function(err, trace) {
- return trace;
- };
  Error.stackTraceLimit = Infinity;
-
  return function structuredStack() {
- return new Error().stack;
+ const e = new Error();
+ overrideStackTrace.set(e, (err, trace) => trace);
+ return e.stack;
  };
- })()`,{},{filename: 'structured-stack'});
+ })()`,{ overrideStackTrace },{filename: 'structured-stack'});
 }
 
 conststack=getStructuredStack();

lib/repl.js

@@ -69,12 +69,15 @@ const CJSModule = require('internal/modules/cjs/loader');
 constdomain=require('domain');
 constdebug=require('internal/util/debuglog').debuglog('repl');
 const{
-ERR_CANNOT_WATCH_SIGINT,
-ERR_INVALID_ARG_TYPE,
-ERR_INVALID_REPL_EVAL_CONFIG,
-ERR_INVALID_REPL_INPUT,
-ERR_SCRIPT_EXECUTION_INTERRUPTED
-}=require('internal/errors').codes;
+codes: {
+ERR_CANNOT_WATCH_SIGINT,
+ERR_INVALID_ARG_TYPE,
+ERR_INVALID_REPL_EVAL_CONFIG,
+ERR_INVALID_REPL_INPUT,
+ERR_SCRIPT_EXECUTION_INTERRUPTED,
+},
+ overrideStackTrace,
+}=require('internal/errors');
 const{ sendInspectorCommand }=require('internal/util/inspector');
 constexperimentalREPLAwait=require('internal/options').getOptionValue(
 '--experimental-repl-await'
@@ -473,10 +476,29 @@ function REPLServer(prompt,
 leterrStack='';
 
 if(typeofe==='object'&&e!==null){
-constpstrace=Error.prepareStackTrace;
-Error.prepareStackTrace=prepareStackTrace(pstrace);
+overrideStackTrace.set(e,(error,stackFrames)=>{
+letframes;
+if(typeofstackFrames==='object'){
+// Search from the bottom of the call stack to
+// find the first frame with a null function name
+constidx=stackFrames
+.reverse()
+.findIndex((frame)=>frame.getFunctionName()===null);
+// If found, get rid of it and everything below it
+frames=stackFrames.splice(idx+1);
+}else{
+frames=stackFrames;
+}
+// FIXME(devsnek): this is inconsistent with the checks
+// that the real prepareStackTrace dispatch uses in
+// lib/internal/errors.js.
+if(typeofError.prepareStackTrace==='function'){
+returnError.prepareStackTrace(error,frames);
+}
+frames.push(error);
+returnframes.reverse().join('\n at ');
+});
 decorateErrorStack(e);
-Error.prepareStackTrace=pstrace;
 
 if(e.domainThrown){
 deletee.domain;
@@ -590,30 +612,6 @@ function REPLServer(prompt,
 }
 }
 
-functionfilterInternalStackFrames(structuredStack){
-// Search from the bottom of the call stack to
-// find the first frame with a null function name
-if(typeofstructuredStack!=='object')
-returnstructuredStack;
-constidx=structuredStack.reverse().findIndex(
-(frame)=>frame.getFunctionName()===null);
-
-// If found, get rid of it and everything below it
-structuredStack=structuredStack.splice(idx+1);
-returnstructuredStack;
-}
-
-functionprepareStackTrace(fn){
-return(error,stackFrames)=>{
-constframes=filterInternalStackFrames(stackFrames);
-if(fn){
-returnfn(error,frames);
-}
-frames.push(error);
-returnframes.reverse().join('\n at ');
-};
-}
-
 function_parseREPLKeyword(keyword,rest){
 constcmd=this.commands[keyword];
 if(cmd){