Db::deleteJob() - Code Metrics - flipbox/queue - Measure and Improve Code Quality continuously with Scrutinizer

Db::deleteJob() A
last analyzed 2017-08-03 15:42 UTC

↳ Parent: Db

Complexity

Conditions	2
Paths	2

Size

Total Lines	15
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

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

<?php

/**
 * @author    Flipbox Factory
 * @copyright Copyright (c) 2017, Flipbox Digital
 * @link      https://github.com/flipbox/queue/releases/latest
 * @license   https://github.com/flipbox/queue/blob/master/LICENSE
 */

namespace flipbox\queue\queues;

use flipbox\queue\jobs\JobInterface;
use yii\db\Connection;
use yii\db\Expression;
use yii\db\Query;
use yii\di\Instance;

/**
 * @author Flipbox Factory <[email protected]>
 * @since 1.0.0
 */
class Db extends AbstractQueue
{
    /**
     * Status when the job is ready.
     */
    const STATUS_READY = 0;

    /**
     * Status when the job is running by the worker.
     */
    const STATUS_ACTIVE = 1;

    /**
     * Status when the job is deleted.
     */
    const STATUS_DELETED = 2;

    /**
     * The database used for the queue.
     *
     * This will use default `db` component from Craft application.
     * @var string|\yii\db\Connection
     */
    public $db = 'db';

    /**
     * The name of the table to store the queue.
     *
     * The table should be pre-created as follows for MySQL:
     *
     * ```php
     * CREATE TABLE queue (
     *     id BIGINT NOT NULL PRIMARY KEY AUTO_INCREMENT,
     *     status TINYINT NOT NULL DEFAULT 0,
     *     timestamp DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
     *     data LONGBLOB
     * );
     * ```
     * @var string
     */
    public $tableName = '{{%queue}}';

    /**
     * Whether to do hard delete of the deleted job, instead of just flagging the
     * status.
     * @var boolean
     */
    public $hardDelete = true;

    /**
     * @inheritdoc
     */
    public function init()
    {
        parent::init();
        $this->db = Instance::ensure($this->db, Connection::class);
    }

    /**
     * @inheritdoc
     */
    protected function fetchJob()
    {
        //Avoiding multiple job.
        $transaction = $this->db->beginTransaction();
        $row = $this->fetchLatestRow();
        if ($row == false || !$this->flagRunningRow($row)) {
            $transaction->rollBack();
            return false;
        }
        $transaction->commit();

        $job = $this->deserialize($row['data']);
        $job->setId($row['id']);
        $job->setHeader('timestamp', $row['timestamp']);

        return $job;
    }

