Merge branch 'main' into aishkan/secure-settings-scope

Author: AndreyZendesk

.github/workflows/actions.yml

@@ -9,6 +9,8 @@ on:
 jobs:
   tests:
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
     strategy:
       fail-fast: false
       matrix:
@@ -27,6 +29,8 @@ jobs:
 
   linter:
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
     steps:
       - uses: zendesk/checkout@v3
       - uses: zendesk/setup-ruby@v1
@@ -40,6 +44,8 @@ jobs:
     needs: tests
     if: always()
     runs-on: ubuntu-latest
+    permissions:
+      actions: read
     steps:
       - run: |
           if ${{ needs.tests.result == 'success' }}

config/locales/en.yml

@@ -132,6 +132,49 @@ en:
               contains an invalid object reference in object_triggers. Trigger \"%{item_identifier}\"
               references object \"%{object_key}\" which does not exist in the objects
               array.
+            excessive_custom_objects_v2_trigger_conditions_v2: The requirements.json
+              file contains too many custom object trigger conditions. The current
+              limit is %{max} conditions per trigger. This app has %{count} conditions
+              for trigger %{trigger_key}.
+            excessive_custom_objects_v2_trigger_actions_v2: The requirements.json
+              file contains too many custom object trigger actions. The current limit
+              is %{max} actions per trigger. This app has %{count} actions for trigger
+              %{trigger_key}.
+            missing_cov2_trigger_schema_key_v2: 'The requirements.json file is missing
+              custom object trigger schema key for trigger %{trigger_key} in object
+              %{object_key}. The following key is required: %{missing_key}.'
+            empty_cov2_trigger_conditions_v2: The requirements.json file contains
+              an empty conditions array for custom object trigger %{trigger_key} in
+              object %{object_key}.
+            invalid_cov2_requirements_structure_v2: The requirements.json file contains
+              an invalid custom_objects_v2 structure. The custom_objects_v2 requirements
+              must be an object.
+            invalid_cov2_trigger_actions_structure_v2: The requirements.json file
+              contains an invalid custom object trigger actions structure. The actions
+              field must be an array for trigger %{trigger_key}.
+            empty_cov2_trigger_actions_v2: The requirements.json file contains empty
+              custom object trigger actions. At least one action must be specified
+              for trigger %{trigger_key}.
+            invalid_objects_structure_in_cov2_requirements_v2: The requirements.json
+              file contains an invalid objects structure. The objects field must be
+              an array.
+            invalid_object_fields_structure_in_cov2_requirements_v2: The requirements.json
+              file contains an invalid object_fields structure. The object_fields
+              field must be an array.
+            invalid_object_triggers_structure_in_cov2_requirements_v2: The requirements.json
+              file contains an invalid object_triggers structure. The object_triggers
+              field must be an array.
+            invalid_cov2_object_reference_in_fields_v2: The requirements.json file
+              contains an invalid object reference in object_fields. Field %{item_identifier}
+              references object %{object_key} which does not exist in the objects
+              array.
+            invalid_cov2_object_reference_in_triggers_v2: The requirements.json file
+              contains an invalid object reference in object_triggers. Trigger %{item_identifier}
+              references object %{object_key} which does not exist in the objects
+              array.
+            invalid_cov2_trigger_conditions_structure_v2: The requirements.json file
+              contains an invalid custom object trigger conditions structure. Conditions
+              must be a hash with all and any arrays for trigger %{trigger_key}.
             missing_required_fields: 'Missing required fields in requirements.json:
               "%{field}" is required in "%{identifier}"'
             duplicate_requirements:

config/locales/translations/zendesk_apps_support.yml

@@ -192,6 +192,7 @@ parts:
       title: 'App builder job: requirements file contains invalid custom object trigger conditions structure. Conditions must be an object (a set of key-value pairs, like { "all": [], "any": [] } in JSON) with "all" and "any" arrays as keys. Leave requirements.json, "all" and "any" as is (do not translate)'
       value: 'The requirements.json file contains an invalid custom object trigger conditions structure. Conditions must be a hash with "all" and "any" arrays for trigger %{trigger_title}.'
       screenshot: "https://drive.google.com/file/d/1c4Hgk8OXscco_cwOfCX5r8Ub3k_-umrr/view?usp=sharing"
+      obsolete: "2025-12-31"
   - translation:
       key: "txt.apps.admin.error.app_build.invalid_cov2_trigger_actions_structure"
       title: "App builder job: requirements file contains an invalid custom object trigger actions structure. Actions must be an array. 'actions' is part of requirements file. Leave requirements.json and 'actions' as is (do not translate)"
