Completed
Pull Request — master (#892)
by Andreas
04:17
created

DoctrineDataCollector::getCachePutsCount()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
c 0
b 0
f 0
dl 0
loc 4
rs 10
cc 1
nc 1
nop 0
1
<?php
2
3
namespace Doctrine\Bundle\DoctrineBundle\DataCollector;
4
5
use Doctrine\Common\Persistence\ManagerRegistry;
6
use Doctrine\ORM\Cache\Logging\CacheLoggerChain;
7
use Doctrine\ORM\Cache\Logging\StatisticsCacheLogger;
8
use Doctrine\ORM\Configuration;
9
use Doctrine\ORM\EntityManager;
10
use Doctrine\ORM\Mapping\ClassMetadataFactory;
11
use Doctrine\ORM\Mapping\ClassMetadataInfo;
12
use Doctrine\ORM\Tools\SchemaValidator;
13
use Doctrine\ORM\Version;
14
use Exception;
15
use Symfony\Bridge\Doctrine\DataCollector\DoctrineDataCollector as BaseCollector;
16
use Symfony\Component\HttpFoundation\Request;
17
use Symfony\Component\HttpFoundation\Response;
18
19
/**
20
 * DoctrineDataCollector.
21
 */
22
class DoctrineDataCollector extends BaseCollector
23
{
24
    /** @var ManagerRegistry */
25
    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...
26
27
    /** @var int|null */
28
    private $invalidEntityCount;
29
30
    /** @var string[] */
31
    private $groupedQueries;
32
33
    public function __construct(ManagerRegistry $registry)
34
    {
35
        $this->registry = $registry;
36
37
        parent::__construct($registry);
38
    }
39
40
    /**
41
     * {@inheritdoc}
42
     */
43
    public function collect(Request $request, Response $response, Exception $exception = null)
44
    {
45
        parent::collect($request, $response, $exception);
46
47
        $errors   = [];
48
        $entities = [];
49
        $caches   = [
50
            'enabled' => false,
51
            'log_enabled' => false,
52
            'counts' => [
53
                'puts' => 0,
54
                'hits' => 0,
55
                'misses' => 0,
56
            ],
57
            'regions' => [
58
                'puts' => [],
59
                'hits' => [],
60
                'misses' => [],
61
            ],
62
        ];
63
64
        /** @var EntityManager $em */
65
        foreach ($this->registry->getManagers() as $name => $em) {
66
            $entities[$name] = [];
67
            /** @var ClassMetadataFactory $factory */
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 ClassMetadataInfo $class */
72
            foreach ($factory->getLoadedMetadata() as $class) {
73
                if (isset($entities[$name][$class->getName()])) {
74
                    continue;
75
                }
76
77
                $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...
78
                $entities[$name][$class->getName()] = $class->getName();
79
80
                if (empty($classErrors)) {
81
                    continue;
82
                }
83
84
                $errors[$name][$class->getName()] = $classErrors;
85
            }
86
87
            /** @var Configuration $emConfig */
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 $cacheLoggerChain */
99
            $cacheConfiguration = $emConfig->getSecondLevelCacheConfiguration();
100
            $cacheLoggerChain   = $cacheConfiguration->getCacheLogger();
101
102
            if (! $cacheLoggerChain || ! $cacheLoggerChain->getLogger('statistics')) {
103
                continue;
104
            }
105
106
            /** @var StatisticsCacheLogger $cacheLoggerStats */
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
        // Might be good idea to replicate this block in doctrine bridge so we can drop this from here after some time.
140
        // This code is compatible with such change, because cloneVar is supposed to check if input is already cloned.
141
        foreach ($this->data['queries'] as &$queries) {
142
            foreach ($queries as &$query) {
143
                $query['params'] = $this->cloneVar($query['params']);
144
            }
145
        }
146
147
        $this->data['entities'] = $entities;
148
        $this->data['errors']   = $errors;
149
        $this->data['caches']   = $caches;
150
        $this->groupedQueries   = null;
0 ignored issues
show
Documentation Bug introduced by
It seems like null of type null is incompatible with the declared type array<integer,string> of property $groupedQueries.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
151
    }
152
153
    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...
154
    {
155
        return $this->data['entities'];
156
    }
157
158
    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...
159
    {
160
        return $this->data['errors'];
161
    }
162
163
    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...
164
    {
165
        return $this->data['caches']['counts']['hits'];
166
    }
167
168
    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...
169
    {
170
        return $this->data['caches']['counts']['puts'];
171
    }
172
173
    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...
174
    {
175
        return $this->data['caches']['counts']['misses'];
176
    }
177
178
    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...
179
    {
180
        return $this->data['caches']['enabled'];
181
    }
182
183
    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...
184
    {
185
        return $this->data['caches']['regions'];
186
    }
187
188
    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...
189
    {
190
        return $this->data['caches']['counts'];
191
    }
192
193
    public function getInvalidEntityCount()
194
    {
195
        if ($this->invalidEntityCount === null) {
196
            $this->invalidEntityCount = array_sum(array_map('count', $this->data['errors']));
0 ignored issues
show
Documentation Bug introduced by
It seems like array_sum(array_map('cou...$this->data['errors'])) can also be of type double. However, the property $invalidEntityCount is declared as type integer|null. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
197
        }
198
199
        return $this->invalidEntityCount;
200
    }
201
202
    public function getGroupedQueries()
203
    {
204
        if ($this->groupedQueries !== null) {
205
            return $this->groupedQueries;
206
        }
207
208
        $this->groupedQueries = [];
209
        $totalExecutionMS     = 0;
210
        foreach ($this->data['queries'] as $connection => $queries) {
211
            $connectionGroupedQueries = [];
212
            foreach ($queries as $i => $query) {
213
                $key = $query['sql'];
214
                if (! isset($connectionGroupedQueries[$key])) {
215
                    $connectionGroupedQueries[$key]                = $query;
216
                    $connectionGroupedQueries[$key]['executionMS'] = 0;
217
                    $connectionGroupedQueries[$key]['count']       = 0;
218
                    $connectionGroupedQueries[$key]['index']       = $i; // "Explain query" relies on query index in 'queries'.
219
                }
220
                $connectionGroupedQueries[$key]['executionMS'] += $query['executionMS'];
221
                $connectionGroupedQueries[$key]['count']++;
222
                $totalExecutionMS += $query['executionMS'];
223
            }
224
            usort($connectionGroupedQueries, static function ($a, $b) {
225
                if ($a['executionMS'] === $b['executionMS']) {
226
                    return 0;
227
                }
228
                return $a['executionMS'] < $b['executionMS'] ? 1 : -1;
229
            });
230
            $this->groupedQueries[$connection] = $connectionGroupedQueries;
231
        }
232
233
        foreach ($this->groupedQueries as $connection => $queries) {
234
            foreach ($queries as $i => $query) {
235
                $this->groupedQueries[$connection][$i]['executionPercent'] =
236
                    $this->executionTimePercentage($query['executionMS'], $totalExecutionMS);
237
            }
238
        }
239
240
        return $this->groupedQueries;
241
    }
242
243
    private function executionTimePercentage($executionTimeMS, $totalExecutionTimeMS)
244
    {
245
        if ($totalExecutionTimeMS === 0.0 || $totalExecutionTimeMS === 0) {
246
            return 0;
247
        }
248
249
        return $executionTimeMS / $totalExecutionTimeMS * 100;
250
    }
251
252
    public function getGroupedQueryCount()
253
    {
254
        $count = 0;
255
        foreach ($this->getGroupedQueries() as $connectionGroupedQueries) {
256
            $count += count($connectionGroupedQueries);
257
        }
258
259
        return $count;
260
    }
261
}
262