Skip to content

Commit 18c2dde

Browse files
nicolas-grekasnicolas-grekas
committed
feature #27519 [HttpKernel][FrameworkBundle] Turn HTTP exceptions to HTTP status codes by default (nicolas-grekas)
This PR was merged into the 4.2-dev branch. Discussion ---------- [HttpKernel][FrameworkBundle] Turn HTTP exceptions to HTTP status codes by default | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #25844 | License | MIT | Doc PR | - When an exception is thrown, *if it is not handled* then it will be reinjected as a 2nd exception event via `HttpKernel::terminateWithException()`. When this happens, this will generate a proper HTTP status code. Commits ------- 80b0739 [HttpKernel][FrameworkBundle] Turn HTTP exceptions to HTTP status codes by default
2 parents ac1189a + 80b0739 commit 18c2dde

File tree

3 files changed

+59
-3
lines changed

3 files changed

+59
-3
lines changed

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,16 @@
6767
<argument type="service" id="router" on-invalid="ignore" />
6868
</service>
6969

70+
<service id="http_exception_listener" class="Symfony\Component\HttpKernel\EventListener\ExceptionListener">
71+
<tag name="kernel.event_listener" event="kernel.exception" method="onKernelException" priority="-2048" />
72+
<tag name="kernel.reset" method="reset" />
73+
<argument>null</argument>
74+
<argument>null</argument>
75+
<argument>%kernel.debug%</argument>
76+
<argument>%kernel.charset%</argument>
77+
<argument>%debug.file_link_format%</argument>
78+
</service>
79+
7080
<service id="validate_request_listener" class="Symfony\Component\HttpKernel\EventListener\ValidateRequestListener">
7181
<tag name="kernel.event_subscriber" />
7282
</service>

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

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,10 @@
1313

1414
use Psr\Log\LoggerInterface;
1515
use Symfony\Component\Debug\Exception\FlattenException;
16+
use Symfony\Component\Debug\ExceptionHandler;
1617
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
1718
use Symfony\Component\HttpFoundation\Request;
19+
use Symfony\Component\HttpFoundation\Response;
1820
use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
1921
use Symfony\Component\HttpKernel\Log\DebugLoggerInterface;
2022
use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
@@ -33,12 +35,17 @@ class ExceptionListener implements EventSubscriberInterface
3335
protected $controller;
3436
protected $logger;
3537
protected $debug;
38+
private $charset;
39+
private $fileLinkFormat;
40+
private $isTerminating = false;
3641

37-
public function __construct($controller, LoggerInterface $logger = null, $debug = false)
42+
public function __construct($controller, LoggerInterface $logger = null, $debug = false, string $charset = null, $fileLinkFormat = null)
3843
{
3944
$this->controller = $controller;
4045
$this->logger = $logger;
4146
$this->debug = $debug;
47+
$this->charset = $charset;
48+
$this->fileLinkFormat = $fileLinkFormat;
4249
}
4350

4451
public function logKernelException(GetResponseForExceptionEvent $event)
@@ -50,6 +57,17 @@ public function logKernelException(GetResponseForExceptionEvent $event)
5057

5158
public function onKernelException(GetResponseForExceptionEvent $event)
5259
{
60+
if (null === $this->controller) {
61+
if (!$event->isMasterRequest()) {
62+
return;
63+
}
64+
if (!$this->isTerminating) {
65+
$this->isTerminating = true;
66+
67+
return;
68+
}
69+
$this->isTerminating = false;
70+
}
5371
$exception = $event->getException();
5472
$request = $this->duplicateRequest($exception, $event->getRequest());
5573
$eventDispatcher = func_num_args() > 2 ? func_get_arg(2) : null;
@@ -85,6 +103,11 @@ public function onKernelException(GetResponseForExceptionEvent $event)
85103
}
86104
}
87105

106+
public function reset()
107+
{
108+
$this->isTerminating = false;
109+
}
110+
88111
public static function getSubscribedEvents()
89112
{
90113
return array(
@@ -123,8 +146,12 @@ protected function logException(\Exception $exception, $message)
123146
protected function duplicateRequest(\Exception $exception, Request $request)
124147
{
125148
$attributes = array(
126-
'_controller' => $this->controller,
127-
'exception' => FlattenException::create($exception),
149+
'exception' => $exception = FlattenException::create($exception),
150+
'_controller' => $this->controller ?: function () use ($exception) {
151+
$handler = new ExceptionHandler($this->debug, $this->charset, $this->fileLinkFormat);
152+
153+
return new Response($handler->getHtml($exception), $exception->getStatusCode(), $exception->getHeaders());
154+
},
128155
'logger' => $this->logger instanceof DebugLoggerInterface ? $this->logger : null,
129156
);
130157
$request = $request->duplicate(null, null, $attributes);

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

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,25 @@ public function testCSPHeaderIsRemoved()
155155
$this->assertFalse($response->headers->has('content-security-policy'), 'CSP header has been removed');
156156
$this->assertFalse($dispatcher->hasListeners(KernelEvents::RESPONSE), 'CSP removal listener has been removed');
157157
}
158+
159+
public function testNullController()
160+
{
161+
$listener = new ExceptionListener(null);
162+
$kernel = $this->getMockBuilder(HttpKernelInterface::class)->getMock();
163+
$kernel->expects($this->once())->method('handle')->will($this->returnCallback(function (Request $request) {
164+
$controller = $request->attributes->get('_controller');
165+
166+
return $controller();
167+
}));
168+
$request = Request::create('/');
169+
$event = new GetResponseForExceptionEvent($kernel, $request, HttpKernelInterface::MASTER_REQUEST, new \Exception('foo'));
170+
171+
$listener->onKernelException($event);
172+
$this->assertNull($event->getResponse());
173+
174+
$listener->onKernelException($event);
175+
$this->assertContains('Whoops, looks like something went wrong.', $event->getResponse()->getContent());
176+
}
158177
}
159178

160179
class TestLogger extends Logger implements DebugLoggerInterface

0 commit comments

Comments
 (0)