feat(router): json serializable as response body (#1420)

Author: NeoIsRecursive

packages/http/src/GenericResponse.php

@@ -5,6 +5,7 @@
 namespace Tempest\Http;
 
 use Generator;
+use JsonSerializable;
 use Tempest\View\View;
 
 final class GenericResponse implements Response
@@ -13,7 +14,7 @@ final class GenericResponse implements Response
 
     public function __construct(
         Status $status,
-        Generator|View|string|array|null $body = null,
+        Generator|View|string|array|JsonSerializable|null $body = null,
         array $headers = [],
         ?View $view = null,
     ) {

packages/http/src/IsResponse.php

@@ -5,6 +5,7 @@
 namespace Tempest\Http;
 
 use Generator;
+use JsonSerializable;
 use Tempest\Http\Cookie\Cookie;
 use Tempest\Http\Cookie\CookieManager;
 use Tempest\Http\Session\Session;
@@ -17,7 +18,7 @@ trait IsResponse
 {
     private(set) Status $status = Status::OK;
 
-    private(set) View|string|array|Generator|null $body = null;
+    private(set) View|string|array|Generator|JsonSerializable|null $body = null;
 
     /** @var \Tempest\Http\Header[] */
     private(set) array $headers = [];

packages/http/src/Response.php

@@ -5,6 +5,7 @@
 namespace Tempest\Http;
 
 use Generator;
+use JsonSerializable;
 use Tempest\Http\Cookie\Cookie;
 use Tempest\View\View;
 
@@ -19,7 +20,7 @@ interface Response
         get;
     }
 
-    public View|string|array|Generator|null $body {
+    public View|string|array|Generator|JsonSerializable|null $body {
         get;
     }
 

packages/http/src/Responses/Created.php

@@ -4,6 +4,7 @@
 
 namespace Tempest\Http\Responses;
 
+use JsonSerializable;
 use Tempest\Http\IsResponse;
 use Tempest\Http\Response;
 use Tempest\Http\Status;
@@ -13,7 +14,7 @@ final class Created implements Response
 {
     use IsResponse;
 
-    public function __construct(string|array|null|View $body = null)
+    public function __construct(string|array|null|View|JsonSerializable $body = null)
     {
         $this->status = Status::CREATED;
         $this->body = $body;

packages/http/src/Responses/NotFound.php

@@ -5,6 +5,7 @@
 namespace Tempest\Http\Responses;
 
 use Generator;
+use JsonSerializable;
 use Tempest\Http\IsResponse;
 use Tempest\Http\Response;
 use Tempest\Http\Status;
@@ -14,7 +15,7 @@ final class NotFound implements Response
 {
     use IsResponse;
 
-    public function __construct(View|Generator|string|array|null $body = null)
+    public function __construct(View|JsonSerializable|Generator|string|array|null $body = null)
     {
         $this->status = Status::NOT_FOUND;
         $this->body = $body;

packages/http/src/Responses/Ok.php

@@ -5,6 +5,7 @@
 namespace Tempest\Http\Responses;
 
 use Generator;
+use JsonSerializable;
 use Tempest\Http\IsResponse;
 use Tempest\Http\Response;
 use Tempest\Http\Status;
@@ -14,7 +15,7 @@ final class Ok implements Response
 {
     use IsResponse;
 
-    public function __construct(View|Generator|string|array|null $body = null)
+    public function __construct(View|JsonSerializable|Generator|string|array|null $body = null)
     {
         $this->status = Status::OK;
         $this->body = $body;

packages/router/src/GenericResponseSender.php

@@ -5,6 +5,7 @@
 namespace Tempest\Router;
 
 use Generator;
+use JsonSerializable;
 use Tempest\Container\Container;
 use Tempest\Http\ContentType;
 use Tempest\Http\Header;
@@ -96,7 +97,7 @@ private function sendContent(Response $response): void
 
         if ($response instanceof File || $response instanceof Download) {
             readfile($body);
-        } elseif (is_array($body)) {
+        } elseif (is_array($body) || $body instanceof JsonSerializable) {
             echo json_encode($body);
         } elseif ($body instanceof View) {
             echo $this->viewRenderer->render($body);

tests/Integration/Http/GenericResponseSenderTest.php

@@ -4,6 +4,7 @@
 
 namespace Tests\Tempest\Integration\Http;
 
+use JsonSerializable;
 use Tempest\Http\GenericRequest;
 use Tempest\Http\GenericResponse;
 use Tempest\Http\Method;
@@ -127,6 +128,29 @@ public function test_sending_of_array_to_json(): void
         $this->assertSame('{"key":"value"}', $output);
     }
 
+    public function test_sending_of_json_serializable_to_json(): void
+    {
+        ob_start();
+
+        $response = new GenericResponse(
+            status: Status::CREATED,
+            body: new class implements JsonSerializable {
+                public function jsonSerialize(): mixed
+                {
+                    return ['key' => 'value'];
+                }
+            },
+        );
+
+        $responseSender = $this->container->get(GenericResponseSender::class);
+
+        $responseSender->send($response);
+
+        $output = ob_get_clean();
+
+        $this->assertSame('{"key":"value"}', $output);
+    }
+
     public function test_view_body(): void
     {
         ob_start();