Merge pull request #87 from yiisoft/fix-bug

Support multiple exceptions, fixed a bug with try/finally

Author: xepozz

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## 3.1.0 under development
 
+- New #87: Add `CompositeException` to be able to render multiple exceptions (@xepozz)
+- Bug #87: Fix a bug with try/finally from #75 (@xepozz)
 - Chg #75: Dispatch `ApplicationError` in `ErrorCatcher` (@xepozz)
 - Enh #82: Add `HeadersProvider` (@xepozz)
 

src/CompositeException.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\ErrorHandler;
+
+use Exception;
+use Throwable;
+
+/**
+ * Aggregate multiple exceptions into one.
+ */
+final class CompositeException extends Exception
+{
+    /**
+     * @var Throwable[]
+     */
+    private array $rest;
+
+    public function __construct(
+        private Throwable $first,
+        Throwable ...$rest,
+    ) {
+        $this->rest = $rest;
+        parent::__construct($first->getMessage(), (int) $first->getCode(), $first);
+    }
+
+    public function getFirstException(): Throwable
+    {
+        return $this->first;
+    }
+
+    /**
+     * @return Throwable[]
+     */
+    public function getPreviousExceptions(): array
+    {
+        return $this->rest;
+    }
+}

src/ErrorHandler.php

@@ -16,8 +16,8 @@
 use function error_get_last;
 use function error_reporting;
 use function function_exists;
-use function ini_set;
 use function http_response_code;
+use function ini_set;
 use function register_shutdown_function;
 use function set_error_handler;
 use function set_exception_handler;
@@ -59,9 +59,7 @@ public function handle(
         ThrowableRendererInterface $renderer = null,
         ServerRequestInterface $request = null
     ): ErrorData {
-        if ($renderer === null) {
-            $renderer = $this->defaultRenderer;
-        }
+        $renderer ??= $this->defaultRenderer;
 
         try {
             $this->logger->error((string) (new PlainTextRenderer())->renderVerbose($t, $request), ['throwable' => $t]);

src/Exception/ErrorException.php

@@ -113,7 +113,7 @@ private function addXDebugTraceToFatalIfAvailable(): void
                 $trace[] = $frame;
             }
 
-            $ref = new ReflectionProperty('Exception', 'trace');
+            $ref = new ReflectionProperty(\Exception::class, 'trace');
             $ref->setAccessible(true);
             $ref->setValue($this, $trace);
         }

src/Middleware/ErrorCatcher.php

@@ -13,8 +13,9 @@
 use Psr\Http\Server\MiddlewareInterface;
 use Psr\Http\Server\RequestHandlerInterface;
 use Throwable;
-use Yiisoft\ErrorHandler\Event\ApplicationError;
+use Yiisoft\ErrorHandler\CompositeException;
 use Yiisoft\ErrorHandler\ErrorHandler;
+use Yiisoft\ErrorHandler\Event\ApplicationError;
 use Yiisoft\ErrorHandler\HeadersProvider;
 use Yiisoft\ErrorHandler\Renderer\HeaderRenderer;
 use Yiisoft\ErrorHandler\Renderer\HtmlRenderer;
@@ -128,13 +129,14 @@ public function forceContentType(string $contentType): self
 
     public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
     {
-        $t = null;
         try {
             return $handler->handle($request);
         } catch (Throwable $t) {
-            $this->eventDispatcher?->dispatch(new ApplicationError($t));
-        } finally {
-            /** @psalm-suppress PossiblyNullArgument $t is set in catch() statement */
+            try {
+                $this->eventDispatcher?->dispatch(new ApplicationError($t));
+            } catch (Throwable $e) {
+                $t = new CompositeException($e, $t);
+            }
             return $this->generateErrorResponse($t, $request);
         }
     }

src/Renderer/HtmlRenderer.php

@@ -9,6 +9,7 @@
 use Psr\Http\Message\ServerRequestInterface;
 use RuntimeException;
 use Throwable;
+use Yiisoft\ErrorHandler\CompositeException;
 use Yiisoft\ErrorHandler\ErrorData;
 use Yiisoft\ErrorHandler\ThrowableRendererInterface;
 use Yiisoft\FriendlyException\FriendlyExceptionInterface;
@@ -32,9 +33,9 @@
 use function mb_strlen;
 use function mb_substr;
 use function ob_clean;
+use function ob_end_clean;
 use function ob_get_clean;
 use function ob_get_level;
-use function ob_end_clean;
 use function ob_implicit_flush;
 use function ob_start;
 use function realpath;
@@ -212,9 +213,17 @@ public function parseMarkdown(string $content): string
      */
     public function renderPreviousExceptions(Throwable $t): string
     {
-        if (($previous = $t->getPrevious()) !== null) {
-            $templatePath = $this->defaultTemplatePath . '/_previous-exception.php';
-            return $this->renderTemplate($templatePath, ['throwable' => $previous]);
+        $templatePath = $this->defaultTemplatePath . '/_previous-exception.php';
+
+        if ($t instanceof CompositeException) {
+            $result = [];
+            foreach ($t->getPreviousExceptions() as $exception) {
+                $result[] = $this->renderTemplate($templatePath, ['throwable' => $exception]);
+            }
+            return implode($result);
+        }
+        if ($t->getPrevious() !== null) {
+            return $this->renderTemplate($templatePath, ['throwable' => $t->getPrevious()]);
         }
 
         return '';