Add support for responding with profiles in Content-Type

Author: tobyzerner

docs/context.md

@@ -47,6 +47,9 @@ class Context
     // Links to be returned in the document's links object
     public ArrayObject $documentLinks;
 
+    // Active JSON:API profile URIs for the current response
+    public ArrayObject $activeProfiles;
+
     // Get the request method
     public function method(): string;
 
@@ -79,5 +82,8 @@ class Context
 
     // Determine whether a sort field has been requested
     public function sortRequested(string $field): bool;
+
+    // Activate a JSON:API profile for the current response
+    public function activateProfile(string $uri): static;
 }
 ```

src/Context.php

@@ -24,6 +24,7 @@ class Context
     public ?array $include = null;
     public ArrayObject $documentMeta;
     public ArrayObject $documentLinks;
+    public ArrayObject $activeProfiles;
     public WeakMap $resourceMeta;
 
     private ?array $body;
@@ -45,6 +46,7 @@ public function __construct(public JsonApi $api, public ServerRequestInterface $
 
         $this->documentMeta = new ArrayObject();
         $this->documentLinks = new ArrayObject();
+        $this->activeProfiles = new ArrayObject();
 
         $this->resourceMeta = new WeakMap();
     }
@@ -289,6 +291,13 @@ public function resourceMeta($model, array $meta): static
         return $this;
     }
 
+    public function activateProfile(string $uri): static
+    {
+        $this->activeProfiles[$uri] = true;
+
+        return $this;
+    }
+
     public function forModel(array $collections, ?object $model): static
     {
         $new = clone $this;

src/Exception/Pagination/MaxPageSizeExceededException.php

@@ -3,6 +3,7 @@
 namespace Tobyz\JsonApiServer\Exception\Pagination;
 
 use Tobyz\JsonApiServer\Exception\BadRequestException;
+use Tobyz\JsonApiServer\Pagination\CursorPagination;
 
 class MaxPageSizeExceededException extends BadRequestException
 {
@@ -11,9 +12,7 @@ public function __construct(private readonly int $maxSize)
         parent::__construct('Page size requested is too large');
 
         $this->meta(['page' => ['maxSize' => $this->maxSize]])->links([
-            'type' => [
-                'https://jsonapi.org/profiles/ethanresnick/cursor-pagination/max-size-exceeded',
-            ],
+            'type' => [CursorPagination::PROFILE_URI . '/max-size-exceeded'],
         ]);
     }
 }

src/Exception/Pagination/RangePaginationNotSupportedException.php

@@ -3,6 +3,7 @@
 namespace Tobyz\JsonApiServer\Exception\Pagination;
 
 use Tobyz\JsonApiServer\Exception\BadRequestException;
+use Tobyz\JsonApiServer\Pagination\CursorPagination;
 
 class RangePaginationNotSupportedException extends BadRequestException
 {
@@ -11,9 +12,7 @@ public function __construct()
         parent::__construct('Range pagination is not supported');
 
         $this->links([
-            'type' => [
-                'https://jsonapi.org/profiles/ethanresnick/cursor-pagination/range-pagination-not-supported',
-            ],
+            'type' => [CursorPagination::PROFILE_URI . '/range-pagination-not-supported'],
         ]);
     }
 }

src/JsonApi.php

@@ -166,6 +166,16 @@ public function handle(Request $request): Response
             throw $e ?? new NotFoundException();
         }
 
+        if (count($context->activeProfiles)) {
+            $contentType = $response->getHeaderLine('Content-Type');
+
+            if (str_starts_with($contentType, self::MEDIA_TYPE)) {
+                $profileUris = array_keys(array_filter($context->activeProfiles->getArrayCopy()));
+                $contentType .= '; profile="' . implode(' ', $profileUris) . '"';
+                $response = $response->withHeader('Content-Type', $contentType);
+            }
+        }
+
         return $response->withAddedHeader('Vary', 'Accept');
     }
 

src/Pagination/CursorPagination.php

@@ -13,6 +13,8 @@ class CursorPagination implements Pagination
 {
     use HasSizeParameter;
 
+    public const PROFILE_URI = 'https://jsonapi.org/profiles/ethanresnick/cursor-pagination';
+
     public readonly int $size;
     public readonly ?string $after;
     public readonly ?string $before;
@@ -24,6 +26,8 @@ public function __construct(int $defaultSize = 20, ?int $maxSize = 50)
 
     public function paginate(object $query, Context $context): array
     {
+        $context->activateProfile(self::PROFILE_URI);
+
         $size = $this->getSize($context, 'size');
         $after = $this->getCursor($context, 'after');
         $before = $this->getCursor($context, 'before');

tests/specification/CursorPaginationTest.php

@@ -4,9 +4,9 @@
 
 use Tobyz\JsonApiServer\Endpoint\Index;
 use Tobyz\JsonApiServer\Exception\BadRequestException;
-use Tobyz\JsonApiServer\JsonApi;
 use Tobyz\JsonApiServer\Exception\Pagination\MaxPageSizeExceededException;
 use Tobyz\JsonApiServer\Exception\Pagination\RangePaginationNotSupportedException;
+use Tobyz\JsonApiServer\JsonApi;
 use Tobyz\Tests\JsonApiServer\AbstractTestCase;
 use Tobyz\Tests\JsonApiServer\MockResource;
 
@@ -27,6 +27,16 @@ public function setUp(): void
         );
     }
 
+    public function test_includes_profile_in_content_type(): void
+    {
+        $response = $this->api->handle($this->buildRequest('GET', '/articles'));
+
+        $this->assertEquals(
+            'application/vnd.api+json; profile="https://jsonapi.org/profiles/ethanresnick/cursor-pagination"',
+            $response->getHeaderLine('Content-Type'),
+        );
+    }
+
     public function test_first_page_includes_expected_links_and_item_cursors(): void
     {
         $response = $this->api->handle($this->buildRequest('GET', '/articles'));