improvement: bypass style/explode processing for Parameter.content values (#1469)

* improvement: add newline remover for Header values

* bypass style/explode processing for `Parameter.content` values

* use named exports

* Update main.js

Author: shockey

src/execute/index.js

@@ -9,7 +9,7 @@ import stockHttp, {mergeInQueryOrForm} from '../http'
 import createError from '../specmap/lib/create-error'
 
 import SWAGGER2_PARAMETER_BUILDERS from './swagger2/parameter-builders'
-import OAS3_PARAMETER_BUILDERS from './oas3/parameter-builders'
+import * as OAS3_PARAMETER_BUILDERS from './oas3/parameter-builders'
 import oas3BuildRequest from './oas3/build-request'
 import swagger2BuildRequest from './swagger2/build-request'
 import {

src/execute/oas3/content-serializer.js

@@ -0,0 +1,16 @@
+/*
+  Serializer that serializes according to a media type instead of OpenAPI's
+  `style` + `explode` constructs.
+*/
+
+export default function serialize(value, mediaType) {
+  if (mediaType.includes('application/json')) {
+    if (typeof value === 'string') {
+      // Assume the user has a JSON string
+      return value
+    }
+    return JSON.stringify(value)
+  }
+
+  return value.toString()
+}

src/execute/oas3/parameter-builders.js

@@ -1,14 +1,21 @@
-import stylize from './style-serializer'
+import stylize, {encodeDisallowedCharacters} from './style-serializer'
+import serialize from './content-serializer'
 
-export default {
-  path,
-  query,
-  header,
-  cookie
-}
+export function path({req, value, parameter}) {
+  const {name, style, explode, content} = parameter
+
+  if (content) {
+    const effectiveMediaType = Object.keys(content)[0]
+
+    req.url = req.url.split(`{${name}}`).join(
+      encodeDisallowedCharacters(
+        serialize(value, effectiveMediaType),
+        {escape: true}
+      )
+    )
+    return
+  }
 
-function path({req, value, parameter}) {
-  const {name, style, explode} = parameter
   const styledValue = stylize({
     key: parameter.name,
     value,
@@ -20,9 +27,16 @@ function path({req, value, parameter}) {
   req.url = req.url.split(`{${name}}`).join(styledValue)
 }
 
-function query({req, value, parameter}) {
+export function query({req, value, parameter}) {
   req.query = req.query || {}
 
+  if (parameter.content) {
+    const effectiveMediaType = Object.keys(parameter.content)[0]
+
+    req.query[parameter.name] = serialize(value, effectiveMediaType)
+    return
+  }
+
   if (value === false) {
     value = 'false'
   }
@@ -98,13 +112,20 @@ const PARAMETER_HEADER_BLACKLIST = [
   'content-type'
 ]
 
-function header({req, parameter, value}) {
+export function header({req, parameter, value}) {
   req.headers = req.headers || {}
 
   if (PARAMETER_HEADER_BLACKLIST.indexOf(parameter.name.toLowerCase()) > -1) {
     return
   }
 
+  if (parameter.content) {
+    const effectiveMediaType = Object.keys(parameter.content)[0]
+
+    req.headers[parameter.name] = serialize(value, effectiveMediaType)
+    return
+  }
+
   if (typeof value !== 'undefined') {
     req.headers[parameter.name] = stylize({
       key: parameter.name,
@@ -116,10 +137,17 @@ function header({req, parameter, value}) {
   }
 }
 
-function cookie({req, parameter, value}) {
+export function cookie({req, parameter, value}) {
   req.headers = req.headers || {}
   const type = typeof value
 
+  if (parameter.content) {
+    const effectiveMediaType = Object.keys(parameter.content)[0]
+
+    req.headers.Cookie = `${parameter.name}=${serialize(value, effectiveMediaType)}`
+    return
+  }
+
   if (type !== 'undefined') {
     const prefix = (
       type === 'object' &&

src/execute/oas3/style-serializer.js

@@ -41,7 +41,7 @@ export function encodeDisallowedCharacters(str, {escape} = {}, parse) {
   }).join('')
 }
 
-export default function (config) {
+export default function stylize(config) {
   const {value} = config
 
   if (Array.isArray(value)) {

test/oas3/execute/main.js

@@ -2,6 +2,7 @@ import xmock from 'xmock'
 import path from 'path'
 import fs from 'fs'
 import jsYaml from 'js-yaml'
+import {escape} from 'querystring'
 
 import {execute, buildRequest, baseUrl, applySecurities, self as stubs} from '../../../src/execute'
 
@@ -565,6 +566,86 @@ describe('buildRequest - OpenAPI Specification 3.0', function () {
       })
     })
   })
+
+  describe('`content` parameters', function () {
+    it('should serialize JSON values provided as objects', function () {
+      const req = buildRequest({
+        spec: {
+          openapi: '3.0.0',
+          paths: {
+            '/{pathPartial}': {
+              post: {
+                operationId: 'myOp',
+                parameters: [
+                  {
+                    name: 'query',
+                    in: 'query',
+                    content: {
+                      'application/json': {
+                        schema: {
+                          type: 'object'
+                        }
+                      }
+                    }
+                  },
+                  {
+                    name: 'FooHeader',
+                    in: 'header',
+                    content: {
+                      'application/json': {
+                        schema: {
+                          type: 'object'
+                        }
+                      }
+                    }
+                  },
+                  {
+                    name: 'pathPartial',
+                    in: 'path',
+                    content: {
+                      'application/json': {
+                        schema: {
+                          type: 'object'
+                        }
+                      }
+                    }
+                  },
+                  {
+                    name: 'myCookie',
+                    in: 'cookie',
+                    content: {
+                      'application/json': {
+                        schema: {
+                          type: 'object'
+                        }
+                      }
+                    }
+                  },
+                ]
+              }
+            }
+          }
+        },
+        operationId: 'myOp',
+        parameters: {
+          query: {a: 1, b: '2'},
+          FooHeader: {foo: 'bar'},
+          pathPartial: {baz: 'qux'},
+          myCookie: {flavor: 'chocolate chip'}
+        }
+      })
+
+      expect(req).toEqual({
+        method: 'POST',
+        url: `/${escape('{"baz":"qux"}')}?query=${escape('{"a":1,"b":"2"}')}`,
+        credentials: 'same-origin',
+        headers: {
+          FooHeader: '{"foo":"bar"}',
+          Cookie: 'myCookie={"flavor":"chocolate chip"}'
+        }
+      })
+    })
+  })
   describe('baseUrl', function () {
     it('should consider contextUrls correctly with relative server paths', function () {
       const spec = {