ProfileClient::getStopwatchEventName() - Code Metrics - Inspection of "Extend profiler toolbar item" - php-http/HttplugBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#135)

unknown

created 2017-04-28 13:23 UTC

ProfileClient::getStopwatchEventName() A

↳ Parent: ProfileClient

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	12
ccs	0
cts	0
cp	0
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	7
nc	2
nop	1
crap	6

<?php

namespace Http\HttplugBundle\Collector;

use Http\Client\Common\FlexibleHttpClient;
use Http\Client\Exception\HttpException;
use Http\Client\HttpAsyncClient;
use Http\Client\HttpClient;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use Symfony\Component\Stopwatch\Stopwatch;
use Symfony\Component\Stopwatch\StopwatchEvent;

/**
 * The ProfileClient decorates any client that implement both HttpClient and HttpAsyncClient interfaces to gather target
 * url and response status code.
 *
 * @author Fabien Bourigault <[email protected]>
 *
 * @internal
 */
class ProfileClient implements HttpClient, HttpAsyncClient
{
    /**
     * @var HttpClient|HttpAsyncClient
     */
    private $client;

    /**
     * @var Collector
     */
    private $collector;

    /**
     * @var Formatter
     */
    private $formatter;

    /**
     * @var Stopwatch
     */
    private $stopwatch;

    /**
     * @var array
     */
    private $eventNames = [];

    /**
     * @param HttpClient|HttpAsyncClient $client    The client to profile. Client must implement both HttpClient and
     *                                              HttpAsyncClient interfaces.
     * @param Collector                  $collector
     * @param Formatter                  $formatter
     * @param Stopwatch                  $stopwatch
     */
    public function __construct($client, Collector $collector, Formatter $formatter, Stopwatch $stopwatch)
    {
        if (!($client instanceof HttpClient && $client instanceof HttpAsyncClient)) {
            throw new \RuntimeException(sprintf(
                '%s first argument must implement %s and %s. Consider using %s.',
                    __METHOD__,
                    HttpClient::class,
                    HttpAsyncClient::class,
                    FlexibleHttpClient::class
            ));
        }
        $this->client = $client;
        $this->collector = $collector;
        $this->formatter = $formatter;
        $this->stopwatch = $stopwatch;
    }

    /**
     * {@inheritdoc}
     */
    public function sendAsyncRequest(RequestInterface $request)
    {
        $stack = $this->collector->getCurrentStack();
        $this->collectRequestInformations($request, $stack);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        $event = $this->stopwatch->start($this->getStopwatchEventName($request));

        return $this->client->sendAsyncRequest($request)->then(
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.
}
            function (ResponseInterface $response) use ($event, $stack) {
                $event->stop();
                $this->collectResponseInformations($response, $event, $stack);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

                return $response;
            }, function (\Exception $exception) use ($event, $stack) {
                $event->stop();
                $this->collectExceptionInformations($exception, $event, $stack);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

                throw $exception;
            }
        );
    }

    /**
     * {@inheritdoc}
     */
    public function sendRequest(RequestInterface $request)
    {
        $stack = $this->collector->getCurrentStack();
        $this->collectRequestInformations($request, $stack);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        $event = $this->stopwatch->start($this->getStopwatchEventName($request));

        try {
            $response = $this->client->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.
}
            $event->stop();

            $this->collectResponseInformations($response, $event, $stack);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

            return $response;
        } catch (\Exception $e) {
            $event->stop();
            $this->collectExceptionInformations($e, $event, $stack);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

            throw $e;
        }
    }

    /**
     * @param RequestInterface $request
     * @param Stack|null       $stack
     */
    private function collectRequestInformations(RequestInterface $request, Stack $stack = null)
    {
        if (!$stack) {
            return;
        }

        $stack->setRequestTarget($request->getRequestTarget());
        $stack->setRequestMethod($request->getMethod());
        $stack->setRequestScheme($request->getUri()->getScheme());
        $stack->setRequestHost($request->getUri()->getHost());
        $stack->setClientRequest($this->formatter->formatRequest($request));
    }

    /**
     * @param ResponseInterface $response
     * @param StopwatchEvent    $event
     * @param Stack|null        $stack
     */
    private function collectResponseInformations(ResponseInterface $response, StopwatchEvent $event, Stack $stack = null)
    {
        if (!$stack) {
            return;
        }

        $stack->setDuration($event->getDuration());
        $stack->setResponseCode($response->getStatusCode());
        $stack->setClientResponse($this->formatter->formatResponse($response));
    }

    /**
     * @param \Exception     $exception
     * @param StopwatchEvent $event
     * @param Stack|null     $stack
     */
    private function collectExceptionInformations(\Exception $exception, StopwatchEvent $event, Stack $stack = null)
    {
        if ($exception instanceof HttpException) {
            $this->collectResponseInformations($exception->getResponse(), $event, $stack);
        }

        if (!$stack) {
            return;
        }

        $stack->setDuration($event->getDuration());
        $stack->setClientException($this->formatter->formatException($exception));
    }

    /**
     * Generates the event name.
     *
     * @param RequestInterface $request
     *
     * @return string
     */
    private function getStopwatchEventName(RequestInterface $request)
    {
        $name = sprintf('%s %s', $request->getMethod(), $request->getUri());

        if (isset($this->eventNames[$name])) {
            $name .= sprintf(' [#%d]', ++$this->eventNames[$name]);
        } else {
            $this->eventNames[$name] = 1;
        }

        return $name;
    }
}


