JobManager::getJob() - Code Metrics - Inspection of "Scrutinizer Auto-Fixes (#25)" - mmucklo/DtcQueueBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cf2de2...e02161 )

by Matthew

created 2017-11-23 20:06 UTC

JobManager::getJob() B

↳ Parent: JobManager

Complexity

Conditions	2
Paths	2

Size

Total Lines	42
Code Lines	28

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	23
CRAP Score	2

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
dl	0
loc	42
ccs	23
cts	23
cp	1
rs	8.8571
c	1
b	1
f	0
cc	2
eloc	28
nc	2
nop	4
crap	2

<?php

namespace Dtc\QueueBundle\ODM;

use Doctrine\MongoDB\Query\Builder;
use Dtc\QueueBundle\Doctrine\BaseJobManager;
use Doctrine\ODM\MongoDB\DocumentManager;
use Dtc\QueueBundle\Model\BaseJob;
use Dtc\QueueBundle\Model\RetryableJob;

class JobManager extends BaseJobManager
{
    use CommonTrait;

    public function countJobsByStatus($objectName, $status, $workerName = null, $method = null)
    {
        /** @var DocumentManager $objectManager */
        $objectManager = $this->getObjectManager();
        $qb = $objectManager->createQueryBuilder($objectName);
        $qb
            ->find()
            ->field('status')->equals($status);

        $this->addWorkerNameCriterion($qb, $workerName, $method);
        $query = $qb->getQuery();

        return $query->count();
    }

    /**
     * @param string|null $workerName
     * @param string|null $method
     */
    public function pruneErroneousJobs($workerName = null, $method = null)
    {
        /** @var DocumentManager $objectManager */
        $objectManager = $this->getObjectManager();
        $qb = $objectManager->createQueryBuilder($this->getArchiveObjectName());
        $qb = $qb->remove();
        $qb->field('status')->equals(BaseJob::STATUS_ERROR);
        $this->addWorkerNameCriterion($qb, $workerName, $method);

        $query = $qb->getQuery();
        $result = $query->execute();
        if (isset($result['n'])) {
            return $result['n'];
        }

        return 0;
    }

    /**
     * @param Builder     $builder
     * @param string|null $workerName
     * @param string|null $method
     */
    protected function addWorkerNameCriterion(Builder $builder, $workerName = null, $method = null)
    {
        if (null !== $workerName) {
            $builder->field('workerName')->equals($workerName);
        }

        if (null !== $method) {
            $builder->field('method')->equals($method);
        }
    }

    /**
     * @param null $workerName
     * @param null $method
     *
     * @return int
     */
    protected function updateExpired($workerName = null, $method = null)
    {
        /** @var DocumentManager $objectManager */
        $objectManager = $this->getObjectManager();
        $qb = $objectManager->createQueryBuilder($this->getObjectName());
        $qb = $qb->updateMany();
        $qb->field('expiresAt')->lte(new \DateTime());
        $qb->field('status')->equals(BaseJob::STATUS_NEW);
        $this->addWorkerNameCriterion($qb, $workerName, $method);
        $qb->field('status')->set(\Dtc\QueueBundle\Model\Job::STATUS_EXPIRED);
        $query = $qb->getQuery();
        $result = $query->execute();
        if (isset($result['n'])) {
            return $result['n'];
        }

        return 0;
    }

    /**
     * Removes archived jobs older than $olderThan.
     *
     * @param \DateTime $olderThan
     *                             return int
     */
    public function pruneArchivedJobs(\DateTime $olderThan)
    {
        return $this->removeOlderThan($this->getArchiveObjectName(), 'updatedAt', $olderThan);
    }

    public function getJobCount($workerName = null, $method = null)
    {
        /** @var DocumentManager $objectManager */
        $objectManager = $this->getObjectManager();
        $qb = $objectManager->createQueryBuilder($this->getObjectName());
        $qb
            ->find();

        $this->addWorkerNameCriterion($qb, $workerName, $method);

        // Filter
        $date = new \DateTime();
        $qb
            ->addAnd(
                $qb->expr()->addOr($qb->expr()->field('expiresAt')->equals(null), $qb->expr()->field('expiresAt')->gt($date))
            )
            ->field('locked')->equals(null);

        $query = $qb->getQuery();

        return $query->count(true);
    }

