feature #51332 [SecurityBundle] Deprecate the require_previous_session config option (alamirault)

fabpot · fabpot · commit 922e98e9383e · 2023-08-11T10:13:11.000+02:00
This PR was squashed before being merged into the 6.4 branch. Discussion ---------- [SecurityBundle] Deprecate the `require_previous_session` config option | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | no | New feature? | no  | Deprecations? | yes  | Tickets | Fix #51318  | License | MIT | Doc PR | symfony/symfony-docs#...  This PR deprecate the `require_previous_session` config option Remove is done in #51333 on 7.0 Commits ------- f92b0fc [SecurityBundle] Deprecate the `require_previous_session` config option
diff --git a/UPGRADE-6.4.md b/UPGRADE-6.4.md
@@ -121,6 +121,11 @@ Security
  * [BC break] Make `PersistentToken` immutable
  * Deprecate accepting only `DateTime` for `TokenProviderInterface::updateToken()`, use `DateTimeInterface` instead
 
+SecurityBundle
+--------------
+
+ * Deprecate the `require_previous_session` config option. Setting it has no effect anymore
+
 Serializer
 ----------
 
diff --git a/src/Symfony/Bundle/SecurityBundle/CHANGELOG.md b/src/Symfony/Bundle/SecurityBundle/CHANGELOG.md
@@ -7,6 +7,7 @@ CHANGELOG
  * Deprecate `Security::ACCESS_DENIED_ERROR`, `AUTHENTICATION_ERROR` and `LAST_USERNAME` constants, use the ones on `SecurityRequestAttributes` instead
  * Allow an array of `pattern` in firewall configuration
  * Add `$badges` argument to `Security::login`
+ * Deprecate the `require_previous_session` config option. Setting it has no effect anymore
 
 6.3
 ---
diff --git a/src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/AbstractFactory.php b/src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/AbstractFactory.php
@@ -67,7 +67,12 @@ public function addConfiguration(NodeDefinition $node)
         ;
 
         foreach (array_merge($this->options, $this->defaultSuccessHandlerOptions, $this->defaultFailureHandlerOptions) as $name => $default) {
-            if (\is_bool($default)) {
+            if ('require_previous_session' === $name) {
+                $builder
+                    ->booleanNode($name)
+                    ->setDeprecated('symfony/security-bundle', '6.4', 'Option "%node%" at "%path%" is deprecated, it will be removed in version 7.0. Setting it has no effect anymore.')
+                    ->defaultValue($default);
+            } elseif (\is_bool($default)) {
                 $builder->booleanNode($name)->defaultValue($default);
             } else {
                 $builder->scalarNode($name)->defaultValue($default);
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/DependencyInjection/Security/Factory/AbstractFactoryTest.php b/src/Symfony/Bundle/SecurityBundle/Tests/DependencyInjection/Security/Factory/AbstractFactoryTest.php
@@ -12,12 +12,16 @@
 namespace Symfony\Bundle\SecurityBundle\Tests\DependencyInjection\Security\Factory;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
 use Symfony\Bundle\SecurityBundle\DependencyInjection\Security\Factory\AbstractFactory;
+use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 class AbstractFactoryTest extends TestCase
 {
+    use ExpectDeprecationTrait;
+
     private ContainerBuilder $container;
 
     protected function setUp(): void
@@ -107,6 +111,27 @@ public function testDefaultSuccessHandler($serviceId, $defaultHandlerInjection)
         }
     }
 
+    /**
+     * @group legacy
+     */
+    public function testRequirePreviousSessionOptionLegacy()
+    {
+        $this->expectDeprecation('Since symfony/security-bundle 6.4: Option "require_previous_session" at "root" is deprecated, it will be removed in version 7.0. Setting it has no effect anymore.');
+
+        $options = [
+            'require_previous_session' => true,
+        ];
+
+        $factory = new StubFactory();
+        $nodeDefinition = new ArrayNodeDefinition('root');
+        $factory->addConfiguration($nodeDefinition);
+
+        $node = $nodeDefinition->getNode();
+        $normalizedConfig = $node->normalize($options);
+
+        $node->finalize($normalizedConfig);
+    }
+
     public static function getSuccessHandlers()
     {
         return [
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/AbstractTokenCompareRoles/config.yml b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/AbstractTokenCompareRoles/config.yml
@@ -20,7 +20,6 @@ security:
       form_login:
         check_path: login
         remember_me: true
-        require_previous_session: false
       logout: ~
       stateless: false
 
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/AbstractTokenCompareRoles/legacy_config.yml b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/AbstractTokenCompareRoles/legacy_config.yml
@@ -20,7 +20,6 @@ security:
       form_login:
         check_path: login
         remember_me: true
-        require_previous_session: false
       logout: ~
       stateless: false
 
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/JsonLoginLdap/config.yml b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/JsonLoginLdap/config.yml
@@ -29,7 +29,6 @@ security:
             stateless: true
             json_login_ldap:
                 check_path: /login
-                require_previous_session: false
                 service: Symfony\Component\Ldap\Ldap
                 dn_string: ''
                 username_path: user.login
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/Logout/config_access.yml b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/Logout/config_access.yml
@@ -16,7 +16,6 @@ security:
             form_login:
                 check_path: login
                 remember_me: true
-                require_previous_session: false
             logout: ~
             stateless: true
 
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/Logout/config_cookie_clearing.yml b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/Logout/config_cookie_clearing.yml
@@ -16,7 +16,6 @@ security:
             form_login:
                 check_path: login
                 remember_me: true
-                require_previous_session: false
             logout:
                 delete_cookies:
                     flavor: { path: null, domain: somedomain }
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/Logout/config_csrf_enabled.yml b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/Logout/config_csrf_enabled.yml
@@ -16,7 +16,6 @@ security:
             form_login:
                 check_path: login
                 remember_me: true
-                require_previous_session: false
             logout:
                 enable_csrf: true
 
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/LogoutWithoutSessionInvalidation/config.yml b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/LogoutWithoutSessionInvalidation/config.yml
@@ -16,7 +16,6 @@ security:
             form_login:
                 check_path: login
                 remember_me: true
-                require_previous_session: false
             remember_me:
                 always_remember_me: true
                 secret: secret
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/RememberMeCookie/config.yml b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/RememberMeCookie/config.yml
@@ -16,7 +16,6 @@ security:
             form_login:
                 check_path: login
                 remember_me: true
-                require_previous_session: false
             remember_me:
                 always_remember_me: true
                 secret: key
