[FrameworkBundle] Deprecate not setting some options (uid, validation)

Jean-Beru · nicolas-grekas · commit 878cda2033e6 · 2023-08-17T18:04:15.000+02:00
diff --git a/UPGRADE-6.4.md b/UPGRADE-6.4.md
@@ -80,6 +80,9 @@ FrameworkBundle
  * [BC break] Add native return type to `Translator` and to `Application::reset()`
  * Deprecate the integration of Doctrine annotations, either uninstall the `doctrine/annotations` package or disable
    the integration by setting `framework.annotations` to `false`
+ * Deprecate not setting the `framework.uid.default_uuid_version` config option; it will default to `7` in 7.0
+ * Deprecate not setting the `framework.uid.time_based_uuid_version` config option; it will default to `7` in 7.0
+ * Deprecate not setting the `framework.validation.email_validation_mode` config option; it will default to `html5` in 7.0
 
 HttpFoundation
 --------------
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -12,6 +12,9 @@ CHANGELOG
  * Add `DomCrawlerAssertionsTrait::assertAnySelectorTextNotContains(string $selector, string $text)`
  * Deprecate `EnableLoggerDebugModePass`, use argument `$debug` of HttpKernel's `Logger` instead
  * Deprecate `AddDebugLogProcessorPass::configureLogger()`, use HttpKernel's `DebugLoggerConfigurator` instead
+ * Deprecate not setting the `framework.uid.default_uuid_version` config option; it will default to `7` in 7.0
+ * Deprecate not setting the `framework.uid.time_based_uuid_version` config option; it will default to `7` in 7.0
+ * Deprecate not setting the `framework.validation.email_validation_mode` config option; it will default to `html5` in 7.0
 
 6.3
 ---
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -994,6 +994,15 @@ private function addTranslatorSection(ArrayNodeDefinition $rootNode, callable $e
     private function addValidationSection(ArrayNodeDefinition $rootNode, callable $enableIfStandalone): void
     {
         $rootNode
+            ->validate()
+                ->always(function ($v) {
+                    if ($v['validation']['enabled'] && !\array_key_exists('email_validation_mode', $v['validation'])) {
+                        trigger_deprecation('symfony/framework-bundle', '6.4', 'Not setting the "framework.validation.email_validation_mode" config option is deprecated. It will default to "html5" in 7.0.');
+                    }
+
+                    return $v;
+                })
+            ->end()
             ->children()
                 ->arrayNode('validation')
                     ->info('validation configuration')
@@ -2316,14 +2325,30 @@ private function addRateLimiterSection(ArrayNodeDefinition $rootNode, callable $
     private function addUidSection(ArrayNodeDefinition $rootNode, callable $enableIfStandalone): void
     {
         $rootNode
+            ->validate()
+                ->always(function ($v) {
+                    if ($v['uid']['enabled']) {
+                        if (!\array_key_exists('default_uuid_version', $v['uid'])) {
+                            trigger_deprecation('symfony/framework-bundle', '6.4', 'Not setting the "framework.uid.default_uuid_version" config option is deprecated. It will default to "7" in 7.0.');
+                        }
+
+                        if (!\array_key_exists('time_based_uuid_version', $v['uid'])) {
+                            trigger_deprecation('symfony/framework-bundle', '6.4', 'Not setting the "framework.uid.time_based_uuid_version" config option is deprecated. It will default to "7" in 7.0.');
+                        }
+                    }
+
+                    $v['uid'] += ['default_uuid_version' => 6, 'time_based_uuid_version' => 6];
+
+                    return $v;
+                })
+            ->end()
             ->children()
                 ->arrayNode('uid')
                     ->info('Uid configuration')
                     ->{$enableIfStandalone('symfony/uid', UuidFactory::class)}()
                     ->addDefaultsIfNotSet()
                     ->children()
                         ->enumNode('default_uuid_version')
-                            ->defaultValue(6)
                             ->values([7, 6, 4, 1])
                         ->end()
                         ->enumNode('name_based_uuid_version')
@@ -2334,7 +2359,6 @@ private function addUidSection(ArrayNodeDefinition $rootNode, callable $enableIf
                             ->cannotBeEmpty()
                         ->end()
                         ->enumNode('time_based_uuid_version')
-                            ->defaultValue(6)
                             ->values([7, 6, 1])
                         ->end()
                         ->scalarNode('time_based_uuid_node')
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/full.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/full.php
@@ -55,6 +55,7 @@
     ],
     'validation' => [
         'enabled' => true,
+        'email_validation_mode' => 'html5',
     ],
     'annotations' => false,
     'serializer' => [
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/validation_annotations.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/validation_annotations.php
@@ -7,6 +7,7 @@
     'validation' => [
         'enabled' => true,
         'enable_annotations' => true,
+        'email_validation_mode' => 'html5',
     ],
 ]);
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/validation_auto_mapping.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/validation_auto_mapping.php
@@ -5,6 +5,7 @@
     'http_method_override' => false,
     'property_info' => ['enabled' => true],
     'validation' => [
+        'email_validation_mode' => 'html5',
         'auto_mapping' => [
             'App\\' => ['foo', 'bar'],
             'Symfony\\' => ['a', 'b'],
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/validation_legacy_annotations.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/validation_legacy_annotations.php
@@ -9,6 +9,7 @@
     'validation' => [
         'enabled' => true,
         'enable_annotations' => true,
+        'email_validation_mode' => 'html5',
     ],
 ]);
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/validation_mapping.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/validation_mapping.php
@@ -4,6 +4,7 @@
     'annotations' => false,
     'http_method_override' => false,
     'validation' => [
+        'email_validation_mode' => 'html5',
         'mapping' => [
             'paths' => [
                 '%kernel.project_dir%/Fixtures/TestBundle/Resources/config/validation_mapping/files',
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/validation_multiple_static_methods.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/validation_multiple_static_methods.php
@@ -6,6 +6,7 @@
     'secret' => 's3cr3t',
     'validation' => [
         'enabled' => true,
+        'email_validation_mode' => 'html5',
         'static_method' => ['loadFoo', 'loadBar'],
     ],
 ]);
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/validation_no_static_method.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/validation_no_static_method.php
@@ -6,6 +6,7 @@
     'secret' => 's3cr3t',
     'validation' => [
         'enabled' => true,
+        'email_validation_mode' => 'html5',
         'static_method' => false,
     ],
 ]);
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/validation_translation_domain.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/validation_translation_domain.php
@@ -4,6 +4,7 @@
     'annotations' => false,
     'http_method_override' => false,
     'validation' => [
+        'email_validation_mode' => 'html5',
         'translation_domain' => 'messages',
     ],
 ]);
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/full.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/full.xml
@@ -31,7 +31,7 @@
         <framework:translator enabled="true" fallback="fr" logging="true" cache-dir="%kernel.cache_dir%/translations">
             <framework:path>%kernel.project_dir%/Fixtures/translations</framework:path>
         </framework:translator>
