[FrameworkBundle][HttpKernel] Add deprecation warning to show `HttpKernel::handle()` will catch throwables #45997

Nyholm · 2022-04-11T14:14:41Z

Q	A
Branch?	6.2
Bug fix?	no
New feature?	no
Deprecations?	yes
Tickets	Fix #16205
License	MIT
Doc PR	symfony/symfony-docs#...

I suggest that starting from Symfony 7.0 the HttpKernel will start to catch \Throwable and convert them to a Response.

This was first asked in #16205, I face a similar issue with Runtime component and Bref..

The reason I push for this change is to embrace the request/response workflow of the Kernel without trusting the custom error handler. In an environment where you serve multiple requests with the same PHP process (read: RoadRunner, Swoole, Bref) you would write something like:

$kernel = new Kernel('prod', false);
while (true) {
  $request = /* create sf request from custom environment */
  try {
    $response = $kernel->handle(request);
    return ResponseConverter::convert($response);
  } catch (\Throwable $e) {
    exit(1);
  }
}

(pseudo code of course. Here is a real example)

The exit(1) means a hard crash. For Bref Runtime it would result in a 500 error from API-gateway. Since the \Throwable is caught, the Symfony error handler is not used. If we would not to catch the \Throwable, then the Symfony error handler would be used, but it would print a Response instead of returning it. (Printing a response will just add HTML on the CLI...)

Other PRs and issues related to this:

I'm happy to let the HttpKernel to catch the \Throwable exception right now, but I thought this very conservative PR would have a higher change to get merged.

Also note that we do not specify any behaviour on our HttpKernelInterface

To remove the deprecation message you need to add this to your config:

framework:
    catch_all_throwables: true

stof · 2022-04-11T14:39:42Z

A deprecation for which there is no way to opt-in for the new behavior is bad: it does not help migrating and will annoy people seeing it without being able to get rid of it.

Nyholm · 2022-04-11T14:43:13Z

Hm. You are very correct. Thank you. Do you have a suggestion on how to make an opt-in?

stof · 2022-04-11T14:48:06Z

Well, you would need some kind of configuration parameter that can turn on the catching of errors.

Nyholm · 2022-04-23T10:02:35Z

Thank you for the review. I've update the PR with a way to opt-in to the new behaviour. I've also added some tests.

Nyholm · 2022-04-24T09:13:42Z

Psalm and Fabbot are both false negatives. It seams like the 8.2 test fails for unrelated reasons.

PHPUnit 8.1 low-deps fails because of this PR. Any suggestions how I could fix them?

derrabus · 2022-04-24T19:02:34Z

Thank you very much for bringing this topic up again. I like how you allow to opt-in to the new behavior.

PHPUnit 8.1 low-deps fails because of this PR. Any suggestions how I could fix them?

The lazy fix would be to add conflict rules to the composer.json files of SecurityBundle and WebProfilerBundle, for FrameworkBundle < 6.1. The alterantive would be to make the test setup for the bundles more complex by setting/removing that option conditionally and I'm not sure that's worth it.

Nyholm · 2022-04-24T19:35:48Z

Thank you for the feedback. I've updated the PR.

Nyholm · 2022-05-01T08:04:50Z

The PR is rebased and updated.

status: Waiting for review

Nyholm · 2022-05-29T11:19:30Z

The PR is updated for 6.2. Fabbot is a false negative and the PHP 8.2 test fail is unrelated.

I would be happy to get another review on this. I believe it is ready to merge

src/Symfony/Bundle/FrameworkBundle/Test/ExceptionListener.php

Nyholm · 2022-05-29T11:33:20Z

Thank you for the review. I've applied the changes.

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php

src/Symfony/Bundle/FrameworkBundle/Test/ExceptionListener.php

xabbuh · 2022-06-16T06:38:06Z

src/Symfony/Bundle/FrameworkBundle/Test/ExceptionListener.php

