Configuration::servicesSection() - Code Metrics - Inspection of "Fix Symfony setDeprecated() arguments" - overblog/GraphQLBundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#762)

unknown
created 2020-10-08 10:50 UTC
Configuration::servicesSection() A

↳ Parent: Configuration
Complexity

Conditions	1
Paths	1
Size

Total Lines	25
Code Lines	18
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	18
CRAP Score	1
Importance

Changes
Metric	Value
eloc	18
c	0
b	0
f	0
dl	0
loc	25
ccs	18
cts	18
cp	1
rs	9.6666
cc	1
nc	1
nop	0
crap	1
<?php

declare(strict_types=1);

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\DependencyInjection\Compiler\ConfigParserPass;
use Overblog\GraphQLBundle\Error\ErrorHandler;
use Overblog\GraphQLBundle\EventListener\ErrorLoggerListener;
use Overblog\GraphQLBundle\Executor\Executor;
use Overblog\GraphQLBundle\ExpressionLanguage\ExpressionLanguage;
use Overblog\GraphQLBundle\Resolver\FieldResolver;
use Symfony\Component\Config\Definition\BaseNode;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\EnumNodeDefinition;
use Symfony\Component\Config\Definition\Builder\ScalarNodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;
use function array_keys;
use function is_array;
use function is_int;
use function is_numeric;
use function is_string;
use function sprintf;

class Configuration implements ConfigurationInterface
{
    public const NAME = 'overblog_graphql';

    private bool $debug;
    private ?string $cacheDir;

    /**
     * @param bool $debug Whether to use the debug mode
     */
    public function __construct(bool $debug, string $cacheDir = null)
    {
        $this->debug = (bool) $debug;
        $this->cacheDir = $cacheDir;
    }

    public function getConfigTreeBuilder(): TreeBuilder
    {
        $treeBuilder = new TreeBuilder(self::NAME);

        $rootNode = $treeBuilder->getRootNode();

        // @phpstan-ignore-next-line
        $rootNode
            ->children()
                ->append($this->batchingMethodSection())
                ->append($this->definitionsSection())
                ->append($this->errorsHandlerSection())
                ->append($this->servicesSection())
                ->append($this->securitySection())
                ->append($this->doctrineSection())
                ->append($this->profilerSection())
            ->end();

        return $treeBuilder;
    }

    private function batchingMethodSection(): EnumNodeDefinition
    {
        $builder = new TreeBuilder('batching_method', 'enum');

        /** @var EnumNodeDefinition $node */
        $node = $builder->getRootNode();

        $node
            ->values(['relay', 'apollo'])
            ->defaultValue('relay')
        ->end();

        return $node;
    }

    private function errorsHandlerSection(): ArrayNodeDefinition
    {
        $builder = new TreeBuilder('errors_handler');

        /** @var ArrayNodeDefinition $node */
        $node = $builder->getRootNode();

        // @phpstan-ignore-next-line
        $node
            ->treatFalseLike(['enabled' => false])
            ->treatTrueLike(['enabled' => true])
            ->treatNullLike(['enabled' => true])
            ->addDefaultsIfNotSet()
            ->children()
                ->booleanNode('enabled')->defaultTrue()->end()
                ->scalarNode('internal_error_message')->defaultValue(ErrorHandler::DEFAULT_ERROR_MESSAGE)->end()
                ->/** @scrutinizer ignore-call */ scalarNode('internal_error_message')->defaultValue(ErrorHandler::DEFAULT_ERROR_MESSAGE)->end()
                ->booleanNode('rethrow_internal_exceptions')->defaultFalse()->end()
                ->booleanNode('debug')->defaultValue($this->debug)->end()
                ->booleanNode('log')->defaultTrue()->end()
                ->scalarNode('logger_service')->defaultValue(ErrorLoggerListener::DEFAULT_LOGGER_SERVICE)->end()
                ->booleanNode('map_exceptions_to_parent')->defaultFalse()->end()
                ->arrayNode('exceptions')
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->arrayNode('warnings')
                            ->treatNullLike([])
                            ->prototype('scalar')->end()
                        ->end()
                        ->arrayNode('errors')
                            ->treatNullLike([])
                            ->prototype('scalar')->end()
                    ->end()
                ->end()
            ->end();

        return $node;
    }

