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

kbond · kbond · commit 3e34ef069b7a · 2023-10-02T09:03:09.000-04:00
diff --git a/src/Symfony/Component/Messenger/CHANGELOG.md b/src/Symfony/Component/Messenger/CHANGELOG.md
@@ -12,6 +12,7 @@ CHANGELOG
  * Add `WrappedExceptionsInterface` interface for exceptions that hold multiple individual exceptions
  * Deprecate `HandlerFailedException::getNestedExceptions()`, `HandlerFailedException::getNestedExceptionsOfClass()`
    and `DelayedMessageHandlingException::getExceptions()` which are replaced by a new `getWrappedExceptions()` method
+ * Add handler description as array key to `HandlerFailedException::getWrappedExceptions()`
 
 6.3
 ---
diff --git a/src/Symfony/Component/Messenger/Exception/HandlerFailedException.php b/src/Symfony/Component/Messenger/Exception/HandlerFailedException.php
@@ -21,7 +21,7 @@ class HandlerFailedException extends RuntimeException implements WrappedExceptio
     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)
     {
@@ -50,7 +50,7 @@ public function getEnvelope(): Envelope
     /**
      * @deprecated since Symfony 6.4, use {@see self::getWrappedExceptions()} instead
      *
-     * @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/Exception/WrappedExceptionsInterface.php b/src/Symfony/Component/Messenger/Exception/WrappedExceptionsInterface.php
@@ -19,7 +19,7 @@
 interface WrappedExceptionsInterface
 {
     /**
-     * @return \Throwable[]
+     * @return array<string, \Throwable>
      */
     public function getWrappedExceptions(string $class = null, bool $recursive = false): array;
 }
