Completed
Pull Request — master (#112)
by David
11:06 queued 05:28
created

HttplugExtension::configurePluginByName()   C

Complexity

Conditions 11
Paths 11

Size

Total Lines 56
Code Lines 44

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 36
CRAP Score 13.2594

Importance

Changes 5
Bugs 1 Features 1
Metric Value
c 5
b 1
f 1
dl 0
loc 56
ccs 36
cts 49
cp 0.7347
rs 6.5481
cc 11
eloc 44
nc 11
nop 5
crap 13.2594

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
3
namespace Http\HttplugBundle\DependencyInjection;
4
5
use Http\Client\Common\BatchClient;
6
use Http\Client\Common\FlexibleHttpClient;
7
use Http\Client\Common\HttpMethodsClient;
8
use Http\Client\Common\Plugin\AuthenticationPlugin;
9
use Http\Discovery\HttpAsyncClientDiscovery;
10
use Http\Discovery\HttpClientDiscovery;
11
use Http\HttplugBundle\ClientFactory\DummyClient;
12
use Http\HttplugBundle\ClientFactory\PluginClientFactory;
13
use Http\HttplugBundle\Collector\DebugPlugin;
14
use Http\Message\Authentication\BasicAuth;
15
use Http\Message\Authentication\Bearer;
16
use Http\Message\Authentication\Wsse;
17
use Psr\Http\Message\UriInterface;
18
use Symfony\Component\Config\FileLocator;
19
use Symfony\Component\DependencyInjection\ContainerBuilder;
20
use Symfony\Component\DependencyInjection\ContainerInterface;
21
use Symfony\Component\DependencyInjection\Definition;
22
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
23
use Symfony\Component\DependencyInjection\Reference;
24
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
25
26
/**
27
 * @author David Buchmann <[email protected]>
28
 * @author Tobias Nyholm <[email protected]>
29
 */
30
class HttplugExtension extends Extension
31
{
32
    /**
33
     * {@inheritdoc}
34
     */
35 9
    public function load(array $configs, ContainerBuilder $container)
36
    {
37 9
        $configuration = $this->getConfiguration($configs, $container);
38 9
        $config = $this->processConfiguration($configuration, $configs);
1 ignored issue
show
Bug introduced by
It seems like $configuration defined by $this->getConfiguration($configs, $container) on line 37 can be null; however, Symfony\Component\Depend...:processConfiguration() does not accept null, maybe add an additional type check?

Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code:

/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
Loading history...
39
40 9
        $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
41
42 9
        $loader->load('services.xml');
43 9
        $loader->load('plugins.xml');
44
45
        // Register default services
46 9
        foreach ($config['classes'] as $service => $class) {
47 9
            if (!empty($class)) {
48 1
                $container->register(sprintf('httplug.%s.default', $service), $class);
49 1
            }
50 9
        }
51
52
        // Set main aliases
53 9
        foreach ($config['main_alias'] as $type => $id) {
54 9
            $container->setAlias(sprintf('httplug.%s', $type), $id);
55 9
        }
56
57
        // Configure toolbar
58 9
        if ($this->isConfigEnabled($container, $config['profiling'])) {
59 6
            $loader->load('data-collector.xml');
60
61 6
            if (!empty($config['profiling']['formatter'])) {
62
                // Add custom formatter
63
                $container
64
                    ->getDefinition('httplug.collector.debug_collector')
65
                    ->replaceArgument(0, new Reference($config['profiling']['formatter']))
66
                ;
67
            }
68
69
            $container
70 6
                ->getDefinition('httplug.formatter.full_http_message')
71 6
                ->addArgument($config['profiling']['captured_body_length'])
72
            ;
73 6
        }
74
75 9
        $this->configureClients($container, $config);
76 9
        $this->configureSharedPlugins($container, $config['plugins']); // must be after clients, as clients.X.plugins might use plugins as templates that will be removed
77 9
        $this->configureAutoDiscoveryClients($container, $config);
78 9
    }
79
80
    /**
81
     * Configure client services.
82
     *
83
     * @param ContainerBuilder $container
84
     * @param array            $config
85
     */
86 9
    private function configureClients(ContainerBuilder $container, array $config)
87
    {
88 9
        $first = null;
89
90 9
        foreach ($config['clients'] as $name => $arguments) {
91 6
            if ($first === null) {
92
                // Save the name of the first configurated client.
93 6
                $first = $name;
94 6
            }
95
96 6
            $this->configureClient($container, $name, $arguments, $this->isConfigEnabled($container, $config['profiling']));
97 9
        }
98
99
        // If we have clients configured
100 9
        if ($first !== null) {
101
            // If we do not have a client named 'default'
102 6
            if (!isset($config['clients']['default'])) {
103
                // Alias the first client to httplug.client.default
104 6
                $container->setAlias('httplug.client.default', 'httplug.client.'.$first);
105 6
            }
106 6
        }
107 9
    }
108
109
    /**
110
     * @param ContainerBuilder $container
111
     * @param array            $config
112
     */
113 9
    private function configureSharedPlugins(ContainerBuilder $container, array $config)
114
    {
115 9
        if (!empty($config['authentication'])) {
116
            $this->configureAuthentication($container, $config['authentication']);
117
        }
118 9
        unset($config['authentication']);
119
120 9
        foreach ($config as $name => $pluginConfig) {
121 9
            $pluginId = 'httplug.plugin.'.$name;
122
123 9
            if ($this->isConfigEnabled($container, $pluginConfig)) {
124 9
                $def = $container->getDefinition($pluginId);
125 9
                $this->configurePluginByName($name, $def, $pluginConfig, $container, $pluginId);
126 9
            } else {
127 9
                $container->removeDefinition($pluginId);
128
            }
129 9
        }
130 9
    }
131
132
    /**
133
     * @param string           $name
134
     * @param Definition       $definition
135
     * @param array            $config
136
     * @param ContainerBuilder $container  In case we need to add additional services for this plugin
137
     * @param string           $serviceId  Service id of the plugin, in case we need to add additional services for this plugin.
138
     */
139 9
    private function configurePluginByName($name, Definition $definition, array $config, ContainerInterface $container, $serviceId)
140
    {
141
        switch ($name) {
142 9
            case 'cache':
143
                $definition
144
                    ->replaceArgument(0, new Reference($config['cache_pool']))
145
                    ->replaceArgument(1, new Reference($config['stream_factory']))
146
                    ->replaceArgument(2, $config['config']);
147
                break;
148 9
            case 'cookie':
149
                $definition->replaceArgument(0, new Reference($config['cookie_jar']));
150
                break;
151 9
            case 'decoder':
152 9
                $definition->addArgument([
153 9
                    'use_content_encoding' => $config['use_content_encoding'],
154 9
                ]);
155 9
                break;
156 9
            case 'history':
157
                $definition->replaceArgument(0, new Reference($config['journal']));
158
                break;
159 9
            case 'logger':
160 9
                $definition->replaceArgument(0, new Reference($config['logger']));
161 9
                if (!empty($config['formatter'])) {
162
                    $definition->replaceArgument(1, new Reference($config['formatter']));
163
                }
164 9
                break;
165 9
            case 'redirect':
166 9
                $definition->addArgument([
167 9
                    'preserve_header' => $config['preserve_header'],
168 9
                    'use_default_for_multiple' => $config['use_default_for_multiple'],
169 9
                ]);
170 9
                break;
171 9
            case 'retry':
172 9
                $definition->addArgument([
173 9
                    'retries' => $config['retry'],
174 9
                ]);
175 9
                break;
176 9
            case 'stopwatch':
177 9
                $definition->replaceArgument(0, new Reference($config['stopwatch']));
178 9
                break;
179
180
            /* client specific plugins */
181
182 3
            case 'add_host':
183 3
                $uriService = $serviceId.'.host_uri';
184 3
                $this->createUri($container, $uriService, $config['host']);
0 ignored issues
show
Compatibility introduced by
$container of type object<Symfony\Component...ion\ContainerInterface> is not a sub-type of object<Symfony\Component...ction\ContainerBuilder>. It seems like you assume a concrete implementation of the interface Symfony\Component\Depend...tion\ContainerInterface to be always present.

This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass.

Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type.

Loading history...
185 3
                $definition->replaceArgument(0, new Reference($uriService));
186 3
                $definition->replaceArgument(1, [
187 3
                    'replace' => $config['replace'],
188 3
                ]);
189 3
                break;
190
191
            default:
192
                throw new \InvalidArgumentException(sprintf('Internal exception: Plugin %s is not handled', $name));
193
        }
194 9
    }
195
196
    /**
197
     * @param ContainerBuilder $container
198
     * @param array            $config
199
     */
200
    private function configureAuthentication(ContainerBuilder $container, array $config)
201
    {
202
        foreach ($config as $name => $values) {
203
            $authServiceKey = sprintf('httplug.plugin.authentication.%s.auth', $name);
204
            switch ($values['type']) {
205
                case 'bearer':
206
                    $container->register($authServiceKey, Bearer::class)
207
                        ->addArgument($values['token']);
208
                    break;
209
                case 'basic':
210
                    $container->register($authServiceKey, BasicAuth::class)
211
                        ->addArgument($values['username'])
212
                        ->addArgument($values['password']);
213
                    break;
214
                case 'wsse':
215
                    $container->register($authServiceKey, Wsse::class)
216
                        ->addArgument($values['username'])
217
                        ->addArgument($values['password']);
218
                    break;
219
                case 'service':
220
                    $authServiceKey = $values['service'];
221
                    break;
222
                default:
223
                    throw new \LogicException(sprintf('Unknown authentication type: "%s"', $values['type']));
224
            }
225
226
            $container->register('httplug.plugin.authentication.'.$name, AuthenticationPlugin::class)
227
                ->addArgument(new Reference($authServiceKey));
228
        }
229
    }
230
231
    /**
232
     * @param ContainerBuilder $container
233
     * @param string           $clientName
234
     * @param array            $arguments
235
     * @param bool             $profiling
236
     */
237
    private function configureClient(ContainerBuilder $container, $clientName, array $arguments, $profiling)
238
    {
239
        $serviceId = 'httplug.client.'.$clientName;
240
241
        $plugins = [];
242
        foreach ($arguments['plugins'] as $plugin) {
243
            list($pluginName, $pluginConfig) = each($plugin);
244
            if ('reference' === $pluginName) {
245
                $plugins[] = $pluginConfig['id'];
246
            } elseif ('authentication' === $pluginName) {
0 ignored issues
show
Unused Code introduced by
This elseif statement is empty, and could be removed.

This check looks for the bodies of elseif statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete.

These elseif bodies can be removed. If you have an empty elseif but statements in the else branch, consider inverting the condition.

Loading history...
247
                // TODO handle custom authentication
248
            } else {
249
                $pluginServiceId = $serviceId.'.plugin.'.$pluginName;
250
                $def = clone $container->getDefinition('httplug.plugin'.'.'.$pluginName);
251
                $def->setAbstract(false);
252
                $this->configurePluginByName($pluginName, $def, $pluginConfig, $container, $pluginServiceId);
253
                $container->setDefinition($pluginServiceId, $def);
254
                $plugins[] = $pluginServiceId;
255
            }
256
        }
257
258
        $pluginClientOptions = [];
259
        if ($profiling) {
260
            // Add the stopwatch plugin
261
            if (!in_array('httplug.plugin.stopwatch', $arguments['plugins'])) {
262
                array_unshift($plugins, 'httplug.plugin.stopwatch');
263
            }
264
265
            // Tell the plugin journal what plugins we used
266
            $container
267
                ->getDefinition('httplug.collector.plugin_journal')
268
                ->addMethodCall('setPlugins', [$clientName, $plugins])
269
            ;
270
271
            $debugPluginServiceId = $this->registerDebugPlugin($container, $serviceId);
272
273
            $pluginClientOptions['debug_plugins'] = [new Reference($debugPluginServiceId)];
274
        }
275
276
        $container
277
            ->register($serviceId, DummyClient::class)
278
            ->setFactory([PluginClientFactory::class, 'createPluginClient'])
279
            ->addArgument(
280
                array_map(
281
                    function ($id) {
282
                        return new Reference($id);
283
                    },
284
                    $plugins
285
                )
286
            )
287
            ->addArgument(new Reference($arguments['factory']))
288
            ->addArgument($arguments['config'])
289
            ->addArgument($pluginClientOptions)
290
        ;
291
292
293
        /*
294
         * Decorate the client with clients from client-common
295
         */
296 View Code Duplication
        if ($arguments['flexible_client']) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
297
            $container
298
                ->register($serviceId.'.flexible', FlexibleHttpClient::class)
299
                ->addArgument(new Reference($serviceId.'.flexible.inner'))
300
                ->setPublic(false)
301
                ->setDecoratedService($serviceId)
302
            ;
303
        }
304
305 View Code Duplication
        if ($arguments['http_methods_client']) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
306
            $container
307
                ->register($serviceId.'.http_methods', HttpMethodsClient::class)
308
                ->setArguments([new Reference($serviceId.'.http_methods.inner'), new Reference('httplug.message_factory')])
309
                ->setPublic(false)
310
                ->setDecoratedService($serviceId)
311
            ;
312
        }
313
314 View Code Duplication
        if ($arguments['batch_client']) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
315
            $container
316
                ->register($serviceId.'.batch_client', BatchClient::class)
317
                ->setArguments([new Reference($serviceId.'.batch_client.inner')])
318
                ->setPublic(false)
319
                ->setDecoratedService($serviceId)
320
            ;
321
        }
