test-openapi/src/validation/check.js

Automated client requests

'use strict'

const { omitBy } = require('lodash')

const { TestOpenApiError, BugError } = require('../errors')
const { crawl, isObject } = require('../utils')

const { validateFromSchema } = require('./validate')

// Validate against JSON schema and on failure throw error with
// `error.value|schema|property` set accordingly
// As opposed to `validateFromSchema()` which is meant to be separated in its
// own repository, this is meant only for this project.
const checkSchema = function({ bug = false, value, ...opts }) {
  const valueA = removeUndefined({ value })

  const error = validateFromSchema({ ...opts, value: valueA })

  if (error === undefined) {
    return
  }

  const ErrorType = bug ? BugError : TestOpenApiError
  const { message } = error
  const errorProps = getErrorProps({ opts, error })

  throw new ErrorType(message, errorProps)
}

// Values whose key is defined but whose value is `undefined` `opts.value` are
// mostly ignored by ajv except:
//  - if top-level `opts.value` itself is `undefined`
//  - `propertyNames`: this should be ok since it validates the key not
//    the value
//  - `minProperties|maxProperties|patternProperties|additionalProperties`:
//    this is problematic as `undefined` should behave as if the key was not
//    defined.
// I.e. we remove `undefined` values deeply
const removeUndefined = function({ value }) {
  return crawl(value, removeUndefinedProp)
}

const removeUndefinedProp = function(value) {
  if (!isObject(value)) {
    return value
  }

  return omitBy(value, valueA => valueA === undefined)
}

const getErrorProps = function({
  opts: { schemaProp, props },
  error: { value, schema, valuePath, schemaPath },
}) {
  const property = getProperty({ schemaProp, valuePath, schemaPath })
  return { value, schema, ...property, ...props }
}

const getProperty = function({ schemaProp, valuePath, schemaPath }) {
  const property = schemaProp === undefined ? valuePath : schemaPath

  if (property === '') {
    return
  }

  return { property }
}

module.exports = {
  checkSchema,
}