pino-http-print/lib/utils.js

Debug HTTP printer for pino

'use strict'

const colorette = require('colorette')
const { prettifyTime } = require('pino-pretty/lib/utils')
const prettyMs = require('pretty-ms')

const colored = {
  default: colorette.white,
  60: colorette.bgRed,
  50: colorette.red,
  40: colorette.yellow,
  30: colorette.green,
  20: colorette.blue,
  10: colorette.gray,
  method: colorette.cyan
}
/**
 * @typedef {Object} HttpPrintOptions
 * @property {boolean} [all] support all log messages, not just HTTP logs
 * @property {boolean} [colorize] colorize logs, default is automatically set by colorette.isColorSupported
 * @property {boolean|string} [translateTime] (default: false) When `true` the timestamp will be prettified into a string,
 *  When false the epoch time will be printed, other valid options are same as for `pino-pretty`
 * @property {boolean} [relativeUrl] (default: false)
 * @property {boolean} [lax] (default: false) When `true` the JSON parser will silently discard unparseable logs, e.g.
 * from nodemon
 */

/** @type {HttpPrintOptions} */
const defaultOptions = {
  colorize: colorette.isColorSupported,
  translateTime: false,
  relativeUrl: false,
  all: false,
  lax: false
}

/**
 * @param {any} o
 * @param {HttpPrintOptions} opts
 */

function format (o, opts) {
  const time = prettifyTime({
    log: o,
    context: {
      timestampKey: 'time',
      // When `translateTime` is `true`, `pino-pretty` will use the `DATE_FORMAT_SIMPLE`
      // format. This module expects it to be the `DATE_FORMAT` format.
      translateTime: opts.translateTime === true ? 'yyyy-mm-dd HH:MM:ss.l o' : opts.translateTime
    }
  })
  const url = (opts.relativeUrl ? '' : ('http://' + o.req.headers.host)) + o.req.url
  const responseTime = prettyMs(o.responseTime)

  if (!opts.colorize) {
    return time + ' ' + o.req.method + ' ' + url + ' ' + o.res.statusCode + ' ' + responseTime + '\n'
  }

  const levelColor = colored[o.level] || colored.default
  return time + ' ' + colored.method(o.req.method) + ' ' +
    url + ' ' + levelColor(o.res.statusCode) + ' ' + responseTime + '\n'
}

module.exports = {
  defaultOptions,
  format
}