All files / lib/utils error-handler.js

100% Statements 131/131
100% Branches 82/82
100% Functions 13/13
100% Lines 129/129

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225    5x 5x 5x 5x 5x 5x 5x 5x 5x 5x   5x     5x 21x 5x   21x     5x         5x 2x 1x   1x     5x 8x 8x 8x 7x 7x 7x             8x   8x 2x 8x 4x   4x 1x 1x 1x 1x 1x     4x 2x   8x 4x 8x   7x 1x   7x             7x       8x 1x   8x 7x     5x 14x   14x 14x 2x   14x 7x             7x 7x       14x 7x   7x     5x 12x 12x   2x 2x     12x 8x   12x 1x 1x 1x 1x     12x 12x 1x 11x 1x 1x 10x 1x 1x     9x 4x 4x     9x 36x 36x 8x     9x   9x 9x 9x 9x 9x 9x   9x 54x 54x 8x     9x 9x 18x   9x 1x             1x     9x     5x   5x 12x 5x   7x   7x 7x 7x 106x 106x 38x 106x   106x 152x   152x     7x     7x 7x           5x 5x  
'use strict'
 
let cbCalled = false
const log = require('npmlog')
const npm = require('../npm.js')
let itWorked = false
const path = require('path')
let wroteLogFile = false
let exitCode = 0
const errorMessage = require('./error-message.js')
const replaceInfo = require('./replace-info.js')
const stopMetrics = require('./metrics.js').stop
 
const cacheFile = require('./cache-file.js')
 
let logFileName
const getLogFile = () => {
  if (!logFileName)
    logFileName = path.resolve(npm.config.get('cache'), '_logs', (new Date()).toISOString().replace(/[.:]/g, '_') + '-debug.log')
 
  return logFileName
}
 
const timings = {
  version: npm.version,
  command: process.argv.slice(2),
  logfile: null,
}
process.on('timing', (name, value) => {
  if (timings[name])
    timings[name] += value
  else
    timings[name] = value
})
 
process.on('exit', code => {
  process.emit('timeEnd', 'npm')
  log.disableProgress()
  if (npm.config && npm.config.loaded && npm.config.get('timing')) {
    try {
      timings.logfile = getLogFile()
      cacheFile.append('_timing.json', JSON.stringify(timings) + '\n')
    } catch (_) {
      // ignore
    }
  }
 
  // kill any outstanding stats reporter if it hasn't finished yet
  stopMetrics()
 
  if (code)
    itWorked = false
  if (itWorked)
    log.info('ok')
  else {
    if (!cbCalled) {
      log.error('', 'cb() never called!')
      console.error('')
      log.error('', 'This is an error with npm itself. Please report this error at:')
      log.error('', '    <https://github.com/npm/cli/issues>')
      writeLogFile()
    }
 
    if (code)
      log.verbose('code', code)
  }
  if (npm.config && npm.config.loaded && npm.config.get('timing') && !wroteLogFile)
    writeLogFile()
  if (wroteLogFile) {
    // just a line break
    if (log.levels[log.level] <= log.levels.error)
      console.error('')
 
    log.error(
      '',
      [
        'A complete log of this run can be found in:',
        '    ' + getLogFile(),
      ].join('\n')
    )
    wroteLogFile = false
  }
 
  // actually exit.
  if (exitCode === 0 && !itWorked)
    exitCode = 1
 
  if (exitCode !== 0)
    process.exit(exitCode)
})
 
const exit = (code, noLog) => {
  exitCode = exitCode || process.exitCode || code
 
  log.verbose('exit', code)
  if (log.level === 'silent')
    noLog = true
 
  const reallyExit = () => {
    itWorked = !code
 
    // Exit directly -- nothing in the CLI should still be running in the
    // background at this point, and this makes sure anything left dangling
    // for whatever reason gets thrown away, instead of leaving the CLI open
    //
    // Commands that expect long-running actions should just delay `cb()`
    process.stdout.write('', () => {
      process.exit(code)
    })
  }
 
  if (code && !noLog)
    writeLogFile()
  else
    reallyExit()
}
 
const errorHandler = (er) => {
  log.disableProgress()
  if (!npm.config || !npm.config.loaded) {
    // logging won't work unless we pretend that it's ready
    er = er || new Error('Exit prior to config file resolving.')
    console.error(er.stack || er.message)
  }
 
  if (cbCalled)
    er = er || new Error('Callback called more than once.')
 
  if (npm.updateNotification) {
    const { level } = log
    log.level = log.levels.notice
    log.notice('', npm.updateNotification)
    log.level = level
  }
 
  cbCalled = true
  if (!er)
    return exit(0)
  if (typeof er === 'string') {
    log.error('', er)
    return exit(1, true)
  } else if (!(er instanceof Error)) {
    log.error('weird error', er)
    return exit(1, true)
  }
 
  if (!er.code) {
    const matchErrorCode = er.message.match(/^(?:Error: )?(E[A-Z]+)/)
    er.code = matchErrorCode && matchErrorCode[1]
  }
 
  for (const k of ['type', 'stack', 'statusCode', 'pkgid']) {
    const v = er[k]
    if (v)
      log.verbose(k, replaceInfo(v))
  }
 
  log.verbose('cwd', process.cwd())
 
  const os = require('os')
  const args = replaceInfo(process.argv)
  log.verbose('', os.type() + ' ' + os.release())
  log.verbose('argv', args.map(JSON.stringify).join(' '))
  log.verbose('node', process.version)
  log.verbose('npm ', 'v' + npm.version)
 
  for (const k of ['code', 'syscall', 'file', 'path', 'dest', 'errno']) {
    const v = er[k]
    if (v)
      log.error(k, v)
  }
 
  const msg = errorMessage(er)
  for (const errline of [...msg.summary, ...msg.detail])
    log.error(...errline)
 
  if (npm.config && npm.config.get('json')) {
    const error = {
      error: {
        code: er.code,
        summary: messageText(msg.summary),
        detail: messageText(msg.detail),
      },
    }
    console.error(JSON.stringify(error, null, 2))
  }
 
  exit(typeof er.errno === 'number' ? er.errno : typeof er.code === 'number' ? er.code : 1)
}
 
const messageText = msg => msg.map(line => line.slice(1).join(' ')).join('\n')
 
const writeLogFile = () => {
  if (wroteLogFile)
    return
 
  const os = require('os')
 
  try {
    let logOutput = ''
    log.record.forEach(m => {
      const p = [m.id, m.level]
      if (m.prefix)
        p.push(m.prefix)
      const pref = p.join(' ')
 
      m.message.trim().split(/\r?\n/)
        .map(line => (pref + ' ' + line).trim())
        .forEach(line => {
          logOutput += line + os.EOL
        })
    })
    cacheFile.write(getLogFile(), logOutput)
 
    // truncate once it's been written.
    log.record.length = 0
    wroteLogFile = true
  } catch (ex) {
 
  }
}
 
module.exports = errorHandler
module.exports.exit = exit