[Messenger] add handler description as array key to HandlerFailedException::getNestedExceptions()

kbond · kbond · commit 61a5a0657cb2 · 2023-09-20T17:36:16.000-04:00
diff --git a/src/Symfony/Component/Messenger/CHANGELOG.md b/src/Symfony/Component/Messenger/CHANGELOG.md
@@ -7,6 +7,7 @@ CHANGELOG
  * Deprecate `StopWorkerOnSignalsListener` in favor of using the `SignalableCommandInterface`
  * Add `HandlerDescriptor::getOptions`
  * Add support for multiple Redis Sentinel hosts
+ * Add handler description as array key to `HandlerFailedException::getNestedExceptions()`
 
 6.3
 ---
diff --git a/src/Symfony/Component/Messenger/Exception/HandlerFailedException.php b/src/Symfony/Component/Messenger/Exception/HandlerFailedException.php
@@ -19,7 +19,7 @@ class HandlerFailedException extends RuntimeException
     private Envelope $envelope;
 
     /**
-     * @param \Throwable[] $exceptions
+     * @param array<string, \Throwable> $exceptions The name of the handler should be given as key
      */
     public function __construct(Envelope $envelope, array $exceptions)
     {
@@ -46,7 +46,7 @@ public function getEnvelope(): Envelope
     }
 
     /**
-     * @return \Throwable[]
+     * @return array<string, \Throwable> The name of the handler should be given as key
      */
     public function getNestedExceptions(): array
     {
diff --git a/src/Symfony/Component/Messenger/Middleware/HandleMessageMiddleware.php b/src/Symfony/Component/Messenger/Middleware/HandleMessageMiddleware.php
@@ -95,7 +95,7 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
                 $envelope = $envelope->with($handledStamp);
                 $this->logger?->info('Message {class} handled by {handler}', $context + ['handler' => $handledStamp->getHandlerName()]);
             } catch (\Throwable $e) {
-                $exceptions[] = $e;
+                $exceptions[$handlerDescriptor->getName()] = $e;
             }
         }
 
@@ -107,7 +107,7 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
                     $handler = $stamp->getHandlerDescriptor()->getBatchHandler();
                     $handler->flush($flushStamp->force());
                 } catch (\Throwable $e) {
-                    $exceptions[] = $e;
+                    $exceptions[$stamp->getHandlerDescriptor()->getName()] = $e;
                 }
             }
         }
diff --git a/src/Symfony/Component/Messenger/Tests/Middleware/HandleMessageMiddlewareTest.php b/src/Symfony/Component/Messenger/Tests/Middleware/HandleMessageMiddlewareTest.php
@@ -47,6 +47,31 @@ public function testItCallsTheHandlerAndNextMiddleware()
         $middleware->handle($envelope, $this->getStackMock());
     }
 
+    public function testItKeysTheHandlerFailedNestedExceptionsByHandlerDescription()
+    {
+        $message = new DummyMessage('Hey');
+        $envelope = new Envelope($message);
+        $handler = new FailingHandleMessageMiddlewareTestCallable();
+
+        $middleware = new HandleMessageMiddleware(new HandlersLocator([
+            DummyMessage::class => [$handler],
+        ]));
+
+        try {
+            $middleware->handle($envelope, $this->getStackMock(false));
+        } catch (HandlerFailedException $e) {
+            $key = (new HandlerDescriptor($handler))->getName();
+
+            $this->assertCount(1, $e->getNestedExceptions());
+            $this->assertArrayHasKey($key, $e->getNestedExceptions());
+            $this->assertSame('failed', $e->getNestedExceptions()[$key]->getMessage());
+
+            return;
+        }
+
+        $this->fail('Exception not thrown.');
+    }
+
     /**
      * @dataProvider itAddsHandledStampsProvider
      */
@@ -335,6 +360,14 @@ public function __invoke()
     }
 }
 
+class FailingHandleMessageMiddlewareTestCallable
+{
+    public function __invoke()
+    {
+        throw new \Exception('failed');
+    }
+}
+
 class HandleMessageMiddlewareNamedArgumentTestCallable
 {
     public function __invoke(object $message, $namedArgument)

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ class HandlerFailedException extends RuntimeException`
`19`	`19`	`private Envelope $envelope;`
`20`	`20`
`21`	`21`	`/**`
`22`		`- * @param \Throwable[] $exceptions`
	`22`	`+ * @param array<string, \Throwable> $exceptions The name of the handler should be given as key`
`23`	`23`	`*/`
`24`	`24`	`public function __construct(Envelope $envelope, array $exceptions)`
`25`	`25`	`{`
`@@ -46,7 +46,7 @@ public function getEnvelope(): Envelope`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`/**`
`49`		`- * @return \Throwable[]`
	`49`	`+ * @return array<string, \Throwable> The name of the handler should be given as key`
`50`	`50`	`*/`
`51`	`51`	`public function getNestedExceptions(): array`
`52`	`52`	`{`
Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope`
`95`	`95`	`$envelope = $envelope->with($handledStamp);`
`96`	`96`	`$this->logger?->info('Message {class} handled by {handler}', $context + ['handler' => $handledStamp->getHandlerName()]);`
`97`	`97`	`} catch (\Throwable $e) {`
`98`		`- $exceptions[] = $e;`
	`98`	`+ $exceptions[$handlerDescriptor->getName()] = $e;`
`99`	`99`	`}`
`100`	`100`	`}`
`101`	`101`
`@@ -107,7 +107,7 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope`
`107`	`107`	`$handler = $stamp->getHandlerDescriptor()->getBatchHandler();`
`108`	`108`	`$handler->flush($flushStamp->force());`
`109`	`109`	`} catch (\Throwable $e) {`
`110`		`- $exceptions[] = $e;`
	`110`	`+ $exceptions[$stamp->getHandlerDescriptor()->getName()] = $e;`
`111`	`111`	`}`
`112`	`112`	`}`
`113`	`113`	`}`