Bugfix: Correctly handle `given` in Array params #1625

rnubel · 2017-05-05T04:48:32Z

Addresses #1600 and #1602.

Array parameters are handled as a parameter that opens a scope with type: Array; given opens up a new scope, but was always setting the type to Hash. This patch fixes that, as well as correctly labeling the error messages associated with array fields.

dblock · 2017-05-05T11:31:09Z

Build needs to be fixed please.

timothysu · 2017-05-08T18:25:21Z

@rnubel Including an extra test to check for each element being independently validated fails. Given your test, removing bar from the second element exemplifies the issue, unless this is intended behavior.

it 'applies the constraint within each element' do
  post '/test',
    { foos: [{ foo_type: 'a' }, { baz_type: 'c' }] }.to_json,
    'CONTENT_TYPE' => 'application/json'

  expect(last_response.status).to eq(400)
  expect(last_response.body).to eq('foos[0][bar] is missing')
end

results in

expected: "foos[0][bar] is missing"
got: "foos[0][bar] is missing, foos[1][bar] is missing"

foos[1] should not have bar required because it does not contain a foo_type

dblock · 2017-05-09T20:21:22Z

I'll wait for @rnubel to comment on the above before merging. Code looks OK to me otherwise.

Array parameters are handled as a parameter that opens a scope with `type: Array`; `given` opens up a new scope, but was always setting the type to Hash. This patch fixes that, as well as correctly labeling the error messages associated with array fields.

rnubel · 2017-05-10T05:12:33Z

Good catch, @timothysu. The problem was that an Array block defines a single scope, for which should_validate? is only called once; the AttributesIterator within applies the validations to each attribute. So, I've updated the PR to perform the dependency check within that iteration, but it needs some polish and further testing.

avellable · 2017-06-08T05:56:53Z

Any update on this?

dblock · 2017-06-08T15:54:23Z

Please contribute @avellable.

dblock · 2017-06-08T15:55:02Z

Still needs CHANGELOG and stuff.

dblock · 2017-06-08T15:55:21Z

lib/grape/validations/params_scope.rb

        return true if parent.nil?
        parent.should_validate?(parameters)
      end

+      def meets_dependency?(params)
+        if @dependent_on


Make this a guard, return unless ...

avellable · 2017-06-09T10:58:39Z

@dblock Done: #1645

rnubel · 2017-06-09T15:41:18Z

@avellable appreciate the help. dependency is the correct spelling of the word, though, and your changelog format is a bit off, so I've pulled the changes into this PR instead and put your name on the changelog entry as well.

@timothysu would you be able to test this patch to verify it works in real-life usage? I can test it against contrived scenarios, but there's no substitute for a real app.

avellable · 2017-06-10T09:43:53Z

@rnubel Thanks! Sorry I forgot to add your name in the CHANGELOG of my changes. I'll close my PR now.

timothysu · 2017-06-12T15:52:41Z

@rnubel It doesn't seem to solve real-life usage issues, during a quick test. I'll double check and follow up with more actionable info when I get a chance.

dblock · 2017-06-12T16:35:42Z

I am going to merge this since it fixes at least one problem (per spec), @timothysu add anything on top that's failing in a new issue/spec please.

