feat: support custom error messages for manual HttpRequestFailed throw

Author: innocenzi

packages/http/src/HttpRequestFailed.php

@@ -4,36 +4,38 @@
 
 use Exception;
 use Tempest\Core\ProvidesContext;
-use Throwable;
 
 /**
- * Represents an HTTP exception.
+ * Stops the request's execution and return a response with the given status. Optionally, a message may be provided.
  */
 final class HttpRequestFailed extends Exception implements ProvidesContext
 {
+    /**
+     * @param Status $status The HTTP status code to send as a response.
+     * @param string|null $message An optional message that will be displayed to the client.
+     * @param Response|null $cause The response that caused the failure, if any.
+     * @param Request|null $request The request that failed, for debug purposes.
+     */
     public function __construct(
         private(set) readonly Status $status,
         ?string $message = null,
         private(set) readonly ?Response $cause = null,
         private(set) readonly ?Request $request = null,
-        ?Throwable $previous = null,
     ) {
         parent::__construct(
             message: $message ?: '',
             code: $status->value,
-            previous: $previous,
         );
     }
 
     public function context(): array
     {
-        return [
+        return array_filter([
             'request_uri' => $this->request?->uri,
             'request_method' => $this->request?->method->value,
-            'status' => $this->status->value,
-            'message' => $this->message,
-            'cause' => $this->cause,
-            'previous' => $this->getPrevious()?->getMessage(),
-        ];
+            'status_code' => $this->status->value,
+            'message' => $this->message !== '' ? $this->message : null,
+            'original_response' => $this->cause ? $this->cause::class : null,
+        ]);
     }
 }

packages/router/src/Exceptions/HtmlExceptionRenderer.php

@@ -69,6 +69,10 @@ public function render(Throwable $throwable): Response
 
     private function renderHttpRequestFailed(HttpRequestFailed $exception): Response
     {
+        if ($exception->getMessage() !== '') {
+            return $this->renderErrorResponse($exception->status, message: $exception->getMessage());
+        }
+
         if ($exception->cause && is_string($exception->cause->body)) {
             return $this->renderErrorResponse($exception->status, message: $exception->cause->body);
         }

packages/router/src/Exceptions/JsonExceptionRenderer.php

@@ -48,6 +48,10 @@ public function render(Throwable $throwable): Response
 
     private function renderHttpRequestFailed(HttpRequestFailed $exception): Response
     {
+        if ($exception->getMessage() !== '') {
+            return $this->renderErrorResponse($exception->status, message: $exception->getMessage());
+        }
+
         if ($exception->cause && is_string($exception->cause->body)) {
             return $this->renderErrorResponse($exception->status, message: $exception->cause->body);
         }

tests/Integration/Http/Exceptions/HtmlExceptionRendererTest.php

@@ -188,4 +188,18 @@ public function uses_translations(): void
         $this->assertInstanceOf(View::class, $response->body);
         $this->assertSame('I am a teapot.', $response->body->data['message']);
     }
+
+    #[Test]
+    public function http_request_failed_with_custom_message(): void
+    {
+        $response = $this->renderer->render(new HttpRequestFailed(
+            status: Status::BAD_REQUEST,
+            message: 'Custom error message',
+        ));
+
+        $this->assertSame(Status::BAD_REQUEST, $response->status);
+        $this->assertInstanceOf(GenericResponse::class, $response);
+        $this->assertInstanceOf(GenericView::class, $response->body);
+        $this->assertSame('Custom error message', $response->body->data['message']);
+    }
 }

tests/Integration/Http/Exceptions/JsonExceptionRendererTest.php

@@ -177,4 +177,17 @@ public function uses_status_description(): void
 
         $this->assertSame("I'm a teapot", $response->body['message']);
     }
+
+    #[Test]
+    public function http_request_failed_with_custom_message(): void
+    {
+        $response = $this->renderer->render(new HttpRequestFailed(
+            status: Status::BAD_REQUEST,
+            message: 'Custom error message',
+        ));
+
+        $this->assertInstanceOf(Json::class, $response);
+        $this->assertSame(Status::BAD_REQUEST, $response->status);
+        $this->assertSame('Custom error message', $response->body['message']);
+    }
 }