bug #23828 [Console] Log exit codes as debug messages instead of errors (haroldiedema)

Robin Chalas · Robin Chalas · commit 7010f99983b1 · 2017-08-08T18:39:56.000+02:00
This PR was merged into the 3.3 branch. Discussion ---------- [Console] Log exit codes as debug messages instead of errors | Q | A | ------------- | --- | Branch? | 3.3 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a Fixes PR #21003 This patch stops logging `exit_codes != 0` to _error_ and logs it to _debug_ instead, since it's not an error. The console application exited without uncaught exceptions, and the console application deliberately returned a specific exit code, therefore it shouldn't be logged as an error. A valid use case would be to let a caller script in bash (the script spawning the console command) know what action to take based on the exit code. More specifically, exit codes other than 1, 2, 127+n isn't necessarily considered an error. Monolog is hooked to our mailbox, so we can see what is happening in our production environment. However, it's currently being spammed for no reason because of #21003. tl;dr: user-programmed exit codes (return <int> in `execute()`) should NOT log an error message to monolog. I find it a bit iffy to leave the `console.terminiate` event listener in since it now logs to `debug` instead. I'm unsure if people want/need this, so I might as well remove the terminate listener entirely. Commits ------- cadbed3 [Console] Log exit codes as debug messages instead of errors
diff --git a/src/Symfony/Component/Console/EventListener/ErrorListener.php b/src/Symfony/Component/Console/EventListener/ErrorListener.php
@@ -59,10 +59,10 @@ public function onConsoleTerminate(ConsoleTerminateEvent $event)
         }
 
         if (!$inputString = $this->getInputString($event)) {
-            return $this->logger->error('The console exited with code "{code}"', array('code' => $exitCode));
+            return $this->logger->debug('The console exited with code "{code}"', array('code' => $exitCode));
         }
 
-        $this->logger->error('Command "{command}" exited with code "{code}"', array('command' => $inputString, 'code' => $exitCode));
+        $this->logger->debug('Command "{command}" exited with code "{code}"', array('command' => $inputString, 'code' => $exitCode));
     }
 
     public static function getSubscribedEvents()
diff --git a/src/Symfony/Component/Console/Tests/EventListener/ErrorListenerTest.php b/src/Symfony/Component/Console/Tests/EventListener/ErrorListenerTest.php
@@ -61,7 +61,7 @@ public function testOnConsoleTerminateForNonZeroExitCodeWritesToLog()
         $logger = $this->getLogger();
         $logger
             ->expects($this->once())
-            ->method('error')
+            ->method('debug')
             ->with('Command "{command}" exited with code "{code}"', array('command' => 'test:run', 'code' => 255))
         ;
 
@@ -74,7 +74,7 @@ public function testOnConsoleTerminateForZeroExitCodeDoesNotWriteToLog()
         $logger = $this->getLogger();
         $logger
             ->expects($this->never())
-            ->method('error')
+            ->method('debug')
         ;
 
         $listener = new ErrorListener($logger);
@@ -97,7 +97,7 @@ public function testAllKindsOfInputCanBeLogged()
         $logger = $this->getLogger();
         $logger
             ->expects($this->exactly(3))
-            ->method('error')
+            ->method('debug')
             ->with('Command "{command}" exited with code "{code}"', array('command' => 'test:run --foo=bar', 'code' => 255))
         ;
 
@@ -112,7 +112,7 @@ public function testCommandNameIsDisplayedForNonStringableInput()
         $logger = $this->getLogger();
         $logger
             ->expects($this->once())
-            ->method('error')
+            ->method('debug')
             ->with('Command "{command}" exited with code "{code}"', array('command' => 'test:run', 'code' => 255))
         ;
 

Original file line number	Diff line number	Diff line change
`@@ -59,10 +59,10 @@ public function onConsoleTerminate(ConsoleTerminateEvent $event)`
`59`	`59`	`}`
`60`	`60`
`61`	`61`	`if (!$inputString = $this->getInputString($event)) {`
`62`		`- return $this->logger->error('The console exited with code "{code}"', array('code' => $exitCode));`
	`62`	`+ return $this->logger->debug('The console exited with code "{code}"', array('code' => $exitCode));`
`63`	`63`	`}`
`64`	`64`
`65`		`- $this->logger->error('Command "{command}" exited with code "{code}"', array('command' => $inputString, 'code' => $exitCode));`
	`65`	`+ $this->logger->debug('Command "{command}" exited with code "{code}"', array('command' => $inputString, 'code' => $exitCode));`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`public static function getSubscribedEvents()`