feat(router): handle ConvertsToResponse outside of exception handler (#1320)

Author: innocenzi

packages/router/src/Exceptions/HttpExceptionHandler.php

@@ -32,7 +32,6 @@ public function handle(Throwable $throwable): void
 
             $response = match (true) {
                 $throwable instanceof ConvertsToResponse => $throwable->toResponse(),
-                $throwable instanceof RouteBindingFailed => $this->renderErrorResponse(Status::NOT_FOUND),
                 $throwable instanceof HttpRequestFailed => $this->renderErrorResponse($throwable->status, $throwable),
                 default => $this->renderErrorResponse(Status::INTERNAL_SERVER_ERROR),
             };

packages/router/src/HandleRouteExceptionMiddleware.php

@@ -8,6 +8,7 @@
 use Tempest\Http\Response;
 use Tempest\Http\Responses\Invalid;
 use Tempest\Http\Responses\NotFound;
+use Tempest\Router\Exceptions\ConvertsToResponse;
 use Tempest\Router\Exceptions\RouteBindingFailed;
 use Tempest\Validation\Exceptions\ValidationFailed;
 
@@ -21,7 +22,7 @@ public function __construct(
     public function __invoke(Request $request, HttpMiddlewareCallable $next): Response
     {
         if ($this->routeConfig->throwHttpExceptions === true) {
-            $response = $next($request);
+            $response = $this->forward($request, $next);
 
             if ($response->status->isServerError() || $response->status->isClientError()) {
                 throw new HttpRequestFailed(
@@ -33,8 +34,15 @@ public function __invoke(Request $request, HttpMiddlewareCallable $next): Respon
             return $response;
         }
 
+        return $this->forward($request, $next);
+    }
+
+    private function forward(Request $request, HttpMiddlewareCallable $next): Response
+    {
         try {
             return $next($request);
+        } catch (ConvertsToResponse $convertsToResponse) {
+            return $convertsToResponse->toResponse();
         } catch (RouteBindingFailed) {
             return new NotFound();
         } catch (ValidationFailed $validationException) {

src/Tempest/Framework/Testing/Http/TestResponseHelper.php

@@ -218,4 +218,10 @@ public function assertNotSee(string $search): self
 
         return $this;
     }
+
+    public function dd(): void
+    {
+        // @phpstan-ignore disallowed.function
+        dd($this->response); // @mago-expect best-practices/no-debug-symbols
+    }
 }

tests/Integration/Http/HttpExceptionHandlerTest.php

@@ -115,17 +115,6 @@ public function test_exception_handler_returns_500_by_default(): void
         $this->assertStringContainsString('An unexpected server error occurred', $this->render($this->response->body));
     }
 
-    public function test_exception_handler_returns_404_for_router_not_found_execption(): void
-    {
-        $this->callExceptionHandler(function (): void {
-            $handler = $this->container->get(HttpExceptionHandler::class);
-            $handler->handle(new RouteBindingFailed());
-        });
-
-        $this->assertSame(Status::NOT_FOUND, $this->response->status);
-        $this->assertStringContainsString('This page could not be found on the server', $this->render($this->response->body));
-    }
-
     #[TestWith([Status::BAD_REQUEST])]
     #[TestWith([Status::INTERNAL_SERVER_ERROR])]
     #[TestWith([Status::NOT_FOUND])]

tests/Integration/Route/Fixtures/ExceptionThatConvertsToRedirectResponse.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Tests\Tempest\Integration\Route\Fixtures;
+
+use Exception;
+use Tempest\Http\Response;
+use Tempest\Http\Responses\Redirect;
+use Tempest\Router\Exceptions\ConvertsToResponse;
+
+/**
+ * Used by RouterTest.
+ */
+final class ExceptionThatConvertsToRedirectResponse extends Exception implements ConvertsToResponse
+{
+    public function toResponse(): Response
+    {
+        return new Redirect('https://tempestphp.com');
+    }
+}

tests/Integration/Route/Fixtures/Http500Controller.php

@@ -25,4 +25,10 @@ public function serverErrorWithBody(): ServerError
     {
         return new ServerError('custom error');
     }
+
+    #[Get('/returns-converts-to-response')]
+    public function convertsToResponse(): ServerError
+    {
+        throw new ExceptionThatConvertsToRedirectResponse();
+    }
 }

tests/Integration/Route/RouterTest.php

@@ -324,4 +324,14 @@ public function test_error_response_processor_does_not_throw_http_exceptions_if_
             ->assertStatus(Status::INTERNAL_SERVER_ERROR)
             ->assertSee('custom error');
     }
+
+    public function test_converts_to_response(): void
+    {
+        $this->registerRoute([Http500Controller::class, 'convertsToResponse']);
+
+        $this->http
+            ->get('/returns-converts-to-response')
+            ->assertStatus(Status::FOUND)
+            ->assertHeaderContains('Location', 'https://tempestphp.com');
+    }
 }