tap_stream.js

// https://github.com/nodejs/node/blob/232efb06fe8787e9573e298ce7ac293ad23b7684/lib/internal/test_runner/tap_stream.js

'use strict'

const {
  ArrayPrototypeForEach,
  ArrayPrototypeJoin,
  ArrayPrototypeMap,
  ArrayPrototypePush,
  ArrayPrototypeShift,
  ObjectEntries,
  StringPrototypeReplaceAll,
  StringPrototypeToUpperCase,
  StringPrototypeSplit,
  RegExpPrototypeSymbolReplace
} = require('#internal/per_context/primordials')
const { inspectWithNoCustomRetry } = require('#internal/errors')
const Readable = require('#internal/streams/readable')
const { isError, kEmptyObject } = require('#internal/util')
const kFrameStartRegExp = /^ {4}at /
const kLineBreakRegExp = /\n|\r\n/
const kDefaultTAPVersion = 13
const inspectOptions = { colors: false, breakLength: Infinity }
let testModule // Lazy loaded due to circular dependency.

function lazyLoadTest () {
  testModule = testModule ?? require('#internal/test_runner/test')

  return testModule
}

class TapStream extends Readable {
  #buffer
  #canPush

  constructor () {
    super()
    this.#buffer = []
    this.#canPush = true
  }

  _read () {
    this.#canPush = true

    while (this.#buffer.length > 0) {
      const line = ArrayPrototypeShift(this.#buffer)

      if (!this.#tryPush(line)) {
        return
      }
    }
  }

  bail (message) {
    this.#tryPush(`Bail out!${message ? ` ${tapEscape(message)}` : ''}\n`)
  }

  fail (indent, testNumber, name, details, directive) {
    this.emit('test:fail', { __proto__: null, name, testNumber, details, ...directive })
    this.#test(indent, testNumber, 'not ok', name, directive)
    this.#details(indent, details)
  }

  ok (indent, testNumber, name, details, directive) {
    this.emit('test:pass', { __proto__: null, name, testNumber, details, ...directive })
    this.#test(indent, testNumber, 'ok', name, directive)
    this.#details(indent, details)
  }

  plan (indent, count, explanation) {
    const exp = `${explanation ? ` # ${tapEscape(explanation)}` : ''}`

    this.#tryPush(`${indent}1..${count}${exp}\n`)
  }

  getSkip (reason) {
    return { __proto__: null, skip: reason }
  }

  getTodo (reason) {
    return { __proto__: null, todo: reason }
  }

  subtest (indent, name) {
    this.#tryPush(`${indent}# Subtest: ${tapEscape(name)}\n`)
  }

  #details (indent, data = kEmptyObject) {
    const { error, duration_ms } = data // eslint-disable-line camelcase
    let details = `${indent}  ---\n`

    details += jsToYaml(indent, 'duration_ms', duration_ms)
    details += jsToYaml(indent, null, error)
    details += `${indent}  ...\n`
    this.#tryPush(details)
  }

  diagnostic (indent, message) {
    this.emit('test:diagnostic', message)
    this.#tryPush(`${indent}# ${tapEscape(message)}\n`)
  }

  version (spec = kDefaultTAPVersion) {
    this.#tryPush(`TAP version ${spec}\n`)
  }

  #test (indent, testNumber, status, name, directive = kEmptyObject) {
    let line = `${indent}${status} ${testNumber}`

    if (name) {
      line += ` ${tapEscape(`- ${name}`)}`
    }

    line += ArrayPrototypeJoin(ArrayPrototypeMap(ObjectEntries(directive), ({ 0: key, 1: value }) => (
      ` # ${StringPrototypeToUpperCase(key)}${value ? ` ${tapEscape(value)}` : ''}`
    )), '')

    line += '\n'

    this.#tryPush(line)
  }

  #tryPush (message) {
    if (this.#canPush) {
      this.#canPush = this.push(message)
    } else {
      ArrayPrototypePush(this.#buffer, message)
    }

    return this.#canPush
  }
}

