Client::open() - Code Metrics - Inspection of "Use HTTP factory and introduce stream handler" - sandrokeil/arangodb-php-client - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#7)

by Sandro

created 2019-06-06 21:11 UTC

Client::open() B

↳ Parent: Client

Complexity

Conditions	8
Paths	10

Size

Total Lines	53
Code Lines	33

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	16.8542

Importance

Changes

Metric	Value
eloc	33
dl	0
loc	53
ccs	14
cts	29
cp	0.4828
rs	8.1475
c	0
b	0
f	0
cc	8
nc	10
nop	1
crap	16.8542

How to fix Long Method

<?php
/**
 * Sandro Keil (https://sandro-keil.de)
 *
 * @link      http://github.com/sandrokeil/arangodb-php-client for the canonical source repository
 * @copyright Copyright (c) 2018-2019 Sandro Keil
 * @license   http://github.com/sandrokeil/arangodb-php-client/blob/master/LICENSE.md New BSD License
 */

declare(strict_types=1);

namespace ArangoDb;

use ArangoDb\Exception\ConnectionException;
use ArangoDb\Exception\NetworkException;
use ArangoDb\Exception\RequestFailedException;
use ArangoDb\Exception\TimeoutException;
use Fig\Http\Message\StatusCodeInterface;
use Psr\Http\Client\ClientInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseFactoryInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\StreamFactoryInterface;

final class Client implements ClientInterface
{
    /**
     * Chunk size in bytes
     */
    private const CHUNK_SIZE = 8192;

    /**
     * End of line mark used in HTTP
     */
    private const EOL = "\r\n";

    /**
     * Connection handle
     *
     * @var resource
     */
    private $handle;

    /**
     * @var bool
     */
    private $useKeepAlive;

    /**
     * @var ClientOptions
     */
    private $options;

    /**
     * @var string
     */
    private $baseUrl = '';

    /**
     * Default headers for all requests
     *
     * @var string
     */
    private $headerLines = '';

    /**
     * @var string
     */
    private $database = '';

    /**
     * @var ResponseFactoryInterface
     */
    private $responseFactory;

    /**
     * @var StreamFactoryInterface
     */
    private $streamFactory;

    /**
     * @param array|ClientOptions $options
     * @param ResponseFactoryInterface $responseFactory
     * @param StreamFactoryInterface $streamFactory
     */
    public function __construct(
        $options,
        ResponseFactoryInterface $responseFactory,
        StreamFactoryInterface $streamFactory
    ) {
        $this->options = $options instanceof ClientOptions ? $options : new ClientOptions($options);
        $this->useKeepAlive = ($this->options[ClientOptions::OPTION_CONNECTION] === 'Keep-Alive');
        $this->responseFactory = $responseFactory;
        $this->streamFactory = $streamFactory;
        $this->updateCommonHttpHeaders();
    }

    /**
     * Delegate / shorthand method
     *
     * @param RequestInterface $request
     * @return ResponseInterface
     * @throws \Psr\Http\Client\ClientExceptionInterface
     */
    public function __invoke(RequestInterface $request): ResponseInterface
    {
        return $this->sendRequest($request);
    }

