Merge pull request #209 from moufmouf/optimize_controller_instantiations

Optimize controllers instantiations

Author: moufmouf

docs/CHANGELOG.md

@@ -4,7 +4,7 @@ title: Changelog
 sidebar_label: Changelog
 ---
 
-## 4.0-beta1
+## 4.0
 
 This is a complete refactoring from 3.x. While existing annotations are kept compatible, the internals have completely
 changed.

src/GlobControllerQueryProvider.php

@@ -9,9 +9,12 @@
 use Psr\Container\ContainerInterface;
 use Psr\SimpleCache\CacheInterface;
 use ReflectionClass;
+use ReflectionMethod;
 use Symfony\Component\Cache\Adapter\Psr16Adapter;
 use Symfony\Contracts\Cache\CacheInterface as CacheContractInterface;
 use TheCodingMachine\ClassExplorer\Glob\GlobClassExplorer;
+use TheCodingMachine\GraphQLite\Annotations\Mutation;
+use TheCodingMachine\GraphQLite\Annotations\Query;
 use Webmozart\Assert\Assert;
 use function class_exists;
 use function interface_exists;
@@ -45,13 +48,15 @@ final class GlobControllerQueryProvider implements QueryProviderInterface
     private $recursive;
     /** @var CacheContractInterface */
     private $cacheContract;
+    /** @var AnnotationReader */
+    private $annotationReader;
 
     /**
      * @param string             $namespace The namespace that contains the GraphQL types (they must have a `@Type` annotation)
      * @param ContainerInterface $container The container we will fetch controllers from.
      * @param bool               $recursive Whether subnamespaces of $namespace must be analyzed.
      */
-    public function __construct(string $namespace, FieldsBuilder $fieldsBuilder, ContainerInterface $container, CacheInterface $cache, ?ClassNameMapper $classNameMapper = null, ?int $cacheTtl = null, bool $recursive = true)
+    public function __construct(string $namespace, FieldsBuilder $fieldsBuilder, ContainerInterface $container, AnnotationReader $annotationReader, CacheInterface $cache, ?ClassNameMapper $classNameMapper = null, ?int $cacheTtl = null, bool $recursive = true)
     {
         $this->namespace       = $namespace;
         $this->container       = $container;
@@ -61,6 +66,7 @@ public function __construct(string $namespace, FieldsBuilder $fieldsBuilder, Con
         $this->cacheTtl        = $cacheTtl;
         $this->fieldsBuilder   = $fieldsBuilder;
         $this->recursive       = $recursive;
+        $this->annotationReader = $annotationReader;
     }
 
     private function getAggregateControllerQueryProvider(): AggregateControllerQueryProvider
@@ -105,6 +111,9 @@ private function buildInstancesList(): array
             if (! $refClass->isInstantiable()) {
                 continue;
             }
+            if (! $this->hasQueriesOrMutations($refClass)) {
+                continue;
+            }
             if (! $this->container->has($className)) {
                 continue;
             }
@@ -115,6 +124,24 @@ private function buildInstancesList(): array
         return $instances;
     }
 
+    /**
+     * @param ReflectionClass<object> $reflectionClass
+     */
+    private function hasQueriesOrMutations(ReflectionClass $reflectionClass): bool
+    {
+        foreach ($reflectionClass->getMethods(ReflectionMethod::IS_PUBLIC) as $refMethod) {
+            $queryAnnotation = $this->annotationReader->getRequestAnnotation($refMethod, Query::class);
+            if ($queryAnnotation !== null) {
+                return true;
+            }
+            $mutationAnnotation = $this->annotationReader->getRequestAnnotation($refMethod, Mutation::class);
+            if ($mutationAnnotation !== null) {
+                return true;
+            }
+        }
+        return false;
+    }
+
     /**
      * @return FieldDefinition[]
      */

src/SchemaFactory.php

@@ -435,6 +435,7 @@ public function createSchema(): Schema
                 $controllerNamespace,
                 $fieldsBuilder,
                 $this->container,
+                $annotationReader,
                 $this->cache,
                 $this->classNameMapper,
                 $this->globTtl

tests/Fixtures/TestController.php

@@ -13,6 +13,16 @@
 
 class TestController
 {
+    /**
+     * @Mutation
+     * @param TestObject $testObject
+     * @return TestObject
+     */
+    public function mutation(TestObject $testObject): TestObject
+    {
+        return $testObject;
+    }
+
     /**
      * @Query
      * @param int $int
@@ -39,16 +49,6 @@ public function test(int $int, array $list, ?bool $boolean, ?float $float, ?\Dat
         return new TestObject($string.$int.$str.($boolean?'true':'false').$float.$dateTimeImmutable->format('YmdHis').$dateTime->format('YmdHis').$withDefault.($id !== null ? $id->val() : '').$enum->getValue());
     }
 
-    /**
-     * @Mutation
-     * @param TestObject $testObject
-     * @return TestObject
-     */
-    public function mutation(TestObject $testObject): TestObject
-    {
-        return $testObject;
-    }
-
     /**
      * @Query
      * @Logged

tests/GlobControllerQueryProviderTest.php

@@ -36,7 +36,7 @@ public function has($id)
             }
         };
 
-        $globControllerQueryProvider = new GlobControllerQueryProvider('TheCodingMachine\\GraphQLite\\Fixtures', $this->getFieldsBuilder(), $container, new Psr16Cache(new NullAdapter()), null, false);
+        $globControllerQueryProvider = new GlobControllerQueryProvider('TheCodingMachine\\GraphQLite\\Fixtures', $this->getFieldsBuilder(), $container, $this->getAnnotationReader(), new Psr16Cache(new NullAdapter()), null, false, false);
 
         $queries = $globControllerQueryProvider->getQueries();
         $this->assertCount(7, $queries);

tests/Integration/EndToEndTest.php

@@ -90,7 +90,7 @@ public function createContainer(array $overloadedServices = []): ContainerInterf
             },
             QueryProviderInterface::class => function(ContainerInterface $container) {
                 return new GlobControllerQueryProvider('TheCodingMachine\\GraphQLite\\Fixtures\\Integration\\Controllers', $container->get(FieldsBuilder::class),
-                    $container->get(BasicAutoWiringContainer::class), new Psr16Cache(new ArrayAdapter()));
+                    $container->get(BasicAutoWiringContainer::class), $container->get(AnnotationReader::class), new Psr16Cache(new ArrayAdapter()));
             },
             FieldsBuilder::class => function(ContainerInterface $container) {
                 return new FieldsBuilder(