fix exceptions listener event name

VasekPurchart · May 12, 2022 · 317f600 · 317f600
1 parent 3e77254
commit 317f600
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 6 deletions.
diff --git a/src/Console/ConsoleExceptionListener.php b/src/Console/ConsoleExceptionListener.php
@@ -29,7 +29,17 @@ public function __construct(
 		$this->logLevel = $logLevel;
 	}
 
+	/**
+	 * Keeping this method for BC (of this package) - was renamed to onConsoleError() as part of a bugfix
+	 *
+	 * @param \Symfony\Component\Console\Event\ConsoleErrorEvent $event
+	 */
 	public function onConsoleException(ConsoleErrorEvent $event): void
+	{
+		$this->onConsoleError($event);
+	}
+
+	public function onConsoleError(ConsoleErrorEvent $event): void
 	{
 		$command = $event->getCommand();
 		$exception = $event->getError();

diff --git a/src/DependencyInjection/config/exception_listener.yml b/src/DependencyInjection/config/exception_listener.yml
@@ -7,5 +7,5 @@ services:
         tags:
             -
                 name: kernel.event_listener
-                event: console.exception
+                event: console.error
                 priority: '%vasek_purchart.console_errors.exception.listener_priority%'
diff --git a/tests/Console/ConsoleExceptionListenerTest.php b/tests/Console/ConsoleExceptionListenerTest.php
@@ -4,6 +4,8 @@
 
 namespace VasekPurchart\ConsoleErrorsBundle\Console;
 
+use Closure;
+use Generator;
 use Psr\Log\LogLevel;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Console\Command\Command;
@@ -14,7 +16,30 @@
 class ConsoleExceptionListenerTest extends \PHPUnit\Framework\TestCase
 {
 
-	public function testLogError(): void
+	/**
+	 * @return mixed[]|\Generator
+	 */
+	public function eventMethodProvider(): Generator
+	{
+		yield 'onConsoleError' => [
+			'methodCallback' => static function (ConsoleExceptionListener $listener, ConsoleErrorEvent $event): void {
+				$listener->onConsoleError($event);
+			},
+		];
+
+		yield 'onConsoleException (for BC)' => [
+			'methodCallback' => static function (ConsoleExceptionListener $listener, ConsoleErrorEvent $event): void {
+				$listener->onConsoleException($event);
+			},
+		];
+	}
+
+	/**
+	 * @dataProvider eventMethodProvider
+	 *
+	 * @param \Closure $methodCallback
+	 */
+	public function testLogError(Closure $methodCallback): void
 	{
 		$commandName = 'hello:world';
 		$message = 'Foobar!';
@@ -35,8 +60,10 @@ public function testLogError(): void
 		$output = $this->createMock(OutputInterface::class);
 		$event = new ConsoleErrorEvent($input, $output, $exception, $command);
 
-		$listener = new ConsoleExceptionListener($logger, $logLevel);
-		$listener->onConsoleException($event);
+		$methodCallback(
+			new ConsoleExceptionListener($logger, $logLevel),
+			$event
+		);
 	}
 
 }
diff --git a/tests/DependencyInjection/ConsoleErrorsExtensionExceptionsTest.php b/tests/DependencyInjection/ConsoleErrorsExtensionExceptionsTest.php
@@ -25,7 +25,7 @@ public function testExceptionsEnabledByDefault(): void
 
 		$this->assertContainerBuilderHasService('vasek_purchart.console_errors.console.console_exception_listener', ConsoleExceptionListener::class);
 		$this->assertContainerBuilderHasServiceDefinitionWithTag('vasek_purchart.console_errors.console.console_exception_listener', 'kernel.event_listener', [
-			'event' => 'console.exception',
+			'event' => 'console.error',
 			'priority' => '%' . ConsoleErrorsExtension::CONTAINER_PARAMETER_EXCEPTION_LISTENER_PRIORITY . '%',
 		]);
 
@@ -55,7 +55,7 @@ public function testExceptionsEnabled(): void
 
 		$this->assertContainerBuilderHasService('vasek_purchart.console_errors.console.console_exception_listener', ConsoleExceptionListener::class);
 		$this->assertContainerBuilderHasServiceDefinitionWithTag('vasek_purchart.console_errors.console.console_exception_listener', 'kernel.event_listener', [
-			'event' => 'console.exception',
+			'event' => 'console.error',
 			'priority' => '%' . ConsoleErrorsExtension::CONTAINER_PARAMETER_EXCEPTION_LISTENER_PRIORITY . '%',
 		]);