    public function sendRequest(RequestInterface $request): ResponseInterface
    {
        try {
            $body = $request->getBody()->getContents();
            $method = $request->getMethod();

            $customHeaders = $request->getHeaders();
            unset($customHeaders['Connection'], $customHeaders['Content-Length']);

            if (! isset($customHeaders['Content-Type'])) {
                $customHeaders['Content-Type'] = ['application/json'];
            }

            $customHeader = '';
            foreach ($customHeaders as $headerKey => $headerValues) {
                foreach ($headerValues as $headerValue) {
                    $customHeader .= $headerKey . ': ' . $headerValue . self::EOL;
                }
            }
        } catch (\Throwable $e) {
            throw RequestFailedException::ofRequest($request, $e);
        }

        $customHeader .= 'Content-Length: ' . strlen($body) . self::EOL;

        $url = $this->baseUrl . $request->getUri();

        try {
            $this->open($request);

            $result = $this->transmit(
                $method . ' ' . $url . ' HTTP/1.1' .
                $this->headerLines .
                $customHeader . self::EOL .
                $body,
                $method
            );
            // TODO https://docs.arangodb.com/3.4/Manual/Architecture/DeploymentModes/ActiveFailover/Architecture.html
            $status = stream_get_meta_data($this->handle);

            if (true === $status['timed_out']) {
                throw TimeoutException::ofRequest($request);
            }
            if (! $this->useKeepAlive) {
                $this->close();
            }

            [$httpCode, $headers, $body] = HttpHelper::parseMessage($result);
        } catch (\Throwable $e) {
            throw NetworkException::with($request, $e);
        }
        $response = $this->responseFactory->createResponse($httpCode);

        foreach ($headers as $headerName => $header) {
            $response = $response->withAddedHeader($headerName, $header);
        }

        return $response->withBody($this->streamFactory->createStream($body));
    }

    /**
     * Sends request to server and reads response.
     *
     * @param string $request
     * @param string $method
     * @return string
     */
    private function transmit(string $request, string $method): string
    {
        fwrite($this->handle, $request);
        fflush($this->handle);

        $contentLength = 0;
        $bodyLength = 0;
        $readTotal = 0;
        $matches = [];
        $message = '';

        do {
            $read = fread($this->handle, self::CHUNK_SIZE);
            if (false === $read || $read === '') {
                break;
            }
            $readLength = strlen($read);
            $readTotal += $readLength;
            $message .= $read;

            if ($contentLength === 0
                && $method !== 'HEAD'
                && 1 === preg_match('/content-length: (\d+)/i', $message, $matches)
            ) {
                $contentLength = (int)$matches[1];
            }

            if ($bodyLength === 0) {
                $bodyStart = strpos($message, "\r\n\r\n");

                if (false !== $bodyStart) {
                    $bodyLength = $bodyStart + $contentLength + 4;
                }
            }
        } while ($readTotal < $bodyLength && ! feof($this->handle));

        return $message;
    }

    /**
     * Update common HTTP headers for all HTTP requests
     */
    private function updateCommonHttpHeaders(): void
    {
        $this->headerLines = self::EOL;

        $endpoint = $this->options[ClientOptions::OPTION_ENDPOINT];
        if (1 !== preg_match('/^unix:\/\/.+/', $endpoint)) {
            $this->headerLines .= 'Host: '
                . preg_replace('/^(tcp|ssl):\/\/(.+?):(\d+)\/?$/', '\\2', $endpoint)
                . self::EOL;
        }
        // add basic auth header
        if (isset(
            $this->options[ClientOptions::OPTION_AUTH_TYPE],
            $this->options[ClientOptions::OPTION_AUTH_USER]
        )) {
            $this->headerLines .= sprintf(
                'Authorization: %s %s%s',
                $this->options[ClientOptions::OPTION_AUTH_TYPE],
                base64_encode(
                    $this->options[ClientOptions::OPTION_AUTH_USER] . ':' .
                    $this->options[ClientOptions::OPTION_AUTH_PASSWD]
                ),
                self::EOL
            );
        }

        if (isset($this->options[ClientOptions::OPTION_CONNECTION])) {
            $this->headerLines .= 'Connection: ' . $this->options[ClientOptions::OPTION_CONNECTION] . self::EOL;
        }

        $this->database = $this->options[ClientOptions::OPTION_DATABASE];
        $this->baseUrl = '/_db/' . urlencode($this->database);
    }