// In certain places, # and \ need to be escaped as \# and \\.
function tapEscape (input) {
  let result = StringPrototypeReplaceAll(input, '\\', '\\\\')
  result = StringPrototypeReplaceAll(result, '#', '\\#')
  result = StringPrototypeReplaceAll(result, '\b', '\\b')
  result = StringPrototypeReplaceAll(result, '\f', '\\f')
  result = StringPrototypeReplaceAll(result, '\t', '\\t')
  result = StringPrototypeReplaceAll(result, '\n', '\\n')
  result = StringPrototypeReplaceAll(result, '\r', '\\r')
  result = StringPrototypeReplaceAll(result, '\v', '\\v')
  return result
}

function jsToYaml (indent, name, value) {
  if (value === null || value === undefined) {
    return ''
  }

  if (typeof value !== 'object') {
    const prefix = `${indent}  ${name}: `

    if (typeof value !== 'string') {
      return `${prefix}${inspectWithNoCustomRetry(value, inspectOptions)}\n`
    }

    const lines = StringPrototypeSplit(value, kLineBreakRegExp)

    if (lines.length === 1) {
      return `${prefix}${inspectWithNoCustomRetry(value, inspectOptions)}\n`
    }

    let str = `${prefix}|-\n`

    for (let i = 0; i < lines.length; i++) {
      str += `${indent}    ${lines[i]}\n`
    }

    return str
  }

  const entries = ObjectEntries(value)
  const isErrorObj = isError(value)
  let result = ''

  for (let i = 0; i < entries.length; i++) {
    const { 0: key, 1: value } = entries[i]

    if (isErrorObj && (key === 'cause' || key === 'code')) {
      continue
    }

    result += jsToYaml(indent, key, value)
  }

  if (isErrorObj) {
    const { kTestCodeFailure, kUnwrapErrors } = lazyLoadTest()
    const {
      cause,
      code,
      failureType,
      message,
      expected,
      actual,
      operator,
      stack
    } = value
    let errMsg = message ?? '<unknown error>'
    let errStack = stack
    let errCode = code
    let errExpected = expected
    let errActual = actual
    let errOperator = operator
    let errIsAssertion = isAssertionLike(value)

    // If the ERR_TEST_FAILURE came from an error provided by user code,
    // then try to unwrap the original error message and stack.
    if (code === 'ERR_TEST_FAILURE' && kUnwrapErrors.has(failureType)) {
      errStack = cause?.stack ?? errStack
      errCode = cause?.code ?? errCode
      if (isAssertionLike(cause)) {
        errExpected = cause.expected
        errActual = cause.actual
        errOperator = cause.operator ?? errOperator
        errIsAssertion = true
      }
      if (failureType === kTestCodeFailure) {
        errMsg = cause?.message ?? errMsg
      }
    }

    result += jsToYaml(indent, 'error', errMsg)

    if (errCode) {
      result += jsToYaml(indent, 'code', errCode)
    }

    if (errIsAssertion) {
      result += jsToYaml(indent, 'expected', errExpected)
      result += jsToYaml(indent, 'actual', errActual)
      if (errOperator) {
        result += jsToYaml(indent, 'operator', errOperator)
      }
    }

    if (typeof errStack === 'string') {
      const frames = []

      ArrayPrototypeForEach(
        StringPrototypeSplit(errStack, kLineBreakRegExp),
        (frame) => {
          const processed = RegExpPrototypeSymbolReplace(
            kFrameStartRegExp,
            frame,
            ''
          )

          if (processed.length > 0 && processed.length !== frame.length) {
            ArrayPrototypePush(frames, processed)
          }
        }
      )

      if (frames.length > 0) {
        const frameDelimiter = `\n${indent}    `

        result += `${indent}  stack: |-${frameDelimiter}`
        result += `${ArrayPrototypeJoin(frames, frameDelimiter)}\n`
      }
    }
  }

  return result
}

function isAssertionLike (value) {
  return value && typeof value === 'object' && 'expected' in value && 'actual' in value
}

module.exports = { TapStream }