RpcClient - Code Metrics - Inspection of "check if queue exists before publish" - contamobi/CmobiRabbitmqBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bf6474...78183b )

by Daniel

created 2017-02-09 21:10 UTC

RpcClient A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	176
Duplicated Lines	11.93 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

Metric	Value
wmc	19
lcom	1
cbo	7
dl	21
loc	176
c	0
b	0
f	0
rs	10

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	onResponse()	0	6	2
A	refreshChannel()	11	11	2
B	publish()	0	38	3
A	queueHasExists()	10	10	2
A	getQueueName()	0	4	1
A	getChannel()	0	4	1
A	getFromName()	0	4	1
A	setResponse()	0	4	1
A	getResponse()	0	4	1
A	generateCorrelationId()	0	4	1
A	getCurrentCorrelationId()	0	4	1
A	getExchange()	0	4	1
A	getExchangeType()	0	4	1

How to fix Duplicated Code

<?php

namespace Cmobi\RabbitmqBundle\Transport\Rpc;

use Cmobi\RabbitmqBundle\Connection\CmobiAMQPChannel;
use Cmobi\RabbitmqBundle\Connection\ConnectionManager;
use Cmobi\RabbitmqBundle\Queue\CmobiAMQPMessage;
use Cmobi\RabbitmqBundle\Queue\QueueProducerInterface;
use Cmobi\RabbitmqBundle\Transport\Exception\QueueNotFoundException;
use PhpAmqpLib\Message\AMQPMessage;

class RpcClient implements QueueProducerInterface
{
    private $connectionManager;
    private $channel;
    private $fromName;
    private $queueName;
    private $response;
    private $correlationId;
    private $callbackQueue;

    public function __construct($queueName, ConnectionManager $manager, $fromName = '')
    {
        $this->queueName = $queueName;
        $this->fromName = $fromName;
        $this->connectionManager = $manager;
    }

    /**
     * @param AMQPMessage $rep
     */
    public function onResponse(AMQPMessage $rep)
    {
        if ($rep->get('correlation_id') === $this->correlationId) {
            $this->response = $rep->getBody();
        }
    }

    /**
     * @return \PhpAmqpLib\Channel\AMQPChannel
     *
     * @throws \Cmobi\RabbitmqBundle\Connection\Exception\NotFoundAMQPConnectionFactoryException
     */
    public function refreshChannel()

    {
        $connection = $this->connectionManager->getConnection();

        if (!$connection->isConnected()) {
            $connection->reconnect();
        }
        $this->channel = $connection->channel();

        return $this->channel;
    }

    /**
     * @param $data
     * @param int $expire
     * @param int $priority
     * @throws QueueNotFoundException
     * @throws \Cmobi\RabbitmqBundle\Connection\Exception\NotFoundAMQPConnectionFactoryException
     */
    public function publish($data, $expire = self::DEFAULT_TTL, $priority = self::PRIORITY_LOW)
    {
        $this->refreshChannel();

        if (! $this->queueHasExists()) {
            throw new QueueNotFoundException("Queue $this->queueName not declared.");
        }
        $this->correlationId = $this->generateCorrelationId();
        $queueBag = new RpcQueueBag(
            sprintf('callback_to_%s_from_%s_%s', $this->getQueueName(), $this->getFromName(), microtime())
        );
        $queueBag->setArguments([
            'x-expires' => ['I', $expire],
        ]);
        list($callbackQueue) = $this->getChannel()->queueDeclare($queueBag->getQueueDeclare());
        $this->callbackQueue = $callbackQueue;
        $consumeQueueBag = new RpcQueueBag($callbackQueue);

        $this->getChannel()->basicConsume(
            $consumeQueueBag->getQueueConsume(),
            [$this, 'onResponse']
        );
        $msg = new CmobiAMQPMessage(
            (string) $data,
            [
                'correlation_id' => $this->correlationId,
                'reply_to' => $this->callbackQueue,
                'priority' => $priority,
            ]
        );
        $this->getChannel()->basic_publish($msg, '', $this->getQueueName());

        while (! $this->response) {
            $this->getChannel()->wait(null, 0, ($expire / 1000));
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
        $this->getChannel()->close();
        $this->connectionManager->getConnection()->close();
    }

    /**
     * @return bool
     */
    public function queueHasExists()

    {
        try {
            $this->getChannel()->queue_declare($this->queueName, true);
        } catch (\Exception $e) {
            return false;
        }

        return true;
    }

    /**
     * @return string
     */
    public function getQueueName()
    {
        return $this->queueName;
    }

    /**
     * @return CmobiAMQPChannel
     */
    public function getChannel()
    {
        return $this->channel;
    }

    /**
     * @return string
     */
    public function getFromName()
    {
        return $this->fromName;
    }

    /**
     * @todo unecessary method set, its only exists to run tests whitout stay jailed in infinite while waiting response.
     *
     * @param $content
     */
    public function setResponse($content)
    {
        $this->response = $content;
    }

    /**
     * @return string
     */
    public function getResponse()
    {
        return $this->response;
    }

    /** @return string */
    public function generateCorrelationId()
    {
        return uniqid($this->getQueueName()).microtime();
    }

    /**
     * @return string
     */
    public function getCurrentCorrelationId()
    {
        return $this->correlationId;
    }

    /**
     * @return string
     */
    public function getExchange()
    {
        return 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());
}
    }

    /**
     * @return string
     */
    public function getExchangeType()
    {
        return 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());
}
    }
}


