#27933

pending completion

Build # #27933

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/6467689a4b773bd73f9e0a7584c3c01ba3a33182">6467689a4<a href="https://github.com/api-platform/core/commit/6467689a4b773bd73f9e0a7584c3c01ba3a33182">">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/f2966469ac85a3e5d7dc361ba98d8fbac0f5ab02">f2966469a</a>">f2966469a</a><a href="https://github.com/api-platform/core/commit/6467689a4b773bd73f9e0a7584c3c01ba3a33182"> into 9aeaa5eb3">9aeaa5eb3</a>

Run Details

13530 of 16954 relevant lines covered (79.8%)

14.82 hits per line

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

89.61

/src/GraphQl/Type/TypeConverter.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\Exception\InvalidArgumentException;
use ApiPlatform\Exception\OperationNotFoundException;
use ApiPlatform\Exception\ResourceClassNotFoundException;
use ApiPlatform\Metadata\GraphQl\Operation;
use ApiPlatform\Metadata\GraphQl\Query;
use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use GraphQL\Error\SyntaxError;
use GraphQL\Language\AST\ListTypeNode;
use GraphQL\Language\AST\NamedTypeNode;
use GraphQL\Language\AST\NonNullTypeNode;
use GraphQL\Language\AST\TypeNode;
use GraphQL\Language\Parser;
use GraphQL\Type\Definition\NullableType;
use GraphQL\Type\Definition\Type as GraphQLType;
use Symfony\Component\PropertyInfo\Type;

/**
 * Converts a type to its GraphQL equivalent.
 *
 * @author Alan Poulain <contact@alanpoulain.eu>
 */
final class TypeConverter implements TypeConverterInterface
{
    private $typeBuilder;
    private $typesContainer;
    private $resourceMetadataCollectionFactory;
    private $propertyMetadataFactory;

