Completed
Pull Request — master (#293)
by Lukas Kahwe
09:43
created

QueryCountClient   A

Complexity

Total Complexity 3

Size/Duplication

Total Lines 38
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 3

Test Coverage

Coverage 100%

Importance

Changes 0
Metric Value
wmc 3
lcom 1
cbo 3
dl 0
loc 38
ccs 11
cts 11
cp 1
rs 10
c 0
b 0
f 0

2 Methods

Rating   Name   Duplication   Size   Complexity  
A setQueryCounter() 0 4 1
B request() 0 27 2
1
<?php
2
3
namespace Liip\FunctionalTestBundle;
4
5
use Symfony\Bundle\FrameworkBundle\Client;
6
7
class QueryCountClient extends Client
8
{
9
    /** @var QueryCounter */
10
    private $queryCounter;
11
12 16
    public function setQueryCounter(QueryCounter $queryCounter)
13
    {
14 16
        $this->queryCounter = $queryCounter;
15 16
    }
16
17 5
    public function request(
18
        $method,
19
        $uri,
20
        array $parameters = array(),
21
        array $files = array(),
22
        array $server = array(),
23
        $content = null,
24
        $changeHistory = true
25
    ) {
26 5
        $crawler = parent::request($method, $uri, $parameters, $files, $server, $content, $changeHistory);
27
28 5
        if ($this->getProfile()) {
29 5
            $this->queryCounter->checkQueryCount(
30 5
                $this->getProfile()->getCollector('db')->getQueryCount()
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Symfony\Component\HttpKe...\DataCollectorInterface as the method getQueryCount() does only exist in the following implementations of said interface: Symfony\Bridge\Doctrine\...r\DoctrineDataCollector.

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...
31 5
            );
32 5
        } else {
33
            // @codeCoverageIgnoreStart
34
            echo "\n".
35
                'Profiler is disabled, it must be enabled for the '.
36
                'Query Counter. '.
37
                'See https://github.com/liip/LiipFunctionalTestBundle#query-counter'.
38
                "\n";
39
            // @codeCoverageIgnoreEnd
40
        }
41
42 3
        return $crawler;
43
    }
44
}
45