[Validator][DoctrineBridge][FWBundle] Automatic data validation

dunglas · dunglas · commit 8c9858f01470 · 2019-03-21T13:05:54.000+01:00
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -792,6 +792,45 @@ private function addValidationSection(ArrayNodeDefinition $rootNode)
                                 ->end()
                             ->end()
                         ->end()
+                        ->arrayNode('auto_mapping')
+                            ->useAttributeAsKey('namespace')
+                            ->normalizeKeys(false)
+                            ->beforeNormalization()
+                                ->ifArray()
+                                ->then(function (array $values): array {
+                                    foreach ($values as $k => $v) {
+                                        if (isset($v['service'])) {
+                                            continue;
+                                        }
+
+                                        if (isset($v['namespace'])) {
+                                            $values[$k]['services'] = [];
+                                            continue;
+                                        }
+
+                                        if (!\is_array($v)) {
+                                            $values[$v]['services'] = [];
+                                            unset($values[$k]);
+                                            continue;
+                                        }
+
+                                        $tmp = $v;
+                                        unset($values[$k]);
+                                        $values[$k]['services'] = $tmp;
+                                    }
+
+                                    return $values;
+                                })
+                            ->end()
+                            ->arrayPrototype()
+                                ->fixXmlConfig('service')
+                                ->children()
+                                    ->arrayNode('services')
+                                        ->prototype('scalar')->end()
+                                    ->end()
+                                ->end()
+                            ->end()
+                        ->end()
                     ->end()
                 ->end()
             ->end()
diff --git a/DependencyInjection/FrameworkExtension.php b/DependencyInjection/FrameworkExtension.php
@@ -107,6 +107,7 @@
 use Symfony\Component\Translation\Command\XliffLintCommand as BaseXliffLintCommand;
 use Symfony\Component\Translation\Translator;
 use Symfony\Component\Validator\ConstraintValidatorInterface;
+use Symfony\Component\Validator\Mapping\Loader\PropertyInfoLoader;
 use Symfony\Component\Validator\ObjectInitializerInterface;
 use Symfony\Component\WebLink\HttpHeaderSerializer;
 use Symfony\Component\Workflow;
@@ -280,7 +281,8 @@ public function load(array $configs, ContainerBuilder $container)
             $container->removeDefinition('console.command.messenger_debug');
         }
 
-        $this->registerValidationConfiguration($config['validation'], $container, $loader);
+        $propertyInfoEnabled = $this->isConfigEnabled($container, $config['property_info']);
+        $this->registerValidationConfiguration($config['validation'], $container, $loader, $propertyInfoEnabled);
         $this->registerEsiConfiguration($config['esi'], $container, $loader);
         $this->registerSsiConfiguration($config['ssi'], $container, $loader);
         $this->registerFragmentsConfiguration($config['fragments'], $container, $loader);
@@ -301,7 +303,7 @@ public function load(array $configs, ContainerBuilder $container)
             $this->registerSerializerConfiguration($config['serializer'], $container, $loader);
         }
 
-        if ($this->isConfigEnabled($container, $config['property_info'])) {
+        if ($propertyInfoEnabled) {
             $this->registerPropertyInfoConfiguration($container, $loader);
         }
 
@@ -1152,7 +1154,7 @@ private function registerTranslatorConfiguration(array $config, ContainerBuilder
         }
     }
 