1		<?php
2
3		namespace Cmobi\RabbitmqBundle\Transport\Rpc;
4
5		use Cmobi\RabbitmqBundle\Connection\CmobiAMQPChannel;
6		use Cmobi\RabbitmqBundle\Connection\ConnectionManager;
7		use Cmobi\RabbitmqBundle\Queue\CmobiAMQPMessage;
8		use Cmobi\RabbitmqBundle\Queue\QueueProducerInterface;
9		use Cmobi\RabbitmqBundle\Transport\Exception\QueueNotFoundException;
10		use PhpAmqpLib\Message\AMQPMessage;
11
12		class RpcClient implements QueueProducerInterface
13		{
14		private $connectionManager;
15		private $channel;
16		private $fromName;
17		private $queueName;
18		private $response;
19		private $correlationId;
20		private $callbackQueue;
21
22		public function __construct($queueName, ConnectionManager $manager, $fromName = '')
23		{
24		$this->queueName = $queueName;
25		$this->fromName = $fromName;
26		$this->connectionManager = $manager;
27		}
28
29		/**
30		* @param AMQPMessage $rep
31		*/
32		public function onResponse(AMQPMessage $rep)
33		{
34		if ($rep->get('correlation_id') === $this->correlationId) {
35		$this->response = $rep->getBody();
36		}
37		}
38
39		/**
40		* @return \PhpAmqpLib\Channel\AMQPChannel
41		*
42		* @throws \Cmobi\RabbitmqBundle\Connection\Exception\NotFoundAMQPConnectionFactoryException
43		*/
44	View Code Duplication	public function refreshChannel()
		0 ignored issues – show Duplication introduced 2016-12-28 18:51 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
45		{
46		$connection = $this->connectionManager->getConnection();
47
48		if (!$connection->isConnected()) {
49		$connection->reconnect();
50		}
51		$this->channel = $connection->channel();
52
53		return $this->channel;
54		}
55
56		/**
57		* @param $data
58		* @param int $expire
59		* @param int $priority
60		* @throws QueueNotFoundException
61		* @throws \Cmobi\RabbitmqBundle\Connection\Exception\NotFoundAMQPConnectionFactoryException
62		*/
63		public function publish($data, $expire = self::DEFAULT_TTL, $priority = self::PRIORITY_LOW)
64		{
65		$this->refreshChannel();
66
67		if (! $this->queueHasExists()) {
68		throw new QueueNotFoundException("Queue $this->queueName not declared.");
69		}
70		$this->correlationId = $this->generateCorrelationId();
71		$queueBag = new RpcQueueBag(
72		sprintf('callback_to_%s_from_%s_%s', $this->getQueueName(), $this->getFromName(), microtime())
73		);
74		$queueBag->setArguments([
75		'x-expires' => ['I', $expire],
76		]);
77		list($callbackQueue) = $this->getChannel()->queueDeclare($queueBag->getQueueDeclare());
78		$this->callbackQueue = $callbackQueue;
79		$consumeQueueBag = new RpcQueueBag($callbackQueue);
80
81		$this->getChannel()->basicConsume(
82		$consumeQueueBag->getQueueConsume(),
83		[$this, 'onResponse']
84		);
85		$msg = new CmobiAMQPMessage(
86		(string) $data,
87		[
88		'correlation_id' => $this->correlationId,
89		'reply_to' => $this->callbackQueue,
90		'priority' => $priority,
91		]
92		);
93		$this->getChannel()->basic_publish($msg, '', $this->getQueueName());
94
95		while (! $this->response) {
96		$this->getChannel()->wait(null, 0, ($expire / 1000));
		0 ignored issues – show Documentation introduced 2016-04-29 12:41 UTC by Report Bug Copy Issue Report `0` is of type `integer`, but the function expects a `boolean`. 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...
97		}
98		$this->getChannel()->close();
99		$this->connectionManager->getConnection()->close();
100		}
101
102		/**
103		* @return bool
104		*/
105	View Code Duplication	public function queueHasExists()
		0 ignored issues – show Duplication introduced 2017-02-09 21:22 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
106		{
107		try {
108		$this->getChannel()->queue_declare($this->queueName, true);
109		} catch (\Exception $e) {
110		return false;
111		}
112
113		return true;
114		}
115
116		/**
117		* @return string
118		*/
119		public function getQueueName()
120		{
121		return $this->queueName;
122		}
123
124		/**
125		* @return CmobiAMQPChannel
126		*/
127		public function getChannel()
128		{
129		return $this->channel;
130		}
131
132		/**
133		* @return string
134		*/
135		public function getFromName()
136		{
137		return $this->fromName;
138		}
139
140		/**
141		* @todo unecessary method set, its only exists to run tests whitout stay jailed in infinite while waiting response.
142		*
143		* @param $content
144		*/
145		public function setResponse($content)
146		{
147		$this->response = $content;
148		}
149
150		/**
151		* @return string
152		*/
153		public function getResponse()
154		{
155		return $this->response;
156		}
157
158		/** @return string */
159		public function generateCorrelationId()
160		{
161		return uniqid($this->getQueueName()).microtime();
162		}
163
164		/**
165		* @return string
166		*/
167		public function getCurrentCorrelationId()
168		{
169		return $this->correlationId;
170		}
171
172		/**
173		* @return string
174		*/
175		public function getExchange()
176		{
177		return false;
		0 ignored issues – show Bug Best Practice introduced 2016-12-28 18:51 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type declared by the interface `Cmobi\RabbitmqBundle\Que...rInterface::getExchange` of type `string`. 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...
178		}
179
180		/**
181		* @return string
182		*/
183		public function getExchangeType()
184		{
185		return false;
		0 ignored issues – show Bug Best Practice introduced 2016-12-28 18:51 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type declared by the interface `Cmobi\RabbitmqBundle\Que...erface::getExchangeType` of type `string`. 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...
186		}
187		}
188

contamobi / CmobiRabbitmqBundle

Push — master ( bf6474...78183b )

RpcClient A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

14 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like