Pass original error to log() option

Author: ehmicky

README.md

@@ -99,7 +99,7 @@ other `require`/`import` statements.
 
 ## log
 
-_Type_: `function(error, level)`
+_Type_: `function(error, level, originalError)`
 
 Customizes how process errors are logged.\
 [Full documentation](docs/API.md#log).

docs/API.md

@@ -42,7 +42,7 @@ _Type_: `object`
 
 #### log
 
-_Type_: `function(error, level)`
+_Type_: `function(error, level, originalError)`
 
 By default process errors will be logged to the console using `console.error()`,
 `console.warn()`, etc.
@@ -52,13 +52,14 @@ process errors with [Winston](https://github.com/winstonjs/winston) instead:
 
 ```js
 logProcessErrors({
-  log(error, level) {
+  log(error, level, originalError) {
     winstonLogger[level](error.stack)
   },
 })
 ```
 
-The function's arguments are [`error`](#error) and [`level`](#level).
+The function's arguments are [`error`](#error), [`level`](#level) and
+[`originalError`](#error).
 
 If logging is asynchronous, the function should return a promise (or use
 `async`/`await`). This is not necessary if logging is using streams (like
@@ -215,6 +216,10 @@ _Type_: `Error`
 The [`log`](#log) and [`level`](#level) options receive as argument an `error`
 instance.
 
+This error is generated based on the original process error but with an improved
+`name`, `message` and `stack`. However the original process error is still
+available as a third argument to [`log`](#log).
+
 #### error.name
 
 _Type_: `string`\

src/error/main.js

@@ -14,7 +14,7 @@ export const getError = function ({ name, event }) {
   const staticProps = getEventProps(mainValue)
   const stackA = getStack(mainValue)
   const error = buildError({ name, message, stack: stackA, staticProps })
-  return { error, stack: stackA }
+  return { error, stack: stackA, mainValue }
 }
 
 // Retrieve main thrown value, which is most likely an `Error` instance

src/handle/common.js

@@ -39,7 +39,7 @@ export const handleEvent = async function ({
 }
 
 const logEvent = async function ({ opts, name, event }) {
-  const { error, stack } = getError({ name, event })
+  const { error, stack, mainValue } = getError({ name, event })
 
   const level = getLevel({ opts, name, error })
 
@@ -50,5 +50,5 @@ const logEvent = async function ({ opts, name, event }) {
   addErrorPrint({ error, opts, level, name, stack })
 
   // See `exit.js` on why we need to `await`
-  await opts.log(error, level)
+  await opts.log(error, level, mainValue)
 }

test/log.js

@@ -12,12 +12,13 @@ import { removeProcessListeners } from './helpers/remove.js'
 
 removeProcessListeners()
 
-const snapshotArgs = function ([error, level]) {
+const snapshotArgs = function ([error, level, mainValue]) {
   return [
     normalizeMessage(inspect(error), { colors: false }),
     String(error),
     Object.keys(error),
     level,
+    mainValue,
   ]
 }
 

test/snapshots/log.js.md

@@ -18,6 +18,9 @@ Generated by [AVA](https://avajs.dev).
       Then rejected with: Error: message`,
       [],
       'info',
+      Error {
+        message: 'message',
+      },
       `i  multipleResolves (a promise was resolved multiple times) ␊
       Initially resolved with: { success: true }␊
       Then resolved again with: { success: true }`,
@@ -26,6 +29,9 @@ Generated by [AVA](https://avajs.dev).
       Then resolved again with: { success: true }`,
       [],
       'info',
+      {
+        success: true,
+      },
       `i  multipleResolves (a promise was  multiple times) ␊
       Initially rejected with: Error: message␊
       Then resolved with: { success: true }`,
@@ -34,6 +40,9 @@ Generated by [AVA](https://avajs.dev).
       Then resolved with: { success: true }`,
       [],
       'info',
+      {
+        success: true,
+      },
       `i  multipleResolves (a promise was rejected multiple times) ␊
       Initially rejected with: Error: message␊
       Then rejected again with: Error: message␊
@@ -43,6 +52,9 @@ Generated by [AVA](https://avajs.dev).
       Then rejected again with: Error: message`,
       [],
       'info',
+      Error {
+        message: 'message',
+      },
     ]
 
 ## should fire opts.log() with arguments | rejectionHandled
@@ -55,6 +67,9 @@ Generated by [AVA](https://avajs.dev).
       'RejectionHandled: a promise was rejected and handled too late: Error: message',
       [],
       'error',
+      Error {
+        message: 'message',
+      },
     ]
 
 ## should fire opts.log() with arguments | uncaughtException
@@ -67,6 +82,9 @@ Generated by [AVA](https://avajs.dev).
       'UncaughtException: an exception was thrown but not caught: Error: message',
       [],
       'error',
+      Error {
+        message: 'message',
+      },
     ]
 
 ## should fire opts.log() with arguments | unhandledRejection
@@ -79,6 +97,9 @@ Generated by [AVA](https://avajs.dev).
       'UnhandledRejection: a promise was rejected but not handled: Error: message',
       [],
       'error',
+      Error {
+        message: 'message',
+      },
     ]
 
 ## should fire opts.log() with arguments | warning
@@ -96,6 +117,11 @@ Generated by [AVA](https://avajs.dev).
         'detail',
       ],
       'warn',
+      WarningType (Error) {
+        code: '500',
+        detail: 'Detail',
+        message: 'message',
+      },
       `‼  warning (WarningType1)  message␊
       [500] ␊
           at STACK TRACE`,
@@ -105,6 +131,10 @@ Generated by [AVA](https://avajs.dev).
         'code',
       ],
       'warn',
+      WarningType1 (Error) {
+        code: '500',
+        message: 'message',
+      },
       `‼  warning (WarningType2)  message␊
       Detail␊
           at STACK TRACE`,
@@ -114,9 +144,16 @@ Generated by [AVA](https://avajs.dev).
         'detail',
       ],
       'warn',
+      WarningType2 (Error) {
+        detail: 'Detail',
+        message: 'message',
+      },
       `‼  warning (WarningType3)  message␊
           at STACK TRACE`,
       'Warning: WarningType3: message',
       [],
       'warn',
+      WarningType3 (Error) {
+        message: 'message',
+      },
     ]