diff --git a/src/Symfony/Component/Messenger/Exception/WrappedExceptionsTrait.php b/src/Symfony/Component/Messenger/Exception/WrappedExceptionsTrait.php
@@ -19,7 +19,7 @@
 trait WrappedExceptionsTrait
 {
     /**
-     * @return \Throwable[]
+     * @return array<array-key, \Throwable>
      */
     public function getWrappedExceptions(string $class = null, bool $recursive = false): array
     {
@@ -30,7 +30,7 @@ public function getWrappedExceptions(string $class = null, bool $recursive = fal
      * @param class-string<\Throwable>|null $class
      * @param iterable<\Throwable>          $exceptions
      *
-     * @return \Throwable[]
+     * @return array<array-key, \Throwable>
      */
     private function getWrappedExceptionsRecursively(?string $class, bool $recursive, iterable $exceptions): array
     {
diff --git a/src/Symfony/Component/Messenger/Middleware/HandleMessageMiddleware.php b/src/Symfony/Component/Messenger/Middleware/HandleMessageMiddleware.php
@@ -66,7 +66,7 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
                 if ($batchHandler && $ackStamp = $envelope->last(AckStamp::class)) {
                     $ack = new Acknowledger(get_debug_type($batchHandler), static function (\Throwable $e = null, $result = null) use ($envelope, $ackStamp, $handlerDescriptor) {
                         if (null !== $e) {
-                            $e = new HandlerFailedException($envelope, [$e]);
+                            $e = new HandlerFailedException($envelope, [$handlerDescriptor->getName() => $e]);
                         } else {
                             $envelope = $envelope->with(HandledStamp::fromDescriptor($handlerDescriptor, $result));
                         }
@@ -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/Exception/HandlerFailedExceptionTest.php b/src/Symfony/Component/Messenger/Tests/Exception/HandlerFailedExceptionTest.php
@@ -75,7 +75,7 @@ public function testThatWrappedExceptionsRecursive()
         $exception2 = new MyOwnException('second');
         $exception3 = new MyOwnException('third');
 
-        $handlerException = new HandlerFailedException($envelope, [$exception1, $exception2, new DelayedMessageHandlingException([$exception3])]);
+        $handlerException = new HandlerFailedException($envelope, [$exception1, $exception2, new DelayedMessageHandlingException([$exception3], $envelope)]);
         $this->assertSame([$exception1, $exception2, $exception3], $handlerException->getWrappedExceptions(recursive: true));
     }
 
@@ -86,7 +86,7 @@ public function testThatWrappedExceptionsRecursiveStringKeys()
         $exception2 = new MyOwnException('second');
         $exception3 = new MyOwnException('third');
 
-        $handlerException = new HandlerFailedException($envelope, ['first' => $exception1, 'second' => $exception2, new DelayedMessageHandlingException(['third' => $exception3])]);
+        $handlerException = new HandlerFailedException($envelope, ['first' => $exception1, 'second' => $exception2, new DelayedMessageHandlingException(['third' => $exception3], $envelope)]);
         $this->assertSame(['first' => $exception1, 'second' => $exception2, 'third' => $exception3], $handlerException->getWrappedExceptions(recursive: true));
     }
 
@@ -97,7 +97,7 @@ public function testThatWrappedExceptionsByClassRecursive()
         $exception2 = new MyOwnException('second');
         $exception3 = new MyOwnException('third');
 
-        $handlerException = new HandlerFailedException($envelope, [$exception1, $exception2, new DelayedMessageHandlingException([$exception3])]);
+        $handlerException = new HandlerFailedException($envelope, [$exception1, $exception2, new DelayedMessageHandlingException([$exception3], $envelope)]);
         $this->assertSame([$exception2, $exception3], $handlerException->getWrappedExceptions(class: MyOwnException::class, recursive: true));
     }
 }
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->getWrappedExceptions());
+            $this->assertArrayHasKey($key, $e->getWrappedExceptions());
+            $this->assertSame('failed', $e->getWrappedExceptions()[$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
`@@ -21,7 +21,7 @@ class HandlerFailedException extends RuntimeException implements WrappedExceptio`
`21`	`21`	`private Envelope $envelope;`
`22`	`22`
`23`	`23`	`/**`
`24`		`- * @param \Throwable[] $exceptions`
	`24`	`+ * @param array<string, \Throwable> $exceptions The name of the handler should be given as key`
`25`	`25`	`*/`
`26`	`26`	`public function __construct(Envelope $envelope, array $exceptions)`
`27`	`27`	`{`
`@@ -50,7 +50,7 @@ public function getEnvelope(): Envelope`
`50`	`50`	`/**`
`51`	`51`	`* @deprecated since Symfony 6.4, use {@see self::getWrappedExceptions()} instead`
`52`	`52`	`*`
`53`		`- * @return \Throwable[]`
	`53`	`+ * @return array<string, \Throwable> The name of the handler should be given as key`
`54`	`54`	`*/`
`55`	`55`	`public function getNestedExceptions(): array`
`56`	`56`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`interface WrappedExceptionsInterface`
`20`	`20`	`{`
`21`	`21`	`/**`
`22`		`- * @return \Throwable[]`
	`22`	`+ * @return array<string, \Throwable>`
`23`	`23`	`*/`
`24`	`24`	`public function getWrappedExceptions(string $class = null, bool $recursive = false): array;`
`25`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope`
`66`	`66`	`if ($batchHandler && $ackStamp = $envelope->last(AckStamp::class)) {`
`67`	`67`	`$ack = new Acknowledger(get_debug_type($batchHandler), static function (\Throwable $e = null, $result = null) use ($envelope, $ackStamp, $handlerDescriptor) {`
`68`	`68`	`if (null !== $e) {`
`69`		`- $e = new HandlerFailedException($envelope, [$e]);`
	`69`	`+ $e = new HandlerFailedException($envelope, [$handlerDescriptor->getName() => $e]);`
`70`	`70`	`} else {`
`71`	`71`	`$envelope = $envelope->with(HandledStamp::fromDescriptor($handlerDescriptor, $result));`
`72`	`72`	`}`
`@@ -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`	`}`
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ public function testThatWrappedExceptionsRecursive()`
`75`	`75`	`$exception2 = new MyOwnException('second');`
`76`	`76`	`$exception3 = new MyOwnException('third');`
`77`	`77`
`78`		`- $handlerException = new HandlerFailedException($envelope, [$exception1, $exception2, new DelayedMessageHandlingException([$exception3])]);`
	`78`	`+ $handlerException = new HandlerFailedException($envelope, [$exception1, $exception2, new DelayedMessageHandlingException([$exception3], $envelope)]);`
`79`	`79`	`$this->assertSame([$exception1, $exception2, $exception3], $handlerException->getWrappedExceptions(recursive: true));`
`80`	`80`	`}`
`81`	`81`
`@@ -86,7 +86,7 @@ public function testThatWrappedExceptionsRecursiveStringKeys()`
`86`	`86`	`$exception2 = new MyOwnException('second');`
`87`	`87`	`$exception3 = new MyOwnException('third');`
`88`	`88`
`89`		`- $handlerException = new HandlerFailedException($envelope, ['first' => $exception1, 'second' => $exception2, new DelayedMessageHandlingException(['third' => $exception3])]);`
	`89`	`+ $handlerException = new HandlerFailedException($envelope, ['first' => $exception1, 'second' => $exception2, new DelayedMessageHandlingException(['third' => $exception3], $envelope)]);`
`90`	`90`	`$this->assertSame(['first' => $exception1, 'second' => $exception2, 'third' => $exception3], $handlerException->getWrappedExceptions(recursive: true));`
`91`	`91`	`}`
`92`	`92`
`@@ -97,7 +97,7 @@ public function testThatWrappedExceptionsByClassRecursive()`
`97`	`97`	`$exception2 = new MyOwnException('second');`
`98`	`98`	`$exception3 = new MyOwnException('third');`
`99`	`99`
`100`		`- $handlerException = new HandlerFailedException($envelope, [$exception1, $exception2, new DelayedMessageHandlingException([$exception3])]);`
	`100`	`+ $handlerException = new HandlerFailedException($envelope, [$exception1, $exception2, new DelayedMessageHandlingException([$exception3], $envelope)]);`
`101`	`101`	`$this->assertSame([$exception2, $exception3], $handlerException->getWrappedExceptions(class: MyOwnException::class, recursive: true));`
`102`	`102`	`}`
`103`	`103`	`}`