Guzzle6Adapter::setCorrelationIdProvider() - Code Metrics - Inspection of "Add correlationId provider" - commercetools/commercetools-php-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#333)

by Jens

created 2017-08-07 11:09 UTC

Guzzle6Adapter::setCorrelationIdProvider() A

↳ Parent: Guzzle6Adapter

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes

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

<?php
/**
 * @author @jayS-de <[email protected]>
 */

namespace Commercetools\Core\Client\Adapter;

use Commercetools\Core\Helper\CorrelationIdProvider;
use Commercetools\Core\Response\AbstractApiResponse;
use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;
use GuzzleHttp\MessageFormatter;
use GuzzleHttp\Middleware;
use GuzzleHttp\Pool;
use GuzzleHttp\Promise\PromiseInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Log\LoggerInterface;
use Commercetools\Core\Error\Message;
use Commercetools\Core\Error\ApiException;
use Psr\Log\LogLevel;

class Guzzle6Adapter implements AdapterInterface, CorrelationIdAware
{
    /**
     * @var Client
     */
    protected $client;

    protected $logger;

    public function __construct(array $options = [])
    {
        $options = array_merge(
            [
                'allow_redirects' => false,
                'verify' => true,
                'timeout' => 60,
                'connect_timeout' => 10,
                'pool_size' => 25
            ],
            $options
        );
        $this->client = new Client($options);
    }

    public function setLogger(LoggerInterface $logger, $logLevel = LogLevel::INFO, $formatter = null)
    {
        if (is_null($formatter)) {
            $formatter = new MessageFormatter();
        }
        $this->logger = $logger;
        $this->addHandler(self::log($logger, $formatter, $logLevel));
    }

    public function setCorrelationIdProvider(CorrelationIdProvider $provider)
    {
        $this->addHandler(Middleware::mapRequest(function (RequestInterface $request) use ($provider) {
            return $request->withAddedHeader(
                AbstractApiResponse::X_CORRELATION_ID,
                $provider->getCorrelationId()
            );
        }));
    }

    /**
     * Middleware that logs requests, responses, and errors using a message
     * formatter.
     *
     * @param LoggerInterface  $logger Logs messages.
     * @param MessageFormatter $formatter Formatter used to create message strings.
     * @param string           $logLevel Level at which to log requests.
     *
     * @return callable Returns a function that accepts the next handler.
     */
    private static function log(LoggerInterface $logger, MessageFormatter $formatter, $logLevel = LogLevel::INFO)
    {
        return function (callable $handler) use ($logger, $formatter, $logLevel) {
            return function ($request, array $options) use ($handler, $logger, $formatter, $logLevel) {
                return $handler($request, $options)->then(
                    function ($response) use ($logger, $request, $formatter, $logLevel) {
                        $message = $formatter->format($request, $response);
                        $context[AbstractApiResponse::X_CORRELATION_ID] = $response->getHeader(
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
                            AbstractApiResponse::X_CORRELATION_ID
                        );
                        $logger->log($logLevel, $message, $context);
                        return $response;
                    },
                    function ($reason) use ($logger, $request, $formatter) {
                        $response = null;
                        $context = [];
                        if ($reason instanceof RequestException) {
                            $response = $reason->getResponse();
                            if (!is_null($response)) {
                                $context[AbstractApiResponse::X_CORRELATION_ID] = $response->getHeader(
                                    AbstractApiResponse::X_CORRELATION_ID
                                );
                            }
                        }
                        $message = $formatter->format($request, $response, $reason);
                        $logger->notice($message, $context);
                        return \GuzzleHttp\Promise\rejection_for($reason);
                    }
                );
            };
        };
    }

    public function addHandler($handler)
    {
        $this->client->getConfig('handler')->push($handler);
    }

    /**
     * @param RequestInterface $request
     * @return ResponseInterface
     */
    public function execute(RequestInterface $request)
    {
        try {
            $response = $this->client->send($request);
        } catch (RequestException $exception) {
            $response = $exception->getResponse();
            throw ApiException::create($request, $response, $exception);
        }

        return $response;
    }