    /**
     * Opens connection depending on options.
     *
     * @param RequestInterface $request
     */
    private function open(RequestInterface $request): void
    {
        if ($this->useKeepAlive && $this->handle !== null && is_resource($this->handle)) {
            if (! feof($this->handle)) {
                return;
            }

            $this->close();

            if (false === $this->options[ClientOptions::OPTION_RECONNECT]) {
                throw ConnectionException::forRequest(
                    $request,
                    'Server has closed the connection already.',
                    StatusCodeInterface::STATUS_REQUEST_TIMEOUT
                );
            }
        }

        $endpoint = $this->options[ClientOptions::OPTION_ENDPOINT];
        $context = stream_context_create();

        if (1 === preg_match('/^ssl:\/\/.+/', $endpoint)) {
            stream_context_set_option(
                $context,
                [
                    'ssl' => [
                        'verify_peer' => $this->options[ClientOptions::OPTION_VERIFY_CERT],
                        'verify_peer_name' => $this->options[ClientOptions::OPTION_VERIFY_CERT_NAME],
                        'allow_self_signed' => $this->options[ClientOptions::OPTION_ALLOW_SELF_SIGNED],
                        'ciphers' => $this->options[ClientOptions::OPTION_CIPHERS],
                    ],
                ]
            );
        }

        $handle = stream_socket_client(
            $endpoint,
            $errNo,
            $message,
            $this->options[ClientOptions::OPTION_TIMEOUT],
            STREAM_CLIENT_CONNECT,
            $context
        );

        if (false === $handle) {
            throw ConnectionException::forRequest(
                $request,
                sprintf('Cannot connect to endpoint "%s". Message: %s', $endpoint, $message),
                $errNo
            );
        }
        $this->handle = $handle;
        stream_set_timeout($this->handle, $this->options[ClientOptions::OPTION_TIMEOUT]);
    }

    /**
     * Closes connection
     */
    private function close(): void
    {
        fclose($this->handle);
        unset($this->handle);
    }
}


