Merge pull request #149 from flow-control/make-classNameMapper-injectable-in-3.0

Backport classNameMapper injectability from #144 to graphqlite v3

Author: moufmouf

src/GlobControllerQueryProvider.php

@@ -39,6 +39,10 @@ final class GlobControllerQueryProvider implements QueryProviderInterface
      * @var ContainerInterface
      */
     private $container;
+    /**
+     * @var ClassNameMapper
+     */
+    private $classNameMapper;
     /**
      * @var AggregateControllerQueryProvider
      */
@@ -69,10 +73,11 @@ final class GlobControllerQueryProvider implements QueryProviderInterface
      * @param int|null $cacheTtl
      * @param bool $recursive Whether subnamespaces of $namespace must be analyzed.
      */
-    public function __construct(string $namespace, FieldsBuilderFactory $fieldsBuilderFactory, RecursiveTypeMapperInterface $recursiveTypeMapper, ContainerInterface $container, LockFactory $lockFactory, CacheInterface $cache, ?int $cacheTtl = null, bool $recursive = true)
+    public function __construct(string $namespace, FieldsBuilderFactory $fieldsBuilderFactory, RecursiveTypeMapperInterface $recursiveTypeMapper, ContainerInterface $container, LockFactory $lockFactory, CacheInterface $cache, ?ClassNameMapper $classNameMapper = null, ?int $cacheTtl = null, bool $recursive = true)
     {
         $this->namespace = $namespace;
         $this->container = $container;
+        $this->classNameMapper = $classNameMapper ?? ClassNameMapper::createFromComposerFile(null, null, true);
         $this->cache = $cache;
         $this->cacheTtl = $cacheTtl;
         $this->fieldsBuilderFactory = $fieldsBuilderFactory;
@@ -126,7 +131,7 @@ private function getInstancesList(): array
      */
     private function buildInstancesList(): array
     {
-        $explorer = new GlobClassExplorer($this->namespace, $this->cache, $this->cacheTtl, ClassNameMapper::createFromComposerFile(null, null, true), $this->recursive);
+        $explorer = new GlobClassExplorer($this->namespace, $this->cache, $this->cacheTtl, $this->classNameMapper, $this->recursive);
         $classes = $explorer->getClasses();
         $instances = [];
         foreach ($classes as $className) {

src/Mappers/GlobTypeMapper.php

@@ -126,15 +126,20 @@ final class GlobTypeMapper implements TypeMapperInterface
      * @var LockFactory
      */
     private $lockFactory;
+    /**
+     * @var ClassNameMapper
+     */
+    private $classNameMapper;
 
     /**
      * @param string $namespace The namespace that contains the GraphQL types (they must have a `@Type` annotation)
      */
-    public function __construct(string $namespace, TypeGenerator $typeGenerator, InputTypeGenerator $inputTypeGenerator, InputTypeUtils $inputTypeUtils, ContainerInterface $container, AnnotationReader $annotationReader, NamingStrategyInterface $namingStrategy, LockFactory $lockFactory, CacheInterface $cache, ?int $globTtl = 2, ?int $mapTtl = null, bool $recursive = true)
+    public function __construct(string $namespace, TypeGenerator $typeGenerator, InputTypeGenerator $inputTypeGenerator, InputTypeUtils $inputTypeUtils, ContainerInterface $container, AnnotationReader $annotationReader, NamingStrategyInterface $namingStrategy, LockFactory $lockFactory, CacheInterface $cache, ClassNameMapper $classNameMapper = null, ?int $globTtl = 2, ?int $mapTtl = null, bool $recursive = true)
     {
         $this->namespace = $namespace;
         $this->typeGenerator = $typeGenerator;
         $this->container = $container;
+        $this->classNameMapper = $classNameMapper ?? ClassNameMapper::createFromComposerFile(null, null, true);
         $this->annotationReader = $annotationReader;
         $this->namingStrategy = $namingStrategy;
         $this->cache = $cache;
@@ -288,7 +293,7 @@ private function getClassList(): array
     {
         if ($this->classes === null) {
             $this->classes = [];
-            $explorer = new GlobClassExplorer($this->namespace, $this->cache, $this->globTtl, ClassNameMapper::createFromComposerFile(null, null, true), $this->recursive);
+            $explorer = new GlobClassExplorer($this->namespace, $this->cache, $this->globTtl, $this->classNameMapper, $this->recursive);
             $classes = $explorer->getClasses();
             foreach ($classes as $className) {
                 if (!\class_exists($className)) {

src/SchemaFactory.php

@@ -10,6 +10,7 @@
 use Doctrine\Common\Cache\ApcuCache;
 use function extension_loaded;
 use GraphQL\Type\SchemaConfig;
+use Mouf\Composer\ClassNameMapper;
 use Psr\Container\ContainerInterface;
 use Psr\SimpleCache\CacheInterface;
 use Symfony\Component\Lock\Factory as LockFactory;
@@ -74,6 +75,10 @@ class SchemaFactory
      * @var ContainerInterface
      */
     private $container;
+    /**
+     * @var ClassNameMapper
+     */
+    private $classNameMapper;
     /**
      * @var SchemaConfig
      */
@@ -180,6 +185,12 @@ public function setSchemaConfig(SchemaConfig $schemaConfig): self
         return $this;
     }
 
+    public function setClassNameMapper(ClassNameMapper $classNameMapper): self
+    {
+        $this->classNameMapper = $classNameMapper;
+        return $this;
+    }
+
     public function createSchema(): Schema
     {
         $annotationReader = new AnnotationReader($this->getDoctrineAnnotationReader(), AnnotationReader::LAX_MODE);
@@ -210,7 +221,7 @@ public function createSchema(): Schema
 
         foreach ($this->typeNamespaces as $typeNamespace) {
             $typeMappers[] = new GlobTypeMapper($typeNamespace, $typeGenerator, $inputTypeGenerator, $inputTypeUtils,
-                $this->container, $annotationReader, $namingStrategy, $lockFactory, $this->cache);
+                $this->container, $annotationReader, $namingStrategy, $lockFactory, $this->cache, $this->classNameMapper);
         }
 
         foreach ($this->typeMappers as $typeMapper) {
@@ -229,7 +240,7 @@ public function createSchema(): Schema
         $queryProviders = [];
         foreach ($this->controllerNamespaces as $controllerNamespace) {
             $queryProviders[] = new GlobControllerQueryProvider($controllerNamespace, $fieldsBuilderFactory, $recursiveTypeMapper,
-                $this->container, $lockFactory, $this->cache);
+                $this->container, $lockFactory, $this->cache, $this->classNameMapper);
         }
 
         foreach ($this->queryProviders as $queryProvider) {

tests/SchemaFactoryTest.php

@@ -5,11 +5,14 @@
 use GraphQL\Error\Debug;
 use GraphQL\GraphQL;
 use GraphQL\Type\SchemaConfig;
+use Mouf\Composer\ClassNameMapper;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Cache\Simple\ArrayCache;
 use Symfony\Component\Cache\Simple\PhpFilesCache;
 use TheCodingMachine\GraphQLite\Containers\BasicAutoWiringContainer;
 use TheCodingMachine\GraphQLite\Containers\EmptyContainer;
 use TheCodingMachine\GraphQLite\Hydrators\FactoryHydrator;
+use TheCodingMachine\GraphQLite\Mappers\CannotMapTypeException;
 use TheCodingMachine\GraphQLite\Mappers\CompositeTypeMapper;
 use TheCodingMachine\GraphQLite\Security\VoidAuthenticationService;
 use TheCodingMachine\GraphQLite\Security\VoidAuthorizationService;
@@ -57,10 +60,47 @@ public function testSetters(): void
         $this->doTestSchema($schema);
     }
 
+    public function testClassNameMapperInjectionWithValidMapper(): void
+    {
+        $factory = new SchemaFactory(
+            new ArrayCache(),
+            new BasicAutoWiringContainer(
+                new EmptyContainer()
+            )
+        );
+        $factory->setAuthenticationService(new VoidAuthenticationService())
+                ->setAuthorizationService(new VoidAuthorizationService())
+                ->setClassNameMapper(ClassNameMapper::createFromComposerFile(null, null, true))
+                ->addControllerNamespace('TheCodingMachine\\GraphQLite\\Fixtures\\Integration\\Controllers')
+                ->addTypeNamespace('TheCodingMachine\\GraphQLite\\Fixtures\\Integration');
+
+        $schema = $factory->createSchema();
+
+        $this->doTestSchema($schema);
+    }
+
+    public function testClassNameMapperInjectionWithInvalidMapper(): void
+    {
+        $factory = new SchemaFactory(
+            new ArrayCache(),
+            new BasicAutoWiringContainer(
+                new EmptyContainer()
+            )
+        );
+        $factory->setAuthenticationService(new VoidAuthenticationService())
+                ->setAuthorizationService(new VoidAuthorizationService())
+                ->setClassNameMapper(new ClassNameMapper())
+                ->addControllerNamespace('TheCodingMachine\\GraphQLite\\Fixtures\\Integration\\Controllers')
+                ->addTypeNamespace('TheCodingMachine\\GraphQLite\\Fixtures\\Integration');
+
+        $this->expectException(\TypeError::class);
+        $this->doTestSchema($factory->createSchema());
+    }
+
     public function testException(): void
     {
         $container = new BasicAutoWiringContainer(new EmptyContainer());
-        $cache = new PhpFilesCache();
+        $cache = new ArrayCache();
 
         $factory = new SchemaFactory($cache, $container);
 
@@ -71,7 +111,7 @@ public function testException(): void
     public function testException2(): void
     {
         $container = new BasicAutoWiringContainer(new EmptyContainer());
-        $cache = new PhpFilesCache();
+        $cache = new ArrayCache();
 
         $factory = new SchemaFactory($cache, $container);
         $factory->addTypeNamespace('TheCodingMachine\\GraphQLite\\Fixtures\\Integration');