Rename exception, add change log and a few other things

sroze · sroze · commit 4fc0e8016faf · 2019-04-06T14:30:38.000+02:00
diff --git a/src/Symfony/Component/Messenger/CHANGELOG.md b/src/Symfony/Component/Messenger/CHANGELOG.md
@@ -71,6 +71,7 @@ CHANGELOG
    only. Pass the `auto_setup` connection option to control this.
  * Added a `SetupTransportsCommand` command to setup the transports
  * Added a Doctrine transport. For example, use the `doctrine://default` DSN (this uses the `default` Doctrine entity manager)
+ * [BC BREAK] A `HandlerFailedException` exception will be thrown if one or more handler fails.
 
 4.2.0
 -----
diff --git a/src/Symfony/Component/Messenger/Exception/ChainedHandlerFailedException.php b/src/Symfony/Component/Messenger/Exception/ChainedHandlerFailedException.php
diff --git a/src/Symfony/Component/Messenger/Exception/HandlerFailedException.php b/src/Symfony/Component/Messenger/Exception/HandlerFailedException.php
@@ -0,0 +1,49 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Messenger\Exception;
+
+use Symfony\Component\Messenger\Envelope;
+
+class HandlerFailedException extends RuntimeException
+{
+    private $exceptions;
+    private $envelope;
+
+    public function __construct(Envelope $envelope, \Throwable ...$exceptions)
+    {
+        $firstFailure = current($exceptions);
+
+        parent::__construct(
+            1 === \count($exceptions)
+                ? $firstFailure->getMessage()
+                : sprintf('%d handlers failed. First failure is: "%s"', \count($exceptions), $firstFailure->getMessage()),
+            $firstFailure->getCode(),
+            $firstFailure
+        );
+
+        $this->envelope = $envelope;
+        $this->exceptions = $exceptions;
+    }
+
+    public function getEnvelope(): Envelope
+    {
+        return $this->envelope;
+    }
+
+    /**
+     * @return \Throwable[]
+     */
+    public function getNestedExceptions(): array
+    {
+        return $this->exceptions;
+    }
+}
diff --git a/src/Symfony/Component/Messenger/Middleware/HandleMessageMiddleware.php b/src/Symfony/Component/Messenger/Middleware/HandleMessageMiddleware.php
@@ -14,7 +14,7 @@
 use Psr\Log\LoggerAwareTrait;
 use Psr\Log\NullLogger;
 use Symfony\Component\Messenger\Envelope;
-use Symfony\Component\Messenger\Exception\ChainedHandlerFailedException;
+use Symfony\Component\Messenger\Exception\HandlerFailedException;
 use Symfony\Component\Messenger\Exception\NoHandlerForMessageException;
 use Symfony\Component\Messenger\Handler\HandlersLocatorInterface;
 use Symfony\Component\Messenger\Stamp\HandledStamp;
@@ -79,7 +79,7 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
         }
 
         if (\count($exceptions)) {
-            throw new ChainedHandlerFailedException($envelope, ...$exceptions);
+            throw new HandlerFailedException($envelope, ...$exceptions);
         }
 
         return $stack->next()->handle($envelope, $stack);
diff --git a/src/Symfony/Component/Messenger/Tests/Fixtures/DummyMessageHandlerFailingFirstTimes.php b/src/Symfony/Component/Messenger/Tests/Fixtures/DummyMessageHandlerFailingFirstTimes.php
@@ -11,7 +11,7 @@
 
 namespace Symfony\Component\Messenger\Tests\Fixtures;
 