    /**
     * Get Status Jobs.
     *
     * @param string $documentName
     *
     * @return array
     */
    protected function getStatusByDocument($documentName)
    {
        // Run a map reduce function get worker and status break down
        $mapFunc = "function() {
            var result = {};
            result[this.status] = 1;
            var key = this.worker_name + '->' + this.method + '()';
            emit(key, result);
        }";
        $reduceFunc = 'function(k, vals) {
            var result = {};
            for (var index in vals) {
                var val =  vals[index];
                for (var i in val) {
                    if (result.hasOwnProperty(i)) {
                        result[i] += val[i];
                    }
                    else {
                        result[i] = val[i];
                    }
                }
            }
            return result;
        }';
        /** @var DocumentManager $objectManager */
        $objectManager = $this->getObjectManager();
        $qb = $objectManager->createQueryBuilder($documentName);
        $qb->map($mapFunc)
            ->reduce($reduceFunc);
        $query = $qb->getQuery();
        $results = $query->execute();

        $allStatus = array(
            BaseJob::STATUS_ERROR => 0,
            BaseJob::STATUS_NEW => 0,
            RetryableJob::STATUS_EXPIRED => 0,
            RetryableJob::STATUS_MAX_ERROR => 0,
            RetryableJob::STATUS_MAX_RETRIES => 0,
            RetryableJob::STATUS_MAX_STALLED => 0,
            BaseJob::STATUS_RUNNING => 0,
            BaseJob::STATUS_SUCCESS => 0,
        );

        $status = [];

        foreach ($results as $info) {
            $status[$info['_id']] = $info['value'] + $allStatus;
        }

        return $status;
    }

    public function getStatus()
    {
        $result = $this->getStatusByDocument($this->getObjectName());
        $status2 = $this->getStatusByDocument($this->getArchiveObjectName());
        foreach ($status2 as $key => $value) {
            foreach ($value as $k => $v) {
                $result[$key][$k] += $v;
            }
        }

        $finalResult = [];
        foreach ($result as $key => $item) {
            ksort($item);
            $finalResult[$key] = $item;
        }

        return $finalResult;
    }

    /**
     * Get the next job to run (can be filtered by workername and method name).
     *
     * @param string $workerName
     * @param string $methodName
     * @param bool   $prioritize
     *
     * @return \Dtc\QueueBundle\Model\Job
     */
    public function getJob($workerName = null, $methodName = null, $prioritize = true, $runId = null)
    {
        /** @var DocumentManager $objectManager */
        $objectManager = $this->getObjectManager();
        $qb = $objectManager->createQueryBuilder($this->getObjectName());
        $qb
            ->findAndUpdate()
            ->returnNew();

        $this->addWorkerNameCriterion($qb, $workerName, $methodName);
        if ($prioritize) {
            $qb->sort([
                'priority' => 'desc',
                'whenAt' => 'asc',
            ]);
        } else {
            $qb->sort('whenAt', 'asc');
        }

        // Filter
        $date = new \DateTime();
        $qb
            ->addAnd(
                $qb->expr()->addOr($qb->expr()->field('whenAt')->equals(null), $qb->expr()->field('whenAt')->lte($date)),
                $qb->expr()->addOr($qb->expr()->field('expiresAt')->equals(null), $qb->expr()->field('expiresAt')->gt($date))
            )
            ->field('status')->equals(BaseJob::STATUS_NEW)
            ->field('locked')->equals(null);

        // Update
        $qb
            ->field('lockedAt')->set($date) // Set started
            ->field('locked')->set(true)
            ->field('status')->set(BaseJob::STATUS_RUNNING)
            ->field('runId')->set($runId);

        $query = $qb->getQuery();

        $job = $query->execute();

        return $job;
    }

    protected function updateNearestBatch(\Dtc\QueueBundle\Model\Job $job)
    {
        /** @var DocumentManager $objectManager */
        $objectManager = $this->getObjectManager();
        $qb = $objectManager->createQueryBuilder($this->getObjectName());
        $qb->find();

        $qb->sort('whenAt', 'asc');
        $qb->field('status')->equals(BaseJob::STATUS_NEW)
            ->field('crcHash')->equals($job->getCrcHash())
            ->field('locked')->equals(null);
        $oldJob = $qb->getQuery()->getSingleResult();

        if (!$oldJob) {
            return null;
        }

        // Update priority or whenAt
        //  This makes sure if someone else is updating at the same time
        //  that we don't trounce their changes.
        $qb = $objectManager->createQueryBuilder($this->getObjectName());
        $qb->findAndUpdate();
        $qb->field('_id')->equals($oldJob->getId());
        $qb->field('priority')->lt($job->getPriority());
        $qb->field('priority')->set($job->getPriority());
        $qb->getQuery()->execute();

        $qb = $objectManager->createQueryBuilder($this->getObjectName());
        $qb->findAndUpdate();
        $qb->field('_id')->equals($oldJob->getId());
        $qb->field('whenAt')->gt($job->getWhenAt());
        $qb->field('whenAt')->set($job->getWhenAt());
        $qb->getQuery()->execute();

        if ($job->getWhenAt() < $oldJob->getWhenAt()) {
            $oldJob->setWhenAt($job->getWhenAt());
        }
        if ($job->getPriority() > $oldJob->getPriority()) {
            $oldJob->setPriority($job->getPriority());
        }

        return $oldJob;
    }
}


