Merge pull request #502 from mcg-web/services_refactor

Refactor services definitions

Author: mcg-web

.gitignore

@@ -7,6 +7,7 @@ composer.lock
 composer.phar
 .php_cs.cache
 .php_cs
+.phpunit.result.cache
 
 phpbench.phar
 phpbench.phar.pubkey

.travis.yml

@@ -34,9 +34,9 @@ jobs:
         - php: 7.1
           env: SYMFONY_VERSION=3.4.*
         - php: 7.2
-          env: SYMFONY_VERSION=4.0.*
+          env: SYMFONY_VERSION=4.0.* PHPUNIT_VERSION=^7.2
         - php: 7.2
-          env: SYMFONY_VERSION=4.1.*
+          env: SYMFONY_VERSION=4.1.* PHPUNIT_VERSION=^7.2
         - php: 7.3
           env: SYMFONY_VERSION=4.2.*
         - php: 7.3

composer.json

@@ -50,7 +50,7 @@
     },
     "require-dev": {
         "doctrine/orm": "^2.5",
-        "phpunit/phpunit": "^5.7.26 || ^6.0 || ^7.2",
+        "phpunit/phpunit": "^7.2 || ^8.2",
         "react/promise": "^2.5",
         "symfony/asset": "^3.4 || ^4.0",
         "symfony/browser-kit": "^3.4 || ^4.0",

lib/generator/tests/Generator/TypeGeneratorModeTest.php

@@ -13,13 +13,14 @@
 
 use Overblog\GraphQLGenerator\Generator\TypeGenerator;
 use Overblog\GraphQLGenerator\Tests\TestCase;
+use PHPUnit\Framework\MockObject\MockObject;
 
 class TypeGeneratorModeTest extends TestCase
 {
     /** @var string */
     private $dir;
 
-    /** @var TypeGenerator|\PHPUnit_Framework_MockObject_MockObject */
+    /** @var TypeGenerator|MockObject */
     private $typeGenerator;
 
     private const CONFIG = [

lib/generator/tests/Generator/TypeGeneratorTest.php

@@ -18,43 +18,35 @@
 use GraphQL\Type\Definition\ObjectType;
 use GraphQL\Type\Definition\StringType;
 use GraphQL\Type\Definition\Type;
+use Overblog\GraphQLGenerator\Generator\TypeGenerator;
 
 class TypeGeneratorTest extends AbstractTypeGeneratorTest
 {
-    /**
-     * @expectedException \InvalidArgumentException
-     * @expectedExceptionMessage Skeleton dir "fake" not found.
-     */
     public function testWrongSetSkeletonDirs(): void
     {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('Skeleton dir "fake" not found.');
         $this->typeGenerator->setSkeletonDirs(['fake']);
     }
 
-    /**
-     * @expectedException \InvalidArgumentException
-     * @expectedExceptionMessage Skeleton dir must be string or object implementing __toString, "array" given.
-     */
     public function testWrongAddSkeletonDir(): void
     {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('Skeleton dir must be string or object implementing __toString, "array" given.');
         $this->typeGenerator->addSkeletonDir([]);
     }
 
-    /**
-     * @expectedException \InvalidArgumentException
-     * @expectedExceptionMessage Skeleton dirs must be array or object implementing \Traversable interface, "object" given.
-     */
     public function testWrongObjectSetSkeletonDir(): void
     {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('Skeleton dirs must be array or object implementing \Traversable interface, "object" given.');
         $this->typeGenerator->setSkeletonDirs(new \stdClass());
     }
 
-
-    /**
-     * @expectedException \InvalidArgumentException
-     * @expectedExceptionMessageRegExp  /Skeleton "fake" could not be found in .*\/skeleton./
-     */
     public function testWrongGetSkeletonDirs(): void
     {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessageRegExp('/Skeleton "fake" could not be found in .*\/skeleton./');
         $this->typeGenerator->getSkeletonContent('fake');
     }
 
@@ -88,12 +80,10 @@ public function testTypeAlias2String(): void
         );
     }
 
-    /**
-     * @expectedException \RuntimeException
-     * @expectedExceptionMessage Malformed ListOf wrapper type "[String" expected "]" but got "g".
-     */
     public function testTypeAlias2StringInvalidListOf(): void
     {
+        $this->expectException(\RuntimeException::class);
+        $this->expectExceptionMessage('Malformed ListOf wrapper type "[String" expected "]" but got "g".');
         $this->generateClasses([
             'T' => [
                 'type' => 'object',
@@ -158,12 +148,13 @@ public function testCallbackEntryDoesNotTreatObject(): void
         $this->assertEquals(['result' => 1], $resolveFn());
     }
 
-    /**
-     * @expectedException \RuntimeException
-     * @expectedExceptionMessage Generator [Overblog\GraphQLGenerator\Generator\TypeGenerator::generateFake] for placeholder "fake" is not callable.
-     */
     public function testProcessInvalidPlaceHoldersReplacements(): void
     {
+        $this->expectException(\RuntimeException::class);
+        $this->expectExceptionMessage(\sprintf(
+            'Generator [%s::generateFake] for placeholder "fake" is not callable.',
+            TypeGenerator::class
+            ));
         $this->typeGenerator->setSkeletonDirs(__DIR__.'/../Resources/Skeleton');
 
         $this->generateClasses($this->getConfigs());

src/DependencyInjection/Compiler/ConfigTypesPass.php

@@ -5,6 +5,7 @@
 namespace Overblog\GraphQLBundle\DependencyInjection\Compiler;
 
 use GraphQL\Type\Definition\Type;
+use Overblog\GraphQLBundle\Definition\Builder\TypeFactory;
 use Overblog\GraphQLBundle\Generator\TypeGenerator;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -27,7 +28,7 @@ public function process(ContainerBuilder $container): void
     private function setTypeServiceDefinition(ContainerBuilder $container, $class, $alias): void
     {
         $definition = $container->setDefinition($class, new Definition(Type::class));
-        $definition->setFactory([new Reference('overblog_graphql.type_factory'), 'create']);
+        $definition->setFactory([new Reference(TypeFactory::class), 'create']);
         $definition->setPublic(false);
         $definition->setArguments([$class]);
         $definition->addTag(TypeTaggedServiceMappingPass::TAG_NAME, ['alias' => $alias, 'generated' => true]);

src/DependencyInjection/Configuration.php

@@ -4,11 +4,14 @@
 
 namespace Overblog\GraphQLBundle\DependencyInjection;
 
+use GraphQL\Executor\Promise\Adapter\SyncPromiseAdapter;
 use GraphQL\Validator\Rules\QueryComplexity;
 use GraphQL\Validator\Rules\QueryDepth;
 use Overblog\GraphQLBundle\Definition\Argument;
 use Overblog\GraphQLBundle\Error\ErrorHandler;
 use Overblog\GraphQLBundle\EventListener\ErrorLoggerListener;
+use Overblog\GraphQLBundle\Executor\Executor;
+use Overblog\GraphQLBundle\ExpressionLanguage\ExpressionLanguage;
 use Overblog\GraphQLBundle\Resolver\Resolver;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\Config\Definition\Builder\EnumNodeDefinition;
@@ -148,13 +151,13 @@ private function servicesSection()
             ->addDefaultsIfNotSet()
             ->children()
                 ->scalarNode('executor')
-                    ->defaultValue(self::NAME.'.executor.default')
+                    ->defaultValue(Executor::class)
                 ->end()
                 ->scalarNode('promise_adapter')
-                    ->defaultValue(self::NAME.'.promise_adapter.default')
+                    ->defaultValue(SyncPromiseAdapter::class)
                 ->end()
                 ->scalarNode('expression_language')
-                    ->defaultValue(self::NAME.'.expression_language.default')
+                    ->defaultValue(ExpressionLanguage::class)
                 ->end()
                 ->scalarNode('cache_expression_language_parser')->end()
             ->end()

src/DependencyInjection/OverblogGraphQLExtension.php

@@ -8,6 +8,7 @@
 use GraphQL\Type\Schema;
 use Overblog\GraphQLBundle\CacheWarmer\CompileCacheWarmer;
 use Overblog\GraphQLBundle\Config\Processor\BuilderProcessor;
+use Overblog\GraphQLBundle\Definition\Builder\SchemaBuilder;
 use Overblog\GraphQLBundle\Error\ErrorHandler;
 use Overblog\GraphQLBundle\Error\UserWarning;
 use Overblog\GraphQLBundle\Event\Events;
@@ -16,6 +17,7 @@
 use Overblog\GraphQLBundle\EventListener\ErrorHandlerListener;
 use Overblog\GraphQLBundle\EventListener\ErrorLoggerListener;
 use Overblog\GraphQLBundle\EventListener\TypeDecoratorListener;
+use Overblog\GraphQLBundle\Request\Executor;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\ContainerInterface;
@@ -74,11 +76,14 @@ public function getConfiguration(array $config, ContainerBuilder $container)
     private function loadConfigFiles(ContainerBuilder $container): void
     {
         $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
-        $loader->load('services.yml');
-        $loader->load('graphql_types.yml');
-        $loader->load('graphql_resolvers.yml');
-        $loader->load('expression_language_functions.yml');
-        $loader->load('definition_config_processors.yml');
+        $loader->load('services.yaml');
+        $loader->load('commands.yaml');
+        $loader->load('listeners.yaml');
+        $loader->load('graphql_types.yaml');
+        $loader->load('graphql_resolvers.yaml');
+        $loader->load('expression_language_functions.yaml');
+        $loader->load('definition_config_processors.yaml');
+        $loader->load('aliases.yaml');
     }
 
     private function setCompilerCacheWarmer(array $config, ContainerBuilder $container): void
@@ -161,7 +166,7 @@ private function treatConfigs(array $configs, ContainerBuilder $container, $forc
 
     private function setSecurity(array $config, ContainerBuilder $container): void
     {
-        $executorDefinition = $container->getDefinition($this->getAlias().'.request_executor');
+        $executorDefinition = $container->getDefinition(Executor::class);
         if ($config['security']['enable_introspection']) {
             $executorDefinition->addMethodCall('enableIntrospectionQuery');
         } else {
@@ -206,14 +211,14 @@ private function setErrorHandler(array $config, ContainerBuilder $container): vo
 
     private function setSchemaBuilderArguments(array $config, ContainerBuilder $container): void
     {
-        $container->getDefinition($this->getAlias().'.schema_builder')
+        $container->getDefinition(SchemaBuilder::class)
             ->replaceArgument(1, $config['definitions']['config_validation']);
     }
 
     private function setSchemaArguments(array $config, ContainerBuilder $container): void
     {
         if (isset($config['definitions']['schema'])) {
-            $executorDefinition = $container->getDefinition($this->getAlias().'.request_executor');
+            $executorDefinition = $container->getDefinition(Executor::class);
             $typeDecoratorListenerDefinition = $container->getDefinition(TypeDecoratorListener::class);
 
             foreach ($config['definitions']['schema'] as $schemaName => $schemaConfig) {

src/Resources/config/aliases.yaml

@@ -0,0 +1,21 @@
+services:
+    _defaults:
+        public: true
+
+    overblog_graphql.type_resolver: '@Overblog\GraphQLBundle\Resolver\TypeResolver'
+    overblog_graphql.resolver_resolver: '@Overblog\GraphQLBundle\Resolver\ResolverResolver'
+    overblog_graphql.mutation_resolver: '@Overblog\GraphQLBundle\Resolver\MutationResolver'
+    overblog_graphql.access_resolver: '@Overblog\GraphQLBundle\Resolver\AccessResolver'
+    overblog_graphql.cache_compiler: '@Overblog\GraphQLBundle\Generator\TypeGenerator'
+    overblog_graphql.react.promise_adapter: '@Overblog\GraphQLBundle\Executor\Promise\Adapter\ReactPromiseAdapter'
+    overblog_graphql.request_executor: '@Overblog\GraphQLBundle\Request\Executor'
+    overblog_graphql.request_parser: '@Overblog\GraphQLBundle\Request\Parser'
+    overblog_graphql.request_batch_parser: '@Overblog\GraphQLBundle\Request\BatchParser'
+
+    overblog_graphql.schema_builder:
+        alias: 'Overblog\GraphQLBundle\Definition\Builder\SchemaBuilder'
+        public: false
+
+    overblog_graphql.type_factory:
+        alias: 'Overblog\GraphQLBundle\Definition\Builder\TypeFactory'
+        public: false

src/Resources/config/commands.yaml

@@ -0,0 +1,30 @@
+services:
+    _defaults:
+        public: true
+
+    Overblog\GraphQLBundle\Command\GraphQLDumpSchemaCommand:
+        arguments:
+            - "%kernel.root_dir%"
+            - '@Overblog\GraphQLBundle\Request\Executor'
+        tags:
+            - { name: console.command, command: graphql:dump-schema, alias: "graph:dump-schema" }
+
+    Overblog\GraphQLBundle\Command\DebugCommand:
+        arguments:
+            - '@Overblog\GraphQLBundle\Resolver\TypeResolver'
+            - '@Overblog\GraphQLBundle\Resolver\MutationResolver'
+            - '@Overblog\GraphQLBundle\Resolver\ResolverResolver'
+        tags:
+            - { name: console.command, command: graphql:debug, alias: "debug:graphql" }
+
+    Overblog\GraphQLBundle\Command\CompileCommand:
+        arguments:
+            - '@Overblog\GraphQLBundle\Generator\TypeGenerator'
+        tags:
+            - { name: console.command, command: graphql:compile }
+
+    Overblog\GraphQLBundle\Command\ValidateCommand:
+        arguments:
+            - '@Overblog\GraphQLBundle\Request\Executor'
+        tags:
+            - { name: console.command, command: graphql:validate }

src/Resources/config/definition_config_processors.yml renamed to src/Resources/config/definition_config_processors.yaml

@@ -1,23 +1,17 @@
 services:
     Overblog\GraphQLBundle\Definition\ConfigProcessor\PublicFieldsFilterConfigProcessor:
-        class: Overblog\GraphQLBundle\Definition\ConfigProcessor\PublicFieldsFilterConfigProcessor
-        public: false
         tags:
             - { name: overblog_graphql.definition_config_processor, priority: 2048 }
 
     Overblog\GraphQLBundle\Definition\ConfigProcessor\AclConfigProcessor:
-        class: Overblog\GraphQLBundle\Definition\ConfigProcessor\AclConfigProcessor
         arguments:
-            - '@overblog_graphql.access_resolver'
+            - '@Overblog\GraphQLBundle\Resolver\AccessResolver'
             - "%overblog_graphql.default_resolver%"
-        public: false
         tags:
             - { name: overblog_graphql.definition_config_processor, priority: 512 }
 
     Overblog\GraphQLBundle\Definition\ConfigProcessor\WrapArgumentConfigProcessor:
-        class: Overblog\GraphQLBundle\Definition\ConfigProcessor\WrapArgumentConfigProcessor
         arguments:
             - '@Overblog\GraphQLBundle\Definition\ArgumentFactory'
-        public: false
         tags:
             - { name: overblog_graphql.definition_config_processor }

src/Resources/config/expression_language_functions.yaml

@@ -0,0 +1,53 @@
+services:
+    _defaults:
+        tags:
+            - { name: overblog_graphql.expression_function }
+
+    # Authorization
+    Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\Security\GetUser: ~
+    Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\Security\HasAnyPermission: ~
+    Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\Security\HasAnyRole: ~
+    Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\Security\HasPermission: ~
+    Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\Security\HasRole: ~
+    Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\Security\IsAnonymous: ~
+    Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\Security\IsAuthenticated: ~
+    Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\Security\IsFullyAuthenticated: ~
+    Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\Security\IsRememberMe: ~
+
+    # Config
+    Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\DependencyInjection\Parameter: ~
+    Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\DependencyInjection\Service: ~
+    Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\GraphQL\IsTypeOf: ~
+    Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\GraphQL\Mutation: ~
+    Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\GraphQL\Resolver: ~
+    Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\NewObject: ~
+    Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\Call: ~
+    Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\GraphQL\Arguments: ~
+
+    # relay
+    Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\GraphQL\Relay\FromGlobalID: ~
+    Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\GraphQL\Relay\GlobalID: ~
+    Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\GraphQL\Relay\IdFetcherCallback: ~
+    Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\GraphQL\Relay\MutateAndGetPayloadCallback: ~
+    Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\GraphQL\Relay\ResolveSingleInputCallback: ~
+
+    # aliases
+    expression_function.parameter_alias:
+        parent: Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\DependencyInjection\Parameter
+        arguments:
+            - param
+
+    expression_function.service_alias:
+        parent: Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\DependencyInjection\Service
+        arguments:
+            - serv
+
+    expression_function.mutation_alias:
+        parent: Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\GraphQL\Mutation
+        arguments:
+            - mut
+
+    expression_function.resolver_alias:
+        parent: Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\GraphQL\Resolver
+        arguments:
+            - res