Use default resolver like callable service

Author: mcg-web

UPGRADE-0.13.md

@@ -3,8 +3,20 @@ UPGRADE FROM 0.12 to 0.13
 
 # Table of Contents
 
+- [Rename default_field config](#rename-default_field-config)
 - [Improve default field resolver](#improve-default-field-resolver)
 
+### Rename default_field config
+
+```diff
+overblog_graphql:
+    definitions:
+-       default_resolver: ~
++       default_field_resolver: ~
+```
+
+The new `default_field_resolver` config entry accepts callable service id.
+
 ### Improve default field resolver
 
 Stop using internally `symfony/property-access` package
@@ -20,7 +32,7 @@ Globally:
 ```yaml
 overblog_graphql:
     definitions:
-        default_resolver: 'App\GraphQL\CustomResolver::defaultFieldResolver'
+        default_field_resolver: 'App\GraphQL\CustomResolver'
 ```
 
 [see default field resolver for more details](https://webonyx.github.io/graphql-php/data-fetching/#default-field-resolver)

docs/definitions/resolver.md

@@ -228,4 +228,16 @@ services:
 `addition` mutation can be access by using `App\GraphQL\Mutation\CalcMutation::addition` or
 `add` alias.
 
+### Default field resolver
+
+The default field resolver can be define using config:
+
+```yaml
+overblog_graphql:
+    definitions:
+       default_field_resolver: 'my_default_field_resolver_service'
+```
+
+Default field resolver should be a callable service (implementing `__invoker` method)
+
 Next step [solving N+1 problem](solving-n-plus-1-problem.md)

src/DependencyInjection/Configuration.php

@@ -13,7 +13,7 @@
 use Overblog\GraphQLBundle\EventListener\ErrorLoggerListener;
 use Overblog\GraphQLBundle\Executor\Executor;
 use Overblog\GraphQLBundle\ExpressionLanguage\ExpressionLanguage;
-use Overblog\GraphQLBundle\Resolver\Resolver;
+use Overblog\GraphQLBundle\Resolver\FieldResolver;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\Config\Definition\Builder\EnumNodeDefinition;
 use Symfony\Component\Config\Definition\Builder\ScalarNodeDefinition;
@@ -120,7 +120,7 @@ private function definitionsSection()
             ->children()
                 ->scalarNode('argument_class')->defaultValue(Argument::class)->end()
                 ->scalarNode('use_experimental_executor')->defaultFalse()->end()
-                ->variableNode('default_resolver')->defaultValue([Resolver::class, 'defaultResolveFn'])->end()
+                ->scalarNode('default_field_resolver')->defaultValue(FieldResolver::class)->end()
                 ->scalarNode('class_namespace')->defaultValue('Overblog\\GraphQLBundle\\__DEFINITIONS__')->end()
                 ->scalarNode('cache_dir')->defaultNull()->end()
                 ->scalarNode('cache_dir_permissions')->defaultNull()->end()

src/DependencyInjection/OverblogGraphQLExtension.php

@@ -48,6 +48,7 @@ public function load(array $configs, ContainerBuilder $container): void
         $this->setClassLoaderListener($config, $container);
         $this->setCompilerCacheWarmer($config, $container);
         $this->registerForAutoconfiguration($container);
+        $this->setDefaultFieldResolver($config, $container);
 
         $container->setParameter($this->getAlias().'.config', $config);
         $container->setParameter($this->getAlias().'.resources_dir', \realpath(__DIR__.'/../Resources'));
@@ -89,6 +90,11 @@ private function registerForAutoconfiguration(ContainerBuilder $container): void
             ->addTag('overblog_graphql.type');
     }
 
+    private function setDefaultFieldResolver(array $config, ContainerBuilder $container): void
+    {
+        $container->setAlias($this->getAlias().'.default_field_resolver', $config['definitions']['default_field_resolver']);
+    }
+
     private function setCompilerCacheWarmer(array $config, ContainerBuilder $container): void
     {
         $container->register(CompileCacheWarmer::class)
@@ -118,7 +124,6 @@ private function setClassLoaderListener(array $config, ContainerBuilder $contain
     private function setDefinitionParameters(array $config, ContainerBuilder $container): void
     {
         // generator and config
-        $container->setParameter($this->getAlias().'.default_resolver', $config['definitions']['default_resolver']);
         $container->setParameter($this->getAlias().'.class_namespace', $config['definitions']['class_namespace']);
         $container->setParameter($this->getAlias().'.cache_dir', $config['definitions']['cache_dir']);
         $container->setParameter($this->getAlias().'.cache_dir_permissions', $config['definitions']['cache_dir_permissions']);

src/GraphQL/Relay/Mutation/MutationFieldResolver.php

@@ -8,7 +8,6 @@
 use Overblog\GraphQLBundle\Definition\ArgumentFactory;
 use Overblog\GraphQLBundle\Definition\Resolver\AliasedInterface;
 use Overblog\GraphQLBundle\Definition\Resolver\ResolverInterface;
-use Overblog\GraphQLBundle\Resolver\Resolver;
 
 final class MutationFieldResolver implements ResolverInterface, AliasedInterface
 {
@@ -28,7 +27,7 @@ public function __invoke($args, $context, $info, \Closure $mutateAndGetPayloadCa
 
         return $this->promiseAdapter->createFulfilled($mutateAndGetPayloadCallback($input, $context, $info))
             ->then(function ($payload) use ($input) {
-                Resolver::setObjectOrArrayValue($payload, 'clientMutationId', $input['clientMutationId']);
+                $this->setObjectOrArrayValue($payload, 'clientMutationId', $input['clientMutationId']);
 
                 return $payload;
             });
@@ -41,4 +40,13 @@ public static function getAliases(): array
     {
         return ['__invoke' => 'relay_mutation_field'];
     }
+
+    private function setObjectOrArrayValue(&$objectOrArray, $fieldName, $value): void
+    {
+        if (\is_array($objectOrArray)) {
+            $objectOrArray[$fieldName] = $value;
+        } elseif (\is_object($objectOrArray)) {
+            $objectOrArray->$fieldName = $value;
+        }
+    }
 }

src/GraphQL/Relay/Node/GlobalIdFieldResolver.php

@@ -8,15 +8,15 @@
 use Overblog\GraphQLBundle\Definition\Resolver\AliasedInterface;
 use Overblog\GraphQLBundle\Definition\Resolver\ResolverInterface;
 use Overblog\GraphQLBundle\Relay\Node\GlobalId;
-use Overblog\GraphQLBundle\Resolver\Resolver;
+use Overblog\GraphQLBundle\Resolver\FieldResolver;
 
 final class GlobalIdFieldResolver implements ResolverInterface, AliasedInterface
 {
     public function __invoke($obj, ResolveInfo $info, $idValue, $typeName)
     {
         return GlobalId::toGlobalId(
             !empty($typeName) ? $typeName : $info->parentType->name,
-            $idValue ? $idValue : Resolver::valueFromObjectOrArray($obj, 'id')
+            $idValue ? $idValue : FieldResolver::valueFromObjectOrArray($obj, 'id')
         );
     }
 

src/Resolver/Resolver.php renamed to src/Resolver/FieldResolver.php

@@ -6,14 +6,14 @@
 
 use GraphQL\Type\Definition\ResolveInfo;
 
-class Resolver
+class FieldResolver
 {
-    public static function defaultResolveFn($objectOrArray, $args, $context, ResolveInfo $info)
+    public function __invoke($parentValue, $args, $context, ResolveInfo $info)
     {
         $fieldName = $info->fieldName;
-        $value = static::valueFromObjectOrArray($objectOrArray, $fieldName);
+        $value = self::valueFromObjectOrArray($parentValue, $fieldName);
 
-        return $value instanceof \Closure ? $value($objectOrArray, $args, $context, $info) : $value;
+        return $value instanceof \Closure ? $value($parentValue, $args, $context, $info) : $value;
     }
 
     public static function valueFromObjectOrArray($objectOrArray, $fieldName)
@@ -32,15 +32,6 @@ public static function valueFromObjectOrArray($objectOrArray, $fieldName)
         return $value;
     }
 
-    public static function setObjectOrArrayValue(&$objectOrArray, $fieldName, $value): void
-    {
-        if (\is_array($objectOrArray)) {
-            $objectOrArray[$fieldName] = $value;
-        } elseif (\is_object($objectOrArray)) {
-            $objectOrArray->$fieldName = $value;
-        }
-    }
-
     private static function guessObjectMethod($object, string $fieldName, string $prefix): ?string
     {
         if (\is_callable([$object, $method = $prefix.\str_replace(' ', '', \ucwords(\str_replace('_', ' ', $fieldName)))])) {

src/Resources/config/definition_config_processors.yaml

@@ -6,7 +6,7 @@ services:
     Overblog\GraphQLBundle\Definition\ConfigProcessor\AclConfigProcessor:
         arguments:
             - '@Overblog\GraphQLBundle\Resolver\AccessResolver'
-            - "%overblog_graphql.default_resolver%"
+            - "@overblog_graphql.default_field_resolver"
         tags:
             - { name: overblog_graphql.definition_config_processor, priority: 512 }
 

src/Resources/config/services.yaml

@@ -8,13 +8,14 @@ services:
     Overblog\GraphQLBundle\Definition\GlobalVariables: ~
     GraphQL\Executor\Promise\Adapter\SyncPromiseAdapter: ~
     Overblog\GraphQLBundle\Executor\Promise\Adapter\ReactPromiseAdapter: ~
+    Overblog\GraphQLBundle\Resolver\FieldResolver: ~
 
     Overblog\GraphQLBundle\Request\Executor:
         arguments:
             - "@overblog_graphql.executor"
             - "@overblog_graphql.promise_adapter"
             - "@event_dispatcher"
-            - '%overblog_graphql.default_resolver%'
+            - '@overblog_graphql.default_field_resolver'
             - "%overblog_graphql.use_experimental_executor%"
         calls:
             - ["setMaxQueryComplexity", ["%overblog_graphql.query_max_complexity%"]]

test.ini

@@ -18,6 +18,6 @@ public function __construct(PromiseAdapter $promiseAdapter)
 
     public function mutate()
     {
-        return $this->promiseAdapter->createFulfilled(['result' => 1]);
+        return $this->promiseAdapter->createFulfilled((object) ['result' => 1]);
     }
 }

tests/Functional/App/Mutation/SimplePromiseMutation.php

@@ -5,10 +5,10 @@
 namespace Overblog\GraphQLBundle\Tests\Resolver;
 
 use GraphQL\Type\Definition\ResolveInfo;
-use Overblog\GraphQLBundle\Resolver\Resolver;
+use Overblog\GraphQLBundle\Resolver\FieldResolver;
 use PHPUnit\Framework\TestCase;
 
-class ResolverTest extends TestCase
+class ResolverFieldTest extends TestCase
 {
     /**
      * @param $fieldName
@@ -17,24 +17,12 @@ class ResolverTest extends TestCase
      *
      * @dataProvider resolverProvider
      */
-    public function testDefaultResolveFn($fieldName, $source, $expected): void
+    public function testDefaultFieldResolveFn($fieldName, $source, $expected): void
     {
         $info = $this->getMockBuilder(ResolveInfo::class)->disableOriginalConstructor()->getMock();
         $info->fieldName = $fieldName;
 
-        $this->assertSame($expected, Resolver::defaultResolveFn($source, [], [], $info));
-    }
-
-    public function testSetObjectOrArrayValue(): void
-    {
-        $object = new \stdClass();
-        $object->foo = null;
-        Resolver::setObjectOrArrayValue($object, 'foo', 'bar');
-        $this->assertSame($object->foo, 'bar');
-
-        $data = ['foo' => null];
-        Resolver::setObjectOrArrayValue($data, 'foo', 'bar');
-        $this->assertSame($data['foo'], 'bar');
+        $this->assertSame($expected, (new FieldResolver())($source, [], [], $info));
     }
 
     public function resolverProvider()