PluginClient::createPluginChain() - Code Metrics - Inspection of "[WIP] Add Plugin Client" - php-http/client-common - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#14)

by Márk

created 2016-05-01 19:47 UTC

PluginClient::createPluginChain() B

↳ Parent: PluginClient

Complexity

Conditions	3
Paths	2

Size

Total Lines	25
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	15
CRAP Score	3

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	25
ccs	15
cts	15
cp	1
rs	8.8571
cc	3
eloc	13
nc	2
nop	2
crap	3

<?php

namespace Http\Client\Common;

use Http\Client\Common\Exception\LoopException;
use Http\Client\Exception as HttplugException;
use Http\Client\HttpAsyncClient;
use Http\Client\HttpClient;
use Http\Promise\FulfilledPromise;
use Http\Promise\RejectedPromise;
use Psr\Http\Message\RequestInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;

/**
 * The client managing plugins and providing a decorator around HTTP Clients.
 *
 * @author Joel Wurtz <[email protected]>
 */
final class PluginClient implements HttpClient, HttpAsyncClient
{
    /**
     * An HTTP async client.
     *
     * @var HttpAsyncClient
     */
    private $client;

    /**
     * The plugin chain.
     *
     * @var Plugin[]
     */
    private $plugins;

    /**
     * A list of options.
     *
     * @var array
     */
    private $options;

    /**
     * @param HttpClient|HttpAsyncClient $client
     * @param Plugin[]                   $plugins
     * @param array                      $options {
     *
     *     @var int $max_restarts
     * }
     *
     * @throws \RuntimeException if client is not an instance of HttpClient or HttpAsyncClient
     */
    public function __construct($client, array $plugins = [], array $options = [])
    {
        if ($client instanceof HttpAsyncClient) {
            $this->client = $client;
        } elseif ($client instanceof HttpClient) {
            $this->client = new EmulatedHttpAsyncClient($client);
        } else {
            throw new \RuntimeException('Client must be an instance of Http\\Client\\HttpClient or Http\\Client\\HttpAsyncClient');
        }

        $this->plugins = $plugins;
        $this->options = $this->configure($options);
    }

