#28205

pending completion

Build # #28205

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/074d2c6b88cbb527ae45d22bfd2785cb0e943ce3">074d2c6b8<a href="https://github.com/api-platform/core/commit/074d2c6b88cbb527ae45d22bfd2785cb0e943ce3">">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/4db5b25cc44e569d3cc5beaf2f6708e09de2d772">4db5b25cc</a>">4db5b25cc</a><a href="https://github.com/api-platform/core/commit/074d2c6b88cbb527ae45d22bfd2785cb0e943ce3"> into a3b833ffe">a3b833ffe</a>

Run Details

518 of 518 new or added lines in 37 files covered. (100.0%)

13323 of 16819 relevant lines covered (79.21%)

14.61 hits per line

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

0.0

/src/Core/GraphQl/Resolver/Stage/ReadStage.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\Api\IriConverterInterface;
use ApiPlatform\Core\DataProvider\ContextAwareCollectionDataProviderInterface;
use ApiPlatform\Core\DataProvider\SubresourceDataProviderInterface;
use ApiPlatform\Core\Util\ArrayTrait;
use ApiPlatform\Core\Util\ClassInfoTrait;
use ApiPlatform\Exception\ItemNotFoundException;
use ApiPlatform\Exception\OperationNotFoundException;
use ApiPlatform\GraphQl\Resolver\Stage\ReadStageInterface;
use ApiPlatform\GraphQl\Resolver\Util\IdentifierTrait;
use ApiPlatform\GraphQl\Serializer\ItemNormalizer;
use ApiPlatform\GraphQl\Serializer\SerializerContextBuilderInterface;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use GraphQL\Type\Definition\ResolveInfo;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

/**
 * Read stage of GraphQL resolvers.
 *
 * @author Alan Poulain <contact@alanpoulain.eu>
 */
final class ReadStage implements ReadStageInterface
{
    use ArrayTrait;
    use ClassInfoTrait;
    use IdentifierTrait;

    private $resourceMetadataCollectionFactory;
    private $iriConverter;
    private $collectionDataProvider;
    private $subresourceDataProvider;
    private $serializerContextBuilder;
    private $nestingSeparator;

    public function __construct(ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, IriConverterInterface $iriConverter, ContextAwareCollectionDataProviderInterface $collectionDataProvider, SubresourceDataProviderInterface $subresourceDataProvider, SerializerContextBuilderInterface $serializerContextBuilder, string $nestingSeparator)
    {
        $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
        $this->iriConverter = $iriConverter;
        $this->collectionDataProvider = $collectionDataProvider;
        $this->subresourceDataProvider = $subresourceDataProvider;
        $this->serializerContextBuilder = $serializerContextBuilder;
        $this->nestingSeparator = $nestingSeparator;
    }

    /**
     * {@inheritdoc}
     */
    public function __invoke(?string $resourceClass, ?string $rootClass, string $operationName, array $context)
    {
        $operation = null;
        try {
            $operation = $resourceClass ? $this->resourceMetadataCollectionFactory->create($resourceClass)->getOperation($operationName) : null;
        } catch (OperationNotFoundException $e) {
            // ReadStage may be invoked without an existing operation
        }

        if ($operation && !($operation->canRead() ?? true)) {
            return $context['is_collection'] ? [] : null;
        }

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

        if (!$context['is_collection']) {
            $identifier = $this->getIdentifierFromContext($context);
            $item = $this->getItem($identifier, $normalizationContext);

            if ($identifier && ($context['is_mutation'] || $context['is_subscription'])) {
                if (null === $item) {
                    throw new NotFoundHttpException(sprintf('Item "%s" not found.', $args['input']['id']));
                }

                if ($resourceClass !== $this->getObjectClass($item)) {
                    throw new \UnexpectedValueException(sprintf('Item "%s" did not match expected type "%s".', $args['input']['id'], $operation->getShortName()));
                }
            }

            return $item;
        }

        if (null === $rootClass) {
            return [];
        }

        $normalizationContext['filters'] = $this->getNormalizedFilters($args);

        $source = $context['source'];
        /** @var ResolveInfo $info */
        $info = $context['info'];
        if (isset($source[$rootProperty = $info->fieldName], $source[ItemNormalizer::ITEM_IDENTIFIERS_KEY], $source[ItemNormalizer::ITEM_RESOURCE_CLASS_KEY])) {
            $rootResolvedFields = $source[ItemNormalizer::ITEM_IDENTIFIERS_KEY];
            $rootResolvedClass = $source[ItemNormalizer::ITEM_RESOURCE_CLASS_KEY];
            $subresourceCollection = $this->getSubresource($rootResolvedClass, $rootResolvedFields, $rootProperty, $resourceClass, $normalizationContext, $operationName);
            if (!is_iterable($subresourceCollection)) {
                throw new \UnexpectedValueException('Expected subresource collection to be iterable.');
            }

            return $subresourceCollection;
        }

        return $this->collectionDataProvider->getCollection($resourceClass, $operationName, $normalizationContext);
    }