    /**
     * @param RequestInterface[] $requests
     * @return ResponseInterface[]
     */
    public function executeBatch(array $requests)
    {
        $results = Pool::batch(
            $this->client,
            $requests
        );

        $responses = [];
        foreach ($results as $key => $result) {
            $httpResponse = $result;
            if ($result instanceof RequestException) {

                $request = $requests[$key];
                $httpResponse = $result->getResponse();
                $httpResponse = ApiException::create($request, $httpResponse, $result);
            }
            $responses[$key] = $httpResponse;
        }

        return $responses;
    }

    /**
     * @param $oauthUri
     * @param $clientId
     * @param $clientSecret
     * @param $formParams
     * @return ResponseInterface
     */
    public function authenticate($oauthUri, $clientId, $clientSecret, $formParams)
    {
        $options = [
            'form_params' => $formParams,
            'auth' => [$clientId, $clientSecret]
        ];

        try {
            $response = $this->client->post($oauthUri, $options);
        } catch (RequestException $exception) {
            throw ApiException::create($exception->getRequest(), $exception->getResponse(), $exception);
        }
        return $response;
    }

    /**
     * @param RequestInterface $request
     * @return AdapterPromiseInterface
     */
    public function executeAsync(RequestInterface $request)
    {
        $guzzlePromise = $this->client->sendAsync($request);

        return new Guzzle6Promise($guzzlePromise);
    }

    public static function getAdapterInfo()
    {
        return 'GuzzleHttp/' . Client::VERSION;
    }
}


