Refactor:Add deep nested placeholder validation for custom objects v2

- Recursively scan objects, fields, and triggers for setting placeholders in nested structures like metadata, custom_field_options, actions, and conditions

Author: zendesk-punavwalke

lib/zendesk_apps_support/validations/custom_objects_v2/schema_validator.rb

@@ -134,14 +134,8 @@ def validate_objects_placeholder_values(objects)
           end
 
           def validate_object_placeholder_values(object, object_identifier)
-            object.select { |_, value| contains_setting_placeholder?(value) }.map do |property_name, property_value|
-              ValidationError.new(
-                :cov2_object_setting_placeholder_not_allowed,
-                object_key: safe_value(object_identifier),
-                property_name:,
-                property_value:
-              )
-            end
+            context_info = { type: :object, object_key: safe_value(object_identifier) }
+            scan_for_placeholders(object, context_info)
           end
 
           def validate_fields_placeholder_values(object_fields)
@@ -152,15 +146,12 @@ def validate_fields_placeholder_values(object_fields)
           end
 
           def validate_field_placeholder_values(field, field_identifier, object_identifier)
-            field.select { |_, value| contains_setting_placeholder?(value) }.map do |property_name, property_value|
-              ValidationError.new(
-                :cov2_field_setting_placeholder_not_allowed,
-                field_key: safe_value(field_identifier),
-                object_key: safe_value(object_identifier),
-                property_name:,
-                property_value:
-              )
-            end
+            context_info = {
+              type: :object_field,
+              field_key: safe_value(field_identifier),
+              object_key: safe_value(object_identifier)
+            }
+            scan_for_placeholders(field, context_info)
           end
 
           def validate_triggers_placeholder_values(object_triggers)
@@ -171,21 +162,55 @@ def validate_triggers_placeholder_values(object_triggers)
           end
 
           def validate_trigger_placeholder_values(trigger, trigger_identifier, object_identifier)
-            placeholder_restricted_keys = %w[key object_key title]
-
-            placeholder_restricted_keys.filter_map do |key|
-              value = trigger[key]
-              next unless value.is_a?(String) && contains_setting_placeholder?(value)
-
-              ValidationError.new(
-                :cov2_trigger_setting_placeholder_not_allowed,
-                trigger_key: safe_value(trigger_identifier),
-                object_key: safe_value(object_identifier),
-                property_name: key,
-                property_value: value
-              )
+            context_info = {
+              type: :object_trigger,
+              trigger_key: safe_value(trigger_identifier),
+              object_key: safe_value(object_identifier)
+            }
+            scan_for_placeholders(trigger, context_info)
+          end
+
+          def scan_for_placeholders(data, context_info)
+            case data
+            when Hash
+              scan_hash_for_placeholders(data, context_info)
+            when Array
+              scan_array_for_placeholders(data, context_info)
+            else
+              []
+            end
+          end
+
+          def scan_hash_for_placeholders(hash, context_info)
+            hash.flat_map do |property_name, property_value|
+              if property_value.is_a?(String) && contains_setting_placeholder?(property_value)
+                [create_placeholder_error(property_name, property_value, context_info)]
+              elsif property_value.is_a?(Hash) || property_value.is_a?(Array)
+                scan_for_placeholders(property_value, context_info)
+              else
+                []
+              end
+            end
+          end
+
+          def scan_array_for_placeholders(array, context_info)
+            array.flat_map do |item|
+              scan_for_placeholders(item, context_info)
             end
           end
+
+          def create_placeholder_error(property_name, property_value, context_info)
+            error_type_map = {
+              object: :cov2_object_setting_placeholder_not_allowed,
+              object_field: :cov2_field_setting_placeholder_not_allowed,
+              object_trigger: :cov2_trigger_setting_placeholder_not_allowed
+            }
+
+            error_type = error_type_map[context_info[:type]]
+
+            ValidationError.new(error_type, **context_info.except(:type), property_name: property_name,
+                                                                          property_value: property_value)
+          end
         end
       end
     end

spec/validations/custom_objects_v2/schema_validator_spec.rb

@@ -104,15 +104,18 @@
           'objects' => [
             {
               'key' => 'object_1',
-              'title' => '{{ setting.object_title }}',
+              'title' => 'Object 1',
               'title_pluralized' => 'Objects 1',
-              'include_in_list_view' => true
+              'include_in_list_view' => true,
+              'metadata' => {
+                'description' => '{{ setting.nested_description }}'
+              }
             }
           ],
           'object_fields' => [],
           'object_triggers' => []
         },
-        description: 'object contains setting placeholder in value'
+        description: 'object contains setting placeholder'
       },
       {
         error: :cov2_field_setting_placeholder_not_allowed,
@@ -126,16 +129,19 @@
             }
           ],
           'object_fields' => [
-      {
-        'key' => 'field_1',
-        'title' => '{{ setting.field_title }}',
-        'type' => 'text',
-        'object_key' => 'object_1'
-      }
-    ],
+            {
+              'key' => 'field_1',
+              'title' => 'Field 1',
+              'type' => 'dropdown',
+              'object_key' => 'object_1',
+              'custom_field_options' => [
+                { 'name' => 'Option 1', 'value' => '{{ setting.option_value }}' }
+              ]
+            }
+          ],
           'object_triggers' => []
         },
-        description: 'field contains setting placeholder in value'
+        description: 'field contains setting placeholder'
       },
       {
         error: :cov2_trigger_setting_placeholder_not_allowed,
@@ -150,16 +156,46 @@
           ],
           'object_fields' => [],
           'object_triggers' => [
+            {
+              'key' => 'trigger_1',
+              'object_key' => 'object_1',
+              'title' => 'Trigger 1',
+              'actions' => [
+                { 'field' => 'status', 'value' => '{{ setting.action_value }}' }
+              ],
+              'conditions' => { 'all' => [{ 'field' => 'status', 'operator' => 'is', 'value' => 'open' }] }
+            }
+          ]
+        },
+        description: 'trigger contains setting placeholder in actions array'
+      },
       {
-        'key' => 'trigger_1',
-        'object_key' => 'object_1',
-        'title' => '{{ setting.trigger_title }}',
-        'actions' => [{ 'field' => 'status', 'value' => 'resolved' }],
-        'conditions' => { 'all' => [{ 'field' => 'status', 'operator' => 'is', 'value' => 'open' }] }
-      }
-    ]
+        error: :cov2_trigger_setting_placeholder_not_allowed,
+        requirements: {
+          'objects' => [
+            {
+              'key' => 'object_1',
+              'title' => 'Object 1',
+              'title_pluralized' => 'Objects 1',
+              'include_in_list_view' => true
+            }
+          ],
+          'object_fields' => [],
+          'object_triggers' => [
+            {
+              'key' => 'trigger_1',
+              'object_key' => 'object_1',
+              'title' => 'Trigger 1',
+              'actions' => [{ 'field' => 'status', 'value' => 'resolved' }],
+              'conditions' => {
+                'all' => [
+                  { 'field' => 'status', 'operator' => 'is', 'value' => '{{ setting.condition_value }}' }
+                ]
+              }
+            }
+          ]
         },
-        description: 'trigger contains setting placeholder in title'
+        description: 'trigger contains setting placeholder in conditions'
       }
     ].each do |test_case|
       context "when #{test_case[:description]}" do