    private function definitionsSection(): ArrayNodeDefinition
    {
        $builder = new TreeBuilder('definitions');
        /** @var ArrayNodeDefinition $node */
        $node = $builder->getRootNode();

        // @phpstan-ignore-next-line
        $node
            ->addDefaultsIfNotSet()
            ->children()
                ->scalarNode('argument_class')->defaultValue(Argument::class)->end()
                ->scalarNode('use_experimental_executor')->defaultFalse()->end()
                ->scalarNode('default_field_resolver')->defaultValue(FieldResolver::class)->end()
                ->scalarNode('class_namespace')->defaultValue('Overblog\\GraphQLBundle\\__DEFINITIONS__')->end()
                ->scalarNode('cache_dir')->defaultNull()->end()
                ->scalarNode('cache_dir_permissions')->defaultNull()->end()
                ->booleanNode('use_classloader_listener')->defaultTrue()->end()
                ->scalarNode('auto_compile')->defaultTrue()->end()
                ->booleanNode('show_debug_info')->info('Show some performance stats in extensions')->defaultFalse()->end()
                ->booleanNode('config_validation')->defaultValue($this->debug)->end()
                ->append($this->definitionsSchemaSection())
                ->append($this->definitionsMappingsSection())
                ->arrayNode('builders')
                    ->children()
                        ->append($this->builderSection('field'))
                        ->append($this->builderSection('fields'))
                        ->append($this->builderSection('args'))
                    ->end()
                ->end()

            ->end()
        ->end();

        return $node;
    }

    private function servicesSection(): ArrayNodeDefinition
    {
        $builder = new TreeBuilder('services');

        /** @var ArrayNodeDefinition $node */
        $node = $builder->getRootNode();

        // @phpstan-ignore-next-line
        $node
            ->addDefaultsIfNotSet()
            ->children()
                ->scalarNode('executor')
                    ->defaultValue(Executor::class)
                ->end()
                ->scalarNode('promise_adapter')
                    ->defaultValue(SyncPromiseAdapter::class)
                ->end()
                ->scalarNode('expression_language')
                    ->defaultValue(ExpressionLanguage::class)
                ->end()
                ->scalarNode('cache_expression_language_parser')->end()
            ->end()
        ->end();

        return $node;
    }

    private function securitySection(): ArrayNodeDefinition
    {
        $builder = new TreeBuilder('security');

        /** @var ArrayNodeDefinition $node */
        $node = $builder->getRootNode();

        // @phpstan-ignore-next-line
        $node
            ->addDefaultsIfNotSet()
            ->children()
                ->append($this->securityQuerySection('query_max_depth', QueryDepth::DISABLED))
                ->append($this->securityQuerySection('query_max_complexity', QueryComplexity::DISABLED))
                ->booleanNode('enable_introspection')->defaultTrue()->end()
                ->booleanNode('handle_cors')->defaultFalse()->end()
                ->/** @scrutinizer ignore-call */ booleanNode('handle_cors')->defaultFalse()->end()
            ->end()
        ->end();

        return $node;
    }

    private function definitionsSchemaSection(): ArrayNodeDefinition
    {
        $builder = new TreeBuilder('schema');

        /** @var ArrayNodeDefinition $node */
        $node = $builder->getRootNode();

        // @phpstan-ignore-next-line
        $node
            ->beforeNormalization()
                ->ifTrue(fn ($v) => isset($v['query']) && is_string($v['query']) || isset($v['mutation']) && is_string($v['mutation']))
                ->then(fn ($v) => ['default' => $v])
            ->end()
            ->useAttributeAsKey('name')
            ->/** @scrutinizer ignore-call */ useAttributeAsKey('name')
            ->prototype('array')
                ->addDefaultsIfNotSet()
                ->children()
                    ->scalarNode('query')->defaultNull()->end()
                    ->scalarNode('mutation')->defaultNull()->end()
                    ->scalarNode('subscription')->defaultNull()->end()
                    ->arrayNode('resolver_maps')
                        ->defaultValue([])
                        ->prototype('scalar')->end()
                        ->setDeprecated(...$this->getDeprecationParameters('The "%path%.%node%" configuration is deprecated since version 0.13 and will be removed in 1.0. Add the "overblog_graphql.resolver_map" tag to the services instead.', '1.0'))
                    ->end()
                    ->arrayNode('types')
                        ->defaultValue([])
                        ->prototype('scalar')->end()
                    ->end()
                ->end()
            ->end()
        ->end();

        return $node;
    }