1			<?php
2			/**
3			* @author @jayS-de <[email protected]>
4			*/
5
6			namespace Commercetools\Core\Client\Adapter;
7
8			use Commercetools\Core\Helper\CorrelationIdProvider;
9			use Commercetools\Core\Response\AbstractApiResponse;
10			use GuzzleHttp\Client;
11			use GuzzleHttp\Exception\RequestException;
12			use GuzzleHttp\MessageFormatter;
13			use GuzzleHttp\Middleware;
14			use GuzzleHttp\Pool;
15			use GuzzleHttp\Promise\PromiseInterface;
16			use Psr\Http\Message\RequestInterface;
17			use Psr\Http\Message\ResponseInterface;
18			use Psr\Log\LoggerInterface;
19			use Commercetools\Core\Error\Message;
20			use Commercetools\Core\Error\ApiException;
21			use Psr\Log\LogLevel;
22
23			class Guzzle6Adapter implements AdapterInterface, CorrelationIdAware
24			{
25			/**
26			* @var Client
27			*/
28			protected $client;
29
30			protected $logger;
31
32	110		public function __construct(array $options = [])
33			{
34	110		$options = array_merge(
35			[
36	110		'allow_redirects' => false,
37			'verify' => true,
38			'timeout' => 60,
39			'connect_timeout' => 10,
40			'pool_size' => 25
41			],
42	110		$options
43			);
44	110		$this->client = new Client($options);
45	110		}
46
47	44		public function setLogger(LoggerInterface $logger, $logLevel = LogLevel::INFO, $formatter = null)
48			{
49	44		if (is_null($formatter)) {
50	44		$formatter = new MessageFormatter();
51			}
52	44		$this->logger = $logger;
53	44		$this->addHandler(self::log($logger, $formatter, $logLevel));
54	44		}
55
56			public function setCorrelationIdProvider(CorrelationIdProvider $provider)
57			{
58	475		$this->addHandler(Middleware::mapRequest(function (RequestInterface $request) use ($provider) {
59	475		return $request->withAddedHeader(
60	475		AbstractApiResponse::X_CORRELATION_ID,
61	475		$provider->getCorrelationId()
62			);
63	39		}));
64	39		}
65
66			/**
67			* Middleware that logs requests, responses, and errors using a message
68			* formatter.
69			*
70			* @param LoggerInterface $logger Logs messages.
71			* @param MessageFormatter $formatter Formatter used to create message strings.
72			* @param string $logLevel Level at which to log requests.
73			*
74			* @return callable Returns a function that accepts the next handler.
75			*/
76			private static function log(LoggerInterface $logger, MessageFormatter $formatter, $logLevel = LogLevel::INFO)
77			{
78			return function (callable $handler) use ($logger, $formatter, $logLevel) {
79	481		return function ($request, array $options) use ($handler, $logger, $formatter, $logLevel) {
80	481		return $handler($request, $options)->then(
81	481		function ($response) use ($logger, $request, $formatter, $logLevel) {
82	481		$message = $formatter->format($request, $response);
83	481		$context[AbstractApiResponse::X_CORRELATION_ID] = $response->getHeader(
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-09-26 12:42 UTC by Report Bug Copy Issue Report `$context` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$context = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
84	481		AbstractApiResponse::X_CORRELATION_ID
85			);
86	481		$logger->log($logLevel, $message, $context);
87	481		return $response;
88	481		},
89	481		function ($reason) use ($logger, $request, $formatter) {
90			$response = null;
91			$context = [];
92			if ($reason instanceof RequestException) {
93			$response = $reason->getResponse();
94			if (!is_null($response)) {
95			$context[AbstractApiResponse::X_CORRELATION_ID] = $response->getHeader(
96			AbstractApiResponse::X_CORRELATION_ID
97			);
98			}
99			}
100			$message = $formatter->format($request, $response, $reason);
101			$logger->notice($message, $context);
102			return \GuzzleHttp\Promise\rejection_for($reason);
103	481		}
104			);
105	39		};
106	44		};
107			}
108
109	47		public function addHandler($handler)
110			{
111	47		$this->client->getConfig('handler')->push($handler);
112	47		}
113
114			/**
115			* @param RequestInterface $request
116			* @return ResponseInterface
117			*/
118	524		public function execute(RequestInterface $request)
119			{
120			try {
121	524		$response = $this->client->send($request);
122	111		} catch (RequestException $exception) {
123	111		$response = $exception->getResponse();
124	111		throw ApiException::create($request, $response, $exception);
125			}
126
127	498		return $response;
128			}
129
130			/**
131			* @param RequestInterface[] $requests
132			* @return ResponseInterface[]
133			*/
134	402		public function executeBatch(array $requests)
135			{
136	402		$results = Pool::batch(
137	402		$this->client,
138	402		$requests
139			);
140
141	402		$responses = [];
142	402		foreach ($results as $key => $result) {
143	402		$httpResponse = $result;
144	402	View Code Duplication	if ($result instanceof RequestException) {
			0 ignored issues – show Duplication introduced 2015-12-07 15:55 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
145	16		$request = $requests[$key];
146	16		$httpResponse = $result->getResponse();
147	16		$httpResponse = ApiException::create($request, $httpResponse, $result);
148			}
149	402		$responses[$key] = $httpResponse;
150			}
151
152	402		return $responses;
153			}
154
155			/**
156			* @param $oauthUri
157			* @param $clientId
158			* @param $clientSecret
159			* @param $formParams
160			* @return ResponseInterface
161			*/
162	45		public function authenticate($oauthUri, $clientId, $clientSecret, $formParams)
163			{
164			$options = [
165	45		'form_params' => $formParams,
166	45		'auth' => [$clientId, $clientSecret]
167			];
168
169			try {
170	45		$response = $this->client->post($oauthUri, $options);
171	3		} catch (RequestException $exception) {
172	3		throw ApiException::create($exception->getRequest(), $exception->getResponse(), $exception);
173			}
174	44		return $response;
175			}
176
177			/**
178			* @param RequestInterface $request
179			* @return AdapterPromiseInterface
180			*/
181	4		public function executeAsync(RequestInterface $request)
182			{
183	4		$guzzlePromise = $this->client->sendAsync($request);
184
185	4		return new Guzzle6Promise($guzzlePromise);
186			}
187
188	74		public static function getAdapterInfo()
189			{
190	74		return 'GuzzleHttp/' . Client::VERSION;
191			}
192			}
193

commercetools / commercetools-php-sdk

Pull Request — develop (#333)

Guzzle6Adapter::setCorrelationIdProvider() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like