+    public static function getExceptions(): array
+    {
+        $exceptions = self::$exceptions;
+        self::$exceptions = [];


For a getter method I would not expect the method to modify the object's state but to be able to call the method several times with the same result.

I'll name this resetExceptions()

Now it's not really clear that I could use this method retrieve the list of all caught exceptions. What about adapting the schema used for methods in the SPL and use something like shiftAll()?

src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/Uid/config_disabled.yml

src/Symfony/Bundle/FrameworkBundle/Tests/Functional/UidTest.php

Nyholm · 2022-06-16T08:24:14Z

I've applied all changes and the CI is green

src/Symfony/Component/HttpKernel/HttpKernel.php

Nyholm · 2022-06-16T18:16:04Z

I've applied the suggested changes. I've rebased the PR and the tests are green.

Could I get a final round of reviews?

HeahDude

~~It would seem the composer.json file of the WebProfilerBundle needs an update as well (https://github.com/symfony/symfony/blob/6.2/src/Symfony/Bundle/WebProfilerBundle/composer.json#L21).~~

EDIT: it seems I've missed https://github.com/symfony/symfony/pull/45997/files#diff-b7944e9265a9fd4f68f0fb505d9c8375791e607b9709dd3bd93519990683f4c7R62

src/Symfony/Bundle/FrameworkBundle/Test/ExceptionSubscriber.php

HeahDude · 2022-06-16T19:20:46Z

src/Symfony/Component/HttpKernel/HttpKernel.php

    {
        $this->dispatcher = $dispatcher;
        $this->resolver = $resolver;
        $this->requestStack = $requestStack ?? new RequestStack();
        $this->argumentResolver = $argumentResolver ?? new ArgumentResolver();
+        $this->catchThrowable = $catchThrowable;
+        if (!$catchThrowable) {
+            trigger_deprecation('symfony/http-kernel', '6.2', 'Starting from 7.0, "%s::handle()" will catch \Throwable exceptions and convert them to HttpFoundation responses.', self::class);


This depreciation message is not actionable. It should tell to pass true as last argument to get rid of it.

Although this would still not be the right fix in the framework context, since the catch_all_throwables option needs to be set to true.
Maybe the configuration needs a ->validate() node to trigger on false with the "good" message.

I've updated the exception message.

Maybe the configuration needs a ->validate() node to trigger on false with the "good" message.

Hm.. Yeah. But isn't that overkill?

I can see two paths. Once you get rid of the deprecation you should be ready for 7.0, but in this case it means passing true instead of false.

Removing the argument and the config node could be done in 8.0, once first deprecated in 7.1.

However removing the arg as it seems to be expected in 7.0 won't break, but will make passing the arg some dead code without notice. Also removing the config node in 7.0 would be a BC break if devs continue to define it to true.

Since the constructor argument and config is part of the deprecation layer they will both be removed in 7.0.
Aren't we overthinking now?

choices_as_values option was used for Symfony 2 deprecation layer, but deprecated in 3.1,
logout_on_user_change option was used in Symfony 3 deprecation layer and deprecated in 4.1 and so on.

The BC should be to not change your code when upgrading to 7.0, in this case changing false to true would make it work, but once done, another change would be required to remove config and arg, so they must still exist before we can safely remove them.

In other words, the deprecation layer itself cannot be deprecated in 6.x nor removed in 7.0, it needs to be deprecated in 7.1.

Maybe the configuration needs a ->validate() node to trigger on false with the "good" message.

Hm... Yeah. But isn't that overkill?

Well, the problem I see is that most devs using the framework do not even know there is an HttpKernel service nor how to change this arg.
However, mentioning the config key in this message from the component feels wrong.

src/Symfony/Component/HttpKernel/HttpKernel.php

HeahDude · 2022-06-16T19:32:26Z

It would be nice to have this default to true with the 6.2 recipe for new projects (and smooth upgrade with composer recipes:update).

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php

src/Symfony/Bundle/FrameworkBundle/Test/ExceptionSubscriber.php

src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/Uid/config_disabled.yml

src/Symfony/Component/HttpKernel/Tests/HttpKernelTest.php

…ables

Nyholm · 2022-06-25T07:27:02Z

I've rebased the PR and squashed the commits.

The CI failures are not related to this PR. Could I ask you to review this PR again to decide if it is good enough to merge.

fabpot · 2022-06-25T07:42:32Z

Thank you @Nyholm.

Nyholm · 2022-06-25T09:16:09Z

Awesome. Thank you for merging.

Big thank you to all reviewers too

…es` to allow `HttpKernel` to handle thrown `Error` in addition to `Exception` (nicolas-grekas) This PR was squashed before being merged into the 6.2 branch. Discussion ---------- [HttpKernel] Add request attribute `_handle_all_throwables` to allow `HttpKernel` to handle thrown `Error` in addition to `Exception` | Q | A | ------------- | --- | Branch? | 6.2 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - I understand the motivation behind #45997 but I don't think the deprecation is worth the migration cost on *all* users of Symfony. The burden of enabling this setting should only be on use cases where getting a response back is needed. The previous behavior was just fine in common situations. /cc `@catch56` for Drupal FYI /cc `@Nyholm` also Commits ------- 8604d3a [HttpKernel] Add request attribute `_handle_all_throwables` to allow `HttpKernel` to handle thrown `Error` in addition to `Exception`

…st to fix CI (jmsche) This PR was merged into the main branch. Discussion ---------- Rename catch_all_throwables to handle_all_throwables in test to fix CI Little fix required to make CI pass again :) The `catch_all_throwables` parameter was renamed by this PR: symfony/symfony#45997 Commits ------- aae2142 Rename catch_all_throwables to handle_all_throwables in test to fix CI

…st to fix CI (jmsche) This PR was merged into the main branch. Discussion ---------- Rename catch_all_throwables to handle_all_throwables in test to fix CI Little fix required to make CI pass again :) The `catch_all_throwables` parameter was renamed by this PR: symfony/symfony#45997 Commits ------- aae2142 Rename catch_all_throwables to handle_all_throwables in test to fix CI

carsonbot added Status: Needs Review Deprecation labels Apr 11, 2022

carsonbot added this to the 6.1 milestone Apr 11, 2022

Nyholm requested review from wouterj and chalasr as code owners April 24, 2022 08:18

Nyholm force-pushed the http-kernel-throwable branch from f806125 to e414827 Compare April 24, 2022 08:45

Nyholm force-pushed the http-kernel-throwable branch from 67077c1 to 08ce868 Compare May 1, 2022 07:57

fabpot modified the milestones: 6.1, 6.2 May 20, 2022

Nyholm force-pushed the http-kernel-throwable branch 4 times, most recently from 77bb69f to a5acdbb Compare May 29, 2022 11:12

derrabus approved these changes May 29, 2022

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Test/ExceptionListener.php Outdated Show resolved Hide resolved

src/Symfony/Bundle/FrameworkBundle/Test/ExceptionListener.php Outdated Show resolved Hide resolved

carsonbot added Status: Reviewed and removed Status: Needs Review labels May 29, 2022

derrabus added HttpKernel FrameworkBundle labels Jun 14, 2022

carsonbot changed the title ~~Add deprecation warning to show HttpKernel::handle() will catch throwables~~ [FrameworkBundle][HttpKernel] Add deprecation warning to show HttpKernel::handle() will catch throwables Jun 14, 2022

derrabus mentioned this pull request Jun 14, 2022

No catch Throwable errors #46596

Closed

xabbuh reviewed Jun 16, 2022

View reviewed changes

HeahDude reviewed Jun 16, 2022

View reviewed changes

src/Symfony/Component/HttpKernel/HttpKernel.php Outdated Show resolved Hide resolved

src/Symfony/Component/HttpKernel/HttpKernel.php Show resolved Hide resolved

Nyholm force-pushed the http-kernel-throwable branch from 98e1a72 to a906e6c Compare June 16, 2022 16:30

HeahDude reviewed Jun 16, 2022

View reviewed changes

Nyholm mentioned this pull request Jun 16, 2022

[FramworkBundle] Added config framework.catch_all_throwables: true symfony/recipes#1098

Merged

OskarStark reviewed Jun 16, 2022

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php Outdated Show resolved Hide resolved

OskarStark reviewed Jun 16, 2022

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Test/ExceptionSubscriber.php Show resolved Hide resolved

OskarStark reviewed Jun 16, 2022

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/Uid/config_disabled.yml Outdated Show resolved Hide resolved

OskarStark changed the title ~~[FrameworkBundle][HttpKernel] Add deprecation warning to show HttpKernel::handle() will catch throwables~~ [FrameworkBundle][HttpKernel] Add deprecation warning to show HttpKernel::handle() will catch throwables Jun 16, 2022

xabbuh reviewed Jun 17, 2022

View reviewed changes

src/Symfony/Component/HttpKernel/Tests/HttpKernelTest.php Outdated Show resolved Hide resolved

Add deprecation warning to show HttpKernel::handle() will catch throw…

7977a15

…ables

Nyholm force-pushed the http-kernel-throwable branch from 96fefac to 7977a15 Compare June 25, 2022 07:18

fabpot approved these changes Jun 25, 2022

View reviewed changes

fabpot mentioned this pull request Jun 25, 2022

[FrameworkBundle][HttpKernel] Add deprecation warning to show `HttpKern… symfony/symfony-docs#16917

Closed

fabpot merged commit 6597825 into symfony:6.2 Jun 25, 2022

nicolas-grekas mentioned this pull request Sep 2, 2022

[HttpKernel] Add "handle-all-throwables option to handle thrown Error in addition to Exception` #47467

Merged

Guuzen mentioned this pull request Sep 2, 2022

Using ErrorController do not give serialized exceptions for all exception types #45478

Closed

derrabus mentioned this pull request Sep 27, 2022

catch \Throwable instead of \Exception #47708

Closed

jmsche mentioned this pull request Oct 19, 2022

Rename catch_all_throwables to handle_all_throwables in test to fix CI symfony/webpack-encore-bundle#196

Merged

dunglas mentioned this pull request Oct 19, 2022

Proposal: remove automatic exceptions handling php/frankenphp#41

Closed

fabpot mentioned this pull request Oct 24, 2022

Release v6.2.0-BETA1 #47972

Merged

Uh oh!

[FrameworkBundle][HttpKernel] Add deprecation warning to show HttpKernel::handle() will catch throwables #45997

[FrameworkBundle][HttpKernel] Add deprecation warning to show HttpKernel::handle() will catch throwables #45997

Uh oh!

Conversation

Nyholm commented Apr 11, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stof commented Apr 11, 2022

Uh oh!

Nyholm commented Apr 11, 2022

Uh oh!

stof commented Apr 11, 2022

Uh oh!

Nyholm commented Apr 23, 2022

Uh oh!

Nyholm commented Apr 24, 2022

Uh oh!

derrabus commented Apr 24, 2022

Uh oh!

Nyholm commented Apr 24, 2022

Uh oh!

Nyholm commented May 1, 2022

Uh oh!

Nyholm commented May 29, 2022

Uh oh!

Uh oh!

Uh oh!

Nyholm commented May 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Nyholm commented Jun 16, 2022

Uh oh!

Uh oh!

Uh oh!

Nyholm commented Jun 16, 2022

Uh oh!

HeahDude left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

HeahDude Jun 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

HeahDude commented Jun 16, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Nyholm commented Jun 25, 2022

Uh oh!

fabpot commented Jun 25, 2022

Uh oh!

Nyholm commented Jun 25, 2022

Uh oh!

Uh oh!

[FrameworkBundle][HttpKernel] Add deprecation warning to show `HttpKernel::handle()` will catch throwables #45997

[FrameworkBundle][HttpKernel] Add deprecation warning to show `HttpKernel::handle()` will catch throwables #45997

Nyholm commented Apr 11, 2022 •

edited

Loading

Nyholm commented May 29, 2022 •

edited

Loading

HeahDude left a comment •

edited

Loading

HeahDude Jun 16, 2022 •

edited

Loading