HttpAdapter::invalidate() - Code Metrics - Inspection of "WIP: upgrade php-http integration" - FriendsOfSymfony/FOSHttpCache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#257)

by David de

created 2015-12-29 19:00 UTC

HttpAdapter::invalidate() A

↳ Parent: HttpAdapter

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	10
ccs	6
cts	6
cp	1
rs	9.4286
cc	2
eloc	5
nc	2
nop	1
crap	2

<?php

namespace FOS\HttpCache\ProxyClient\Http;

use FOS\HttpCache\Exception\ExceptionCollection;
use FOS\HttpCache\Exception\InvalidArgumentException;
use FOS\HttpCache\Exception\InvalidUrlException;
use FOS\HttpCache\Exception\ProxyResponseException;
use FOS\HttpCache\Exception\ProxyUnreachableException;
use Http\Client\Exception;
use Http\Client\Exception\HttpException;
use Http\Client\Exception\RequestException;
use Http\Client\HttpAsyncClient;
use Http\Promise\Promise;
use Http\Discovery\UriFactoryDiscovery;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\UriInterface;

/**
 * An adapter to work with the Httplug asynchronous client.
 *
 * @author David Buchmann <[email protected]>
 */
class HttpAdapter
{
    /**
     * @var HttpAsyncClient
     */
    private $httpClient;

    /**
     * Queued requests
     *
     * @var RequestInterface[]
     */
    private $queue = [];

    /**
     * Caching proxy server host names or IP addresses.
     *
     * @var UriInterface[]
     */
    private $servers;

    /**
     * Application host name and optional base URL.
     *
     * @var UriInterface
     */
    private $baseUri;

    /**
     * @param string[] $servers Caching proxy server hostnames or IP
     *                          addresses, including port if not port 80.
     *                          E.g. ['127.0.0.1:6081']
     * @param string   $baseUri Default application hostname, optionally
     *                          including base URL, for purge and refresh
     *                          requests (optional). This is required if
     *                          you purge and refresh paths instead of
     *                          absolute URLs.
     * @param HttpAsyncClient $httpClient
     */
    public function __construct(array $servers, $baseUri, HttpAsyncClient $httpClient)
    {
        $this->setServers($servers);
        $this->setBaseUri($baseUri);
        $this->httpClient = $httpClient;
    }

    /**
     * Queue invalidation request.
     *
     * @param RequestInterface $invalidationRequest
     */
    public function invalidate(RequestInterface $invalidationRequest)
    {
        $signature = $this->getRequestSignature($invalidationRequest);

        if (isset($this->queue[$signature])) {
            return;
        }

        $this->queue[$signature] = $invalidationRequest;
    }

    /**
     * Send all pending invalidation requests and make sure the requests have terminated and gather exceptions.
     *
     * @return int The number of cache invalidations performed per caching server.
     *
     * @throws ExceptionCollection If any errors occurred during flush.
     */
    public function flush()
    {
        $queue = $this->queue;
        $this->queue = [];
        /** @var Promise[] $promises */
        $promises = [];

        $exceptions = new ExceptionCollection();

        foreach ($queue as $request) {
            foreach ($this->fanOut($request) as $proxyRequest) {
                $promises[] = $this->httpClient->sendAsyncRequest($proxyRequest);
            }
        }

        if (count($exceptions)) {
            throw new ExceptionCollection($exceptions);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        foreach ($promises as $promise) {
            try {
                $promise->wait();
            } catch (HttpException $exception) {
                $exceptions->add(ProxyResponseException::proxyResponse($exception->getResponse()));
            } catch (RequestException $exception) {
                $exceptions->add(ProxyUnreachableException::proxyUnreachable($exception));
            } catch (\Exception $exception)  {
                    $exceptions->add(new InvalidArgumentException($exception));
            }
        }

        if (count($exceptions)) {
            throw $exceptions;
        }

        return count($queue);
    }

    /**
     * Duplicate a request for each caching server
     *
     * @param RequestInterface $request The request to duplicate for each configured server
     *
     * @return RequestInterface[]
     */
    private function fanOut(RequestInterface $request)
    {
        $requests = [];

        $uri = $request->getUri();

        // If a base URI is configured, try to make partial invalidation
        // requests complete.
        if ($this->baseUri) {
            if ($uri->getHost()) {
                // Absolute URI: does it already have a scheme?
                if (!$uri->getScheme() && $this->baseUri->getScheme() !== '') {
                    $uri = $uri->withScheme($this->baseUri->getScheme());
                }
            } else {
                // Relative URI
                if ($this->baseUri->getHost() !== '') {
                    $uri = $uri->withHost($this->baseUri->getHost());
                }

                if ($this->baseUri->getPort()) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
                    $uri = $uri->withPort($this->baseUri->getPort());
                }

                // Base path
                if ($this->baseUri->getPath() !== '') {
                    $path = $this->baseUri->getPath() . '/' . ltrim($uri->getPath(), '/');
                    $uri = $uri->withPath($path);
                }
            }
        }

        // Close connections to make sure invalidation (PURGE/BAN) requests
        // will not interfere with content (GET) requests.
        $request = $request->withUri($uri)->withHeader('Connection', 'Close');

        // Create a request to each caching proxy server
        foreach ($this->servers as $server) {
            $requests[] = $request->withUri(
                $uri
                    ->withScheme($server->getScheme())
                    ->withHost($server->getHost())
                    ->withPort($server->getPort())
                ,
                true    // Preserve application Host header
            );
        }

        return $requests;
    }

