process: split routines used to enhance fatal exception stack traces

Previously the enhancement were done right after emitting
`'uncaughtException'`, which meant by the time we knew the
exception was fatal in C++, the error.stack had already been
patched.

This patch moves those routines to be called later during the
fatal exception handling, and split them into two stages:
before and after the inspector is notified by the invocation of
`V8Inspector::exceptionThrown`. We now expand the stack to include
additional informations about unhandled 'error' events before
the inspector is notified, but delay the highlighting of the
frames until after the inspector is notified, so that the
ANSI escape sequences won't show up in the inspector console.

PR-URL: #28308
Fixes: #28287
Reviewed-By: Benjamin Gruenbaum <[email protected]>

Author: joyeecheung

lib/events.js

@@ -25,11 +25,15 @@ const { Math, Object, Reflect } = primordials;
 
 var spliceOne;
 
+const {
+  kEnhanceStackBeforeInspector,
+  codes
+} = require('internal/errors');
 const {
   ERR_INVALID_ARG_TYPE,
   ERR_OUT_OF_RANGE,
   ERR_UNHANDLED_ERROR
-} = require('internal/errors').codes;
+} = codes;
 
 const {
   inspect
@@ -142,8 +146,8 @@ function enhanceStackTrace(err, own) {
     ownStack.splice(off + 1, len - 2,
                     '    [... lines matching original stack trace ...]');
   }
-  // Do this last, because it is the only operation with side effects.
-  err.stack = err.stack + sep + ownStack.join('\n');
+
+  return err.stack + sep + ownStack.join('\n');
 }
 
 EventEmitter.prototype.emit = function emit(type, ...args) {
@@ -162,11 +166,10 @@ EventEmitter.prototype.emit = function emit(type, ...args) {
       er = args[0];
     if (er instanceof Error) {
       try {
-        const { kExpandStackSymbol } = require('internal/util');
         const capture = {};
         // eslint-disable-next-line no-restricted-syntax
         Error.captureStackTrace(capture, EventEmitter.prototype.emit);
-        Object.defineProperty(er, kExpandStackSymbol, {
+        Object.defineProperty(er, kEnhanceStackBeforeInspector, {
           value: enhanceStackTrace.bind(null, er, capture),
           configurable: true
         });

lib/internal/bootstrap/node.js

@@ -299,9 +299,22 @@ process.emitWarning = emitWarning;
 }
 
 function setupPrepareStackTrace() {
-  const { setPrepareStackTraceCallback } = internalBinding('errors');
-  const { prepareStackTrace } = require('internal/errors');
+  const {
+    setEnhanceStackForFatalException,
+    setPrepareStackTraceCallback
+  } = internalBinding('errors');
+  const {
+    prepareStackTrace,
+    fatalExceptionStackEnhancers: {
+      beforeInspector,
+      afterInspector
+    }
+  } = require('internal/errors');
+  // Tell our PrepareStackTraceCallback passed to the V8 API
+  // to call prepareStackTrace().
   setPrepareStackTraceCallback(prepareStackTrace);
+  // Set the function used to enhance the error stack for printing
+  setEnhanceStackForFatalException(beforeInspector, afterInspector);
 }
 
 function setupProcessObject() {

lib/internal/errors.js

@@ -622,6 +622,45 @@ function addNumericalSeparator(val) {
   return `${val.slice(0, i)}${res}`;
 }
 
+// Used to enhance the stack that will be picked up by the inspector
+const kEnhanceStackBeforeInspector = Symbol('kEnhanceStackBeforeInspector');
+
+// These are supposed to be called only on fatal exceptions before
+// the process exits.
+const fatalExceptionStackEnhancers = {
+  beforeInspector(error) {
+    if (typeof error[kEnhanceStackBeforeInspector] !== 'function') {
+      return error.stack;
+    }
+
+    try {
+      // Set the error.stack here so it gets picked up by the
+      // inspector.
+      error.stack = error[kEnhanceStackBeforeInspector]();
+    } catch {
+      // We are just enhancing the error. If it fails, ignore it.
+    }
+    return error.stack;
+  },
+  afterInspector(error) {
+    const originalStack = error.stack;
+    const {
+      inspect,
+      inspectDefaultOptions: {
+        colors: defaultColors
+      }
+    } = lazyInternalUtilInspect();
+    const colors = internalBinding('util').guessHandleType(2) === 'TTY' &&
+                   require('internal/tty').hasColors() ||
+                   defaultColors;
+    try {
+      return inspect(error, { colors });
+    } catch {
+      return originalStack;
+    }
+  }
+};
+
 module.exports = {
   addCodeToName, // Exported for NghttpError
   codes,
@@ -638,6 +677,8 @@ module.exports = {
   // This is exported only to facilitate testing.
   E,
   prepareStackTrace,
+  kEnhanceStackBeforeInspector,
+  fatalExceptionStackEnhancers
 };
 
 // To declare an error message, use the E(sym, val, def) function above. The sym

lib/internal/process/execution.js

@@ -150,10 +150,6 @@ function createOnGlobalUncaughtException() {
     } else if (!process.emit('uncaughtException', er, type)) {
       // If someone handled it, then great. Otherwise, die in C++ land
       // since that means that we'll exit the process, emit the 'exit' event.
-      const { inspect } = require('internal/util/inspect');
-      const colors = internalBinding('util').guessHandleType(2) === 'TTY' &&
-                     require('internal/tty').hasColors() ||
-                     inspect.defaultOptions.colors;
       try {
         if (!process._exiting) {
           process._exiting = true;
@@ -163,14 +159,6 @@ function createOnGlobalUncaughtException() {
       } catch {
         // Nothing to be done about it at this point.
       }
-      try {
-        const { kExpandStackSymbol } = require('internal/util');
-        if (typeof er[kExpandStackSymbol] === 'function')
-          er[kExpandStackSymbol]();
-        er.stack = inspect(er, { colors });
-      } catch {
-        // Nothing to be done about it at this point.
-      }
       return false;
     }
 

lib/internal/util.js

@@ -414,6 +414,5 @@ module.exports = {
   // Used by the buffer module to capture an internal reference to the
   // default isEncoding implementation, just in case userland overrides it.
   kIsEncodingSymbol: Symbol('kIsEncodingSymbol'),
-  kExpandStackSymbol: Symbol('kExpandStackSymbol'),
   kVmBreakFirstLineSymbol: Symbol('kVmBreakFirstLineSymbol')
 };

lib/internal/util/inspect.js

@@ -1683,5 +1683,6 @@ function formatWithOptions(inspectOptions, ...args) {
 module.exports = {
   inspect,
   format,
-  formatWithOptions
+  formatWithOptions,
+  inspectDefaultOptions
 };

src/env.h

@@ -408,6 +408,8 @@ constexpr size_t kFsStatsBufferLength =
   V(crypto_key_object_constructor, v8::Function)                               \
   V(domain_callback, v8::Function)                                             \
   V(domexception_function, v8::Function)                                       \
+  V(enhance_fatal_stack_after_inspector, v8::Function)                         \
+  V(enhance_fatal_stack_before_inspector, v8::Function)                        \
   V(fs_use_promises_symbol, v8::Symbol)                                        \
   V(host_import_module_dynamically_callback, v8::Function)                     \
   V(host_initialize_import_meta_object_callback, v8::Function)                 \

src/inspector_agent.cc

@@ -570,7 +570,7 @@ class NodeInspectorClient : public V8InspectorClient {
     }
   }
 
-  void FatalException(Local<Value> error, Local<Message> message) {
+  void ReportUncaughtException(Local<Value> error, Local<Message> message) {
     Isolate* isolate = env_->isolate();
     Local<Context> context = env_->context();
 
@@ -836,10 +836,11 @@ void Agent::WaitForDisconnect() {
   }
 }
 
-void Agent::FatalException(Local<Value> error, Local<Message> message) {
+void Agent::ReportUncaughtException(Local<Value> error,
+                                    Local<Message> message) {
   if (!IsListening())
     return;
-  client_->FatalException(error, message);
+  client_->ReportUncaughtException(error, message);
   WaitForDisconnect();
 }
 

src/inspector_agent.h

@@ -65,8 +65,8 @@ class Agent {
   void WaitForConnect();
   // Blocks till all the sessions with "WaitForDisconnectOnShutdown" disconnect
   void WaitForDisconnect();
-  void FatalException(v8::Local<v8::Value> error,
-                      v8::Local<v8::Message> message);
+  void ReportUncaughtException(v8::Local<v8::Value> error,
+                               v8::Local<v8::Message> message);
 
   // Async stack traces instrumentation.
   void AsyncTaskScheduled(const v8_inspector::StringView& taskName, void* task,