Pull Request — master (#135)

ProfileClient::getStopwatchEventName() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

1		<?php
2
3		namespace Http\HttplugBundle\Collector;
4
5		use Http\Client\Common\FlexibleHttpClient;
6		use Http\Client\Exception\HttpException;
7		use Http\Client\HttpAsyncClient;
8		use Http\Client\HttpClient;
9		use Psr\Http\Message\RequestInterface;
10		use Psr\Http\Message\ResponseInterface;
11		use Symfony\Component\Stopwatch\Stopwatch;
12		use Symfony\Component\Stopwatch\StopwatchEvent;
13
14		/**
15		* The ProfileClient decorates any client that implement both HttpClient and HttpAsyncClient interfaces to gather target
16		* url and response status code.
17		*
18		* @author Fabien Bourigault <[email protected]>
19		*
20		* @internal
21		*/
22		class ProfileClient implements HttpClient, HttpAsyncClient
23		{
24		/**
25		* @var HttpClient\|HttpAsyncClient
26		*/
27		private $client;
28
29		/**
30		* @var Collector
31		*/
32		private $collector;
33
34		/**
35		* @var Formatter
36		*/
37		private $formatter;
38
39		/**
40		* @var Stopwatch
41		*/
42		private $stopwatch;
43
44		/**
45		* @var array
46		*/
47		private $eventNames = [];
48
49		/**
50		* @param HttpClient\|HttpAsyncClient $client The client to profile. Client must implement both HttpClient and
51		* HttpAsyncClient interfaces.
52		* @param Collector $collector
53		* @param Formatter $formatter
54		* @param Stopwatch $stopwatch
55		*/
56	6	public function __construct($client, Collector $collector, Formatter $formatter, Stopwatch $stopwatch)
57		{
58	6	if (!($client instanceof HttpClient && $client instanceof HttpAsyncClient)) {
59		throw new \RuntimeException(sprintf(
60		'%s first argument must implement %s and %s. Consider using %s.',
61		__METHOD__,
62		HttpClient::class,
63		HttpAsyncClient::class,
64		FlexibleHttpClient::class
65		));
66		}
67		$this->client = $client;
68		$this->collector = $collector;
69		$this->formatter = $formatter;
70		$this->stopwatch = $stopwatch;
71		}
72
73		/**
74		* {@inheritdoc}
75		*/
76		public function sendAsyncRequest(RequestInterface $request)
77		{
78		$stack = $this->collector->getCurrentStack();
79		$this->collectRequestInformations($request, $stack);
		0 ignored issues – show Bug introduced 2017-04-19 12:18 UTC by Report Bug Copy Issue Report It seems like `$stack` defined by `$this->collector->getCurrentStack()` on line `78` can also be of type `boolean`; however, `Http\HttplugBundle\Colle...ctRequestInformations()` does only seem to accept `null\|object<Http\HttplugBundle\Collector\Stack>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
80		$event = $this->stopwatch->start($this->getStopwatchEventName($request));
81
82		return $this->client->sendAsyncRequest($request)->then(
		0 ignored issues – show Bug introduced 2017-04-19 12:18 UTC by Report Bug Copy Issue Report The method `sendAsyncRequest` does only exist in `Http\Client\HttpAsyncClient`, but not in `Http\Client\HttpClient`. 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...
83		function (ResponseInterface $response) use ($event, $stack) {
84		$event->stop();
85		$this->collectResponseInformations($response, $event, $stack);
		0 ignored issues – show Bug introduced 2017-04-19 12:18 UTC by Report Bug Copy Issue Report It seems like `$stack` defined by `$this->collector->getCurrentStack()` on line `78` can also be of type `boolean`; however, `Http\HttplugBundle\Colle...tResponseInformations()` does only seem to accept `null\|object<Http\HttplugBundle\Collector\Stack>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
86
87		return $response;
88		}, function (\Exception $exception) use ($event, $stack) {
89		$event->stop();
90		$this->collectExceptionInformations($exception, $event, $stack);
		0 ignored issues – show Bug introduced 2017-04-10 10:45 UTC by Report Bug Copy Issue Report It seems like `$stack` defined by `$this->collector->getCurrentStack()` on line `78` can also be of type `boolean`; however, `Http\HttplugBundle\Colle...ExceptionInformations()` does only seem to accept `null\|object<Http\HttplugBundle\Collector\Stack>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
91
92		throw $exception;
93		}
94		);
95		}
96
97		/**
98		* {@inheritdoc}
99		*/
100		public function sendRequest(RequestInterface $request)
101		{
102		$stack = $this->collector->getCurrentStack();
103		$this->collectRequestInformations($request, $stack);
		0 ignored issues – show Bug introduced 2017-04-19 12:18 UTC by Report Bug Copy Issue Report It seems like `$stack` defined by `$this->collector->getCurrentStack()` on line `102` can also be of type `boolean`; however, `Http\HttplugBundle\Colle...ctRequestInformations()` does only seem to accept `null\|object<Http\HttplugBundle\Collector\Stack>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
104		$event = $this->stopwatch->start($this->getStopwatchEventName($request));
105
106		try {
107		$response = $this->client->sendRequest($request);
		0 ignored issues – show Bug introduced 2017-04-19 12:18 UTC by Report Bug Copy Issue Report The method `sendRequest` does only exist in `Http\Client\HttpClient`, 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...
108		$event->stop();
109
110		$this->collectResponseInformations($response, $event, $stack);
		0 ignored issues – show Bug introduced 2017-04-19 12:18 UTC by Report Bug Copy Issue Report It seems like `$stack` defined by `$this->collector->getCurrentStack()` on line `102` can also be of type `boolean`; however, `Http\HttplugBundle\Colle...tResponseInformations()` does only seem to accept `null\|object<Http\HttplugBundle\Collector\Stack>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
111
112		return $response;
113		} catch (\Exception $e) {
114		$event->stop();
115		$this->collectExceptionInformations($e, $event, $stack);
		0 ignored issues – show Bug introduced 2017-04-19 12:18 UTC by Report Bug Copy Issue Report It seems like `$stack` defined by `$this->collector->getCurrentStack()` on line `102` can also be of type `boolean`; however, `Http\HttplugBundle\Colle...ExceptionInformations()` does only seem to accept `null\|object<Http\HttplugBundle\Collector\Stack>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
116
117		throw $e;
118		}
119		}
120
121		/**
122		* @param RequestInterface $request
123		* @param Stack\|null $stack
124		*/
125		private function collectRequestInformations(RequestInterface $request, Stack $stack = null)
126		{
127		if (!$stack) {
128		return;
129		}
130
131		$stack->setRequestTarget($request->getRequestTarget());
132		$stack->setRequestMethod($request->getMethod());
133		$stack->setRequestScheme($request->getUri()->getScheme());
134		$stack->setRequestHost($request->getUri()->getHost());
135		$stack->setClientRequest($this->formatter->formatRequest($request));
136		}
137
138		/**
139		* @param ResponseInterface $response
140		* @param StopwatchEvent $event
141		* @param Stack\|null $stack
142		*/
143		private function collectResponseInformations(ResponseInterface $response, StopwatchEvent $event, Stack $stack = null)
144		{
145		if (!$stack) {
146		return;
147		}
148
149		$stack->setDuration($event->getDuration());
150		$stack->setResponseCode($response->getStatusCode());
151		$stack->setClientResponse($this->formatter->formatResponse($response));
152		}
153
154		/**
155		* @param \Exception $exception
156		* @param StopwatchEvent $event
157		* @param Stack\|null $stack
158		*/
159		private function collectExceptionInformations(\Exception $exception, StopwatchEvent $event, Stack $stack = null)
160		{
161		if ($exception instanceof HttpException) {
162		$this->collectResponseInformations($exception->getResponse(), $event, $stack);
163		}
164
165		if (!$stack) {
166		return;
167		}
168
169		$stack->setDuration($event->getDuration());
170		$stack->setClientException($this->formatter->formatException($exception));
171		}
172
173		/**
174		* Generates the event name.
175		*
176		* @param RequestInterface $request
177		*
178		* @return string
179		*/
180		private function getStopwatchEventName(RequestInterface $request)
181		{
182		$name = sprintf('%s %s', $request->getMethod(), $request->getUri());
183
184		if (isset($this->eventNames[$name])) {
185		$name .= sprintf(' [#%d]', ++$this->eventNames[$name]);
186		} else {
187		$this->eventNames[$name] = 1;
188		}
189
190		return $name;
191		}
192		}
193

php-http / HttplugBundle

Pull Request — master (#135)

ProfileClient::getStopwatchEventName() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like