Add an action to show error pages in kernel.debug mode #12096

mpdude · 2014-10-02T11:45:34Z

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#7446, #1486, #11327
License	MIT
Doc PR	symfony/symfony-docs#4293

See #7446 for the initial reasoning. In short, add to your routing_development.yml file the following

_errors:
    resource: "@TwigBundle/Resources/config/routing/errors.xml"
    prefix:   /_error

Then you can use http://localhost/app_dev.php/_error/xxx to preview the HTML error page that the default ExceptionController (from TwigBundle) would pick for the XXX status code.

You can also use http://localhost/app_dev.php/_error/xxx.{some_format} to show error pages for other formats than HTML, most notably txt.

Note that the status code will be 500 for all exceptions that do not implement HttpExceptionInterface.

Want to test with a custom exception?

~~Folks might want to display (part of) the exception even on error pages and thus need to work with generic (own) exceptions.~~

They could write an arbitrary controller and throw their exception there. By default, the ExceptionController would be used to handle this, only that it would not show error pages in kernel.debug mode.

~~Thus, a simple public setter to change the debug flag after construction could help. Do we want to add that as well?~~

If you want to test error pages with your own exceptions,

create a subclass of ExceptionController
set the protected debug flag to false
register it as twig.exception_controller in the config
throw your custom exception from any controller.

That should give you the error page also in kernel.debug mode.

To-Do

Update docs
Add route in symfony/symfony-default

fabpot · 2014-10-02T13:31:38Z

@weaverryan Can you have a look at this PR. It would be great if we can accept it today or tomorrow for inclusion in 2.6. Thanks.

mpdude · 2014-10-02T13:48:15Z

When do you need PRs for symfony/symfony-standard and or -docs at the latest?

fabpot · 2014-10-02T14:10:57Z

@mpdude before the end of the week (Sunday.)

weaverryan · 2014-10-02T21:06:35Z

src/Symfony/Bundle/TwigBundle/Controller/ExceptionController.php

