Remove the default values from setters with a nullable parameter.

Author: derrabus

Authentication/Token/Storage/TokenStorage.php

@@ -39,6 +39,10 @@ public function getToken(): ?TokenInterface
 
     public function setToken(TokenInterface $token = null)
     {
+        if (1 > \func_num_args()) {
+            trigger_deprecation('symfony/security-core', '6.2', 'Calling "%s()" without any arguments is deprecated. Please explicitly pass null if you want to unset the token.', __METHOD__);
+        }
+
         if ($token) {
             // ensure any initializer is called
             $this->getToken();

Authentication/Token/Storage/TokenStorageInterface.php

@@ -30,5 +30,5 @@ public function getToken(): ?TokenInterface;
      *
      * @param TokenInterface|null $token A TokenInterface token, or null if no further authentication information should be stored
      */
-    public function setToken(TokenInterface $token = null);
+    public function setToken(?TokenInterface $token);
 }

Authentication/Token/Storage/UsageTrackingTokenStorage.php

@@ -46,6 +46,10 @@ public function getToken(): ?TokenInterface
 
     public function setToken(TokenInterface $token = null): void
     {
+        if (1 > \func_num_args()) {
+            trigger_deprecation('symfony/security-core', '6.2', 'Calling "%s()" without any arguments is deprecated. Please explicitly pass null if you want to unset the token.', __METHOD__);
+        }
+
         $this->storage->setToken($token);
 
         if ($token && $this->shouldTrackUsage()) {

CHANGELOG.md

@@ -4,7 +4,9 @@ CHANGELOG
 6.2
 ---
 
-* Deprecate the `Security` class, use `Symfony\Bundle\SecurityBundle\Security\Security` instead
+ * Deprecate the `Security` class, use `Symfony\Bundle\SecurityBundle\Security\Security` instead
+ * Change the signature of `TokenStorageInterface::setToken()` to `setToken(?TokenInterface $token)`
+ * Deprecate calling `TokenStorage::setToken()` or `UsageTrackingTokenStorage::setToken()` without arguments
 
 6.0
 ---

Tests/Authentication/Token/Storage/TokenStorageTest.php

@@ -12,18 +12,39 @@
 namespace Symfony\Component\Security\Core\Tests\Authentication\Token\Storage;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorage;
 use Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken;
 use Symfony\Component\Security\Core\User\InMemoryUser;
 
 class TokenStorageTest extends TestCase
 {
+    use ExpectDeprecationTrait;
+
+    /**
+     * @group legacy
+     */
+    public function testGetSetTokenLegacy()
+    {
+        $tokenStorage = new TokenStorage();
+        $token = new UsernamePasswordToken('username', 'password', 'provider');
+        $tokenStorage->setToken($token);
+        $this->assertSame($token, $tokenStorage->getToken());
+
+        $this->expectDeprecation('Since symfony/security-core 6.2: Calling "Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorage::setToken()" without any arguments is deprecated. Please explicitly pass null if you want to unset the token.');
+
+        $tokenStorage->setToken();
+        $this->assertNull($tokenStorage->getToken());
+    }
+
     public function testGetSetToken()
     {
         $tokenStorage = new TokenStorage();
         $this->assertNull($tokenStorage->getToken());
         $token = new UsernamePasswordToken(new InMemoryUser('username', 'password'), 'provider');
         $tokenStorage->setToken($token);
         $this->assertSame($token, $tokenStorage->getToken());
+        $tokenStorage->setToken(null);
+        $this->assertNull($tokenStorage->getToken());
     }
 }