fix: show stack trace in errlog

Author: jdx

src/errors.ts

@@ -35,7 +35,18 @@ function bangify(msg: string, c: string): string {
   return lines.join('\n')
 }
 
-export function getErrorMessage(err: any): string {
+export function getErrorMessage(err: any, opts: {stack?: boolean} = {}): string {
+  const severity = (err['cli-ux'] && err['cli-ux'].severity) || 'error'
+  const context = err['cli-ux'] && err['cli-ux'].context
+
+  function wrap(msg: string): string {
+    const linewrap = require('@heroku/linewrap')
+    return linewrap(6, deps.screen.errtermwidth, {
+      skip: /^\$ .*$/,
+      skipScheme: 'ansi-color',
+    })(msg)
+  }
+
   let message
   if (err.body) {
     // API error
@@ -46,54 +57,43 @@ export function getErrorMessage(err: any): string {
     }
   }
   // Unhandled error
-  if (err.message && err.code) {
-    message = `${inspect(err.code)}: ${err.message}`
-  } else if (err.message) {
-    message = err.message
-  }
-  const context = err['cli-ux'] && err['cli-ux'].context
+  if (err.message) message = err.message
   if (context && !_.isEmpty(context)) {
     message += '\n' + indent(styledObject(err['cli-ux'].context), 4)
   }
-  return message || inspect(err)
-}
-
-function displayError(err: CLIError) {
-  function wrap(msg: string): string {
-    const linewrap = require('@heroku/linewrap')
-    return linewrap(6, deps.screen.errtermwidth, {
-      skip: /^\$ .*$/,
-      skipScheme: 'ansi-color',
-    })(msg)
-  }
-
-  function render(): string {
-    const severity = (err['cli-ux'] && err['cli-ux'].severity) || 'error'
-    const msg = [
-      _.upperFirst(severity === 'warn' ? 'warning' : severity),
-      ': ',
-      getErrorMessage(err),
-    ].join('')
-    if (process.env.CI || severity === 'fatal' || config.debug) {
-      // show stack trace
-      let stack = err.stack || inspect(err)
-      stack = clean(stack, {pretty: true})
-      stack = extract(stack)
-      return [msg, stack].join('\n')
-    }
+  message = message || inspect(err)
+
+  message = [
+    _.upperFirst(severity === 'warn' ? 'warning' : severity),
+    ': ',
+    message,
+  ].join('')
+
+  if (opts.stack || process.env.CI || severity === 'fatal' || config.debug) {
+    // show stack trace
+    let stack = err.stack || inspect(err)
+    stack = clean(stack, {pretty: true})
+    stack = extract(stack)
+    message = [message, stack].join('\n')
+  } else {
     let bang = severity === 'warn' ? chalk.yellow(arrow) : chalk.red(arrow)
     if (severity === 'warn') bang = chalk.yellow(arrow)
-    return bangify(wrap(msg), bang)
+    message = bangify(wrap(message), bang)
   }
+  return message
+}
+
+function displayError(err: CLIError) {
+  const severity = (err['cli-ux'] && err['cli-ux'].severity) || 'error'
 
   function getBang(): string {
-    if (err['cli-ux'].severity === 'warn') return chalk.yellowBright('!')
-    if (err['cli-ux'].severity === 'fatal') return chalk.bold.bgRedBright('!!!')
+    if (severity === 'warn') return chalk.yellowBright('!')
+    if (severity === 'fatal') return chalk.bold.bgRedBright('!!!')
     return chalk.bold.redBright('!')
   }
 
   config.action.pause(() => {
-    console.error(render())
+    console.error(getErrorMessage(err))
   }, getBang())
 }
 

src/logger.ts

@@ -1,5 +1,4 @@
 import * as fs from 'fs-extra'
-import * as _ from 'lodash'
 import * as path from 'path'
 
 import {config} from './config'
@@ -43,16 +42,17 @@ export default (e: IEventEmitter) => {
 
   const handleOutput = (m: Output.Message | Errors.Message) => {
     if (!canWrite(m.severity)) return
-    const msg = m.type === 'error' ? Errors.getErrorMessage(m.error) : Output.render(m)
-    const output = chomp(_([timestamp(), m.severity.toUpperCase(), msg]).compact().join(' '))
-    buffer.push(deps.stripAnsi(output))
+    let msg = m.type === 'error' ? Errors.getErrorMessage(m.error, {stack: true}) : Output.render(m)
+    msg = deps.stripAnsi(chomp(msg))
+    let lines = msg.split('\n').map(l => `${timestamp()} ${l}`)
+    buffer.push(...lines)
     flush(50).catch(console.error)
   }
   e.on('output', handleOutput)
 
   async function flush(waitForMs: number = 0) {
+    await wait(waitForMs)
     flushing = flushing.then(async () => {
-      await wait(waitForMs)
       if (!config.errlog || buffer.length === 0) return
       const file = config.errlog
       const mylines = buffer

test/logger.test.ts

@@ -21,7 +21,7 @@ describe('logger', () => {
     cli.info('hideme')
     cli.error('showerror', {exit: false})
     await cli.done()
-    expect(fs.readFileSync(cli.config.errlog!, 'utf8')).to.contain(' ERROR showerror')
+    expect(fs.readFileSync(cli.config.errlog!, 'utf8')).to.contain(' Warning: showwarning')
   })
 
   fancy
@@ -34,7 +34,7 @@ describe('logger', () => {
     cli.debug('hideme')
     cli.error('showerror', {exit: false})
     await cli.done()
-    expect(fs.readFileSync(cli.config.errlog!, 'utf8')).to.contain(' ERROR showerror')
+    expect(fs.readFileSync(cli.config.errlog!, 'utf8')).to.contain(' Error: showerror')
   })
 
   fancy