Avoid coercing parameter with multiple types to an empty Array #2019
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stanhu
force-pushed
the
sh-respect-nil-values-multiple-types
branch
2 times, most recently
from
af12335 to
10b15fe
Compare
stanhu
commented
Mar 17, 2020
| return Set.new if type == Set | ||
| return {} if type == Hash | ||
| return val if type.is_a?(Array) |
There was a problem hiding this comment.
I'm not sure about this type.is_a?(Array) check. I assume that passing a nil value to a parameter with multiple types might lead to ambiguity?
There was a problem hiding this comment.
Unfortunately, it was necessary
it 'handles default value to array' do
subject.params do
optional :a, type: Array[Integer], default: []
end
subject.put('/test') { declared(params).to_json }
put '/test', { a: nil }
expect(last_response.status).to eq(200)
expect(last_response.body).to eq('{"a":[]}')
endThat test fails because type != array but it's type.is_a?(Array)
I'll make a PR to fix it
stanhu
force-pushed
the
sh-respect-nil-values-multiple-types
branch
from
10b15fe to
d38b594
Compare
dblock
reviewed
Mar 17, 2020
|
Looks like a bug, thanks for the fix! Move the changelog entry and I'll merge. |
stanhu
force-pushed
the
sh-respect-nil-values-multiple-types
branch
from
d38b594 to
43fd676
Compare
dblock
reviewed
Mar 17, 2020
stanhu
force-pushed
the
sh-respect-nil-values-multiple-types
branch
from
109d1a5 to
31d9ff0
Compare
|
See rubocop offense, I'll merge on green. |
dblock
reviewed
Mar 17, 2020
dblock
reviewed
Mar 17, 2020
| return [] if type == Array | ||
| return Set.new if type == Set | ||
| return {} if type == Hash | ||
| return val |
There was a problem hiding this comment.
this is a good place for a case
case type
when Array
when ...There was a problem hiding this comment.
That doesn't actually work in this case because we need to distinguish between type.is_a?(Array) and type == Array (https://stackoverflow.com/questions/3908380/ruby-class-types-and-case-statements).
stanhu
force-pushed
the
sh-respect-nil-values-multiple-types
branch
from
31d9ff0 to
d0e8009
Compare
If an optional parameter has multiple types (e.g. [File, String]) and a nil parameter is passed, Grape would previously coerce the value to an empty Array. This can break certain APIs that treat nil values differently from an empty Array. To fix this, we refactor the nil handling into a `coerce_nil` method and remove the special case check for handling an Array of types. Closes ruby-grape#2018
stanhu
force-pushed
the
sh-respect-nil-values-multiple-types
branch
from
d0e8009 to
633d7cf
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If an optional parameter has multiple types (e.g.
[File, String]) and anilparameter is passed, Grape would previously coerce the value to anempty
Array. This can break certain APIs that treat nil valuesdifferently from an empty Array.
To fix this, we refactor the nil handling into a
coerce_nilmethod andremove the special case check for handling an Array of types.
Closes #2018