1		<?php
2		/**
3		* Sandro Keil (https://sandro-keil.de)
4		*
5		* @link http://github.com/sandrokeil/arangodb-php-client for the canonical source repository
6		* @copyright Copyright (c) 2018-2019 Sandro Keil
7		* @license http://github.com/sandrokeil/arangodb-php-client/blob/master/LICENSE.md New BSD License
8		*/
9
10		declare(strict_types=1);
11
12		namespace ArangoDb;
13
14		use ArangoDb\Exception\ConnectionException;
15		use ArangoDb\Exception\NetworkException;
16		use ArangoDb\Exception\RequestFailedException;
17		use ArangoDb\Exception\TimeoutException;
18		use Fig\Http\Message\StatusCodeInterface;
19		use Psr\Http\Client\ClientInterface;
20		use Psr\Http\Message\RequestInterface;
21		use Psr\Http\Message\ResponseFactoryInterface;
22		use Psr\Http\Message\ResponseInterface;
23		use Psr\Http\Message\StreamFactoryInterface;
24
25		final class Client implements ClientInterface
26		{
27		/**
28		* Chunk size in bytes
29		*/
30		private const CHUNK_SIZE = 8192;
31
32		/**
33		* End of line mark used in HTTP
34		*/
35		private const EOL = "\r\n";
36
37		/**
38		* Connection handle
39		*
40		* @var resource
41		*/
42		private $handle;
43
44		/**
45		* @var bool
46		*/
47		private $useKeepAlive;
48
49		/**
50		* @var ClientOptions
51		*/
52		private $options;
53
54		/**
55		* @var string
56		*/
57		private $baseUrl = '';
58
59		/**
60		* Default headers for all requests
61		*
62		* @var string
63		*/
64		private $headerLines = '';
65
66		/**
67		* @var string
68		*/
69		private $database = '';
70
71		/**
72		* @var ResponseFactoryInterface
73		*/
74		private $responseFactory;
75
76		/**
77		* @var StreamFactoryInterface
78		*/
79		private $streamFactory;
80
81		/**
82		* @param array\|ClientOptions $options
83		* @param ResponseFactoryInterface $responseFactory
84		* @param StreamFactoryInterface $streamFactory
85		*/
86	62	public function __construct(
87		$options,
88		ResponseFactoryInterface $responseFactory,
89		StreamFactoryInterface $streamFactory
90		) {
91	62	$this->options = $options instanceof ClientOptions ? $options : new ClientOptions($options);
92	62	$this->useKeepAlive = ($this->options[ClientOptions::OPTION_CONNECTION] === 'Keep-Alive');
93	62	$this->responseFactory = $responseFactory;
94	62	$this->streamFactory = $streamFactory;
95	62	$this->updateCommonHttpHeaders();
96	62	}
97
98		/**
99		* Delegate / shorthand method
100		*
101		* @param RequestInterface $request
102		* @return ResponseInterface
103		* @throws \Psr\Http\Client\ClientExceptionInterface
104		*/
105		public function __invoke(RequestInterface $request): ResponseInterface
106		{
107		return $this->sendRequest($request);
108		}
109
110	41	public function sendRequest(RequestInterface $request): ResponseInterface
111		{
112		try {
113	41	$body = $request->getBody()->getContents();
114	41	$method = $request->getMethod();
115
116	41	$customHeaders = $request->getHeaders();
117	41	unset($customHeaders['Connection'], $customHeaders['Content-Length']);
118
119	41	if (! isset($customHeaders['Content-Type'])) {
120	40	$customHeaders['Content-Type'] = ['application/json'];
121		}
122
123	41	$customHeader = '';
124	41	foreach ($customHeaders as $headerKey => $headerValues) {
125	41	foreach ($headerValues as $headerValue) {
126	41	$customHeader .= $headerKey . ': ' . $headerValue . self::EOL;
127		}
128		}
129		} catch (\Throwable $e) {
130		throw RequestFailedException::ofRequest($request, $e);
131		}
132
133	41	$customHeader .= 'Content-Length: ' . strlen($body) . self::EOL;
134
135	41	$url = $this->baseUrl . $request->getUri();
136
137		try {
138	41	$this->open($request);
139
140	41	$result = $this->transmit(
141	41	$method . ' ' . $url . ' HTTP/1.1' .
142	41	$this->headerLines .
143	41	$customHeader . self::EOL .
144	41	$body,
145		$method
146		);
147		// TODO https://docs.arangodb.com/3.4/Manual/Architecture/DeploymentModes/ActiveFailover/Architecture.html
148	41	$status = stream_get_meta_data($this->handle);
149
150	41	if (true === $status['timed_out']) {
151		throw TimeoutException::ofRequest($request);
152		}
153	41	if (! $this->useKeepAlive) {
154		$this->close();
155		}
156
157	41	[$httpCode, $headers, $body] = HttpHelper::parseMessage($result);
158		} catch (\Throwable $e) {
159		throw NetworkException::with($request, $e);
160		}
161	41	$response = $this->responseFactory->createResponse($httpCode);
162
163	41	foreach ($headers as $headerName => $header) {
164	41	$response = $response->withAddedHeader($headerName, $header);
165		}
166
167	41	return $response->withBody($this->streamFactory->createStream($body));
168		}
169
170		/**
171		* Sends request to server and reads response.
172		*
173		* @param string $request
174		* @param string $method
175		* @return string
176		*/
177	41	private function transmit(string $request, string $method): string
178		{
179	41	fwrite($this->handle, $request);
180	41	fflush($this->handle);
181
182	41	$contentLength = 0;
183	41	$bodyLength = 0;
184	41	$readTotal = 0;
185	41	$matches = [];
186	41	$message = '';
187
188		do {
189	41	$read = fread($this->handle, self::CHUNK_SIZE);
190	41	if (false === $read \|\| $read === '') {
191		break;
192		}
193	41	$readLength = strlen($read);
194	41	$readTotal += $readLength;
195	41	$message .= $read;
196
197	41	if ($contentLength === 0
198	41	&& $method !== 'HEAD'
199	41	&& 1 === preg_match('/content-length: (\d+)/i', $message, $matches)
200		) {
201	41	$contentLength = (int)$matches[1];
202		}
203
204	41	if ($bodyLength === 0) {
205	41	$bodyStart = strpos($message, "\r\n\r\n");
206
207	41	if (false !== $bodyStart) {
208	41	$bodyLength = $bodyStart + $contentLength + 4;
209		}
210		}
211	41	} while ($readTotal < $bodyLength && ! feof($this->handle));
212
213	41	return $message;
214		}
215
216		/**
217		* Update common HTTP headers for all HTTP requests
218		*/
219	62	private function updateCommonHttpHeaders(): void
220		{
221	62	$this->headerLines = self::EOL;
222
223	62	$endpoint = $this->options[ClientOptions::OPTION_ENDPOINT];
224	62	if (1 !== preg_match('/^unix:\/\/.+/', $endpoint)) {
225	62	$this->headerLines .= 'Host: '
226	62	. preg_replace('/^(tcp\|ssl):\/\/(.+?):(\d+)\/?$/', '\\2', $endpoint)
227	62	. self::EOL;
228		}
229		// add basic auth header
230		if (isset(
231	62	$this->options[ClientOptions::OPTION_AUTH_TYPE],
232	62	$this->options[ClientOptions::OPTION_AUTH_USER]
233		)) {
234		$this->headerLines .= sprintf(
235		'Authorization: %s %s%s',
236		$this->options[ClientOptions::OPTION_AUTH_TYPE],
237		base64_encode(
238		$this->options[ClientOptions::OPTION_AUTH_USER] . ':' .
239		$this->options[ClientOptions::OPTION_AUTH_PASSWD]
240		),
241		self::EOL
242		);
243		}
244
245	62	if (isset($this->options[ClientOptions::OPTION_CONNECTION])) {
246	62	$this->headerLines .= 'Connection: ' . $this->options[ClientOptions::OPTION_CONNECTION] . self::EOL;
247		}
248
249	62	$this->database = $this->options[ClientOptions::OPTION_DATABASE];
250	62	$this->baseUrl = '/_db/' . urlencode($this->database);
251	62	}
252
253		/**
254		* Opens connection depending on options.
255		*
256		* @param RequestInterface $request
257		*/
258	41	private function open(RequestInterface $request): void
259		{
260	41	if ($this->useKeepAlive && $this->handle !== null && is_resource($this->handle)) {
261	18	if (! feof($this->handle)) {
262	18	return;
263		}
264
265		$this->close();
266
267		if (false === $this->options[ClientOptions::OPTION_RECONNECT]) {
268		throw ConnectionException::forRequest(
269		$request,
270		'Server has closed the connection already.',
271		StatusCodeInterface::STATUS_REQUEST_TIMEOUT
272		);
273		}
274		}
275
276	41	$endpoint = $this->options[ClientOptions::OPTION_ENDPOINT];
277	41	$context = stream_context_create();
278
279	41	if (1 === preg_match('/^ssl:\/\/.+/', $endpoint)) {
280		stream_context_set_option(
281		$context,
282		[
283		'ssl' => [
284		'verify_peer' => $this->options[ClientOptions::OPTION_VERIFY_CERT],
285		'verify_peer_name' => $this->options[ClientOptions::OPTION_VERIFY_CERT_NAME],
286		'allow_self_signed' => $this->options[ClientOptions::OPTION_ALLOW_SELF_SIGNED],
287		'ciphers' => $this->options[ClientOptions::OPTION_CIPHERS],
288		],
289		]
290		);
291		}
292
293	41	$handle = stream_socket_client(
294	41	$endpoint,
295		$errNo,
296		$message,
297	41	$this->options[ClientOptions::OPTION_TIMEOUT],
298	41	STREAM_CLIENT_CONNECT,
299		$context
300		);
301
302	41	if (false === $handle) {
303		throw ConnectionException::forRequest(
304		$request,
305		sprintf('Cannot connect to endpoint "%s". Message: %s', $endpoint, $message),
306		$errNo
307		);
308		}
309	41	$this->handle = $handle;
310	41	stream_set_timeout($this->handle, $this->options[ClientOptions::OPTION_TIMEOUT]);
311	41	}
312
313		/**
314		* Closes connection
315		*/
316		private function close(): void
317		{
318		fclose($this->handle);
319		unset($this->handle);
320		}
321		}
322

sandrokeil / arangodb-php-client

Pull Request — master (#7)

Client::open() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like