ObservableBunny::onError() - Code Metrics - Inspection of "test when an error occurs on consume" - WyriHaximus/reactphp-observable-bunny - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f51a54...1c8d09 )

by Cees-Jan

created 2018-02-15 21:02 UTC

ObservableBunny::onError() A

↳ Parent: ObservableBunny

Complexity

Conditions	2
Paths	1

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

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

<?php declare(strict_types=1);

namespace WyriHaximus\React\ObservableBunny;

use Bunny\Async\Client;
use Bunny\Channel;
use Bunny\Message as BunnyMessage;
use Bunny\Protocol\MethodBasicConsumeOkFrame;
use React\EventLoop\LoopInterface;
use React\EventLoop\Timer\TimerInterface;
use React\Promise\PromiseInterface;
use Rx\Subject\Subject;
use Throwable;

final class ObservableBunny
{
    /**
     * @var LoopInterface
     */
    private $loop;

    /**
     * @var Client
     */
    private $bunny;

    /**
     * @param LoopInterface $loop
     * @param Client        $bunny
     */
    public function __construct(LoopInterface $loop, Client $bunny)
    {
        $this->loop = $loop;
        $this->bunny = $bunny;
    }

    public function consume(
        string $queue = '',
        string $consumerTag = '',
        bool $noLocal = false,
        bool $noAck = false,
        bool $exclusive = false,
        bool $nowait = false,
        array $arguments = []
    ): Subject {
        $subject = new Subject();
        $consumeArgs = [$queue, $consumerTag, $noLocal, $noAck, $exclusive, $nowait, $arguments];

        $channel = $this->bunny->channel();
        $channel->then(function (Channel $channel) use ($subject, $consumeArgs) {
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            /** @var string $consumerTag */
            $consumerTag = null;
            $timer = $this->loop->addPeriodicTimer(1, function () use ($channel, $subject, &$timer, &$consumerTag) {
                if (!$subject->isDisposed()) {
                    return;
                }

                $this->cancelSubscription(
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.
    }
}
                    $timer,
                    $channel,
                    $consumerTag
                )->done([$subject, 'onComplete'], $this->onError($subject, $timer));
            });
            $channel->consume(
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                function (BunnyMessage $message, Channel $channel) use ($subject, &$timer, &$consumerTag) {
                    if ($subject->isDisposed()) {
                        $channel->nack($message);
                        $this->cancelSubscription(
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.
    }
}
                            $timer,
                            $channel,
                            $consumerTag
                        )->done([$subject, 'onComplete'], $this->onError($subject, $timer));

                        return;
                    }

                    $subject->onNext(new Message($message, $channel));
                },
                ...$consumeArgs
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            )->then(function (MethodBasicConsumeOkFrame $response) use (&$consumerTag) {
                $consumerTag = $response->consumerTag;
            })->done(null, $this->onError($subject, $timer));
        })->done(null, [$subject, 'onError']);

        return $subject;
    }

    private function cancelSubscription(TimerInterface $timer, Channel $channel, string $consumerTag): PromiseInterface
    {
        $this->loop->cancelTimer($timer);

        return $channel->cancel($consumerTag)->then(function () use ($channel) {
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            return $channel->close();
        });
    }

    private function onError(Subject $subject, TimerInterface $timer): callable
    {
        return function (Throwable $et) use ($subject, $timer) {
            if ($this->loop->isTimerActive($timer)) {
                $this->loop->cancelTimer($timer);
            }
            $subject->onError($et);
        };
    }
}


