Merge pull request #198 from mcg-web/optimizations

Allow using project composer Classloader and some more optimizations

Author: mcg-web

.travis.yml

@@ -17,7 +17,7 @@ matrix:
         - php: 7.0
           env: SYMFONY_VERSION=3.2.*
         - php: 7.1
-          env: SYMFONY_VERSION=3.3.* SCRUTINIZER=true
+          env: SYMFONY_VERSION=3.3.* TEST_COVERAGE=true
         - php: 7.1
           env: GRAPHQLPHP_VERSION=0.10.0
         - php: hhvm
@@ -31,17 +31,17 @@ cache:
         - $HOME/.php_cs.cache
 
 before_install:
-    - if [[ ${SCRUTINIZER} != true && ${TRAVIS_PHP_VERSION} != "hhvm" ]]; then phpenv config-rm xdebug.ini || true; fi
+    - if [ ${TEST_COVERAGE} != true ]; then phpenv config-rm xdebug.ini || true; fi
     - composer selfupdate
     - if [ $SYMFONY_VERSION ]; then composer require "symfony/symfony:${SYMFONY_VERSION}" "symfony/framework-bundle:${SYMFONY_VERSION}" --dev --no-update; fi;
     - if [ $GRAPHQLPHP_VERSION ]; then composer require "webonyx/graphql-php:${GRAPHQLPHP_VERSION}" --dev --no-update; fi;
 
 install: composer update --prefer-source --no-interaction --optimize-autoloader
 
 script:
-    - bin/phpunit --debug $( if [ $SCRUTINIZER = true ]; then echo "-d xdebug.max_nesting_level=1000 --coverage-clover=build/logs/clover.xml"; fi; )
+    - bin/phpunit --debug $( if [ $TEST_COVERAGE = true ]; then echo "-d xdebug.max_nesting_level=1000 --coverage-clover=build/logs/clover.xml"; fi; )
     - if [ ${TRAVIS_PHP_VERSION} == "7.0" ]; then bin/php-cs-fixer fix --diff --dry-run -v; fi;
 
 after_script:
-    - if [ ${SCRUTINIZER} = true ]; then wget https://scrutinizer-ci.com/ocular.phar && php ocular.phar code-coverage:upload --format=php-clover build/logs/clover.xml; fi
-    - if [ ${SCRUTINIZER} = true ]; then composer require "satooshi/php-coveralls:^1.0" && travis_retry php bin/coveralls -v; fi
+    - if [ ${TEST_COVERAGE} = true ]; then wget https://scrutinizer-ci.com/ocular.phar && travis_retry php ocular.phar code-coverage:upload --format=php-clover build/logs/clover.xml; fi
+    - if [ ${TEST_COVERAGE} = true ]; then composer require "satooshi/php-coveralls:^1.0" && travis_retry php bin/coveralls -v; fi

CONTRIBUTING.md