    /**
     * Fetch latest ready job from the table.
     *
     * Due to the use of AUTO_INCREMENT ID, this will fetch the job with the
     * largest ID.
     *
     * @return array
     */
    protected function fetchLatestRow()
    {
        return (new Query())
            ->select('*')
            ->from($this->tableName)
            ->where(['status' => self::STATUS_READY])
            ->orderBy(['id' => SORT_ASC])
            ->limit(1)
            ->one($this->db);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * Flag a row as running. This will update the row ID and status if ready.
     *
     * @param array $row The row to update.
     * @return boolean Whether successful or not.
     */
    protected function flagRunningRow(array $row)
    {
        $updated = $this->db->createCommand()
            ->update(
                $this->tableName,
                ['status' => self::STATUS_ACTIVE],
                [
                    'id' => $row['id'],
                    'status' => self::STATUS_READY,
                ]
            )->execute();
        return $updated == 1;
    }

    /**
     * @inheritdoc
     */
    protected function postJob(JobInterface $job, array $options = []): bool
    {
        return $this->db->createCommand()->insert(
            $this->tableName,
            [
                'timestamp' => new Expression('NOW()'),
                'data' => $this->serialize($job),
            ]
        )->execute() == 1;
    }

    /**
     * @inheritdoc
     */
    public function deleteJob(JobInterface $job): bool
    {
        if ($this->hardDelete) {
            return $this->db->createCommand()->delete(
                $this->tableName,
                ['id' => $job->getId()]
            )->execute() == 1;
        } else {
            return $this->db->createCommand()->update(
                $this->tableName,
                ['status' => self::STATUS_DELETED],
                ['id' => $job->getId()]
            )->execute() == 1;
        }
    }

    /**
     * @inheritdoc
     */
    public function releaseJob(JobInterface $job): bool
    {
        return $this->db->createCommand()->update(
            $this->tableName,
            ['status' => self::STATUS_READY],
            ['id' => $job->getId()]
        )->execute() == 1;
    }

    /**
     * @inheritdoc
     */
    public function getSize(): int
    {
        return (new Query())
            ->select('*')
            ->from($this->tableName)
            ->where(['status' => self::STATUS_READY])
            ->count('*', $this->db);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * @inheritdoc
     */
    public function purge(): bool
    {
        return false;
    }
}


1			<?php
2
3			/**
4			* @author Flipbox Factory
5			* @copyright Copyright (c) 2017, Flipbox Digital
6			* @link https://github.com/flipbox/queue/releases/latest
7			* @license https://github.com/flipbox/queue/blob/master/LICENSE
8			*/
9
10			namespace flipbox\queue\queues;
11
12			use flipbox\queue\jobs\JobInterface;
13			use yii\db\Connection;
14			use yii\db\Expression;
15			use yii\db\Query;
16			use yii\di\Instance;
17
18			/**
19			* @author Flipbox Factory <[email protected]>
20			* @since 1.0.0
21			*/
22			class Db extends AbstractQueue
23			{
24			/**
25			* Status when the job is ready.
26			*/
27			const STATUS_READY = 0;
28
29			/**
30			* Status when the job is running by the worker.
31			*/
32			const STATUS_ACTIVE = 1;
33
34			/**
35			* Status when the job is deleted.
36			*/
37			const STATUS_DELETED = 2;
38
39			/**
40			* The database used for the queue.
41			*
42			* This will use default `db` component from Craft application.
43			* @var string\|\yii\db\Connection
44			*/
45			public $db = 'db';
46
47			/**
48			* The name of the table to store the queue.
49			*
50			* The table should be pre-created as follows for MySQL:
51			*
52			* ```php
53			* CREATE TABLE queue (
54			* id BIGINT NOT NULL PRIMARY KEY AUTO_INCREMENT,
55			* status TINYINT NOT NULL DEFAULT 0,
56			* timestamp DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
57			* data LONGBLOB
58			* );
59			* ```
60			* @var string
61			*/
62			public $tableName = '{{%queue}}';
63
64			/**
65			* Whether to do hard delete of the deleted job, instead of just flagging the
66			* status.
67			* @var boolean
68			*/
69			public $hardDelete = true;
70
71			/**
72			* @inheritdoc
73			*/
74			public function init()
75			{
76			parent::init();
77			$this->db = Instance::ensure($this->db, Connection::class);
78			}
79
80			/**
81			* @inheritdoc
82			*/
83			protected function fetchJob()
84			{
85			//Avoiding multiple job.
86			$transaction = $this->db->beginTransaction();
87			$row = $this->fetchLatestRow();
88			if ($row == false \|\| !$this->flagRunningRow($row)) {
89			$transaction->rollBack();
90			return false;
91			}
92			$transaction->commit();
93
94			$job = $this->deserialize($row['data']);
95			$job->setId($row['id']);
96			$job->setHeader('timestamp', $row['timestamp']);
97
98			return $job;
99			}
100
101			/**
102			* Fetch latest ready job from the table.
103			*
104			* Due to the use of AUTO_INCREMENT ID, this will fetch the job with the
105			* largest ID.
106			*
107			* @return array
108			*/
109			protected function fetchLatestRow()
110			{
111			return (new Query())
112			->select('*')
113			->from($this->tableName)
114			->where(['status' => self::STATUS_READY])
115			->orderBy(['id' => SORT_ASC])
116			->limit(1)
117			->one($this->db);
			0 ignored issues – show Bug introduced 2017-06-06 23:53 UTC by Report Bug Copy Issue Report It seems like `$this->db` can also be of type `string`; however, `yii\db\Query::one()` does only seem to accept `object<yii\db\Connection>\|null`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
118			}
119
120			/**
121			* Flag a row as running. This will update the row ID and status if ready.
122			*
123			* @param array $row The row to update.
124			* @return boolean Whether successful or not.
125			*/
126			protected function flagRunningRow(array $row)
127			{
128			$updated = $this->db->createCommand()
129			->update(
130			$this->tableName,
131			['status' => self::STATUS_ACTIVE],
132			[
133			'id' => $row['id'],
134			'status' => self::STATUS_READY,
135			]
136			)->execute();
137			return $updated == 1;
138			}
139
140			/**
141			* @inheritdoc
142			*/
143			protected function postJob(JobInterface $job, array $options = []): bool
144			{
145			return $this->db->createCommand()->insert(
146			$this->tableName,
147			[
148			'timestamp' => new Expression('NOW()'),
149			'data' => $this->serialize($job),
150			]
151			)->execute() == 1;
152			}
153
154			/**
155			* @inheritdoc
156			*/
157			public function deleteJob(JobInterface $job): bool
158			{
159			if ($this->hardDelete) {
160			return $this->db->createCommand()->delete(
161			$this->tableName,
162			['id' => $job->getId()]
163			)->execute() == 1;
164			} else {
165			return $this->db->createCommand()->update(
166			$this->tableName,
167			['status' => self::STATUS_DELETED],
168			['id' => $job->getId()]
169			)->execute() == 1;
170			}
171			}
172
173			/**
174			* @inheritdoc
175			*/
176			public function releaseJob(JobInterface $job): bool
177			{
178			return $this->db->createCommand()->update(
179			$this->tableName,
180			['status' => self::STATUS_READY],
181			['id' => $job->getId()]
182			)->execute() == 1;
183			}
184
185			/**
186			* @inheritdoc
187			*/
188			public function getSize(): int
189			{
190			return (new Query())
191			->select('*')
192			->from($this->tableName)
193			->where(['status' => self::STATUS_READY])
194			->count('*', $this->db);
			0 ignored issues – show Bug introduced 2017-06-06 23:53 UTC by Report Bug Copy Issue Report It seems like `$this->db` can also be of type `string`; however, `yii\db\Query::count()` does only seem to accept `object<yii\db\Connection>\|null`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
195			}
196
197			/**
198			* @inheritdoc
199			*/
200			public function purge(): bool
201			{
202			return false;
203			}
204			}
205

flipbox / queue

Db::deleteJob() A last analyzed 2017-08-03 15:42 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Db::deleteJob() A
last analyzed 2017-08-03 15:42 UTC