Client::sendAsyncRequest() - Code Metrics - php-http/artax-adapter - Measure and Improve Code Quality continuously with Scrutinizer

Client::sendAsyncRequest() A
last analyzed 2018-01-23 17:52 UTC

↳ Parent: Client

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

namespace Http\Adapter\Artax;

use Amp\Artax;
use Amp\CancellationTokenSource;
use Amp\Promise;
use Http\Client\Exception\RequestException;
use Http\Client\Exception\TransferException;
use Http\Client\HttpAsyncClient;
use Http\Client\HttpClient;
use Http\Discovery\MessageFactoryDiscovery;
use Http\Message\ResponseFactory;
use Http\Message\StreamFactory;
use Psr\Http\Message\RequestInterface;
use function Amp\call;

class Client implements HttpClient, HttpAsyncClient
{
    private $client;

    private $responseFactory;

    /**
     * @param Artax\Client    $client          HTTP client implementation.
     * @param ResponseFactory $responseFactory Response factory to use or `null` to attempt auto-discovery.
     * @param StreamFactory   $streamFactory   This parameter will be ignored and removed in the next major version.
     */
    public function __construct(
        Artax\Client $client = null,
        ResponseFactory $responseFactory = null,
        StreamFactory $streamFactory = null
    ) {
        $this->client = $client ?? new Artax\DefaultClient();
        $this->responseFactory = $responseFactory ?? MessageFactoryDiscovery::find();

        if (null === $streamFactory || 3 === \func_num_args()) {
            @\trigger_error('The $streamFactory parameter is deprecated and ignored.', \E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        }
    }

    /** {@inheritdoc} */
    public function sendRequest(RequestInterface $request)
    {
        return $this->doRequest($request)->wait();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /** {@inheritdoc} */
    public function sendAsyncRequest(RequestInterface $request)
    {
        return $this->doRequest($request, false);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    protected function doRequest(RequestInterface $request, $useInternalStream = true): Promise
    {
        return new Internal\Promise(
            call(function () use ($request, $useInternalStream) {
                $cancellationTokenSource = new CancellationTokenSource();

                /** @var Artax\Request $req */
                $req = new Artax\Request($request->getUri(), $request->getMethod());
                $req = $req->withProtocolVersions([$request->getProtocolVersion()]);
                $req = $req->withHeaders($request->getHeaders());
                $req = $req->withBody((string) $request->getBody());

                try {
                    /** @var Artax\Response $resp */
                    $resp = yield $this->client->request($req, [
                        Artax\Client::OP_MAX_REDIRECTS => 0,
                    ], $cancellationTokenSource->getToken());
                } catch (Artax\HttpException $e) {
                    throw new RequestException($e->getMessage(), $request, $e);
                } catch (\Throwable $e) {
                    throw new TransferException($e->getMessage(), 0, $e);
                }

                if ($useInternalStream) {
                    $body = new Internal\ResponseStream($resp->getBody()->getInputStream(), $cancellationTokenSource);
                } else {
                    $body = yield $resp->getBody();
                }

                $response = $this->responseFactory->createResponse(
                    $resp->getStatus(),
                    $resp->getReason(),
                    $resp->getHeaders(),
                    $body,
                    $resp->getProtocolVersion()
                );

                return $response;
            })
        );
    }
}


1		<?php
2
3		namespace Http\Adapter\Artax;
4
5		use Amp\Artax;
6		use Amp\CancellationTokenSource;
7		use Amp\Promise;
8		use Http\Client\Exception\RequestException;
9		use Http\Client\Exception\TransferException;
10		use Http\Client\HttpAsyncClient;
11		use Http\Client\HttpClient;
12		use Http\Discovery\MessageFactoryDiscovery;
13		use Http\Message\ResponseFactory;
14		use Http\Message\StreamFactory;
15		use Psr\Http\Message\RequestInterface;
16		use function Amp\call;
17
18		class Client implements HttpClient, HttpAsyncClient
19		{
20		private $client;
21
22		private $responseFactory;
23
24		/**
25		* @param Artax\Client $client HTTP client implementation.
26		* @param ResponseFactory $responseFactory Response factory to use or `null` to attempt auto-discovery.
27	52	* @param StreamFactory $streamFactory This parameter will be ignored and removed in the next major version.
28		*/
29		public function __construct(
30		Artax\Client $client = null,
31		ResponseFactory $responseFactory = null,
32	52	StreamFactory $streamFactory = null
33	52	) {
34		$this->client = $client ?? new Artax\DefaultClient();
35	52	$this->responseFactory = $responseFactory ?? MessageFactoryDiscovery::find();
36	1
37		if (null === $streamFactory \|\| 3 === \func_num_args()) {
38	52	@\trigger_error('The $streamFactory parameter is deprecated and ignored.', \E_USER_DEPRECATED);
		0 ignored issues – show Security Best Practice introduced 2017-07-28 16:36 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
39		}
40		}
41
42		/** {@inheritdoc} */
43	51	public function sendRequest(RequestInterface $request)
44	51	{
45		return $this->doRequest($request)->wait();
		0 ignored issues – show Bug introduced 2018-01-23 17:52 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Amp\Promise` as the method `wait()` does only exist in the following implementations of said interface: `Http\Adapter\Artax\Internal\Promise`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
46		}
47	51
48	51	/** {@inheritdoc} */
49	51	public function sendAsyncRequest(RequestInterface $request)
50	51	{
51		return $this->doRequest($request, false);
		0 ignored issues – show Bug Best Practice introduced 2018-01-23 17:52 UTC by Report Bug Copy Issue Report The return type of `return $this->doRequest($request, false);` (`Amp\Promise`) is incompatible with the return type declared by the interface `Http\Client\HttpAsyncClient::sendAsyncRequest` of type `Http\Promise\Promise`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
52		}
53
54	51	protected function doRequest(RequestInterface $request, $useInternalStream = true): Promise
55	51	{
56	51	return new Internal\Promise(
57	1	call(function () use ($request, $useInternalStream) {
58	1	$cancellationTokenSource = new CancellationTokenSource();
59
60		/** @var Artax\Request $req */
61	50	$req = new Artax\Request($request->getUri(), $request->getMethod());
62	50	$req = $req->withProtocolVersions([$request->getProtocolVersion()]);
63	50	$req = $req->withHeaders($request->getHeaders());
64	50	$req = $req->withBody((string) $request->getBody());
65	50
66	50	try {
67		/** @var Artax\Response $resp */
68	51	$resp = yield $this->client->request($req, [
69		Artax\Client::OP_MAX_REDIRECTS => 0,
70		], $cancellationTokenSource->getToken());
71		} catch (Artax\HttpException $e) {
72		throw new RequestException($e->getMessage(), $request, $e);
73		} catch (\Throwable $e) {
74		throw new TransferException($e->getMessage(), 0, $e);
75		}
76
77		if ($useInternalStream) {
78		$body = new Internal\ResponseStream($resp->getBody()->getInputStream(), $cancellationTokenSource);
79		} else {
80		$body = yield $resp->getBody();
81		}
82
83		$response = $this->responseFactory->createResponse(
84		$resp->getStatus(),
85		$resp->getReason(),
86		$resp->getHeaders(),
87		$body,
88		$resp->getProtocolVersion()
89		);
90
91		return $response;
92		})
93		);
94		}
95		}
96

php-http / artax-adapter

Client::sendAsyncRequest() A last analyzed 2018-01-23 17:52 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

Client::sendAsyncRequest() A
last analyzed 2018-01-23 17:52 UTC