Improve invalid messages for form types

hiddewie · xabbuh · commit 8f5631584f3b · 2020-07-10T11:35:53.000+02:00
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -189,6 +189,18 @@ private function addFormSection(ArrayNodeDefinition $rootNode)
                                 ->scalarNode('field_name')->defaultValue('_token')->end()
                             ->end()
                         ->end()
+                        // to be set to false in Symfony 6.0
+                        ->booleanNode('legacy_error_messages')
+                            ->defaultTrue()
+                            ->validate()
+                                ->ifTrue()
+                                ->then(function ($v) {
+                                    @trigger_error('Since symfony/framework-bundle 5.2: Setting the "framework.form.legacy_error_messages" option to "true" is deprecated. It will have no effect as of Symfony 6.0.', E_USER_DEPRECATED);
+
+                                    return $v;
+                                })
+                            ->end()
+                        ->end()
                     ->end()
                 ->end()
             ->end()
diff --git a/DependencyInjection/FrameworkExtension.php b/DependencyInjection/FrameworkExtension.php
@@ -514,6 +514,8 @@ private function registerFormConfiguration(array $config, ContainerBuilder $cont
     {
         $loader->load('form.php');
 
+        $container->getDefinition('form.type_extension.form.validator')->setArgument(1, $config['form']['legacy_error_messages']);
+
         if (null === $config['form']['csrf_protection']['enabled']) {
             $config['form']['csrf_protection']['enabled'] = $config['csrf_protection']['enabled'];
         }
diff --git a/Resources/config/schema/symfony-1.0.xsd b/Resources/config/schema/symfony-1.0.xsd
@@ -52,6 +52,7 @@
             <xsd:element name="csrf-protection" type="form_csrf_protection" minOccurs="0" maxOccurs="1" />
         </xsd:all>
         <xsd:attribute name="enabled" type="xsd:boolean" />
+        <xsd:attribute name="legacy-error-messages" type="xsd:boolean" />
     </xsd:complexType>
 
     <xsd:complexType name="form_csrf_protection">
diff --git a/Tests/DependencyInjection/ConfigurationTest.php b/Tests/DependencyInjection/ConfigurationTest.php
@@ -354,6 +354,7 @@ protected static function getBundleDefaultConfig()
                     'enabled' => null, // defaults to csrf_protection.enabled
                     'field_name' => '_token',
                 ],
+                'legacy_error_messages' => true,
             ],
             'esi' => ['enabled' => false],
             'ssi' => ['enabled' => false],
diff --git a/Tests/DependencyInjection/Fixtures/php/csrf.php b/Tests/DependencyInjection/Fixtures/php/csrf.php
@@ -2,7 +2,9 @@
 
 $container->loadFromExtension('framework', [
     'csrf_protection' => true,
-    'form' => true,
+    'form' => [
+        'legacy_error_messages' => false,
+    ],
     'session' => [
         'handler_id' => null,
     ],
diff --git a/Tests/DependencyInjection/Fixtures/php/form_legacy_messages.php b/Tests/DependencyInjection/Fixtures/php/form_legacy_messages.php
@@ -0,0 +1,7 @@
+<?php
+
+$container->loadFromExtension('framework', [
+    'form' => [
+        'legacy_error_messages' => true,
+    ],
+]);
diff --git a/Tests/DependencyInjection/Fixtures/php/form_no_csrf.php b/Tests/DependencyInjection/Fixtures/php/form_no_csrf.php
@@ -5,5 +5,6 @@
         'csrf_protection' => [
             'enabled' => false,
         ],
+        'legacy_error_messages' => false,
     ],
 ]);
diff --git a/Tests/DependencyInjection/Fixtures/php/full.php b/Tests/DependencyInjection/Fixtures/php/full.php
@@ -8,6 +8,7 @@
         'csrf_protection' => [
             'field_name' => '_csrf',
         ],
