pino-http-print/test/cli.test.js

Debug HTTP printer for pino

'use strict'

const test = require('node:test')
const through = require('through2')
const strip = require('strip-ansi')

const { httpPrintFactory: printerFactory } = require('../')
const printer = printerFactory()

const log = JSON.stringify(require('./fixtures/http-log.json')) + '\n'
const customLevel = '{"pid":13961,"hostname":"MacBook-Pro-4","level":99,"time":1469122492244,"msg":"request completed","res":{"statusCode":200,"header":"HTTP/1.1 200 OK\\r\\ncontent-type: application/json; charset=utf-8\\r\\ncache-control: no-cache\\r\\nvary: accept-encoding\\r\\ncontent-encoding: gzip\\r\\ndate: Thu, 21 Jul 2016 17:34:52 GMT\\r\\nconnection: close\\r\\ntransfer-encoding: chunked\\r\\n\\r\\n"},"responseTime":17,"req":{"id":8,"method":"GET","url":"/api/activity/component","headers":{"host":"localhost:20000","connection":"keep-alive","cache-control":"max-age=0","accept":"application/json","user-agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","referer":"http://localhost:20000/","accept-encoding":"gzip, deflate, sdch","accept-language":"en-US,en;q=0.8,de;q=0.6","cookie":"_ga=GA1.1.204420087.1444842476"},"remoteAddress":"127.0.0.1","remotePort":61543},"v":1}\n'
const nonHttpLog = JSON.stringify(require('./fixtures/not-http-log.json')) + '\n'
const nonJSONLog = 'this is just some raw text that can\'t parse as JSON\n'

test('outputs log message for req/res serialized pino log', function (t, end) {
  t.plan(1)
  const expected = '[1469122492244] GET http://localhost:20000/api/activity/component 200 17ms\n'
  const p = printer(through(function (line) {
    t.assert.equal(strip(line.toString()), expected)
    end()
  }))
  p.write(log)
})

test('translates time when option is set', function (t, end) {
  t.plan(1)
  const translateTimePrinter = printerFactory({ translateTime: true })
  const expected = '[2016-07-21 17:34:52.244 +0000] GET http://localhost:20000/api/activity/component 200 17ms\n'
  const p = translateTimePrinter(through(function (line) {
    t.assert.equal(strip(line.toString()), expected)
    end()
  }))
  p.write(log)
})

test('use relative url when option is set', function (t, end) {
  t.plan(1)
  const relativeUrlPrinter = printerFactory({ relativeUrl: true })
  const expected = '[1469122492244] GET /api/activity/component 200 17ms\n'
  const p = relativeUrlPrinter(through(function (line) {
    t.assert.equal(strip(line.toString()), expected)
    end()
  }))
  p.write(log)
})

test('colorize when option is set (http log)', function (t, end) {
  t.plan(1)
  const coloredPrinter = printerFactory({ colorize: true })
  const expected = '[1469122492244] \u001B[36mGET\u001B[39m http://localhost:20000/api/activity/component \u001B[32m200\u001B[39m 17ms\n'
  const p = coloredPrinter(through(function (line) {
    t.assert.equal(line.toString(), expected)
    end()
  }))
  p.write(log)
})

test('colorize when option is set (non-http log)', function (t, end) {
  t.plan(1)
  const coloredPrinter = printerFactory({ colorize: true, all: true })
  const expected = '[1557721475837] \u001B[32mINFO\u001B[39m (48079 on MacBook-Pro-4): \u001B[36mThis is not a request/response log\u001B[39m\n    v: 1\n'
  const p = coloredPrinter(through(function (line) {
    t.assert.equal(line.toString(), expected)
    end()
  }))
  p.write(nonHttpLog)
})

test('colorize when option is set an fallback to default color level', function (t, end) {
  t.plan(1)
  const coloredPrinter = printerFactory({ colorize: true, all: true })
  const expected = '[1469122492244] \u001B[36mGET\u001B[39m http://localhost:20000/api/activity/component \u001B[37m200\u001B[39m 17ms\n'
  const p = coloredPrinter(through(function (line) {
    t.assert.equal(line.toString(), expected)
    end()
  }))
  p.write(customLevel)
})

test('not colorize when option is set (non-http log)', function (t, end) {
  t.plan(1)
  const coloredPrinter = printerFactory({ colorize: false })
  const expected = '[1469122492244] GET http://localhost:20000/api/activity/component 200 17ms\n'
  const p = coloredPrinter(through(function (line) {
    t.assert.equal(line.toString(), expected)
    end()
  }))
  p.write(log)
})

test('does not output non-http log messages by default', function (t, end) {
  t.plan(1)
  const printedLines = []

  const p = printer(through(function (line) {
    printedLines.push(line.toString())
  }))

  p.write(nonHttpLog)

  setImmediate(() => {
    t.assert.equal(printedLines.length, 0)
    end()
  })
})

test('outputs non-http log messages when `all` option is set to `true`', function (t, end) {
  t.plan(2)
  const expected = '[1557721475837] INFO (48079 on MacBook-Pro-4): This is not a request/response log\n    v: 1\n'
  const allPrinter = printerFactory({ all: true })

  const printedLines = []

  const p = allPrinter(through(function (line) {
    printedLines.push(strip(line.toString()))
  }))

  p.write(nonHttpLog)

  setImmediate(() => {
    t.assert.equal(printedLines.length, 1)
    t.assert.equal(printedLines[0], expected)
    end()
  })
})

test('passes options to pino-pretty when `all` option is set to `true`', function (t, end) {
  t.plan(2)
  const expected = '[2019-05-13 04:24:35.837 +0000] INFO (48079 on MacBook-Pro-4): This is not a request/response log\n    v: 1\n'
  const allPrinter = printerFactory({ all: true }, { translateTime: true })

  const printedLines = []

  const p = allPrinter(through(function (line) {
    printedLines.push(strip(line.toString()))
  }))

  p.write(nonHttpLog)

  setImmediate(() => {
    t.assert.equal(printedLines.length, 1)
    t.assert.equal(printedLines[0], expected)
    end()
  })
})

test('logs to process.stdout by default', function (t, end) {
  t.plan(1)
  const expected = '[1469122492244] GET http://localhost:20000/api/activity/component 200 17ms\n'
  const p = printer()
  const write = process.stdout.write
  process.stdout.write = function (chunk, enc, cb) {
    process.stdout.write = write
    t.assert.equal(strip(chunk.toString()), expected)
    end()
  }
  p.write(log)
})

test('disables parser strictness and discards invalid lines when the `lax` option is `true`', function (t, end) {
  t.plan(1)
  const allPrinter = printerFactory({ all: true, lax: true })

  const printedLines = []

  const p = allPrinter(through(function (line) {
    printedLines.push(strip(line.toString()))
  }))

  p.write(nonJSONLog)

  setImmediate(() => {
    t.assert.equal(printedLines.length, 0)
    end()
  })
})