322
    }
323
324
    /**
325
     * Create a URI object with the default URI factory.
326
     *
327
     * @param ContainerBuilder $container
328
     * @param string           $serviceId Name of the private service to create
329
     * @param string           $uri       String representation of the URI
330
     */
331
    private function createUri(ContainerBuilder $container, $serviceId, $uri)
332
    {
333
        $container
334
            ->register($serviceId, UriInterface::class)
335
            ->setPublic(false)
336
            ->setFactory([new Reference('httplug.uri_factory'), 'createUri'])
337
            ->addArgument($uri)
338
        ;
339
    }
340
341
    /**
342
     * Make the user can select what client is used for auto discovery. If none is provided, a service will be created
343
     * by finding a client using auto discovery.
344
     *
345
     * @param ContainerBuilder $container
346
     * @param array            $config
347
     */
348
    private function configureAutoDiscoveryClients(ContainerBuilder $container, array $config)
349
    {
350
        $httpClient = $config['discovery']['client'];
351
352 View Code Duplication
        if (!empty($httpClient)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
353
            if ($httpClient === 'auto') {
354
                $httpClient = $this->registerAutoDiscoverableClient(
355
                    $container,
356
                    'auto_discovered_client',
357
                    [HttpClientDiscovery::class, 'find'],
358
                    $this->isConfigEnabled($container, $config['profiling'])
359
                );
360
            }
361
362
            $httpClient = new Reference($httpClient);
363
        }
364
365
        $asyncHttpClient = $config['discovery']['async_client'];
366
367 View Code Duplication
        if (!empty($asyncHttpClient)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
368
            if ($asyncHttpClient === 'auto') {
369
                $asyncHttpClient = $this->registerAutoDiscoverableClient(
370
                    $container,
371
                    'auto_discovered_async',
372
                    [HttpAsyncClientDiscovery::class, 'find'],
373
                    $this->isConfigEnabled($container, $config['profiling'])
374
                );
375
            }
376
377
            $asyncHttpClient = new Reference($asyncHttpClient);
378
        }
379
380
        $container
381
            ->getDefinition('httplug.strategy')
382
            ->addArgument($httpClient)
383
            ->addArgument($asyncHttpClient)
384
        ;
385
    }