-    private function registerValidationConfiguration(array $config, ContainerBuilder $container, XmlFileLoader $loader)
+    private function registerValidationConfiguration(array $config, ContainerBuilder $container, XmlFileLoader $loader, bool $propertyInfoEnabled)
     {
         if (!$this->validatorConfigEnabled = $this->isConfigEnabled($container, $config)) {
             return;
@@ -1203,6 +1205,11 @@ private function registerValidationConfiguration(array $config, ContainerBuilder
         if (!$container->getParameter('kernel.debug')) {
             $validatorBuilder->addMethodCall('setMetadataCache', [new Reference('validator.mapping.cache.symfony')]);
         }
+
+        $container->setParameter('validator.auto_mapping', $config['auto_mapping']);
+        if (!$propertyInfoEnabled || !$config['auto_mapping'] || !class_exists(PropertyInfoLoader::class)) {
+            $container->removeDefinition('validator.property_info_loader');
+        }
     }
 
     private function registerValidatorMapping(ContainerBuilder $container, array $config, array &$files)
diff --git a/FrameworkBundle.php b/FrameworkBundle.php
@@ -53,6 +53,7 @@
 use Symfony\Component\Translation\DependencyInjection\TranslationExtractorPass;
 use Symfony\Component\Translation\DependencyInjection\TranslatorPass;
 use Symfony\Component\Translation\DependencyInjection\TranslatorPathsPass;
+use Symfony\Component\Validator\DependencyInjection\AddAutoMappingConfigurationPass;
 use Symfony\Component\Validator\DependencyInjection\AddConstraintValidatorsPass;
 use Symfony\Component\Validator\DependencyInjection\AddValidatorInitializersPass;
 
@@ -124,6 +125,7 @@ public function build(ContainerBuilder $container)
         $container->addCompilerPass(new TestServiceContainerRealRefPass(), PassConfig::TYPE_AFTER_REMOVING);
         $this->addCompilerPassIfExists($container, AddMimeTypeGuesserPass::class);
         $this->addCompilerPassIfExists($container, MessengerPass::class);
+        $this->addCompilerPassIfExists($container, AddAutoMappingConfigurationPass::class);
         $container->addCompilerPass(new RegisterReverseContainerPass(true));
         $container->addCompilerPass(new RegisterReverseContainerPass(false), PassConfig::TYPE_AFTER_REMOVING);
 
diff --git a/Resources/config/schema/symfony-1.0.xsd b/Resources/config/schema/symfony-1.0.xsd
@@ -190,6 +190,7 @@
         <xsd:choice minOccurs="0" maxOccurs="unbounded">
             <xsd:element name="static-method" type="xsd:string" />
             <xsd:element name="mapping" type="file_mapping" />
+            <xsd:element name="auto-mapping" type="auto_mapping" />
         </xsd:choice>
 
         <xsd:attribute name="enabled" type="xsd:boolean" />
@@ -207,6 +208,13 @@
         </xsd:sequence>
     </xsd:complexType>
 
+    <xsd:complexType name="auto_mapping">
+        <xsd:sequence>
+            <xsd:element name="service" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
+        </xsd:sequence>
+        <xsd:attribute name="namespace" type="xsd:string" use="required" />
+    </xsd:complexType>
+
     <xsd:simpleType name="email-validation-mode">
         <xsd:restriction base="xsd:string">
             <xsd:enumeration value="html5" />
diff --git a/Resources/config/validator.xml b/Resources/config/validator.xml
@@ -60,5 +60,12 @@
             <argument></argument>
             <tag name="validator.constraint_validator" alias="Symfony\Component\Validator\Constraints\EmailValidator" />
         </service>
+
+        <service id="validator.property_info_loader" class="Symfony\Component\Validator\Mapping\Loader\PropertyInfoLoader">
+            <argument type="service" id="property_info" />
+            <argument type="service" id="property_info" />
+
+            <tag name="validator.auto_mapper" />
+        </service>
     </services>
 </container>
diff --git a/Tests/DependencyInjection/ConfigurationTest.php b/Tests/DependencyInjection/ConfigurationTest.php
@@ -232,6 +232,7 @@ protected static function getBundleDefaultConfig()
                 'mapping' => [
                     'paths' => [],
                 ],
+                'auto_mapping' => [],
             ],
             'annotations' => [
                 'cache' => 'php_array',
diff --git a/Tests/DependencyInjection/Fixtures/php/validation_auto_mapping.php b/Tests/DependencyInjection/Fixtures/php/validation_auto_mapping.php
@@ -0,0 +1,12 @@
+<?php
+
+$container->loadFromExtension('framework', [
+    'property_info' => ['enabled' => true],
+    'validation' => [
+        'auto_mapping' => [
+            'App\\' => ['foo', 'bar'],
+            'Symfony\\' => ['a', 'b'],
+            'Foo\\',
+        ],
+    ],
+]);
diff --git a/Tests/DependencyInjection/Fixtures/xml/validation_auto_mapping.xml b/Tests/DependencyInjection/Fixtures/xml/validation_auto_mapping.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+           xmlns:framework="http://symfony.com/schema/dic/symfony">
+
+    <framework:config>
+        <framework:property-info enabled="true" />
+        <framework:validation>
+            <framework:auto-mapping namespace="App\">
+                <framework:service>foo</framework:service>
+                <framework:service>bar</framework:service>
+            </framework:auto-mapping>
+            <framework:auto-mapping namespace="Symfony\">
+                <framework:service>a</framework:service>
+                <framework:service>b</framework:service>
+            </framework:auto-mapping>
+            <framework:auto-mapping namespace="Foo\" />
+        </framework:validation>
+    </framework:config>
+</container>
diff --git a/Tests/DependencyInjection/Fixtures/yml/validation_auto_mapping.yml b/Tests/DependencyInjection/Fixtures/yml/validation_auto_mapping.yml
@@ -0,0 +1,7 @@
+framework:
+  property_info: { enabled: true }
+  validation:
+    auto_mapping:
+      'App\': ['foo', 'bar']
+      'Symfony\': ['a', 'b']
+      'Foo\': []
diff --git a/Tests/DependencyInjection/FrameworkExtensionTest.php b/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -50,6 +50,8 @@
 use Symfony\Component\Serializer\Serializer;
 use Symfony\Component\Translation\DependencyInjection\TranslatorPass;
 use Symfony\Component\Validator\DependencyInjection\AddConstraintValidatorsPass;
+use Symfony\Component\Validator\Mapping\Loader\PropertyInfoLoader;
+use Symfony\Component\Validator\Validation;
 use Symfony\Component\Workflow;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
@@ -1033,6 +1035,23 @@ public function testValidationMapping()
         $this->assertContains('validation.yaml', $calls[4][1][0][2]);
     }
 
+    public function testValidationAutoMapping()
+    {
+        if (!class_exists(PropertyInfoLoader::class)) {
+            $this->markTestSkipped('Auto-mapping requires symfony/validation 4.2+');
+        }
+
+        $container = $this->createContainerFromFile('validation_auto_mapping');
+        $parameter = [
+            'App\\' => ['services' => ['foo', 'bar']],
+            'Symfony\\' => ['services' => ['a', 'b']],
+            'Foo\\' => ['services' => []],
+        ];
+
+        $this->assertSame($parameter, $container->getParameter('validator.auto_mapping'));
+        $this->assertTrue($container->hasDefinition('validator.property_info_loader'));
+    }
+
     public function testFormsCanBeEnabledWithoutCsrfProtection()
     {
         $container = $this->createContainerFromFile('form_no_csrf');

Original file line number	Diff line number	Diff line change
`@@ -107,6 +107,7 @@`
`107`	`107`	`use Symfony\Component\Translation\Command\XliffLintCommand as BaseXliffLintCommand;`
`108`	`108`	`use Symfony\Component\Translation\Translator;`
`109`	`109`	`use Symfony\Component\Validator\ConstraintValidatorInterface;`
	`110`	`+use Symfony\Component\Validator\Mapping\Loader\PropertyInfoLoader;`
`110`	`111`	`use Symfony\Component\Validator\ObjectInitializerInterface;`
`111`	`112`	`use Symfony\Component\WebLink\HttpHeaderSerializer;`
`112`	`113`	`use Symfony\Component\Workflow;`
`@@ -280,7 +281,8 @@ public function load(array $configs, ContainerBuilder $container)`
`280`	`281`	`$container->removeDefinition('console.command.messenger_debug');`
`281`	`282`	`}`
`282`	`283`
`283`		`- $this->registerValidationConfiguration($config['validation'], $container, $loader);`
	`284`	`+ $propertyInfoEnabled = $this->isConfigEnabled($container, $config['property_info']);`
	`285`	`+ $this->registerValidationConfiguration($config['validation'], $container, $loader, $propertyInfoEnabled);`
`284`	`286`	`$this->registerEsiConfiguration($config['esi'], $container, $loader);`
`285`	`287`	`$this->registerSsiConfiguration($config['ssi'], $container, $loader);`
`286`	`288`	`$this->registerFragmentsConfiguration($config['fragments'], $container, $loader);`
`@@ -301,7 +303,7 @@ public function load(array $configs, ContainerBuilder $container)`
`301`	`303`	`$this->registerSerializerConfiguration($config['serializer'], $container, $loader);`
`302`	`304`	`}`
`303`	`305`
`304`		`- if ($this->isConfigEnabled($container, $config['property_info'])) {`
	`306`	`+ if ($propertyInfoEnabled) {`
`305`	`307`	`$this->registerPropertyInfoConfiguration($container, $loader);`
`306`	`308`	`}`
`307`	`309`
`@@ -1152,7 +1154,7 @@ private function registerTranslatorConfiguration(array $config, ContainerBuilder`
`1152`	`1154`	`}`
`1153`	`1155`	`}`
`1154`	`1156`
`1155`		`- private function registerValidationConfiguration(array $config, ContainerBuilder $container, XmlFileLoader $loader)`
	`1157`	`+ private function registerValidationConfiguration(array $config, ContainerBuilder $container, XmlFileLoader $loader, bool $propertyInfoEnabled)`
`1156`	`1158`	`{`
`1157`	`1159`	`if (!$this->validatorConfigEnabled = $this->isConfigEnabled($container, $config)) {`
`1158`	`1160`	`return;`
`@@ -1203,6 +1205,11 @@ private function registerValidationConfiguration(array $config, ContainerBuilder`
`1203`	`1205`	`if (!$container->getParameter('kernel.debug')) {`
`1204`	`1206`	`$validatorBuilder->addMethodCall('setMetadataCache', [new Reference('validator.mapping.cache.symfony')]);`
`1205`	`1207`	`}`
	`1208`	`+`
	`1209`	`+ $container->setParameter('validator.auto_mapping', $config['auto_mapping']);`
	`1210`	`+ if (!$propertyInfoEnabled \|\| !$config['auto_mapping'] \|\| !class_exists(PropertyInfoLoader::class)) {`
	`1211`	`+ $container->removeDefinition('validator.property_info_loader');`
	`1212`	`+ }`
`1206`	`1213`	`}`
`1207`	`1214`
`1208`	`1215`	`private function registerValidatorMapping(ContainerBuilder $container, array $config, array &$files)`