-        <framework:validation enabled="true" />
+        <framework:validation enabled="true" email-validation-mode="html5" />
         <framework:annotations enabled="false" />
         <framework:serializer enabled="true" enable-annotations="true" name-converter="serializer.name_converter.camel_case_to_snake_case" circular-reference-handler="my.circular.reference.handler" max-depth-handler="my.max.depth.handler">
             <framework:default-context>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/validation_annotations.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/validation_annotations.xml
@@ -8,7 +8,7 @@
 
     <framework:config secret="s3cr3t" http-method-override="false">
         <framework:annotations enabled="false" />
-        <framework:validation enabled="true" enable-annotations="true" />
+        <framework:validation enabled="true" enable-annotations="true" email-validation-mode="html5" />
     </framework:config>
 
     <services>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/validation_auto_mapping.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/validation_auto_mapping.xml
@@ -6,7 +6,7 @@
     <framework:config http-method-override="false">
         <framework:annotations enabled="false" />
         <framework:property-info enabled="true" />
-        <framework:validation>
+        <framework:validation email-validation-mode="html5">
             <framework:auto-mapping namespace="App\">
                 <framework:service>foo</framework:service>
                 <framework:service>bar</framework:service>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/validation_legacy_annotations.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/validation_legacy_annotations.xml
@@ -8,7 +8,7 @@
 
     <framework:config secret="s3cr3t" http-method-override="false">
         <framework:annotations enabled="true" />
-        <framework:validation enabled="true" enable-annotations="true" />
+        <framework:validation enabled="true" enable-annotations="true" email-validation-mode="html5" />
     </framework:config>
 
     <services>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/validation_mapping.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/validation_mapping.xml
@@ -6,7 +6,7 @@
 
     <framework:config http-method-override="false">
         <framework:annotations enabled="false" />
-        <framework:validation>
+        <framework:validation email-validation-mode="html5">
             <framework:mapping>
                 <framework:path>%kernel.project_dir%/Fixtures/TestBundle/Resources/config/validation_mapping/files</framework:path>
                 <framework:path>%kernel.project_dir%/Fixtures/TestBundle/Resources/config/validation_mapping/validation.yml</framework:path>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/validation_multiple_static_methods.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/validation_multiple_static_methods.xml
@@ -8,7 +8,7 @@
 
     <framework:config secret="s3cr3t" http-method-override="false">
         <framework:annotations enabled="false" />
