Merge pull request #497 from mcg-web/experimental_executor

Allow using GraphQL experimental Coroutine executor

Author: mcg-web

.travis.yml

@@ -41,6 +41,8 @@ jobs:
           env: SYMFONY_VERSION=4.2.*
         - php: 7.3
           env: SYMFONY_VERSION=4.3.* SYMFONY_DEPRECATIONS_HELPER=max[total]=0
+        - php: 7.3
+          env: SYMFONY_VERSION=4.3.* USE_EXPERIMENTAL_EXECUTOR=1 SYMFONY_DEPRECATIONS_HELPER=max[total]=0
         - php: 7.3
           env: SYMFONY_VERSION=4.4.* STABILITY=dev SYMFONY_DEPRECATIONS_HELPER=max[total]=0
         - php: 7.3

README.md

@@ -44,6 +44,7 @@ Documentation
   - [GraphQL schema language](docs/definitions/graphql-schema-language.md)
   - [Schema](docs/definitions/schema.md)
   - [Resolver](docs/definitions/resolver.md)
+  - [Experimental coroutine executor](docs/definitions/coroutine-executor.md)
   - [Solving N+1 problem](docs/definitions/solving-n-plus-1-problem.md)
   - [Mutation](docs/definitions/mutation.md)
   - [Relay](docs/definitions/relay/index.md)

composer.json

@@ -38,7 +38,7 @@
         "symfony/framework-bundle": "^3.4 || ^4.0",
         "symfony/options-resolver": "^3.4 || ^4.0",
         "symfony/property-access": "^3.4 || ^4.0",
-        "webonyx/graphql-php": "^0.13.0"
+        "webonyx/graphql-php": "^0.13.5"
     },
     "replace": {
         "overblog/graphql-php-generator": "self.version"

docs/definitions/coroutine-executor.md

@@ -0,0 +1,11 @@
+Experimental coroutine executor
+================================
+
+[The experimental coroutine executor](https://github.com/webonyx/graphql-php/blob/0.13.x/UPGRADE.md#try-it-experimental-executor-with-improved-performance)
+can be enabled using configuration:
+
+```yaml
+overblog_graphql:
+    definitions:
+        use_experimental_executor: true
+```

docs/definitions/index.md

@@ -7,6 +7,7 @@
 
 ## Go further
 
+-   [Experimental coroutine executor](coroutine-executor.md)
 -   [Solving N+1 problem](solving-n-plus-1-problem.md)
 -   [Resolver](resolver.md)
 -   [Mutation](mutation.md)

phpunit.xml.dist

@@ -29,6 +29,7 @@
     <php>
       <ini name="error_reporting" value="-1" />
       <env name="SYMFONY_DEPRECATIONS_HELPER" value="999999" />
+      <env name="USE_EXPERIMENTAL_EXECUTOR" value="0" />
     </php>
     <listeners>
         <listener class="Symfony\Bridge\PhpUnit\SymfonyTestsListener" />

src/DependencyInjection/Configuration.php

@@ -118,6 +118,7 @@ private function definitionsSection()
             ->addDefaultsIfNotSet()
             ->children()
                 ->scalarNode('argument_class')->defaultValue(Argument::class)->end()
+                ->scalarNode('use_experimental_executor')->defaultFalse()->end()
                 ->variableNode('default_resolver')->defaultValue([Resolver::class, 'defaultResolveFn'])->end()
                 ->scalarNode('class_namespace')->defaultValue('Overblog\\GraphQLBundle\\__DEFINITIONS__')->end()
                 ->scalarNode('cache_dir')->defaultNull()->end()

src/DependencyInjection/OverblogGraphQLExtension.php

@@ -121,6 +121,7 @@ private function setDefinitionParameters(array $config, ContainerBuilder $contai
         $container->setParameter($this->getAlias().'.cache_dir', $config['definitions']['cache_dir']);
         $container->setParameter($this->getAlias().'.cache_dir_permissions', $config['definitions']['cache_dir_permissions']);
         $container->setParameter($this->getAlias().'.argument_class', $config['definitions']['argument_class']);
+        $container->setParameter($this->getAlias().'.use_experimental_executor', $config['definitions']['use_experimental_executor']);
     }
 
     private function setBatchingMethod(array $config, ContainerBuilder $container): void

src/Request/Executor.php

@@ -6,6 +6,7 @@
 
 use GraphQL\Executor\ExecutionResult;
 use GraphQL\Executor\Promise\PromiseAdapter;
+use GraphQL\GraphQL;
 use GraphQL\Type\Schema;
 use GraphQL\Validator\DocumentValidator;
 use GraphQL\Validator\Rules\DisableIntrospection;
@@ -34,16 +35,20 @@ class Executor
 
     private $defaultFieldResolver;
 
+    private $useExperimentalExecutor;
+
     public function __construct(
         ExecutorInterface $executor,
         PromiseAdapter $promiseAdapter,
         EventDispatcherInterface $dispatcher,
-        ?callable $defaultFieldResolver = null
+        ?callable $defaultFieldResolver = null,
+        bool $useExperimental = false
     ) {
         $this->executor = $executor;
         $this->promiseAdapter = $promiseAdapter;
         $this->dispatcher = $dispatcher;
         $this->defaultFieldResolver = $defaultFieldResolver;
+        $this->useExperimentalExecutor = $useExperimental;
     }
 
     public function setExecutor(ExecutorInterface $executor): self
@@ -122,6 +127,8 @@ public function disableIntrospectionQuery(): void
      */
     public function execute(?string $schemaName, array $request, $rootValue = null): ExecutionResult
     {
+        $this->useExperimentalExecutor ? GraphQL::useExperimentalExecutor() : GraphQL::useReferenceExecutor();
+
         $executorArgumentsEvent = $this->preExecute(
             $this->getSchema($schemaName),
             $request[ParserInterface::PARAM_QUERY] ?? null,

src/Resources/config/services.yaml

@@ -15,6 +15,7 @@ services:
             - "@overblog_graphql.promise_adapter"
             - "@event_dispatcher"
             - '%overblog_graphql.default_resolver%'
+            - "%overblog_graphql.use_experimental_executor%"
         calls:
             - ["setMaxQueryComplexity", ["%overblog_graphql.query_max_complexity%"]]
             - ["setMaxQueryDepth", ["%overblog_graphql.query_max_depth%"]]