Handle json array (#2538)

* Handle json array

* Fix rubocop offenses

* fix index

* fix json array with nested json array

* add change to changelog

Author: mohammednasser-32

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-02-08 13:42:40 UTC using RuboCop version 1.71.2.
+# on 2025-02-23 19:41:28 UTC using RuboCop version 1.71.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new

CHANGELOG.md

@@ -10,7 +10,7 @@
 
 #### Fixes
 
-* Your contribution here.
+* [#2538](https://github.com/ruby-grape/grape/pull/2538): Fix validating nested json array params - [@mohammednasser-32](https://github.com/mohammednasser-32).
 
 ### 2.3.0 (2025-02-08)
 

lib/grape/dsl/parameters.rb

@@ -251,7 +251,7 @@ def map_params(params, element, is_array = false)
       # @return hash of parameters relevant for the current scope
       # @api private
       def params(params)
-        params = @parent.params(params) if instance_variable_defined?(:@parent) && @parent
+        params = @parent.params_meeting_dependency.presence || @parent.params(params) if instance_variable_defined?(:@parent) && @parent
         params = map_params(params, @element) if instance_variable_defined?(:@element) && @element
         params
       end

lib/grape/validations/params_scope.rb

@@ -4,7 +4,7 @@ module Grape
   module Validations
     class ParamsScope
       attr_accessor :element, :parent, :index
-      attr_reader :type
+      attr_reader :type, :params_meeting_dependency
 
       include Grape::DSL::Parameters
 
@@ -67,6 +67,7 @@ def initialize(opts, &block)
         @type             = opts[:type]
         @group            = opts[:group]
         @dependent_on     = opts[:dependent_on]
+        @params_meeting_dependency = []
         @declared_params = []
         @index = nil
 
@@ -94,7 +95,11 @@ def should_validate?(parameters)
       def meets_dependency?(params, request_params)
         return true unless @dependent_on
         return false if @parent.present? && !@parent.meets_dependency?(@parent.params(request_params), request_params)
-        return params.any? { |param| meets_dependency?(param, request_params) } if params.is_a?(Array)
+
+        if params.is_a?(Array)
+          @params_meeting_dependency = params.flatten.filter { |param| meets_dependency?(param, request_params) }
+          return @params_meeting_dependency.present?
+        end
 
         meets_hash_dependency?(params)
       end
@@ -127,7 +132,7 @@ def meets_hash_dependency?(params)
       def full_name(name, index: nil)
         if nested?
           # Find our containing element's name, and append ours.
-          "#{@parent.full_name(@element)}#{brackets(@index || index)}#{brackets(name)}"
+          "#{@parent.full_name(@element)}#{brackets(index || @index)}#{brackets(name)}"
         elsif lateral?
           # Find the name of the element as if it was at the same nesting level
           # as our parent. We need to forward our index upward to achieve this.

spec/grape/dsl/parameters_spec.rb

@@ -258,7 +258,7 @@ def extract_message_option(attrs)
     it 'inherits params from parent' do
       parent_params = { foo: 'bar' }
       subject.parent = Object.new
-      allow(subject.parent).to receive(:params).and_return(parent_params)
+      allow(subject.parent).to receive_messages(params: parent_params, params_meeting_dependency: nil)
       expect(subject.params({})).to eq parent_params
     end
 

spec/grape/validations/params_scope_spec.rb

@@ -630,6 +630,177 @@ def initialize(value)
       expect(last_response.body).to eq 'inner3[0][baz][0][baz_category] is missing'
     end
 
+    context 'detect when json array' do
+      before do
+        subject.params do
+          requires :array, type: Array do
+            requires :a, type: String
+            given a: ->(val) { val == 'a' } do
+              requires :json, type: Hash do
+                requires :b, type: String
+              end
+            end
+          end
+        end
+
+        subject.post '/nested_array' do
+          'nested array works!'
+        end
+      end
+
+      it 'succeeds' do
+        params = {
+          array: [
+            {
+              a: 'a',
+              json: { b: 'b' }
+            },
+            {
+              a: 'b'
+            }
+          ]
+        }
+        post '/nested_array', params.to_json, 'CONTENT_TYPE' => 'application/json'
+
+        expect(last_response.status).to eq(201)
+      end
+
+      it 'fails' do
+        params = {
+          array: [
+            {
+              a: 'a',
+              json: { b: 'b' }
+            },
+            {
+              a: 'a'
+            }
+          ]
+        }
+        post '/nested_array', params.to_json, 'CONTENT_TYPE' => 'application/json'
+
+        expect(last_response.status).to eq(400)
+        expect(last_response.body).to eq('array[1][json] is missing, array[1][json][b] is missing')
+      end
+    end
+
+    context 'array without given' do
+      before do
+        subject.params do
+          requires :array, type: Array do
+            requires :a, type: Integer
+            requires :b, type: Integer
+          end
+        end
+
+        subject.post '/array_without_given'
+      end
+
+      it 'fails' do
+        params = {
+          array: [
+            {
+              a: 1,
+              b: 2
+            },
+            {
+              a: 3
+            },
+            {
+              a: 5
+            }
+          ]
+        }
+        post '/array_without_given', params.to_json, 'CONTENT_TYPE' => 'application/json'
+        expect(last_response.body).to eq('array[1][b] is missing, array[2][b] is missing')
+        expect(last_response.status).to eq(400)
+      end
+    end
+
+    context 'array with given' do
+      before do
+        subject.params do
+          requires :array, type: Array do
+            requires :a, type: Integer
+            given a: lambda(&:odd?) do
+              requires :b, type: Integer
+            end
+          end
+        end
+
+        subject.post '/array_with_given'
+      end
+
+      it 'fails' do
+        params = {
+          array: [
+            {
+              a: 1,
+              b: 2
+            },
+            {
+              a: 3
+            },
+            {
+              a: 5
+            }
+          ]
+        }
+        post '/array_with_given', params.to_json, 'CONTENT_TYPE' => 'application/json'
+        expect(last_response.body).to eq('array[1][b] is missing, array[2][b] is missing')
+        expect(last_response.status).to eq(400)
+      end
+    end
+
+    context 'nested json array with given' do
+      before do
+        subject.params do
+          requires :workflow_nodes, type: Array do
+            requires :steps, type: Array do
+              requires :id, type: String
+              optional :type, type: String, values: %w[send_messsge assign_user assign_team tag_conversation snooze close add_commit]
+              given type: ->(val) { val == 'send_messsge' } do
+                requires :message, type: Hash do
+                  requires :content, type: String
+                end
+              end
+            end
+          end
+        end
+
+        subject.post '/nested_json_array_with_given'
+      end
+
+      it 'passes' do
+        params = {
+          workflow_nodes: [
+            {
+              id: 'eqibmvEzPo8hQOSt',
+              title: 'Node 1',
+              is_start: true,
+              steps: [
+                {
+                  id: 'DvdSZaIm1hEd5XO5',
+                  type: 'send_messsge',
+                  message: {
+                    content: '打击好',
+                    menus: []
+                  }
+                },
+                {
+                  id: 'VY6MIwycBw0b51Ib',
+                  type: 'add_commit',
+                  comment_content: '初来乍到'
+                }
+              ]
+            }
+          ]
+        }
+        post '/nested_json_array_with_given', params.to_json, 'CONTENT_TYPE' => 'application/json'
+        expect(last_response.status).to eq(201)
+      end
+    end
+
     it 'includes the parameter within #declared(params)' do
       get '/test', a: true, b: true