#27351

pending completion

Build # #27351

Build Type

push

github

Committed by

web-flow

Commit Message

<a href="https://github.com/api-platform/core/commit/<a class=hub.com/api-platform/core/commit/169baa1e0991d7e4874e985557d77c398a32636e">169baa1e0<a href="https://github.com/api-platform/core/commit/169baa1e0991d7e4874e985557d77c398a32636e">">Merge </a><a class="double-link" href="https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/fdce8651baf1880ef2046e5ca20c2f6e5fdc3e08">fdce8651b</a>">fdce8651b</a><a href="https://github.com/api-platform/core/commit/169baa1e0991d7e4874e985557d77c398a32636e"> into 6099c3d60">6099c3d60</a>

Run Details

2 of 2 new or added lines in 1 file covered. (100.0%)

9726 of 11658 relevant lines covered (83.43%)

14.68 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

88.04

/src/GraphQl/Resolver/Stage/SerializeStage.php

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Core\GraphQl\Resolver\Stage;

use ApiPlatform\Core\DataProvider\Pagination;
use ApiPlatform\Core\DataProvider\PaginatorInterface;
use ApiPlatform\Core\DataProvider\PartialPaginatorInterface;
use ApiPlatform\Core\GraphQl\Resolver\Util\IdentifierTrait;
use ApiPlatform\Core\GraphQl\Serializer\ItemNormalizer;
use ApiPlatform\Core\GraphQl\Serializer\SerializerContextBuilderInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;

/**
 * Serialize stage of GraphQL resolvers.
 *
 * @experimental
 *
 * @author Alan Poulain <contact@alanpoulain.eu>
 */
final class SerializeStage implements SerializeStageInterface
{
    use IdentifierTrait;

    private $resourceMetadataFactory;
    private $normalizer;
    private $serializerContextBuilder;
    private $pagination;