-class MessageHandlerFailingFirstTimes
+class DummyMessageHandlerFailingFirstTimes
 {
     private $remainingFailures;
 
diff --git a/src/Symfony/Component/Messenger/Tests/Middleware/HandleMessageMiddlewareTest.php b/src/Symfony/Component/Messenger/Tests/Middleware/HandleMessageMiddlewareTest.php
@@ -12,7 +12,7 @@
 namespace Symfony\Component\Messenger\Tests\Middleware;
 
 use Symfony\Component\Messenger\Envelope;
-use Symfony\Component\Messenger\Exception\ChainedHandlerFailedException;
+use Symfony\Component\Messenger\Exception\HandlerFailedException;
 use Symfony\Component\Messenger\Handler\HandlersLocator;
 use Symfony\Component\Messenger\Middleware\HandleMessageMiddleware;
 use Symfony\Component\Messenger\Middleware\StackMiddleware;
@@ -52,7 +52,7 @@ public function testItAddsHandledStamps(array $handlers, array $expectedStamps,
 
         try {
             $envelope = $middleware->handle($envelope, $this->getStackMock($nextIsCalled));
-        } catch (ChainedHandlerFailedException $e) {
+        } catch (HandlerFailedException $e) {
             $envelope = $e->getEnvelope();
         }
 
diff --git a/src/Symfony/Component/Messenger/Tests/RetryIntegrationTest.php b/src/Symfony/Component/Messenger/Tests/RetryIntegrationTest.php
@@ -1,7 +1,5 @@
 <?php
 
-declare(strict_types=1);
-
 /*
  * This file is part of the Symfony package.
  *
@@ -22,7 +20,7 @@
 use Symfony\Component\Messenger\Retry\MultiplierRetryStrategy;
 use Symfony\Component\Messenger\Stamp\SentStamp;
 use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
-use Symfony\Component\Messenger\Tests\Fixtures\MessageHandlerFailingFirstTimes;
+use Symfony\Component\Messenger\Tests\Fixtures\DummyMessageHandlerFailingFirstTimes;
 use Symfony\Component\Messenger\Transport\Receiver\ReceiverInterface;
 use Symfony\Component\Messenger\Transport\Sender\SendersLocator;
 use Symfony\Component\Messenger\Worker;
@@ -43,8 +41,8 @@ public function testRetryMechanism()
 
         $senderLocator = new SendersLocator([], ['*' => true]);
 
-        $handler = new MessageHandlerFailingFirstTimes();
-        $throwingHandler = new MessageHandlerFailingFirstTimes(1);
+        $handler = new DummyMessageHandlerFailingFirstTimes();
+        $throwingHandler = new DummyMessageHandlerFailingFirstTimes(1);
         $handlerLocator = new HandlersLocator([
             DummyMessage::class => [
                 'handler' => $handler,
diff --git a/src/Symfony/Component/Messenger/Worker.php b/src/Symfony/Component/Messenger/Worker.php
@@ -15,7 +15,7 @@
 use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
 use Symfony\Component\Messenger\Event\WorkerMessageHandledEvent;
 use Symfony\Component\Messenger\Event\WorkerMessageReceivedEvent;
-use Symfony\Component\Messenger\Exception\ChainedHandlerFailedException;
+use Symfony\Component\Messenger\Exception\HandlerFailedException;
 use Symfony\Component\Messenger\Exception\LogicException;
 use Symfony\Component\Messenger\Exception\UnrecoverableMessageHandlingException;
 use Symfony\Component\Messenger\Retry\RetryStrategyInterface;
@@ -124,7 +124,7 @@ private function handleMessage(Envelope $envelope, ReceiverInterface $receiver,
         try {
             $envelope = $this->bus->dispatch($envelope->with(new ReceivedStamp()));
         } catch (\Throwable $throwable) {
-            if ($throwable instanceof ChainedHandlerFailedException) {
+            if ($throwable instanceof HandlerFailedException) {
                 $envelope = $throwable->getEnvelope();
             }
 

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Messenger\Tests\Fixtures;`
`13`	`13`
`14`		`-class MessageHandlerFailingFirstTimes`
	`14`	`+class DummyMessageHandlerFailingFirstTimes`
`15`	`15`	`{`
`16`	`16`	`private $remainingFailures;`
`17`	`17`