+    {
+        try {
+            throw new \Exception("Something has intentionally gone wrong.");
+        } catch (\Exception $exception) {


Was this on accident or am I missing the point of this try-catch block? Should we just have the return new Response part?

Ah, nevermind, I see what you are doing. Why not just create the Exception and use it - I don't think we need to actually throw it here:

$exception = new \Exception('This is a generic exception being used to help test your error page'); return new Response(...);

I was unsure whether this was needed to give the exception for example a "real" stack trace, just in case the error page is to display that...

The stack trace is created when the exception is created, so you can remove the try/catch block.

Just did that :-)

weaverryan · 2014-10-02T21:20:40Z

@mpdude Thanks for this!

First, everything works exactly as advertised and I only spotted one change I can see to make.

Second - about your to be discussed: I understand your point about custom exception messages. In this PR, we just create a generic \Exception with a generic message. So you're right that if someone is doing something in the template with their custom Exception class or message, then they can't really replicate that here.

Do we fix this? As you said, adding a setDebug method to ExceptionController (or maybe you call it ->forceProductErrorPage()), then you could call this in your controller temporarily to test your custom error message. But that seems hacky enough and enough of an edge case that I'm -1 on it.

Cheers!

…atch block.

fabpot · 2014-10-03T11:20:15Z

👍 Looks good to me. Can you submit a PR on symfony/symfony-standard?

mpdude · 2014-10-03T11:33:18Z

Thanks! See symfony/symfony-standard#720.

lyrixx · 2014-10-03T11:36:19Z

Yeah, this is very simple ! Nice contributions !

mpdude · 2014-10-03T11:51:13Z

I will need another 24h for a docs PR. Can also write up something for the Symfony blog of you like.

stof · 2014-10-03T14:48:13Z

src/Symfony/Bundle/TwigBundle/Controller/ExceptionController.php

+     *
+     * @return Response
+     */
+    protected function createResponse(Request $request, FlattenException $exception, $debug, DebugLoggerInterface $logger = null, $currentContent = '')


I think this should be private

It was in the meantime, but I reverted it back to protected.

Reason: The docs mention subclassing this controller in order to pass additional variables to the template. As this part of the code as moved from the showAction to this method, I'd like to keep the possibility to override it.

@stof agree?

fabpot · 2014-10-04T06:15:01Z

@mpdude If you can write the blog post the the Symfony blog as well, that would be wonderful. Thanks.

The docs (http://symfony.com/doc/current/cookbook/controller/error_pages.html) explicitly mentioned subclassing the controller and overriding the showAction method to pass additional variables to the template. The variables are now defined in createResponse(), so I'd like to keep the possibility to change them. The new testErrorPageAction() method might even work in these cases.

mpdude · 2014-10-04T10:54:59Z

Doc PR at symfony/symfony-docs#4293.

mpdude · 2014-10-04T21:30:31Z

Here's a suggestion for the blog article: https://gist.github.com/mpdude/ffa505570858e674c62b.

fabpot · 2014-10-05T13:27:54Z

Thank you @mpdude.

…de (mpdude) This PR was squashed before being merged into the 2.6-dev branch (closes #12096). Discussion ---------- Add an action to show *error* pages in kernel.debug mode | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #7446, #1486, #11327 | License | MIT | Doc PR | symfony/symfony-docs#4293 See #7446 for the initial reasoning. In short, add to your `routing_development.yml` file the following ```yaml _errors: resource: "@TwigBundle/Resources/config/routing/errors.xml" prefix: /_error ``` Then you can use `http://localhost/app_dev.php/_error/xxx` to preview the HTML *error* page that the default `ExceptionController` (from `TwigBundle`) would pick for the XXX status code. You can also use `http://localhost/app_dev.php/_error/xxx.{some_format}` to show error pages for other formats than HTML, most notably `txt`. Note that the status code will be 500 for all exceptions [that do not implement `HttpExceptionInterface`](https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Debug/Exception/FlattenException.php#L47). ##### Want to test with a custom exception? ~~Folks might want to display (part of) the exception even on error pages and thus need to work with generic (own) exceptions.~~ ~~They could write an arbitrary controller and throw their exception there. By default, the `ExceptionController` would be used to handle this, only that it would not show *error* pages in `kernel.debug` mode.~~ ~~Thus, a simple public setter to change the `debug` flag after construction could help. Do we want to add that as well?~~ If you want to test error pages with your own exceptions, * create a subclass of `ExceptionController` * set the protected `debug` flag to false * register it as twig.exception_controller in the config * throw your custom exception from any controller. That should give you the error page also in `kernel.debug` mode. ##### To-Do - [x] Update docs - [x] Add route in symfony/symfony-default Commits ------- 66ed177 Add an action to show *error* pages in kernel.debug mode

This PR was merged into the 2.6-dev branch. Discussion ---------- Add route to preview error pages in development See symfony/symfony#12096 for details. I think this is my first contribution to symfony-standard, does that earn me a badge :-)? Commits ------- c7d9f6a Add route to preview error pages in development (see Symfony issue #12096)

This PR was merged into the master branch. Discussion ---------- Document error page preview (Symfony ~2.6) This adds documentation how to use the new preview feature from symfony/symfony#12096 (and hopefully the fix in symfony/symfony#12147). Commits ------- d02c7c4 Updates according to GH feedback 8e70373 Document error page preview in Symfony ~2.6 (#4293)

Add an action to show *error* pages in kernel.debug mode

97cd43c

mpdude mentioned this pull request Oct 2, 2014

[DX] Easier template customizing with a query parameter #11327

Closed

1 task

weaverryan reviewed Oct 2, 2014
View reviewed changes

mpdude changed the title ~~Add an action to show *error* pages in kernel.debug mode~~ [WIP] Add an action to show *error* pages in kernel.debug mode Oct 3, 2014

mpdude added 3 commits October 3, 2014 11:43

Add an extra test

65bafc0

Seems the Exception has a reasonable stack trace also without a try/c…

086d0fb

…atch block.

Extract method refactoring

1c4a4b6

mpdude changed the title ~~[WIP] Add an action to show *error* pages in kernel.debug mode~~ Add an action to show *error* pages in kernel.debug mode Oct 3, 2014

mpdude mentioned this pull request Oct 3, 2014

Add route to preview error pages in development symfony/symfony-standard#720

Merged

stof reviewed Oct 3, 2014
View reviewed changes

mpdude added 2 commits October 4, 2014 10:31

Fixes as suggested by GH reviewers

dde4596

mpdude mentioned this pull request Oct 4, 2014

Document error page preview (Symfony ~2.6) symfony/symfony-docs#4293

Merged

fabpot closed this Oct 5, 2014

mpdude deleted the test-error-pages branch October 6, 2014 11:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add an action to show error pages in kernel.debug mode #12096

Add an action to show error pages in kernel.debug mode #12096

mpdude commented Oct 2, 2014

fabpot commented Oct 2, 2014

mpdude commented Oct 2, 2014

fabpot commented Oct 2, 2014

weaverryan Oct 2, 2014

weaverryan Oct 2, 2014

mpdude Oct 2, 2014

fabpot Oct 3, 2014

mpdude Oct 3, 2014

weaverryan commented Oct 2, 2014

fabpot commented Oct 3, 2014

mpdude commented Oct 3, 2014

lyrixx commented Oct 3, 2014

mpdude commented Oct 3, 2014

stof Oct 3, 2014

mpdude Oct 4, 2014

fabpot commented Oct 4, 2014

mpdude commented Oct 4, 2014

mpdude commented Oct 4, 2014

fabpot commented Oct 5, 2014

Add an action to show *error* pages in kernel.debug mode #12096

Add an action to show *error* pages in kernel.debug mode #12096

Conversation

mpdude commented Oct 2, 2014

Want to test with a custom exception?

To-Do

fabpot commented Oct 2, 2014

mpdude commented Oct 2, 2014

fabpot commented Oct 2, 2014

weaverryan Oct 2, 2014

Choose a reason for hiding this comment

weaverryan Oct 2, 2014

Choose a reason for hiding this comment

mpdude Oct 2, 2014

Choose a reason for hiding this comment

fabpot Oct 3, 2014

Choose a reason for hiding this comment

mpdude Oct 3, 2014

Choose a reason for hiding this comment

weaverryan commented Oct 2, 2014

fabpot commented Oct 3, 2014

mpdude commented Oct 3, 2014

lyrixx commented Oct 3, 2014

mpdude commented Oct 3, 2014

stof Oct 3, 2014

Choose a reason for hiding this comment

mpdude Oct 4, 2014

Choose a reason for hiding this comment

fabpot commented Oct 4, 2014

mpdude commented Oct 4, 2014

mpdude commented Oct 4, 2014

fabpot commented Oct 5, 2014

Add an action to show error pages in kernel.debug mode #12096

Add an action to show error pages in kernel.debug mode #12096