7970375011

Committed 20 Feb 2024 08:17AM UTC coverage: 63.802% (-0.03%) from 63.835%

Build # 7970375011

Build Type

push

github

Committed by

web-flow

Commit Message

feat(graphql): partial pagination for page based pagination (#6120)

Co-authored-by: Xavier Leune <xleune@ccmbenchmark.com>

Run Details

2 of 29 new or added lines in 8 files covered. (6.9%)

12 existing lines in 3 files now uncovered.

17065 of 26747 relevant lines covered (63.8%)

31.2 hits per line

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

0.0

/src/GraphQl/Type/TypeBuilder.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\GraphQl\Type;

use ApiPlatform\GraphQl\Serializer\ItemNormalizer;
use ApiPlatform\Metadata\CollectionOperationInterface;
use ApiPlatform\Metadata\Exception\OperationNotFoundException;
use ApiPlatform\Metadata\GraphQl\Mutation;
use ApiPlatform\Metadata\GraphQl\Operation;
use ApiPlatform\Metadata\GraphQl\Query;
use ApiPlatform\Metadata\GraphQl\Subscription;
use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
use ApiPlatform\State\Pagination\Pagination;
use GraphQL\Type\Definition\EnumType;
use GraphQL\Type\Definition\InputObjectType;
use GraphQL\Type\Definition\InterfaceType;
use GraphQL\Type\Definition\NonNull;
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\Type as GraphQLType;
use Psr\Container\ContainerInterface;
use Symfony\Component\PropertyInfo\Type;

/**
 * Builds the GraphQL types.
 *
 * @author Alan Poulain <contact@alanpoulain.eu>
 */
final class TypeBuilder implements TypeBuilderInterface, TypeBuilderEnumInterface
{
    private $defaultFieldResolver;

    public function __construct(private readonly TypesContainerInterface $typesContainer, callable $defaultFieldResolver, private readonly ContainerInterface $fieldsBuilderLocator, private readonly Pagination $pagination)
    {
        $this->defaultFieldResolver = $defaultFieldResolver;
    }

    /**
     * {@inheritdoc}
     */
    public function getResourceObjectType(?string $resourceClass, ResourceMetadataCollection $resourceMetadataCollection, Operation $operation, bool $input, bool $wrapped = false, int $depth = 0): GraphQLType
    {
        $shortName = $operation->getShortName();
        $operationName = $operation->getName();

        if ($operation instanceof Mutation) {
            $shortName = $operationName.ucfirst($shortName);
        }

        if ($operation instanceof Subscription) {
            $shortName = $operationName.ucfirst($shortName).'Subscription';
        }

        if ($input) {
            if ($depth > 0) {
                $shortName .= 'Nested';
            }
            $shortName .= 'Input';
        } elseif ($operation instanceof Mutation || $operation instanceof Subscription) {
            if ($depth > 0) {
                $shortName .= 'Nested';
            }
            $shortName .= 'Payload';
        }

        if ('item_query' === $operationName || 'collection_query' === $operationName) {
            // Test if the collection/item has different groups
            if ($resourceMetadataCollection->getOperation($operation instanceof CollectionOperationInterface ? 'item_query' : 'collection_query')->getNormalizationContext() !== $operation->getNormalizationContext()) {
                $shortName .= $operation instanceof CollectionOperationInterface ? 'Collection' : 'Item';
            }
        }

        if ($wrapped && ($operation instanceof Mutation || $operation instanceof Subscription)) {
            $shortName .= 'Data';
        }

        if ($this->typesContainer->has($shortName)) {
            $resourceObjectType = $this->typesContainer->get($shortName);
            if (!($resourceObjectType instanceof ObjectType || $resourceObjectType instanceof NonNull)) {
                throw new \LogicException(sprintf('Expected GraphQL type "%s" to be %s.', $shortName, implode('|', [ObjectType::class, NonNull::class])));
            }

            return $resourceObjectType;
        }

        $ioMetadata = $input ? $operation->getInput() : $operation->getOutput();
        if (null !== $ioMetadata && \array_key_exists('class', $ioMetadata) && null !== $ioMetadata['class']) {
            $resourceClass = $ioMetadata['class'];
        }

        $wrapData = !$wrapped && ($operation instanceof Mutation || $operation instanceof Subscription) && !$input && $depth < 1;

        $configuration = [
            'name' => $shortName,
            'description' => $operation->getDescription(),
            'resolveField' => $this->defaultFieldResolver,
            'fields' => function () use ($resourceClass, $operation, $operationName, $resourceMetadataCollection, $input, $wrapData, $depth, $ioMetadata) {
                if ($wrapData) {
                    $queryNormalizationContext = $this->getQueryOperation($resourceMetadataCollection)?->getNormalizationContext() ?? [];

                    try {
                        $mutationNormalizationContext = $operation instanceof Mutation || $operation instanceof Subscription ? ($resourceMetadataCollection->getOperation($operationName)->getNormalizationContext() ?? []) : [];
                    } catch (OperationNotFoundException) {
                        $mutationNormalizationContext = [];
                    }
                    // Use a new type for the wrapped object only if there is a specific normalization context for the mutation or the subscription.
                    // If not, use the query type in order to ensure the client cache could be used.
                    $useWrappedType = $queryNormalizationContext !== $mutationNormalizationContext;

                    $wrappedOperationName = $operationName;

                    if (!$useWrappedType) {
                        $wrappedOperationName = $operation instanceof Query ? $operationName : 'item_query';
                    }

                    $wrappedOperation = $resourceMetadataCollection->getOperation($wrappedOperationName);

                    $fields = [
                        lcfirst($wrappedOperation->getShortName()) => $this->getResourceObjectType($resourceClass, $resourceMetadataCollection, $wrappedOperation instanceof Operation ? $wrappedOperation : null, $input, true, $depth),
                    ];

                    if ($operation instanceof Subscription) {
                        $fields['clientSubscriptionId'] = GraphQLType::string();
                        if ($operation->getMercure()) {
                            $fields['mercureUrl'] = GraphQLType::string();
                        }

                        return $fields;
                    }

                    return $fields + ['clientMutationId' => GraphQLType::string()];
                }

                $fieldsBuilder = $this->fieldsBuilderLocator->get('api_platform.graphql.fields_builder');
                $fields = $fieldsBuilder->getResourceObjectTypeFields($resourceClass, $operation, $input, $depth, $ioMetadata);

                if ($input && $operation instanceof Mutation && null !== $mutationArgs = $operation->getArgs()) {
                    return $fieldsBuilder->resolveResourceArgs($mutationArgs, $operation) + ['clientMutationId' => $fields['clientMutationId']];
                }
                if ($input && $operation instanceof Mutation && null !== $extraMutationArgs = $operation->getExtraArgs()) {
                    return $fields + $fieldsBuilder->resolveResourceArgs($extraMutationArgs, $operation);
                }

                return $fields;
            },
            'interfaces' => $wrapData ? [] : [$this->getNodeInterface()],
        ];

        $resourceObjectType = $input ? GraphQLType::nonNull(new InputObjectType($configuration)) : new ObjectType($configuration);
        $this->typesContainer->set($shortName, $resourceObjectType);

        return $resourceObjectType;
    }

    /**
     * {@inheritdoc}
     */
    public function getNodeInterface(): InterfaceType
    {
        if ($this->typesContainer->has('Node')) {
            $nodeInterface = $this->typesContainer->get('Node');
            if (!$nodeInterface instanceof InterfaceType) {
                throw new \LogicException(sprintf('Expected GraphQL type "Node" to be %s.', InterfaceType::class));
            }

            return $nodeInterface;
        }

        $nodeInterface = new InterfaceType([
            'name' => 'Node',
            'description' => 'A node, according to the Relay specification.',
            'fields' => [
                'id' => [
                    'type' => GraphQLType::nonNull(GraphQLType::id()),
                    'description' => 'The id of this node.',
                ],
            ],
            'resolveType' => function ($value): ?GraphQLType {
                if (!isset($value[ItemNormalizer::ITEM_RESOURCE_CLASS_KEY])) {
                    return null;
                }

                $shortName = (new \ReflectionClass($value[ItemNormalizer::ITEM_RESOURCE_CLASS_KEY]))->getShortName();

                return $this->typesContainer->has($shortName) ? $this->typesContainer->get($shortName) : null;
            },
        ]);

        $this->typesContainer->set('Node', $nodeInterface);

        return $nodeInterface;
    }

    /**
     * {@inheritdoc}
     */
    public function getResourcePaginatedCollectionType(GraphQLType $resourceType, string $resourceClass, Operation $operation): GraphQLType
    {
        @trigger_error('Using getResourcePaginatedCollectionType method of TypeBuilder is deprecated since API Platform 3.1. Use getPaginatedCollectionType method instead.', \E_USER_DEPRECATED);

        return $this->getPaginatedCollectionType($resourceType, $operation);
    }

    /**
     * {@inheritdoc}
     */
    public function getPaginatedCollectionType(GraphQLType $resourceType, Operation $operation): GraphQLType
    {
        $namedType = GraphQLType::getNamedType($resourceType);
        // graphql-php 15: name() exists
        $shortName = method_exists($namedType, 'name') ? $namedType->name() : $namedType->name;
        $paginationType = $this->pagination->getGraphQlPaginationType($operation);

        $connectionTypeKey = sprintf('%s%sConnection', $shortName, ucfirst($paginationType));
        if ($this->typesContainer->has($connectionTypeKey)) {
            return $this->typesContainer->get($connectionTypeKey);
        }

        $fields = 'cursor' === $paginationType ?
            $this->getCursorBasedPaginationFields($resourceType) :
            $this->getPageBasedPaginationFields($resourceType);

        $configuration = [
            'name' => $connectionTypeKey,
            'description' => sprintf("%s connection for $shortName.", ucfirst($paginationType)),
            'fields' => $fields,
        ];

        $resourcePaginatedCollectionType = new ObjectType($configuration);
        $this->typesContainer->set($connectionTypeKey, $resourcePaginatedCollectionType);

        return $resourcePaginatedCollectionType;
    }

    public function getEnumType(Operation $operation): GraphQLType
    {
        $enumName = $operation->getShortName();

        if ($this->typesContainer->has($enumName)) {
            return $this->typesContainer->get($enumName);
        }

        /** @var FieldsBuilderEnumInterface|FieldsBuilderInterface $fieldsBuilder */
        $fieldsBuilder = $this->fieldsBuilderLocator->get('api_platform.graphql.fields_builder');
        $enumCases = [];
        // Remove the condition in API Platform 4.
        if ($fieldsBuilder instanceof FieldsBuilderEnumInterface) {
            $enumCases = $fieldsBuilder->getEnumFields($operation->getClass());
        } else {
            @trigger_error(sprintf('api_platform.graphql.fields_builder service implementing "%s" is deprecated since API Platform 3.1. It has to implement "%s" instead.', FieldsBuilderInterface::class, FieldsBuilderEnumInterface::class), \E_USER_DEPRECATED);
        }

        $enumConfig = [
            'name' => $enumName,
            'values' => $enumCases,
        ];
        if ($enumDescription = $operation->getDescription()) {
            $enumConfig['description'] = $enumDescription;
        }

        $enumType = new EnumType($enumConfig);
        $this->typesContainer->set($enumName, $enumType);

        return $enumType;
    }

    /**
     * {@inheritdoc}
     */
    public function isCollection(Type $type): bool
    {
        return $type->isCollection() && ($collectionValueType = $type->getCollectionValueTypes()[0] ?? null) && null !== $collectionValueType->getClassName();
    }

    private function getCursorBasedPaginationFields(GraphQLType $resourceType): array
    {
        $namedType = GraphQLType::getNamedType($resourceType);
        // graphql-php 15: name() exists
        $shortName = method_exists($namedType, 'name') ? $namedType->name() : $namedType->name;

        $edgeObjectTypeConfiguration = [
            'name' => "{$shortName}Edge",
            'description' => "Edge of $shortName.",
            'fields' => [
                'node' => $resourceType,
                'cursor' => GraphQLType::nonNull(GraphQLType::string()),
            ],
        ];
        $edgeObjectType = new ObjectType($edgeObjectTypeConfiguration);
        $this->typesContainer->set("{$shortName}Edge", $edgeObjectType);

        $pageInfoObjectTypeConfiguration = [
            'name' => "{$shortName}PageInfo",
            'description' => 'Information about the current page.',
            'fields' => [
                'endCursor' => GraphQLType::string(),
                'startCursor' => GraphQLType::string(),
                'hasNextPage' => GraphQLType::nonNull(GraphQLType::boolean()),
                'hasPreviousPage' => GraphQLType::nonNull(GraphQLType::boolean()),
            ],
        ];
        $pageInfoObjectType = new ObjectType($pageInfoObjectTypeConfiguration);
        $this->typesContainer->set("{$shortName}PageInfo", $pageInfoObjectType);

        return [
            'edges' => GraphQLType::listOf($edgeObjectType),
            'pageInfo' => GraphQLType::nonNull($pageInfoObjectType),
            'totalCount' => GraphQLType::nonNull(GraphQLType::int()),
        ];
    }

    private function getPageBasedPaginationFields(GraphQLType $resourceType): array
    {
        $namedType = GraphQLType::getNamedType($resourceType);
        // graphql-php 15: name() exists
        $shortName = method_exists($namedType, 'name') ? $namedType->name() : $namedType->name;

        $paginationInfoObjectTypeConfiguration = [
            'name' => "{$shortName}PaginationInfo",
            'description' => 'Information about the pagination.',
            'fields' => [
                'itemsPerPage' => GraphQLType::nonNull(GraphQLType::int()),
                'lastPage' => GraphQLType::nonNull(GraphQLType::int()),
                'totalCount' => GraphQLType::nonNull(GraphQLType::int()),
                'hasNextPage' => GraphQLType::nonNull(GraphQLType::boolean()),
            ],
        ];
        $paginationInfoObjectType = new ObjectType($paginationInfoObjectTypeConfiguration);
        $this->typesContainer->set("{$shortName}PaginationInfo", $paginationInfoObjectType);

        return [
            'collection' => GraphQLType::listOf($resourceType),
            'paginationInfo' => GraphQLType::nonNull($paginationInfoObjectType),
        ];
    }

    private function getQueryOperation(ResourceMetadataCollection $resourceMetadataCollection): ?Operation
    {
        foreach ($resourceMetadataCollection as $resourceMetadata) {
            foreach ($resourceMetadata->getGraphQlOperations() as $operation) {
                // Filter the custom queries.
                if ($operation instanceof Query && !$operation->getResolver()) {
                    return $operation;
                }
            }
        }

        return 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\GraphQl\Type;
15
16	use ApiPlatform\GraphQl\Serializer\ItemNormalizer;
17	use ApiPlatform\Metadata\CollectionOperationInterface;
18	use ApiPlatform\Metadata\Exception\OperationNotFoundException;
19	use ApiPlatform\Metadata\GraphQl\Mutation;
20	use ApiPlatform\Metadata\GraphQl\Operation;
21	use ApiPlatform\Metadata\GraphQl\Query;
22	use ApiPlatform\Metadata\GraphQl\Subscription;
23	use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
24	use ApiPlatform\State\Pagination\Pagination;
25	use GraphQL\Type\Definition\EnumType;
26	use GraphQL\Type\Definition\InputObjectType;
27	use GraphQL\Type\Definition\InterfaceType;
28	use GraphQL\Type\Definition\NonNull;
29	use GraphQL\Type\Definition\ObjectType;
30	use GraphQL\Type\Definition\Type as GraphQLType;
31	use Psr\Container\ContainerInterface;
32	use Symfony\Component\PropertyInfo\Type;
33
34	/**
35	* Builds the GraphQL types.
36	*
37	* @author Alan Poulain <contact@alanpoulain.eu>
38	*/
39	final class TypeBuilder implements TypeBuilderInterface, TypeBuilderEnumInterface
40	{
41	private $defaultFieldResolver;
42
43	public function __construct(private readonly TypesContainerInterface $typesContainer, callable $defaultFieldResolver, private readonly ContainerInterface $fieldsBuilderLocator, private readonly Pagination $pagination)
44	{
45	$this->defaultFieldResolver = $defaultFieldResolver;	×
46	}
47
48	/**
49	* {@inheritdoc}
50	*/
51	public function getResourceObjectType(?string $resourceClass, ResourceMetadataCollection $resourceMetadataCollection, Operation $operation, bool $input, bool $wrapped = false, int $depth = 0): GraphQLType
52	{
53	$shortName = $operation->getShortName();	×
54	$operationName = $operation->getName();	×
55
56	if ($operation instanceof Mutation) {	×
57	$shortName = $operationName.ucfirst($shortName);	×
58	}
59
60	if ($operation instanceof Subscription) {	×
61	$shortName = $operationName.ucfirst($shortName).'Subscription';	×
62	}
63
64	if ($input) {	×
65	if ($depth > 0) {	×
66	$shortName .= 'Nested';	×
67	}
68	$shortName .= 'Input';	×
69	} elseif ($operation instanceof Mutation \|\| $operation instanceof Subscription) {	×
70	if ($depth > 0) {	×
71	$shortName .= 'Nested';	×
72	}
73	$shortName .= 'Payload';	×
74	}
75
76	if ('item_query' === $operationName \|\| 'collection_query' === $operationName) {	×
77	// Test if the collection/item has different groups
78	if ($resourceMetadataCollection->getOperation($operation instanceof CollectionOperationInterface ? 'item_query' : 'collection_query')->getNormalizationContext() !== $operation->getNormalizationContext()) {	×
79	$shortName .= $operation instanceof CollectionOperationInterface ? 'Collection' : 'Item';	×
80	}
81	}
82
83	if ($wrapped && ($operation instanceof Mutation \|\| $operation instanceof Subscription)) {	×
84	$shortName .= 'Data';	×
85	}
86
87	if ($this->typesContainer->has($shortName)) {	×
88	$resourceObjectType = $this->typesContainer->get($shortName);	×
89	if (!($resourceObjectType instanceof ObjectType \|\| $resourceObjectType instanceof NonNull)) {	×
90	throw new \LogicException(sprintf('Expected GraphQL type "%s" to be %s.', $shortName, implode('\|', [ObjectType::class, NonNull::class])));	×
91	}
92
93	return $resourceObjectType;	×
94	}
95
96	$ioMetadata = $input ? $operation->getInput() : $operation->getOutput();	×
97	if (null !== $ioMetadata && \array_key_exists('class', $ioMetadata) && null !== $ioMetadata['class']) {	×
98	$resourceClass = $ioMetadata['class'];	×
99	}
100
101	$wrapData = !$wrapped && ($operation instanceof Mutation \|\| $operation instanceof Subscription) && !$input && $depth < 1;	×
102
103	$configuration = [	×
104	'name' => $shortName,	×
105	'description' => $operation->getDescription(),	×
106	'resolveField' => $this->defaultFieldResolver,	×
107	'fields' => function () use ($resourceClass, $operation, $operationName, $resourceMetadataCollection, $input, $wrapData, $depth, $ioMetadata) {	×
108	if ($wrapData) {	×
109	$queryNormalizationContext = $this->getQueryOperation($resourceMetadataCollection)?->getNormalizationContext() ?? [];	×
110
111	try {
112	$mutationNormalizationContext = $operation instanceof Mutation \|\| $operation instanceof Subscription ? ($resourceMetadataCollection->getOperation($operationName)->getNormalizationContext() ?? []) : [];	×
113	} catch (OperationNotFoundException) {	×
114	$mutationNormalizationContext = [];	×
115	}
116	// Use a new type for the wrapped object only if there is a specific normalization context for the mutation or the subscription.
117	// If not, use the query type in order to ensure the client cache could be used.
118	$useWrappedType = $queryNormalizationContext !== $mutationNormalizationContext;	×
119
120	$wrappedOperationName = $operationName;	×
121
122	if (!$useWrappedType) {	×
123	$wrappedOperationName = $operation instanceof Query ? $operationName : 'item_query';	×
124	}
125
126	$wrappedOperation = $resourceMetadataCollection->getOperation($wrappedOperationName);	×
127
128	$fields = [	×
129	lcfirst($wrappedOperation->getShortName()) => $this->getResourceObjectType($resourceClass, $resourceMetadataCollection, $wrappedOperation instanceof Operation ? $wrappedOperation : null, $input, true, $depth),	×
130	];	×
131
132	if ($operation instanceof Subscription) {	×
133	$fields['clientSubscriptionId'] = GraphQLType::string();	×
134	if ($operation->getMercure()) {	×
135	$fields['mercureUrl'] = GraphQLType::string();	×
136	}
137
138	return $fields;	×
139	}
140
141	return $fields + ['clientMutationId' => GraphQLType::string()];	×
142	}
143
144	$fieldsBuilder = $this->fieldsBuilderLocator->get('api_platform.graphql.fields_builder');	×
145	$fields = $fieldsBuilder->getResourceObjectTypeFields($resourceClass, $operation, $input, $depth, $ioMetadata);	×
146
147	if ($input && $operation instanceof Mutation && null !== $mutationArgs = $operation->getArgs()) {	×
148	return $fieldsBuilder->resolveResourceArgs($mutationArgs, $operation) + ['clientMutationId' => $fields['clientMutationId']];	×
149	}
150	if ($input && $operation instanceof Mutation && null !== $extraMutationArgs = $operation->getExtraArgs()) {	×
151	return $fields + $fieldsBuilder->resolveResourceArgs($extraMutationArgs, $operation);	×
152	}
153
154	return $fields;	×
155	},	×
156	'interfaces' => $wrapData ? [] : [$this->getNodeInterface()],	×
157	];	×
158
159	$resourceObjectType = $input ? GraphQLType::nonNull(new InputObjectType($configuration)) : new ObjectType($configuration);	×
160	$this->typesContainer->set($shortName, $resourceObjectType);	×
161
162	return $resourceObjectType;	×
163	}
164
165	/**
166	* {@inheritdoc}
167	*/
168	public function getNodeInterface(): InterfaceType
169	{
170	if ($this->typesContainer->has('Node')) {	×
171	$nodeInterface = $this->typesContainer->get('Node');	×
172	if (!$nodeInterface instanceof InterfaceType) {	×
173	throw new \LogicException(sprintf('Expected GraphQL type "Node" to be %s.', InterfaceType::class));	×
174	}
175
176	return $nodeInterface;	×
177	}
178
179	$nodeInterface = new InterfaceType([	×
180	'name' => 'Node',	×
181	'description' => 'A node, according to the Relay specification.',	×
182	'fields' => [	×
183	'id' => [	×
184	'type' => GraphQLType::nonNull(GraphQLType::id()),	×
185	'description' => 'The id of this node.',	×
186	],	×
187	],	×
188	'resolveType' => function ($value): ?GraphQLType {	×
189	if (!isset($value[ItemNormalizer::ITEM_RESOURCE_CLASS_KEY])) {	×
190	return null;	×
191	}
192
193	$shortName = (new \ReflectionClass($value[ItemNormalizer::ITEM_RESOURCE_CLASS_KEY]))->getShortName();	×
194
195	return $this->typesContainer->has($shortName) ? $this->typesContainer->get($shortName) : null;	×
196	},	×
197	]);	×
198
199	$this->typesContainer->set('Node', $nodeInterface);	×
200
201	return $nodeInterface;	×
202	}
203
204	/**
205	* {@inheritdoc}
206	*/
207	public function getResourcePaginatedCollectionType(GraphQLType $resourceType, string $resourceClass, Operation $operation): GraphQLType
208	{
209	@trigger_error('Using getResourcePaginatedCollectionType method of TypeBuilder is deprecated since API Platform 3.1. Use getPaginatedCollectionType method instead.', \E_USER_DEPRECATED);	×
210
211	return $this->getPaginatedCollectionType($resourceType, $operation);	×
212	}
213
214	/**
215	* {@inheritdoc}
216	*/
217	public function getPaginatedCollectionType(GraphQLType $resourceType, Operation $operation): GraphQLType
218	{
219	$namedType = GraphQLType::getNamedType($resourceType);	×
220	// graphql-php 15: name() exists
221	$shortName = method_exists($namedType, 'name') ? $namedType->name() : $namedType->name;	×
222	$paginationType = $this->pagination->getGraphQlPaginationType($operation);	×
223
224	$connectionTypeKey = sprintf('%s%sConnection', $shortName, ucfirst($paginationType));	×
225	if ($this->typesContainer->has($connectionTypeKey)) {	×
226	return $this->typesContainer->get($connectionTypeKey);	×
227	}
228
229	$fields = 'cursor' === $paginationType ?	×
230	$this->getCursorBasedPaginationFields($resourceType) :	×
231	$this->getPageBasedPaginationFields($resourceType);	×
232
233	$configuration = [	×
234	'name' => $connectionTypeKey,	×
235	'description' => sprintf("%s connection for $shortName.", ucfirst($paginationType)),	×
236	'fields' => $fields,	×
237	];	×
238
239	$resourcePaginatedCollectionType = new ObjectType($configuration);	×
240	$this->typesContainer->set($connectionTypeKey, $resourcePaginatedCollectionType);	×
241
242	return $resourcePaginatedCollectionType;	×
243	}
244
245	public function getEnumType(Operation $operation): GraphQLType
246	{
247	$enumName = $operation->getShortName();	×
248
249	if ($this->typesContainer->has($enumName)) {	×
250	return $this->typesContainer->get($enumName);	×
251	}
252
253	/** @var FieldsBuilderEnumInterface\|FieldsBuilderInterface $fieldsBuilder */
254	$fieldsBuilder = $this->fieldsBuilderLocator->get('api_platform.graphql.fields_builder');	×
255	$enumCases = [];	×
256	// Remove the condition in API Platform 4.
257	if ($fieldsBuilder instanceof FieldsBuilderEnumInterface) {	×
258	$enumCases = $fieldsBuilder->getEnumFields($operation->getClass());	×
259	} else {
260	@trigger_error(sprintf('api_platform.graphql.fields_builder service implementing "%s" is deprecated since API Platform 3.1. It has to implement "%s" instead.', FieldsBuilderInterface::class, FieldsBuilderEnumInterface::class), \E_USER_DEPRECATED);	×
261	}
262
263	$enumConfig = [	×
264	'name' => $enumName,	×
265	'values' => $enumCases,	×
266	];	×
267	if ($enumDescription = $operation->getDescription()) {	×
268	$enumConfig['description'] = $enumDescription;	×
269	}
270
271	$enumType = new EnumType($enumConfig);	×
272	$this->typesContainer->set($enumName, $enumType);	×
273
274	return $enumType;	×
275	}
276
277	/**
278	* {@inheritdoc}
279	*/
280	public function isCollection(Type $type): bool
281	{
282	return $type->isCollection() && ($collectionValueType = $type->getCollectionValueTypes()[0] ?? null) && null !== $collectionValueType->getClassName();	×
283	}
284
285	private function getCursorBasedPaginationFields(GraphQLType $resourceType): array
286	{
287	$namedType = GraphQLType::getNamedType($resourceType);	×
288	// graphql-php 15: name() exists
289	$shortName = method_exists($namedType, 'name') ? $namedType->name() : $namedType->name;	×
290
291	$edgeObjectTypeConfiguration = [	×
292	'name' => "{$shortName}Edge",	×
293	'description' => "Edge of $shortName.",	×
294	'fields' => [	×
295	'node' => $resourceType,	×
296	'cursor' => GraphQLType::nonNull(GraphQLType::string()),	×
297	],	×
298	];	×
299	$edgeObjectType = new ObjectType($edgeObjectTypeConfiguration);	×
300	$this->typesContainer->set("{$shortName}Edge", $edgeObjectType);	×
301
302	$pageInfoObjectTypeConfiguration = [	×
303	'name' => "{$shortName}PageInfo",	×
304	'description' => 'Information about the current page.',	×
305	'fields' => [	×
306	'endCursor' => GraphQLType::string(),	×
307	'startCursor' => GraphQLType::string(),	×
308	'hasNextPage' => GraphQLType::nonNull(GraphQLType::boolean()),	×
309	'hasPreviousPage' => GraphQLType::nonNull(GraphQLType::boolean()),	×
310	],	×
311	];	×
312	$pageInfoObjectType = new ObjectType($pageInfoObjectTypeConfiguration);	×
313	$this->typesContainer->set("{$shortName}PageInfo", $pageInfoObjectType);	×
314
315	return [	×
316	'edges' => GraphQLType::listOf($edgeObjectType),	×
317	'pageInfo' => GraphQLType::nonNull($pageInfoObjectType),	×
318	'totalCount' => GraphQLType::nonNull(GraphQLType::int()),	×
319	];	×
320	}
321
322	private function getPageBasedPaginationFields(GraphQLType $resourceType): array
323	{
324	$namedType = GraphQLType::getNamedType($resourceType);	×
325	// graphql-php 15: name() exists
326	$shortName = method_exists($namedType, 'name') ? $namedType->name() : $namedType->name;	×
327
328	$paginationInfoObjectTypeConfiguration = [	×
329	'name' => "{$shortName}PaginationInfo",	×
330	'description' => 'Information about the pagination.',	×
331	'fields' => [	×
332	'itemsPerPage' => GraphQLType::nonNull(GraphQLType::int()),	×
333	'lastPage' => GraphQLType::nonNull(GraphQLType::int()),	×
334	'totalCount' => GraphQLType::nonNull(GraphQLType::int()),	×
NEW 335	'hasNextPage' => GraphQLType::nonNull(GraphQLType::boolean()),	×
336	],	×
337	];	×
338	$paginationInfoObjectType = new ObjectType($paginationInfoObjectTypeConfiguration);	×
339	$this->typesContainer->set("{$shortName}PaginationInfo", $paginationInfoObjectType);	×
340
341	return [	×
342	'collection' => GraphQLType::listOf($resourceType),	×
343	'paginationInfo' => GraphQLType::nonNull($paginationInfoObjectType),	×
344	];	×
345	}
346
347	private function getQueryOperation(ResourceMetadataCollection $resourceMetadataCollection): ?Operation
348	{
349	foreach ($resourceMetadataCollection as $resourceMetadata) {	×
350	foreach ($resourceMetadata->getGraphQlOperations() as $operation) {	×
351	// Filter the custom queries.
352	if ($operation instanceof Query && !$operation->getResolver()) {	×
353	return $operation;	×
354	}
355	}
356	}
357
358	return null;	×
359	}
360	}

api-platform / core / 7970375011

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