Add ability to perform getBody() on response when ExceptionResponder middleware is processing (#98)

Author: vjik

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## 3.1.1 under development
 
-- no changes in this release.
+- New #98: Add ability to execute `getBody()` on response when `ExceptionResponder` middleware is processing (@vjik)
 
 ## 3.1.0 January 07, 2024
 

src/Middleware/ExceptionResponder.php

@@ -51,18 +51,24 @@ final class ExceptionResponder implements MiddlewareInterface
      * ```
      *
      * @param callable[]|int[] $exceptionMap A callable that must return a `ResponseInterface` or response status code.
+     * @param bool $checkResponseBody Whether executing `getBody()` on response needs to be done. It's useful for
+     * catching exceptions that can be thrown in the process of body generation.
      */
     public function __construct(
         private array $exceptionMap,
         private ResponseFactoryInterface $responseFactory,
         private Injector $injector,
+        private bool $checkResponseBody = false,
     ) {
     }
 
     public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
     {
         try {
-            return $handler->handle($request);
+            $response = $handler->handle($request);
+            if ($this->checkResponseBody) {
+                $response->getBody();
+            }
         } catch (Throwable $t) {
             foreach ($this->exceptionMap as $exceptionType => $responseHandler) {
                 if ($t instanceof $exceptionType) {
@@ -78,5 +84,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
             }
             throw $t;
         }
+
+        return $response;
     }
 }

tests/Middleware/ExceptionResponderTest.php

@@ -5,13 +5,17 @@
 namespace Yiisoft\ErrorHandler\Tests\Middleware;
 
 use DomainException;
+use HttpSoft\Message\Response;
 use HttpSoft\Message\ResponseFactory;
+use HttpSoft\Message\ResponseTrait;
 use HttpSoft\Message\ServerRequestFactory;
 use InvalidArgumentException;
+use LogicException;
 use PHPUnit\Framework\TestCase;
 use Psr\Http\Message\ResponseFactoryInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Message\StreamInterface;
 use Psr\Http\Server\RequestHandlerInterface;
 use Yiisoft\ErrorHandler\Middleware\ExceptionResponder;
 use Yiisoft\Http\Method;
@@ -61,6 +65,45 @@ public function testAnotherException(): void
         $this->process($middleware);
     }
 
+    public function testCheckResponseBody(): void
+    {
+        $middleware = $this->createMiddleware(checkResponseBody: true);
+        $request = (new ServerRequestFactory())->createServerRequest(Method::GET, 'http://example.com');
+        $handler = new class () implements RequestHandlerInterface {
+            public function handle(ServerRequestInterface $request): ResponseInterface
+            {
+                return new class () implements ResponseInterface {
+                    use ResponseTrait;
+
+                    public function getBody(): StreamInterface
+                    {
+                        throw new LogicException('test');
+                    }
+                };
+            }
+        };
+
+        $this->expectException(LogicException::class);
+        $this->expectExceptionMessage('test');
+        $middleware->process($request, $handler);
+    }
+
+    public function testSuccess(): void
+    {
+        $middleware = $this->createMiddleware(checkResponseBody: true);
+        $request = (new ServerRequestFactory())->createServerRequest(Method::GET, 'http://example.com');
+        $handler = new class () implements RequestHandlerInterface {
+            public function handle(ServerRequestInterface $request): ResponseInterface
+            {
+                return new Response();
+            }
+        };
+
+        $response = $middleware->process($request, $handler);
+
+        $this->assertSame(200, $response->getStatusCode());
+    }
+
     private function process(ExceptionResponder $middleware): ResponseInterface
     {
         return $middleware->process(
@@ -74,8 +117,10 @@ public function handle(ServerRequestInterface $request): ResponseInterface
         );
     }
 
-    private function createMiddleware(array $exceptionMap): ExceptionResponder
-    {
+    private function createMiddleware(
+        array $exceptionMap = [],
+        bool $checkResponseBody = false,
+    ): ExceptionResponder {
         return new ExceptionResponder(
             $exceptionMap,
             new ResponseFactory(),
@@ -84,6 +129,7 @@ private function createMiddleware(array $exceptionMap): ExceptionResponder
                     ResponseFactoryInterface::class => new ResponseFactory(),
                 ]),
             ),
+            $checkResponseBody,
         );
     }
 }