Context around array validation failures

[lukestephenson]

Given a request like:

{ "orders": [ {customerId: 'invalid', salesPersonId: 5}, {customerId: 5, salesPersonId: 'invalid'} ] }

And the following parameter definitions:

    params do
      requires :orders, type: Array do
        requires :customerId, type: Integer
        requires :salesPersonId, type: Integer
      end
    end

Grape correctly detects that the input is invalid. However there is no context in the errors collection about which item in the array was invalid. Currently the error is reported against the key orders[customerId] but I need to be able to pair the errors back to the original element in the array like orders[0][customerId].

Is this supported by grape?

[dblock]

Grape doesn't provide array index context, and I think it should. Labelling this as a feature request.

[towanda]

@dblock could we close this issue, since It's already implemented? Thanks.

[dblock]

👍

[akeuk]

In Grape version 0.14.0, Array index context only return [0]

Parameter definitions:

params do
  requires :employees, type: Array do
    requires :name, type: String
    requires :email, regexp: /.+@.+/
  end
end

1. Failure in first element

Request (invalid email):

{
  "employees": [
    {
      "name": "Jovani Kiehn",
      "email": "invalid_email"
    },
    {
      "name": "Eliezer Torphy",
      "email": "eliezer_torphy@gmail.com"
    }
  ]
}

Response:

employees[0][email] is invalid

2. Failure in second element

Request (missing name):

{
  "employees": [
    {
      "name": "Jovani Kiehn",
      "email": "jovani_kiehn@yahoo.com"
    },
    {
       "email": "eliezer_torphy@gmail.com"
    }
  ]
}

Response:

employees[0][name] is missing

My expected is employees[1][name] is missing

3. Failure in both elements

Request:

{
  "employees": [
    {
      "name": "Jovani Kiehn",
      "email": "invalid_email"
    },
    {
      "email": "eliezer_torphy@gmail.com"
    }
  ]
}

Response:

employees[0][name] is missing, employees[0][email] is invalid

My expected is employees[0][email] is invalid, employees[1][name] is missing

Thanks!

[towanda]

@akeuk I'll take a look tonight, thanks!

[akeuk]

@towanda Thank you! :)

How was it now?

[treacher]

With this change now Hashes also return indexes so if for example I have

params do
  requires :employees, type: Hash do
    requires :name, type: String
    requires :email, type: Hash
  end
end

I would expect:
employess[name] is missing, employees[email] is missing
not:
employess[0][name] is missing, employees[0][email] is missing
currently it returns:
employess[0][name] is missing, employees[0][email] is missing

Thoughts on this?

[dblock]

That would be a bug, did I overlook this? Definitely would be a regression, appreciate at least a spec for this.

[treacher]

Sure, I'll whip something up when I get into work.

[treacher]

Wrote another test that seems to be failing around testing arrays with multiple failures: #1314 does this seem right?