JobManager - Code Metrics - Inspection of "Merge branch 'feature/doctrine_orm'" - mmucklo/DtcQueueBundle - Measure and Improve Code Quality continuously with Scrutinizer

Test Setup Failed

Push — master ( 298fd3...56daff )

by Matthew

created 2017-10-14 18:10 UTC

JobManager A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	270
Duplicated Lines	15.56 %

Coupling/Cohesion

Components	1
Dependencies	10

Importance

Changes

Metric	Value
wmc	27
lcom	1
cbo	10
dl	42
loc	270
rs	10
c	0
b	0
f	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	stopIdGenerator()	0	9	1
B	countJobsByStatus()	0	30	4
A	pruneErroneousJobs()	21	21	3
A	pruneExpiredJobs()	21	21	3
A	pruneArchivedJobs()	0	13	1
B	getJobCount()	0	45	4
A	getStatus()	0	14	2
A	getStatusByEntityName()	0	18	3
B	getJob()	0	71	6

How to fix Duplicated Code

<?php

namespace Dtc\QueueBundle\ORM;

use Doctrine\DBAL\LockMode;
use Doctrine\ORM\EntityManager;
use Doctrine\ORM\EntityRepository;
use Doctrine\ORM\Id\AssignedGenerator;
use Doctrine\ORM\Mapping\ClassMetadata;
use Doctrine\ORM\QueryBuilder;
use Dtc\QueueBundle\Doctrine\BaseJobManager;
use Dtc\QueueBundle\Entity\Job;

class JobManager extends BaseJobManager
{
    public function stopIdGenerator($objectName)
    {
        $objectManager = $this->getObjectManager();
        $repository = $objectManager->getRepository($objectName);
        /** @var ClassMetadata $metadata */
        $metadata = $objectManager->getClassMetadata($repository->getClassName());
        $metadata->setIdGeneratorType(ClassMetadata::GENERATOR_TYPE_NONE);
        $metadata->setIdGenerator(new AssignedGenerator());
    }

    public function countJobsByStatus($objectName, $status, $workerName = null, $method = null)
    {
        /** @var EntityManager $objectManager */
        $objectManager = $this->getObjectManager();

        $qb = $objectManager
            ->createQueryBuilder()
            ->select('count(a.id)')
            ->from($objectName, 'a')
            ->where('a.status = :status');

        if ($workerName) {
            $qb->andWhere('a.workerName = :workerName')
                ->setParameter(':workerName', $workerName);
        }

        if ($method) {
            $qb->andWhere('a.method = :method')
                ->setParameter(':method', $workerName);
        }

        $count = $qb->setParameter(':status', $status)
            ->getQuery()->getSingleScalarResult();

        if (!$count) {
            return 0;
        }

        return $count;
    }

    public function pruneErroneousJobs($workerName = null, $method = null)

    {
        /** @var EntityManager $objectManager */
        $objectManager = $this->getObjectManager();
        $qb = $objectManager->createQueryBuilder()->delete($this->getArchiveObjectName(), 'j');
        $qb = $qb
            ->where('j.status = :status')
            ->setParameter(':status', Job::STATUS_ERROR);

        if ($workerName) {
            $qb->andWhere('j.workerName = :workerName')->setParameter(':workerName', $workerName);
        }

        if ($method) {
            $qb->andWhere('j.method = :method')->setParameter(':method', $method);
        }

        $query = $qb->getQuery();

        return $query->execute();
    }

    public function pruneExpiredJobs($workerName = null, $method = null)

    {
        /** @var EntityManager $objectManager */
        $objectManager = $this->getObjectManager();
        $qb = $objectManager->createQueryBuilder()->delete($this->getObjectName(), 'j');
        $qb = $qb
            ->where('j.expiresAt <= :expiresAt')
            ->setParameter(':expiresAt', new \DateTime());

        if ($workerName) {
            $qb->andWhere('j.workerName = :workerName')->setParameter(':workerName', $workerName);
        }

        if ($method) {
            $qb->andWhere('j.method = :method')->setParameter(':method', $method);
        }

        $query = $qb->getQuery();

        return $query->execute();
    }