@@ -304,6 +305,11 @@ parts:
       title: 'App builder job: requirements file contains an invalid object reference in object_triggers for Custom Objects V2. Do not translate "requirements.json", %{item_identifier}, %{object_key}. Do not translate "object_triggers" as it is part of schema.'
       value: 'The requirements.json file contains an invalid object reference in object_triggers. Trigger %{item_identifier} references object %{object_key} which does not exist in the objects array.'
       screenshot: "https://drive.google.com/file/d/1hwmWbFPd5_XtoY6gpyy7FZ9niHppRe2m/view?usp=sharing"
+  - translation:
+      key: "txt.apps.admin.error.app_build.invalid_cov2_trigger_conditions_structure_v2"
+      title: 'App builder job: requirements file contains invalid custom object trigger conditions structure. Conditions must be an object (a set of key-value pairs, like { "all": [], "any": [] } in JSON) with "all" and "any" arrays as keys. Do not translate "requirements.json". Do not translate "all" and "any" as it is part of schema.'
+      value: 'The requirements.json file contains an invalid custom object trigger conditions structure. Conditions must be a hash with all and any arrays for trigger %{trigger_key}.'
+      screenshot: "https://drive.google.com/file/d/1q9S42EyNDE1GPk8A32LT0n2ZQiBpuCEW/view?usp=sharing"
   - translation:
       key: "txt.apps.admin.error.app_build.missing_required_fields"
       title: "App builder job: required key missing in requirements, e.g. \"title\" is required in \"my_custom_email_target\""

lib/zendesk_apps_support/validations/custom_objects_v2/constants.rb

@@ -49,8 +49,8 @@ module Constants
         MAX_PAYLOAD_SIZE_BYTES = 1_048_576 # 1 MB in bytes
 
         REFERENCE_VALIDATION_CONFIG = {
-          SCHEMA_KEYS[:object_fields] => { identifier: KEY, error: :invalid_cov2_object_reference_in_fields },
-          SCHEMA_KEYS[:object_triggers] => { identifier: TITLE, error: :invalid_cov2_object_reference_in_triggers }
+          SCHEMA_KEYS[:object_fields] => { identifier: KEY, error: :invalid_cov2_object_reference_in_fields_v2 },
+          SCHEMA_KEYS[:object_triggers] => { identifier: KEY, error: :invalid_cov2_object_reference_in_triggers_v2 }
         }.freeze
       end
     end

lib/zendesk_apps_support/validations/custom_objects_v2/custom_objects_v2.rb

@@ -51,14 +51,14 @@ def validate_overall_requirements_structure(requirements)
           end
 
           [
-            validate_collection_is_array(objects, :invalid_objects_structure_in_cov2_requirements),
-            validate_collection_is_array(object_fields, :invalid_object_fields_structure_in_cov2_requirements),
-            validate_collection_is_array(object_triggers, :invalid_object_triggers_structure_in_cov2_requirements)
+            validate_collection_is_array(objects, :invalid_objects_structure_in_cov2_requirements_v2),
+            validate_collection_is_array(object_fields, :invalid_object_fields_structure_in_cov2_requirements_v2),
+            validate_collection_is_array(object_triggers, :invalid_object_triggers_structure_in_cov2_requirements_v2)
           ].flatten
         end
 
         def validate_structural_requirements(requirements)
-          return [ValidationError.new(:invalid_cov2_requirements_structure)] unless requirements.is_a?(Hash)
+          return [ValidationError.new(:invalid_cov2_requirements_structure_v2)] unless requirements.is_a?(Hash)
           return [ValidationError.new(:empty_cov2_requirements)] if requirements.empty?
 
           []

lib/zendesk_apps_support/validations/custom_objects_v2/limits_validator.rb

@@ -140,10 +140,10 @@ def validate_trigger_conditions(trigger)
 
             return [] unless total_conditions > MAX_CONDITIONS_PER_TRIGGER
 
-            [ValidationError.new(:excessive_custom_objects_v2_trigger_conditions,
+            [ValidationError.new(:excessive_custom_objects_v2_trigger_conditions_v2,
                                  max: MAX_CONDITIONS_PER_TRIGGER,
                                  count: total_conditions,
-                                 trigger_title: trigger[TITLE])]
+                                 trigger_key: trigger[KEY])]
           end
 
           def validate_triggers_actions_limit(object_triggers)