use correct params class in declared add changelog entry add tests for declared class fix rubocop make changelog entry better remove puts in tests one more puts change test names conform changelog entry return dynamic class name parse response instead remove params Instrument validators with ActiveSupport::Notifications Suppress `warning: method redefined` Bugfix: Correctly handle `given` in Array params (ruby-grape#1625) * Bugfix: Correctly handle `given` in Array params Array parameters are handled as a parameter that opens a scope with `type: Array`; `given` opens up a new scope, but was always setting the type to Hash. This patch fixes that, as well as correctly labeling the error messages associated with array fields. * Code review fix * Add CHANGELOG entry Add ability to include an array of modules as helpers Changing helpers DSL to allow the inclusion of many modules. This attemps to bring a better readability, since it seems to be more intuitive to send a list of modules when the message in question is called helpers. ensure we return a string from test return json in tests Update README according to new `helpers` macro interface Silence warnings (ruby-grape#1632) * silence warnings initialize vars in initializers subclass hashie mash to silence warnings rubocop fixes add changelog entry Revert "use correct params class in declared" This reverts commit 61f0c8e. fix tests * remove disable_warnings in hashie mash * make rubocop happy * fix hashie tests

Multi-param and default validators, all of which implemented their own `validate!` method, were not respecting the `given` dependency as expected. This change copies the check into all those validators. The bug was likely introduced by ruby-grape#1625, which required that the dependency check be moved out of the scope itself and into the validators. Rolling back that change would require fundamentally re-architecting how array parameters are validated (possibly with a new kind of scope).

* Bugfix: Correctly handle `given` in Array params Array parameters are handled as a parameter that opens a scope with `type: Array`; `given` opens up a new scope, but was always setting the type to Hash. This patch fixes that, as well as correctly labeling the error messages associated with array fields. * Code review fix * Add CHANGELOG entry

rnubel force-pushed the fix/given-within-array-param branch from 3d125cb to 44913f7 Compare May 5, 2017 14:52

timothysu added a commit to salsify/grape that referenced this pull request May 8, 2017

Apply patch from ruby-grape#1625

d4e3138

rnubel force-pushed the fix/given-within-array-param branch from 44913f7 to f2c9b95 Compare May 10, 2017 05:08

dblock reviewed Jun 8, 2017

View reviewed changes

avellable mentioned this pull request Jun 9, 2017

Bugfix: Handle given nested in Array params correctly #1645

Closed

rnubel added 2 commits June 9, 2017 09:46

Code review fix

738b3e7

Add CHANGELOG entry

86b9d9f

dblock merged commit f34fe12 into ruby-grape:master Jun 12, 2017

dblock mentioned this pull request Jun 12, 2017

Parameter dependecy using given does not work with nested arrays and custom block #1602

Closed

jnardone mentioned this pull request Jul 13, 2017

regression: parameters bound by given always applied/checked when nested #1659

Closed

rnubel mentioned this pull request Oct 6, 2017

[Bug] Fix validations nested under a given #1691

Closed

This was referenced Mar 28, 2018

exactly_one_of seems not work for nested parameters #1288

Open

Fix shared params with exactly_one_of #1755

Merged

braktar mentioned this pull request Aug 20, 2020

vrp benchmark #2096

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bugfix: Correctly handle `given` in Array params #1625

Bugfix: Correctly handle `given` in Array params #1625

rnubel commented May 5, 2017

dblock commented May 5, 2017

timothysu commented May 8, 2017 •

edited

Loading

dblock commented May 9, 2017

rnubel commented May 10, 2017

avellable commented Jun 8, 2017

dblock commented Jun 8, 2017

dblock commented Jun 8, 2017

dblock Jun 8, 2017

avellable commented Jun 9, 2017

rnubel commented Jun 9, 2017

avellable commented Jun 10, 2017 •

edited

Loading

timothysu commented Jun 12, 2017

dblock commented Jun 12, 2017

Bugfix: Correctly handle given in Array params #1625

Bugfix: Correctly handle given in Array params #1625

Conversation

rnubel commented May 5, 2017

dblock commented May 5, 2017

timothysu commented May 8, 2017 • edited Loading

dblock commented May 9, 2017

rnubel commented May 10, 2017

avellable commented Jun 8, 2017

dblock commented Jun 8, 2017

dblock commented Jun 8, 2017

dblock Jun 8, 2017

Choose a reason for hiding this comment

avellable commented Jun 9, 2017

rnubel commented Jun 9, 2017

avellable commented Jun 10, 2017 • edited Loading

timothysu commented Jun 12, 2017

dblock commented Jun 12, 2017

Bugfix: Correctly handle `given` in Array params #1625

Bugfix: Correctly handle `given` in Array params #1625

timothysu commented May 8, 2017 •

edited

Loading

avellable commented Jun 10, 2017 •

edited

Loading