@@ -0,0 +1,20 @@
+Contributing
+============
+
+Running tests
+--------------
+
+Install [phpunit](https://phpunit.de/manual/current/en/installation.html).
+
+In the bundle directory:
+
+```bash
+bin/phpunit
+```
+
+Giving some love to PHP CS
+---------------------------
+
+```bash
+bin/php-cs-fixer fix ./
+```

Config/Parser/YmlParser.php renamed to Config/Parser/YamlParser.php

@@ -16,9 +16,9 @@
 use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
 use Symfony\Component\Finder\SplFileInfo;
 use Symfony\Component\Yaml\Exception\ParseException;
-use Symfony\Component\Yaml\Parser as YamlParser;
+use Symfony\Component\Yaml\Parser;
 
-class YmlParser implements ParserInterface
+class YamlParser implements ParserInterface
 {
     private static $yamlParser;
 
@@ -31,7 +31,7 @@ class YmlParser implements ParserInterface
     public static function parse(SplFileInfo $file, ContainerBuilder $container)
     {
         if (null === self::$yamlParser) {
-            self::$yamlParser = new YamlParser();
+            self::$yamlParser = new Parser();
         }
 
         try {

DependencyInjection/Compiler/ConfigTypesPass.php

@@ -21,12 +21,22 @@ class ConfigTypesPass implements CompilerPassInterface
     public function process(ContainerBuilder $container)
     {
         $config = $container->getParameter('overblog_graphql_types.config');
-        $generatedClasses = $container->get('overblog_graphql.cache_compiler')->compile($this->processConfig($config));
+        $generatedClasses = $container->get('overblog_graphql.cache_compiler')->compile(
+            $this->processConfig($config),
+            $container->getParameter('overblog_graphql.use_classloader_listener')
+        );
 
         foreach ($generatedClasses as $class => $file) {
+            if (!class_exists($class)) {
+                throw new \RuntimeException(sprintf(
+                    'Type class %s not found. If you are using your own classLoader verify the path and the namespace please.',
+                        json_encode($class))
+                );
+            }
             $aliases = call_user_func($class.'::getAliases');
             $this->setTypeServiceDefinition($container, $class, $aliases);
         }
+        $container->getParameterBag()->remove('overblog_graphql_types.config');
     }
 
     private function setTypeServiceDefinition(ContainerBuilder $container, $class, array $aliases)

DependencyInjection/Compiler/MutationTaggedServiceMappingTaggedPass.php

@@ -18,11 +18,6 @@ protected function getTagName()
         return 'overblog_graphql.mutation';
     }
 
-    protected function getParameterName()
-    {
-        return 'overblog_graphql.mutations_mapping';
-    }
-
     protected function getResolverServiceID()
     {
         return 'overblog_graphql.mutation_resolver';

DependencyInjection/Compiler/ResolverTaggedServiceMappingPass.php

@@ -18,11 +18,6 @@ protected function getTagName()
         return 'overblog_graphql.resolver';
     }
 
-    protected function getParameterName()
-    {
-        return 'overblog_graphql.resolvers_mapping';
-    }
-
     protected function checkRequirements($id, array $tag)
     {
         parent::checkRequirements($id, $tag);

DependencyInjection/Compiler/TaggedServiceMappingPass.php

@@ -54,7 +54,6 @@ private function getTaggedServiceMapping(ContainerBuilder $container, $tagName)
     public function process(ContainerBuilder $container)
     {
         $mapping = $this->getTaggedServiceMapping($container, $this->getTagName());
-        $container->setParameter($this->getParameterName(), $mapping);
         $resolverDefinition = $container->findDefinition($this->getResolverServiceID());
 
         foreach ($mapping as $name => $options) {
@@ -101,6 +100,4 @@ protected function checkRequirements($id, array $tag)
     abstract protected function getTagName();
 
     abstract protected function getResolverServiceID();
-
-    abstract protected function getParameterName();
 }

DependencyInjection/Compiler/TypeTaggedServiceMappingPass.php

@@ -18,11 +18,6 @@ protected function getTagName()
         return 'overblog_graphql.type';
     }
 
-    protected function getParameterName()
-    {
-        return 'overblog_graphql.types_mapping';
-    }
-
     protected function getResolverServiceID()
     {
         return 'overblog_graphql.type_resolver';

DependencyInjection/Configuration.php

@@ -14,21 +14,26 @@
 use GraphQL\Validator\Rules\QueryComplexity;
 use GraphQL\Validator\Rules\QueryDepth;
 use Overblog\GraphQLBundle\Error\ErrorHandler;
+use Overblog\GraphQLBundle\Resolver\Resolver;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
 class Configuration implements ConfigurationInterface
 {
     private $debug;
 
+    private $cacheDir;
+
     /**
      * Constructor.
      *
-     * @param bool $debug Whether to use the debug mode
+     * @param bool        $debug    Whether to use the debug mode
+     * @param null|string $cacheDir
      */
-    public function __construct($debug)
+    public function __construct($debug, $cacheDir = null)
     {
         $this->debug = (bool) $debug;
+        $this->cacheDir = $cacheDir;
     }
 
     public function getConfigTreeBuilder()
@@ -46,6 +51,10 @@ public function getConfigTreeBuilder()
                     ->addDefaultsIfNotSet()
                     ->children()
                         ->scalarNode('internal_error_message')->defaultNull()->end()
+                        ->variableNode('default_resolver')->defaultValue([Resolver::class, 'defaultResolveFn'])->end()
+                        ->scalarNode('class_namespace')->defaultValue('Overblog\\GraphQLBundle\\__DEFINITIONS__')->end()
+                        ->scalarNode('cache_dir')->defaultValue($this->cacheDir.'/overblog/graphql-bundle/__definitions__')->end()
+                        ->booleanNode('use_classloader_listener')->defaultTrue()->end()
                         ->booleanNode('show_debug_info')->defaultFalse()->end()
                         ->booleanNode('config_validation')->defaultValue($this->debug)->end()
                         ->arrayNode('schema')
@@ -89,8 +98,18 @@ public function getConfigTreeBuilder()
                                 ->arrayNode('types')
                                     ->prototype('array')
                                         ->addDefaultsIfNotSet()
+                                        ->beforeNormalization()
+                                            ->ifTrue(function ($v) {
+                                                return isset($v['type']) && $v['type'] === 'yml';
+                                            })
+                                            ->then(function ($v) {
+                                                $v['type'] = 'yaml';
+
+                                                return $v;
+                                            })
+                                        ->end()
                                         ->children()
-                                            ->enumNode('type')->isRequired()->values(['yml', 'xml'])->end()
+                                            ->enumNode('type')->isRequired()->values(['yaml', 'xml'])->end()
                                             ->scalarNode('dir')->defaultNull()->end()
                                         ->end()
                                     ->end()
@@ -167,8 +186,8 @@ public function getConfigTreeBuilder()
                 ->arrayNode('versions')
                     ->addDefaultsIfNotSet()
                     ->children()
-                        ->scalarNode('graphiql')->defaultValue('0.9')->end()
-                        ->scalarNode('react')->defaultValue('15.4')->end()
+                        ->scalarNode('graphiql')->defaultValue('0.11')->end()
+                        ->scalarNode('react')->defaultValue('15.6')->end()
                         ->scalarNode('fetch')->defaultValue('2.0')->end()
                         ->enumNode('relay')->values(['modern', 'classic'])->defaultValue('classic')->end()
                     ->end()

DependencyInjection/OverblogGraphQLExtension.php

@@ -13,6 +13,7 @@
 
 use GraphQL\Type\Schema;
 use Overblog\GraphQLBundle\Config\TypeWithOutputFieldsDefinition;
+use Overblog\GraphQLBundle\EventListener\ClassLoaderListener;
 use Symfony\Component\Cache\Adapter\ArrayAdapter;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -45,7 +46,8 @@ public function load(array $configs, ContainerBuilder $container)
         $this->setConfigBuilders($config, $container);
         $this->setVersions($config, $container);
         $this->setShowDebug($config, $container);
-        $this->setAutoMappingParameters($config, $container);
+        $this->setDefinitionParameters($config, $container);
+        $this->setClassLoaderListener($config, $container);
 
         $container->setParameter($this->getAlias().'.resources_dir', realpath(__DIR__.'/../Resources'));
     }
@@ -68,13 +70,35 @@ public function getAlias()
 
     public function getConfiguration(array $config, ContainerBuilder $container)
     {
-        return new Configuration($container->getParameter('kernel.debug'));
+        return new Configuration(
+            $container->getParameter('kernel.debug'),
+            $container->hasParameter('kernel.cache_dir') ? $container->getParameter('kernel.cache_dir') : null
+        );
     }
 
-    private function setAutoMappingParameters(array $config, ContainerBuilder $container)
+    private function setClassLoaderListener(array $config, ContainerBuilder $container)
     {
+        $container->setParameter($this->getAlias().'.use_classloader_listener', $config['definitions']['use_classloader_listener']);
+        if ($config['definitions']['use_classloader_listener']) {
+            $definition = $container->setDefinition(
+                $this->getAlias().'.event_listener.classloader_listener',
+                new Definition(ClassLoaderListener::class)
+            );
+            $definition->setArguments([new Reference($this->getAlias().'.cache_compiler')]);
+            $definition->addTag('kernel.event_listener', ['event' => 'kernel.request', 'method' => 'load', 'priority' => 255]);
+            $definition->addTag('kernel.event_listener', ['event' => 'console.command', 'method' => 'load', 'priority' => 255]);
+        }
+    }
+
+    private function setDefinitionParameters(array $config, ContainerBuilder $container)
+    {
+        // auto mapping
         $container->setParameter($this->getAlias().'.auto_mapping.enabled', $config['definitions']['auto_mapping']['enabled']);
         $container->setParameter($this->getAlias().'.auto_mapping.directories', $config['definitions']['auto_mapping']['directories']);
+        // 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']);
     }
 
     private function setBatchingMethod(array $config, ContainerBuilder $container)