HttpClientRouter::addClient() - Code Metrics - Inspection of "Merge pull request #193 from GrahamCampbell/type-e..." - php-http/client-common - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cd17f3...38b66e )

by David

created 2020-07-01 13:55 UTC

HttpClientRouter::addClient() A

↳ Parent: HttpClientRouter

Complexity

Conditions	3
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3.1406

Importance

Changes

Metric	Value
dl	0
loc	13
ccs	6
cts	8
cp	0.75
rs	9.8333
c	0
b	0
f	0
cc	3
nc	2
nop	2
crap	3.1406

<?php

declare(strict_types=1);

namespace Http\Client\Common;

use Http\Client\Common\Exception\HttpClientNoMatchException;
use Http\Client\HttpAsyncClient;
use Http\Message\RequestMatcher;
use Psr\Http\Client\ClientInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;

/**
 * {@inheritdoc}
 *
 * @author Joel Wurtz <[email protected]>
 */
final class HttpClientRouter implements HttpClientRouterInterface
{
    /**
     * @var array
     */
    private $clients = [];

    /**
     * {@inheritdoc}
     */
    public function sendRequest(RequestInterface $request): ResponseInterface
    {
        return $this->chooseHttpClient($request)->sendRequest($request);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
    }

    /**
     * {@inheritdoc}
     */
    public function sendAsyncRequest(RequestInterface $request)
    {
        return $this->chooseHttpClient($request)->sendAsyncRequest($request);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
    }

    /**
     * Add a client to the router.
     *
     * @param ClientInterface|HttpAsyncClient $client
     */
    public function addClient($client, RequestMatcher $requestMatcher): void
    {
        if (!$client instanceof ClientInterface && !$client instanceof HttpAsyncClient) {
            throw new \TypeError(
                sprintf('%s::addClient(): Argument #1 ($client) must be of type %s|%s, %s given', self::class, ClientInterface::class, HttpAsyncClient::class, get_debug_type($client))

            );
        }

        $this->clients[] = [
            'matcher' => $requestMatcher,
            'client' => new FlexibleHttpClient($client),
        ];
    }

    /**
     * Choose an HTTP client given a specific request.
     *
     * @return ClientInterface|HttpAsyncClient
     */
    private function chooseHttpClient(RequestInterface $request)
    {
        foreach ($this->clients as $client) {
            if ($client['matcher']->matches($request)) {
                return $client['client'];
            }
        }

        throw new HttpClientNoMatchException('No client found for the specified request', $request);
    }
}


Push — master ( cd17f3...38b66e )

HttpClientRouter::addClient() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

1		<?php
2
3		declare(strict_types=1);
4
5		namespace Http\Client\Common;
6
7		use Http\Client\Common\Exception\HttpClientNoMatchException;
8		use Http\Client\HttpAsyncClient;
9		use Http\Message\RequestMatcher;
10		use Psr\Http\Client\ClientInterface;
11		use Psr\Http\Message\RequestInterface;
12		use Psr\Http\Message\ResponseInterface;
13
14		/**
15		* {@inheritdoc}
16		*
17		* @author Joel Wurtz <[email protected]>
18		*/
19		final class HttpClientRouter implements HttpClientRouterInterface
20		{
21		/**
22		* @var array
23		*/
24		private $clients = [];
25
26		/**
27		* {@inheritdoc}
28		*/
29	2	public function sendRequest(RequestInterface $request): ResponseInterface
30		{
31	2	return $this->chooseHttpClient($request)->sendRequest($request);
		0 ignored issues – show Bug introduced 2019-01-03 13:59 UTC by Report Bug Copy Issue Report The method `sendRequest` does only exist in `Psr\Http\Client\ClientInterface`, but not in `Http\Client\HttpAsyncClient`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
32		}
33
34		/**
35		* {@inheritdoc}
36		*/
37	2	public function sendAsyncRequest(RequestInterface $request)
38		{
39	2	return $this->chooseHttpClient($request)->sendAsyncRequest($request);
		0 ignored issues – show Bug introduced 2019-01-03 13:59 UTC by Report Bug Copy Issue Report The method `sendAsyncRequest` does only exist in `Http\Client\HttpAsyncClient`, but not in `Psr\Http\Client\ClientInterface`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
40		}
41
42		/**
43		* Add a client to the router.
44		*
45		* @param ClientInterface\|HttpAsyncClient $client
46		*/
47	4	public function addClient($client, RequestMatcher $requestMatcher): void
48		{
49	4	if (!$client instanceof ClientInterface && !$client instanceof HttpAsyncClient) {
50		throw new \TypeError(
51		sprintf('%s::addClient(): Argument #1 ($client) must be of type %s\|%s, %s given', self::class, ClientInterface::class, HttpAsyncClient::class, get_debug_type($client))
		0 ignored issues – show Unused Code introduced 2020-07-01 13:56 UTC by Report Bug Copy Issue Report The call to `TypeError::__construct()` has too many arguments starting with `sprintf('%s::addClient()...et_debug_type($client))`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
52		);
53		}
54
55	4	$this->clients[] = [
56	4	'matcher' => $requestMatcher,
57	4	'client' => new FlexibleHttpClient($client),
58		];
59	4	}
60
61		/**
62		* Choose an HTTP client given a specific request.
63		*
64		* @return ClientInterface\|HttpAsyncClient
65		*/
66	4	private function chooseHttpClient(RequestInterface $request)
67		{
68	4	foreach ($this->clients as $client) {
69	4	if ($client['matcher']->matches($request)) {
70	2	return $client['client'];
71		}
72		}
73
74	2	throw new HttpClientNoMatchException('No client found for the specified request', $request);
75		}
76		}
77

php-http / client-common

Push — master ( cd17f3...38b66e )

HttpClientRouter::addClient() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like