    /**
     * @return object|null
     */
    private function getItem(?string $identifier, array $normalizationContext)
    {
        if (null === $identifier) {
            return null;
        }

        try {
            $item = $this->iriConverter->getItemFromIri($identifier, $normalizationContext);
        } catch (ItemNotFoundException $e) {
            return null;
        }

        return $item;
    }

    private function getNormalizedFilters(array $args): array
    {
        $filters = $args;

        foreach ($filters as $name => $value) {
            if (\is_array($value)) {
                if (strpos($name, '_list')) {
                    $name = substr($name, 0, \strlen($name) - \strlen('_list'));
                }

                // If the value contains arrays, we need to merge them for the filters to understand this syntax, proper to GraphQL to preserve the order of the arguments.
                if ($this->isSequentialArrayOfArrays($value)) {
                    if (\count($value[0]) > 1) {
                        $deprecationMessage = "The filter syntax \"$name: {";
                        $filterArgsOld = [];
                        $filterArgsNew = [];
                        foreach ($value[0] as $filterArgName => $filterArgValue) {
                            $filterArgsOld[] = "$filterArgName: \"$filterArgValue\"";
                            $filterArgsNew[] = sprintf('{%s: "%s"}', $filterArgName, $filterArgValue);
                        }
                        $deprecationMessage .= sprintf('%s}" is deprecated since API Platform 2.6, use the following syntax instead: "%s: [%s]".', implode(', ', $filterArgsOld), $name, implode(', ', $filterArgsNew));
                        @trigger_error($deprecationMessage, \E_USER_DEPRECATED);
                    }
                    $value = array_merge(...$value);
                }
                $filters[$name] = $this->getNormalizedFilters($value);
            }

            if (\is_string($name) && strpos($name, $this->nestingSeparator)) {
                // Gives a chance to relations/nested fields.
                $index = array_search($name, array_keys($filters), true);
                $filters =
                    \array_slice($filters, 0, $index + 1) +
                    [str_replace($this->nestingSeparator, '.', $name) => $value] +
                    \array_slice($filters, $index + 1);
            }
        }

        return $filters;
    }

