BeanstalkdQueueStoreAdapter::createPayload() - Code Metrics - Inspection of "Merge pull request #13 from 2amigos/redis-backend" - 2amigos/mailer-library - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9eae13...e56856 )

by Antonio

created 2016-01-18 15:49 UTC

BeanstalkdQueueStoreAdapter::createPayload() A

↳ Parent: BeanstalkdQueueStoreAdapter

Complexity

Conditions	2
Paths	1

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	2

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

<?php
namespace Da\Mailer\Queue\Backend\Beanstalk;

use Da\Mailer\Exception\InvalidCallException;
use Da\Mailer\Queue\Backend\MailJobInterface;
use Da\Mailer\Queue\Backend\QueueStoreAdapterInterface;
use Pheanstalk\Job as PheanstalkJob;
use Pheanstalk\Pheanstalk;
use phpseclib\Crypt\Random;

class BeanstalkdQueueStoreAdapter implements QueueStoreAdapterInterface
{
    /**
     * @var string the queue name
     */
    private $queueName;
    /**
     * @var int the time to run. Defaults to Pheanstalkd::DEFAULT_TTR.
     */
    private $timeToRun;
    /**
     * @var BeanstalkdQueueStoreConnection
     */
    protected $connection;

    /**
     * BeanstalkdQueueStoreAdapter constructor.
     *
     * @param BeanstalkdQueueStoreConnection $connection
     * @param string $queueName
     * @param int $timeToRun
     */
    public function __construct(
        BeanstalkdQueueStoreConnection $connection,
        $queueName = 'mail_queue',
        $timeToRun = Pheanstalk::DEFAULT_TTR
    ) {
        $this->connection = $connection;
        $this->queueName = $queueName;
        $this->timeToRun = $timeToRun;
        $this->init();
    }

    /**
     * @return BeanstalkdQueueStoreAdapter
     */
    public function init()
    {
        $this->getConnection()->connect();

        return $this;
    }

    /**
     * @return BeanstalkdQueueStoreConnection
     */
    public function getConnection()
    {
        return $this->connection;
    }

    /**
     * @param BeanstalkdMailJob|MailJobInterface $mailJob
     *
     * @return int
     */
    public function enqueue(MailJobInterface $mailJob)
    {
        $timestamp = $mailJob->getTimeToSend();
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.
    }
}
        $payload = $this->createPayload($mailJob);
        if ($payload === false) {
            var_dump(json_last_error_msg());

            ob_flush();
        }
        $delay = (int)max(Pheanstalk::DEFAULT_DELAY, $timestamp - time());

        return $this->getConnection()
            ->getInstance()
            ->useTube($this->queueName)
            ->put($payload, Pheanstalk::DEFAULT_PRIORITY, $delay, $this->timeToRun);
    }

    public function dequeue()
    {
        $job = $this->getConnection()->getInstance()->watchOnly($this->queueName)->reserve(0);
        if ($job instanceof PheanstalkJob) {
            $data = json_decode($job->getData(), true);

            return new BeanstalkdMailJob(
                [
                    'id' => $data['id'],
                    'attempt' => $data['attempt'],
                    'message' => $data['message'],
                    'pheanstalkJob' => $job
                ]
            );
        }

        return null;
    }

    /**
     * @param BeanstalkdMailJob|MailJobInterface $mailJob
     */
    public function ack(MailJobInterface $mailJob)
    {
        if ($mailJob->isNewRecord()) {
            throw new InvalidCallException('BeanstalkdMailJob cannot be a new object to be acknowledged');
        }

        $pheanstalk = $this->getConnection()->getInstance()->useTube($this->queueName);
        if ($mailJob->isCompleted()) {
            $pheanstalk->delete($mailJob->getPheanstalkJob());
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.
    }
}
        } else {
            $timestamp = $mailJob->getTimeToSend();
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.
    }
}
            $delay = max(0, $timestamp - time());

            // add back to the queue as it wasn't completed maybe due to some transitory error
            // could also be failed.
            $pheanstalk->release($mailJob->getPheanstalkJob(), Pheanstalk::DEFAULT_PRIORITY, $delay);
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.
    }
}
        }
    }

    /**
     *
     * @return bool
     */
    public function isEmpty()
    {
        $stats = $this->getConnection()->getInstance()->statsTube($this->queueName);
        return (int)$stats->current_jobs_delayed === 0
        && (int)$stats->current_jobs_urgent === 0
        && (int)$stats->current_jobs_ready === 0;

    }

    /**
     * @param BeanstalkdMailJob|MailJobInterface $mailJob
     *
     * @return string
     */
    protected function createPayload(MailJobInterface $mailJob)
    {
        return json_encode(
            [
                'id' => $mailJob->isNewRecord() ? sha1(Random::string(32)) : $mailJob->getId(),
                'attempt' => $mailJob->getAttempt(),
                'message' => $mailJob->getMessage(),
            ]
        );
    }
}


