Skip to content

fix: accept string-represented values in required array runtime validation #5609

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 2 commits into from
Sep 15, 2019
Merged

fix: accept string-represented values in required array runtime validation #5609

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
222054b
rename `listCheck` -> `arrayListCheck`
shockey Sep 15, 2019
c938146
allow non-empty strings to quality a required array value
shockey Sep 15, 2019
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
9 changes: 5 additions & 4 deletions src/core/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -523,7 +523,8 @@ export const validateParam = (param, value, { isOAS3 = false, bypassRequiredChec
// These checks should evaluate to true if there is a parameter
let stringCheck = type === "string" && value
let arrayCheck = type === "array" && Array.isArray(value) && value.length
let listCheck = type === "array" && Im.List.isList(value) && value.count()
let arrayListCheck = type === "array" && Im.List.isList(value) && value.count()
let arrayStringCheck = type === "array" && typeof value === "string" && value
let fileCheck = type === "file" && value instanceof win.File
let booleanCheck = type === "boolean" && (value || value === false)
let numberCheck = type === "number" && (value || value === 0)
Expand All @@ -543,8 +544,8 @@ export const validateParam = (param, value, { isOAS3 = false, bypassRequiredChec
// }

const allChecks = [
stringCheck, arrayCheck, listCheck, fileCheck, booleanCheck,
numberCheck, integerCheck, objectCheck, objectStringCheck,
stringCheck, arrayCheck, arrayListCheck, arrayStringCheck, fileCheck,
booleanCheck, numberCheck, integerCheck, objectCheck, objectStringCheck,
]

const passedAnyCheck = allChecks.some(v => !!v)
Expand Down Expand Up @@ -605,7 +606,7 @@ export const validateParam = (param, value, { isOAS3 = false, bypassRequiredChec
} else if ( type === "array" ) {
let itemType

if ( !listCheck || !value.count() ) { return errors }
if ( !arrayListCheck || !value.count() ) { return errors }

itemType = paramDetails.getIn(["items", "type"])

Expand Down
16 changes: 16 additions & 0 deletions test/mocha/core/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -602,6 +602,14 @@ describe("utils", function() {
}
value = []
assertValidateParam(param, value, ["Required field is not provided"])

// invalid (empty) array, represented as a string
param = {
required: true,
type: "array"
}
value = ""
assertValidateParam(param, value, ["Required field is not provided"])

// invalid (not an array)
param = {
Expand Down Expand Up @@ -629,6 +637,14 @@ describe("utils", function() {
}
value = [1]
assertValidateParam(param, value, [])

// valid array, with no 'type' for items, represented as a string
param = {
required: true,
type: "array"
}
value = "[1]"
assertValidateParam(param, value, [])

// valid array, items match type
param = {
Expand Down