386
387
    /**
388
     * Find a client with auto discovery and return a service Reference to it.
389
     *
390
     * @param ContainerBuilder $container
391
     * @param string           $name
392
     * @param callable         $factory
393
     * @param bool             $profiling
394
     *
395
     * @return string service id
396
     */
397
    private function registerAutoDiscoverableClient(ContainerBuilder $container, $name, $factory, $profiling)
398
    {
399
        $serviceId = 'httplug.auto_discovery.'.$name;
400
401
        $pluginClientOptions = [];
402
403
        if ($profiling) {
404
            // Tell the plugin journal what plugins we used
405
            $container
406
                ->getDefinition('httplug.collector.plugin_journal')
407
                ->addMethodCall('setPlugins', [$name, ['httplug.plugin.stopwatch']])
408
            ;
409
410
            $debugPluginServiceId = $this->registerDebugPlugin($container, $serviceId);
411
412
            $pluginClientOptions['debug_plugins'] = [new Reference($debugPluginServiceId)];
413
        }
414
415
        $container
416
            ->register($serviceId, DummyClient::class)
417
            ->setFactory([PluginClientFactory::class, 'createPluginClient'])
418
            ->setArguments([[new Reference('httplug.plugin.stopwatch')], $factory, [], $pluginClientOptions])
419
        ;
420
421
        return $serviceId;
422
    }
423
424
    /**
425
     * Create a new plugin service for this client.
426
     *
427
     * @param ContainerBuilder $container
428
     * @param string           $serviceId
429
     *
430
     * @return string
431
     */
432
    private function registerDebugPlugin(ContainerBuilder $container, $serviceId)
433
    {
434
        $serviceIdDebugPlugin = $serviceId.'.debug_plugin';
435
436
        $container
437
            ->register($serviceIdDebugPlugin, DebugPlugin::class)
438
            ->addArgument(new Reference('httplug.collector.debug_collector'))
439
            ->addArgument(substr($serviceId, strrpos($serviceId, '.') + 1))
440
            ->setPublic(false)
441
        ;
442
443
        return $serviceIdDebugPlugin;
444
    }
445
446
    /**
447
     * {@inheritdoc}
448
     */
449
    public function getConfiguration(array $config, ContainerBuilder $container)
450
    {
451
        return new Configuration($container->getParameter('kernel.debug'));
452
    }
453
}
454