Skip to content

Address issues with allowReserved #1181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 10, 2017
Merged

Address issues with allowReserved #1181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ba18f9d
Disable allowReserved effects for non-query parameters
shockey Nov 10, 2017
3ae51c6
Improve handling of query allowReserved flag
shockey Nov 10, 2017
c469ad7
Linter fixes
shockey Nov 10, 2017
f5638c9
Merge branch 'master' into bug/3817-query-allowreserved-encoding
shockey Nov 10, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@
"cookie": "^0.3.1",
"cross-fetch": "0.0.8",
"deep-extend": "^0.4.1",
"encode-3986": "^1.0.0",
"fast-json-patch": "1.1.8",
"isomorphic-form-data": "0.0.1",
"js-yaml": "^3.8.1",
Expand Down
4 changes: 2 additions & 2 deletions src/execute/oas3/parameter-builders.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ function path({req, value, parameter}) {
value,
style: style || 'simple',
explode: explode || false,
escape: !parameter.allowReserved,
escape: false,
})

req.url = req.url.replace(`{${name}}`, styledValue)
Expand Down Expand Up @@ -110,7 +110,7 @@ function header({req, parameter, value}) {
value,
style: parameter.style || 'simple',
explode: typeof parameter.explode === 'undefined' ? false : parameter.explode,
escape: !parameter.allowReserved,
escape: false,
})
}
}
Expand Down
43 changes: 25 additions & 18 deletions src/execute/oas3/style-serializer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import encodeToRFC3986 from 'encode-3986'

export default function (config) {
const {value} = config

Expand All @@ -14,16 +16,18 @@ export default function (config) {
const escapeFn = str => encodeURIComponent(str)

function encodeArray({key, value, style, explode, escape}) {
const valueEncoder = escape ? a => encodeToRFC3986(a) : a => a

if (style === 'simple') {
return value.join(',')
return value.map(val => valueEncoder(val)).join(',')
}

if (style === 'label') {
return `.${value.join('.')}`
return `.${value.map(val => valueEncoder(val)).join('.')}`
}

if (style === 'matrix') {
return value.reduce((prev, curr) => {
return value.map(val => valueEncoder(val)).reduce((prev, curr) => {
if (!prev || explode) {
return `${(prev || '')};${key}=${curr}`
}
Expand All @@ -34,27 +38,28 @@ function encodeArray({key, value, style, explode, escape}) {
if (style === 'form') {
const commaValue = escape ? escapeFn(',') : ','
const after = explode ? `&${key}=` : commaValue
return value.join(after)
return value.map(val => valueEncoder(val)).join(after)
}

if (style === 'spaceDelimited') {
const after = explode ? `${key}=` : ''
return value.join(`${escapeFn(' ')}${after}`)
return value.map(val => valueEncoder(val)).join(`${escapeFn(' ')}${after}`)
}

if (style === 'pipeDelimited') {
const after = explode ? `${key}=` : ''
const separator = escape ? escapeFn('|') : '|'
return value.join(`${separator}${after}`)
return value.map(val => valueEncoder(val)).join(`${separator}${after}`)
}
}

function encodeObject({key, value, style, explode}) {
function encodeObject({key, value, style, explode, escape}) {
const valueEncoder = escape ? a => encodeToRFC3986(a) : a => a
const valueKeys = Object.keys(value)

if (style === 'simple') {
return valueKeys.reduce((prev, curr) => {
const val = value[curr]
const val = valueEncoder(value[curr])
const middleChar = explode ? '=' : ','
const prefix = prev ? `${prev},` : ''

Expand All @@ -64,7 +69,7 @@ function encodeObject({key, value, style, explode}) {

if (style === 'label') {
return valueKeys.reduce((prev, curr) => {
const val = value[curr]
const val = valueEncoder(value[curr])
const middleChar = explode ? '=' : '.'
const prefix = prev ? `${prev}.` : '.'

Expand All @@ -74,7 +79,7 @@ function encodeObject({key, value, style, explode}) {

if (style === 'matrix' && explode) {
return valueKeys.reduce((prev, curr) => {
const val = value[curr]
const val = valueEncoder(value[curr])
const prefix = prev ? `${prev};` : ';'

return `${prefix}${curr}=${val}`
Expand All @@ -84,7 +89,7 @@ function encodeObject({key, value, style, explode}) {
if (style === 'matrix') {
// no explode
return valueKeys.reduce((prev, curr) => {
const val = value[curr]
const val = valueEncoder(value[curr])
const prefix = prev ? `${prev},` : `;${key}=`

return `${prefix}${curr},${val}`
Expand All @@ -93,7 +98,7 @@ function encodeObject({key, value, style, explode}) {

if (style === 'form') {
return valueKeys.reduce((prev, curr) => {
const val = value[curr]
const val = valueEncoder(value[curr])
const prefix = prev ? `${prev}${explode ? '&' : ','}` : ''
const separator = explode ? '=' : ','

Expand All @@ -102,24 +107,26 @@ function encodeObject({key, value, style, explode}) {
}
}

function encodePrimitive({key, value, style, explode}) {
function encodePrimitive({key, value, style, explode, escape}) {
const valueEncoder = escape ? a => encodeToRFC3986(a) : a => a

if (style === 'simple') {
return value
return valueEncoder(value)
}

if (style === 'label') {
return `.${value}`
return `.${valueEncoder(value)}`
}

if (style === 'matrix') {
return `;${key}=${value}`
return `;${key}=${valueEncoder(value)}`
}

if (style === 'form') {
return value
return valueEncoder(value)
}

if (style === 'deepObject') {
return value
return valueEncoder(value)
}
}
208 changes: 206 additions & 2 deletions test/oas3/execute/style-explode.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -946,6 +946,83 @@ describe('buildRequest w/ `style` & `explode` - OpenAPI Specification 3.0', func
headers: {},
})
})

it('should build a query parameter in form/no-explode format with allowReserved', function () {
// Given
const spec = {
openapi: '3.0.0',
paths: {
'/users': {
get: {
operationId: 'myOperation',
parameters: [
{
name: 'id',
in: 'query',
style: 'form',
explode: false,
allowReserved: true
}
]
}
}
}
}

// when
const req = buildRequest({
spec,
operationId: 'myOperation',
parameters: {
id: ':/?#[]@!$&\'()*+,;='
}
})

expect(req).toEqual({
method: 'GET',
url: '/users?id=:/?#[]@!$&\'()*+,;=',
credentials: 'same-origin',
headers: {},
})
})

it('should build a query parameter in form/no-explode format with percent-encoding if allowReserved is not set', function () {
// Given
const spec = {
openapi: '3.0.0',
paths: {
'/users': {
get: {
operationId: 'myOperation',
parameters: [
{
name: 'id',
in: 'query',
style: 'form',
explode: false
}
]
}
}
}
}

// when
const req = buildRequest({
spec,
operationId: 'myOperation',
parameters: {
id: ':/?#[]@!$&\'()*+,;='
}
})

expect(req).toEqual({
method: 'GET',
url: '/users?id=%3A%2F%3F%23%5B%5D%40%21%24%26%27%28%29%2A%2B%2C%3B%3D',
credentials: 'same-origin',
headers: {},
})
})
})
describe('array values', function () {
const VALUE = [3, 4, 5]
Expand Down Expand Up @@ -1089,13 +1166,57 @@ describe('buildRequest w/ `style` & `explode` - OpenAPI Specification 3.0', func
spec,
operationId: 'myOperation',
parameters: {
id: VALUE
id: [
':', '/', '?', '#', '[', ']', '@', '!', '$', '&', '\'',
'(', ')', '*', '+', ',', ';', '='
]
}
})

expect(req).toEqual({
method: 'GET',
url: '/users?id=:,/,?,#,[,],@,!,$,&,\',(,),*,+,,,;,=',
credentials: 'same-origin',
headers: {},
})
})

it('should build a query parameter in form/no-explode format without allowReserved', function () {
// Given
const spec = {
openapi: '3.0.0',
paths: {
'/users': {
get: {
operationId: 'myOperation',
parameters: [
{
name: 'id',
in: 'query',
style: 'form',
explode: false
}
]
}
}
}
}

// when
const req = buildRequest({
spec,
operationId: 'myOperation',
parameters: {
id: [
':', '/', '?', '#', '[', ']', '@', '!', '$', '&', '\'',
'(', ')', '*', '+', ',', ';', '='
]
}
})

expect(req).toEqual({
method: 'GET',
url: '/users?id=3,4,5',
url: '/users?id=%3A%2C%2F%2C%3F%2C%23%2C%5B%2C%5D%2C%40%2C%21%2C%24%2C%26%2C%27%2C%28%2C%29%2C%2A%2C%2B%2C%2C%2C%3B%2C%3D',
credentials: 'same-origin',
headers: {},
})
Expand Down Expand Up @@ -1488,6 +1609,89 @@ describe('buildRequest w/ `style` & `explode` - OpenAPI Specification 3.0', func
})
})

it('should build a query parameter in form/no-explode format with allowReserved', function () {
// Given
const spec = {
openapi: '3.0.0',
paths: {
'/users': {
get: {
operationId: 'myOperation',
parameters: [
{
name: 'id',
in: 'query',
style: 'form',
explode: false,
allowReserved: true
}
]
}
}
}
}

// when
const req = buildRequest({
spec,
operationId: 'myOperation',
parameters: {
id: {
role: 'admin',
firstName: ':/?#[]@!$&\'()*+,;='
}
}
})

expect(req).toEqual({
method: 'GET',
url: '/users?id=role,admin,firstName,:/?#[]@!$&\'()*+,;=',
credentials: 'same-origin',
headers: {},
})
})

it('should build a query parameter in form/no-explode format without allowReserved', function () {
// Given
const spec = {
openapi: '3.0.0',
paths: {
'/users': {
get: {
operationId: 'myOperation',
parameters: [
{
name: 'id',
in: 'query',
style: 'form',
explode: false
}
]
}
}
}
}

// when
const req = buildRequest({
spec,
operationId: 'myOperation',
parameters: {
id: {
role: 'admin',
firstName: ':/?#[]@!$&\'()*+,;='
}
}
})

expect(req).toEqual({
method: 'GET',
url: '/users?id=role,admin,firstName,%3A%2F%3F%23%5B%5D%40%21%24%26%27%28%29%2A%2B%2C%3B%3D',
credentials: 'same-origin',
headers: {},
})
})

it('should build a query parameter in deepObject/explode format', function () {
// Given
const spec = {
Expand Down