-        <framework:validation enabled="true">
+        <framework:validation enabled="true" email-validation-mode="html5">
             <framework:static-method>loadFoo</framework:static-method>
             <framework:static-method>loadBar</framework:static-method>
         </framework:validation>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/validation_no_static_method.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/validation_no_static_method.xml
@@ -8,6 +8,6 @@
 
     <framework:config secret="s3cr3t" http-method-override="false">
         <framework:annotations enabled="false" />
-        <framework:validation enabled="true" static-method="false" />
+        <framework:validation enabled="true" email-validation-mode="html5" static-method="false" />
     </framework:config>
 </container>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/validation_translation_domain.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/validation_translation_domain.xml
@@ -7,6 +7,6 @@
 
     <framework:config http-method-override="false">
         <framework:annotations enabled="false" />
-        <framework:validation translation-domain="messages" />
+        <framework:validation email-validation-mode="html5" translation-domain="messages" />
     </framework:config>
 </container>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/full.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/full.yml
@@ -45,6 +45,7 @@ framework:
         paths: ['%kernel.project_dir%/Fixtures/translations']
     validation:
         enabled: true
+        email_validation_mode: html5
     annotations: false
     serializer:
          enabled:                    true
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/validation_annotations.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/validation_annotations.yml
@@ -5,6 +5,7 @@ framework:
     validation:
         enabled:     true
         enable_annotations: true
+        email_validation_mode: html5
 
 services:
     validator.alias:
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/validation_auto_mapping.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/validation_auto_mapping.yml
@@ -3,6 +3,7 @@ framework:
   http_method_override: false
   property_info: { enabled: true }
   validation:
+    email_validation_mode: html5
     auto_mapping:
       'App\': ['foo', 'bar']
       'Symfony\': ['a', 'b']
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/validation_legacy_annotations.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/validation_legacy_annotations.yml
@@ -6,6 +6,7 @@ framework:
     validation:
         enabled:     true
         enable_annotations: true
+        email_validation_mode: html5
 
 services:
     validator.alias:
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/validation_mapping.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/validation_mapping.yml
@@ -2,6 +2,7 @@ framework:
   annotations: false
   http_method_override: false
   validation:
+    email_validation_mode: html5
     mapping:
       paths:
         - "%kernel.project_dir%/Fixtures/TestBundle/Resources/config/validation_mapping/files"
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/validation_multiple_static_methods.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/validation_multiple_static_methods.yml
@@ -4,4 +4,5 @@ framework:
     secret: s3cr3t
     validation:
         enabled:       true
+        email_validation_mode: html5
         static_method: [loadFoo, loadBar]
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/validation_no_static_method.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/validation_no_static_method.yml
@@ -4,4 +4,5 @@ framework:
     secret: s3cr3t
     validation:
         enabled:       true
+        email_validation_mode: html5
         static_method: false
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/validation_translation_domain.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/validation_translation_domain.yml
@@ -2,4 +2,5 @@ framework:
     annotations: false
     http_method_override: false
     validation:
+        email_validation_mode: html5
         translation_domain: messages
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/Uid/config_enabled.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/Uid/config_enabled.yml
@@ -3,4 +3,6 @@ imports:
 
 framework:
     http_method_override: false
-    uid: ~
+    uid:
+        default_uuid_version: 7
+        time_based_uuid_version: 7
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/config/framework.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/config/framework.yml
@@ -3,7 +3,7 @@ framework:
     http_method_override: false
     secret:        test
     router:        { resource: "%kernel.project_dir%/%kernel.test_case%/routing.yml", utf8: true }
-    validation:    { enabled: true, enable_annotations: true }
+    validation:    { enabled: true, enable_annotations: true, email_validation_mode: html5 }
     csrf_protection: true
     form:
         enabled: true
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/FirewallEntryPoint/config.yml b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/FirewallEntryPoint/config.yml
@@ -3,7 +3,7 @@ framework:
     http_method_override: false
     secret: test
     router: { resource: "%kernel.project_dir%/%kernel.test_case%/routing.yml", utf8: true }
-    validation: { enabled: true, enable_annotations: true }
+    validation: { enabled: true, enable_annotations: true, email_validation_mode: html5 }
     csrf_protection: true
     form:
         enabled: true
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/config/framework.yml b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/config/framework.yml
@@ -3,7 +3,7 @@ framework:
     http_method_override: false
     secret: test
     router: { resource: "%kernel.project_dir%/%kernel.test_case%/routing.yml", utf8: true }
-    validation: { enabled: true, enable_annotations: true }
+    validation: { enabled: true, enable_annotations: true, email_validation_mode: html5 }
     assets: ~
     csrf_protection: true
     form:
