release 2.3.6 (#23)

KondukterCRO · Mateo Fuzul · web-flow · commit b7779e45dec7 · 2024-04-24T00:35:31.000+02:00
* Support LID * Add links on resource collection * Static code analysis fixes * Add read side validation * Upgrade dependencies (#26) * refactor: remove deprecated methods * refactor: upgrade dependencies --------- Co-authored-by: Mateo Fuzul <85337487+fuzulbot@users.noreply.github.com>
diff --git a/composer.json b/composer.json
@@ -40,7 +40,7 @@
     },
     "scripts": {
         "lint": [
-            "php-cs-fixer fix --diff --ansi --dry-run"
+            "PHP_CS_FIXER_IGNORE_ENV=1 php-cs-fixer fix --diff --ansi --dry-run"
         ],
         "phpstan": [
             "php -d memory_limit=-1 vendor/bin/phpstan analyse -n --ansi --no-progress"
@@ -53,5 +53,10 @@
             "@phpstan",
             "@test"
         ]
+    },
+    "config": {
+        "allow-plugins": {
+            "phpstan/extension-installer": true
+        }
     }
 }
diff --git a/composer.lock b/composer.lock
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -20,6 +20,8 @@ public function getConfigTreeBuilder(): TreeBuilder
             ->min(-255)
             ->max(255)
             ->end()
+            ?->booleanNode('validate_read_model')
+            ->defaultFalse()
             ->end();
 
         return $treeBuilder;
diff --git a/src/DependencyInjection/JsonApiSymfonyExtension.php b/src/DependencyInjection/JsonApiSymfonyExtension.php
@@ -41,5 +41,6 @@ public function load(array $configs, ContainerBuilder $container): void
             ],
         ]);
         $container->setDefinition('json_api_symfony.exception_listener', $definition);
+        $container->setParameter('json_api_symfony.validate_read_model', $config['validate_read_model'] ?? false);
     }
 }
diff --git a/src/DependencyInjection/config/services.yaml b/src/DependencyInjection/config/services.yaml
@@ -51,7 +51,9 @@ services:
     Undabot\SymfonyJsonApi\Service\Resource\Factory\Definition\ResourceMetadataFactoryInterface: '@Undabot\SymfonyJsonApi\Service\Resource\Factory\ResourceMetadataFactory'
     Undabot\SymfonyJsonApi\Service\Resource\Denormalizer\ResourceDenormalizer: ~
     Undabot\SymfonyJsonApi\Service\Resource\Validation\ResourceValidator: ~
-    Undabot\SymfonyJsonApi\Service\Resource\Factory\ResourceFactory: ~
+    Undabot\SymfonyJsonApi\Service\Resource\Factory\ResourceFactory:
+        arguments:
+            $shouldValidateReadModel: '%json_api_symfony.validate_read_model%'
 
     Undabot\SymfonyJsonApi\Http\Service\:
         resource: '../../Http/Service/*'
diff --git a/src/Http/Service/EventSubscriber/ViewResponseSubscriber.php b/src/Http/Service/EventSubscriber/ViewResponseSubscriber.php
@@ -19,11 +19,11 @@
 use Undabot\SymfonyJsonApi\Http\Model\Response\ResourceResponse;
 use Undabot\SymfonyJsonApi\Http\Model\Response\ResourceUpdatedResponse;
 use Undabot\SymfonyJsonApi\Http\Model\Response\ResourceValidationErrorsResponse;
+use Undabot\SymfonyJsonApi\Service\Pagination\PaginationLinkBuilder;
 