    public function __construct(TypeBuilderInterface $typeBuilder, TypesContainerInterface $typesContainer, ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory = null)
    {
        $this->typeBuilder = $typeBuilder;
        $this->typesContainer = $typesContainer;
        $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
        $this->propertyMetadataFactory = $propertyMetadataFactory;

        if (null === $this->propertyMetadataFactory) {
            @trigger_error(sprintf('Not injecting %s in the TypeConverter is deprecated since 2.7 and will not be supported in 3.0.', PropertyMetadataFactoryInterface::class), \E_USER_DEPRECATED);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function convertType(Type $type, bool $input, Operation $rootOperation, string $resourceClass, string $rootResource, ?string $property, int $depth)
    {
        switch ($type->getBuiltinType()) {
            case Type::BUILTIN_TYPE_BOOL:
                return GraphQLType::boolean();
            case Type::BUILTIN_TYPE_INT:
                return GraphQLType::int();
            case Type::BUILTIN_TYPE_FLOAT:
                return GraphQLType::float();
            case Type::BUILTIN_TYPE_STRING:
                return GraphQLType::string();
            case Type::BUILTIN_TYPE_ARRAY:
            case Type::BUILTIN_TYPE_ITERABLE:
                if ($resourceType = $this->getResourceType($type, $input, $rootOperation, $rootResource, $property, $depth)) {
                    return $resourceType;
                }

                return 'Iterable';
            case Type::BUILTIN_TYPE_OBJECT:
                if (is_a($type->getClassName(), \DateTimeInterface::class, true)) {
                    return GraphQLType::string();
                }

                return $this->getResourceType($type, $input, $rootOperation, $rootResource, $property, $depth);
            default:
                return null;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function resolveType(string $type): ?GraphQLType
    {
        try {
            $astTypeNode = Parser::parseType($type);
        } catch (SyntaxError $e) {
            throw new InvalidArgumentException(sprintf('"%s" is not a valid GraphQL type.', $type), 0, $e);
        }

        if ($graphQlType = $this->resolveAstTypeNode($astTypeNode, $type)) {
            return $graphQlType;
        }

        throw new InvalidArgumentException(sprintf('The type "%s" was not resolved.', $type));
    }

    private function getResourceType(Type $type, bool $input, Operation $rootOperation, string $rootResource, ?string $property, int $depth): ?GraphQLType
    {
        if (
            $this->typeBuilder->isCollection($type) &&
            $collectionValueType = method_exists(Type::class, 'getCollectionValueTypes') ? ($type->getCollectionValueTypes()[0] ?? null) : $type->getCollectionValueType()
        ) {
            $resourceClass = $collectionValueType->getClassName();
        } else {
            $resourceClass = $type->getClassName();
        }

        if (null === $resourceClass) {
            return null;
        }

        try {
            $resourceMetadataCollection = $this->resourceMetadataCollectionFactory->create($resourceClass);
        } catch (ResourceClassNotFoundException $e) {
            return null;
        }

        $hasGraphQl = false;
        foreach ($resourceMetadataCollection as $resourceMetadata) {
            if (null !== $resourceMetadata->getGraphQlOperations()) {
                $hasGraphQl = true;
                break;
            }
        }

        if (isset($resourceMetadataCollection[0]) && 'Node' === $resourceMetadataCollection[0]->getShortName()) {
            throw new \UnexpectedValueException('A "Node" resource cannot be used with GraphQL because the type is already used by the Relay specification.');
        }

        if (!$hasGraphQl) {
            return null;
        }

        $propertyMetadata = null;
        if ($property && $this->propertyMetadataFactory) {
            $context = [
                'normalization_groups' => $rootOperation->getNormalizationContext()['groups'] ?? null,
                'denormalization_groups' => $rootOperation->getDenormalizationContext()['groups'] ?? null,
            ];
            $propertyMetadata = $this->propertyMetadataFactory->create($rootResource, $property, $context);
        }

        if ($input && $depth > 0 && (!$propertyMetadata || !$propertyMetadata->isWritableLink())) {
            return GraphQLType::string();
        }

        try {
            $operation = $resourceMetadataCollection->getGraphQlOperation($rootOperation->getName());
        } catch (OperationNotFoundException $e) {
            $operation = (new Query())
                ->withResource($resourceMetadataCollection[0])
                ->withName($rootOperation->getName())
                ->withCollection('collection_query' === $rootOperation->getName());
        }

        return $this->typeBuilder->getResourceObjectType($resourceClass, $resourceMetadataCollection, $operation, $input, false, $depth);
    }

    private function resolveAstTypeNode(TypeNode $astTypeNode, string $fromType): ?GraphQLType
    {
        if ($astTypeNode instanceof NonNullTypeNode) {
            /** @var NullableType|null $nullableAstTypeNode */
            $nullableAstTypeNode = $this->resolveNullableAstTypeNode($astTypeNode->type, $fromType);

            return $nullableAstTypeNode ? GraphQLType::nonNull($nullableAstTypeNode) : null;
        }

        return $this->resolveNullableAstTypeNode($astTypeNode, $fromType);
    }

    private function resolveNullableAstTypeNode(TypeNode $astTypeNode, string $fromType): ?GraphQLType
    {
        if ($astTypeNode instanceof ListTypeNode) {
            /** @var TypeNode $astTypeNodeElement */
            $astTypeNodeElement = $astTypeNode->type;

            return GraphQLType::listOf($this->resolveAstTypeNode($astTypeNodeElement, $fromType));
        }

        if (!$astTypeNode instanceof NamedTypeNode) {
            return null;
        }

        $typeName = $astTypeNode->name->value;

        switch ($typeName) {
            case GraphQLType::STRING:
                return GraphQLType::string();
            case GraphQLType::INT:
                return GraphQLType::int();
            case GraphQLType::BOOLEAN:
                return GraphQLType::boolean();
            case GraphQLType::FLOAT:
                return GraphQLType::float();
            case GraphQLType::ID:
                return GraphQLType::id();
            default:
                if ($this->typesContainer->has($typeName)) {
                    return $this->typesContainer->get($typeName);
                }

                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\Exception\InvalidArgumentException;
17	use ApiPlatform\Exception\OperationNotFoundException;
18	use ApiPlatform\Exception\ResourceClassNotFoundException;
19	use ApiPlatform\Metadata\GraphQl\Operation;
20	use ApiPlatform\Metadata\GraphQl\Query;
21	use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
22	use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
23	use GraphQL\Error\SyntaxError;
24	use GraphQL\Language\AST\ListTypeNode;
25	use GraphQL\Language\AST\NamedTypeNode;
26	use GraphQL\Language\AST\NonNullTypeNode;
27	use GraphQL\Language\AST\TypeNode;
28	use GraphQL\Language\Parser;
29	use GraphQL\Type\Definition\NullableType;
30	use GraphQL\Type\Definition\Type as GraphQLType;
31	use Symfony\Component\PropertyInfo\Type;
32
33	/**
34	* Converts a type to its GraphQL equivalent.
35	*
36	* @author Alan Poulain <contact@alanpoulain.eu>
37	*/
38	final class TypeConverter implements TypeConverterInterface
39	{
40	private $typeBuilder;
41	private $typesContainer;
42	private $resourceMetadataCollectionFactory;
43	private $propertyMetadataFactory;
44
45	public function __construct(TypeBuilderInterface $typeBuilder, TypesContainerInterface $typesContainer, ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory = null)
46	{
47	$this->typeBuilder = $typeBuilder;	31✔
48	$this->typesContainer = $typesContainer;	31✔
49	$this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;	31✔
50	$this->propertyMetadataFactory = $propertyMetadataFactory;	31✔
51
52	if (null === $this->propertyMetadataFactory) {	31✔
53	@trigger_error(sprintf('Not injecting %s in the TypeConverter is deprecated since 2.7 and will not be supported in 3.0.', PropertyMetadataFactoryInterface::class), \E_USER_DEPRECATED);	×
54	}
55	}	31✔
56
57	/**
58	* {@inheritdoc}
59	*/
60	public function convertType(Type $type, bool $input, Operation $rootOperation, string $resourceClass, string $rootResource, ?string $property, int $depth)
61	{
62	switch ($type->getBuiltinType()) {	18✔
63	case Type::BUILTIN_TYPE_BOOL:
64	return GraphQLType::boolean();	1✔
65	case Type::BUILTIN_TYPE_INT:
66	return GraphQLType::int();	1✔
67	case Type::BUILTIN_TYPE_FLOAT:
68	return GraphQLType::float();	1✔
69	case Type::BUILTIN_TYPE_STRING:
70	return GraphQLType::string();	1✔
71	case Type::BUILTIN_TYPE_ARRAY:
72	case Type::BUILTIN_TYPE_ITERABLE:
73	if ($resourceType = $this->getResourceType($type, $input, $rootOperation, $rootResource, $property, $depth)) {	3✔
74	return $resourceType;	1✔
75	}
76
77	return 'Iterable';	2✔
78	case Type::BUILTIN_TYPE_OBJECT:
79	if (is_a($type->getClassName(), \DateTimeInterface::class, true)) {	8✔
80	return GraphQLType::string();	1✔
81	}
82
83	return $this->getResourceType($type, $input, $rootOperation, $rootResource, $property, $depth);	7✔
84	default:
85	return null;	3✔
86	}
87	}
88
89	/**
90	* {@inheritdoc}
91	*/
92	public function resolveType(string $type): ?GraphQLType
93	{
94	try {
95	$astTypeNode = Parser::parseType($type);	13✔
96	} catch (SyntaxError $e) {	1✔
97	throw new InvalidArgumentException(sprintf('"%s" is not a valid GraphQL type.', $type), 0, $e);	1✔
98	}
99
100	if ($graphQlType = $this->resolveAstTypeNode($astTypeNode, $type)) {	12✔
101	return $graphQlType;	10✔
102	}
103
104	throw new InvalidArgumentException(sprintf('The type "%s" was not resolved.', $type));	2✔
105	}
106
107	private function getResourceType(Type $type, bool $input, Operation $rootOperation, string $rootResource, ?string $property, int $depth): ?GraphQLType
108	{
109	if (
110	$this->typeBuilder->isCollection($type) &&	10✔
111	$collectionValueType = method_exists(Type::class, 'getCollectionValueTypes') ? ($type->getCollectionValueTypes()[0] ?? null) : $type->getCollectionValueType()	10✔
112	) {
113	$resourceClass = $collectionValueType->getClassName();	2✔
114	} else {
115	$resourceClass = $type->getClassName();	8✔
116	}
117
118	if (null === $resourceClass) {	10✔
119	return null;	3✔
120	}
121
122	try {
123	$resourceMetadataCollection = $this->resourceMetadataCollectionFactory->create($resourceClass);	7✔
124	} catch (ResourceClassNotFoundException $e) {	1✔
125	return null;	1✔
126	}
127
128	$hasGraphQl = false;	6✔
129	foreach ($resourceMetadataCollection as $resourceMetadata) {	6✔
130	if (null !== $resourceMetadata->getGraphQlOperations()) {	6✔
131	$hasGraphQl = true;	5✔
132	break;	5✔
133	}
134	}
135
136	if (isset($resourceMetadataCollection[0]) && 'Node' === $resourceMetadataCollection[0]->getShortName()) {	6✔
137	throw new \UnexpectedValueException('A "Node" resource cannot be used with GraphQL because the type is already used by the Relay specification.');	1✔
138	}
139
140	if (!$hasGraphQl) {	5✔
141	return null;	1✔
142	}
143
144	$propertyMetadata = null;	4✔
145	if ($property && $this->propertyMetadataFactory) {	4✔
146	$context = [	2✔
147	'normalization_groups' => $rootOperation->getNormalizationContext()['groups'] ?? null,	2✔
148	'denormalization_groups' => $rootOperation->getDenormalizationContext()['groups'] ?? null,	2✔
149	];
150	$propertyMetadata = $this->propertyMetadataFactory->create($rootResource, $property, $context);	2✔
151	}
152
153	if ($input && $depth > 0 && (!$propertyMetadata \|\| !$propertyMetadata->isWritableLink())) {	4✔
154	return GraphQLType::string();	1✔
155	}
156
157	try {
158	$operation = $resourceMetadataCollection->getGraphQlOperation($rootOperation->getName());	3✔
159	} catch (OperationNotFoundException $e) {	×
160	$operation = (new Query())	×
161	->withResource($resourceMetadataCollection[0])	×
162	->withName($rootOperation->getName())	×
163	->withCollection('collection_query' === $rootOperation->getName());	×
164	}
165
166	return $this->typeBuilder->getResourceObjectType($resourceClass, $resourceMetadataCollection, $operation, $input, false, $depth);	3✔
167	}
168
169	private function resolveAstTypeNode(TypeNode $astTypeNode, string $fromType): ?GraphQLType
170	{
171	if ($astTypeNode instanceof NonNullTypeNode) {	12✔
172	/** @var NullableType\|null $nullableAstTypeNode */
173	$nullableAstTypeNode = $this->resolveNullableAstTypeNode($astTypeNode->type, $fromType);	6✔
174
175	return $nullableAstTypeNode ? GraphQLType::nonNull($nullableAstTypeNode) : null;	6✔
176	}
177
178	return $this->resolveNullableAstTypeNode($astTypeNode, $fromType);	8✔
179	}
180
181	private function resolveNullableAstTypeNode(TypeNode $astTypeNode, string $fromType): ?GraphQLType
182	{
183	if ($astTypeNode instanceof ListTypeNode) {	12✔
184	/** @var TypeNode $astTypeNodeElement */
185	$astTypeNodeElement = $astTypeNode->type;	4✔
186
187	return GraphQLType::listOf($this->resolveAstTypeNode($astTypeNodeElement, $fromType));	4✔
188	}
189
190	if (!$astTypeNode instanceof NamedTypeNode) {	12✔
191	return null;	×
192	}
193
194	$typeName = $astTypeNode->name->value;	12✔
195
196	switch ($typeName) {	12✔
197	case GraphQLType::STRING:
198	return GraphQLType::string();	2✔
199	case GraphQLType::INT:
200	return GraphQLType::int();	2✔
201	case GraphQLType::BOOLEAN:
202	return GraphQLType::boolean();	2✔
203	case GraphQLType::FLOAT:
204	return GraphQLType::float();	2✔
205	case GraphQLType::ID:
206	return GraphQLType::id();	×
207	default:
208	if ($this->typesContainer->has($typeName)) {	4✔
209	return $this->typesContainer->get($typeName);	2✔
210	}
211
212	return null;	2✔
213	}
214	}
215	}

api-platform / core / #27933

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