1		<?php
2
3		namespace Dtc\QueueBundle\ODM;
4
5		use Doctrine\MongoDB\Query\Builder;
6		use Dtc\QueueBundle\Doctrine\BaseJobManager;
7		use Doctrine\ODM\MongoDB\DocumentManager;
8		use Dtc\QueueBundle\Model\BaseJob;
9		use Dtc\QueueBundle\Model\RetryableJob;
10
11		class JobManager extends BaseJobManager
12		{
13		use CommonTrait;
14
15	3	public function countJobsByStatus($objectName, $status, $workerName = null, $method = null)
16		{
17		/** @var DocumentManager $objectManager */
18	3	$objectManager = $this->getObjectManager();
19	3	$qb = $objectManager->createQueryBuilder($objectName);
20		$qb
21	3	->find()
22	3	->field('status')->equals($status);
23
24	3	$this->addWorkerNameCriterion($qb, $workerName, $method);
25	3	$query = $qb->getQuery();
26
27	3	return $query->count();
28		}
29
30		/**
31		* @param string\|null $workerName
32		* @param string\|null $method
33		*/
34	1	public function pruneErroneousJobs($workerName = null, $method = null)
35		{
36		/** @var DocumentManager $objectManager */
37	1	$objectManager = $this->getObjectManager();
38	1	$qb = $objectManager->createQueryBuilder($this->getArchiveObjectName());
39	1	$qb = $qb->remove();
40	1	$qb->field('status')->equals(BaseJob::STATUS_ERROR);
41	1	$this->addWorkerNameCriterion($qb, $workerName, $method);
42
43	1	$query = $qb->getQuery();
44	1	$result = $query->execute();
45	1	if (isset($result['n'])) {
46	1	return $result['n'];
47		}
48
49		return 0;
50		}
51
52		/**
53		* @param Builder $builder
54		* @param string\|null $workerName
55		* @param string\|null $method
56		*/
57	16	protected function addWorkerNameCriterion(Builder $builder, $workerName = null, $method = null)
58		{
59	16	if (null !== $workerName) {
60	4	$builder->field('workerName')->equals($workerName);
61		}
62
63	16	if (null !== $method) {
64	3	$builder->field('method')->equals($method);
65		}
66	16	}
67
68		/**
69		* @param null $workerName
70		* @param null $method
71		*
72		* @return int
73		*/
74	2	protected function updateExpired($workerName = null, $method = null)
75		{
76		/** @var DocumentManager $objectManager */
77	2	$objectManager = $this->getObjectManager();
78	2	$qb = $objectManager->createQueryBuilder($this->getObjectName());
79	2	$qb = $qb->updateMany();
80	2	$qb->field('expiresAt')->lte(new \DateTime());
81	2	$qb->field('status')->equals(BaseJob::STATUS_NEW);
82	2	$this->addWorkerNameCriterion($qb, $workerName, $method);
83	2	$qb->field('status')->set(\Dtc\QueueBundle\Model\Job::STATUS_EXPIRED);
84	2	$query = $qb->getQuery();
85	2	$result = $query->execute();
86	2	if (isset($result['n'])) {
87	2	return $result['n'];
88		}
89
90		return 0;
91		}
92
93		/**
94		* Removes archived jobs older than $olderThan.
95		*
96		* @param \DateTime $olderThan
97		* return int
98		*/
99	1	public function pruneArchivedJobs(\DateTime $olderThan)
100		{
101	1	return $this->removeOlderThan($this->getArchiveObjectName(), 'updatedAt', $olderThan);
102		}
103
104	2	public function getJobCount($workerName = null, $method = null)
105		{
106		/** @var DocumentManager $objectManager */
107	2	$objectManager = $this->getObjectManager();
108	2	$qb = $objectManager->createQueryBuilder($this->getObjectName());
109		$qb
110	2	->find();
111
112	2	$this->addWorkerNameCriterion($qb, $workerName, $method);
113
114		// Filter
115	2	$date = new \DateTime();
116		$qb
117	2	->addAnd(
118	2	$qb->expr()->addOr($qb->expr()->field('expiresAt')->equals(null), $qb->expr()->field('expiresAt')->gt($date))
119		)
120	2	->field('locked')->equals(null);
121
122	2	$query = $qb->getQuery();
123
124	2	return $query->count(true);
125		}
126
127		/**
128		* Get Status Jobs.
129		*
130		* @param string $documentName
131		*
132		* @return array
133		*/
134	2	protected function getStatusByDocument($documentName)
135		{
136		// Run a map reduce function get worker and status break down
137	2	$mapFunc = "function() {
138		var result = {};
139		result[this.status] = 1;
140		var key = this.worker_name + '->' + this.method + '()';
141		emit(key, result);
142		}";
143	2	$reduceFunc = 'function(k, vals) {
144		var result = {};
145		for (var index in vals) {
146		var val = vals[index];
147		for (var i in val) {
148		if (result.hasOwnProperty(i)) {
149		result[i] += val[i];
150		}
151		else {
152		result[i] = val[i];
153		}
154		}
155		}
156		return result;
157		}';
158		/** @var DocumentManager $objectManager */
159	2	$objectManager = $this->getObjectManager();
160	2	$qb = $objectManager->createQueryBuilder($documentName);
161	2	$qb->map($mapFunc)
162	2	->reduce($reduceFunc);
163	2	$query = $qb->getQuery();
164	2	$results = $query->execute();
165
166		$allStatus = array(
167	2	BaseJob::STATUS_ERROR => 0,
168	2	BaseJob::STATUS_NEW => 0,
169	2	RetryableJob::STATUS_EXPIRED => 0,
170	2	RetryableJob::STATUS_MAX_ERROR => 0,
171	2	RetryableJob::STATUS_MAX_RETRIES => 0,
172	2	RetryableJob::STATUS_MAX_STALLED => 0,
173	2	BaseJob::STATUS_RUNNING => 0,
174	2	BaseJob::STATUS_SUCCESS => 0,
175		);
176
177	2	$status = [];
178
179	2	foreach ($results as $info) {
180	1	$status[$info['_id']] = $info['value'] + $allStatus;
181		}
182
183	2	return $status;
184		}
185
186	2	public function getStatus()
187		{
188	2	$result = $this->getStatusByDocument($this->getObjectName());
189	2	$status2 = $this->getStatusByDocument($this->getArchiveObjectName());
190	2	foreach ($status2 as $key => $value) {
191	1	foreach ($value as $k => $v) {
192	1	$result[$key][$k] += $v;
193		}
194		}
195
196	2	$finalResult = [];
197	2	foreach ($result as $key => $item) {
198	1	ksort($item);
199	1	$finalResult[$key] = $item;
200		}
201
202	2	return $finalResult;
203		}
204
205		/**
206		* Get the next job to run (can be filtered by workername and method name).
207		*
208		* @param string $workerName
209		* @param string $methodName
210		* @param bool $prioritize
211		*
212		* @return \Dtc\QueueBundle\Model\Job
213		*/
214	9	public function getJob($workerName = null, $methodName = null, $prioritize = true, $runId = null)
215		{
216		/** @var DocumentManager $objectManager */
217	9	$objectManager = $this->getObjectManager();
218	9	$qb = $objectManager->createQueryBuilder($this->getObjectName());
219		$qb
220	9	->findAndUpdate()
221	9	->returnNew();
222
223	9	$this->addWorkerNameCriterion($qb, $workerName, $methodName);
224	9	if ($prioritize) {
225	9	$qb->sort([
226	9	'priority' => 'desc',
227		'whenAt' => 'asc',
228		]);
229		} else {
230	1	$qb->sort('whenAt', 'asc');
231		}
232
233		// Filter
234	9	$date = new \DateTime();
235		$qb
236	9	->addAnd(
237	9	$qb->expr()->addOr($qb->expr()->field('whenAt')->equals(null), $qb->expr()->field('whenAt')->lte($date)),
238	9	$qb->expr()->addOr($qb->expr()->field('expiresAt')->equals(null), $qb->expr()->field('expiresAt')->gt($date))
239		)
240	9	->field('status')->equals(BaseJob::STATUS_NEW)
241	9	->field('locked')->equals(null);
242
243		// Update
244		$qb
245	9	->field('lockedAt')->set($date) // Set started
246	9	->field('locked')->set(true)
247	9	->field('status')->set(BaseJob::STATUS_RUNNING)
248	9	->field('runId')->set($runId);
249
250	9	$query = $qb->getQuery();
251
252	9	$job = $query->execute();
253
254	9	return $job;
255		}
256
257	1	protected function updateNearestBatch(\Dtc\QueueBundle\Model\Job $job)
258		{
259		/** @var DocumentManager $objectManager */
260	1	$objectManager = $this->getObjectManager();
261	1	$qb = $objectManager->createQueryBuilder($this->getObjectName());
262	1	$qb->find();
263
264	1	$qb->sort('whenAt', 'asc');
265	1	$qb->field('status')->equals(BaseJob::STATUS_NEW)
266	1	->field('crcHash')->equals($job->getCrcHash())
267	1	->field('locked')->equals(null);
268	1	$oldJob = $qb->getQuery()->getSingleResult();
269
270	1	if (!$oldJob) {
271		return null;
272		}
273
274		// Update priority or whenAt
275		// This makes sure if someone else is updating at the same time
276		// that we don't trounce their changes.
277	1	$qb = $objectManager->createQueryBuilder($this->getObjectName());
278	1	$qb->findAndUpdate();
279	1	$qb->field('_id')->equals($oldJob->getId());
280	1	$qb->field('priority')->lt($job->getPriority());
281	1	$qb->field('priority')->set($job->getPriority());
282	1	$qb->getQuery()->execute();
283
284	1	$qb = $objectManager->createQueryBuilder($this->getObjectName());
285	1	$qb->findAndUpdate();
286	1	$qb->field('_id')->equals($oldJob->getId());
287	1	$qb->field('whenAt')->gt($job->getWhenAt());
288	1	$qb->field('whenAt')->set($job->getWhenAt());
289	1	$qb->getQuery()->execute();
290
291	1	if ($job->getWhenAt() < $oldJob->getWhenAt()) {
292	1	$oldJob->setWhenAt($job->getWhenAt());
293		}
294	1	if ($job->getPriority() > $oldJob->getPriority()) {
295	1	$oldJob->setPriority($job->getPriority());
296		}
297
298	1	return $oldJob;
299		}
300		}
301

mmucklo / DtcQueueBundle

Push — master ( cf2de2...e02161 )

JobManager::getJob() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like