Completed
Pull Request — master (#579)
by Mindaugas
03:27
created

DoctrineDataCollector::collect()   F

Complexity

Conditions 20
Paths 484

Size

Total Lines 123
Code Lines 74

Duplication

Lines 21
Ratio 17.07 %

Importance

Changes 0
Metric Value
dl 21
loc 123
rs 3.1438
c 0
b 0
f 0
cc 20
eloc 74
nc 484
nop 3

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
/*
4
 * This file is part of the Doctrine Bundle
5
 *
6
 * The code was originally distributed inside the Symfony framework.
7
 *
8
 * (c) Fabien Potencier <[email protected]>
9
 * (c) Doctrine Project, Benjamin Eberlei <[email protected]>
10
 *
11
 * For the full copyright and license information, please view the LICENSE
12
 * file that was distributed with this source code.
13
 */
14
15
namespace Doctrine\Bundle\DoctrineBundle\DataCollector;
16
17
use Doctrine\Common\Persistence\ManagerRegistry;
18
use Doctrine\ORM\Tools\SchemaValidator;
19
use Doctrine\ORM\Version;
20
use Symfony\Bridge\Doctrine\DataCollector\DoctrineDataCollector as BaseCollector;
21
use Symfony\Component\HttpFoundation\Request;
22
use Symfony\Component\HttpFoundation\Response;
23
24
/**
25
 * DoctrineDataCollector.
26
 *
27
 * @author Christophe Coevoet <[email protected]>
28
 */
29
class DoctrineDataCollector extends BaseCollector
30
{
31
    private $registry;
0 ignored issues
show
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
32
    private $invalidEntityCount;
33
34
    public function __construct(ManagerRegistry $registry)
35
    {
36
        $this->registry = $registry;
37
38
        parent::__construct($registry);
39
    }
40
41
    /**
42
     * {@inheritdoc}
43
     */
44
    public function collect(Request $request, Response $response, \Exception $exception = null)
45
    {
46
        parent::collect($request, $response, $exception);
47
48
        $errors = array();
49
        $entities = array();
50
        $caches = array(
51
            'enabled' => false,
52
            'log_enabled' => false,
53
            'counts' => array(
54
                'puts' => 0,
55
                'hits' => 0,
56
                'misses' => 0,
57
            ),
58
            'regions' => array(
59
                'puts' => array(),
60
                'hits' => array(),
61
                'misses' => array(),
62
            ),
63
        );
64
65
        foreach ($this->registry->getManagers() as $name => $em) {
66
            $entities[$name] = array();
67
            /** @var $factory \Doctrine\ORM\Mapping\ClassMetadataFactory */
68
            $factory = $em->getMetadataFactory();
69
            $validator = new SchemaValidator($em);
0 ignored issues
show
Compatibility introduced by
$em of type object<Doctrine\Common\Persistence\ObjectManager> is not a sub-type of object<Doctrine\ORM\EntityManagerInterface>. It seems like you assume a child interface of the interface Doctrine\Common\Persistence\ObjectManager 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...
70
71
            /** @var $class \Doctrine\ORM\Mapping\ClassMetadataInfo */
72
            foreach ($factory->getLoadedMetadata() as $class) {
73
                if (!isset($entities[$name][$class->getName()])) {
74
                    $classErrors = $validator->validateClass($class);
0 ignored issues
show
Compatibility introduced by
$class of type object<Doctrine\Common\P...\Mapping\ClassMetadata> is not a sub-type of object<Doctrine\ORM\Mapping\ClassMetadataInfo>. It seems like you assume a concrete implementation of the interface Doctrine\Common\Persistence\Mapping\ClassMetadata 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...
75
                    $entities[$name][$class->getName()] = $class->getName();
76
77
                    if (!empty($classErrors)) {
78
                        $errors[$name][$class->getName()] = $classErrors;
79
                    }
80
                }
81
            }
82
83
            if (version_compare(Version::VERSION, '2.5.0-DEV') < 0) {
84
                continue;
85
            }
86
87
            /** @var $emConfig \Doctrine\ORM\Configuration */
88
            $emConfig = $em->getConfiguration();
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Doctrine\Common\Persistence\ObjectManager as the method getConfiguration() does only exist in the following implementations of said interface: Doctrine\ORM\Decorator\EntityManagerDecorator, Doctrine\ORM\EntityManager.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
89
            $slcEnabled = $emConfig->isSecondLevelCacheEnabled();
90
91
            if (!$slcEnabled) {
92
                continue;
93
            }
94
95
            $caches['enabled'] = true;
96
97
            /** @var $cacheConfiguration \Doctrine\ORM\Cache\CacheConfiguration */
98
            /** @var $cacheLoggerChain \Doctrine\ORM\Cache\Logging\CacheLoggerChain */
99
            $cacheConfiguration = $emConfig->getSecondLevelCacheConfiguration();
100
            $cacheLoggerChain = $cacheConfiguration->getCacheLogger();
101
102
            if (!$cacheLoggerChain || !$cacheLoggerChain->getLogger('statistics')) {
103
                continue;
104
            }
105
106
            /** @var $cacheLoggerStats \Doctrine\ORM\Cache\Logging\StatisticsCacheLogger */
107
            $cacheLoggerStats = $cacheLoggerChain->getLogger('statistics');
108
            $caches['log_enabled'] = true;
109
110
            $caches['counts']['puts'] += $cacheLoggerStats->getPutCount();
111
            $caches['counts']['hits'] += $cacheLoggerStats->getHitCount();
112
            $caches['counts']['misses'] += $cacheLoggerStats->getMissCount();
113
114 View Code Duplication
            foreach ($cacheLoggerStats->getRegionsPut() as $key => $value) {
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...
115
                if (!isset($caches['regions']['puts'][$key])) {
116
                    $caches['regions']['puts'][$key] = 0;
117
                }
118
119
                $caches['regions']['puts'][$key] += $value;
120
            }
121
122 View Code Duplication
            foreach ($cacheLoggerStats->getRegionsHit() as $key => $value) {
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...
123
                if (!isset($caches['regions']['hits'][$key])) {
124
                    $caches['regions']['hits'][$key] = 0;
125
                }
126
127
                $caches['regions']['hits'][$key] += $value;
128
            }
129
130 View Code Duplication
            foreach ($cacheLoggerStats->getRegionsMiss() as $key => $value) {
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...
131
                if (!isset($caches['regions']['misses'][$key])) {
132
                    $caches['regions']['misses'][$key] = 0;
133
                }
134
135
                $caches['regions']['misses'][$key] += $value;
136
            }
137
        }
138
139
        $groupedQueries = array();
140
        foreach ($this->data['queries'] as $connection => $queries) {
141
            $connectionGroupedQueries = array();
142
            foreach ($queries as $i => $query) {
143
                $key = $query['sql'];
144
                if (!isset($connectionGroupedQueries[$key])) {
145
                    $connectionGroupedQueries[$key] = $query;
146
                    $connectionGroupedQueries[$key]['executionMS'] = 0;
147
                    $connectionGroupedQueries[$key]['count'] = 0;
148
                    $connectionGroupedQueries[$key]['i'] = $i; // "Explain query" relies on query index in 'queries'.
149
                }
150
                $connectionGroupedQueries[$key]['executionMS'] += $query['executionMS'];
151
                $connectionGroupedQueries[$key]['count']++;
152
            }
153
            usort($connectionGroupedQueries, function ($a, $b) {
154
                if ($a['executionMS'] === $b['executionMS']) {
155
                    return 0;
156
                }
157
                return ($a['executionMS'] < $b['executionMS']) ? 1 : -1;
158
            });
159
            $groupedQueries[$connection] = $connectionGroupedQueries;
160
        }
161
162
        $this->data['entities'] = $entities;
163
        $this->data['errors'] = $errors;
164
        $this->data['caches'] = $caches;
165
        $this->data['groupedQueries'] = $groupedQueries;
166
    }
167
168
    public function getEntities()
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
169
    {
170
        return $this->data['entities'];
171
    }
172
173
    public function getMappingErrors()
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
174
    {
175
        return $this->data['errors'];
176
    }
177
178
    public function getCacheHitsCount()
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
179
    {
180
        return $this->data['caches']['counts']['hits'];
181
    }
182
183
    public function getCachePutsCount()
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
184
    {
185
        return $this->data['caches']['counts']['puts'];
186
    }
187
188
    public function getCacheMissesCount()
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
189
    {
190
        return $this->data['caches']['counts']['misses'];
191
    }
192
193
    public function getCacheEnabled()
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
194
    {
195
        return $this->data['caches']['enabled'];
196
    }
197
198
    public function getCacheRegions()
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
199
    {
200
        return $this->data['caches']['regions'];
201
    }
202
203
    public function getCacheCounts()
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
204
    {
205
        return $this->data['caches']['counts'];
206
    }
207
208
    public function getInvalidEntityCount()
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
209
    {
210
        if (null === $this->invalidEntityCount) {
211
            $this->invalidEntityCount = array_sum(array_map('count', $this->data['errors']));
212
        }
213
214
        return $this->invalidEntityCount;
215
    }
216
217
    public function getGroupedQueries()
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
218
    {
219
        return $this->data['groupedQueries'];
220
    }
221
}
222