Merge pull request #34 from matthiasnoback/igneus-fix-infinite-loop-on-unedited-field

Igneus fix infinite loop on unedited field

Author: matthiasnoback

.travis.yml

@@ -2,11 +2,9 @@ language: php
 
 matrix:
   include:
-    - php: 7.0
-      env: SYMFONY_VERSION=3.0.*
     - php: 7.0
       env: SYMFONY_VERSION=3.4.*
-    - php: 7.1
+    - php: 7.2
       env: SYMFONY_VERSION=4.0.*
 
 before_install:

composer.json

@@ -24,18 +24,18 @@
     },
     "require": {
         "php": ">=7.0",
-        "symfony/form": "~3.0|~4.0",
-        "symfony/console": "~3.0|~4.0",
-        "symfony/translation": "~3.0|~4.0"
+        "symfony/form": "~3.4|~4.0",
+        "symfony/console": "~3.4|~4.0",
+        "symfony/translation": "~3.4|~4.0"
     },
     "require-dev": {
         "beberlei/assert": "~2.1",
         "behat/behat": "~3.0",
         "friendsofphp/php-cs-fixer": "^1.10|^2.2",
-        "symfony/finder": "~3.0|~4.0",
-        "symfony/framework-bundle": "~3.0|~4.0",
-        "symfony/validator": "~3.0|~4.0",
-        "symfony/yaml": "~3.0|~4.0",
-        "symfony/security": "~3.0|~4.0"
+        "symfony/finder": "~3.4|~4.0",
+        "symfony/framework-bundle": "~3.4|~4.0",
+        "symfony/validator": "~3.4|~4.0",
+        "symfony/yaml": "~3.4|~4.0",
+        "symfony/security": "~3.4|~4.0"
     }
 }

features/interactive.feature

@@ -207,3 +207,19 @@ Feature: It is possible to interactively fill in a form from the CLI
           [price] => 10.95
       )
       """
+
+  Scenario: Secret required field
+    When I run the command "form:secret_required_field" and I provide as input
+      """
+      Jelmer[enter]
+      """
+    Then the command was not successful
+    And the output should contain
+      """
+        Invalid data provided: ERROR: This value should not be blank.
+      """
+    And the output should contain
+      """
+        [RuntimeException]
+        Errors out of the form's scope - do you have validation constraints on properties not used in the form? (Violations on unused fields: data.fieldNotUsedInTheForm)
+      """

src/Console/Helper/FormHelper.php

@@ -7,7 +7,10 @@
 use Symfony\Component\Console\Helper\Helper;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Form\FormError;
+use Symfony\Component\Form\FormErrorIterator;
 use Symfony\Component\Form\FormInterface;
+use Symfony\Component\Validator\ConstraintViolationInterface;
 
 class FormHelper extends Helper
 {
@@ -69,7 +72,16 @@ public function interactUsingForm(
             $data = $form->getData();
 
             if (!$form->isValid()) {
-                $output->write(sprintf('Invalid data provided: %s', $form->getErrors(true, false)));
+                $formErrors = $form->getErrors(true, false);
+                $output->write(sprintf('Invalid data provided: %s', $formErrors));
+                if ($this->noErrorsCanBeFixed($formErrors)) {
+                    $violationPaths = $this->constraintViolationPaths($formErrors);
+                    $hint = (count($violationPaths) > 0 ? ' (Violations on unused fields: '.implode(', ', $violationPaths).')' : '');
+                    throw new \RuntimeException(
+                        'Errors out of the form\'s scope - do you have validation constraints on properties not used in the form?'
+                        . $hint
+                    );
+                }
                 array_map(
                     function (FormInterface $formField) use (&$validFormFields) {
                         if ($formField->isValid()) {
@@ -83,4 +95,33 @@ function (FormInterface $formField) use (&$validFormFields) {
 
         return $data;
     }
+
+    /**
+     * @param FormErrorIterator $errors
+     * @return bool
+     */
+    protected function noErrorsCanBeFixed(FormErrorIterator $errors)
+    {
+        // none of the remaining errors is related to a value of a form field
+        return $errors->count() > 0 &&
+            0 === count(array_filter(iterator_to_array($errors), function ($error) {
+                return $error instanceof FormErrorIterator;
+            }));
+    }
+
+    protected function constraintViolationPaths(FormErrorIterator $errors)
+    {
+        $paths = [];
+        foreach ($errors as $error) {
+            if (!$error instanceof FormError) {
+                continue;
+            }
+            $cause = $error->getCause();
+            if (!$cause instanceof ConstraintViolationInterface) {
+                continue;
+            }
+            $paths[] = $cause->getPropertyPath();
+        }
+        return $paths;
+    }
 }

test/Command/PrintFormDataCommand.php

@@ -18,7 +18,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             }
 
             return $data;
-        }, $formData);
+        }, (array)$formData);
 
         $output->write(print_r($printData, true));
     }

test/Form/Data/SecretRequiredField.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Matthias\SymfonyConsoleForm\Tests\Form\Data;
+
+use Symfony\Component\Validator\Constraints as Assert;
+
+class SecretRequiredField
+{
+    /**
+     * @Assert\NotBlank()
+     */
+    public $name;
+
+    /**
+     * @Assert\NotBlank()
+     */
+    public $fieldNotUsedInTheForm;
+}

test/Form/SecretRequiredFieldType.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Matthias\SymfonyConsoleForm\Tests\Form;
+
+use Matthias\SymfonyConsoleForm\Tests\Form\Data\SecretRequiredField;
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\SubmitType;
+use Symfony\Component\Form\Extension\Core\Type\TextType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+use Symfony\Component\Validator\Constraints\Length;
+
+class SecretRequiredFieldType extends AbstractType
+{
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        $builder->add(
+            'name',
+            TextType::class,
+            [
+                'label' => 'Your name',
+            ]
+        );
+    }
+
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        $resolver->setDefaults([
+            'data_class' => SecretRequiredField::class,
+        ]);
+    }
+}

test/config.yml

@@ -90,6 +90,14 @@ services:
         tags:
             - { name: console.command }
 
+    secret_required_field_command:
+        class: Matthias\SymfonyConsoleForm\Tests\Command\PrintFormDataCommand
+        arguments:
+            - Matthias\SymfonyConsoleForm\Tests\Form\SecretRequiredFieldType
+            - secret_required_field
+        tags:
+            - { name: console.command }
+
 framework:
     form:
         csrf_protection: true