[Form] Support catching exceptions from an accessor

symfony · alcaeus · Jul 20, 2020 · Jul 20, 2020 · Jul 20, 2020 · Jul 20, 2020
commit 2fc85b01a3520bea54bbb61a3b15c0b0c9ef76b5
diff --git a/src/Symfony/Component/Form/Extension/Core/DataMapper/AccessorMapper.php b/src/Symfony/Component/Form/Extension/Core/DataMapper/AccessorMapper.php
@@ -3,7 +3,10 @@
 namespace Symfony\Component\Form\Extension\Core\DataMapper;
 
 use Symfony\Component\Form\DataMapperInterface;
+use Symfony\Component\Form\Exception\ExceptionInterface;
 use Symfony\Component\Form\Exception\UnexpectedTypeException;
+use Symfony\Component\Form\FormError;
+use TypeError;
 
 class AccessorMapper implements DataMapperInterface
 {
@@ -69,7 +72,13 @@ public function mapFormsToData(iterable $forms, &$data)
             // Write-back is disabled if the form is not synchronized (transformation failed),
             // if the form was not submitted and if the form is disabled (modification not allowed)
             if (null !== $this->set && $config->getMapped() && $form->isSubmitted() && $form->isSynchronized() && !$form->isDisabled()) {
-                $returnValue = ($this->set)($data, $form->getData());
+                try {
+                    $returnValue = ($this->set)($data, $form->getData());
+                } catch (ExceptionInterface | TypeError $e) {
+                    $form->addError(new FormError($e->getMessage()));
+                    continue;
+                }
+
                 $type = is_object($returnValue) ? get_class($returnValue) : gettype($returnValue);
 
                 if (

diff --git a/src/Symfony/Component/Form/Tests/Extension/Core/DataMapper/AccessorMapperTest.php b/src/Symfony/Component/Form/Tests/Extension/Core/DataMapper/AccessorMapperTest.php
@@ -1,5 +1,8 @@
 <?php
 
+// Declare strict is necessary here to provoke type errors
+declare(strict_types = 1);
+
 /*
  * This file is part of the Symfony package.
  *
@@ -17,6 +20,7 @@
 use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\Form\DataMapperInterface;
+use Symfony\Component\Form\Exception\RuntimeException;
 use Symfony\Component\Form\Extension\Core\DataMapper\AccessorMapper;
 use Symfony\Component\Form\Extension\Core\DataMapper\PropertyPathMapper;
 use Symfony\Component\Form\Form;
@@ -236,6 +240,63 @@ public function getEngineClosure()
         $this->assertSame('petrol', $data->getEngineClosure());
     }
 
+    public static function invalidValueProvider(): \Generator
+    {
+        yield 'validation error' => ['#Corn is not a valid engine type#', 'corn'];
+        yield 'type error' => ['#Argument 1 passed to class@anonymous::setEngineClosure\(\) must be of the type string, object given#', new stdClass()];
+    }
+
+    /**
+     * @dataProvider InvalidValueProvider
+     */
+    public function testSetAccessorCatchesExceptions(string $errorMessagePattern, $value)
+    {
+        $this->setupPropertyPathMapper($this->any(), $this->any());
+
+        $data = new class('petrol') {
+            private $engine;
+
+            public function __construct(string $engine)
+            {
+                $this->engine = $engine;
+            }
+
+            public function setEngineClosure(string $data)
+            {
+                if ($data === 'corn') {
+                    throw new class extends RuntimeException
+                    {
+                        public function __construct()
+                        {
+                            parent::__construct('Corn is not a valid engine type');
+                        }
+                    };
+                }
+
+                $this->engine = $data;
+            }
+
+            public function getEngineClosure()
+            {
+                return $this->engine;
+            }
+        };
+
+        $config = new FormConfigBuilder('car', null, $this->dispatcher);
+        $config->setCompound(true);
+        $config->setDataMapper($this->createMapper(true, true));
+        $config->setData($data);
+        $form = new Form($config);
+        $form
+            ->add(new Form(new FormConfigBuilder('engine', null, $this->dispatcher)));
+
+        $form->submit(['engine' => $value]);
+        $this->assertFalse($form->isValid());
+        $this->assertSame('petrol', $data->getEngineClosure());
+
+        $this->assertMatchesRegularExpression($errorMessagePattern, (string) $form->get('engine')->getErrors());
+    }
+
     private function setupPropertyPathMapper(Invocation $dataToFormsMatcher, Invocation $formsToDataMatcher): void
     {
         $propertyPathMapper = new PropertyPathMapper($this->propertyAccessor);