We could not synchronize checks via GitHub's checks API since Scrutinizer's GitHub App is not installed for this repository.
Total Complexity | 171 |
Total Lines | 938 |
Duplicated Lines | 0 % |
Changes | 2 | ||
Bugs | 0 | Features | 0 |
Complex classes like MetadataParser often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use MetadataParser, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
44 | abstract class MetadataParser implements PreParserInterface |
||
45 | { |
||
46 | const ANNOTATION_NAMESPACE = 'Overblog\GraphQLBundle\Annotation\\'; |
||
47 | const METADATA_FORMAT = '%s'; |
||
48 | |||
49 | private static ClassesTypesMap $map; |
||
50 | private static array $typeGuessers = []; |
||
51 | private static array $providers = []; |
||
52 | private static array $reflections = []; |
||
53 | |||
54 | private const GQL_SCALAR = 'scalar'; |
||
55 | private const GQL_ENUM = 'enum'; |
||
56 | private const GQL_TYPE = 'type'; |
||
57 | private const GQL_INPUT = 'input'; |
||
58 | private const GQL_UNION = 'union'; |
||
59 | private const GQL_INTERFACE = 'interface'; |
||
60 | |||
61 | /** |
||
62 | * @see https://facebook.github.io/graphql/draft/#sec-Input-and-Output-Types |
||
63 | */ |
||
64 | private const VALID_INPUT_TYPES = [self::GQL_SCALAR, self::GQL_ENUM, self::GQL_INPUT]; |
||
65 | private const VALID_OUTPUT_TYPES = [self::GQL_SCALAR, self::GQL_TYPE, self::GQL_INTERFACE, self::GQL_UNION, self::GQL_ENUM]; |
||
66 | |||
67 | /** |
||
68 | * {@inheritdoc} |
||
69 | * |
||
70 | * @throws InvalidArgumentException |
||
71 | * @throws ReflectionException |
||
72 | */ |
||
73 | public static function preParse(SplFileInfo $file, ContainerBuilder $container, array $configs = []): void |
||
76 | } |
||
77 | |||
78 | /** |
||
79 | * @throws InvalidArgumentException |
||
80 | * @throws ReflectionException |
||
81 | */ |
||
82 | public static function parse(SplFileInfo $file, ContainerBuilder $container, array $configs = []): array |
||
83 | { |
||
84 | return self::processFile($file, $container, $configs, false); |
||
85 | } |
||
86 | |||
87 | /** |
||
88 | * @internal |
||
89 | */ |
||
90 | public static function reset(array $configs): void |
||
100 | } |
||
101 | |||
102 | /** |
||
103 | * Process a file. |
||
104 | * |
||
105 | * @throws InvalidArgumentException|ReflectionException|AnnotationException |
||
106 | */ |
||
107 | private static function processFile(SplFileInfo $file, ContainerBuilder $container, array $configs, bool $preProcess): array |
||
136 | } |
||
137 | } |
||
138 | |||
139 | /** |
||
140 | * @return array<string,array> |
||
141 | */ |
||
142 | private static function classMetadatasToGQLConfiguration( |
||
143 | ReflectionClass $reflectionClass, |
||
144 | Meta $classMetadata, |
||
145 | array $configs, |
||
146 | array $gqlTypes, |
||
147 | bool $preProcess |
||
148 | ): array { |
||
149 | $gqlConfiguration = $gqlType = $gqlName = null; |
||
150 | |||
151 | switch (true) { |
||
152 | case $classMetadata instanceof Metadata\Type: |
||
153 | $gqlType = self::GQL_TYPE; |
||
154 | $gqlName = $classMetadata->name ?? $reflectionClass->getShortName(); |
||
155 | if (!$preProcess) { |
||
156 | $gqlConfiguration = self::typeMetadataToGQLConfiguration($reflectionClass, $classMetadata, $gqlName, $configs); |
||
157 | |||
158 | if ($classMetadata instanceof Metadata\Relay\Connection) { |
||
159 | if (!$reflectionClass->implementsInterface(ConnectionInterface::class)) { |
||
160 | throw new InvalidArgumentException(sprintf('The metadata %s on class "%s" can only be used on class implementing the ConnectionInterface.', self::formatMetadata('Connection'), $reflectionClass->getName())); |
||
161 | } |
||
162 | |||
163 | if (!(isset($classMetadata->edge) xor isset($classMetadata->node))) { |
||
164 | throw new InvalidArgumentException(sprintf('The metadata %s on class "%s" is invalid. You must define either the "edge" OR the "node" attribute, but not both.', self::formatMetadata('Connection'), $reflectionClass->getName())); |
||
165 | } |
||
166 | |||
167 | $edgeType = $classMetadata->edge ?? false; |
||
168 | if (!$edgeType) { |
||
169 | $edgeType = $gqlName.'Edge'; |
||
170 | $gqlTypes[$edgeType] = [ |
||
171 | 'type' => 'object', |
||
172 | 'config' => [ |
||
173 | 'builders' => [ |
||
174 | ['builder' => 'relay-edge', 'builderConfig' => ['nodeType' => $classMetadata->node]], |
||
175 | ], |
||
176 | ], |
||
177 | ]; |
||
178 | } |
||
179 | |||
180 | if (!isset($gqlConfiguration['config']['builders'])) { |
||
181 | $gqlConfiguration['config']['builders'] = []; |
||
182 | } |
||
183 | |||
184 | array_unshift($gqlConfiguration['config']['builders'], ['builder' => 'relay-connection', 'builderConfig' => ['edgeType' => $edgeType]]); |
||
185 | } |
||
186 | } |
||
187 | break; |
||
188 | |||
189 | case $classMetadata instanceof Metadata\Input: |
||
190 | $gqlType = self::GQL_INPUT; |
||
191 | $gqlName = $classMetadata->name ?? self::suffixName($reflectionClass->getShortName(), 'Input'); |
||
192 | if (!$preProcess) { |
||
193 | $gqlConfiguration = self::inputMetadataToGQLConfiguration($reflectionClass, $classMetadata); |
||
194 | } |
||
195 | break; |
||
196 | |||
197 | case $classMetadata instanceof Metadata\Scalar: |
||
198 | $gqlType = self::GQL_SCALAR; |
||
199 | if (!$preProcess) { |
||
200 | $gqlConfiguration = self::scalarMetadataToGQLConfiguration($reflectionClass, $classMetadata); |
||
201 | } |
||
202 | break; |
||
203 | |||
204 | case $classMetadata instanceof Metadata\Enum: |
||
205 | $gqlType = self::GQL_ENUM; |
||
206 | if (!$preProcess) { |
||
207 | $gqlConfiguration = self::enumMetadataToGQLConfiguration($reflectionClass, $classMetadata); |
||
208 | } |
||
209 | break; |
||
210 | |||
211 | case $classMetadata instanceof Metadata\Union: |
||
212 | $gqlType = self::GQL_UNION; |
||
213 | if (!$preProcess) { |
||
214 | $gqlConfiguration = self::unionMetadataToGQLConfiguration($reflectionClass, $classMetadata); |
||
215 | } |
||
216 | break; |
||
217 | |||
218 | case $classMetadata instanceof Metadata\TypeInterface: |
||
219 | $gqlType = self::GQL_INTERFACE; |
||
220 | if (!$preProcess) { |
||
221 | $gqlConfiguration = self::typeInterfaceMetadataToGQLConfiguration($reflectionClass, $classMetadata); |
||
222 | } |
||
223 | break; |
||
224 | |||
225 | case $classMetadata instanceof Metadata\Provider: |
||
226 | if ($preProcess) { |
||
227 | self::$providers[] = ['reflectionClass' => $reflectionClass, 'metadata' => $classMetadata]; |
||
228 | } |
||
229 | |||
230 | return []; |
||
231 | } |
||
232 | |||
233 | if (null !== $gqlType) { |
||
234 | if (!$gqlName) { |
||
235 | $gqlName = isset($classMetadata->name) ? $classMetadata->name : $reflectionClass->getShortName(); |
||
236 | } |
||
237 | |||
238 | if ($preProcess) { |
||
239 | if (self::$map->hasType($gqlName)) { |
||
|
|||
240 | throw new InvalidArgumentException(sprintf('The GraphQL type "%s" has already been registered in class "%s"', $gqlName, self::$map->getType($gqlName)['class'])); |
||
241 | } |
||
242 | self::$map->addClassType($gqlName, $reflectionClass->getName(), $gqlType); |
||
243 | } else { |
||
244 | $gqlTypes = [$gqlName => $gqlConfiguration] + $gqlTypes; |
||
245 | } |
||
246 | } |
||
247 | |||
248 | return $gqlTypes; |
||
249 | } |
||
250 | |||
251 | /** |
||
252 | * @throws ReflectionException |
||
253 | * @phpstan-param class-string $className |
||
254 | */ |
||
255 | private static function getClassReflection(string $className): ReflectionClass |
||
256 | { |
||
257 | self::$reflections[$className] ??= new ReflectionClass($className); |
||
258 | |||
259 | return self::$reflections[$className]; |
||
260 | } |
||
261 | |||
262 | private static function typeMetadataToGQLConfiguration( |
||
263 | ReflectionClass $reflectionClass, |
||
264 | Metadata\Type $classMetadata, |
||
265 | string $gqlName, |
||
266 | array $configs |
||
267 | ): array { |
||
268 | $isMutation = $isDefault = $isRoot = false; |
||
269 | if (isset($configs['definitions']['schema'])) { |
||
270 | $defaultSchemaName = isset($configs['definitions']['schema']['default']) ? 'default' : array_key_first($configs['definitions']['schema']); |
||
271 | foreach ($configs['definitions']['schema'] as $schemaName => $schema) { |
||
272 | $schemaQuery = $schema['query'] ?? null; |
||
273 | $schemaMutation = $schema['mutation'] ?? null; |
||
274 | |||
275 | if ($gqlName === $schemaQuery) { |
||
276 | $isRoot = true; |
||
277 | if ($defaultSchemaName === $schemaName) { |
||
278 | $isDefault = true; |
||
279 | } |
||
280 | } elseif ($gqlName === $schemaMutation) { |
||
281 | $isMutation = true; |
||
282 | $isRoot = true; |
||
283 | if ($defaultSchemaName === $schemaName) { |
||
284 | $isDefault = true; |
||
285 | } |
||
286 | } |
||
287 | } |
||
288 | } |
||
289 | |||
290 | $currentValue = $isRoot ? sprintf("service('%s')", self::formatNamespaceForExpression($reflectionClass->getName())) : 'value'; |
||
291 | |||
292 | $gqlConfiguration = self::graphQLTypeConfigFromAnnotation($reflectionClass, $classMetadata, $currentValue); |
||
293 | |||
294 | $providerFields = self::getGraphQLFieldsFromProviders($reflectionClass, $isMutation ? Metadata\Mutation::class : Metadata\Query::class, $gqlName, $isDefault); |
||
295 | $gqlConfiguration['config']['fields'] = array_merge($gqlConfiguration['config']['fields'], $providerFields); |
||
296 | |||
297 | if ($classMetadata instanceof Metadata\Relay\Edge) { |
||
298 | if (!$reflectionClass->implementsInterface(EdgeInterface::class)) { |
||
299 | throw new InvalidArgumentException(sprintf('The metadata %s on class "%s" can only be used on class implementing the EdgeInterface.', self::formatMetadata('Edge'), $reflectionClass->getName())); |
||
300 | } |
||
301 | if (!isset($gqlConfiguration['config']['builders'])) { |
||
302 | $gqlConfiguration['config']['builders'] = []; |
||
303 | } |
||
304 | array_unshift($gqlConfiguration['config']['builders'], ['builder' => 'relay-edge', 'builderConfig' => ['nodeType' => $classMetadata->node]]); |
||
305 | } |
||
306 | |||
307 | return $gqlConfiguration; |
||
308 | } |
||
309 | |||
310 | /** |
||
311 | * @return array{type: 'relay-mutation-payload'|'object', config: array} |
||
312 | */ |
||
313 | private static function graphQLTypeConfigFromAnnotation(ReflectionClass $reflectionClass, Metadata\Type $typeAnnotation, string $currentValue): array |
||
314 | { |
||
315 | $typeConfiguration = []; |
||
316 | $metadatas = static::getMetadatas($reflectionClass); |
||
317 | |||
318 | $fieldsFromProperties = self::getGraphQLTypeFieldsFromAnnotations($reflectionClass, self::getClassProperties($reflectionClass), Metadata\Field::class, $currentValue); |
||
319 | $fieldsFromMethods = self::getGraphQLTypeFieldsFromAnnotations($reflectionClass, $reflectionClass->getMethods(), Metadata\Field::class, $currentValue); |
||
320 | |||
321 | $typeConfiguration['fields'] = array_merge($fieldsFromProperties, $fieldsFromMethods); |
||
322 | $typeConfiguration = self::getDescriptionConfiguration($metadatas) + $typeConfiguration; |
||
323 | |||
324 | if (!empty($typeAnnotation->interfaces)) { |
||
325 | $typeConfiguration['interfaces'] = $typeAnnotation->interfaces; |
||
326 | } else { |
||
327 | $interfaces = array_keys(self::$map->searchClassesMapBy(function ($gqlType, $configuration) use ($reflectionClass) { |
||
328 | ['class' => $interfaceClassName] = $configuration; |
||
329 | |||
330 | $interfaceMetadata = self::getClassReflection($interfaceClassName); |
||
331 | if ($interfaceMetadata->isInterface() && $reflectionClass->implementsInterface($interfaceMetadata->getName())) { |
||
332 | return true; |
||
333 | } |
||
334 | |||
335 | return $reflectionClass->isSubclassOf($interfaceClassName); |
||
336 | }, self::GQL_INTERFACE)); |
||
337 | |||
338 | sort($interfaces); |
||
339 | $typeConfiguration['interfaces'] = $interfaces; |
||
340 | } |
||
341 | |||
342 | if (isset($typeAnnotation->resolveField)) { |
||
343 | $typeConfiguration['resolveField'] = self::formatExpression($typeAnnotation->resolveField); |
||
344 | } |
||
345 | |||
346 | $buildersAnnotations = array_merge(self::getMetadataMatching($metadatas, Metadata\FieldsBuilder::class), $typeAnnotation->builders); |
||
347 | if (!empty($buildersAnnotations)) { |
||
348 | $typeConfiguration['builders'] = array_map(function ($fieldsBuilderAnnotation) { |
||
349 | return ['builder' => $fieldsBuilderAnnotation->value, 'builderConfig' => $fieldsBuilderAnnotation->config]; |
||
350 | }, $buildersAnnotations); |
||
351 | } |
||
352 | |||
353 | if (isset($typeAnnotation->isTypeOf)) { |
||
354 | $typeConfiguration['isTypeOf'] = $typeAnnotation->isTypeOf; |
||
355 | } |
||
356 | |||
357 | $publicMetadata = self::getFirstMetadataMatching($metadatas, Metadata\IsPublic::class); |
||
358 | if (null !== $publicMetadata) { |
||
359 | $typeConfiguration['fieldsDefaultPublic'] = self::formatExpression($publicMetadata->value); |
||
360 | } |
||
361 | |||
362 | $accessMetadata = self::getFirstMetadataMatching($metadatas, Metadata\Access::class); |
||
363 | if (null !== $accessMetadata) { |
||
364 | $typeConfiguration['fieldsDefaultAccess'] = self::formatExpression($accessMetadata->value); |
||
365 | } |
||
366 | |||
367 | return ['type' => $typeAnnotation->isRelay ? 'relay-mutation-payload' : 'object', 'config' => $typeConfiguration]; |
||
368 | } |
||
369 | |||
370 | /** |
||
371 | * Create a GraphQL Interface type configuration from metadatas on properties. |
||
372 | * |
||
373 | * @return array{type: 'interface', config: array} |
||
374 | */ |
||
375 | private static function typeInterfaceMetadataToGQLConfiguration(ReflectionClass $reflectionClass, Metadata\TypeInterface $interfaceAnnotation): array |
||
376 | { |
||
377 | $interfaceConfiguration = []; |
||
378 | |||
379 | $fieldsFromProperties = self::getGraphQLTypeFieldsFromAnnotations($reflectionClass, self::getClassProperties($reflectionClass)); |
||
380 | $fieldsFromMethods = self::getGraphQLTypeFieldsFromAnnotations($reflectionClass, $reflectionClass->getMethods()); |
||
381 | |||
382 | $interfaceConfiguration['fields'] = array_merge($fieldsFromProperties, $fieldsFromMethods); |
||
383 | $interfaceConfiguration = self::getDescriptionConfiguration(static::getMetadatas($reflectionClass)) + $interfaceConfiguration; |
||
384 | |||
385 | $interfaceConfiguration['resolveType'] = self::formatExpression($interfaceAnnotation->resolveType); |
||
386 | |||
387 | return ['type' => 'interface', 'config' => $interfaceConfiguration]; |
||
388 | } |
||
389 | |||
390 | /** |
||
391 | * Create a GraphQL Input type configuration from metadatas on properties. |
||
392 | * |
||
393 | * @return array{type: 'relay-mutation-input'|'input-object', config: array} |
||
394 | */ |
||
395 | private static function inputMetadataToGQLConfiguration(ReflectionClass $reflectionClass, Metadata\Input $inputAnnotation): array |
||
396 | { |
||
397 | $inputConfiguration = array_merge([ |
||
398 | 'fields' => self::getGraphQLInputFieldsFromMetadatas($reflectionClass, self::getClassProperties($reflectionClass)), |
||
399 | ], self::getDescriptionConfiguration(static::getMetadatas($reflectionClass))); |
||
400 | |||
401 | return ['type' => $inputAnnotation->isRelay ? 'relay-mutation-input' : 'input-object', 'config' => $inputConfiguration]; |
||
402 | } |
||
403 | |||
404 | /** |
||
405 | * Get a GraphQL scalar configuration from given scalar metadata. |
||
406 | * |
||
407 | * @return array{type: 'custom-scalar', config: array} |
||
408 | */ |
||
409 | private static function scalarMetadataToGQLConfiguration(ReflectionClass $reflectionClass, Metadata\Scalar $scalarAnnotation): array |
||
410 | { |
||
411 | $scalarConfiguration = []; |
||
412 | |||
413 | if (isset($scalarAnnotation->scalarType)) { |
||
414 | $scalarConfiguration['scalarType'] = self::formatExpression($scalarAnnotation->scalarType); |
||
415 | } else { |
||
416 | $scalarConfiguration = [ |
||
417 | 'serialize' => [$reflectionClass->getName(), 'serialize'], |
||
418 | 'parseValue' => [$reflectionClass->getName(), 'parseValue'], |
||
419 | 'parseLiteral' => [$reflectionClass->getName(), 'parseLiteral'], |
||
420 | ]; |
||
421 | } |
||
422 | |||
423 | $scalarConfiguration = self::getDescriptionConfiguration(static::getMetadatas($reflectionClass)) + $scalarConfiguration; |
||
424 | |||
425 | return ['type' => 'custom-scalar', 'config' => $scalarConfiguration]; |
||
426 | } |
||
427 | |||
428 | /** |
||
429 | * Get a GraphQL Enum configuration from given enum metadata. |
||
430 | * |
||
431 | * @return array{type: 'enum', config: array} |
||
432 | */ |
||
433 | private static function enumMetadataToGQLConfiguration(ReflectionClass $reflectionClass, Metadata\Enum $enumMetadata): array |
||
434 | { |
||
435 | $metadatas = static::getMetadatas($reflectionClass); |
||
436 | $enumValues = array_merge(self::getMetadataMatching($metadatas, Metadata\EnumValue::class), $enumMetadata->values); |
||
437 | |||
438 | $values = []; |
||
439 | |||
440 | foreach ($reflectionClass->getConstants() as $name => $value) { |
||
441 | $enumValueAnnotation = current(array_filter($enumValues, fn ($enumValueAnnotation) => $enumValueAnnotation->name === $name)); |
||
442 | $valueConfig = []; |
||
443 | $valueConfig['value'] = $value; |
||
444 | |||
445 | if (false !== $enumValueAnnotation) { |
||
446 | if (isset($enumValueAnnotation->description)) { |
||
447 | $valueConfig['description'] = $enumValueAnnotation->description; |
||
448 | } |
||
449 | |||
450 | if (isset($enumValueAnnotation->deprecationReason)) { |
||
451 | $valueConfig['deprecationReason'] = $enumValueAnnotation->deprecationReason; |
||
452 | } |
||
453 | } |
||
454 | |||
455 | $values[$name] = $valueConfig; |
||
456 | } |
||
457 | |||
458 | $enumConfiguration = ['values' => $values]; |
||
459 | $enumConfiguration = self::getDescriptionConfiguration(static::getMetadatas($reflectionClass)) + $enumConfiguration; |
||
460 | |||
461 | return ['type' => 'enum', 'config' => $enumConfiguration]; |
||
462 | } |
||
463 | |||
464 | /** |
||
465 | * Get a GraphQL Union configuration from given union metadata. |
||
466 | * |
||
467 | * @return array{type: 'union', config: array} |
||
468 | */ |
||
469 | private static function unionMetadataToGQLConfiguration(ReflectionClass $reflectionClass, Metadata\Union $unionMetadata): array |
||
470 | { |
||
471 | $unionConfiguration = []; |
||
472 | if (!empty($unionMetadata->types)) { |
||
473 | $unionConfiguration['types'] = $unionMetadata->types; |
||
474 | } else { |
||
475 | $types = array_keys(self::$map->searchClassesMapBy(function ($gqlType, $configuration) use ($reflectionClass) { |
||
476 | $typeClassName = $configuration['class']; |
||
477 | $typeMetadata = self::getClassReflection($typeClassName); |
||
478 | |||
479 | if ($reflectionClass->isInterface() && $typeMetadata->implementsInterface($reflectionClass->getName())) { |
||
480 | return true; |
||
481 | } |
||
482 | |||
483 | return $typeMetadata->isSubclassOf($reflectionClass->getName()); |
||
484 | }, self::GQL_TYPE)); |
||
485 | sort($types); |
||
486 | $unionConfiguration['types'] = $types; |
||
487 | } |
||
488 | |||
489 | $unionConfiguration = self::getDescriptionConfiguration(static::getMetadatas($reflectionClass)) + $unionConfiguration; |
||
490 | |||
491 | if (isset($unionMetadata->resolveType)) { |
||
492 | $unionConfiguration['resolveType'] = self::formatExpression($unionMetadata->resolveType); |
||
493 | } else { |
||
494 | if ($reflectionClass->hasMethod('resolveType')) { |
||
495 | $method = $reflectionClass->getMethod('resolveType'); |
||
496 | if ($method->isStatic() && $method->isPublic()) { |
||
497 | $unionConfiguration['resolveType'] = self::formatExpression(sprintf("@=call('%s::%s', [service('overblog_graphql.type_resolver'), value], true)", self::formatNamespaceForExpression($reflectionClass->getName()), 'resolveType')); |
||
498 | } else { |
||
499 | throw new InvalidArgumentException(sprintf('The "resolveType()" method on class must be static and public. Or you must define a "resolveType" attribute on the %s metadata.', self::formatMetadata('Union'))); |
||
500 | } |
||
501 | } else { |
||
502 | throw new InvalidArgumentException(sprintf('The metadata %s has no "resolveType" attribute and the related class has no "resolveType()" public static method. You need to define of them.', self::formatMetadata('Union'))); |
||
503 | } |
||
504 | } |
||
505 | |||
506 | return ['type' => 'union', 'config' => $unionConfiguration]; |
||
507 | } |
||
508 | |||
509 | /** |
||
510 | * @phpstan-param ReflectionMethod|ReflectionProperty $reflector |
||
511 | * @phpstan-param class-string<Metadata\Field> $fieldMetadataName |
||
512 | * |
||
513 | * @throws AnnotationException |
||
514 | * |
||
515 | * @return array<string,array> |
||
516 | */ |
||
517 | private static function getTypeFieldConfigurationFromReflector(ReflectionClass $reflectionClass, Reflector $reflector, string $fieldMetadataName, string $currentValue = 'value'): array |
||
639 | } |
||
640 | |||
641 | /** |
||
642 | * Create GraphQL input fields configuration based on metadatas. |
||
643 | * |
||
644 | * @param ReflectionProperty[] $reflectors |
||
645 | * |
||
646 | * @throws AnnotationException |
||
647 | * |
||
648 | * @return array<string,array> |
||
649 | */ |
||
650 | private static function getGraphQLInputFieldsFromMetadatas(ReflectionClass $reflectionClass, array $reflectors): array |
||
651 | { |
||
652 | $fields = []; |
||
653 | |||
654 | foreach ($reflectors as $reflector) { |
||
655 | $metadatas = static::getMetadatas($reflector); |
||
656 | |||
657 | /** @var Metadata\Field|null $fieldMetadata */ |
||
658 | $fieldMetadata = self::getFirstMetadataMatching($metadatas, Metadata\Field::class); |
||
659 | |||
660 | // No field metadata found |
||
661 | if (null === $fieldMetadata) { |
||
662 | continue; |
||
663 | } |
||
664 | |||
665 | // Ignore field with resolver when the type is an Input |
||
666 | if (isset($fieldMetadata->resolve)) { |
||
667 | continue; |
||
668 | } |
||
669 | |||
670 | $fieldName = $reflector->getName(); |
||
671 | if (isset($fieldMetadata->type)) { |
||
672 | $fieldType = $fieldMetadata->type; |
||
673 | } else { |
||
674 | try { |
||
675 | $fieldType = self::guessType($reflectionClass, $reflector, self::VALID_INPUT_TYPES); |
||
676 | } catch (TypeGuessingException $e) { |
||
677 | throw new InvalidArgumentException(sprintf('The attribute "type" on %s is missing on property "%s" and cannot be auto-guessed from the following type guessers:'."\n%s\n", self::formatMetadata(Metadata\Field::class), $reflector->getName(), $e->getMessage())); |
||
678 | } |
||
679 | } |
||
680 | $fieldConfiguration = []; |
||
681 | if ($fieldType) { |
||
682 | // Resolve a PHP class from a GraphQL type |
||
683 | $resolvedType = self::$map->getType($fieldType); |
||
684 | // We found a type but it is not allowed |
||
685 | if (null !== $resolvedType && !in_array($resolvedType['type'], self::VALID_INPUT_TYPES)) { |
||
686 | throw new InvalidArgumentException(sprintf('The type "%s" on "%s" is a "%s" not valid on an Input %s. Only Input, Scalar and Enum are allowed.', $fieldType, $reflector->getName(), $resolvedType['type'], self::formatMetadata('Field'))); |
||
687 | } |
||
688 | |||
689 | $fieldConfiguration['type'] = $fieldType; |
||
690 | } |
||
691 | |||
692 | $fieldConfiguration = array_merge(self::getDescriptionConfiguration($metadatas, true), $fieldConfiguration); |
||
693 | $fields[$fieldName] = $fieldConfiguration; |
||
694 | } |
||
695 | |||
696 | return $fields; |
||
697 | } |
||
698 | |||
699 | /** |
||
700 | * Create GraphQL type fields configuration based on metadatas. |
||
701 | * |
||
702 | * @phpstan-param class-string<Metadata\Field> $fieldMetadataName |
||
703 | * |
||
704 | * @param ReflectionProperty[]|ReflectionMethod[] $reflectors |
||
705 | * |
||
706 | * @throws AnnotationException |
||
707 | */ |
||
708 | private static function getGraphQLTypeFieldsFromAnnotations(ReflectionClass $reflectionClass, array $reflectors, string $fieldMetadataName = Metadata\Field::class, string $currentValue = 'value'): array |
||
709 | { |
||
710 | $fields = []; |
||
711 | |||
712 | foreach ($reflectors as $reflector) { |
||
713 | $fields = array_merge($fields, self::getTypeFieldConfigurationFromReflector($reflectionClass, $reflector, $fieldMetadataName, $currentValue)); |
||
714 | } |
||
715 | |||
716 | return $fields; |
||
717 | } |
||
718 | |||
719 | /** |
||
720 | * @phpstan-param class-string<Metadata\Query|Metadata\Mutation> $expectedMetadata |
||
721 | * |
||
722 | * Return fields config from Provider methods. |
||
723 | * Loop through configured provider and extract fields targeting the targetType. |
||
724 | * |
||
725 | * @return array<string,array> |
||
726 | */ |
||
727 | private static function getGraphQLFieldsFromProviders(ReflectionClass $reflectionClass, string $expectedMetadata, string $targetType, bool $isDefaultTarget = false): array |
||
728 | { |
||
729 | $fields = []; |
||
730 | foreach (self::$providers as ['reflectionClass' => $providerReflection, 'metadata' => $providerMetadata]) { |
||
731 | $defaultAccessAnnotation = self::getFirstMetadataMatching(static::getMetadatas($providerReflection), Metadata\Access::class); |
||
732 | $defaultIsPublicAnnotation = self::getFirstMetadataMatching(static::getMetadatas($providerReflection), Metadata\IsPublic::class); |
||
733 | |||
734 | $defaultAccess = $defaultAccessAnnotation ? self::formatExpression($defaultAccessAnnotation->value) : false; |
||
735 | $defaultIsPublic = $defaultIsPublicAnnotation ? self::formatExpression($defaultIsPublicAnnotation->value) : false; |
||
736 | |||
737 | $methods = []; |
||
738 | // First found the methods matching the targeted type |
||
739 | foreach ($providerReflection->getMethods() as $method) { |
||
740 | $metadatas = static::getMetadatas($method); |
||
741 | |||
742 | $metadata = self::getFirstMetadataMatching($metadatas, [Metadata\Mutation::class, Metadata\Query::class]); |
||
743 | if (null === $metadata) { |
||
744 | continue; |
||
745 | } |
||
746 | |||
747 | // TODO: Remove old property check in 1.1 |
||
748 | $metadataTargets = $metadata->targetTypes ?? null; |
||
749 | |||
750 | if (null === $metadataTargets) { |
||
751 | if ($metadata instanceof Metadata\Mutation && isset($providerMetadata->targetMutationTypes)) { |
||
752 | $metadataTargets = $providerMetadata->targetMutationTypes; |
||
753 | } elseif ($metadata instanceof Metadata\Query && isset($providerMetadata->targetQueryTypes)) { |
||
754 | $metadataTargets = $providerMetadata->targetQueryTypes; |
||
755 | } |
||
756 | } |
||
757 | |||
758 | if (null === $metadataTargets) { |
||
759 | if ($isDefaultTarget) { |
||
760 | $metadataTargets = [$targetType]; |
||
761 | if (!$metadata instanceof $expectedMetadata) { |
||
762 | continue; |
||
763 | } |
||
764 | } else { |
||
765 | continue; |
||
766 | } |
||
767 | } |
||
768 | |||
769 | if (!in_array($targetType, $metadataTargets)) { |
||
770 | continue; |
||
771 | } |
||
772 | |||
773 | if (!$metadata instanceof $expectedMetadata) { |
||
774 | if (Metadata\Mutation::class === $expectedMetadata) { |
||
775 | $message = sprintf('The provider "%s" try to add a query field on type "%s" (through %s on method "%s") but "%s" is a mutation.', $providerReflection->getName(), $targetType, self::formatMetadata('Query'), $method->getName(), $targetType); |
||
776 | } else { |
||
777 | $message = sprintf('The provider "%s" try to add a mutation on type "%s" (through %s on method "%s") but "%s" is not a mutation.', $providerReflection->getName(), $targetType, self::formatMetadata('Mutation'), $method->getName(), $targetType); |
||
778 | } |
||
779 | |||
780 | throw new InvalidArgumentException($message); |
||
781 | } |
||
782 | $methods[$method->getName()] = $method; |
||
783 | } |
||
784 | |||
785 | $currentValue = sprintf("service('%s')", self::formatNamespaceForExpression($providerReflection->getName())); |
||
786 | $providerFields = self::getGraphQLTypeFieldsFromAnnotations($reflectionClass, $methods, $expectedMetadata, $currentValue); |
||
787 | foreach ($providerFields as $fieldName => $fieldConfig) { |
||
788 | if (isset($providerMetadata->prefix)) { |
||
789 | $fieldName = sprintf('%s%s', $providerMetadata->prefix, $fieldName); |
||
790 | } |
||
791 | |||
792 | if ($defaultAccess && !isset($fieldConfig['access'])) { |
||
793 | $fieldConfig['access'] = $defaultAccess; |
||
794 | } |
||
795 | |||
796 | if ($defaultIsPublic && !isset($fieldConfig['public'])) { |
||
797 | $fieldConfig['public'] = $defaultIsPublic; |
||
798 | } |
||
799 | |||
800 | $fields[$fieldName] = $fieldConfig; |
||
801 | } |
||
802 | } |
||
803 | |||
804 | return $fields; |
||
805 | } |
||
806 | |||
807 | /** |
||
808 | * Get the config for description & deprecation reason. |
||
809 | * |
||
810 | * @return array<'description'|'deprecationReason',string> |
||
811 | */ |
||
812 | private static function getDescriptionConfiguration(array $metadatas, bool $withDeprecation = false): array |
||
813 | { |
||
814 | $config = []; |
||
815 | $descriptionAnnotation = self::getFirstMetadataMatching($metadatas, Metadata\Description::class); |
||
816 | if (null !== $descriptionAnnotation) { |
||
817 | $config['description'] = $descriptionAnnotation->value; |
||
818 | } |
||
819 | |||
820 | if ($withDeprecation) { |
||
821 | $deprecatedAnnotation = self::getFirstMetadataMatching($metadatas, Metadata\Deprecated::class); |
||
822 | if (null !== $deprecatedAnnotation) { |
||
823 | $config['deprecationReason'] = $deprecatedAnnotation->value; |
||
824 | } |
||
825 | } |
||
826 | |||
827 | return $config; |
||
828 | } |
||
829 | |||
830 | /** |
||
831 | * Format an array of args to a list of arguments in an expression. |
||
832 | */ |
||
833 | private static function formatArgsForExpression(array $args): string |
||
841 | } |
||
842 | |||
843 | /** |
||
844 | * Format a namespace to be used in an expression (double escape). |
||
845 | */ |
||
846 | private static function formatNamespaceForExpression(string $namespace): string |
||
847 | { |
||
848 | return str_replace('\\', '\\\\', $namespace); |
||
849 | } |
||
850 | |||
851 | /** |
||
852 | * Get the first metadata matching given class. |
||
853 | * |
||
854 | * @phpstan-template T of object |
||
855 | * @phpstan-param class-string<T>|class-string<T>[] $metadataClasses |
||
856 | * @phpstan-return T|null |
||
857 | * |
||
858 | * @return object|null |
||
859 | */ |
||
860 | private static function getFirstMetadataMatching(array $metadatas, $metadataClasses) |
||
861 | { |
||
862 | $metas = self::getMetadataMatching($metadatas, $metadataClasses); |
||
863 | |||
864 | return array_shift($metas); |
||
865 | } |
||
866 | |||
867 | /** |
||
868 | * Return the metadata matching given class |
||
869 | * |
||
870 | * @phpstan-template T of object |
||
871 | * @phpstan-param class-string<T>|class-string<T>[] $metadataClasses |
||
872 | * |
||
873 | * @return array |
||
874 | */ |
||
875 | private static function getMetadataMatching(array $metadatas, $metadataClasses) |
||
876 | { |
||
877 | if (is_string($metadataClasses)) { |
||
878 | $metadataClasses = [$metadataClasses]; |
||
879 | } |
||
880 | |||
881 | return array_filter($metadatas, function ($metadata) use ($metadataClasses) { |
||
882 | foreach ($metadataClasses as $metadataClass) { |
||
883 | if ($metadata instanceof $metadataClass) { |
||
884 | return true; |
||
885 | } |
||
886 | } |
||
887 | |||
888 | return false; |
||
889 | }); |
||
890 | } |
||
891 | |||
892 | /** |
||
893 | * Format an expression (ie. add "@=" if not set). |
||
894 | */ |
||
895 | private static function formatExpression(string $expression): string |
||
896 | { |
||
897 | return '@=' === substr($expression, 0, 2) ? $expression : sprintf('@=%s', $expression); |
||
898 | } |
||
899 | |||
900 | /** |
||
901 | * Suffix a name if it is not already. |
||
902 | */ |
||
903 | private static function suffixName(string $name, string $suffix): string |
||
904 | { |
||
905 | return substr($name, -strlen($suffix)) === $suffix ? $name : sprintf('%s%s', $name, $suffix); |
||
906 | } |
||
907 | |||
908 | /** |
||
909 | * Try to guess a GraphQL type using configured type guessers |
||
910 | * |
||
911 | * @throws RuntimeException |
||
912 | */ |
||
913 | private static function guessType(ReflectionClass $reflectionClass, Reflector $reflector, array $filterGraphQLTypes = []): string |
||
914 | { |
||
915 | $errors = []; |
||
916 | foreach (self::$typeGuessers as $typeGuesser) { |
||
917 | if (!$typeGuesser->supports($reflector)) { |
||
918 | continue; |
||
919 | } |
||
920 | try { |
||
921 | $type = $typeGuesser->guessType($reflectionClass, $reflector, $filterGraphQLTypes); |
||
922 | |||
923 | return $type; |
||
924 | } catch (TypeGuessingException $exception) { |
||
925 | $errors[] = sprintf('[%s] %s', $typeGuesser->getName(), $exception->getMessage()); |
||
926 | } |
||
927 | } |
||
928 | |||
929 | throw new TypeGuessingException(join("\n", $errors)); |
||
930 | } |
||
931 | |||
932 | /** |
||
933 | * Transform a method arguments from reflection to a list of GraphQL argument. |
||
934 | */ |
||
935 | private static function guessArgs(ReflectionClass $reflectionClass, ReflectionMethod $method): array |
||
936 | { |
||
937 | $arguments = []; |
||
938 | foreach ($method->getParameters() as $index => $parameter) { |
||
939 | try { |
||
940 | $gqlType = self::guessType($reflectionClass, $parameter, self::VALID_INPUT_TYPES); |
||
941 | } catch (TypeGuessingException $exception) { |
||
942 | throw new InvalidArgumentException(sprintf('Argument n°%s "$%s" on method "%s" cannot be auto-guessed from the following type guessers:'."\n%s\n", $index + 1, $parameter->getName(), $method->getName(), $exception->getMessage())); |
||
943 | } |
||
944 | |||
945 | $argumentConfig = []; |
||
946 | if ($parameter->isDefaultValueAvailable()) { |
||
947 | $argumentConfig['defaultValue'] = $parameter->getDefaultValue(); |
||
948 | } |
||
949 | |||
950 | $argumentConfig['type'] = $gqlType; |
||
951 | |||
952 | $arguments[$parameter->getName()] = $argumentConfig; |
||
953 | } |
||
954 | |||
955 | return $arguments; |
||
956 | } |
||
957 | |||
958 | /** |
||
959 | * @return ReflectionProperty[] |
||
960 | */ |
||
961 | private static function getClassProperties(ReflectionClass $reflectionClass): array |
||
962 | { |
||
963 | $properties = []; |
||
964 | do { |
||
965 | foreach ($reflectionClass->getProperties() as $property) { |
||
966 | if (isset($properties[$property->getName()])) { |
||
967 | continue; |
||
968 | } |
||
969 | $properties[$property->getName()] = $property; |
||
970 | } |
||
971 | } while ($reflectionClass = $reflectionClass->getParentClass()); |
||
972 | |||
973 | return $properties; |
||
974 | } |
||
975 | |||
976 | protected static function formatMetadata(string $className): string |
||
979 | } |
||
980 | |||
981 | abstract protected static function getMetadatas(Reflector $reflector): array; |
||
982 | } |
||
983 |