+        'legacy_error_messages' => false,
     ],
     'http_method_override' => false,
     'esi' => [
diff --git a/Tests/DependencyInjection/Fixtures/xml/csrf.xml b/Tests/DependencyInjection/Fixtures/xml/csrf.xml
@@ -8,7 +8,7 @@
 
     <framework:config>
         <framework:csrf-protection />
-        <framework:form />
+        <framework:form legacy-error-messages="false" />
         <framework:session />
     </framework:config>
 </container>
diff --git a/Tests/DependencyInjection/Fixtures/xml/form_csrf_sets_field_name.xml b/Tests/DependencyInjection/Fixtures/xml/form_csrf_sets_field_name.xml
@@ -9,6 +9,6 @@
     <framework:config>
         <framework:csrf-protection field-name="_custom" />
         <framework:session />
-        <framework:form />
+        <framework:form legacy-error-messages="false" />
     </framework:config>
 </container>
diff --git a/Tests/DependencyInjection/Fixtures/xml/form_csrf_under_form_sets_field_name.xml b/Tests/DependencyInjection/Fixtures/xml/form_csrf_under_form_sets_field_name.xml
@@ -8,7 +8,7 @@
 
     <framework:config>
         <framework:csrf-protection field-name="_custom_form" />
-        <framework:form />
+        <framework:form legacy-error-messages="false" />
         <framework:session />
     </framework:config>
 </container>
diff --git a/Tests/DependencyInjection/Fixtures/xml/form_legacy_messages.xml b/Tests/DependencyInjection/Fixtures/xml/form_legacy_messages.xml
@@ -0,0 +1,12 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:framework="http://symfony.com/schema/dic/symfony"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
+                        http://symfony.com/schema/dic/symfony http://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
+
+    <framework:config>
+        <framework:form legacy-error-messages="true" />
+    </framework:config>
+</container>
diff --git a/Tests/DependencyInjection/Fixtures/xml/form_no_csrf.xml b/Tests/DependencyInjection/Fixtures/xml/form_no_csrf.xml
@@ -7,7 +7,7 @@
                         http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
 
     <framework:config>
-        <framework:form enabled="true">
+        <framework:form enabled="true" legacy-error-messages="false">
             <framework:csrf-protection enabled="false" />
         </framework:form>
     </framework:config>
diff --git a/Tests/DependencyInjection/Fixtures/xml/full.xml b/Tests/DependencyInjection/Fixtures/xml/full.xml
@@ -8,7 +8,7 @@
 
     <framework:config secret="s3cr3t" ide="file%%link%%format" default-locale="fr" http-method-override="false">
         <framework:csrf-protection />
-        <framework:form>
+        <framework:form legacy-error-messages="false">
             <framework:csrf-protection field-name="_csrf"/>
         </framework:form>
         <framework:esi enabled="true" />
diff --git a/Tests/DependencyInjection/Fixtures/yml/csrf.yml b/Tests/DependencyInjection/Fixtures/yml/csrf.yml
@@ -1,5 +1,6 @@
 framework:
     secret: s3cr3t
     csrf_protection: ~
-    form: ~
+    form:
+        legacy_error_messages: false
     session: ~
diff --git a/Tests/DependencyInjection/Fixtures/yml/form_legacy_messages.yml b/Tests/DependencyInjection/Fixtures/yml/form_legacy_messages.yml
@@ -0,0 +1,3 @@
+framework:
+    form:
+        legacy_error_messages: true
diff --git a/Tests/DependencyInjection/Fixtures/yml/form_no_csrf.yml b/Tests/DependencyInjection/Fixtures/yml/form_no_csrf.yml
@@ -2,3 +2,4 @@ framework:
     form:
         csrf_protection:
             enabled: false
+        legacy_error_messages: false
diff --git a/Tests/DependencyInjection/Fixtures/yml/full.yml b/Tests/DependencyInjection/Fixtures/yml/full.yml
@@ -5,6 +5,7 @@ framework:
     form:
         csrf_protection:
             field_name: _csrf
+        legacy_error_messages: false
     http_method_override: false
     esi:
         enabled: true
diff --git a/Tests/DependencyInjection/FrameworkExtensionTest.php b/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -13,6 +13,7 @@
 
 use Doctrine\Common\Annotations\Annotation;
 use Psr\Log\LoggerAwareInterface;
+use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\AddAnnotationsCachedReaderPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\FrameworkExtension;
 use Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\DummyMessage;
@@ -57,6 +58,8 @@
 
 abstract class FrameworkExtensionTest extends TestCase
 {
+    use ExpectDeprecationTrait;
+
     private static $containerCache = [];
 
     abstract protected function loadFromFile(ContainerBuilder $container, $file);
@@ -1015,6 +1018,16 @@ public function testFormsCanBeEnabledWithoutCsrfProtection()
         $this->assertFalse($container->getParameter('form.type_extension.csrf.enabled'));
     }
 
+    /**
+     * @group legacy
+     */
+    public function testFormsWithoutImprovedValidationMessages()
+    {
+        $this->expectDeprecation('Since symfony/framework-bundle 5.2: Setting the "framework.form.legacy_error_messages" option to "true" is deprecated. It will have no effect as of Symfony 6.0.');
+
+        $this->createContainerFromFile('form_legacy_messages');
+    }
+
     public function testStopwatchEnabledWithDebugModeEnabled()
     {
         $container = $this->createContainerFromFile('default_config', [
diff --git a/Tests/Functional/app/config/framework.yml b/Tests/Functional/app/config/framework.yml
@@ -3,7 +3,9 @@ framework:
     router:        { resource: "%kernel.project_dir%/%kernel.test_case%/routing.yml", utf8: true }
     validation:    { enabled: true, enable_annotations: true }
     csrf_protection: true
-    form: true
+    form:
+        enabled: true
+        legacy_error_messages: false
     test: true
     default_locale: en
     session:

Original file line number	Diff line number	Diff line change
`@@ -514,6 +514,8 @@ private function registerFormConfiguration(array $config, ContainerBuilder $cont`
`514`	`514`	`{`
`515`	`515`	`$loader->load('form.php');`
`516`	`516`
	`517`	`+ $container->getDefinition('form.type_extension.form.validator')->setArgument(1, $config['form']['legacy_error_messages']);`
	`518`	`+`
`517`	`519`	`if (null === $config['form']['csrf_protection']['enabled']) {`
`518`	`520`	`$config['form']['csrf_protection']['enabled'] = $config['csrf_protection']['enabled'];`
`519`	`521`	`}`