    /**
     * Set caching proxy server URI objects, validating them.
     *
     * @param string[] $servers Caching proxy proxy server hostnames or IP
     *                          addresses, including port if not port 80.
     *                          E.g. ['127.0.0.1:6081']
     *
     * @throws InvalidUrlException If server is invalid or contains URL
     *                             parts other than scheme, host, port
     */
    private function setServers(array $servers)
    {
        $this->servers = [];
        foreach ($servers as $server) {
            $this->servers[] = $this->filterUri($server, ['scheme', 'host', 'port']);
        }
    }

    /**
     * Set application base URI that will be prefixed to relative purge and
     * refresh requests, and validate it.
     *
     * @param string $uriString Your application’s base URI
     *
     * @throws InvalidUrlException If the base URI is not a valid URI.
     */
    private function setBaseUri($uriString = null)
    {
        if (null === $uriString) {
            $this->baseUri = null;

            return;
        }

        $this->baseUri = $this->filterUri($uriString);
    }

    /**
     * Filter a URL
     *
     * Prefix the URL with "http://" if it has no scheme, then check the URL
     * for validity. You can specify what parts of the URL are allowed.
     *
     * @param string       $uriString
     * @param string[]     $allowedParts Array of allowed URL parts (optional)
     *
     * @return UriInterface Filtered URI (with default scheme if there was no scheme)
     *
     * @throws InvalidUrlException If URL is invalid, the scheme is not http or
     *                             contains parts that are not expected.
     */
    private function filterUri($uriString, array $allowedParts = [])
    {
        // Creating a PSR-7 URI without scheme (with parse_url) results in the
        // original hostname to be seen as path. So first add a scheme if none
        // is given.
        if (false === strpos($uriString, '://')) {
            $uriString = sprintf('%s://%s', 'http', $uriString);
        }

        try {
            $uri = UriFactoryDiscovery::find()->createUri($uriString);
        } catch (\InvalidArgumentException $e) {
            throw InvalidUrlException::invalidUrl($uriString);
        }

        if (!$uri->getScheme()) {
            throw InvalidUrlException::invalidUrl($uriString, 'empty scheme');
        }

        if (count($allowedParts) > 0) {
            $parts = parse_url((string) $uri);
            $diff = array_diff(array_keys($parts), $allowedParts);
            if (count($diff) > 0) {
                throw InvalidUrlException::invalidUrlParts($uriString, $allowedParts);
            }
        }

        return $uri;
    }

    /**
     * Build a request signature based on the request data. Unique for every different request, identical
     * for the same requests.
     *
     * This signature is used to avoid sending the same invalidation request twice.
     *
     * @param RequestInterface $request An invalidation request.
     *
     * @return string A signature for this request.
     */
    private function getRequestSignature(RequestInterface $request)
    {
        $headers = $request->getHeaders();
        ksort($headers);

        return md5($request->getMethod(). "\n" . $request->getUri(). "\n" . var_export($headers, true));
    }
}


