JobManager::getJobCount() - Code Metrics - Inspection of "Update beanstalk, rabbitmq, many minor fixes, incl..." - mmucklo/DtcQueueBundle - Measure and Improve Code Quality continuously with Scrutinizer

Test Setup Failed

Pull Request — master (#7)

by Matthew

created 2017-08-17 16:45 UTC

JobManager::getJobCount() B

↳ Parent: JobManager

Complexity

Conditions	3
Paths	4

Size

Total Lines	24
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	24
rs	8.9713
c	0
b	0
f	0
cc	3
eloc	14
nc	4
nop	2

<?php

namespace Dtc\QueueBundle\Documents;

use Dtc\QueueBundle\Model\JobManagerInterface;
use Doctrine\ODM\MongoDB\DocumentRepository;
use Doctrine\ODM\MongoDB\DocumentManager;

class JobManager implements JobManagerInterface
{
    protected $dm;
    protected $documentName;

    public function __construct(DocumentManager $dm, $documentName)
    {
        $this->dm = $dm;
        $this->documentName = $documentName;
    }

    /**
     * @return DocumentManager
     */
    public function getDocumentManager()
    {
        return $this->dm;
    }

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

    /**
     * @return DocumentRepository
     */
    public function getRepository()
    {
        return $this->dm->getRepository($this->documentName);
    }

    public function resetErroneousJobs($workerName = null, $method = null)
    {
        $qb = $this->dm->createQueryBuilder($this->documentName);
        $qb

            ->update()
            ->multiple(true)
            ->field('status')->equals(Job::STATUS_ERROR)
            ->field('locked')->set(null)
            ->field('status')->set(Job::STATUS_NEW);

        if ($workerName) {
            $qb->field('workerName')->equals($workerName);
        }

        if ($method) {
            $qb->field('method')->equals($method);
        }

        $query = $qb->getQuery();
        $query->execute();
    }

    public function pruneErroneousJobs($workerName = null, $method = null)
    {
        $qb = $this->dm->createQueryBuilder($this->documentName);
        $qb
        ->remove()
        ->multiple(true)
        ->field('status')->equals(Job::STATUS_ERROR);

        if ($workerName) {
            $qb->field('workerName')->equals($workerName);
        }

        if ($method) {
            $qb->field('method')->equals($method);
        }

        $query = $qb->getQuery();
        $query->execute();
    }

    public function getJobCount($workerName = null, $method = null)
    {
        $qb = $this->dm->createQueryBuilder($this->documentName);
        $qb
        ->find();

        if ($workerName) {
            $qb->field('workerName')->equals($workerName);
        }

        if ($method) {
            $qb->field('method')->equals($method);
        }

        // Filter
        $qb
            ->addOr($qb->expr()->field('when')->equals(null))
            ->addOr($qb->expr()->field('when')->lte(new \DateTime()))
            ->field('locked')->equals(null);

        $query = $qb->getQuery();

        return $query->count(true);
    }

    /**
     * Get Status Jobs.
     */
    public function getStatus()
    {
        // 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;
        }';

        $qb = $this->dm->createQueryBuilder($this->documentName)
            ->map($mapFunc)
            ->reduce($reduceFunc);
        $query = $qb->getQuery();
        $results = $query->execute();

        $allStatus = array(
            Job::STATUS_ERROR => 0,
            Job::STATUS_NEW => 0,
            Job::STATUS_SUCCESS => 0,
        );

        $status = [];

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

        return $status;
    }

    /**
     * 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)
    {
        $qb = $this->dm->createQueryBuilder($this->documentName);
        $qb
            ->findAndUpdate()
            ->returnNew();

        if ($workerName) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $qb->field('workerName')->equals($workerName);
        }

        if ($methodName) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $qb->field('method')->equals($methodName);
        }

        if ($prioritize) {
            $qb->sort('priority', 'asc');
        } else {
            $qb->sort('when', 'asc');
        }

        // Filter
        $qb
            ->addOr($qb->expr()->field('when')->equals(null))
            ->addOr($qb->expr()->field('when')->lte(new \DateTime()))
            ->field('status')->equals(Job::STATUS_NEW)
            ->field('locked')->equals(null);
        // Update
        $qb
            ->field('lockedAt')->set(new \DateTime())        // Set started
            ->field('locked')->set(true)
        ;

        //$arr = $qb->getQueryArray();

        $query = $qb->getQuery();

        //ve($query->debug());

        $job = $query->execute();

        return $job;
    }

    public function deleteJob(\Dtc\QueueBundle\Model\Job $job)
    {
        $this->dm->remove($job);
        $this->dm->flush();
    }

    public function saveHistory(\Dtc\QueueBundle\Model\Job $job)
    {
        $this->save($job);
    }

    public function save(\Dtc\QueueBundle\Model\Job $job)
    {
        // Todo: Serialize args

        // Generate crc hash for the job
        $hashValues = array($job->getClassName(), $job->getMethod(), $job->getWorkerName(), $job->getArgs());
        $crcHash = hash('sha256', serialize($hashValues));
        $job->setCrcHash($crcHash);

        if ($job->getBatch() === true) {
            // See if similar job that hasn't run exists
            $criteria = array('crcHash' => $crcHash, 'status' => Job::STATUS_NEW);
            $oldJob = $this->getRepository()->findOneBy($criteria);

            if ($oldJob) {
                // Old job exists - just override fields Set higher priority
                $oldJob->setPriority(max($job->getPriority(), $oldJob->getPriority()));
                $oldJob->setWhen(min($job->getWhen(), $oldJob->getWhen()));
                $oldJob->setBatch(true);
                $oldJob->setUpdatedAt(new \DateTime());

                $this->dm->flush();

                return $oldJob;
            }
        }

        // Just save a new job
        $this->dm->persist($job);
        $this->dm->flush();

        return $job;
    }
}


1			<?php
2
3			namespace Dtc\QueueBundle\Documents;
4
5			use Dtc\QueueBundle\Model\JobManagerInterface;
6			use Doctrine\ODM\MongoDB\DocumentRepository;
7			use Doctrine\ODM\MongoDB\DocumentManager;
8
9			class JobManager implements JobManagerInterface
10			{
11			protected $dm;
12			protected $documentName;
13
14			public function __construct(DocumentManager $dm, $documentName)
15			{
16			$this->dm = $dm;
17			$this->documentName = $documentName;
18			}
19
20			/**
21			* @return DocumentManager
22			*/
23			public function getDocumentManager()
24			{
25			return $this->dm;
26			}
27
28			/**
29			* @return string
30			*/
31			public function getDocumentName()
32			{
33			return $this->documentName;
34			}
35
36			/**
37			* @return DocumentRepository
38			*/
39			public function getRepository()
40			{
41			return $this->dm->getRepository($this->documentName);
42			}
43
44			public function resetErroneousJobs($workerName = null, $method = null)
45			{
46			$qb = $this->dm->createQueryBuilder($this->documentName);
47			$qb
			0 ignored issues – show Deprecated Code introduced 2017-07-24 01:46 UTC by Report Bug Copy Issue Report The method `Doctrine\ODM\MongoDB\Query\Builder::update()` has been deprecated with message: Deprecated in version 1.2 - use updateOne or updateMany instead This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
48			->update()
49			->multiple(true)
50			->field('status')->equals(Job::STATUS_ERROR)
51			->field('locked')->set(null)
52			->field('status')->set(Job::STATUS_NEW);
53
54			if ($workerName) {
55			$qb->field('workerName')->equals($workerName);
56			}
57
58			if ($method) {
59			$qb->field('method')->equals($method);
60			}
61
62			$query = $qb->getQuery();
63			$query->execute();
64			}
65
66			public function pruneErroneousJobs($workerName = null, $method = null)
67			{
68			$qb = $this->dm->createQueryBuilder($this->documentName);
69			$qb
70			->remove()
71			->multiple(true)
72			->field('status')->equals(Job::STATUS_ERROR);
73
74			if ($workerName) {
75			$qb->field('workerName')->equals($workerName);
76			}
77
78			if ($method) {
79			$qb->field('method')->equals($method);
80			}
81
82			$query = $qb->getQuery();
83			$query->execute();
84			}
85
86			public function getJobCount($workerName = null, $method = null)
87			{
88			$qb = $this->dm->createQueryBuilder($this->documentName);
89			$qb
90			->find();
91
92			if ($workerName) {
93			$qb->field('workerName')->equals($workerName);
94			}
95
96			if ($method) {
97			$qb->field('method')->equals($method);
98			}
99
100			// Filter
101			$qb
102			->addOr($qb->expr()->field('when')->equals(null))
103			->addOr($qb->expr()->field('when')->lte(new \DateTime()))
104			->field('locked')->equals(null);
105
106			$query = $qb->getQuery();
107
108			return $query->count(true);
109			}
110
111			/**
112			* Get Status Jobs.
113			*/
114			public function getStatus()
115			{
116			// Run a map reduce function get worker and status break down
117			$mapFunc = "function() {
118			var result = {};
119			result[this.status] = 1;
120			var key = this.worker_name + '->' + this.method + '()';
121			emit(key, result);
122			}";
123			$reduceFunc = 'function(k, vals) {
124			var result = {};
125			for (var index in vals) {
126			var val = vals[index];
127			for (var i in val) {
128			if (result.hasOwnProperty(i)) {
129			result[i] += val[i];
130			}
131			else {
132			result[i] = val[i];
133			}
134			}
135			}
136			return result;
137			}';
138
139			$qb = $this->dm->createQueryBuilder($this->documentName)
140			->map($mapFunc)
141			->reduce($reduceFunc);
142			$query = $qb->getQuery();
143			$results = $query->execute();
144
145			$allStatus = array(
146			Job::STATUS_ERROR => 0,
147			Job::STATUS_NEW => 0,
148			Job::STATUS_SUCCESS => 0,
149			);
150
151			$status = [];
152
153			foreach ($results as $info) {
154			$status[$info['_id']] = $info['value'] + $allStatus;
155			}
156
157			return $status;
158			}
159
160			/**
161			* Get the next job to run (can be filtered by workername and method name).
162			*
163			* @param string $workerName
164			* @param string $methodName
165			* @param bool $prioritize
166			*
167			* @return \Dtc\QueueBundle\Model\Job
168			*/
169			public function getJob($workerName = null, $methodName = null, $prioritize = true)
170			{
171			$qb = $this->dm->createQueryBuilder($this->documentName);
172			$qb
173			->findAndUpdate()
174			->returnNew();
175
176			if ($workerName) {
			0 ignored issues – show Bug Best Practice introduced 2016-01-27 22:30 UTC by Report Bug Copy Issue Report The expression `$workerName` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. 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 `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
177			$qb->field('workerName')->equals($workerName);
178			}
179
180			if ($methodName) {
			0 ignored issues – show Bug Best Practice introduced 2016-01-27 22:30 UTC by Report Bug Copy Issue Report The expression `$methodName` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. 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 `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
181			$qb->field('method')->equals($methodName);
182			}
183
184			if ($prioritize) {
185			$qb->sort('priority', 'asc');
186			} else {
187			$qb->sort('when', 'asc');
188			}
189
190			// Filter
191			$qb
192			->addOr($qb->expr()->field('when')->equals(null))
193			->addOr($qb->expr()->field('when')->lte(new \DateTime()))
194			->field('status')->equals(Job::STATUS_NEW)
195			->field('locked')->equals(null);
196			// Update
197			$qb
198			->field('lockedAt')->set(new \DateTime()) // Set started
199			->field('locked')->set(true)
200			;
201
202			//$arr = $qb->getQueryArray();
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-08-17 16:59 UTC by Report Bug Copy Issue Report `60%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
203			$query = $qb->getQuery();
204
205			//ve($query->debug());
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-06-02 08:54 UTC by Report Bug Copy Issue Report `78%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
206			$job = $query->execute();
207
208			return $job;
209			}
210
211			public function deleteJob(\Dtc\QueueBundle\Model\Job $job)
212			{
213			$this->dm->remove($job);
214			$this->dm->flush();
215			}
216
217			public function saveHistory(\Dtc\QueueBundle\Model\Job $job)
218			{
219			$this->save($job);
220			}
221
222			public function save(\Dtc\QueueBundle\Model\Job $job)
223			{
224			// Todo: Serialize args
225
226			// Generate crc hash for the job
227			$hashValues = array($job->getClassName(), $job->getMethod(), $job->getWorkerName(), $job->getArgs());
228			$crcHash = hash('sha256', serialize($hashValues));
229			$job->setCrcHash($crcHash);
230
231			if ($job->getBatch() === true) {
232			// See if similar job that hasn't run exists
233			$criteria = array('crcHash' => $crcHash, 'status' => Job::STATUS_NEW);
234			$oldJob = $this->getRepository()->findOneBy($criteria);
235
236			if ($oldJob) {
237			// Old job exists - just override fields Set higher priority
238			$oldJob->setPriority(max($job->getPriority(), $oldJob->getPriority()));
239			$oldJob->setWhen(min($job->getWhen(), $oldJob->getWhen()));
240			$oldJob->setBatch(true);
241			$oldJob->setUpdatedAt(new \DateTime());
242
243			$this->dm->flush();
244
245			return $oldJob;
246			}
247			}
248
249			// Just save a new job
250			$this->dm->persist($job);
251			$this->dm->flush();
252
253			return $job;
254			}
255			}
256

mmucklo / DtcQueueBundle

Pull Request — master (#7)

JobManager::getJobCount() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like