1		<?php declare(strict_types=1);
2
3		namespace WyriHaximus\React\ObservableBunny;
4
5		use Bunny\Async\Client;
6		use Bunny\Channel;
7		use Bunny\Message as BunnyMessage;
8		use Bunny\Protocol\MethodBasicConsumeOkFrame;
9		use React\EventLoop\LoopInterface;
10		use React\EventLoop\Timer\TimerInterface;
11		use React\Promise\PromiseInterface;
12		use Rx\Subject\Subject;
13		use Throwable;
14
15		final class ObservableBunny
16		{
17		/**
18		* @var LoopInterface
19		*/
20		private $loop;
21
22		/**
23		* @var Client
24		*/
25		private $bunny;
26
27		/**
28		* @param LoopInterface $loop
29	1	* @param Client $bunny
30		*/
31	1	public function __construct(LoopInterface $loop, Client $bunny)
32	1	{
33	1	$this->loop = $loop;
34		$this->bunny = $bunny;
35	1	}
36
37		public function consume(
38		string $queue = '',
39		string $consumerTag = '',
40		bool $noLocal = false,
41		bool $noAck = false,
42		bool $exclusive = false,
43		bool $nowait = false,
44	1	array $arguments = []
45	1	): Subject {
46		$subject = new Subject();
47	1	$consumeArgs = [$queue, $consumerTag, $noLocal, $noAck, $exclusive, $nowait, $arguments];
48	1
49		$channel = $this->bunny->channel();
50	1	$channel->then(function (Channel $channel) use ($subject, $consumeArgs) {
		0 ignored issues – show Bug introduced 2018-02-14 22:29 UTC by Report Bug Copy Issue Report The method `then` does only exist in `React\Promise\PromiseInterface`, but not in `Bunny\Channel`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
51	1	/** @var string $consumerTag */
52	1	$consumerTag = null;
53		$timer = $this->loop->addPeriodicTimer(1, function () use ($channel, $subject, &$timer, &$consumerTag) {
54		if (!$subject->isDisposed()) {
55		return;
56	1	}
57	1
58	1	$this->cancelSubscription(
		0 ignored issues – show Bug introduced 2018-02-15 21:08 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `React\Promise\PromiseInterface` as the method `done()` does only exist in the following implementations of said interface: `React\Promise\FulfilledPromise`, `React\Promise\LazyPromise`, `React\Promise\Promise`, `React\Promise\RejectedPromise`. 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...
59	1	$timer,
60	1	$channel,
61	1	$consumerTag
62	1	)->done([$subject, 'onComplete'], $this->onError($subject, $timer));
63	1	});
64	1	$channel->consume(
		0 ignored issues – show Bug introduced 2018-02-14 22:29 UTC by Report Bug Copy Issue Report The method `then` does only exist in `React\Promise\PromiseInterface`, but not in `Bunny\Protocol\MethodBasicConsumeOkFrame`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
65		function (BunnyMessage $message, Channel $channel) use ($subject, &$timer, &$consumerTag) {
66		if ($subject->isDisposed()) {
67		$channel->nack($message);
68		$this->cancelSubscription(
		0 ignored issues – show Bug introduced 2018-02-15 21:08 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `React\Promise\PromiseInterface` as the method `done()` does only exist in the following implementations of said interface: `React\Promise\FulfilledPromise`, `React\Promise\LazyPromise`, `React\Promise\Promise`, `React\Promise\RejectedPromise`. 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...
69		$timer,
70		$channel,
71		$consumerTag
72		)->done([$subject, 'onComplete'], $this->onError($subject, $timer));
73
74		return;
75	1	}
76	1
77	1	$subject->onNext(new Message($message, $channel));
78	1	},
79	1	...$consumeArgs
		0 ignored issues – show Documentation introduced 2018-02-14 22:29 UTC by Report Bug Copy Issue Report `$consumeArgs` is of type `array<integer,string\|boo..."boolean","6":"array"}>`, but the function expects a `string`. 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...
80	1	)->then(function (MethodBasicConsumeOkFrame $response) use (&$consumerTag) {
81	1	$consumerTag = $response->consumerTag;
82		})->done(null, $this->onError($subject, $timer));
83	1	})->done(null, [$subject, 'onError']);
84
85		return $subject;
86	1	}
87
88	1	private function cancelSubscription(TimerInterface $timer, Channel $channel, string $consumerTag): PromiseInterface
89		{
90	1	$this->loop->cancelTimer($timer);
91	1
92	1	return $channel->cancel($consumerTag)->then(function () use ($channel) {
		0 ignored issues – show Bug introduced 2018-02-15 21:08 UTC by Report Bug Copy Issue Report The method `then` does only exist in `React\Promise\PromiseInterface`, but not in `Bunny\Protocol\MethodBasicCancelOkFrame`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
93		return $channel->close();
94		});
95		}
96
97		private function onError(Subject $subject, TimerInterface $timer): callable
98		{
99		return function (Throwable $et) use ($subject, $timer) {
100		if ($this->loop->isTimerActive($timer)) {
101		$this->loop->cancelTimer($timer);
102		}
103		$subject->onError($et);
104		};
105		}
106		}
107

WyriHaximus / reactphp-observable-bunny

GitHub Access Token became invalid

Push — master ( f51a54...1c8d09 )

ObservableBunny::onError() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like