8000 [FrameworkBundle][HttpFoundation] Add `_stateless` · symfony/symfony@33ed3e8 · GitHub
[go: up one dir, main page]
Skip to content

Commit 33ed3e8

Browse files
mtarldmtarld
committed
[FrameworkBundle][HttpFoundation] Add _stateless 
1 parent a4c0bfa commit 33ed3e8

File tree

7 files changed

+125
-15
lines changed

7 files changed

+125
-15
lines changed

‎src/Symfony/Bundle/FrameworkBundle/Resources/config/session.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,9 @@
6666
<argument type="service_locator">
6767
<argument key="session" type="service" id="session" on-invalid="ignore" />
6868
<argument key="initialized_session" type="service" id="session" on-invalid="ignore_uninitialized" />
69+
<argument key="logger" type="service" id="logger" on-invalid="ignore" />
6970
</argument>
71+
<argument>%kernel.debug%</argument>
7072
</service>
7173

7274
<!-- for BC -->

‎src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -504,7 +504,7 @@ public function testNullSessionHandler()
504504
$this->assertNull($container->getDefinition('session.storage.native')->getArgument(1));
505505
$this->assertNull($container->getDefinition('session.storage.php_bridge')->getArgument(0));
506506

507-
$expected = ['session', 'initialized_session'];
507+
$expected = ['session', 'initialized_session', 'logger'];
508508
$this->assertEquals($expected, array_keys($container->getDefinition('session_listener')->getArgument(0)->getValues()));
509509
}
510510

@@ -1301,7 +1301,7 @@ public function testSessionCookieSecureAuto()
13011301
{
13021302
$container = $this->createContainerFromFile('session_cookie_secure_auto');
13031303

1304-
$expected = ['session', 'initialized_session', 'session_storage', 'request_stack'];
1304+
$expected = ['session', 'initialized_session', 'logger', 'session_storage', 'request_stack'];
13051305
$this->assertEquals($expected, array_keys($container->getDefinition('session_listener')->getArgument(0)->getValues()));
13061306
}
13071307

‎src/Symfony/Component/HttpKernel/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ CHANGELOG
55
-----
66

77
* allowed using public aliases to reference controllers
8+
* added session usage reporting when the `_stateless` attribute of the request is set to `true`
89

910
5.0.0
1011
-----

‎src/Symfony/Component/HttpKernel/EventListener/AbstractSessionListener.php

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
use Symfony\Component\HttpKernel\Event\FinishRequestEvent;
1919
use Symfony\Component\HttpKernel\Event\RequestEvent;
2020
use Symfony\Component\HttpKernel\Event\ResponseEvent;
21+
use Symfony\Component\HttpKernel\Exception\UnexpectedSessionUsageException;
2122
use Symfony\Component\HttpKernel\KernelEvents;
2223

2324
/**
@@ -41,10 +42,12 @@ abstract class AbstractSessionListener implements EventSubscriberInterface
4142

4243
protected $container;
4344
private $sessionUsageStack = [];
45+
private $debug;
4446

45-
public function __construct(ContainerInterface $container = null)
47+
public function __construct(ContainerInterface $container = null, bool $debug = false)
4648
{
4749
$this->container = $container;
50+
$this->debug = $debug;
4851
}
4952

5053
public function onKernelRequest(RequestEvent $event)
@@ -82,16 +85,6 @@ public function onKernelResponse(ResponseEvent $event)
8285
return;
8386
}
8487

85-
if ($session instanceof Session ? $session->getUsageIndex() !== end($this->sessionUsageStack) : $session->isStarted()) {
86-
if ($autoCacheControl) {
87-
$response
88-
->setExpires(new \DateTime())
89-
->setPrivate()
90-
->setMaxAge(0)
91-
->headers->addCacheControlDirective('must-revalidate');
92-
}
93-
}
94-
9588
if ($session->isStarted()) {
9689
/*
9790
* Saves the session, in case it is still open, before sending the response/headers.
@@ -120,6 +113,20 @@ public function onKernelResponse(ResponseEvent $event)
120113
*/
121114
$session->save();
122115
}
116+
117+
if ($session instanceof Session ? $session->getUsageIndex() !== end($this->sessionUsageStack) : $session->isStarted()) {
118+
if ($event->getRequest()->attributes->get('_stateless', false)) {
119+
$this->reportUnexpectedSessionUse();
120+
}
121+
122+
if ($autoCacheControl) {
123+
$response
124+
->setExpires(new \DateTime())
125+
->setPrivate()
126+
->setMaxAge(0)
127+
->headers->addCacheControlDirective('must-revalidate');
128+
}
129+
}
123130
}
124131

125132
public function onFinishRequest(FinishRequestEvent $event)
@@ -145,4 +152,19 @@ public static function getSubscribedEvents(): array
145152
* @return SessionInterface|null A SessionInterface instance or null if no session is available
146153
*/
147154
abstract protected function getSession();
155+
156+
/**
157+
* @throws UnexpectedSessionUsageException
158+
*/
159+
private function reportUnexpectedSessionUse(): void
160+
{
161+
$message = 'Session was used while the request was declared stateless.';
162+
if ($this->debug) {
163+
throw new UnexpectedSessionUsageException($message);
164+
}
165+
166+
if ($this->container->has('logger')) {
167+
$this->container->get('logger')->warning($message);
168+
}
169+
}
148170
}

