Merge pull request #75 from yiisoft/add-error-dispatching

Add error event dispatching

Author: xepozz

CHANGELOG.md

@@ -1,7 +1,8 @@
 # Yii Error Handler Change Log
 
-## 3.0.1 under development
+## 3.1.0 under development
 
+- Chg #75: Dispatch `ApplicationError` in `ErrorCatcher` (@xepozz)
 - Enh #82: Add `HeadersProvider` (@xepozz)
 
 ## 3.0.0 February 14, 2023

README.md

@@ -198,22 +198,26 @@ In the application middleware stack `Yiisoft\ErrorHandler\Middleware\ExceptionRe
 For use in the [Yii framework](https://www.yiiframework.com/),
 see [Yii guide to handling errors](https://github.com/yiisoft/docs/blob/master/guide/en/runtime/handling-errors.md).
 
+## Events
+
+- When `ErrorCatcher` catches an error it dispatches `\Yiisoft\ErrorHandler\Event\ApplicationError` event.
+
 ## Friendly Exceptions
 
 `HtmlRenderer` supports [friendly exceptions](https://github.com/yiisoft/friendly-exception/).
 
 Code blocks in solution markdown support language syntax highlight:
 
-| Language | Aliases |
-| -------- | ------- |
-| Bash | bash, sh, zsh |
-| CSS | css |
-| HTML, XML | xml, html, xhtml, rss, atom, xjb, xsd, xsl, plist, svg |
-| JavaScript | javascript, js, jsx |
-| JSON | json |
-| PHP | php |
-| Plaintext | plaintext, txt, text |
-| SQL | sql |
+| Language   | Aliases                                                |
+|------------|--------------------------------------------------------|
+| Bash       | bash, sh, zsh                                          |
+| CSS        | css                                                    |
+| HTML, XML  | xml, html, xhtml, rss, atom, xjb, xsd, xsl, plist, svg |
+| JavaScript | javascript, js, jsx                                    |
+| JSON       | json                                                   |
+| PHP        | php                                                    |
+| Plaintext  | plaintext, txt, text                                   |
+| SQL        | sql                                                    |
 
 For example:
 

src/ErrorHandler.php

@@ -197,9 +197,7 @@ private function renderThrowableAndTerminate(Throwable $t): void
         http_response_code(Status::INTERNAL_SERVER_ERROR);
 
         echo $this->handle($t);
-        if ($this->eventDispatcher !== null) {
-            $this->eventDispatcher->dispatch(new ApplicationError($t));
-        }
+        $this->eventDispatcher?->dispatch(new ApplicationError($t));
 
         register_shutdown_function(static function (): void {
             exit(1);

src/Middleware/ErrorCatcher.php

@@ -6,12 +6,14 @@
 
 use InvalidArgumentException;
 use Psr\Container\ContainerInterface;
+use Psr\EventDispatcher\EventDispatcherInterface;
 use Psr\Http\Message\ResponseFactoryInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Server\MiddlewareInterface;
 use Psr\Http\Server\RequestHandlerInterface;
 use Throwable;
+use Yiisoft\ErrorHandler\Event\ApplicationError;
 use Yiisoft\ErrorHandler\ErrorHandler;
 use Yiisoft\ErrorHandler\HeadersProvider;
 use Yiisoft\ErrorHandler\Renderer\HeaderRenderer;
@@ -57,6 +59,7 @@ public function __construct(
         private ResponseFactoryInterface $responseFactory,
         private ErrorHandler $errorHandler,
         private ContainerInterface $container,
+        private ?EventDispatcherInterface $eventDispatcher = null,
         HeadersProvider $headersProvider = null,
     ) {
         $this->headersProvider = $headersProvider ?? new HeadersProvider();
@@ -125,9 +128,13 @@ 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 */
             return $this->generateErrorResponse($t, $request);
         }
     }

tests/Middleware/ErrorCatcherTest.php

@@ -4,6 +4,7 @@
 
 namespace Yiisoft\ErrorHandler\Tests\Middleware;
 
+use Psr\EventDispatcher\EventDispatcherInterface;
 use HttpSoft\Message\ResponseFactory;
 use HttpSoft\Message\ServerRequest;
 use InvalidArgumentException;
@@ -62,6 +63,31 @@ public function testProcessWithFailAcceptRequestHeader(): void
         $this->assertStringContainsString('<html', $content);
     }
 
+    public function testProcessWithFailedEventDispatcher(): void
+    {
+        $eventDispatcher = $this->createMock(EventDispatcherInterface::class);
+        $eventDispatcher->method('dispatch')->willThrowException(new \RuntimeException('Event dispatcher error'));
+        $container = new SimpleContainer([], fn (string $className): object => new $className());
+        $errorCatcher = new ErrorCatcher(
+            new ResponseFactory(),
+            $this->createErrorHandler(),
+            $container,
+            $eventDispatcher,
+        );
+        $response = $errorCatcher->process(
+            $this->createServerRequest('GET', ['Accept' => ['text/plain;q=2.0']]),
+            $this->createRequestHandlerWithThrowable(),
+        );
+        $response
+            ->getBody()
+            ->rewind();
+        $content = $response
+            ->getBody()
+            ->getContents();
+        $this->assertNotSame(PlainTextRenderer::DEFAULT_ERROR_MESSAGE, $content);
+        $this->assertStringContainsString('<html', $content);
+    }
+
     public function testAddedRenderer(): void
     {
         $mimeType = 'test/test';
@@ -240,6 +266,7 @@ private function createErrorCatcher(
             new ResponseFactory(),
             $this->createErrorHandler(),
             $container,
+            null,
             $provider ?? new HeadersProvider()
         );
     }