    /**
     * @return iterable|object|null
     */
    private function getSubresource(string $rootResolvedClass, array $rootResolvedFields, string $rootProperty, string $subresourceClass, array $normalizationContext, string $operationName)
    {
        $resolvedIdentifiers = [];
        $rootIdentifiers = array_keys($rootResolvedFields);
        foreach ($rootIdentifiers as $rootIdentifier) {
            $resolvedIdentifiers[$rootIdentifier] = [$rootResolvedClass, $rootIdentifier];
        }

        return $this->subresourceDataProvider->getSubresource($subresourceClass, $rootResolvedFields, $normalizationContext + [
            'property' => $rootProperty,
            'identifiers' => $resolvedIdentifiers,
            'collection' => true,
        ], $operationName);
    }
}

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\Api\IriConverterInterface;
17	use ApiPlatform\Core\DataProvider\ContextAwareCollectionDataProviderInterface;
18	use ApiPlatform\Core\DataProvider\SubresourceDataProviderInterface;
19	use ApiPlatform\Core\Util\ArrayTrait;
20	use ApiPlatform\Core\Util\ClassInfoTrait;
21	use ApiPlatform\Exception\ItemNotFoundException;
22	use ApiPlatform\Exception\OperationNotFoundException;
23	use ApiPlatform\GraphQl\Resolver\Stage\ReadStageInterface;
24	use ApiPlatform\GraphQl\Resolver\Util\IdentifierTrait;
25	use ApiPlatform\GraphQl\Serializer\ItemNormalizer;
26	use ApiPlatform\GraphQl\Serializer\SerializerContextBuilderInterface;
27	use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
28	use GraphQL\Type\Definition\ResolveInfo;
29	use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
30
31	/**
32	* Read stage of GraphQL resolvers.
33	*
34	* @author Alan Poulain <contact@alanpoulain.eu>
35	*/
36	final class ReadStage implements ReadStageInterface
37	{
38	use ArrayTrait;
39	use ClassInfoTrait;
40	use IdentifierTrait;
41
42	private $resourceMetadataCollectionFactory;
43	private $iriConverter;
44	private $collectionDataProvider;
45	private $subresourceDataProvider;
46	private $serializerContextBuilder;
47	private $nestingSeparator;
48
49	public function __construct(ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, IriConverterInterface $iriConverter, ContextAwareCollectionDataProviderInterface $collectionDataProvider, SubresourceDataProviderInterface $subresourceDataProvider, SerializerContextBuilderInterface $serializerContextBuilder, string $nestingSeparator)
50	{
51	$this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;	×
52	$this->iriConverter = $iriConverter;	×
53	$this->collectionDataProvider = $collectionDataProvider;	×
54	$this->subresourceDataProvider = $subresourceDataProvider;	×
55	$this->serializerContextBuilder = $serializerContextBuilder;	×
56	$this->nestingSeparator = $nestingSeparator;	×
57	}	×
58
59	/**
60	* {@inheritdoc}
61	*/
62	public function __invoke(?string $resourceClass, ?string $rootClass, string $operationName, array $context)
63	{
64	$operation = null;	×
65	try {
66	$operation = $resourceClass ? $this->resourceMetadataCollectionFactory->create($resourceClass)->getOperation($operationName) : null;	×
67	} catch (OperationNotFoundException $e) {	×
68	// ReadStage may be invoked without an existing operation
69	}
70
71	if ($operation && !($operation->canRead() ?? true)) {	×
72	return $context['is_collection'] ? [] : null;	×
73	}
74
75	$args = $context['args'];	×
76	$normalizationContext = $this->serializerContextBuilder->create($resourceClass, $operationName, $context, true);	×
77
78	if (!$context['is_collection']) {	×
79	$identifier = $this->getIdentifierFromContext($context);	×
80	$item = $this->getItem($identifier, $normalizationContext);	×
81
82	if ($identifier && ($context['is_mutation'] \|\| $context['is_subscription'])) {	×
83	if (null === $item) {	×
84	throw new NotFoundHttpException(sprintf('Item "%s" not found.', $args['input']['id']));	×
85	}
86
87	if ($resourceClass !== $this->getObjectClass($item)) {	×
88	throw new \UnexpectedValueException(sprintf('Item "%s" did not match expected type "%s".', $args['input']['id'], $operation->getShortName()));	×
89	}
90	}
91
92	return $item;	×
93	}
94
95	if (null === $rootClass) {	×
96	return [];	×
97	}
98
99	$normalizationContext['filters'] = $this->getNormalizedFilters($args);	×
100
101	$source = $context['source'];	×
102	/** @var ResolveInfo $info */
103	$info = $context['info'];	×
104	if (isset($source[$rootProperty = $info->fieldName], $source[ItemNormalizer::ITEM_IDENTIFIERS_KEY], $source[ItemNormalizer::ITEM_RESOURCE_CLASS_KEY])) {	×
105	$rootResolvedFields = $source[ItemNormalizer::ITEM_IDENTIFIERS_KEY];	×
106	$rootResolvedClass = $source[ItemNormalizer::ITEM_RESOURCE_CLASS_KEY];	×
107	$subresourceCollection = $this->getSubresource($rootResolvedClass, $rootResolvedFields, $rootProperty, $resourceClass, $normalizationContext, $operationName);	×
108	if (!is_iterable($subresourceCollection)) {	×
109	throw new \UnexpectedValueException('Expected subresource collection to be iterable.');	×
110	}
111
112	return $subresourceCollection;	×
113	}
114
115	return $this->collectionDataProvider->getCollection($resourceClass, $operationName, $normalizationContext);	×
116	}
117
118	/**
119	* @return object\|null
120	*/
121	private function getItem(?string $identifier, array $normalizationContext)
122	{
123	if (null === $identifier) {	×
124	return null;	×
125	}
126
127	try {
128	$item = $this->iriConverter->getItemFromIri($identifier, $normalizationContext);	×
129	} catch (ItemNotFoundException $e) {	×
130	return null;	×
131	}
132
133	return $item;	×
134	}
135
136	private function getNormalizedFilters(array $args): array
137	{
138	$filters = $args;	×
139
140	foreach ($filters as $name => $value) {	×
141	if (\is_array($value)) {	×
142	if (strpos($name, '_list')) {	×
143	$name = substr($name, 0, \strlen($name) - \strlen('_list'));	×
144	}
145
146	// If the value contains arrays, we need to merge them for the filters to understand this syntax, proper to GraphQL to preserve the order of the arguments.
147	if ($this->isSequentialArrayOfArrays($value)) {	×
148	if (\count($value[0]) > 1) {	×
149	$deprecationMessage = "The filter syntax \"$name: {";	×
150	$filterArgsOld = [];	×
151	$filterArgsNew = [];	×
152	foreach ($value[0] as $filterArgName => $filterArgValue) {	×
153	$filterArgsOld[] = "$filterArgName: \"$filterArgValue\"";	×
154	$filterArgsNew[] = sprintf('{%s: "%s"}', $filterArgName, $filterArgValue);	×
155	}
156	$deprecationMessage .= sprintf('%s}" is deprecated since API Platform 2.6, use the following syntax instead: "%s: [%s]".', implode(', ', $filterArgsOld), $name, implode(', ', $filterArgsNew));	×
157	@trigger_error($deprecationMessage, \E_USER_DEPRECATED);	×
158	}
159	$value = array_merge(...$value);	×
160	}
161	$filters[$name] = $this->getNormalizedFilters($value);	×
162	}
163
164	if (\is_string($name) && strpos($name, $this->nestingSeparator)) {	×
165	// Gives a chance to relations/nested fields.
166	$index = array_search($name, array_keys($filters), true);	×
167	$filters =	×
168	\array_slice($filters, 0, $index + 1) +	×
169	[str_replace($this->nestingSeparator, '.', $name) => $value] +	×
170	\array_slice($filters, $index + 1);	×
171	}
172	}
173
174	return $filters;	×
175	}
176
177	/**
178	* @return iterable\|object\|null
179	*/
180	private function getSubresource(string $rootResolvedClass, array $rootResolvedFields, string $rootProperty, string $subresourceClass, array $normalizationContext, string $operationName)
181	{
182	$resolvedIdentifiers = [];	×
183	$rootIdentifiers = array_keys($rootResolvedFields);	×
184	foreach ($rootIdentifiers as $rootIdentifier) {	×
185	$resolvedIdentifiers[$rootIdentifier] = [$rootResolvedClass, $rootIdentifier];	×
186	}
187
188	return $this->subresourceDataProvider->getSubresource($subresourceClass, $rootResolvedFields, $normalizationContext + [	×
189	'property' => $rootProperty,	×
190	'identifiers' => $resolvedIdentifiers,	×
191	'collection' => true,
192	], $operationName);
193	}
194	}

api-platform / core / #28205

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