QueueProcessor::hasMessageExpired() - Code Metrics - Inspection of "Enable limiting and ages based expiry in QueueProc..." - genkgo/mail - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#41)

by Gawain

created 2018-01-16 05:27 UTC

QueueProcessor::hasMessageExpired() A

↳ Parent: QueueProcessor

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3

Importance

Changes

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

<?php
declare(strict_types=1);

namespace Genkgo\Mail\Queue;

use Genkgo\Mail\Exception\AbstractProtocolException;
use Genkgo\Mail\Exception\EmptyQueueException;
use Genkgo\Mail\MessageInterface;
use Genkgo\Mail\Transport\QueueIfFailedTransport;
use Genkgo\Mail\TransportInterface;

/**
 * Class QueueProcessor
 * @package Genkgo\Mail\Queue
 */
final class QueueProcessor
{

    /**
     * @var TransportInterface
     */
    private $transport;
    /**
     * @var array|QueueInterface[]
     */
    private $queue;

    /**
     * @param TransportInterface $transport
     * @param QueueInterface[] $queue
     */
    public function __construct(TransportInterface $transport, iterable $queue)
    {
        $this->transport = $transport;
        $this->queue = $queue;
    }

    /**
     * @param int|null $messageLimit
     * @param int|null $timeLimit
     * @return int
     * @throws \Genkgo\Mail\Exception\QueueStoreException
     */
    public function process(?int $messageLimit = null, ?int $timeLimit = null): int
    {
        $count = 0;
        foreach ($this->queue as $queue) {
            try {
                while ($message = $queue->fetch()) {
                    if ($messageLimit && $count >= $messageLimit) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
                        $queue->store($message);

                        return $count;
                    }
                    try {
                        if (!$this->hasMessageExpired($message, (int) $timeLimit)) {
                            $this->transport->send($message);
                        }
                    } catch (AbstractProtocolException $e) {
                        $queue->store($message);

                        // do not continue transporting messages
                        // apparently our transport is not ready to receive messages yet
                        return $count;
                    }
                    ++$count;
                }
            } catch (EmptyQueueException $e) {
            }
        }

        return $count;
    }

    /**
     * @param MessageInterface $message
     * @param int $timeLimit
     * @return bool
     */
    private function hasMessageExpired(MessageInterface $message, int $timeLimit): bool
    {
        if ($timeLimit === 0) {
            return false;
        }
        if ($this->getSubmissionTimestamp($message) + $timeLimit > \time()) {
            return false;
        }

        return true;
    }

    /**
     * @param MessageInterface $message
     * @return int
     */
    private function getSubmissionTimestamp(MessageInterface $message): int
    {
        $queuedAt = $message->getHeader(QueueIfFailedTransport::QUEUED_HEADER);

        return (int) \strtotime(reset($queuedAt)->getValue()->getRaw());
    }
}


1		<?php
2		declare(strict_types=1);
3
4		namespace Genkgo\Mail\Queue;
5
6		use Genkgo\Mail\Exception\AbstractProtocolException;
7		use Genkgo\Mail\Exception\EmptyQueueException;
8		use Genkgo\Mail\MessageInterface;
9		use Genkgo\Mail\Transport\QueueIfFailedTransport;
10		use Genkgo\Mail\TransportInterface;
11
12		/**
13		* Class QueueProcessor
14		* @package Genkgo\Mail\Queue
15		*/
16		final class QueueProcessor
17		{
18
19		/**
20		* @var TransportInterface
21		*/
22		private $transport;
23		/**
24		* @var array\|QueueInterface[]
25		*/
26		private $queue;
27
28		/**
29		* @param TransportInterface $transport
30		* @param QueueInterface[] $queue
31		*/
32	7	public function __construct(TransportInterface $transport, iterable $queue)
33		{
34	7	$this->transport = $transport;
35	7	$this->queue = $queue;
36	7	}
37
38		/**
39		* @param int\|null $messageLimit
40		* @param int\|null $timeLimit
41		* @return int
42		* @throws \Genkgo\Mail\Exception\QueueStoreException
43		*/
44	7	public function process(?int $messageLimit = null, ?int $timeLimit = null): int
45		{
46	7	$count = 0;
47	7	foreach ($this->queue as $queue) {
48		try {
49	7	while ($message = $queue->fetch()) {
50	7	if ($messageLimit && $count >= $messageLimit) {
		0 ignored issues – show Bug Best Practice introduced 2018-01-16 05:29 UTC by Report Bug Copy Issue Report The expression `$messageLimit` of type `integer\|null` is loosely compared to `true`; this is ambiguous if the integer can be zero. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
51	1	$queue->store($message);
52
53	1	return $count;
54		}
55		try {
56	7	if (!$this->hasMessageExpired($message, (int) $timeLimit)) {
57	7	$this->transport->send($message);
58		}
59	2	} catch (AbstractProtocolException $e) {
60	2	$queue->store($message);
61
62		// do not continue transporting messages
63		// apparently our transport is not ready to receive messages yet
64	2	return $count;
65		}
66	5	++$count;
67		}
68	4	} catch (EmptyQueueException $e) {
69		}
70		}
71
72	4	return $count;
73		}
74
75		/**
76		* @param MessageInterface $message
77		* @param int $timeLimit
78		* @return bool
79		*/
80	7	private function hasMessageExpired(MessageInterface $message, int $timeLimit): bool
81		{
82	7	if ($timeLimit === 0) {
83	6	return false;
84		}
85	1	if ($this->getSubmissionTimestamp($message) + $timeLimit > \time()) {
86	1	return false;
87		}
88
89	1	return true;
90		}
91
92		/**
93		* @param MessageInterface $message
94		* @return int
95		*/
96	1	private function getSubmissionTimestamp(MessageInterface $message): int
97		{
98	1	$queuedAt = $message->getHeader(QueueIfFailedTransport::QUEUED_HEADER);
99
100	1	return (int) \strtotime(reset($queuedAt)->getValue()->getRaw());
101		}
102		}
103

genkgo / mail

Pull Request — master (#41)

QueueProcessor::hasMessageExpired() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like