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

Completed
Pull Request — 0.13 (#745)
by Timur
12:56
created

OverblogGraphQLExtension::setErrorHandler()   A

Complexity

Conditions 4
Paths 4

Size

Total Lines 30
Code Lines 21

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 21
CRAP Score 4.0015

Importance

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