Refactor stack trace cleaning

packages/build/src/error/clean_stack.js

@@ -11,7 +11,12 @@ const stripAnsi = require('strip-ansi')
 // Keep non stack trace lines as is.
 // We do not use libraries that patch `Error.prepareStackTrace()` because they
 // tend to create issues.
-const cleanStacks = function(string) {
+const cleanStacks = function(string, rawStack) {
+  // Internal errors / bugs keep their full stack trace
+  if (rawStack || string === undefined) {
+    return string
+  }
+
   return String(string)
     .split('\n')
     .reduce(cleanStackLine, '')

packages/build/src/error/serialize.js

@@ -30,14 +30,14 @@ const CLEANED_ERROR_PROPS = [INFO_SYM, 'requireStack']
 
 // Retrieve body to print in logs
 const getBody = function({
-  typeInfo: { stackType, getLocation, showErrorProps },
+  typeInfo: { stackType, getLocation, showErrorProps, rawStack },
   message,
   stack,
   errorProps,
   location = {},
   plugin = {},
 }) {
-  const { message: messageA, stack: stackA } = getStackInfo({ message, stack, stackType })
+  const { message: messageA, stack: stackA } = getStackInfo({ message, stack, stackType, rawStack })
   const messageBlock = { name: 'Error message', value: messageA }
   const pluginBlock = getPluginBlock(plugin)
   const locationBlock = getLocationBlock({ stack: stackA, location, getLocation })

packages/build/src/error/stack.js

@@ -1,30 +1,25 @@
 const { cleanStacks } = require('./clean_stack')
 
 // Retrieve the stack trace
-const getStackInfo = function({ message, stack, stackType }) {
+const getStackInfo = function({ message, stack, stackType, rawStack }) {
+  const { message: messageA, stack: stackA } = splitStackInfo({ message, stack, stackType })
+  const stackB = cleanStacks(stackA, rawStack)
+  return { message: messageA, stack: stackB }
+}
+
+const splitStackInfo = function({ message, stack, stackType }) {
   // Some errors should not show any stack trace
   if (stackType === 'none') {
     return { message }
   }
 
-  // Some errors should show `error.stack` as is, without cleaning it
-  if (stackType === 'stack') {
-    return splitStack(stack)
-  }
-
-  return splitStackInfo(message)
-}
-
-// Some errors have the stack trace inside `error.message` instead of
-// `error.stack` due to IPC
-const splitStackInfo = function(string) {
-  const { message, stack } = splitStack(string)
-  if (stack === undefined) {
-    return { message }
+  // Some errors have their stack trace inside `error.message` instead of
+  // `error.stack` due to IPC
+  if (stackType === 'message') {
+    return splitStack(message)
   }
 
-  const stackA = cleanStacks(stack)
-  return { message, stack: stackA }
+  return splitStack(stack)
 }
 
 const splitStack = function(string) {

packages/build/src/error/type.js

@@ -16,7 +16,7 @@ const TYPES = {
   pluginLoad: { header: 'Build failed', stackType: 'message', getLocation: getPluginLoadLocation },
   shellCommand: { header: 'Build failed', stackType: 'message', getLocation: getShellCommandLocation },
   pluginCommand: { header: 'Build failed', stackType: 'message', getLocation: getPluginCommandLocation },
-  internalError: { header: 'Internal error', stackType: 'stack', showErrorProps: true },
+  internalError: { header: 'Internal error', stackType: 'stack', showErrorProps: true, rawStack: true },
 }
 // When no error type matches, it's an uncaught exception, i.e. a bug
 const DEFAULT_TYPE = 'internalError'