    /**
     * Removes archived jobs older than $olderThan.
     *
     * @param \DateTime $olderThan
     */
    public function pruneArchivedJobs(\DateTime $olderThan)
    {
        /** @var EntityManager $objectManager */
        $objectManager = $this->getObjectManager();
        $qb = $objectManager->createQueryBuilder()->delete($this->getArchiveObjectName(), 'j');
        $qb = $qb
            ->where('j.updatedAt < :updatedAt')
            ->setParameter(':updatedAt', $olderThan);

        $query = $qb->getQuery();

        return $query->execute();
    }

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


        $qb = $qb->select('count(j)')->from($this->getObjectName(), 'j');

        $where = 'where';
        if ($workerName) {
            if ($method) {
                $qb->where($qb->expr()->andX(
                    $qb->expr()->eq('j.workerName', ':workerName'),
                                             $qb->expr()->eq('j.method', ':method')
                ))
                    ->setParameter(':method', $method);
            } else {
                $qb->where('j.workerName = :workerName');
            }
            $qb->setParameter(':workerName', $workerName);
            $where = 'andWhere';
        } elseif ($method) {
            $qb->where('j.method = :method')->setParameter(':method', $method);
            $where = 'andWhere';
        }

        $dateTime = new \DateTime();
        // Filter
        $qb
            ->$where($qb->expr()->orX(
                $qb->expr()->isNull('j.whenAt'),
                                        $qb->expr()->lte('j.whenAt', ':whenAt')
            ))
            ->andWhere($qb->expr()->orX(
                $qb->expr()->isNull('j.expiresAt'),
                $qb->expr()->gt('j.expiresAt', ':expiresAt')
            ))
            ->andWhere('j.locked is NULL')
            ->setParameter(':whenAt', $dateTime)
            ->setParameter(':expiresAt', $dateTime);

        $query = $qb->getQuery();

        return $query->getSingleScalarResult();
    }

    /**
     * Get Jobs statuses.
     */
    public function getStatus()
    {
        $result = [];
        $this->getStatusByEntityName($this->getObjectName(), $result);
        $this->getStatusByEntityName($this->getObjectName(), $result);

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

        return $finalResult;
    }

    protected function getStatusByEntityName($entityName, array &$result)
    {
        /** @var EntityManager $objectManager */
        $objectManager = $this->getObjectManager();
        $result1 = $objectManager->getRepository($entityName)->createQueryBuilder('j')->select('j.workerName, j.method, j.status, count(j) as c')
            ->groupBy('j.workerName, j.method, j.status')->getQuery()->getArrayResult();

        foreach ($result1 as $item) {
            $method = $item['workerName'].'->'.$item['method'];
            if (!isset($result[$method])) {
                $result[$method] = [Job::STATUS_NEW => 0,
                                    Job::STATUS_RUNNING => 0,
                                    Job::STATUS_SUCCESS => 0,
                                    Job::STATUS_ERROR => 0, ];
            }
            $result[$method][$item['status']] += intval($item['c']);
        }
    }

    /**
     * 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|null
     */
    public function getJob($workerName = null, $methodName = null, $prioritize = true, $runId = null)
    {
        $uniqid = uniqid(gethostname().'-'.getmypid(), true);
        $hash = hash('sha256', $uniqid);

        /** @var EntityManager $objectManager */
        $objectManager = $this->getObjectManager();

        $objectManager->beginTransaction();

        /** @var EntityRepository $repository */
        $repository = $this->getRepository();
        $qb = $repository->createQueryBuilder('j');
        $dateTime = new \DateTime();
        $qb
            ->select('j')
            ->where('j.status = :status')->setParameter(':status', Job::STATUS_NEW)
            ->andWhere('j.locked is NULL')
            ->andWhere($qb->expr()->orX(
                $qb->expr()->isNull('j.whenAt'),
                        $qb->expr()->lte('j.whenAt', ':whenAt')
            ))
            ->andWhere($qb->expr()->orX(
                $qb->expr()->isNull('j.expiresAt'),
                        $qb->expr()->gt('j.expiresAt', ':expiresAt')
            ))
            ->setParameter(':whenAt', $dateTime)
            ->setParameter(':expiresAt', $dateTime);

        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->andWhere('j.workerName = :workerName')
                ->setParameter(':workerName', $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->andWhere('j.method = :method')
                ->setParameter(':method', $methodName);
        }

        if ($prioritize) {
            $qb->add('orderBy', 'j.priority ASC, j.whenAt ASC');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } else {
            $qb->orderBy('j.whenAt', 'ASC');
        }
        $qb->setMaxResults(1);

        /** @var QueryBuilder $qb */
        $query = $qb->getQuery();
        $query->setLockMode(LockMode::PESSIMISTIC_WRITE);
        $jobs = $query->getResult();

        if ($jobs) {
            /** @var Job $job */
            $job = $jobs[0];
            if (!$job) {
                throw new \Exception("No job found for $hash, even though last result was count ".count($jobs));
            }
            $job->setLocked(true);
            $job->setLockedAt(new \DateTime());
            $job->setStatus(Job::STATUS_RUNNING);
            $job->setRunId($runId);
            $objectManager->commit();
            $objectManager->flush();

            return $job;
        }

        $objectManager->rollback();

        return null;
    }
}