1		<?php
2		namespace Da\Mailer\Queue\Backend\Beanstalk;
3
4		use Da\Mailer\Exception\InvalidCallException;
5		use Da\Mailer\Queue\Backend\MailJobInterface;
6		use Da\Mailer\Queue\Backend\QueueStoreAdapterInterface;
7		use Pheanstalk\Job as PheanstalkJob;
8		use Pheanstalk\Pheanstalk;
9		use phpseclib\Crypt\Random;
10
11		class BeanstalkdQueueStoreAdapter implements QueueStoreAdapterInterface
12		{
13		/**
14		* @var string the queue name
15		*/
16		private $queueName;
17		/**
18		* @var int the time to run. Defaults to Pheanstalkd::DEFAULT_TTR.
19		*/
20		private $timeToRun;
21		/**
22		* @var BeanstalkdQueueStoreConnection
23		*/
24		protected $connection;
25
26		/**
27		* BeanstalkdQueueStoreAdapter constructor.
28		*
29		* @param BeanstalkdQueueStoreConnection $connection
30		* @param string $queueName
31		* @param int $timeToRun
32		*/
33	4	public function __construct(
34		BeanstalkdQueueStoreConnection $connection,
35		$queueName = 'mail_queue',
36		$timeToRun = Pheanstalk::DEFAULT_TTR
37		) {
38	4	$this->connection = $connection;
39	4	$this->queueName = $queueName;
40	4	$this->timeToRun = $timeToRun;
41	4	$this->init();
42	4	}
43
44		/**
45		* @return BeanstalkdQueueStoreAdapter
46		*/
47	4	public function init()
48		{
49	4	$this->getConnection()->connect();
50
51	4	return $this;
52		}
53
54		/**
55		* @return BeanstalkdQueueStoreConnection
56		*/
57	4	public function getConnection()
58		{
59	4	return $this->connection;
60		}
61
62		/**
63		* @param BeanstalkdMailJob\|MailJobInterface $mailJob
64		*
65		* @return int
66		*/
67	3	public function enqueue(MailJobInterface $mailJob)
68		{
69	3	$timestamp = $mailJob->getTimeToSend();
		0 ignored issues – show Bug introduced 2016-01-18 13:22 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Da\Mailer\Queue\Backend\MailJobInterface` as the method `getTimeToSend()` does only exist in the following implementations of said interface: `Da\Mailer\Queue\Backend\...stalk\BeanstalkdMailJob`, `Da\Mailer\Queue\Backend\Pdo\PdoMailJob`, `Da\Mailer\Queue\Backend\Redis\RedisMailJob`. 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...
70	3	$payload = $this->createPayload($mailJob);
71	3	if ($payload === false) {
72		var_dump(json_last_error_msg());
		0 ignored issues – show Security Debugging Code introduced 2016-01-18 13:22 UTC by Report Bug Copy Issue Report `var_dump(json_last_error_msg());` looks like debug code. Are you sure you do not want to remove it? This might expose sensitive data. Loading history...
73		ob_flush();
74		}
75	3	$delay = (int)max(Pheanstalk::DEFAULT_DELAY, $timestamp - time());
76
77	3	return $this->getConnection()
78	3	->getInstance()
79	3	->useTube($this->queueName)
80	3	->put($payload, Pheanstalk::DEFAULT_PRIORITY, $delay, $this->timeToRun);
81		}
82
83	3	public function dequeue()
84		{
85	3	$job = $this->getConnection()->getInstance()->watchOnly($this->queueName)->reserve(0);
86	3	if ($job instanceof PheanstalkJob) {
87	3	$data = json_decode($job->getData(), true);
88
89	3	return new BeanstalkdMailJob(
90		[
91	3	'id' => $data['id'],
92	3	'attempt' => $data['attempt'],
93	3	'message' => $data['message'],
94		'pheanstalkJob' => $job
95	3	]
96	3	);
97		}
98
99	2	return null;
100		}
101
102		/**
103		* @param BeanstalkdMailJob\|MailJobInterface $mailJob
104		*/
105	4	public function ack(MailJobInterface $mailJob)
106		{
107	4	if ($mailJob->isNewRecord()) {
108	1	throw new InvalidCallException('BeanstalkdMailJob cannot be a new object to be acknowledged');
109		}
110
111	3	$pheanstalk = $this->getConnection()->getInstance()->useTube($this->queueName);
112	3	if ($mailJob->isCompleted()) {
113	2	$pheanstalk->delete($mailJob->getPheanstalkJob());
		0 ignored issues – show Bug introduced 2016-01-18 13:22 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Da\Mailer\Queue\Backend\MailJobInterface` as the method `getPheanstalkJob()` does only exist in the following implementations of said interface: `Da\Mailer\Queue\Backend\...stalk\BeanstalkdMailJob`. 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...
114	2	} else {
115	1	$timestamp = $mailJob->getTimeToSend();
		0 ignored issues – show Bug introduced 2016-01-18 13:22 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Da\Mailer\Queue\Backend\MailJobInterface` as the method `getTimeToSend()` does only exist in the following implementations of said interface: `Da\Mailer\Queue\Backend\...stalk\BeanstalkdMailJob`, `Da\Mailer\Queue\Backend\Pdo\PdoMailJob`, `Da\Mailer\Queue\Backend\Redis\RedisMailJob`. 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...
116	1	$delay = max(0, $timestamp - time());
117
118		// add back to the queue as it wasn't completed maybe due to some transitory error
119		// could also be failed.
120	1	$pheanstalk->release($mailJob->getPheanstalkJob(), Pheanstalk::DEFAULT_PRIORITY, $delay);
		0 ignored issues – show Bug introduced 2016-01-18 13:22 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Da\Mailer\Queue\Backend\MailJobInterface` as the method `getPheanstalkJob()` does only exist in the following implementations of said interface: `Da\Mailer\Queue\Backend\...stalk\BeanstalkdMailJob`. 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...
121		}
122	3	}
123
124		/**
125		*
126		* @return bool
127		*/
128	2	public function isEmpty()
129		{
130	2	$stats = $this->getConnection()->getInstance()->statsTube($this->queueName);
131	2	return (int)$stats->current_jobs_delayed === 0
132	2	&& (int)$stats->current_jobs_urgent === 0
133	2	&& (int)$stats->current_jobs_ready === 0;
134
135		}
136
137		/**
138		* @param BeanstalkdMailJob\|MailJobInterface $mailJob
139		*
140		* @return string
141		*/
142	3	protected function createPayload(MailJobInterface $mailJob)
143		{
144	3	return json_encode(
145		[
146	3	'id' => $mailJob->isNewRecord() ? sha1(Random::string(32)) : $mailJob->getId(),
147	3	'attempt' => $mailJob->getAttempt(),
148	3	'message' => $mailJob->getMessage(),
149		]
150	3	);
151		}
152		}
153

2amigos / mailer-library

Push — master ( 9eae13...e56856 )

BeanstalkdQueueStoreAdapter::createPayload() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like