Merge pull request misd-service-development#194 from odolbeau/prevent-trigger-update-on-form

fix(form): avoid update triggered by new PhoneNumber instance with equal value

Author: maxhelias

src/Form/Extension/PhoneNumberTypeEqualityExtension.php

@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Symfony2 PhoneNumberBundle.
+ *
+ * (c) University of Cambridge
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Misd\PhoneNumberBundle\Form\Extension;
+
+use libphonenumber\PhoneNumber;
+use Misd\PhoneNumberBundle\Form\Type\PhoneNumberType;
+use Symfony\Component\Form\AbstractTypeExtension;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\Form\FormEvent;
+use Symfony\Component\Form\FormEvents;
+use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
+
+class PhoneNumberTypeEqualityExtension extends AbstractTypeExtension
+{
+    private PropertyAccessorInterface $propertyAccessor;
+
+    public function __construct(
+        PropertyAccessorInterface $propertyAccessor,
+    ) {
+        $this->propertyAccessor = $propertyAccessor;
+    }
+
+    public static function getExtendedTypes(): iterable
+    {
+        return [PhoneNumberType::class];
+    }
+
+    public function buildForm(FormBuilderInterface $builder, array $options): void
+    {
+        $builder->addEventListener(FormEvents::SUBMIT, function (FormEvent $event) {
+            $newPhoneNumber = $event->getData();
+
+            $parentForm = $event->getForm()->getParent();
+            $propertyName = $event->getForm()->getName();
+
+            if (!$parentForm) {
+                return;
+            }
+
+            $original = $parentForm->getData();
+            if (!$original || !$propertyName) {
+                return;
+            }
+
+            if ($this->propertyAccessor->isReadable($original, $propertyName)) {
+                $originalPhoneNumber = $this->propertyAccessor->getValue($original, $propertyName);
+            } else {
+                trigger_deprecation('odolbeau/phone-number-bundle', '4.2', 'Could not access property "%s" on class "%s". Make sure it is readable or add a getter method.', $propertyName, $original::class);
+
+                return;
+            }
+
+            if ($newPhoneNumber instanceof PhoneNumber && $originalPhoneNumber instanceof PhoneNumber && $newPhoneNumber->equals($originalPhoneNumber)) {
+                $event->setData($originalPhoneNumber);
+            }
+        });
+    }
+}

src/Resources/config/form.xml

@@ -8,6 +8,11 @@
         <service id="Misd\PhoneNumberBundle\Form\Type\PhoneNumberType">
             <tag name="form.type" alias="phone_number"/>
         </service>
+
+        <service id="Misd\PhoneNumberBundle\Form\Extension\PhoneNumberTypeEqualityExtension">
+            <tag name="form.type_extension" extended-type="Misd\PhoneNumberBundle\Form\Type\PhoneNumberType"/>
+            <argument type="service" id="form.property_accessor" />
+        </service>
     </services>
 
 </container>

tests/Form/Extension/PhoneNumberTypeEqualityExtensionTest.php

@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Symfony2 PhoneNumberBundle.
+ *
+ * (c) University of Cambridge
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Misd\PhoneNumberBundle\Tests\Form\Extension;
+
+use libphonenumber\PhoneNumber;
+use Misd\PhoneNumberBundle\Form\Extension\PhoneNumberTypeEqualityExtension;
+use Misd\PhoneNumberBundle\Form\Type\PhoneNumberType;
+use Symfony\Component\Form\Extension\Core\Type\FormType;
+use Symfony\Component\Form\Test\TypeTestCase;
+use Symfony\Component\PropertyAccess\PropertyAccess;
+
+class PhoneNumberTypeEqualityExtensionTest extends TypeTestCase
+{
+    protected function getTypeExtensions(): array
+    {
+        $accessor = PropertyAccess::createPropertyAccessor();
+
+        return [
+            new PhoneNumberTypeEqualityExtension($accessor),
+        ];
+    }
+
+    public function testNoChangeKeepsOriginalInstance(): void
+    {
+        $phone = new PhoneNumber();
+        $phone->setCountryCode(33);
+        $phone->setNationalNumber('612345678');
+
+        $entity = new class($phone) {
+            private PhoneNumber $phoneNumber;
+
+            public function __construct(PhoneNumber $phoneNumber)
+            {
+                $this->phoneNumber = $phoneNumber;
+            }
+
+            public function getPhoneNumber(): PhoneNumber
+            {
+                return $this->phoneNumber;
+            }
+
+            public function setPhoneNumber(PhoneNumber $phoneNumber): void
+            {
+                $this->phoneNumber = $phoneNumber;
+            }
+        };
+
+        $form = $this->factory->createBuilder(FormType::class, $entity)
+            ->add('phoneNumber', PhoneNumberType::class, [
+                'number_type' => PhoneNumberType::NUMBER_TYPE_TEL,
+            ])
+            ->getForm();
+
+        $form->submit(['phoneNumber' => '+33612345678']);
+
+        $this->assertSame($entity->getPhoneNumber(), $phone);
+    }
+}