‎src/Symfony/Component/HttpKernel/EventListener/SessionListener.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@
2828
*/
2929
class SessionListener extends AbstractSessionListener
3030
{
31-
public function __construct(ContainerInterface $container)
31+
public function __construct(ContainerInterface $container, bool $debug = false)
3232
{
33-
$this->container = $container;
33+
parent::__construct($container, $debug);
3434
}
3535

3636
protected function getSession(): ?SessionInterface

‎src/Symfony/Component/HttpKernel/Exception/UnexpectedSessionUsageException.php

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\HttpKernel\Exception;
13+
14+
/**
15+
* @author Mathias Arlaud <mathias.arlaud@gmail.com>
16+
*/
17+
class UnexpectedSessionUsageException extends \LogicException
18+
{
19+
}

‎src/Symfony/Component/HttpKernel/Tests/EventListener/SessionListenerTest.php

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
namespace Symfony\Component\HttpKernel\Tests\EventListener;
1313

1414
use PHPUnit\Framework\TestCase;
15+
use Psr\Log\LoggerInterface;
1516
use Symfony\Component\DependencyInjection\Container;
1617
use Symfony\Component\DependencyInjection\ServiceLocator;
1718
use Symfony\Component\HttpFoundation\Request;
@@ -24,6 +25,7 @@
2425
use Symfony\Component\HttpKernel\Event\ResponseEvent;
2526
use Symfony\Component\HttpKernel\EventListener\AbstractSessionListener;
2627
use Symfony\Component\HttpKernel\EventListener\SessionListener;
28+
use Symfony\Component\HttpKernel\Exception\UnexpectedSessionUsageException;
2729
use Symfony\Component\HttpKernel\HttpKernelInterface;
2830

2931
class SessionListenerTest extends TestCase
@@ -178,4 +180,68 @@ public function testSurrogateMasterRequestIsPublic()
178180
$this->assertTrue($response->headers->has('Expires'));
179181
$this->assertLessThanOrEqual((new \DateTime('now', new \DateTimeZone('UTC'))), (new \DateTime($response->headers->get('Expires'))));
180182
}
183+
184+
public function testSessionUsageExceptionIfStatelessAndSessionUsed()
185+
{
186+
$session = $this->getMockBuilder(Session::class)->disableOriginalConstructor()->getMock();
187+
$session->expects($this->exactly(2))->method('getUsageIndex')->will($this->onConsecutiveCalls(0, 1));
188+
189+
$container = new Container();
190+
$container->set('initialized_session', $session);
191+
192+
$listener = new SessionListener($container, true);
193+
$kernel = $this->getMockBuilder(HttpKernelInterface::class)->disableOriginalConstructor()->getMock();
194+
195+
$request = new Request();
196+
$request->attributes->set('_stateless', true);
197+
$listener->onKernelRequest(new RequestEvent($kernel, $request, HttpKernelInterface::MASTER_REQUEST));
198+
199+
$this->expectException(UnexpectedSessionUsageException::class);
200+
$listener->onKernelResponse(new ResponseEvent($kernel, $request, HttpKernelInterface::MASTER_REQUEST, new Response()));
201+
}
202+
203+
public function testSessionUsageLogIfStatelessAndSessionUsed()
204+
{
205+
$session = $this->getMockBuilder(Session::class)->disableOriginalConstructor()->getMock();
206+
$session->expects($this->exactly(2))->method('getUsageIndex')->will($this->onConsecutiveCalls(0, 1));
207+
208+
$logger = $this->getMockBuilder(LoggerInterface::class)->disableOriginalConstructor()->getMock();
209+
$logger->expects($this->exactly(1))->method('warning');
210+
211+
$container = new Container();
212+
$container->set('initialized_session', $session);
213+
$container->set('logger', $logger);
214+
215+
$listener = new SessionListener($container, false);
216+
$kernel = $this->getMockBuilder(HttpKernelInterface::class)->disableOriginalConstructor()->getMock();
217+
218+
$request = new Request();
219+
$request->attributes->set('_stateless', true);
220+
$listener->onKernelRequest(new RequestEvent($kernel, $request, HttpKernelInterface::MASTER_REQUEST));
221+
222+
$listener->onKernelResponse(new ResponseEvent($kernel, $request, HttpKernelInterface::MASTER_REQUEST, new Response()));
223+
}
224+
225+
public function testSessionIsSavedWhenUnexpectedSessionExceptionThrown()
226+
{
227+
$session = $this->getMockBuilder(Session::class)->disableOriginalConstructor()->getMock();
228+
$session->method('isStarted')->willReturn(true);
229+
$session->expects($this->exactly(2))->method('getUsageIndex')->will($this->onConsecutiveCalls(0, 1));
230+
$session->expects($this->exactly(1))->method('save');
231+
232+
$container = new Container();
233+
$container->set('initialized_session', $session);
234+
235+
$listener = new SessionListener($container, true);
236+
$kernel = $this->getMockBuilder(HttpKernelInterface::class)->disableOriginalConstructor()->getMock();
237+
238+
$request = new Request();
239+
$request->attributes->set('_stateless', true);
240+
241+
$listener->onKernelRequest(new RequestEvent($kernel, $request, HttpKernelInterface::MASTER_REQUEST));
242+
243+
$response = new Response();
244+
$this->expectException(UnexpectedSessionUsageException::class);
245+
$listener->onKernelResponse(new ResponseEvent($kernel, $request, HttpKernelInterface::MASTER_REQUEST, $response));
246+
}
181247
}

0 commit comments

Comments
 (0)
0