Scrutinizer GitHub App not installed

We could not synchronize checks via GitHub's checks API since Scrutinizer's GitHub App is not installed for this repository.

Install GitHub App

Passed
Pull Request — master (#615)
by Stefano
23:11 queued 05:01
created

OverblogGraphQLExtension::setBatchingMethod()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 0
Metric Value
eloc 1
dl 0
loc 3
ccs 2
cts 2
cp 1
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 2
crap 1
1
<?php
2
3
declare(strict_types=1);
4
5
namespace Overblog\GraphQLBundle\DependencyInjection;
6
7
use GraphQL\Error\UserError;
8
use GraphQL\Type\Definition\Type;
9
use GraphQL\Type\Schema;
10
use Overblog\GraphQLBundle\CacheWarmer\CompileCacheWarmer;
11
use Overblog\GraphQLBundle\Config\Processor\BuilderProcessor;
12
use Overblog\GraphQLBundle\Definition\Builder\SchemaBuilder;
13
use Overblog\GraphQLBundle\Definition\Resolver\MutationInterface;
14
use Overblog\GraphQLBundle\Definition\Resolver\ResolverInterface;
15
use Overblog\GraphQLBundle\Error\ErrorHandler;
16
use Overblog\GraphQLBundle\Error\ExceptionConverter;
17
use Overblog\GraphQLBundle\Error\ExceptionConverterInterface;
18
use Overblog\GraphQLBundle\Error\UserWarning;
19
use Overblog\GraphQLBundle\Event\Events;
20
use Overblog\GraphQLBundle\EventListener\ClassLoaderListener;
21
use Overblog\GraphQLBundle\EventListener\DebugListener;
22
use Overblog\GraphQLBundle\EventListener\ErrorHandlerListener;
23
use Overblog\GraphQLBundle\EventListener\ErrorLoggerListener;
24
use Overblog\GraphQLBundle\Request\Executor;
25
use Overblog\GraphQLBundle\Resolver\ResolverMapInterface;
26
use Overblog\GraphQLBundle\Validator\ValidatorFactory;
27
use Symfony\Component\Config\FileLocator;
28
use Symfony\Component\DependencyInjection\ContainerBuilder;
29
use Symfony\Component\DependencyInjection\ContainerInterface;
30
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
31
use Symfony\Component\DependencyInjection\Reference;
32
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
33
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
34
35
class OverblogGraphQLExtension extends Extension
36
{
37 42
    public function load(array $configs, ContainerBuilder $container): void
38
    {
39 42
        $this->loadConfigFiles($container);
40 42
        $configuration = $this->getConfiguration($configs, $container);
41 42
        $config = $this->processConfiguration($configuration, $configs);
42
43 42
        $this->setBatchingMethod($config, $container);
44 42
        $this->setServicesAliases($config, $container);
45 42
        $this->setSchemaBuilderArguments($config, $container);
46 42
        $this->setSchemaArguments($config, $container);
47 42
        $this->setErrorHandler($config, $container);
48 42
        $this->setSecurity($config, $container);
49 42
        $this->setConfigBuilders($config, $container);
50 42
        $this->setDebugListener($config, $container);
51 42
        $this->setDefinitionParameters($config, $container);
52 42
        $this->setClassLoaderListener($config, $container);
53 42
        $this->setCompilerCacheWarmer($config, $container);
54 42
        $this->registerForAutoconfiguration($container);
55 42
        $this->setDefaultFieldResolver($config, $container);
56 42
        $this->registerValidatorFactory($container);
57
58 42
        $container->setParameter($this->getAlias().'.config', $config);
59 42
        $container->setParameter($this->getAlias().'.resources_dir', \realpath(__DIR__.'/../Resources'));
60 42
    }
61
62 42
    public function getAlias()
63
    {
64 42
        return Configuration::NAME;
65
    }
66
67 42
    public function getConfiguration(array $config, ContainerBuilder $container)
68
    {
69 42
        return new Configuration(
70 42
            $container->getParameter('kernel.debug'),
71 42
            $container->hasParameter('kernel.cache_dir') ? $container->getParameter('kernel.cache_dir') : null
72
        );
73
    }
74
75 42
    private function loadConfigFiles(ContainerBuilder $container): void
76
    {
77 42
        $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
78 42
        $loader->load('services.yaml');
79 42
        $loader->load('commands.yaml');
80 42
        $loader->load('listeners.yaml');
81 42
        $loader->load('graphql_types.yaml');
82 42
        $loader->load('graphql_resolvers.yaml');
83 42
        $loader->load('expression_language_functions.yaml');
84 42
        $loader->load('definition_config_processors.yaml');
85 42
        $loader->load('aliases.yaml');
86 42
    }
87
88 42
    private function registerForAutoconfiguration(ContainerBuilder $container): void
89
    {
90 42
        $container->registerForAutoconfiguration(MutationInterface::class)
91 42
            ->addTag('overblog_graphql.mutation');
92
93 42
        $container->registerForAutoconfiguration(ResolverInterface::class)
94 42
            ->addTag('overblog_graphql.resolver');
95
96 42
        $container->registerForAutoconfiguration(ResolverMapInterface::class)
97 42
            ->addTag('overblog_graphql.resolver_map');
98
99 42
        $container->registerForAutoconfiguration(Type::class)
100 42
            ->addTag('overblog_graphql.type');
101 42
    }
102
103 42
    private function registerValidatorFactory(ContainerBuilder $container): void
104
    {
105 42
        if (\class_exists('Symfony\\Component\\Validator\\Validation')) {
106 42
            $container->register(ValidatorFactory::class)
107 42
                ->setArguments([
108 42
                    new Reference('validator.validator_factory'),
109 42
                    new Reference('translator.default', $container::NULL_ON_INVALID_REFERENCE),
110
                ])
111 42
                ->addTag(
112 42
                    'overblog_graphql.global_variable',
113
                    [
114 42
                        'alias' => 'validatorFactory',
115
                        'public' => false,
116
                    ]
117
                );
118
        }
119 42
    }
120
121 42
    private function setDefaultFieldResolver(array $config, ContainerBuilder $container): void
122
    {
123 42
        $container->setAlias($this->getAlias().'.default_field_resolver', $config['definitions']['default_field_resolver']);
124 42
    }
125
126 42
    private function setCompilerCacheWarmer(array $config, ContainerBuilder $container): void
127
    {
128 42
        $container->register(CompileCacheWarmer::class)
129 42
            ->setArguments([
130 42
                new Reference($this->getAlias().'.cache_compiler'),
131 42
                $config['definitions']['auto_compile'],
132
            ])
133 42
            ->addTag('kernel.cache_warmer', ['priority' => 50])
134
        ;
135 42
    }
136
137 42
    private function setClassLoaderListener(array $config, ContainerBuilder $container): void
138
    {
139 42
        $container->setParameter($this->getAlias().'.use_classloader_listener', $config['definitions']['use_classloader_listener']);
140 42
        if ($config['definitions']['use_classloader_listener']) {
141 41
            $definition = $container->register(
142 41
                $this->getAlias().'.event_listener.classloader_listener',
143 41
                ClassLoaderListener::class
144
            );
145 41
            $definition->setPublic(true);
146 41
            $definition->setArguments([new Reference($this->getAlias().'.cache_compiler')]);
147 41
            $definition->addTag('kernel.event_listener', ['event' => 'kernel.request', 'method' => 'load', 'priority' => 255]);
148 41
            $definition->addTag('kernel.event_listener', ['event' => 'console.command', 'method' => 'load', 'priority' => 255]);
149
        }
150 42
    }
151
152 42
    private function setDefinitionParameters(array $config, ContainerBuilder $container): void
153
    {
154
        // generator and config
155 42
        $container->setParameter($this->getAlias().'.class_namespace', $config['definitions']['class_namespace']);
156 42
        $container->setParameter($this->getAlias().'.cache_dir', $config['definitions']['cache_dir']);
157 42
        $container->setParameter($this->getAlias().'.cache_dir_permissions', $config['definitions']['cache_dir_permissions']);
158 42
        $container->setParameter($this->getAlias().'.argument_class', $config['definitions']['argument_class']);
159 42
        $container->setParameter($this->getAlias().'.use_experimental_executor', $config['definitions']['use_experimental_executor']);
160 42
    }
161
162 42
    private function setBatchingMethod(array $config, ContainerBuilder $container): void
163
    {
164 42
        $container->setParameter($this->getAlias().'.batching_method', $config['batching_method']);
165 42
    }
166
167 42
    private function setDebugListener(array $config, ContainerBuilder $container): void
168
    {
169 42
        if ($config['definitions']['show_debug_info']) {
170 1
            $definition = $container->register(DebugListener::class);
171 1
            $definition->addTag('kernel.event_listener', ['event' => Events::PRE_EXECUTOR, 'method' => 'onPreExecutor']);
172 1
            $definition->addTag('kernel.event_listener', ['event' => Events::POST_EXECUTOR, 'method' => 'onPostExecutor']);
173
        }
174 42
    }
175
176 42
    private function setConfigBuilders(array $config, ContainerBuilder $container): void
177
    {
178 42
        foreach (BuilderProcessor::BUILDER_TYPES as $type) {
179 42
            if (!empty($config['definitions']['builders'][$type])) {
180 5
                foreach ($config['definitions']['builders'][$type] as $params) {
181 5
                    $container->addObjectResource($params['class']);
182 5
                    BuilderProcessor::addBuilderClass($params['alias'], $type, $params['class']);
183
                }
184
            }
185
        }
186 42
    }
187
188 42
    private function setSecurity(array $config, ContainerBuilder $container): void
189
    {
190 42
        $executorDefinition = $container->getDefinition(Executor::class);
191 42
        if ($config['security']['enable_introspection']) {
192 41
            $executorDefinition->addMethodCall('enableIntrospectionQuery');
193
        } else {
194 1
            $executorDefinition->addMethodCall('disableIntrospectionQuery');
195
        }
196
197 42
        foreach ($config['security'] as $key => $value) {
198 42
            $container->setParameter(\sprintf('%s.%s', $this->getAlias(), $key), $value);
199
        }
200 42
    }
201
202 42
    private function setErrorHandler(array $config, ContainerBuilder $container): void
203
    {
204 42
        if (!$config['errors_handler']['enabled']) {
205
            return;
206
        }
207
208 42
        $container->register(ExceptionConverter::class)
209 42
            ->setArgument(0, $this->buildExceptionMap($config['errors_handler']['exceptions']))
210 42
            ->setArgument(1, $config['errors_handler']['map_exceptions_to_parent']);
211
212 42
        $container->register(ErrorHandler::class)
213 42
            ->setArgument(0, new Reference(EventDispatcherInterface::class))
214 42
            ->setArgument(1, new Reference(ExceptionConverterInterface::class));
215
216 42
        $container->register(ErrorHandlerListener::class)
217 42
            ->setArgument(0, new Reference(ErrorHandler::class))
218 42
            ->setArgument(1, $config['errors_handler']['rethrow_internal_exceptions'])
219 42
            ->setArgument(2, $config['errors_handler']['debug'])
220 42
            ->addTag('kernel.event_listener', ['event' => Events::POST_EXECUTOR, 'method' => 'onPostExecutor']);
221
222 42
        $container->setAlias(ExceptionConverterInterface::class, ExceptionConverter::class);
223
224 42
        if ($config['errors_handler']['log']) {
225 42
            $loggerServiceId = $config['errors_handler']['logger_service'];
226 42
            $invalidBehavior = ErrorLoggerListener::DEFAULT_LOGGER_SERVICE === $loggerServiceId ? ContainerInterface::NULL_ON_INVALID_REFERENCE : ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE;
227
228 42
            $container->register(ErrorLoggerListener::class)
229 42
                ->setPublic(true)
230 42
                ->addArgument(new Reference($loggerServiceId, $invalidBehavior))
231 42
                ->addTag('kernel.event_listener', ['event' => Events::ERROR_FORMATTING, 'method' => 'onErrorFormatting']);
232
        }
233 42
    }
234
235 42
    private function setSchemaBuilderArguments(array $config, ContainerBuilder $container): void
236
    {
237 42
        $container->getDefinition(SchemaBuilder::class)
238 42
            ->replaceArgument(1, $config['definitions']['config_validation']);
239 42
    }
240
241 42
    private function setSchemaArguments(array $config, ContainerBuilder $container): void
242
    {
243 42
        if (!isset($config['definitions']['schema'])) {
244
            return;
245
        }
246
247 42
        $executorDefinition = $container->getDefinition(Executor::class);
248 42
        $resolverMapsBySchema = [];
249
250 42
        foreach ($config['definitions']['schema'] as $schemaName => $schemaConfig) {
251
            // builder
252 34
            $schemaBuilderID = \sprintf('%s.schema_builder_%s', $this->getAlias(), $schemaName);
253 34
            $definition = $container->register($schemaBuilderID, \Closure::class);
254 34
            $definition->setFactory([new Reference('overblog_graphql.schema_builder'), 'getBuilder']);
255 34
            $definition->setArguments([
256 34
                $schemaName,
257 34
                $schemaConfig['query'],
258 34
                $schemaConfig['mutation'],
259 34
                $schemaConfig['subscription'],
260 34
                $schemaConfig['types'],
261
            ]);
262
            // schema
263 34
            $schemaID = \sprintf('%s.schema_%s', $this->getAlias(), $schemaName);
264 34
            $definition = $container->register($schemaID, Schema::class);
265 34
            $definition->setFactory([new Reference($schemaBuilderID), 'call']);
266
267 34
            $executorDefinition->addMethodCall('addSchemaBuilder', [$schemaName, new Reference($schemaBuilderID)]);
268
269 34
            $resolverMapsBySchema[$schemaName] = $schemaConfig['resolver_maps'];
270
        }
271
272 42
        $container->setParameter(\sprintf('%s.resolver_maps', $this->getAlias()), $resolverMapsBySchema);
273 42
    }
274
275 42
    private function setServicesAliases(array $config, ContainerBuilder $container): void
276
    {
277 42
        if (isset($config['services'])) {
278 42
            foreach ($config['services'] as $name => $id) {
279 42
                $alias = \sprintf('%s.%s', $this->getAlias(), $name);
280 42
                $container->setAlias($alias, $id);
281
            }
282
        }
283 42
    }
284
285
    /**
286
     * Returns a list of custom exceptions mapped to error/warning classes.
287
     *
288
     * @param array<string, string[]> $exceptionConfig
289
     *
290
     * @return array<string, string> Custom exception map, [exception => UserError/UserWarning]
291
     */
292 42
    private function buildExceptionMap(array $exceptionConfig): array
293
    {
294 42
        $exceptionMap = [];
295
        $errorsMapping = [
296 42
            'errors' => UserError::class,
297
            'warnings' => UserWarning::class,
298
        ];
299
300 42
        foreach ($exceptionConfig as $type => $exceptionList) {
301 42
            foreach ($exceptionList as $exception) {
302 2
                $exceptionMap[$exception] = $errorsMapping[$type];
303
            }
304
        }
305
306 42
        return $exceptionMap;
307
    }
308
}
309