@@ -153,10 +153,10 @@ def validate_triggers_actions_limit(object_triggers)
               actions = trigger[ACTIONS]
               next if actions.size <= MAX_ACTIONS_PER_TRIGGER
 
-              ValidationError.new(:excessive_custom_objects_v2_trigger_actions,
+              ValidationError.new(:excessive_custom_objects_v2_trigger_actions_v2,
                                   max: MAX_ACTIONS_PER_TRIGGER,
                                   count: actions.size,
-                                  trigger_title: trigger[TITLE])
+                                  trigger_key: trigger[KEY])
             end
           end
 

lib/zendesk_apps_support/validations/custom_objects_v2/schema_validator.rb

@@ -62,45 +62,45 @@ def validate_triggers_schema(object_triggers = [])
           def validate_trigger_schema(trigger)
             required_keys = %w[key object_key title actions conditions]
             missing_keys = required_keys - trigger.keys
-            trigger_title = safe_value(trigger[TITLE])
+            trigger_key = safe_value(trigger[KEY])
             object_key = safe_value(trigger[OBJECT_KEY])
 
             errors = missing_keys.map do |missing_key|
-              ValidationError.new(:missing_cov2_trigger_schema_key,
+              ValidationError.new(:missing_cov2_trigger_schema_key_v2,
                                   missing_key: missing_key,
-                                  trigger_title: trigger_title,
+                                  trigger_key: trigger_key,
                                   object_key: object_key)
             end
 
-            errors.concat(validate_conditions_schema(trigger[CONDITIONS], object_key, trigger_title))
-            errors.concat(validate_actions_schema(trigger[ACTIONS], object_key, trigger_title))
+            errors.concat(validate_conditions_schema(trigger[CONDITIONS], object_key, trigger_key))
+            errors.concat(validate_actions_schema(trigger[ACTIONS], object_key, trigger_key))
             errors
           end
 
-          def validate_conditions_schema(conditions, object_key, title)
-            error_data = { trigger_title: title, object_key: object_key }
+          def validate_conditions_schema(conditions, object_key, trigger_key)
+            error_data = { trigger_key:, object_key: }
 
             unless valid_conditions_structure?(conditions)
-              return [ValidationError.new(:invalid_cov2_trigger_conditions_structure, **error_data)]
+              return [ValidationError.new(:invalid_cov2_trigger_conditions_structure_v2, **error_data)]
             end
 
             if count_conditions(conditions).zero?
-              return [ValidationError.new(:empty_cov2_trigger_conditions, **error_data)]
+              return [ValidationError.new(:empty_cov2_trigger_conditions_v2, **error_data)]
             end
 
             []
           end
 
-          def validate_actions_schema(actions, object_key, title)
-            error_data = { trigger_title: title, object_key: object_key }
+          def validate_actions_schema(actions, object_key, trigger_key)
+            error_data = { trigger_key:, object_key: }
 
             unless actions.is_a?(Array)
-              return [ValidationError.new(:invalid_cov2_trigger_actions_structure, **error_data)]
+              return [ValidationError.new(:invalid_cov2_trigger_actions_structure_v2, **error_data)]
             end
 
             return [] unless actions.empty?
 
-            [ValidationError.new(:empty_cov2_trigger_actions, **error_data)]
+            [ValidationError.new(:empty_cov2_trigger_actions_v2, **error_data)]
           end
 
           def valid_conditions_structure?(conditions)

spec/validations/custom_objects_v2/custom_objects_v2_spec.rb

@@ -6,12 +6,12 @@
   describe '.call' do
     [
       {
-        error: :invalid_cov2_requirements_structure,
+        error: :invalid_cov2_requirements_structure_v2,
         requirements: nil,
         description: 'requirements is nil'
       },
       {
-        error: :invalid_cov2_requirements_structure,
+        error: :invalid_cov2_requirements_structure_v2,
         requirements: [],
         description: 'requirements is an array'
       },
@@ -30,7 +30,7 @@
         description: 'all cov2 arrays are empty'
       },
       {
-        error: :invalid_objects_structure_in_cov2_requirements,
+        error: :invalid_objects_structure_in_cov2_requirements_v2,
         requirements: {
           'objects' => {},
           'object_fields' => [{ 'key' => 'field_1', 'type' => 'text', 'title' => 'Field 1',
@@ -41,7 +41,7 @@
         description: 'objects is not an array'
       },
       {
-        error: :invalid_object_fields_structure_in_cov2_requirements,
+        error: :invalid_object_fields_structure_in_cov2_requirements_v2,
         requirements: {
           'objects' => [{ 'key' => 'object_1', 'title' => 'Object 1', 'title_pluralized' => 'Objects 1',
                           'include_in_list_view' => true }],
@@ -52,7 +52,7 @@
         description: 'object_fields is not an array'
       },
       {
-        error: :invalid_object_triggers_structure_in_cov2_requirements,
+        error: :invalid_object_triggers_structure_in_cov2_requirements_v2,
         requirements: {
           'objects' => [{ 'key' => 'object_1', 'title' => 'Object 1', 'title_pluralized' => 'Objects 1',
                           'include_in_list_view' => true }],
@@ -79,7 +79,7 @@
         description: 'payload exceeds size limit'
       },
       {
-        error: :invalid_cov2_object_reference_in_triggers,
+        error: :invalid_cov2_object_reference_in_triggers_v2,
         requirements: {
           'objects' => [
             { 'key' => 'object_1', 'title' => 'Object 1', 'title_pluralized' => 'Objects 1',
@@ -95,7 +95,7 @@
         description: 'object_trigger references non-existent object'
       },
       {
-        error: :invalid_cov2_object_reference_in_fields,
+        error: :invalid_cov2_object_reference_in_fields_v2,
         requirements: {
           'objects' => [
             { 'key' => 'object_1', 'title' => 'Object 1', 'title_pluralized' => 'Objects 1',

spec/validations/custom_objects_v2/limits_validator_spec.rb

@@ -79,7 +79,7 @@
         description: 'there are more than 20 triggers per object'
       },
       {
-        error: :excessive_custom_objects_v2_trigger_conditions,
+        error: :excessive_custom_objects_v2_trigger_conditions_v2,
         requirements: {
           'objects' => [{ 'key' => 'object_1', 'title' => 'Object 1' }],
           'object_fields' => [],
@@ -96,7 +96,7 @@
         description: 'there are more than 50 conditions per trigger'
       },
       {
-        error: :excessive_custom_objects_v2_trigger_actions,
+        error: :excessive_custom_objects_v2_trigger_actions_v2,
         requirements: {
           'objects' => [{ 'key' => 'object_1', 'title' => 'Object 1' }],
           'object_fields' => [],

spec/validations/custom_objects_v2/schema_validator_spec.rb

@@ -25,7 +25,7 @@
         description: 'fields is missing required key'
       },
       {
-        error: :missing_cov2_trigger_schema_key,
+        error: :missing_cov2_trigger_schema_key_v2,
         requirements: {
           'objects' => [{ 'key' => 'object_1', 'title' => 'Object 1', 'title_pluralized' => 'Objects 1',
                           'include_in_list_view' => true }],
@@ -35,7 +35,7 @@
         description: 'triggers is missing required key'
       },
       {
-        error: :invalid_cov2_trigger_conditions_structure,
+        error: :invalid_cov2_trigger_conditions_structure_v2,
         requirements: {
           'objects' => [{ 'key' => 'object_1', 'title' => 'Object 1', 'title_pluralized' => 'Objects 1',
                           'include_in_list_view' => true }],
@@ -51,7 +51,7 @@
         description: 'triggers has invalid conditions structure'
       },
       {
-        error: :empty_cov2_trigger_conditions,
+        error: :empty_cov2_trigger_conditions_v2,
         requirements: {
           'objects' => [{ 'key' => 'object_1', 'title' => 'Object 1', 'title_pluralized' => 'Objects 1',
                           'include_in_list_view' => true }],
@@ -67,7 +67,7 @@
         description: 'triggers has empty conditions'
       },
       {
-        error: :invalid_cov2_trigger_actions_structure,
+        error: :invalid_cov2_trigger_actions_structure_v2,
         requirements: {
           'objects' => [{ 'key' => 'object_1', 'title' => 'Object 1', 'title_pluralized' => 'Objects 1',
                           'include_in_list_view' => true }],
@@ -83,7 +83,7 @@
         description: 'triggers has invalid actions structure'
       },
       {
-        error: :empty_cov2_trigger_actions,
+        error: :empty_cov2_trigger_actions_v2,
         requirements: {
           'objects' => [{ 'key' => 'object_1', 'title' => 'Object 1', 'title_pluralized' => 'Objects 1',
                           'include_in_list_view' => true }],