    public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, NormalizerInterface $normalizer, SerializerContextBuilderInterface $serializerContextBuilder, Pagination $pagination)
    {
        $this->resourceMetadataFactory = $resourceMetadataFactory;
        $this->normalizer = $normalizer;
        $this->serializerContextBuilder = $serializerContextBuilder;
        $this->pagination = $pagination;
    }

    /**
     * {@inheritdoc}
     */
    public function __invoke($itemOrCollection, string $resourceClass, string $operationName, array $context): ?array
    {
        $isCollection = $context['is_collection'];
        $isMutation = $context['is_mutation'];
        $isSubscription = $context['is_subscription'];

        $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
        if (!$resourceMetadata->getGraphqlAttribute($operationName, 'serialize', true, true)) {
            if ($isCollection) {
                if ($this->pagination->isGraphQlEnabled($resourceClass, $operationName, $context)) {
                    return 'cursor' === $this->pagination->getGraphQlPaginationType($resourceClass, $operationName) ?
                        $this->getDefaultCursorBasedPaginatedData() :
                        $this->getDefaultPageBasedPaginatedData();
                }

                return [];
            }

            if ($isMutation) {
                return $this->getDefaultMutationData($context);
            }

            if ($isSubscription) {
                return $this->getDefaultSubscriptionData($context);
            }

            return null;
        }

        $normalizationContext = $this->serializerContextBuilder->create($resourceClass, $operationName, $context, true);

        $data = null;
        if (!$isCollection) {
            if ($isMutation && 'delete' === $operationName) {
                $data = ['id' => $this->getIdentifierFromContext($context)];
            } else {
                $data = $this->normalizer->normalize($itemOrCollection, ItemNormalizer::FORMAT, $normalizationContext);
            }
        }

        if ($isCollection && is_iterable($itemOrCollection)) {
            if (!$this->pagination->isGraphQlEnabled($resourceClass, $operationName, $context)) {
                $data = [];
                foreach ($itemOrCollection as $index => $object) {
                    $data[$index] = $this->normalizer->normalize($object, ItemNormalizer::FORMAT, $normalizationContext);
                }
            } else {
                $data = 'cursor' === $this->pagination->getGraphQlPaginationType($resourceClass, $operationName) ?
                    $this->serializeCursorBasedPaginatedCollection($itemOrCollection, $normalizationContext, $context) :
                    $this->serializePageBasedPaginatedCollection($itemOrCollection, $normalizationContext);
            }
        }

        if (null !== $data && !\is_array($data)) {
            throw new \UnexpectedValueException('Expected serialized data to be a nullable array.');
        }

        if ($isMutation || $isSubscription) {
            $wrapFieldName = lcfirst($resourceMetadata->getShortName());

            return [$wrapFieldName => $data] + ($isMutation ? $this->getDefaultMutationData($context) : $this->getDefaultSubscriptionData($context));
        }

        return $data;
    }

    /**
     * @throws \LogicException
     * @throws \UnexpectedValueException
     */
    private function serializeCursorBasedPaginatedCollection(iterable $collection, array $normalizationContext, array $context): array
    {
        $args = $context['args'];

        if (!($collection instanceof PartialPaginatorInterface)) {
            throw new \LogicException(sprintf('Collection returned by the collection data provider must implement %s or %s.', PaginatorInterface::class, PartialPaginatorInterface::class));
        }

        $offset = 0;
        $totalItems = 1; // For partial pagination, always consider there is at least one item.
        $nbPageItems = $collection->count();
        if (isset($args['after'])) {
            $after = base64_decode($args['after'], true);
            if (false === $after || '' === $args['after']) {
                throw new \UnexpectedValueException('' === $args['after'] ? 'Empty cursor is invalid' : sprintf('Cursor %s is invalid', $args['after']));
            }
            $offset = 1 + (int) $after;
        }

        if ($collection instanceof PaginatorInterface) {
            $totalItems = $collection->getTotalItems();

            if (isset($args['before'])) {
                $before = base64_decode($args['before'], true);
                if (false === $before || '' === $args['before']) {
                    throw new \UnexpectedValueException('' === $args['before'] ? 'Empty cursor is invalid' : sprintf('Cursor %s is invalid', $args['before']));
                }
                $offset = (int) $before - $nbPageItems;
            }
            if (isset($args['last']) && !isset($args['before'])) {
                $offset = $totalItems - $args['last'];
            }
        }

        $offset = 0 > $offset ? 0 : $offset;

        $data = $this->getDefaultCursorBasedPaginatedData();
        if ($totalItems > 0) {
            $data['pageInfo']['startCursor'] = base64_encode((string) $offset);
            $end = $offset + $nbPageItems - 1;
            $data['pageInfo']['endCursor'] = base64_encode((string) ($end >= 0 ? $end : 0));
            $data['pageInfo']['hasPreviousPage'] = $offset > 0;
            if ($collection instanceof PaginatorInterface) {
                $data['totalCount'] = $totalItems;
                $itemsPerPage = $collection->getItemsPerPage();
                $data['pageInfo']['hasNextPage'] = (float) ($itemsPerPage > 0 ? $offset % $itemsPerPage : $offset) + $itemsPerPage * $collection->getCurrentPage() < $totalItems;
            }
        }

        $index = 0;
        foreach ($collection as $object) {
            $data['edges'][$index] = [
                'node' => $this->normalizer->normalize($object, ItemNormalizer::FORMAT, $normalizationContext),
                'cursor' => base64_encode((string) ($index + $offset)),
            ];
            ++$index;
        }

        return $data;
    }

    /**
     * @throws \LogicException
     */
    private function serializePageBasedPaginatedCollection(iterable $collection, array $normalizationContext): array
    {
        if (!($collection instanceof PaginatorInterface)) {
            throw new \LogicException(sprintf('Collection returned by the collection data provider must implement %s.', PaginatorInterface::class));
        }

        $data = $this->getDefaultPageBasedPaginatedData();
        $data['paginationInfo']['totalCount'] = $collection->getTotalItems();
        $data['paginationInfo']['lastPage'] = $collection->getLastPage();
        $data['paginationInfo']['itemsPerPage'] = $collection->getItemsPerPage();

        foreach ($collection as $object) {
            $data['collection'][] = $this->normalizer->normalize($object, ItemNormalizer::FORMAT, $normalizationContext);
        }

        return $data;
    }

    private function getDefaultCursorBasedPaginatedData(): array
    {
        return ['totalCount' => 0., 'edges' => [], 'pageInfo' => ['startCursor' => null, 'endCursor' => null, 'hasNextPage' => false, 'hasPreviousPage' => false]];
    }

    private function getDefaultPageBasedPaginatedData(): array
    {
        return ['collection' => [], 'paginationInfo' => ['itemsPerPage' => 0., 'totalCount' => 0., 'lastPage' => 0.]];
    }

    private function getDefaultMutationData(array $context): array
    {
        return ['clientMutationId' => $context['args']['input']['clientMutationId'] ?? null];
    }

    private function getDefaultSubscriptionData(array $context): array
    {
        return ['clientSubscriptionId' => $context['args']['input']['clientSubscriptionId'] ?? null];
    }
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace ApiPlatform\Core\GraphQl\Resolver\Stage;
15
16	use ApiPlatform\Core\DataProvider\Pagination;
17	use ApiPlatform\Core\DataProvider\PaginatorInterface;
18	use ApiPlatform\Core\DataProvider\PartialPaginatorInterface;
19	use ApiPlatform\Core\GraphQl\Resolver\Util\IdentifierTrait;
20	use ApiPlatform\Core\GraphQl\Serializer\ItemNormalizer;
21	use ApiPlatform\Core\GraphQl\Serializer\SerializerContextBuilderInterface;
22	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
23	use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
24
25	/**
26	* Serialize stage of GraphQL resolvers.
27	*
28	* @experimental
29	*
30	* @author Alan Poulain <contact@alanpoulain.eu>
31	*/
32	final class SerializeStage implements SerializeStageInterface
33	{
34	use IdentifierTrait;
35
36	private $resourceMetadataFactory;
37	private $normalizer;
38	private $serializerContextBuilder;
39	private $pagination;
40
41	public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, NormalizerInterface $normalizer, SerializerContextBuilderInterface $serializerContextBuilder, Pagination $pagination)
42	{
43	$this->resourceMetadataFactory = $resourceMetadataFactory;	29✔
44	$this->normalizer = $normalizer;	29✔
45	$this->serializerContextBuilder = $serializerContextBuilder;	29✔
46	$this->pagination = $pagination;	29✔
47	}	29✔
48
49	/**
50	* {@inheritdoc}
51	*/
52	public function __invoke($itemOrCollection, string $resourceClass, string $operationName, array $context): ?array
53	{
54	$isCollection = $context['is_collection'];	23✔
55	$isMutation = $context['is_mutation'];	23✔
56	$isSubscription = $context['is_subscription'];	23✔
57
58	$resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);	23✔
59	if (!$resourceMetadata->getGraphqlAttribute($operationName, 'serialize', true, true)) {	23✔
60	if ($isCollection) {	5✔
61	if ($this->pagination->isGraphQlEnabled($resourceClass, $operationName, $context)) {	2✔
62	return 'cursor' === $this->pagination->getGraphQlPaginationType($resourceClass, $operationName) ?	1✔
63	$this->getDefaultCursorBasedPaginatedData() :	1✔
64	$this->getDefaultPageBasedPaginatedData();	1✔
65	}
66
67	return [];	1✔
68	}
69
70	if ($isMutation) {	3✔
71	return $this->getDefaultMutationData($context);	1✔
72	}
73
74	if ($isSubscription) {	2✔
75	return $this->getDefaultSubscriptionData($context);	1✔
76	}
77
78	return null;	1✔
79	}
80
81	$normalizationContext = $this->serializerContextBuilder->create($resourceClass, $operationName, $context, true);	18✔
82
83	$data = null;	18✔
84	if (!$isCollection) {	18✔
85	if ($isMutation && 'delete' === $operationName) {	5✔
86	$data = ['id' => $this->getIdentifierFromContext($context)];	1✔
87	} else {
88	$data = $this->normalizer->normalize($itemOrCollection, ItemNormalizer::FORMAT, $normalizationContext);	4✔
89	}
90	}
91
92	if ($isCollection && is_iterable($itemOrCollection)) {	18✔
93	if (!$this->pagination->isGraphQlEnabled($resourceClass, $operationName, $context)) {	13✔
94	$data = [];	1✔
95	foreach ($itemOrCollection as $index => $object) {	1✔
96	$data[$index] = $this->normalizer->normalize($object, ItemNormalizer::FORMAT, $normalizationContext);	1✔
97	}
98	} else {
99	$data = 'cursor' === $this->pagination->getGraphQlPaginationType($resourceClass, $operationName) ?	12✔
100	$this->serializeCursorBasedPaginatedCollection($itemOrCollection, $normalizationContext, $context) :	12✔
101	$this->serializePageBasedPaginatedCollection($itemOrCollection, $normalizationContext);	×
102	}
103	}
104
105	if (null !== $data && !\is_array($data)) {	13✔
106	throw new \UnexpectedValueException('Expected serialized data to be a nullable array.');	1✔
107	}
108
109	if ($isMutation \|\| $isSubscription) {	12✔
110	$wrapFieldName = lcfirst($resourceMetadata->getShortName());	3✔
111
112	return [$wrapFieldName => $data] + ($isMutation ? $this->getDefaultMutationData($context) : $this->getDefaultSubscriptionData($context));	3✔
113	}
114
115	return $data;	9✔
116	}
117
118	/**
119	* @throws \LogicException
120	* @throws \UnexpectedValueException
121	*/
122	private function serializeCursorBasedPaginatedCollection(iterable $collection, array $normalizationContext, array $context): array
123	{
124	$args = $context['args'];	12✔
125
126	if (!($collection instanceof PartialPaginatorInterface)) {	12✔
127	throw new \LogicException(sprintf('Collection returned by the collection data provider must implement %s or %s.', PaginatorInterface::class, PartialPaginatorInterface::class));	1✔
128	}
129
130	$offset = 0;	11✔
131	$totalItems = 1; // For partial pagination, always consider there is at least one item.	11✔
132	$nbPageItems = $collection->count();	11✔
133	if (isset($args['after'])) {	11✔
134	$after = base64_decode($args['after'], true);	4✔
135	if (false === $after \|\| '' === $args['after']) {	4✔
136	throw new \UnexpectedValueException('' === $args['after'] ? 'Empty cursor is invalid' : sprintf('Cursor %s is invalid', $args['after']));	2✔
137	}
138	$offset = 1 + (int) $after;	2✔
139	}
140
141	if ($collection instanceof PaginatorInterface) {	9✔
142	$totalItems = $collection->getTotalItems();	7✔
143
144	if (isset($args['before'])) {	7✔
145	$before = base64_decode($args['before'], true);	3✔
146	if (false === $before \|\| '' === $args['before']) {	3✔
147	throw new \UnexpectedValueException('' === $args['before'] ? 'Empty cursor is invalid' : sprintf('Cursor %s is invalid', $args['before']));	2✔
148	}
149	$offset = (int) $before - $nbPageItems;	1✔
150	}
151	if (isset($args['last']) && !isset($args['before'])) {	5✔
152	$offset = $totalItems - $args['last'];	1✔
153	}
154	}
155
156	$offset = 0 > $offset ? 0 : $offset;	7✔
157
158	$data = $this->getDefaultCursorBasedPaginatedData();	7✔
159	if ($totalItems > 0) {	7✔
160	$data['pageInfo']['startCursor'] = base64_encode((string) $offset);	6✔
161	$end = $offset + $nbPageItems - 1;	6✔
162	$data['pageInfo']['endCursor'] = base64_encode((string) ($end >= 0 ? $end : 0));	6✔
163	$data['pageInfo']['hasPreviousPage'] = $offset > 0;	6✔
164	if ($collection instanceof PaginatorInterface) {	6✔
165	$data['totalCount'] = $totalItems;	4✔
166	$itemsPerPage = $collection->getItemsPerPage();	4✔
167	$data['pageInfo']['hasNextPage'] = (float) ($itemsPerPage > 0 ? $offset % $itemsPerPage : $offset) + $itemsPerPage * $collection->getCurrentPage() < $totalItems;	4✔
168	}
169	}
170
171	$index = 0;	7✔
172	foreach ($collection as $object) {	7✔
173	$data['edges'][$index] = [	4✔
174	'node' => $this->normalizer->normalize($object, ItemNormalizer::FORMAT, $normalizationContext),	4✔
175	'cursor' => base64_encode((string) ($index + $offset)),	4✔
176	];
177	++$index;	4✔
178	}
179
180	return $data;	7✔
181	}
182
183	/**
184	* @throws \LogicException
185	*/
186	private function serializePageBasedPaginatedCollection(iterable $collection, array $normalizationContext): array
187	{
188	if (!($collection instanceof PaginatorInterface)) {	×
189	throw new \LogicException(sprintf('Collection returned by the collection data provider must implement %s.', PaginatorInterface::class));	×
190	}
191
192	$data = $this->getDefaultPageBasedPaginatedData();	×
193	$data['paginationInfo']['totalCount'] = $collection->getTotalItems();	×
194	$data['paginationInfo']['lastPage'] = $collection->getLastPage();	×
195	$data['paginationInfo']['itemsPerPage'] = $collection->getItemsPerPage();	×
196
197	foreach ($collection as $object) {	×
198	$data['collection'][] = $this->normalizer->normalize($object, ItemNormalizer::FORMAT, $normalizationContext);	×
199	}
200
201	return $data;	×
202	}
203
204	private function getDefaultCursorBasedPaginatedData(): array
205	{
206	return ['totalCount' => 0., 'edges' => [], 'pageInfo' => ['startCursor' => null, 'endCursor' => null, 'hasNextPage' => false, 'hasPreviousPage' => false]];	8✔
207	}
208
209	private function getDefaultPageBasedPaginatedData(): array
210	{
211	return ['collection' => [], 'paginationInfo' => ['itemsPerPage' => 0., 'totalCount' => 0., 'lastPage' => 0.]];	×
212	}
213
214	private function getDefaultMutationData(array $context): array
215	{
216	return ['clientMutationId' => $context['args']['input']['clientMutationId'] ?? null];	3✔
217	}
218
219	private function getDefaultSubscriptionData(array $context): array
220	{
221	return ['clientSubscriptionId' => $context['args']['input']['clientSubscriptionId'] ?? null];	2✔
222	}
223	}

api-platform / core / #27351

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous