Deprecat service "session"

Author: jderusse

Authentication/Token/Storage/UsageTrackingTokenStorage.php

@@ -12,6 +12,7 @@
 namespace Symfony\Component\Security\Core\Authentication\Token\Storage;
 
 use Psr\Container\ContainerInterface;
+use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpFoundation\Session\SessionInterface;
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 use Symfony\Contracts\Service\ServiceSubscriberInterface;
@@ -24,13 +25,13 @@
 final class UsageTrackingTokenStorage implements TokenStorageInterface, ServiceSubscriberInterface
 {
     private $storage;
-    private $sessionLocator;
+    private $container;
     private $enableUsageTracking = false;
 
-    public function __construct(TokenStorageInterface $storage, ContainerInterface $sessionLocator)
+    public function __construct(TokenStorageInterface $storage, ContainerInterface $container)
     {
         $this->storage = $storage;
-        $this->sessionLocator = $sessionLocator;
+        $this->container = $container;
     }
 
     /**
@@ -40,7 +41,7 @@ public function getToken(): ?TokenInterface
     {
         if ($this->enableUsageTracking) {
             // increments the internal session usage index
-            $this->sessionLocator->get('session')->getMetadataBag();
+            $this->getSession()->getMetadataBag();
         }
 
         return $this->storage->getToken();
@@ -55,7 +56,7 @@ public function setToken(TokenInterface $token = null): void
 
         if ($token && $this->enableUsageTracking) {
             // increments the internal session usage index
-            $this->sessionLocator->get('session')->getMetadataBag();
+            $this->getSession()->getMetadataBag();
         }
     }
 
@@ -72,7 +73,19 @@ public function disableUsageTracking(): void
     public static function getSubscribedServices(): array
     {
         return [
-            'session' => SessionInterface::class,
+            'request_stack' => RequestStack::class,
         ];
     }
+
+    private function getSession(): SessionInterface
+    {
+        // BC for symfony/security-bundle < 5.3
+        if ($this->container->has('session')) {
+            trigger_deprecation('symfony/security-core', '5.3', 'Injecting the "session" in "%s" is deprecated, inject the "request_stack" instead.', __CLASS__);
+
+            return $this->container->get('session');
+        }
+
+        return $this->container->get('request_stack')->getSession();
+    }
 }

Tests/Authentication/Token/Storage/UsageTrackingTokenStorageTest.php

@@ -13,6 +13,8 @@
 
 use PHPUnit\Framework\TestCase;
 use Psr\Container\ContainerInterface;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpFoundation\Session\SessionInterface;
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorage;
 use Symfony\Component\Security\Core\Authentication\Token\Storage\UsageTrackingTokenStorage;
@@ -24,14 +26,19 @@ class UsageTrackingTokenStorageTest extends TestCase
     public function testGetSetToken()
     {
         $sessionAccess = 0;
-        $sessionLocator = new class(['session' => function () use (&$sessionAccess) {
+        $sessionLocator = new class(['request_stack' => function () use (&$sessionAccess) {
             ++$sessionAccess;
 
             $session = $this->createMock(SessionInterface::class);
             $session->expects($this->once())
                     ->method('getMetadataBag');
 
-            return $session;
+            $request = new Request();
+            $request->setSession($session);
+            $requestStack = new RequestStack();
+            $requestStack->push($request);
+
+            return $requestStack;
         }]) implements ContainerInterface {
             use ServiceLocatorTrait;
         };

composer.json

@@ -26,14 +26,15 @@
         "psr/container": "^1.0",
         "symfony/event-dispatcher": "^4.4|^5.0",
         "symfony/expression-language": "^4.4|^5.0",
-        "symfony/http-foundation": "^4.4|^5.0",
+        "symfony/http-foundation": "^5.3",
         "symfony/ldap": "^4.4|^5.0",
         "symfony/translation": "^4.4|^5.0",
         "symfony/validator": "^5.2",
         "psr/log": "~1.0"
     },
     "conflict": {
         "symfony/event-dispatcher": "<4.4",
+        "symfony/http-foundation": "<5.3",
         "symfony/security-guard": "<4.4",
         "symfony/ldap": "<4.4",
         "symfony/validator": "<5.2"