-class ViewResponseSubscriber implements EventSubscriberInterface
+final class ViewResponseSubscriber implements EventSubscriberInterface
 {
-    /** @var DocumentToPhpArrayEncoderInterface */
-    private $documentEncoder;
+    private DocumentToPhpArrayEncoderInterface $documentEncoder;
 
     public function __construct(DocumentToPhpArrayEncoderInterface $documentEncoder)
     {
@@ -47,7 +47,7 @@ public function buildView(ViewEvent $event): void
                 null,
                 $data->getMeta(),
                 $this->buildJsonApi(),
-                $data->getLinks(),
+                (new PaginationLinkBuilder())->createLinks($event->getRequest(), $data),
                 $data->getIncludedResources()
             );
 
diff --git a/src/Http/Service/Factory/RequestFactory.php b/src/Http/Service/Factory/RequestFactory.php
@@ -23,6 +23,8 @@ class RequestFactory
 {
     private PhpArrayToResourceEncoderInterface$resourceEncoder;
     private RequestValidator$requestValidator;
+    /** @var array<string, mixed> */
+    private array $requestData = [];
 
     public function __construct(
         PhpArrayToResourceEncoderInterface $resourceEncoder,
@@ -45,12 +47,22 @@ public function createResourceRequest(
         $this->requestValidator->assertValidRequest($request);
         $requestPrimaryData = $this->getRequestPrimaryData($request);
 
-        // If the server-side ID is passed as argument, we don't expect the Client to generate ID
-        // https://jsonapi.org/format/#crud-creating-client-ids
+        /** If the server-side ID is passed as argument, we don't expect the Client to generate ID
+         * @see https://jsonapi.org/format/#crud-creating-client-ids
+         */
         if (null !== $id) {
             $this->requestValidator->assertResourceIsWithoutClientGeneratedId($requestPrimaryData);
             $requestPrimaryData['id'] = $id;
         }
+        /**
+         * If we have lid sent as id we will pass it as resource id
+         * @see https://jsonapi.org/format/#document-resource-object-identification
+         */
+        $lid = $this->getResourceLid($request);
+        if (null !== $lid) {
+            $requestPrimaryData['id'] = $lid;
+            unset($requestPrimaryData['lid']);
+        }
 
         $resource = $this->resourceEncoder->decode($requestPrimaryData);
 
@@ -136,15 +148,28 @@ public function updateResourceRequest(Request $request, string $id): UpdateResou
      */
     private function getRequestPrimaryData(Request $request): array
     {
+        if (false === empty($this->requestData)) {
+            return $this->requestData;
+        }
+
         /** @var string $rawRequestData */
-        $rawRequestData = $request->getContent(false);
+        $rawRequestData = $request->getContent();
         Assertion::isJsonString($rawRequestData, 'Request data must be valid JSON');
         $requestData = json_decode($rawRequestData, true);
 
         Assertion::notNull($requestData, 'Request data must be parsable to a valid array');
         Assertion::isArray($requestData, 'Request data must be parsable to a valid array');
         Assertion::keyExists($requestData, 'data', 'The request MUST include a single resource object as primary data');
+        $this->requestData = $requestData['data'];
 
         return $requestData['data'];
     }
+
+    private function getResourceLid(Request $request): ?string
+    {
+        $requestPrimaryData = $this->getRequestPrimaryData($request);
+        $this->requestValidator->assertResourceLidIsValid($requestPrimaryData);
+
+        return $requestPrimaryData['lid'] ?? null;
+    }
 }
diff --git a/src/Http/Service/Validation/RequestValidator.php b/src/Http/Service/Validation/RequestValidator.php
@@ -117,4 +117,11 @@ public function assertValidUpdateRequestData(array $data, string $id): void
 
         Assertion::same($data['id'], $id, 'Resource with invalid ID given');
     }
+
+    public function assertResourceLidIsValid(array $requestPrimaryData): void
+    {
+        if (true === \array_key_exists('lid', $requestPrimaryData)) {
+            Assertion::string($requestPrimaryData['lid']);
+        }
+    }
 }
diff --git a/src/Model/Link/ResponsePaginationLink.php b/src/Model/Link/ResponsePaginationLink.php
@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Undabot\SymfonyJsonApi\Model\Link;
+
+/** @psalm-immutable */
+final class ResponsePaginationLink
+{
+    public function __construct(
+        public string $paginationPageKey,
+        public int $nextSet,
+        public int $previousSet,
+        public int $firstPageKey,
+        public ?int $lastPageKey
+    ) {
+    }
+}
diff --git a/src/Model/Resource/FlatResource.php b/src/Model/Resource/FlatResource.php
@@ -136,9 +136,13 @@ public function getIndexedRelationshipObjects(): array
     public function getRelationshipMetas(): array
     {
         if (true === empty($this->relationshipMetas)) {
-            /** @var RelationshipInterface $relationship */
-            foreach ($this->resource->getRelationships() as $relationship) {
-                $this->buildRelationshipMeta($relationship);
+            $relationships = $this->resource->getRelationships();
+
+            if (null !== $relationships) {
+                /** @var RelationshipInterface $relationship */
+                foreach ($relationships as $relationship) {
+                    $this->buildRelationshipMeta($relationship);
+                }
             }
         }
 
diff --git a/src/Service/Pagination/Creator/OffsetBasedPaginationLinkParametersFactory.php b/src/Service/Pagination/Creator/OffsetBasedPaginationLinkParametersFactory.php
@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Undabot\SymfonyJsonApi\Service\Pagination\Creator;
+
+use Undabot\JsonApi\Definition\Model\Request\Pagination\PaginationInterface;
+use Undabot\JsonApi\Implementation\Model\Request\Pagination\OffsetBasedPagination;
+use Undabot\SymfonyJsonApi\Model\Link\ResponsePaginationLink;
+
+final class OffsetBasedPaginationLinkParametersFactory implements PaginationLinkParametersFactory
+{
+    public function createLinks(PaginationInterface $pagination, ?int $total): ResponsePaginationLink
+    {
+        return new ResponsePaginationLink(
+            OffsetBasedPagination::PARAM_PAGE_OFFSET,
+            $pagination->getSize(),
+            $pagination->getSize() * -1,
+            0,
+            null === $total ? null : (int) (ceil($total / $pagination->getSize()) * $pagination->getSize() - $pagination->getSize()),
+        );
+    }
+}
diff --git a/src/Service/Pagination/Creator/PageBasedPaginationLinkParametersFactory.php b/src/Service/Pagination/Creator/PageBasedPaginationLinkParametersFactory.php
@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Undabot\SymfonyJsonApi\Service\Pagination\Creator;
+
+use Undabot\JsonApi\Definition\Model\Request\Pagination\PaginationInterface;
+use Undabot\JsonApi\Implementation\Model\Request\Pagination\PageBasedPagination;
+use Undabot\SymfonyJsonApi\Model\Link\ResponsePaginationLink;
+
+final class PageBasedPaginationLinkParametersFactory implements PaginationLinkParametersFactory
+{
+    public function createLinks(PaginationInterface $pagination, ?int $total): ResponsePaginationLink
+    {
+        return new ResponsePaginationLink(
+            PageBasedPagination::PARAM_PAGE_NUMBER,
+            1,
+            -1,
+            1,
+            null === $total ? null : (int) ceil($total / $pagination->getSize()),
+        );
+    }
+}
diff --git a/src/Service/Pagination/Creator/PaginationLinkParametersFactory.php b/src/Service/Pagination/Creator/PaginationLinkParametersFactory.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Undabot\SymfonyJsonApi\Service\Pagination\Creator;
+
+use Undabot\JsonApi\Definition\Model\Request\Pagination\PaginationInterface;
+use Undabot\SymfonyJsonApi\Model\Link\ResponsePaginationLink;
+
+interface PaginationLinkParametersFactory
+{
+    public function createLinks(PaginationInterface $pagination, ?int $total): ResponsePaginationLink;
+}
diff --git a/src/Service/Pagination/PaginationLinkBuilder.php b/src/Service/Pagination/PaginationLinkBuilder.php
@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Undabot\SymfonyJsonApi\Service\Pagination;
+
+use Symfony\Component\HttpFoundation\Request;
+use Undabot\JsonApi\Definition\Model\Link\LinkCollectionInterface;
+use Undabot\JsonApi\Definition\Model\Link\LinkNamesEnum;
+use Undabot\JsonApi\Definition\Model\Request\Pagination\PaginationInterface;
+use Undabot\JsonApi\Implementation\Factory\PaginationFactory;
+use Undabot\JsonApi\Implementation\Model\Link\Link;
+use Undabot\JsonApi\Implementation\Model\Link\LinkCollection;
+use Undabot\JsonApi\Implementation\Model\Link\LinkUrl;
+use Undabot\JsonApi\Implementation\Model\Request\Pagination\OffsetBasedPagination;
+use Undabot\SymfonyJsonApi\Http\Model\Request\GetResourceCollectionRequest;
+use Undabot\SymfonyJsonApi\Http\Model\Response\ResourceCollectionResponse;
+use Undabot\SymfonyJsonApi\Service\Pagination\Creator\OffsetBasedPaginationLinkParametersFactory;
+use Undabot\SymfonyJsonApi\Service\Pagination\Creator\PageBasedPaginationLinkParametersFactory;
+
+final class PaginationLinkBuilder
+{
+    public function createLinks(Request $request, ResourceCollectionResponse $response): ?LinkCollectionInterface
+    {
+        $pagination = $this->buildPaginationIfAvailable($request);
+        $links = $response->getLinks();
+        if (null === $pagination) {
+            return $links;
+        }
+        $queryParams = $request->query->all();
+        $total = null;
+        if (null !== $response->getMeta()) {
+            $total = $response->getMeta()->getData()['total'] ?? null;
+        }
+        $responsePaginationLink = (true === ($pagination instanceof OffsetBasedPagination))
+            ? (new OffsetBasedPaginationLinkParametersFactory())->createLinks(
+                $pagination,
+                $total,
+            )
+            : (new PageBasedPaginationLinkParametersFactory())->createLinks(
+                $pagination,
+                $total,
+            );
+        $queryParamsFirst = $queryParams;
+        $queryParamsFirst[GetResourceCollectionRequest::PAGINATION_KEY][$responsePaginationLink->paginationPageKey]
+            = $responsePaginationLink->firstPageKey;
+        $paginationLinks = [$this->buildLink(LinkNamesEnum::LINK_NAME_PAGINATION_FIRST, $request, $queryParamsFirst)];
+        if (null !== $responsePaginationLink->lastPageKey) {
+            $queryParamsLast = $queryParams;
+            $queryParamsLast[GetResourceCollectionRequest::PAGINATION_KEY][$responsePaginationLink->paginationPageKey]
+                = $responsePaginationLink->lastPageKey;
+            $paginationLinks[] = $this->buildLink(LinkNamesEnum::LINK_NAME_PAGINATION_LAST, $request, $queryParamsLast);
+        }
+        if (0 !== $pagination->getOffset()) {
+            $queryParamsPrev = $queryParams;
+            $queryParamsPrev[GetResourceCollectionRequest::PAGINATION_KEY][$responsePaginationLink->paginationPageKey] += $responsePaginationLink->previousSet;
+            $paginationLinks[] = $this->buildLink(LinkNamesEnum::LINK_NAME_PAGINATION_PREV, $request, $queryParamsPrev);
+        }
+        if (null !== $total && ($pagination->getOffset() + $pagination->getSize()) < $total) {
+            $queryParamsNext = $queryParams;
+            $queryParamsNext[GetResourceCollectionRequest::PAGINATION_KEY][$responsePaginationLink->paginationPageKey] += $responsePaginationLink->nextSet;
+            $paginationLinks[] = $this->buildLink(LinkNamesEnum::LINK_NAME_PAGINATION_NEXT, $request, $queryParamsNext);
+        }
+
+        return new LinkCollection(array_merge($paginationLinks, null === $links ? [] : $links->getLinks()));
+    }
+
+    /** @param array<string,string> $queryParams */
+    private function buildLink(string $linkName, Request $request, array $queryParams): Link
+    {
+        return new Link(
+            $linkName,
+            new LinkUrl($request->getSchemeAndHttpHost() . $request->getPathInfo() . '?'
+                . urldecode(http_build_query($queryParams))),
+        );
+    }
+
+    private function buildPaginationIfAvailable(Request $request): ?PaginationInterface
+    {
+        if (false === $request->query->has(GetResourceCollectionRequest::PAGINATION_KEY)) {
+            return null;
+        }
+
+        return (new PaginationFactory())
+            ->fromArray($request->query->all()[GetResourceCollectionRequest::PAGINATION_KEY] ?? null);
+    }
+}
diff --git a/src/Service/Resource/Factory/ResourceFactory.php b/src/Service/Resource/Factory/ResourceFactory.php
@@ -19,19 +19,19 @@
 use Undabot\SymfonyJsonApi\Model\Resource\Metadata\ResourceMetadata;
 use Undabot\SymfonyJsonApi\Service\Resource\Builder\ResourceAttributesBuilder;
 use Undabot\SymfonyJsonApi\Service\Resource\Builder\ResourceRelationshipsBuilder;
+use Undabot\SymfonyJsonApi\Service\Resource\Validation\ResourceValidator;
 
 /**
  * Class responsible for creating a ResourceInterface instance out of given API model that is
  * correctly annotated with library's annotations.
  */
 class ResourceFactory
 {
-    /** @var ResourceMetadataFactory */
-    private $metadataFactory;
-
-    public function __construct(ResourceMetadataFactory $metadataFactory)
-    {
-        $this->metadataFactory = $metadataFactory;
+    public function __construct(
+        private ResourceMetadataFactory $metadataFactory,
+        private bool $shouldValidateReadModel,
+        private ResourceValidator $validator,
+    ) {
     }
 
     /**
@@ -53,7 +53,12 @@ public function make(ApiModel $apiModel): ResourceInterface
         $attributes = $this->makeAttributeCollection($apiModel, $metadata);
         $relationships = $this->makeRelationshipsCollection($apiModel, $metadata);
 
-        return new Resource($id, $type, $attributes, $relationships);
+        $resource = new Resource($id, $type, $attributes, $relationships);
+        if (true === $this->shouldValidateReadModel) {
+            $this->validator->assertValid($resource, \get_class($apiModel));
+        }
+
+        return $resource;
     }
 
     /**
diff --git a/tests/Integration/Http/Service/EventSubscriber/ViewResponseSubscriberTest.php b/tests/Integration/Http/Service/EventSubscriber/ViewResponseSubscriberTest.php
diff --git a/tests/Integration/Resource/Denormalizer/ResourceWithAliasesDenormalizerTest.php b/tests/Integration/Resource/Denormalizer/ResourceWithAliasesDenormalizerTest.php
diff --git a/tests/Integration/Resource/Factory/ResourceFactoryTest.php b/tests/Integration/Resource/Factory/ResourceFactoryTest.php
diff --git a/tests/Unit/Http/Service/EventSubscriber/ViewResponseSubscriberTest.php b/tests/Unit/Http/Service/EventSubscriber/ViewResponseSubscriberTest.php
diff --git a/tests/Unit/Http/Service/Factory/RequestFactoryTest.php b/tests/Unit/Http/Service/Factory/RequestFactoryTest.php

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@`
`40`	`40`	`},`
`41`	`41`	`"scripts": {`
`42`	`42`	`"lint": [`
`43`		`- "php-cs-fixer fix --diff --ansi --dry-run"`
	`43`	`+ "PHP_CS_FIXER_IGNORE_ENV=1 php-cs-fixer fix --diff --ansi --dry-run"`
`44`	`44`	`],`
`45`	`45`	`"phpstan": [`
`46`	`46`	`"php -d memory_limit=-1 vendor/bin/phpstan analyse -n --ansi --no-progress"`
`@@ -53,5 +53,10 @@`
`53`	`53`	`"@phpstan",`
`54`	`54`	`"@test"`
`55`	`55`	`]`
	`56`	`+ },`
	`57`	`+ "config": {`
	`58`	`+ "allow-plugins": {`
	`59`	`+ "phpstan/extension-installer": true`
	`60`	`+ }`
`56`	`61`	`}`
`57`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,5 +41,6 @@ public function load(array $configs, ContainerBuilder $container): void`
`41`	`41`	`],`
`42`	`42`	`]);`
`43`	`43`	`$container->setDefinition('json_api_symfony.exception_listener', $definition);`
	`44`	`+ $container->setParameter('json_api_symfony.validate_read_model', $config['validate_read_model'] ?? false);`
`44`	`45`	`}`
`45`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -117,4 +117,11 @@ public function assertValidUpdateRequestData(array $data, string $id): void`
`117`	`117`
`118`	`118`	`Assertion::same($data['id'], $id, 'Resource with invalid ID given');`
`119`	`119`	`}`
	`120`	`+`
	`121`	`+ public function assertResourceLidIsValid(array $requestPrimaryData): void`
	`122`	`+ {`
	`123`	`+ if (true === \array_key_exists('lid', $requestPrimaryData)) {`
	`124`	`+ Assertion::string($requestPrimaryData['lid']);`
	`125`	`+ }`
	`126`	`+ }`
`120`	`127`	`}`
Original file line number	Diff line number	Diff line change
`@@ -136,9 +136,13 @@ public function getIndexedRelationshipObjects(): array`
`136`	`136`	`public function getRelationshipMetas(): array`
`137`	`137`	`{`
`138`	`138`	`if (true === empty($this->relationshipMetas)) {`
`139`		`- /** @var RelationshipInterface $relationship */`
`140`		`- foreach ($this->resource->getRelationships() as $relationship) {`
`141`		`- $this->buildRelationshipMeta($relationship);`
	`139`	`+ $relationships = $this->resource->getRelationships();`
	`140`	`+`
	`141`	`+ if (null !== $relationships) {`
	`142`	`+ /** @var RelationshipInterface $relationship */`
	`143`	`+ foreach ($relationships as $relationship) {`
	`144`	`+ $this->buildRelationshipMeta($relationship);`
	`145`	`+ }`
`142`	`146`	`}`
`143`	`147`	`}`
`144`	`148`