1		<?php
2
3		namespace FOS\HttpCache\ProxyClient\Http;
4
5		use FOS\HttpCache\Exception\ExceptionCollection;
6		use FOS\HttpCache\Exception\InvalidArgumentException;
7		use FOS\HttpCache\Exception\InvalidUrlException;
8		use FOS\HttpCache\Exception\ProxyResponseException;
9		use FOS\HttpCache\Exception\ProxyUnreachableException;
10		use Http\Client\Exception;
11		use Http\Client\Exception\HttpException;
12		use Http\Client\Exception\RequestException;
13		use Http\Client\HttpAsyncClient;
14		use Http\Promise\Promise;
15		use Http\Discovery\UriFactoryDiscovery;
16		use Psr\Http\Message\RequestInterface;
17		use Psr\Http\Message\UriInterface;
18
19		/**
20		* An adapter to work with the Httplug asynchronous client.
21		*
22		* @author David Buchmann <[email protected]>
23		*/
24		class HttpAdapter
25		{
26		/**
27		* @var HttpAsyncClient
28		*/
29		private $httpClient;
30
31		/**
32		* Queued requests
33		*
34		* @var RequestInterface[]
35		*/
36		private $queue = [];
37
38		/**
39		* Caching proxy server host names or IP addresses.
40		*
41		* @var UriInterface[]
42		*/
43		private $servers;
44
45		/**
46		* Application host name and optional base URL.
47		*
48		* @var UriInterface
49		*/
50		private $baseUri;
51
52		/**
53		* @param string[] $servers Caching proxy server hostnames or IP
54		* addresses, including port if not port 80.
55		* E.g. ['127.0.0.1:6081']
56		* @param string $baseUri Default application hostname, optionally
57		* including base URL, for purge and refresh
58		* requests (optional). This is required if
59		* you purge and refresh paths instead of
60		* absolute URLs.
61		* @param HttpAsyncClient $httpClient
62		*/
63	45	public function __construct(array $servers, $baseUri, HttpAsyncClient $httpClient)
64		{
65	45	$this->setServers($servers);
66	42	$this->setBaseUri($baseUri);
67	42	$this->httpClient = $httpClient;
68	42	}
69
70		/**
71		* Queue invalidation request.
72		*
73		* @param RequestInterface $invalidationRequest
74		*/
75	37	public function invalidate(RequestInterface $invalidationRequest)
76		{
77	37	$signature = $this->getRequestSignature($invalidationRequest);
78
79	37	if (isset($this->queue[$signature])) {
80	1	return;
81		}
82
83	37	$this->queue[$signature] = $invalidationRequest;
84	37	}
85
86		/**
87		* Send all pending invalidation requests and make sure the requests have terminated and gather exceptions.
88		*
89		* @return int The number of cache invalidations performed per caching server.
90		*
91		* @throws ExceptionCollection If any errors occurred during flush.
92		*/
93	38	public function flush()
94		{
95	38	$queue = $this->queue;
96	38	$this->queue = [];
97		/** @var Promise[] $promises */
98	38	$promises = [];
99
100	38	$exceptions = new ExceptionCollection();
101
102	38	foreach ($queue as $request) {
103	37	foreach ($this->fanOut($request) as $proxyRequest) {
104	37	$promises[] = $this->httpClient->sendAsyncRequest($proxyRequest);
105	37	}
106	38	}
107
108	38	if (count($exceptions)) {
109		throw new ExceptionCollection($exceptions);
		0 ignored issues – show Documentation introduced 2015-12-07 13:45 UTC by Report Bug Copy Issue Report `$exceptions` is of type `object<FOS\HttpCache\Exc...on\ExceptionCollection>`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
110		}
111
112	38	foreach ($promises as $promise) {
113		try {
114	37	$promise->wait();
115	37	} catch (HttpException $exception) {
116		$exceptions->add(ProxyResponseException::proxyResponse($exception->getResponse()));
117	1	} catch (RequestException $exception) {
118	1	$exceptions->add(ProxyUnreachableException::proxyUnreachable($exception));
119	1	} catch (\Exception $exception) {
120		$exceptions->add(new InvalidArgumentException($exception));
121		}
122	38	}
123
124	38	if (count($exceptions)) {
125	1	throw $exceptions;
126		}
127
128	38	return count($queue);
129		}
130
131		/**
132		* Duplicate a request for each caching server
133		*
134		* @param RequestInterface $request The request to duplicate for each configured server
135		*
136		* @return RequestInterface[]
137		*/
138	37	private function fanOut(RequestInterface $request)
139		{
140	37	$requests = [];
141
142	37	$uri = $request->getUri();
143
144		// If a base URI is configured, try to make partial invalidation
145		// requests complete.
146	37	if ($this->baseUri) {
147	34	if ($uri->getHost()) {
148		// Absolute URI: does it already have a scheme?
149	2	if (!$uri->getScheme() && $this->baseUri->getScheme() !== '') {
150		$uri = $uri->withScheme($this->baseUri->getScheme());
151		}
152	2	} else {
153		// Relative URI
154	32	if ($this->baseUri->getHost() !== '') {
155	32	$uri = $uri->withHost($this->baseUri->getHost());
156	32	}
157
158	32	if ($this->baseUri->getPort()) {
		0 ignored issues – show Bug Best Practice introduced 2015-12-07 13:45 UTC by Report Bug Copy Issue Report The expression `$this->baseUri->getPort()` of type `null\|integer` is loosely compared to `true`; this is ambiguous if the integer can be zero. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
159	13	$uri = $uri->withPort($this->baseUri->getPort());
160	13	}
161
162		// Base path
163	32	if ($this->baseUri->getPath() !== '') {
164	1	$path = $this->baseUri->getPath() . '/' . ltrim($uri->getPath(), '/');
165	1	$uri = $uri->withPath($path);
166	1	}
167		}
168	34	}
169
170		// Close connections to make sure invalidation (PURGE/BAN) requests
171		// will not interfere with content (GET) requests.
172	37	$request = $request->withUri($uri)->withHeader('Connection', 'Close');
173
174		// Create a request to each caching proxy server
175	37	foreach ($this->servers as $server) {
176	37	$requests[] = $request->withUri(
177		$uri
178	37	->withScheme($server->getScheme())
179	37	->withHost($server->getHost())
180	37	->withPort($server->getPort())
181	37	,
182		true // Preserve application Host header
183	37	);
184	37	}
185
186	37	return $requests;
187		}
188
189		/**
190		* Set caching proxy server URI objects, validating them.
191		*
192		* @param string[] $servers Caching proxy proxy server hostnames or IP
193		* addresses, including port if not port 80.
194		* E.g. ['127.0.0.1:6081']
195		*
196		* @throws InvalidUrlException If server is invalid or contains URL
197		* parts other than scheme, host, port
198		*/
199	45	private function setServers(array $servers)
200		{
201	45	$this->servers = [];
202	45	foreach ($servers as $server) {
203	45	$this->servers[] = $this->filterUri($server, ['scheme', 'host', 'port']);
204	42	}
205	42	}
206
207		/**
208		* Set application base URI that will be prefixed to relative purge and
209		* refresh requests, and validate it.
210		*
211		* @param string $uriString Your application’s base URI
212		*
213		* @throws InvalidUrlException If the base URI is not a valid URI.
214		*/
215	42	private function setBaseUri($uriString = null)
216		{
217	42	if (null === $uriString) {
218	6	$this->baseUri = null;
219
220	6	return;
221		}
222
223	36	$this->baseUri = $this->filterUri($uriString);
224	36	}
225
226		/**
227		* Filter a URL
228		*
229		* Prefix the URL with "http://" if it has no scheme, then check the URL
230		* for validity. You can specify what parts of the URL are allowed.
231		*
232		* @param string $uriString
233		* @param string[] $allowedParts Array of allowed URL parts (optional)
234		*
235		* @return UriInterface Filtered URI (with default scheme if there was no scheme)
236		*
237		* @throws InvalidUrlException If URL is invalid, the scheme is not http or
238		* contains parts that are not expected.
239		*/
240	45	private function filterUri($uriString, array $allowedParts = [])
241		{
242		// Creating a PSR-7 URI without scheme (with parse_url) results in the
243		// original hostname to be seen as path. So first add a scheme if none
244		// is given.
245	45	if (false === strpos($uriString, '://')) {
246	40	$uriString = sprintf('%s://%s', 'http', $uriString);
247	40	}
248
249		try {
250	45	$uri = UriFactoryDiscovery::find()->createUri($uriString);
251	45	} catch (\InvalidArgumentException $e) {
252	1	throw InvalidUrlException::invalidUrl($uriString);
253		}
254
255	44	if (!$uri->getScheme()) {
256	1	throw InvalidUrlException::invalidUrl($uriString, 'empty scheme');
257		}
258
259	43	if (count($allowedParts) > 0) {
260	43	$parts = parse_url((string) $uri);
261	43	$diff = array_diff(array_keys($parts), $allowedParts);
262	43	if (count($diff) > 0) {
263	1	throw InvalidUrlException::invalidUrlParts($uriString, $allowedParts);
264		}
265	42	}
266
267	42	return $uri;
268		}
269
270		/**
271		* Build a request signature based on the request data. Unique for every different request, identical
272		* for the same requests.
273		*
274		* This signature is used to avoid sending the same invalidation request twice.
275		*
276		* @param RequestInterface $request An invalidation request.
277		*
278		* @return string A signature for this request.
279		*/
280	37	private function getRequestSignature(RequestInterface $request)
281		{
282	37	$headers = $request->getHeaders();
283	37	ksort($headers);
284
285	37	return md5($request->getMethod(). "\n" . $request->getUri(). "\n" . var_export($headers, true));
286		}
287		}
288

FriendsOfSymfony / FOSHttpCache

Pull Request — master (#257)

HttpAdapter::invalidate() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like