[Console] Add console.ERROR event and deprecate console.EXCEPTION #18140

wouterj · 2016-03-12T19:13:15Z

Q	A
Branch	master
Bug fix?	yes
New feature?	yes
BC breaks?	no
Deprecations?	yes
Tests pass?	yes
Fixed tickets	-
License	MIT
Doc PR	todo

The Problem

The current console.EXCEPTION event is only dispatched for exceptions during the execution of Command#execute(). All other exceptions (e.g. the ones thrown by listeners to events) are catched by the try ... catch loop in Application#doRunCommand(). This means that there is no way to override exception handling.

The Solution

This PR adds a console.ERROR event which has the same scope as the default try ... catch loop. This allows to customize all exception handling.

In order to keep BC, a new event was created and console.EXCEPTION was deprecated.

wouterj · 2016-03-12T19:49:44Z

src/Symfony/Component/Console/Event/ConsoleExceptionEvent.php

     */
-    public function setException(\Exception $exception)
+    public function setException(\Exception $exception = null)


Strictly speaking, this is a BC break. But only the public API is important for event classes, so I don't think we should consider this a BC break.

weaverryan · 2016-03-13T15:53:47Z

src/Symfony/Component/Console/Application.php

-                $this->renderException($e, $output->getErrorOutput());
-            } else {
-                $this->renderException($e, $output);
+                $e = $event->getException();


I realize that you want a listener to ERROR to be able to "handle" the exception so that things don't continue. To do this, the listener will call $event->setException(null), which just looks like a weird way to do it.

Perhaps a $event->setExceptionAsHandled() or something to signal that the Application shouldn't continue and render the exception? It would also simplify the $exitCode code below, since there will be an exception still.

xabbuh · 2016-12-25T18:29:26Z

@wouterj Are you able to address the comments here?

wouterj · 2016-12-25T23:35:50Z

Updated this PR:

A new ConsoleErrorEvent was introduced, replacing ConsoleExceptionEvent. This now adds full PHP 7 support (\Throwable instead of \Exception) and makes it a lot easier to trigger deprecation notices.
Instead of passing null to setException(), markErrorAsHandled() and isErrorHandled() were introduced.
Tests were updated to use the new event and a new legacy test was added for the old behaviour.

wouterj · 2016-12-25T23:37:18Z

Fabbot.io failures should be ignored, this is a bug in the CS fixer config

fabpot · 2016-12-26T07:17:49Z

src/Symfony/Component/Console/Event/ConsoleErrorEvent.php

+     */
+    public function getException()
+    {
+        @trigger_error('The ConsoleExceptionEvent::'.__METHOD__.'() method is deprecated since version 3.3 and will be removed in 4.0. Use ConsoleErrorEvent::getError() instead.', E_USER_DEPRECATED);


Should use sprintf and __METHOD__ already contains the namespace.

fabpot · 2016-12-26T07:18:16Z

src/Symfony/Component/Console/Event/ConsoleExceptionEvent.php

@@ -19,17 +19,24 @@
 * Allows to handle exception thrown in a command.
 *
 * @author Fabien Potencier <[email protected]>
+ *
+ * @deprecated ConsoleExceptionEvent is deprecated since version 3.2 and will be removed in 4.0. Use ConsoleErrorEvent instead.


fabpot · 2016-12-26T07:18:23Z

src/Symfony/Component/Console/Event/ConsoleExceptionEvent.php

    {
+        if ($deprecation) {
+            @trigger_error('The '.__CLASS__.' class is deprecated since version 3.3 and will be removed in 4.0. Use the ConsoleErrorEvent instead.', E_USER_DEPRECATED);


wouterj · 2016-12-26T10:17:10Z

Thanks for the quick review. PR is now updated (also added related UPGRADE and CHANGELOG notes).

xabbuh · 2016-12-28T12:01:53Z

UPGRADE-3.3.md

+Console
+-------
+
+ * The `console.exception` event and related `ConsoleExceptionEvent` class have been deprecated


[...] and the related [...]

xabbuh · 2016-12-28T12:02:05Z

UPGRADE-3.3.md

+-------
+
+ * The `console.exception` event and related `ConsoleExceptionEvent` class have been deprecated
+   in favor of the `console.error` event and `ConsoleErrorEvent` class. The deprecated event and


[...] and the ConsoleErrorEvent [...]

xabbuh · 2016-12-28T12:02:23Z

UPGRADE-4.0.md

@@ -13,6 +13,9 @@ Console
 * Setting unknown style options is not supported anymore and throws an
   exception.

+ * The `console.exception` event and related `ConsoleExceptionEvent` class have


[...] and the related [...]

xabbuh · 2016-12-28T12:02:42Z

UPGRADE-4.0.md

@@ -13,6 +13,9 @@ Console
 * Setting unknown style options is not supported anymore and throws an
   exception.

+ * The `console.exception` event and related `ConsoleExceptionEvent` class have
+   been removed in favor of the `console.error` event and `ConsoleErrorEvent` class.


[...] and the ConsoleErrorEvent [...]

xabbuh · 2016-12-28T12:04:32Z

src/Symfony/Component/Console/Event/ConsoleEvent.php

@@ -38,7 +38,7 @@ public function __construct(Command $command, InputInterface $input, OutputInter
    /**
     * Gets the command that is executed.
     *
-     * @return Command A Command instance
+     * @return Command|null A Command instance


Technically, this is a BC break.

~~Yeah see #18140 (comment) :~~

~~Strictly speaking, this is a BC break. But only the public API is important for event classes, so I don't think we should consider this a BC break.~~

Yeah, but this only happends on the new console.error event. All other events behave the same.

wouterj · 2017-02-01T08:55:05Z

Updated the PR. Should be ready to merge now (finally).

fabpot · 2017-02-04T16:40:45Z

src/Symfony/Component/Console/ConsoleEvents.php

+     * a Symfony\Component\Console\Event\ConsoleExceptionEvent
+     * instance.
+     *
+     * @Event


Should be @Event("Symfony\Component\Console\Event\ConsoleExceptionEvent")

fabpot · 2017-02-04T16:41:02Z

src/Symfony/Component/Console/ConsoleEvents.php

+     *
+     * This event allows you to deal with the exception/error or
+     * to modify the thrown exception. The event listener method receives
+     * a Symfony\Component\Console\Event\ConsoleExceptionEvent


This comment can be removed if you fix the @Event annotation (see below).

fabpot · 2017-02-04T16:42:09Z

src/Symfony/Component/Console/Event/ConsoleErrorEvent.php

+     * If it is not marked as handled, the error/exception will be displayed in
+     * the command output.
+     */
+    public function markErrorAsHandled()


Instead of having this marker, can't we just set the error as null to signify that error handling is done?

I did it that way before, but @weaverryan suggested to use a marker:

I realize that you want a listener to ERROR to be able to "handle" the exception so that things don't continue. To do this, the listener will call $event->setException(null), which just looks like a weird way to do it.

Perhaps a $event->setExceptionAsHandled() or something to signal that the Application shouldn't continue and render the exception?

-- #18140 (comment)

wouterj · 2017-03-16T20:28:57Z

So, what's the decision here:

Keep current proposal, using $event->markErrorAsHandled() to indicate console shouldn't output the error
Change to $event->setException(null) again

I'm getting a bit tired of rebasing my PRs each month, so I would like to have some quick decision making on this. Happy to close as well.

fabpot · 2017-03-22T23:10:53Z

Thank you @wouterj.

…e.EXCEPTION (wouterj) This PR was merged into the 3.3-dev branch. Discussion ---------- [Console] Add console.ERROR event and deprecate console.EXCEPTION | Q | A | | --- | --- | | Branch | master | | Bug fix? | yes | | New feature? | yes | | BC breaks? | no | | Deprecations? | yes | | Tests pass? | yes | | Fixed tickets | - | | License | MIT | | Doc PR | todo | ## The Problem The current `console.EXCEPTION` event is only dispatched for exceptions during the execution of `Command#execute()`. All other exceptions (e.g. the ones thrown by listeners to events) are catched by the `try ... catch` loop in `Application#doRunCommand()`. This means that there is _no way to override exception handling_. ## The Solution This PR adds a `console.ERROR` event which has the same scope as the default `try ... catch` loop. This allows to customize all exception handling. In order to keep BC, a new event was created and `console.EXCEPTION` was deprecated. Commits ------- c02a4c9 Added a console.ERROR event

chalasr · 2017-03-23T12:59:28Z

src/Symfony/Component/Console/Event/ConsoleExceptionEvent.php

 */
 class ConsoleExceptionEvent extends ConsoleEvent
 {
    private $exception;
    private $exitCode;
+    private $handled = false;


@wouterj this prop doesn't seem to be used, should we remove it?

Yes, seems to be a left-over of the previous implementation

fixed in 2ad5923

lyrixx · 2017-03-24T10:17:34Z

src/Symfony/Component/Console/Application.php

+        }
+
+        if (null !== $e && null !== $this->dispatcher) {
+            $event = new ConsoleErrorEvent($this->runningCommand, $input, $output, $e, $e->getCode());


With everything on master, if you run: bin/console mldsqlkmldmksq you got this:

Fatal error: Uncaught Symfony\Component\Debug\Exception\FatalThrowableError: Type error: Argument 1 passed to Symfony\Component\Console\Event\ConsoleErrorEvent::__construct() must be an instance of Symfony\Component\Console\Command\Command, null given, called in /home/greg/dev/github.com/lyrixx/symfony/src/Symfony/Component/Console/Application.php on line 131 in /home/greg/dev/github.com/lyrixx/symfony/src/Symfony/Component/Console/Event/ConsoleErrorEvent.php:30 Stack trace: #0 /home/greg/dev/github.com/lyrixx/symfony/src/Symfony/Component/Console/Application.php(131): Symfony\Component\Console\Event\ConsoleErrorEvent->__construct(NULL, Object(Symfony\Component\Console\Input\ArgvInput), Object(Symfony\Component\Console\Output\ConsoleOutput), Object(Symfony\Component\Console\Exception\CommandNotFoundException), 0) #1 /home/greg/dev/github.com/lyrixx/symfony-standard/bin/console(28): Symfony\Component\Console\Application->run(Object(Symfony\Component\Console\Input\ArgvInput)) #2 {main} thrown in /home/greg/dev/github.com/lyrixx/symfony/src/Symfony/Component/Console/Event/ConsoleErrorEvent.php on line 30

It's weird nobody notice that. May be I'm missing something but I really doubt, because all my repository are clean.

Do you experience this behaviour too?

How to patch that ? I can do a PR, but I'm not sure about the how to solve this.

I ran into this yesterday, I believe the same occurs on 2.7 with ConsoleExceptionEvent. Not sure about the better approach to fix it yet

My attempts to fix that: #22144

renan · 2017-04-24T14:56:29Z

I believe the ability for the application to catch \Throwable and then exit in error is quite an important thing to have. Can we have this backported into a 3.2 release?

nicolas-grekas · 2017-04-24T15:28:47Z

@renan it already does. What this PR provides is access to the original throwable (they are cast to FatalErrorException before), and dispatching for exceptions thrown when a command is found/not found.

renan · 2017-04-25T08:09:34Z

@nicolas-grekas Indeed I can't reproduce it with a minimalist script. Looks like there's a bad mix of Doctrine + Framework Bundle + Debug Component (ErrorHandler) on my application that's causing exceptions thrown on migrations to not mark the script execution as failed.

PS: Sorry for the noise.

…as-grekas) This PR was merged into the 3.3-dev branch. Discussion ---------- [Console] Review console.ERROR related behavior | Q | A | ------------- | --- | Branch? | 3.3 | Bug fix? | yes | New feature? | yes | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - This PR is a follow up of #18140 that I wanted to do since a few weeks. It enhances this work with fixes and behavior changes. It embeds #22435 and resolves issues like the one described in #20808. - makes ConsoleErrorEvent *not* extend the deprecated ConsoleExceptionEvent - replace ConsoleErrorEvent::markErrorAsHandled by ConsoleErrorEvent::setExitCode - triggers the deprecation in a more appropriate moment - renames ExceptionListener to ErrorListener - tweaks the behavior in relation to #22435 Commits ------- a7c67c9 [Console] Review console.ERROR related behavior

carsonbot added the Status: Needs Review label Mar 12, 2016

wouterj reviewed Mar 12, 2016
View reviewed changes

javiereguiluz added Bug Feature Console Deprecation labels Mar 12, 2016

weaverryan reviewed Mar 13, 2016
View reviewed changes

nicolas-grekas added this to the 3.x milestone Dec 6, 2016

wouterj force-pushed the issue_16497 branch 2 times, most recently from c0dbc95 to 741c752 Compare December 25, 2016 23:33

wouterj force-pushed the issue_16497 branch from 741c752 to 55067cf Compare December 25, 2016 23:37

fabpot reviewed Dec 26, 2016

View reviewed changes

wouterj force-pushed the issue_16497 branch from 55067cf to 939375b Compare December 26, 2016 10:16

xabbuh reviewed Dec 28, 2016

View reviewed changes

wouterj force-pushed the issue_16497 branch from 939375b to 076a2c7 Compare February 1, 2017 08:54

wouterj force-pushed the issue_16497 branch 2 times, most recently from 8be9f16 to d25f8e4 Compare February 1, 2017 10:13

fabpot reviewed Feb 4, 2017

View reviewed changes

wouterj force-pushed the issue_16497 branch from d25f8e4 to c02a4c9 Compare February 4, 2017 17:06

Added a console.ERROR event

c02a4c9

fabpot merged commit c02a4c9 into symfony:master Mar 22, 2017

wouterj deleted the issue_16497 branch March 23, 2017 00:26

chalasr reviewed Mar 23, 2017

View reviewed changes

lyrixx reviewed Mar 24, 2017

View reviewed changes

nicolas-grekas modified the milestones: 3.x, 3.3 Mar 24, 2017

javiereguiluz mentioned this pull request Mar 26, 2017

[Console] Add console.ERROR event and deprecate console.EXCEPTION symfony/symfony-docs#7704

Closed

ogizanagi mentioned this pull request Mar 29, 2017

[Console] Allow Application to handle PHP 7 Errors #20808

Closed

chalasr mentioned this pull request Apr 3, 2017

[Console][DX] Error handling degradation in 3.3 #22259

Closed

wouterj mentioned this pull request Apr 14, 2017

[Console] Fix dispatching throwables from ConsoleEvents::COMMAND #22435

Merged

nicolas-grekas mentioned this pull request Apr 14, 2017

[Console] Review console.ERROR related behavior #22441

Merged

fabpot mentioned this pull request May 1, 2017

Release v3.3.0-BETA1 #22603

Merged

derrabus mentioned this pull request Feb 2, 2018

[HttpKernel] Support for Throwable #22128

Closed

scaytrase mentioned this pull request Apr 17, 2018

[Console] Exception gone from ExceptionListener error context #26957

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Console] Add console.ERROR event and deprecate console.EXCEPTION #18140

[Console] Add console.ERROR event and deprecate console.EXCEPTION #18140

wouterj commented Mar 12, 2016

wouterj Mar 12, 2016

weaverryan Mar 13, 2016

xabbuh commented Dec 25, 2016

wouterj commented Dec 25, 2016

wouterj commented Dec 25, 2016

fabpot Dec 26, 2016

fabpot Dec 26, 2016

fabpot Dec 26, 2016

wouterj commented Dec 26, 2016

xabbuh Dec 28, 2016

xabbuh Dec 28, 2016 •

edited

Loading

xabbuh Dec 28, 2016

xabbuh Dec 28, 2016

xabbuh Dec 28, 2016

wouterj Dec 28, 2016 •

edited

Loading

wouterj commented Feb 1, 2017

fabpot Feb 4, 2017

fabpot Feb 4, 2017

fabpot Feb 4, 2017

wouterj Feb 4, 2017 •

edited

Loading

wouterj commented Mar 16, 2017

fabpot commented Mar 22, 2017

chalasr Mar 23, 2017

wouterj Mar 23, 2017

fabpot Mar 23, 2017

lyrixx Mar 24, 2017 •

edited

Loading

chalasr Mar 24, 2017

lyrixx Mar 24, 2017

renan commented Apr 24, 2017

nicolas-grekas commented Apr 24, 2017 •

edited

Loading

renan commented Apr 25, 2017

[Console] Add console.ERROR event and deprecate console.EXCEPTION #18140

[Console] Add console.ERROR event and deprecate console.EXCEPTION #18140

Conversation

wouterj commented Mar 12, 2016

The Problem

The Solution

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xabbuh commented Dec 25, 2016

wouterj commented Dec 25, 2016

wouterj commented Dec 25, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wouterj commented Dec 26, 2016

Choose a reason for hiding this comment

xabbuh Dec 28, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wouterj Dec 28, 2016 • edited Loading

Choose a reason for hiding this comment

wouterj commented Feb 1, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wouterj Feb 4, 2017 • edited Loading

Choose a reason for hiding this comment

wouterj commented Mar 16, 2017

fabpot commented Mar 22, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lyrixx Mar 24, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

renan commented Apr 24, 2017

nicolas-grekas commented Apr 24, 2017 • edited Loading

renan commented Apr 25, 2017

xabbuh Dec 28, 2016 •

edited

Loading

wouterj Dec 28, 2016 •

edited

Loading

wouterj Feb 4, 2017 •

edited

Loading

lyrixx Mar 24, 2017 •

edited

Loading

nicolas-grekas commented Apr 24, 2017 •

edited

Loading