TaskExtension::load() - Code Metrics - Inspection of "Implemented retry-exectution for specific handler..." - php-task/TaskBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cfc46b...5a6c91 )

by Thomas

created 2017-08-22 12:56 UTC

TaskExtension::load() B

↳ Parent: TaskExtension

Complexity

Conditions	3
Paths	4

Size

Total Lines	27
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	19
CRAP Score	3.0077

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	27
ccs	19
cts	21
cp	0.9048
rs	8.8571
cc	3
eloc	18
nc	4
nop	2
crap	3.0077

<?php

/*
 * This file is part of php-task library.
 *
 * (c) php-task
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Task\TaskBundle\DependencyInjection;

use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\Config\Loader\LoaderInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\Loader;
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
use Task\Event\Events;
use Task\TaskBundle\EventListener\DoctrineTaskExecutionListener;

/**
 * Container extension for php-task library.
 */
class TaskExtension extends Extension
{
    /**
     * {@inheritdoc}
     */
    public function load(array $configs, ContainerBuilder $container)
    {
        $configuration = $this->getConfiguration($configs, $container);
        $config = $this->processConfiguration($configuration, $configs);
/** @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);
    }
}

        $container->setParameter('task.system_tasks', $config['system_tasks']);

        $container->setAlias('task.lock.storage', $configuration->getLockingStorageId($config['locking']['storage']));
        foreach (array_keys($config['locking']['storages']) as $key) {
            $container->setParameter('task.lock.storages.' . $key, $config['locking']['storages'][$key]);
        }

        $loader = new Loader\XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
        $loader->load(sprintf('storage/%s.xml', $config['storage']));
        $loader->load('task_event_listener.xml');
        $loader->load('scheduler.xml');
        $loader->load('command.xml');
        $loader->load('locking/services.xml');

        if ($config['run']['mode'] === 'listener') {
            $loader->load('listener.xml');
        }

        $this->loadDoctrineAdapter($config['adapters']['doctrine'], $container);
        $this->loadLockingComponent($config['locking'], $container, $loader);
        $this->loadExecutorComponent($config['executor'], $container, $loader);
    }

    /**
     * Load doctrine adapter.
     *
     * @param array $config
     * @param ContainerBuilder $container
     */
    private function loadDoctrineAdapter(array $config, ContainerBuilder $container)
    {
        if ($config['clear']) {
            $definition = new Definition(
                DoctrineTaskExecutionListener::class,
                [new Reference('doctrine.orm.entity_manager', ContainerInterface::IGNORE_ON_INVALID_REFERENCE)]
            );
            $definition->addTag(
                'kernel.event_listener',
                ['event' => Events::TASK_AFTER, 'method' => 'clearEntityManagerAfterTask']
            );
            $container->setDefinition('task.adapter.doctrine.execution_listener', $definition);
        }
    }

    /**
     * Load services for locking component.
     *
     * @param array $config
     * @param LoaderInterface $loader
     * @param ContainerBuilder $container
     */
    private function loadLockingComponent(array $config, ContainerBuilder $container, LoaderInterface $loader)
    {
        if (!$config['enabled']) {
            return $loader->load('locking/null.xml');
        }

        $loader->load('locking/services.xml');
        $container->setParameter('task.lock.ttl', $config['ttl']);
    }

    /**
     * Load services for executor component.
     *
     * @param array $config
     * @param LoaderInterface $loader
     * @param ContainerBuilder $container
     */
    private function loadExecutorComponent(array $config, ContainerBuilder $container, LoaderInterface $loader)
    {
        $loader->load('executor/' . $config['type'] . '.xml');
        $container->setAlias('task.executor', 'task.executor.' . $config['type']);

        if (!array_key_exists($config['type'], $config)) {
            return;
        }

        foreach ($config[$config['type']] as $key => $value) {
            $container->setParameter('task.executor.' . $key, $value);
        }

        if (!file_exists($container->getParameter('task.executor.console_path'))) {
            throw new InvalidConfigurationException(
                'Console file does not exists! Given in "task.executor.seperate.console".'
            );
        }
    }

    /**
     * Find storage aliases and related ids.
     *
     * @param ContainerBuilder $container
     *
     * @return array
     */
    private function getLockingStorageAliases(ContainerBuilder $container)
    {
        $taggedServices = $container->findTaggedServiceIds('task.lock.storage');

        $result = [];
        foreach ($taggedServices as $id => $tags) {
            foreach ($tags as $tag) {
                $result[$tag['alias']] = $id;
            }
        }

        return $result;
    }

    /**
     * {@inheritdoc}
     */
    public function getConfiguration(array $config, ContainerBuilder $container)
    {
        $loader = new Loader\XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
        $loader->load('locking/storages.xml');

        return new Configuration($this->getLockingStorageAliases($container));
    }
}


1		<?php
2
3		/*
4		* This file is part of php-task library.
5		*
6		* (c) php-task
7		*
8		* This source file is subject to the MIT license that is bundled
9		* with this source code in the file LICENSE.
10		*/
11
12		namespace Task\TaskBundle\DependencyInjection;
13
14		use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
15		use Symfony\Component\Config\FileLocator;
16		use Symfony\Component\Config\Loader\LoaderInterface;
17		use Symfony\Component\DependencyInjection\ContainerBuilder;
18		use Symfony\Component\DependencyInjection\ContainerInterface;
19		use Symfony\Component\DependencyInjection\Definition;
20		use Symfony\Component\DependencyInjection\Loader;
21		use Symfony\Component\DependencyInjection\Reference;
22		use Symfony\Component\HttpKernel\DependencyInjection\Extension;
23		use Task\Event\Events;
24		use Task\TaskBundle\EventListener\DoctrineTaskExecutionListener;
25
26		/**
27		* Container extension for php-task library.
28		*/
29		class TaskExtension extends Extension
30		{
31		/**
32		* {@inheritdoc}
33		*/
34	30	public function load(array $configs, ContainerBuilder $container)
35		{
36	30	$configuration = $this->getConfiguration($configs, $container);
37	30	$config = $this->processConfiguration($configuration, $configs);
		0 ignored issues – show Bug introduced 2017-05-15 07:35 UTC by Report Bug Copy Issue Report It seems like `$configuration` defined by `$this->getConfiguration($configs, $container)` on line `36` 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...
38
39	30	$container->setParameter('task.system_tasks', $config['system_tasks']);
40
41	30	$container->setAlias('task.lock.storage', $configuration->getLockingStorageId($config['locking']['storage']));
42	30	foreach (array_keys($config['locking']['storages']) as $key) {
43	30	$container->setParameter('task.lock.storages.' . $key, $config['locking']['storages'][$key]);
44	30	}
45
46	30	$loader = new Loader\XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
47	30	$loader->load(sprintf('storage/%s.xml', $config['storage']));
48	30	$loader->load('task_event_listener.xml');
49	30	$loader->load('scheduler.xml');
50	30	$loader->load('command.xml');
51	30	$loader->load('locking/services.xml');
52
53	30	if ($config['run']['mode'] === 'listener') {
54		$loader->load('listener.xml');
55		}
56
57	30	$this->loadDoctrineAdapter($config['adapters']['doctrine'], $container);
58	30	$this->loadLockingComponent($config['locking'], $container, $loader);
59	30	$this->loadExecutorComponent($config['executor'], $container, $loader);
60	30	}
61
62		/**
63		* Load doctrine adapter.
64		*
65		* @param array $config
66		* @param ContainerBuilder $container
67		*/
68	30	private function loadDoctrineAdapter(array $config, ContainerBuilder $container)
69		{
70	30	if ($config['clear']) {
71	30	$definition = new Definition(
72	30	DoctrineTaskExecutionListener::class,
73	30	[new Reference('doctrine.orm.entity_manager', ContainerInterface::IGNORE_ON_INVALID_REFERENCE)]
74	30	);
75	30	$definition->addTag(
76	30	'kernel.event_listener',
77	30	['event' => Events::TASK_AFTER, 'method' => 'clearEntityManagerAfterTask']
78	30	);
79	30	$container->setDefinition('task.adapter.doctrine.execution_listener', $definition);
80	30	}
81	30	}
82
83		/**
84		* Load services for locking component.
85		*
86		* @param array $config
87		* @param LoaderInterface $loader
88		* @param ContainerBuilder $container
89		*/
90	30	private function loadLockingComponent(array $config, ContainerBuilder $container, LoaderInterface $loader)
91		{
92	30	if (!$config['enabled']) {
93		return $loader->load('locking/null.xml');
94		}
95
96	30	$loader->load('locking/services.xml');
97	30	$container->setParameter('task.lock.ttl', $config['ttl']);
98	30	}
99
100		/**
101		* Load services for executor component.
102		*
103		* @param array $config
104		* @param LoaderInterface $loader
105		* @param ContainerBuilder $container
106		*/
107	30	private function loadExecutorComponent(array $config, ContainerBuilder $container, LoaderInterface $loader)
108		{
109	30	$loader->load('executor/' . $config['type'] . '.xml');
110	30	$container->setAlias('task.executor', 'task.executor.' . $config['type']);
111
112	30	if (!array_key_exists($config['type'], $config)) {
113		return;
114		}
115
116	30	foreach ($config[$config['type']] as $key => $value) {
117	30	$container->setParameter('task.executor.' . $key, $value);
118	30	}
119
120	30	if (!file_exists($container->getParameter('task.executor.console_path'))) {
121		throw new InvalidConfigurationException(
122		'Console file does not exists! Given in "task.executor.seperate.console".'
123		);
124		}
125	30	}
126
127		/**
128		* Find storage aliases and related ids.
129		*
130		* @param ContainerBuilder $container
131		*
132		* @return array
133		*/
134	30	private function getLockingStorageAliases(ContainerBuilder $container)
135		{
136	30	$taggedServices = $container->findTaggedServiceIds('task.lock.storage');
137
138	30	$result = [];
139	30	foreach ($taggedServices as $id => $tags) {
140	30	foreach ($tags as $tag) {
141	30	$result[$tag['alias']] = $id;
142	30	}
143	30	}
144
145	30	return $result;
146		}
147
148		/**
149		* {@inheritdoc}
150		*/
151	30	public function getConfiguration(array $config, ContainerBuilder $container)
152		{
153	30	$loader = new Loader\XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
154	30	$loader->load('locking/storages.xml');
155
156	30	return new Configuration($this->getLockingStorageAliases($container));
157		}
158		}
159

php-task / TaskBundle

Push — master ( cfc46b...5a6c91 )

TaskExtension::load() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like