1		<?php
2
3		namespace Dtc\QueueBundle\ORM;
4
5		use Doctrine\DBAL\LockMode;
6		use Doctrine\ORM\EntityManager;
7		use Doctrine\ORM\EntityRepository;
8		use Doctrine\ORM\Id\AssignedGenerator;
9		use Doctrine\ORM\Mapping\ClassMetadata;
10		use Doctrine\ORM\QueryBuilder;
11		use Dtc\QueueBundle\Doctrine\BaseJobManager;
12		use Dtc\QueueBundle\Entity\Job;
13
14		class JobManager extends BaseJobManager
15		{
16		public function stopIdGenerator($objectName)
17		{
18		$objectManager = $this->getObjectManager();
19		$repository = $objectManager->getRepository($objectName);
20		/** @var ClassMetadata $metadata */
21		$metadata = $objectManager->getClassMetadata($repository->getClassName());
22		$metadata->setIdGeneratorType(ClassMetadata::GENERATOR_TYPE_NONE);
23		$metadata->setIdGenerator(new AssignedGenerator());
24		}
25
26		public function countJobsByStatus($objectName, $status, $workerName = null, $method = null)
27		{
28		/** @var EntityManager $objectManager */
29		$objectManager = $this->getObjectManager();
30
31		$qb = $objectManager
32		->createQueryBuilder()
33		->select('count(a.id)')
34		->from($objectName, 'a')
35		->where('a.status = :status');
36
37		if ($workerName) {
38		$qb->andWhere('a.workerName = :workerName')
39		->setParameter(':workerName', $workerName);
40		}
41
42		if ($method) {
43		$qb->andWhere('a.method = :method')
44		->setParameter(':method', $workerName);
45		}
46
47		$count = $qb->setParameter(':status', $status)
48		->getQuery()->getSingleScalarResult();
49
50		if (!$count) {
51		return 0;
52		}
53
54		return $count;
55		}
56
57	View Code Duplication	public function pruneErroneousJobs($workerName = null, $method = null)
		0 ignored issues – show Duplication introduced 2017-10-14 18:28 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
58		{
59		/** @var EntityManager $objectManager */
60		$objectManager = $this->getObjectManager();
61		$qb = $objectManager->createQueryBuilder()->delete($this->getArchiveObjectName(), 'j');
62		$qb = $qb
63		->where('j.status = :status')
64		->setParameter(':status', Job::STATUS_ERROR);
65
66		if ($workerName) {
67		$qb->andWhere('j.workerName = :workerName')->setParameter(':workerName', $workerName);
68		}
69
70		if ($method) {
71		$qb->andWhere('j.method = :method')->setParameter(':method', $method);
72		}
73
74		$query = $qb->getQuery();
75
76		return $query->execute();
77		}
78
79	View Code Duplication	public function pruneExpiredJobs($workerName = null, $method = null)
		0 ignored issues – show Duplication introduced 2017-10-14 18:28 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
80		{
81		/** @var EntityManager $objectManager */
82		$objectManager = $this->getObjectManager();
83		$qb = $objectManager->createQueryBuilder()->delete($this->getObjectName(), 'j');
84		$qb = $qb
85		->where('j.expiresAt <= :expiresAt')
86		->setParameter(':expiresAt', new \DateTime());
87
88		if ($workerName) {
89		$qb->andWhere('j.workerName = :workerName')->setParameter(':workerName', $workerName);
90		}
91
92		if ($method) {
93		$qb->andWhere('j.method = :method')->setParameter(':method', $method);
94		}
95
96		$query = $qb->getQuery();
97
98		return $query->execute();
99		}
100
101		/**
102		* Removes archived jobs older than $olderThan.
103		*
104		* @param \DateTime $olderThan
105		*/
106		public function pruneArchivedJobs(\DateTime $olderThan)
107		{
108		/** @var EntityManager $objectManager */
109		$objectManager = $this->getObjectManager();
110		$qb = $objectManager->createQueryBuilder()->delete($this->getArchiveObjectName(), 'j');
111		$qb = $qb
112		->where('j.updatedAt < :updatedAt')
113		->setParameter(':updatedAt', $olderThan);
114
115		$query = $qb->getQuery();
116
117		return $query->execute();
118		}
119
120		public function getJobCount($workerName = null, $method = null)
121		{
122		/** @var EntityManager $objectManager */
123		$objectManager = $this->getObjectManager();
124		$qb = $objectManager->createQueryBuilder('j');
		0 ignored issues – show Unused Code introduced 2017-10-14 18:28 UTC by Report Bug Copy Issue Report The call to `EntityManager::createQueryBuilder()` has too many arguments starting with `'j'`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
125
126		$qb = $qb->select('count(j)')->from($this->getObjectName(), 'j');
127
128		$where = 'where';
129		if ($workerName) {
130		if ($method) {
131		$qb->where($qb->expr()->andX(
132		$qb->expr()->eq('j.workerName', ':workerName'),
133		$qb->expr()->eq('j.method', ':method')
134		))
135		->setParameter(':method', $method);
136		} else {
137		$qb->where('j.workerName = :workerName');
138		}
139		$qb->setParameter(':workerName', $workerName);
140		$where = 'andWhere';
141		} elseif ($method) {
142		$qb->where('j.method = :method')->setParameter(':method', $method);
143		$where = 'andWhere';
144		}
145
146		$dateTime = new \DateTime();
147		// Filter
148		$qb
149		->$where($qb->expr()->orX(
150		$qb->expr()->isNull('j.whenAt'),
151		$qb->expr()->lte('j.whenAt', ':whenAt')
152		))
153		->andWhere($qb->expr()->orX(
154		$qb->expr()->isNull('j.expiresAt'),
155		$qb->expr()->gt('j.expiresAt', ':expiresAt')
156		))
157		->andWhere('j.locked is NULL')
158		->setParameter(':whenAt', $dateTime)
159		->setParameter(':expiresAt', $dateTime);
160
161		$query = $qb->getQuery();
162
163		return $query->getSingleScalarResult();
164		}
165
166		/**
167		* Get Jobs statuses.
168		*/
169		public function getStatus()
170		{
171		$result = [];
172		$this->getStatusByEntityName($this->getObjectName(), $result);
173		$this->getStatusByEntityName($this->getObjectName(), $result);
174
175		$finalResult = [];
176		foreach ($result as $key => $item) {
177		ksort($item);
178		$finalResult[$key] = $item;
179		}
180
181		return $finalResult;
182		}
183
184		protected function getStatusByEntityName($entityName, array &$result)
185		{
186		/** @var EntityManager $objectManager */
187		$objectManager = $this->getObjectManager();
188		$result1 = $objectManager->getRepository($entityName)->createQueryBuilder('j')->select('j.workerName, j.method, j.status, count(j) as c')
189		->groupBy('j.workerName, j.method, j.status')->getQuery()->getArrayResult();
190
191		foreach ($result1 as $item) {
192		$method = $item['workerName'].'->'.$item['method'];
193		if (!isset($result[$method])) {
194		$result[$method] = [Job::STATUS_NEW => 0,
195		Job::STATUS_RUNNING => 0,
196		Job::STATUS_SUCCESS => 0,
197		Job::STATUS_ERROR => 0, ];
198		}
199		$result[$method][$item['status']] += intval($item['c']);
200		}
201		}
202
203		/**
204		* Get the next job to run (can be filtered by workername and method name).
205		*
206		* @param string $workerName
207		* @param string $methodName
208		* @param bool $prioritize
209		*
210		* @return \Dtc\QueueBundle\Model\Job\|null
211		*/
212		public function getJob($workerName = null, $methodName = null, $prioritize = true, $runId = null)
213		{
214		$uniqid = uniqid(gethostname().'-'.getmypid(), true);
215		$hash = hash('sha256', $uniqid);
216
217		/** @var EntityManager $objectManager */
218		$objectManager = $this->getObjectManager();
219
220		$objectManager->beginTransaction();
221
222		/** @var EntityRepository $repository */
223		$repository = $this->getRepository();
224		$qb = $repository->createQueryBuilder('j');
225		$dateTime = new \DateTime();
226		$qb
227		->select('j')
228		->where('j.status = :status')->setParameter(':status', Job::STATUS_NEW)
229		->andWhere('j.locked is NULL')
230		->andWhere($qb->expr()->orX(
231		$qb->expr()->isNull('j.whenAt'),
232		$qb->expr()->lte('j.whenAt', ':whenAt')
233		))
234		->andWhere($qb->expr()->orX(
235		$qb->expr()->isNull('j.expiresAt'),
236		$qb->expr()->gt('j.expiresAt', ':expiresAt')
237		))
238		->setParameter(':whenAt', $dateTime)
239		->setParameter(':expiresAt', $dateTime);
240
241		if ($workerName) {
		0 ignored issues – show Bug Best Practice introduced 2017-10-14 18:28 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...
242		$qb->andWhere('j.workerName = :workerName')
243		->setParameter(':workerName', $workerName);
244		}
245
246		if ($methodName) {
		0 ignored issues – show Bug Best Practice introduced 2017-10-14 18:28 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...
247		$qb->andWhere('j.method = :method')
248		->setParameter(':method', $methodName);
249		}
250
251		if ($prioritize) {
252		$qb->add('orderBy', 'j.priority ASC, j.whenAt ASC');
		0 ignored issues – show Documentation introduced 2017-10-14 18:28 UTC by Report Bug Copy Issue Report `'j.priority ASC, j.whenAt ASC'` is of type `string`, but the function expects a `object<Doctrine\ORM\Query\Expr\Base>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
253		} else {
254		$qb->orderBy('j.whenAt', 'ASC');
255		}
256		$qb->setMaxResults(1);
257
258		/** @var QueryBuilder $qb */
259		$query = $qb->getQuery();
260		$query->setLockMode(LockMode::PESSIMISTIC_WRITE);
261		$jobs = $query->getResult();
262
263		if ($jobs) {
264		/** @var Job $job */
265		$job = $jobs[0];
266		if (!$job) {
267		throw new \Exception("No job found for $hash, even though last result was count ".count($jobs));
268		}
269		$job->setLocked(true);
270		$job->setLockedAt(new \DateTime());
271		$job->setStatus(Job::STATUS_RUNNING);
272		$job->setRunId($runId);
273		$objectManager->commit();
274		$objectManager->flush();
275
276		return $job;
277		}
278
279		$objectManager->rollback();
280
281		return null;
282		}
283		}
284

mmucklo / DtcQueueBundle

Push — master ( 298fd3...56daff )

JobManager A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

9 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like