Fix #1169

When using attributes or annotations, we can try to auto resolve the types associated with interfaces.

Author: Vincz

docs/annotations/annotations-reference.md

@@ -591,13 +591,15 @@ class Hero {
 
 This annotation is used on _class_ to define a GraphQL interface.
 
-Required attributes:
+Optional attributes:
 
 -   **resolveType** : An expression to resolve the types
+-   **name**  : The GraphQL name of the interface (default to the class name without namespace)
 
-Optional attributes:
+If the `resolveType` attribute is not set, the service `overblog_graphql.interface_type_resolver` will be used to try to resolve the type automatically based on types implementing the interface and their associated class.  
+The system will register a map of interfaces with the list of types and their associated class name implementing the interface (the parameter is named `overblog_graphql_types.interfaces_map` in the container) and use it to resolve the type from the value (the first type where the class `instanceof` operator returns true will be used).  
 
--   **name**  : The GraphQL name of the interface (default to the class name without namespace)
+```php
 
 ## @Scalar
 

src/Annotation/TypeInterface.php

@@ -20,7 +20,7 @@ final class TypeInterface extends Annotation
     /**
      * Resolver type for interface.
      */
-    public string $resolveType;
+    public ?string $resolveType;
 
     /**
      * Interface name.
@@ -31,7 +31,7 @@ final class TypeInterface extends Annotation
      * @param string        $resolveType The express resolve type
      * @param string|null   $name        The GraphQL name of the interface
      */
-    public function __construct(string $resolveType, ?string $name = null)
+    public function __construct(?string $resolveType = null, ?string $name = null)
     {
         $this->resolveType = $resolveType;
         $this->name = $name;

src/Config/Parser/MetadataParser/ClassesTypesMap.php

@@ -11,6 +11,11 @@ final class ClassesTypesMap
      */
     private array $classesMap = [];
 
+    /**
+     * @var array<string, array{class: string, type: string}>
+     */
+    private array $interfacesMap = [];
+
     public function hasType(string $gqlType): bool
     {
         return isset($this->classesMap[$gqlType]);
@@ -72,8 +77,25 @@ public function searchClassesMapBy(callable $predicate, string $type): array
         return $classNames;
     }
 
-    public function toArray(): array
+    public function classesToArray(): array
     {
         return $this->classesMap;
     }
+
+    /**
+     * Add a type and its associated class to the interfaces map
+     */
+    public function addInterfaceType(string $interfaceType, string $graphqlType, string $className): void
+    {
+        if (!isset($this->interfacesMap[$interfaceType])) {
+            $this->interfacesMap[$interfaceType] = [];
+        }
+
+        $this->interfacesMap[$interfaceType][$className] = $graphqlType;
+    }
+
+    public function interfacesToArray(): array
+    {
+        return $this->interfacesMap;
+    }
 }

src/Config/Parser/MetadataParser/MetadataParser.php

@@ -88,6 +88,22 @@ public static function parse(SplFileInfo $file, ContainerBuilder $container, arr
         return self::processFile($file, $container, $configs, false);
     }
 
+    public static function finalize(ContainerBuilder $container): void
+    {
+        $parameter = 'overblog_graphql_types.interfaces_map';
+        $value = $container->hasParameter($parameter) ? $container->getParameter($parameter) : [];
+        foreach (self::$map->interfacesToArray() as $interface => $types) {
+            if (!isset($value[$interface])) {
+                $value[$interface] = [];
+            }
+            foreach ($types as $className => $typeName) {
+                $value[$interface][$className] = $typeName;
+            }
+        }
+
+        $container->setParameter('overblog_graphql_types.interfaces_map', $value);
+    }
+
     /**
      * @internal
      */
@@ -134,7 +150,7 @@ private static function processFile(SplFileInfo $file, ContainerBuilder $contain
                 }
             }
 
-            return $preProcess ? self::$map->toArray() : $gqlTypes;
+            return $preProcess ? self::$map->classesToArray() : $gqlTypes;
         } catch (ReflectionException $e) {
             return $gqlTypes;
         } catch (\InvalidArgumentException $e) {
@@ -189,6 +205,11 @@ private static function classMetadatasToGQLConfiguration(
 
                         array_unshift($gqlConfiguration['config']['builders'], ['builder' => 'relay-connection', 'builderConfig' => ['edgeType' => $edgeType]]);
                     }
+
+                    $interfaces = $gqlConfiguration['config']['interfaces'] ?? [];
+                    foreach ($interfaces as $interface) {
+                        self::$map->addInterfaceType($interface, $gqlName, $reflectionClass->getName());
+                    }
                 }
                 break;
 
@@ -224,7 +245,10 @@ private static function classMetadatasToGQLConfiguration(
             case $classMetadata instanceof Metadata\TypeInterface:
                 $gqlType = self::GQL_INTERFACE;
                 if (!$preProcess) {
-                    $gqlConfiguration = self::typeInterfaceMetadataToGQLConfiguration($reflectionClass, $classMetadata);
+                    if (!$gqlName) {
+                        $gqlName = !empty($classMetadata->name) ? $classMetadata->name : $reflectionClass->getShortName();
+                    }
+                    $gqlConfiguration = self::typeInterfaceMetadataToGQLConfiguration($reflectionClass, $classMetadata, $gqlName);
                 }
                 break;
 
@@ -380,7 +404,7 @@ private static function graphQLTypeConfigFromAnnotation(ReflectionClass $reflect
      *
      * @return array{type: 'interface', config: array}
      */
-    private static function typeInterfaceMetadataToGQLConfiguration(ReflectionClass $reflectionClass, Metadata\TypeInterface $interfaceAnnotation): array
+    private static function typeInterfaceMetadataToGQLConfiguration(ReflectionClass $reflectionClass, Metadata\TypeInterface $interfaceAnnotation, string $gqlName): array
     {
         $interfaceConfiguration = [];
 
@@ -390,7 +414,12 @@ private static function typeInterfaceMetadataToGQLConfiguration(ReflectionClass
         $interfaceConfiguration['fields'] = array_merge($fieldsFromProperties, $fieldsFromMethods);
         $interfaceConfiguration = self::getDescriptionConfiguration(static::getMetadatas($reflectionClass)) + $interfaceConfiguration;
 
-        $interfaceConfiguration['resolveType'] = self::formatExpression($interfaceAnnotation->resolveType);
+        if (isset($interfaceAnnotation->resolveType)) {
+            $interfaceConfiguration['resolveType'] = self::formatExpression($interfaceAnnotation->resolveType);
+        } else {
+            // Try to use default interface resolver type
+            $interfaceConfiguration['resolveType'] = self::formatExpression(sprintf("service('overblog_graphql.interface_type_resolver').resolveType('%s', value)", $gqlName));
+        }
 
         return ['type' => 'interface', 'config' => $interfaceConfiguration];
     }
@@ -687,7 +716,7 @@ private static function getGraphQLInputFieldsFromMetadatas(ReflectionClass $refl
 
             if ($fieldMetadata instanceof InputField && null !== $fieldMetadata->defaultValue) {
                 $fieldConfiguration['defaultValue'] = $fieldMetadata->defaultValue;
-            } elseif ($reflector->hasDefaultValue()) {
+            } elseif ($reflector->hasDefaultValue() && null !== $reflector->getDefaultValue()) {
                 $fieldConfiguration['defaultValue'] = $reflector->getDefaultValue();
             }
 

src/Controller/ProfilerController.php

@@ -63,7 +63,7 @@ public function __invoke(Request $request, string $token): Response
 
         $tokens = array_map(function ($tokenData) {
             $profile = $this->profiler->loadProfile($tokenData['token']);
-            if (!$profile->hasCollector('graphql')) {
+            if (!$profile || !$profile->hasCollector('graphql')) {
                 return false;
             }
             $tokenData['graphql'] = $profile->getCollector('graphql');

src/DependencyInjection/Compiler/ConfigParserPass.php

@@ -91,6 +91,8 @@ private function getConfigs(ContainerBuilder $container): array
         $config = $container->getParameterBag()->resolveValue($container->getParameter('overblog_graphql.config'));
         $container->getParameterBag()->remove('overblog_graphql.config');
         $container->setParameter($this->getAlias().'.classes_map', []);
+        $container->setParameter($this->getAlias().'.interfaces_map', []);
+
         $typesMappings = $this->mappingConfig($config, $container);
         // reset treated files
         $this->treatedFiles = [];
@@ -117,6 +119,9 @@ private function getConfigs(ContainerBuilder $container): array
         // flatten config is a requirement to support inheritance
         $flattenTypeConfig = array_merge(...$typeConfigs);
 
+        AnnotationParser::finalize($container);
+        AttributeParser::finalize($container);
+
         return $flattenTypeConfig;
     }
 

src/Resolver/InterfaceTypeResolver.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Overblog\GraphQLBundle\Resolver;
+
+class InterfaceTypeResolver
+{
+    private TypeResolver $typeResolver;
+    private array $interfacesMap;
+
+    public function __construct(TypeResolver $typeResolver, array $interfacesMap = [])
+    {
+        $this->typeResolver = $typeResolver;
+        $this->interfacesMap = $interfacesMap;
+    }
+
+    public function resolveType(string $interfaceType, mixed $value)
+    {
+        if (!isset($this->interfacesMap[$interfaceType])) {
+            throw new UnresolvableException(sprintf('Default interface type resolver was unable to find interface with name "%s"', $interfaceType));
+        }
+
+        $gqlType = null;
+        $types = $this->interfacesMap[$interfaceType];
+        foreach ($types as $className => $type) {
+            if ($value instanceof $className) {
+                $gqlType = $type;
+                break;
+            }
+        }
+
+        if (null === $gqlType) {
+            throw new UnresolvableException(sprintf('Default interface type resolver with interface "%s" did not find a matching instance in: %s', $interfaceType, implode(', ', array_keys($types))));
+        }
+
+        return $this->typeResolver->resolve($gqlType);
+    }
+}

src/Resources/config/aliases.yaml

@@ -12,6 +12,7 @@ services:
     overblog_graphql.request_parser: '@Overblog\GraphQLBundle\Request\Parser'
     overblog_graphql.request_batch_parser: '@Overblog\GraphQLBundle\Request\BatchParser'
     overblog_graphql.arguments_transformer: '@Overblog\GraphQLBundle\Transformer\ArgumentsTransformer'
+    overblog_graphql.interface_type_resolver: '@Overblog\GraphQLBundle\Resolver\InterfaceTypeResolver'
 
     overblog_graphql.schema_builder:
         alias: 'Overblog\GraphQLBundle\Definition\Builder\SchemaBuilder'

src/Resources/config/services.yaml

@@ -10,14 +10,14 @@ services:
     Overblog\GraphQLBundle\Resolver\FieldResolver: ~
 
     Overblog\GraphQLBundle\Definition\GraphQLServices:
-        tags: ['container.service_locator']
+        tags: ["container.service_locator"]
 
     Overblog\GraphQLBundle\Request\Executor:
         arguments:
             - "@overblog_graphql.executor"
             - "@overblog_graphql.promise_adapter"
             - "@event_dispatcher"
-            - '@overblog_graphql.default_field_resolver'
+            - "@overblog_graphql.default_field_resolver"
         calls:
             - ["setMaxQueryComplexity", ["%overblog_graphql.query_max_complexity%"]]
             - ["setMaxQueryDepth", ["%overblog_graphql.query_max_depth%"]]
@@ -34,14 +34,14 @@ services:
 
     Overblog\GraphQLBundle\Resolver\TypeResolver:
         calls:
-            - ['setDispatcher', ['@event_dispatcher']]
+            - ["setDispatcher", ["@event_dispatcher"]]
         tags:
             - { name: overblog_graphql.service, alias: typeResolver }
 
     Overblog\GraphQLBundle\Transformer\ArgumentsTransformer:
         arguments:
-            - '@?validator'
-            - '%overblog_graphql_types.classes_map%'
+            - "@?validator"
+            - "%overblog_graphql_types.classes_map%"
 
     Overblog\GraphQLBundle\Resolver\QueryResolver:
         tags:
@@ -51,31 +51,36 @@ services:
         tags:
             - { name: overblog_graphql.service, alias: mutationResolver }
 
+    Overblog\GraphQLBundle\Resolver\InterfaceTypeResolver:
+        arguments:
+            - '@Overblog\GraphQLBundle\Resolver\TypeResolver'
+            - "%overblog_graphql_types.interfaces_map%"
+
     Overblog\GraphQLBundle\Resolver\AccessResolver:
         arguments:
-            - '@overblog_graphql.promise_adapter'
+            - "@overblog_graphql.promise_adapter"
 
     Overblog\GraphQLBundle\ExpressionLanguage\ExpressionLanguage:
         arguments:
-            - '@?overblog_graphql.cache_expression_language_parser'
+            - "@?overblog_graphql.cache_expression_language_parser"
 
     Overblog\GraphQLBundle\Generator\TypeGenerator:
         arguments:
-            - '%overblog_graphql_types.config%'
+            - "%overblog_graphql_types.config%"
             - '@Overblog\GraphQLBundle\Generator\TypeBuilder'
             - '@Symfony\Contracts\EventDispatcher\EventDispatcherInterface'
             - !service
-                class: Overblog\GraphQLBundle\Generator\TypeGeneratorOptions
-                arguments:
-                    - '%overblog_graphql.class_namespace%'
-                    - '%overblog_graphql.cache_dir%'
-                    - '%overblog_graphql.use_classloader_listener%'
-                    - '%kernel.cache_dir%'
-                    - '%overblog_graphql.cache_dir_permissions%'
+              class: Overblog\GraphQLBundle\Generator\TypeGeneratorOptions
+              arguments:
+                  - "%overblog_graphql.class_namespace%"
+                  - "%overblog_graphql.cache_dir%"
+                  - "%overblog_graphql.use_classloader_listener%"
+                  - "%kernel.cache_dir%"
+                  - "%overblog_graphql.cache_dir_permissions%"
 
     Overblog\GraphQLBundle\Definition\ArgumentFactory:
         arguments:
-            - '%overblog_graphql.argument_class%'
+            - "%overblog_graphql.argument_class%"
         tags:
             - { name: overblog_graphql.service, alias: argumentFactory }
 
@@ -90,7 +95,7 @@ services:
 
     Overblog\GraphQLBundle\Definition\ConfigProcessor:
         arguments:
-            - !tagged_iterator 'overblog_graphql.definition_config_processor'
+            - !tagged_iterator "overblog_graphql.definition_config_processor"
 
     GraphQL\Executor\Promise\PromiseAdapter: "@overblog_graphql.promise_adapter"
 
@@ -100,7 +105,7 @@ services:
 
     Overblog\GraphQLBundle\Security\Security:
         arguments:
-            - '@?security.helper'
+            - "@?security.helper"
         tags:
             - { name: overblog_graphql.service, alias: security, public: false }
 
@@ -111,12 +116,12 @@ services:
     Overblog\GraphQLBundle\Generator\TypeBuilder:
         arguments:
             - '@Overblog\GraphQLBundle\Generator\Converter\ExpressionConverter'
-            - '%overblog_graphql.class_namespace%'
+            - "%overblog_graphql.class_namespace%"
 
     Overblog\GraphQLBundle\Validator\InputValidatorFactory:
         arguments:
-            - '@?validator.validator_factory'
-            - '@?validator'
-            - '@?translator.default'
+            - "@?validator.validator_factory"
+            - "@?validator"
+            - "@?translator.default"
         tags:
             - { name: overblog_graphql.service, alias: input_validator_factory, public: false }

tests/Config/Parser/MetadataParserTest.php

@@ -252,6 +252,10 @@ public function testInterfaces(): void
             'description' => 'The armored interface',
             'resolveType' => '@=query(\'character_type\', [value])',
         ]);
+
+        $this->expect('Biped', 'interface', [
+            'resolveType' => "@=service('overblog_graphql.interface_type_resolver').resolveType('Biped', value)",
+        ]);
     }
 
     public function testEnum(): void
@@ -304,7 +308,7 @@ public function testUnionAutoguessed(): void
     public function testInterfaceAutoguessed(): void
     {
         $this->expect('Mandalorian', 'object', [
-            'interfaces' => ['Character', 'WithArmor'],
+            'interfaces' => ['Biped', 'Character', 'WithArmor'],
             'fields' => [
                 'name' => ['type' => 'String!', 'description' => 'The name of the character'],
                 'friends' => ['type' => '[Character]', 'description' => 'The friends of the character', 'resolve' => "@=query('App\\MyResolver::getFriends')"],