test-openapi/src/core/call/run/url/normalize.js

Automated client requests

'use strict'

// TODO: remove when using Babel. URL is global starting from Node.js 10
// eslint-disable-next-line node/prefer-global/url, no-shadow
const { URL } = require('url')

const { addErrorHandler, TestOpenApiError } = require('../../../../errors')

// Escape, normalize and validate the request URL
const normalizeUrl = function({ url: originalUrl }) {
  const url = escapeUrl(originalUrl)
  const urlA = eParseUrl({ url, originalUrl })
  const urlB = urlA.toString()
  return urlB
}

// According to RFC 3986, all characters should be escaped in paths except:
//   [:alnum:]-.+_~!$&'()*,;=:@/
// However `encodeURI()` does not escape # and ? so we escape them
// This is the same situation for origins, except RFC 3986 forbids slashes, but
// we allow it since `task.call.server` can contain the base path.
const escapeUrl = function(url) {
  return encodeURI(url)
    .replace(/#/gu, '%23')
    .replace(/\?/gu, '%3F')
}

const parseUrl = function({ url }) {
  return new URL(url)
}

const parseUrlHandler = function({ message }, { originalUrl }) {
  throw new TestOpenApiError(
    `Request URL '${originalUrl}' is not a valid full URL: ${message}`,
    // It could come from either `server` or `path`
    { property: 'task.call', value: originalUrl },
  )
}

const eParseUrl = addErrorHandler(parseUrl, parseUrlHandler)

module.exports = {
  normalizeUrl,
}