    /**
     * {@inheritdoc}
     */
    public function sendRequest(RequestInterface $request)
    {
        // If we don't have an http client, use the async call
        if (!($this->client instanceof HttpClient)) {
            return $this->sendAsyncRequest($request)->wait();
        }

        // Else we want to use the synchronous call of the underlying client, and not the async one in the case
        // we have both an async and sync call
        $pluginChain = $this->createPluginChain($this->plugins, function (RequestInterface $request) {
            try {
                return new FulfilledPromise($this->client->sendRequest($request));
            } catch (HttplugException $exception) {
                return new RejectedPromise($exception);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return $pluginChain($request)->wait();
    }

    /**
     * {@inheritdoc}
     */
    public function sendAsyncRequest(RequestInterface $request)
    {
        $pluginChain = $this->createPluginChain($this->plugins, function (RequestInterface $request) {
            return $this->client->sendAsyncRequest($request);
        });

        return $pluginChain($request);
    }

    /**
     * Configure the plugin client.
     *
     * @param array $options
     *
     * @return array
     */
    private function configure(array $options = [])
    {
        $resolver = new OptionsResolver();
        $resolver->setDefaults([
            'max_restarts' => 10,
        ]);

        return $resolver->resolve($options);
    }

    /**
     * Create the plugin chain.
     *
     * @param Plugin[] $pluginList     A list of plugins
     * @param callable $clientCallable Callable making the HTTP call
     *
     * @return callable
     */
    private function createPluginChain($pluginList, callable $clientCallable)
    {
        $firstCallable = $lastCallable = $clientCallable;

        while ($plugin = array_pop($pluginList)) {
            $lastCallable = function (RequestInterface $request) use ($plugin, $lastCallable, &$firstCallable) {
                return $plugin->handleRequest($request, $lastCallable, $firstCallable);
            };

            $firstCallable = $lastCallable;
        }

        $firstCalls = 0;
        $firstCallable = function (RequestInterface $request) use ($lastCallable, &$firstCalls) {
            if ($firstCalls > $this->options['max_restarts']) {
                throw new LoopException('Too many restarts in plugin client', $request);
            }

            ++$firstCalls;

            return $lastCallable($request);
        };

        return $firstCallable;
    }
}


1		<?php
2
3		namespace Http\Client\Common;
4
5		use Http\Client\Common\Exception\LoopException;
6		use Http\Client\Exception as HttplugException;
7		use Http\Client\HttpAsyncClient;
8		use Http\Client\HttpClient;
9		use Http\Promise\FulfilledPromise;
10		use Http\Promise\RejectedPromise;
11		use Psr\Http\Message\RequestInterface;
12		use Symfony\Component\OptionsResolver\OptionsResolver;
13
14		/**
15		* The client managing plugins and providing a decorator around HTTP Clients.
16		*
17		* @author Joel Wurtz <[email protected]>
18		*/
19		final class PluginClient implements HttpClient, HttpAsyncClient
20		{
21		/**
22		* An HTTP async client.
23		*
24		* @var HttpAsyncClient
25		*/
26		private $client;
27
28		/**
29		* The plugin chain.
30		*
31		* @var Plugin[]
32		*/
33		private $plugins;
34
35		/**
36		* A list of options.
37		*
38		* @var array
39		*/
40		private $options;
41
42		/**
43		* @param HttpClient\|HttpAsyncClient $client
44		* @param Plugin[] $plugins
45		* @param array $options {
46		*
47		* @var int $max_restarts
48		* }
49		*
50		* @throws \RuntimeException if client is not an instance of HttpClient or HttpAsyncClient
51		*/
52	8	public function __construct($client, array $plugins = [], array $options = [])
53		{
54	8	if ($client instanceof HttpAsyncClient) {
55	3	$this->client = $client;
56	8	} elseif ($client instanceof HttpClient) {
57	5	$this->client = new EmulatedHttpAsyncClient($client);
58	5	} else {
59		throw new \RuntimeException('Client must be an instance of Http\\Client\\HttpClient or Http\\Client\\HttpAsyncClient');
60		}
61
62	8	$this->plugins = $plugins;
63	8	$this->options = $this->configure($options);
64	8	}
65
66		/**
67		* {@inheritdoc}
68		*/
69	4	public function sendRequest(RequestInterface $request)
70		{
71		// If we don't have an http client, use the async call
72	4	if (!($this->client instanceof HttpClient)) {
73	1	return $this->sendAsyncRequest($request)->wait();
74		}
75
76		// Else we want to use the synchronous call of the underlying client, and not the async one in the case
77		// we have both an async and sync call
78		$pluginChain = $this->createPluginChain($this->plugins, function (RequestInterface $request) {
79		try {
80	2	return new FulfilledPromise($this->client->sendRequest($request));
81		} catch (HttplugException $exception) {
82		return new RejectedPromise($exception);
		0 ignored issues – show Documentation introduced 2016-03-03 22:55 UTC by Report Bug Copy Issue Report `$exception` is of type `object<Http\Client\Exception>`, but the function expects a `object<Exception>`. 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...
83		}
84	3	});
85
86	3	return $pluginChain($request)->wait();
87		}
88
89		/**
90		* {@inheritdoc}
91		*/
92	2	public function sendAsyncRequest(RequestInterface $request)
93		{
94		$pluginChain = $this->createPluginChain($this->plugins, function (RequestInterface $request) {
95	2	return $this->client->sendAsyncRequest($request);
96	2	});
97
98	2	return $pluginChain($request);
99		}
100
101		/**
102		* Configure the plugin client.
103		*
104		* @param array $options
105		*
106		* @return array
107		*/
108	8	private function configure(array $options = [])
109		{
110	8	$resolver = new OptionsResolver();
111	8	$resolver->setDefaults([
112	8	'max_restarts' => 10,
113	8	]);
114
115	8	return $resolver->resolve($options);
116		}
117
118		/**
119		* Create the plugin chain.
120		*
121		* @param Plugin[] $pluginList A list of plugins
122		* @param callable $clientCallable Callable making the HTTP call
123		*
124		* @return callable
125		*/
126	5	private function createPluginChain($pluginList, callable $clientCallable)
127		{
128	5	$firstCallable = $lastCallable = $clientCallable;
129
130	5	while ($plugin = array_pop($pluginList)) {
131		$lastCallable = function (RequestInterface $request) use ($plugin, $lastCallable, &$firstCallable) {
132	1	return $plugin->handleRequest($request, $lastCallable, $firstCallable);
133	1	};
134
135	1	$firstCallable = $lastCallable;
136	1	}
137
138	5	$firstCalls = 0;
139	5	$firstCallable = function (RequestInterface $request) use ($lastCallable, &$firstCalls) {
140	5	if ($firstCalls > $this->options['max_restarts']) {
141	1	throw new LoopException('Too many restarts in plugin client', $request);
142		}
143
144	5	++$firstCalls;
145
146	5	return $lastCallable($request);
147	5	};
148
149	5	return $firstCallable;
150		}
151		}
152

php-http / client-common

Pull Request — master (#14)

PluginClient::createPluginChain() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like