    private function definitionsMappingsSection(): ArrayNodeDefinition
    {
        $builder = new TreeBuilder('mappings');

        /** @var ArrayNodeDefinition $node */
        $node = $builder->getRootNode();

        // @phpstan-ignore-next-line
        $node
            ->children()
                ->arrayNode('auto_discover')
                    ->treatFalseLike(['bundles' => false, 'root_dir' => false, 'built_in' => true])
                    ->treatTrueLike(['bundles' => true, 'root_dir' => true, 'built_in' => true])
                    ->treatNullLike(['bundles' => true, 'root_dir' => true, 'built_in' => true])
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->booleanNode('bundles')->defaultFalse()->end()
                        ->booleanNode('root_dir')->defaultFalse()->end()
                        ->booleanNode('built_in')->defaultTrue()->end()
                    ->end()
                ->end()
                ->arrayNode('types')
                    ->prototype('array')
                        ->addDefaultsIfNotSet()
                        ->beforeNormalization()
                            ->ifTrue(function ($v) {
                                return isset($v['type']) && is_string($v['type']);
                            })
                            ->then(function ($v) {
                                if ('yml' === $v['type']) {
                                    $v['types'] = ['yaml'];
                                } else {
                                    $v['types'] = [$v['type']];
                                }
                                unset($v['type']);

                                return $v;
                            })
                        ->end()
                        ->children()
                            ->arrayNode('types')
                                ->prototype('enum')->values(array_keys(ConfigParserPass::SUPPORTED_TYPES_EXTENSIONS))->isRequired()->end()
                            ->end()
                            ->scalarNode('dir')->defaultNull()->end()
                            ->scalarNode('suffix')->defaultValue(ConfigParserPass::DEFAULT_TYPES_SUFFIX)->end()
                        ->end()
                    ->end()
                ->end()
            ->end()
        ;

        return $node;
    }

    private function doctrineSection(): ArrayNodeDefinition
    {
        $builder = new TreeBuilder('doctrine');

        /** @var ArrayNodeDefinition $node */
        $node = $builder->getRootNode();

        // @phpstan-ignore-next-line
        $node
            ->addDefaultsIfNotSet()
            ->children()
                ->arrayNode('types_mapping')
                    ->defaultValue([])
                    ->prototype('scalar')->end()
                ->end()
                ->/** @scrutinizer ignore-call */ end()
            ->end()
        ;

        return $node;
    }

    private function profilerSection(): ArrayNodeDefinition
    {
        $builder = new TreeBuilder('profiler');

        /** @var ArrayNodeDefinition $node */
        $node = $builder->getRootNode();

        // @phpstan-ignore-next-line
        $node
            ->addDefaultsIfNotSet()
            ->children()
                ->scalarNode('query_match')->defaultNull()->end()
            ->end()
        ;

        return $node;
    }

    private function builderSection(string $name): ArrayNodeDefinition
    {
        $builder = new TreeBuilder($name);

        /** @var ArrayNodeDefinition $node */
        $node = $builder->getRootNode();

        $node->beforeNormalization()
            ->ifTrue(fn ($v) => is_array($v) && !empty($v))
            ->then(function ($v) {
                foreach ($v as $key => &$config) {
                    if (is_string($config)) {
                        $config = [
                            'alias' => $key,
                            'class' => $config,
                        ];
                    }
                }

                return $v;
            })
        ->end();

        // @phpstan-ignore-next-line
        $node->prototype('array')
            ->children()
                ->scalarNode('alias')->isRequired()->end()
                ->scalarNode('class')->isRequired()->end()
            ->end()
        ->end()
        ;

        return $node;
    }

    /**
     * @param mixed $disabledValue
     */
    private function securityQuerySection(string $name, $disabledValue): ScalarNodeDefinition
    {
        $builder = new TreeBuilder($name, 'scalar');

        /** @var ScalarNodeDefinition $node */
        $node = $builder->getRootNode();

        $node->beforeNormalization()
                ->ifTrue(fn ($v) => is_string($v) && is_numeric($v))
                ->then(fn ($v) => (int) $v)
            ->end();

        $node
            ->info('Disabled if equal to false.')
            ->beforeNormalization()
                ->ifTrue(fn ($v) => false === $v)
                ->then(fn () => $disabledValue)
            ->end()
            ->defaultValue($disabledValue)
            ->validate()
                ->ifTrue(fn ($v) => is_int($v) && $v < 0)
                ->thenInvalid(sprintf('"%s.security.%s" must be greater or equal to 0.', self::NAME, $name))
            ->end()
        ;

        return $node;
    }

    /**
     * Returns the correct deprecation parameters for setDeprecated.
     *
     * @param string $message
     * @param string $version
     *
     * @return string[]
     */
    private function getDeprecationParameters($message, $version)
    {
        if (method_exists(BaseNode::class, 'getDeprecation')) {
            return ['overblog/graphql-bundle', $version, $message];
        }

        return [$message];
    }
}

overblog / GraphQLBundle

Scrutinizer GitHub App not installed

Pull Request — master (#762)

Configuration::servicesSection() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
