Add NestedExceptionsInterface interface for exceptions that hold multiple individual exceptions

Jeroeny · Jeroeny · commit 30c69c51ba90 · 2023-09-19T16:27:22.000+02:00
diff --git a/UPGRADE-6.4.md b/UPGRADE-6.4.md
@@ -112,6 +112,7 @@ Messenger
 ---------
 
  * Deprecate `StopWorkerOnSignalsListener` in favor of using the `SignalableCommandInterface`
+ * Deprecate `HandlerFailedException::getNestedExceptionOfClass` which is replaced by `HandlerFailedException::getWrappedExceptions`
 
 MonologBridge
 -------------
diff --git a/src/Symfony/Component/Messenger/CHANGELOG.md b/src/Symfony/Component/Messenger/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
  * Deprecate `StopWorkerOnSignalsListener` in favor of using the `SignalableCommandInterface`
  * Add `HandlerDescriptor::getOptions`
+ * Add `NestedExceptionsInterface` interface for exceptions that hold multiple individual exceptions
 
 6.3
 ---
diff --git a/src/Symfony/Component/Messenger/Exception/DelayedMessageHandlingException.php b/src/Symfony/Component/Messenger/Exception/DelayedMessageHandlingException.php
@@ -17,8 +17,10 @@
  *
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
-class DelayedMessageHandlingException extends RuntimeException
+class DelayedMessageHandlingException extends RuntimeException implements NestedExceptionsInterface
 {
+    use NestedExceptionsTrait;
+
     private array $exceptions;
 
     public function __construct(array $exceptions)
diff --git a/src/Symfony/Component/Messenger/Exception/HandlerFailedException.php b/src/Symfony/Component/Messenger/Exception/HandlerFailedException.php
@@ -13,8 +13,10 @@
 
 use Symfony\Component\Messenger\Envelope;
 
-class HandlerFailedException extends RuntimeException
+class HandlerFailedException extends RuntimeException implements NestedExceptionsInterface
 {
+    use NestedExceptionsTrait;
+
     private array $exceptions;
     private Envelope $envelope;
 
@@ -55,6 +57,8 @@ public function getNestedExceptions(): array
 
     public function getNestedExceptionOfClass(string $exceptionClassName): array
     {
+        trigger_deprecation('symfony/messenger', '6.4', 'The "%s()" method is deprecated, use "%s::getWrappedExceptions" instead.', __METHOD__, self::class);
+
         return array_values(
             array_filter(
                 $this->exceptions,
diff --git a/src/Symfony/Component/Messenger/Exception/NestedExceptionsInterface.php b/src/Symfony/Component/Messenger/Exception/NestedExceptionsInterface.php
@@ -0,0 +1,25 @@
+<?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;
+
+/**
+ * Exception that holds multiple exceptions thrown by one or more handlers and/or messages.
+ *
+ * @author Jeroen <https://github.com/Jeroeny>
+ */
+interface NestedExceptionsInterface extends \Throwable
+{
+    /**
+     * @return \Throwable[]
+     */
+    public function getWrappedExceptions(string $class = null, bool $recursive = false): array;
+}
diff --git a/src/Symfony/Component/Messenger/Exception/NestedExceptionsTrait.php b/src/Symfony/Component/Messenger/Exception/NestedExceptionsTrait.php
@@ -0,0 +1,44 @@
+<?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;
+
+/**
+ * @author Jeroen <https://github.com/Jeroeny>
+ */
+trait NestedExceptionsTrait
+{
+    /**
+     * @return \Throwable[]
+     */
+    public function getWrappedExceptions(string $class = null, bool $recursive = false): array
+    {
+        return $recursive ? iterator_to_array($this->getWrappedExceptionsRecursively($class, $this->exceptions), false) : $this->exceptions;
+    }
+
+    /**
+     * @param iterable<\Throwable>
+     *
+     * @return \Traversable<\Throwable>
+     */
+    private function getWrappedExceptionsRecursively(?string $class, iterable $exceptions): \Traversable
+    {
+        foreach ($exceptions as $exception) {
+            if ($exception instanceof NestedExceptionsInterface) {
+                yield from $this->getWrappedExceptionsRecursively($class, $exception->getWrappedExceptions());
+
+                return;
+            }
+
+            yield $exception;
+        }
+    }
+}
diff --git a/src/Symfony/Component/Messenger/Tests/Exception/HandlerFailedExceptionTest.php b/src/Symfony/Component/Messenger/Tests/Exception/HandlerFailedExceptionTest.php
@@ -13,6 +13,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\Exception\DelayedMessageHandlingException;
 use Symfony\Component\Messenger\Exception\HandlerFailedException;
 use Symfony\Component\Messenger\Tests\Fixtures\MyOwnChildException;
 use Symfony\Component\Messenger\Tests\Fixtures\MyOwnException;
@@ -32,7 +33,7 @@ public function __construct()
         };
 
         $handlerException = new HandlerFailedException($envelope, [$exception]);
-        $originalException = $handlerException->getNestedExceptions()[0];
+        $originalException = $handlerException->getWrappedExceptions()[0];
 
         $this->assertIsInt($handlerException->getCode(), 'Exception codes must converts to int');
         $this->assertSame(0, $handlerException->getCode(), 'String code (HY000) converted to int must be 0');
@@ -66,4 +67,15 @@ public function testThatNestedExceptionClassAreNotFoundIfNotPresent()
         $handlerException = new HandlerFailedException($envelope, [$exception]);
         $this->assertCount(0, $handlerException->getNestedExceptionOfClass(MyOwnException::class));
     }
+
+    public function testThatNestedExceptionsRecursive()
+    {
+        $envelope = new Envelope(new \stdClass());
+        $exception1 = new \LogicException();
+        $exception2 = new MyOwnException('second');
+        $exception3 = new MyOwnException('third');
+
+        $handlerException = new HandlerFailedException($envelope, [$exception1, $exception2, new DelayedMessageHandlingException([$exception3])]);
+        $this->assertSame([$exception1, $exception2, $exception3], $handlerException->getWrappedExceptions(recursive: true));
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -17,8 +17,10 @@`
`17`	`17`	`*`
`18`	`18`	`* @author Tobias Nyholm <tobias.nyholm@gmail.com>`
`19`	`19`	`*/`
`20`		`-class DelayedMessageHandlingException extends RuntimeException`
	`20`	`+class DelayedMessageHandlingException extends RuntimeException implements NestedExceptionsInterface`
`21`	`21`	`{`
	`22`	`+ use NestedExceptionsTrait;`
	`23`	`+`
`22`	`24`	`private array $exceptions;`
`23`	`25`
`24`	`26`	`public function __construct(array $exceptions)`