Indragunawan\ApiRateLimitBundle\DependencyInjection\Configuration

Complexity

Total Complexity

7

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	4

Test Coverage

Coverage

90.48%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
C	getConfigTreeBuilder()	0	101	7

<?php

/*
 * This file is part of the ApiRateLimitBundle
 *
 * (c) Indra Gunawan <hello@indra.my.id>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Indragunawan\ApiRateLimitBundle\DependencyInjection;

use Indragunawan\ApiRateLimitBundle\Exception\RateLimitExceededException;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;
use Symfony\Component\HttpFoundation\Response;

/**
 * The configuration of the bundle.
 *
 * @author Indra Gunawan <hello@indra.my.id>
 */
final class Configuration implements ConfigurationInterface
{
    /**
     * {@inheritdoc}
     */
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder();
        $rootNode = $treeBuilder->root('indragunawan_api_rate_limit');

        $rootNode
            ->children()
                ->booleanNode('enabled')->defaultTrue()->end()
                ->scalarNode('storage')->defaultNull()->cannotBeEmpty()->end()
                ->scalarNode('cache')->defaultNull()->cannotBeEmpty()->end()
                ->arrayNode('header')
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->booleanNode('display')->defaultTrue()->end()
                        ->arrayNode('names')
                            ->addDefaultsIfNotSet()
                            ->children()
                                ->scalarNode('limit')->cannotBeEmpty()->defaultValue('X-RateLimit-Limit')->end()
                                ->scalarNode('remaining')->cannotBeEmpty()->defaultValue('X-RateLimit-Remaining')->end()
                                ->scalarNode('reset')->cannotBeEmpty()->defaultValue('X-RateLimit-Reset')->end()
                            ->end()
                        ->end()
                    ->end()
                ->end()
                ->arrayNode('throttle')
                    ->beforeNormalization()
                        ->ifTrue(function ($v) { return is_array($v) && (isset($v['limit']) || isset($v['period'])); })
                        ->then(function ($v) {
                            $v['default'] = [];
                            if (isset($v['limit'])) {
                                @trigger_error('The indragunawan_api_rate_limit.throttle.limit configuration key is deprecated since version v0.2.0 and will be removed in v0.3.0. Use the indragunawan_api_rate_limit.throttle.default.limit configuration key instead.', E_USER_DEPRECATED);

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

                                $v['default']['limit'] = $v['limit'];
                            }

                            if (isset($v['period'])) {
                                @trigger_error('The indragunawan_api_rate_limit.throttle.period configuration key is deprecated since version v0.2.0 and will be removed in v0.3.0. Use the indragunawan_api_rate_limit.throttle.default.period configuration key instead.', E_USER_DEPRECATED);

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

                                $v['default']['period'] = $v['period'];
                            }

                            return $v;
                        })
                    ->end()
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->integerNode('limit')->min(1)->defaultValue(60)->end()
                        ->integerNode('period')->min(1)->defaultValue(60)->end()
                        ->arrayNode('default')
                            ->addDefaultsIfNotSet()
                            ->children()
                                ->integerNode('limit')->min(1)->defaultValue(60)->end()
                                ->integerNode('period')->min(1)->defaultValue(60)->end()
                            ->end()
                        ->end()
                        ->arrayNode('roles')
                            ->useAttributeAsKey('name')
                            ->prototype('array')
                                ->children()
                                    ->integerNode('limit')->isRequired()->min(1)->end()
                                    ->integerNode('period')->isRequired()->min(1)->end()
                                ->end()
                            ->end()
                        ->end()
                    ->end()
                ->end()
                ->arrayNode('exception')
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->integerNode('status_code')
                            ->defaultValue(Response::HTTP_TOO_MANY_REQUESTS)
                            ->validate()
                            ->ifNotInArray(array_keys(Response::$statusTexts))
                                ->thenInvalid('Invalid status code "%s"')
                            ->end()
                        ->end()
                        ->scalarNode('message')->cannotBeEmpty()->defaultValue('API rate limit exceeded for %s.')->end()
                        ->scalarNode('custom_exception')
                            ->cannotBeEmpty()
                            ->defaultNull()
                            ->validate()
                            ->ifTrue(function ($v) {
                                if (!class_exists($v)) {
                                    return true;
                                }

                                if (!is_subclass_of($v, RateLimitExceededException::class)) {

Due to PHP Bug #53727, is_subclass_of might return inconsistent results on some PHP versions if \Indragunawan\ApiRateLimitBundle\Exception\RateLimitExceededException::class can be an interface. If so, you could instead use ReflectionClass::implementsInterface.

                                    return true;
                                }

                                return false;
                            })
                                ->thenInvalid('The class %s does not exist or not extend "Indragunawan\ApiRateLimitBundle\Exception\RateLimitExceededException" class.')
                            ->end()
                        ->end()
                    ->end()
                ->end()
            ->end();

        return $treeBuilder;
    }
}