Introduce isStateless method

VincentLanglet · VincentLanglet · commit 05d485225b84 · 2024-06-23T16:32:31.000+02:00
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Security/FirewallMapTest.php b/src/Symfony/Bundle/SecurityBundle/Tests/Security/FirewallMapTest.php
@@ -88,7 +88,7 @@ public function testGetListeners(Request $request, bool $expectedState)
         $this->assertEquals([[$listener], $exceptionListener, $logoutListener], $firewallMap->getListeners($request));
         $this->assertEquals($firewallConfig, $firewallMap->getFirewallConfig($request));
         $this->assertEquals('security.firewall.map.context.foo', $request->attributes->get(self::ATTRIBUTE_FIREWALL_CONTEXT));
-        $this->assertEquals($expectedState, $request->attributes->get('_stateless'));
+        $this->assertEquals($expectedState, $request->isStateless());
     }
 
     public static function providesStatefulStatelessRequests(): \Generator
diff --git a/src/Symfony/Component/HttpFoundation/Request.php b/src/Symfony/Component/HttpFoundation/Request.php
@@ -652,6 +652,11 @@ public function get(string $key, mixed $default = null): mixed
         return $default;
     }
 
+    public function isStateless(): bool
+    {
+        return $this->attributes->getBoolean('_stateless');
+    }
+
     /**
      * Gets the Session.
      *
diff --git a/src/Symfony/Component/HttpKernel/DataCollector/RequestDataCollector.php b/src/Symfony/Component/HttpKernel/DataCollector/RequestDataCollector.php
@@ -106,7 +106,7 @@ public function collect(Request $request, Response $response, ?\Throwable $excep
             'session_metadata' => $sessionMetadata,
             'session_attributes' => $sessionAttributes,
             'session_usages' => array_values($this->sessionUsages),
-            'stateless_check' => $this->requestStack?->getMainRequest()?->attributes->get('_stateless') ?? false,
+            'stateless_check' => $this->requestStack?->getMainRequest()?->isStateless() ?? false,
             'flashes' => $flashes,
             'path_info' => $request->getPathInfo(),
             'controller' => 'n/a',
diff --git a/src/Symfony/Component/HttpKernel/EventListener/AbstractSessionListener.php b/src/Symfony/Component/HttpKernel/EventListener/AbstractSessionListener.php
@@ -206,7 +206,7 @@ public function onKernelResponse(ResponseEvent $event): void
                 ->headers->addCacheControlDirective('must-revalidate');
         }
 
-        if (!$event->getRequest()->attributes->get('_stateless', false)) {
+        if (!$event->getRequest()->isStateless()) {
             return;
         }
 
@@ -239,7 +239,7 @@ public function onSessionUsage(): void
         $stateless = false;
         $clonedRequestStack = clone $requestStack;
         while (null !== ($request = $clonedRequestStack->pop()) && !$stateless) {
-            $stateless = $request->attributes->get('_stateless');
+            $stateless = $request->isStateless();
         }
 
         if (!$stateless) {
diff --git a/src/Symfony/Component/HttpKernel/Tests/Fragment/InlineFragmentRendererTest.php b/src/Symfony/Component/HttpKernel/Tests/Fragment/InlineFragmentRendererTest.php
@@ -281,7 +281,7 @@ public function testStatelessAttributeIsForwardedByDefault()
         $kernel
             ->expects($this->once())
             ->method('handle')
-            ->with($this->callback(static fn (Request $subRequest) => $subRequest->attributes->get('_stateless')))
+            ->with($this->callback(static fn (Request $subRequest) => $subRequest->isStateless()))
         ;
         $strategy = new InlineFragmentRenderer($kernel);
         $strategy->render('/', $request);
@@ -296,7 +296,7 @@ public function testStatelessAttributeCanBeDisabled()
         $kernel
             ->expects($this->once())
             ->method('handle')
-            ->with($this->callback(static fn (Request $subRequest) => !$subRequest->attributes->get('_stateless')))
+            ->with($this->callback(static fn (Request $subRequest) => !$subRequest->isStateless()))
         ;
         $strategy = new InlineFragmentRenderer($kernel);
         $strategy->render(new ControllerReference('main_controller', ['_stateless' => false]), $request);
diff --git a/src/Symfony/Component/Security/Http/Authentication/DefaultAuthenticationFailureHandler.php b/src/Symfony/Component/Security/Http/Authentication/DefaultAuthenticationFailureHandler.php
@@ -86,7 +86,7 @@ public function onAuthenticationFailure(Request $request, AuthenticationExceptio
 
         $this->logger?->debug('Authentication failure, redirect triggered.', ['failure_path' => $options['failure_path']]);
 
-        if (!$request->attributes->getBoolean('_stateless')) {
+        if (!$request->isStateless()) {
             $request->getSession()->set(SecurityRequestAttributes::AUTHENTICATION_ERROR, $exception);
         }
 
diff --git a/src/Symfony/Component/Security/Http/Authentication/DefaultAuthenticationSuccessHandler.php b/src/Symfony/Component/Security/Http/Authentication/DefaultAuthenticationSuccessHandler.php
@@ -99,7 +99,7 @@ protected function determineTargetUrl(Request $request): string
         }
 
         $firewallName = $this->getFirewallName();
-        if (null !== $firewallName && !$request->attributes->getBoolean('_stateless') && $targetUrl = $this->getTargetPath($request->getSession(), $firewallName)) {
+        if (null !== $firewallName && !$request->isStateless() && $targetUrl = $this->getTargetPath($request->getSession(), $firewallName)) {
             $this->removeTargetPath($request->getSession(), $firewallName);
 
             return $targetUrl;

Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ public function testGetListeners(Request $request, bool $expectedState)`
`88`	`88`	`$this->assertEquals([[$listener], $exceptionListener, $logoutListener], $firewallMap->getListeners($request));`
`89`	`89`	`$this->assertEquals($firewallConfig, $firewallMap->getFirewallConfig($request));`
`90`	`90`	`$this->assertEquals('security.firewall.map.context.foo', $request->attributes->get(self::ATTRIBUTE_FIREWALL_CONTEXT));`
`91`		`- $this->assertEquals($expectedState, $request->attributes->get('_stateless'));`
	`91`	`+ $this->assertEquals($expectedState, $request->isStateless());`
`92`	`92`	`}`
`93`	`93`
`94`	`94`	`public static function providesStatefulStatelessRequests(): \Generator`
Original file line number	Diff line number	Diff line change
`@@ -652,6 +652,11 @@ public function get(string $key, mixed $default = null): mixed`
`652`	`652`	`return $default;`
`653`	`653`	`}`
`654`	`654`
	`655`	`+ public function isStateless(): bool`
	`656`	`+ {`
	`657`	`+ return $this->attributes->getBoolean('_stateless');`
	`658`	`+ }`
	`659`	`+`
`655`	`660`	`/**`
`656`	`661`	`* Gets the Session.`
`657`	`662`	`*`
Original file line number	Diff line number	Diff line change
`@@ -206,7 +206,7 @@ public function onKernelResponse(ResponseEvent $event): void`
`206`	`206`	`->headers->addCacheControlDirective('must-revalidate');`
`207`	`207`	`}`
`208`	`208`
`209`		`- if (!$event->getRequest()->attributes->get('_stateless', false)) {`
	`209`	`+ if (!$event->getRequest()->isStateless()) {`
`210`	`210`	`return;`
`211`	`211`	`}`
`212`	`212`
`@@ -239,7 +239,7 @@ public function onSessionUsage(): void`
`239`	`239`	`$stateless = false;`
`240`	`240`	`$clonedRequestStack = clone $requestStack;`
`241`	`241`	`while (null !== ($request = $clonedRequestStack->pop()) && !$stateless) {`
`242`		`- $stateless = $request->attributes->get('_stateless');`
	`242`	`+ $stateless = $request->isStateless();`
`243`	`243`	`}`
`244`	`244`
`245`	`245`	`if (!$stateless) {`
Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ public function onAuthenticationFailure(Request $request, AuthenticationExceptio`
`86`	`86`
`87`	`87`	`$this->logger?->debug('Authentication failure, redirect triggered.', ['failure_path' => $options['failure_path']]);`
`88`	`88`
`89`		`- if (!$request->attributes->getBoolean('_stateless')) {`
	`89`	`+ if (!$request->isStateless()) {`
`90`	`90`	`$request->getSession()->set(SecurityRequestAttributes::AUTHENTICATION_ERROR, $exception);`
`91`	`91`	`}`
`92`	`92`
Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ protected function determineTargetUrl(Request $request): string`
`99`	`99`	`}`
`100`	`100`
`101`	`101`	`$firewallName = $this->getFirewallName();`
`102`		`- if (null !== $firewallName && !$request->attributes->getBoolean('_stateless') && $targetUrl = $this->getTargetPath($request->getSession(), $firewallName)) {`
	`102`	`+ if (null !== $firewallName && !$request->isStateless() && $targetUrl = $this->getTargetPath($request->getSession(), $firewallName)) {`
`103`	`103`	`$this->removeTargetPath($request->getSession(), $firewallName);`
`104`	`104`
`105`	`105`	`return $targetUrl;`