DoormanRunner::setDefaultRules() - Code Metrics - symbiote/silverstripe-queuedjobs - Measure and Improve Code Quality continuously with Scrutinizer

DoormanRunner::setDefaultRules() A
last analyzed 2019-12-18 20:39 UTC

↳ Parent: DoormanRunner

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	5
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

namespace Symbiote\QueuedJobs\Tasks\Engines;

use AsyncPHP\Doorman\Manager\ProcessManager;
use SilverStripe\Core\Environment;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\ORM\FieldType\DBDatetime;
use Symbiote\QueuedJobs\DataObjects\QueuedJobDescriptor;
use Symbiote\QueuedJobs\Jobs\DoormanQueuedJobTask;
use Symbiote\QueuedJobs\Services\QueuedJob;
use Symbiote\QueuedJobs\Services\QueuedJobService;

/**
 * Runs all jobs through the doorman engine
 */
class DoormanRunner extends BaseRunner implements TaskRunnerEngine
{
    /**
     * @var string[]
     */
    protected $defaultRules = [];

    /**
     * Assign default rules for this task
     *
     * @param array $rules
     * @return $this
     */
    public function setDefaultRules($rules)
    {
        $this->defaultRules = $rules;
        return $this;
    }

    /**
     * @return array List of rules
     */
    public function getDefaultRules()
    {
        return $this->defaultRules;
    }

    /**
     * Run tasks on the given queue
     *
     * @param string $queue
     */
    public function runQueue($queue)
    {
        // check if queue can be processed
        $service = QueuedJobService::singleton();
        if ($service->isAtMaxJobs()) {
            $service->getLogger()->info('Not processing queue as jobs are at max initialisation limit.');
            return;
        }

        // split jobs out into multiple tasks...

        /** @var ProcessManager $manager */
        $manager = Injector::inst()->create(ProcessManager::class);
        $manager->setWorker(
            BASE_PATH . "/vendor/silverstripe/framework/cli-script.php dev/tasks/ProcessJobQueueChildTask"
        );
        $logPath = Environment::getEnv('SS_DOORMAN_LOGPATH');

        if ($logPath) {
            $manager->setLogPath($logPath);
        }

        // Assign default rules
        $defaultRules = $this->getDefaultRules();
        if ($defaultRules) {

            foreach ($defaultRules as $rule) {
                $manager->addRule($rule);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            }
        }

        $descriptor = $this->getNextJobDescriptorWithoutMutex($queue);

        while ($manager->tick() || $descriptor) {
            if (QueuedJobService::singleton()->isMaintenanceLockActive()) {
                $service->getLogger()->info('Skipped queued job descriptor since maintenance log is active.');
                return;
            }

            $this->logDescriptorStatus($descriptor, $queue);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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

            if ($descriptor instanceof QueuedJobDescriptor) {
                $descriptor->JobStatus = QueuedJob::STATUS_INIT;
                $descriptor->write();

                $manager->addTask(new DoormanQueuedJobTask($descriptor));
            }

            sleep(1);

            $descriptor = $this->getNextJobDescriptorWithoutMutex($queue);
        }
    }

    /**
     * @param string $queue
     * @return null|QueuedJobDescriptor
     */
    protected function getNextJobDescriptorWithoutMutex($queue)
    {
        $list = QueuedJobDescriptor::get()
            ->filter('JobType', $queue)
            ->sort('ID', 'ASC');

        $descriptor = $list
            ->filter('JobStatus', QueuedJob::STATUS_WAIT)
            ->first();

        if ($descriptor) {
            return $descriptor;
        }

        return $list
            ->filter('JobStatus', QueuedJob::STATUS_NEW)
            ->where(sprintf(
                '"StartAfter" < \'%s\' OR "StartAfter" IS NULL',
                DBDatetime::now()->getValue()
            ))
            ->first();
    }
}


1			<?php
2
3			namespace Symbiote\QueuedJobs\Tasks\Engines;
4
5			use AsyncPHP\Doorman\Manager\ProcessManager;
6			use SilverStripe\Core\Environment;
7			use SilverStripe\Core\Injector\Injector;
8			use SilverStripe\ORM\FieldType\DBDatetime;
9			use Symbiote\QueuedJobs\DataObjects\QueuedJobDescriptor;
10			use Symbiote\QueuedJobs\Jobs\DoormanQueuedJobTask;
11			use Symbiote\QueuedJobs\Services\QueuedJob;
12			use Symbiote\QueuedJobs\Services\QueuedJobService;
13
14			/**
15			* Runs all jobs through the doorman engine
16			*/
17			class DoormanRunner extends BaseRunner implements TaskRunnerEngine
18			{
19			/**
20			* @var string[]
21			*/
22			protected $defaultRules = [];
23
24			/**
25			* Assign default rules for this task
26			*
27			* @param array $rules
28			* @return $this
29			*/
30			public function setDefaultRules($rules)
31			{
32			$this->defaultRules = $rules;
33			return $this;
34			}
35
36			/**
37			* @return array List of rules
38			*/
39			public function getDefaultRules()
40			{
41			return $this->defaultRules;
42			}
43
44			/**
45			* Run tasks on the given queue
46			*
47			* @param string $queue
48			*/
49			public function runQueue($queue)
50			{
51			// check if queue can be processed
52			$service = QueuedJobService::singleton();
53			if ($service->isAtMaxJobs()) {
54			$service->getLogger()->info('Not processing queue as jobs are at max initialisation limit.');
55			return;
56			}
57
58			// split jobs out into multiple tasks...
59
60			/** @var ProcessManager $manager */
61			$manager = Injector::inst()->create(ProcessManager::class);
62			$manager->setWorker(
63			BASE_PATH . "/vendor/silverstripe/framework/cli-script.php dev/tasks/ProcessJobQueueChildTask"
64			);
65			$logPath = Environment::getEnv('SS_DOORMAN_LOGPATH');
			0 ignored issues – show Bug introduced 2018-04-05 02:40 UTC by Report Bug Copy Issue Report The method `getEnv()` does not seem to exist on `object<SilverStripe\Core\Environment>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
66			if ($logPath) {
67			$manager->setLogPath($logPath);
68			}
69
70			// Assign default rules
71			$defaultRules = $this->getDefaultRules();
72			if ($defaultRules) {
			0 ignored issues – show Bug Best Practice introduced 2018-09-26 03:06 UTC by Report Bug Copy Issue Report The expression `$defaultRules` of type `string[]` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
73			foreach ($defaultRules as $rule) {
74			$manager->addRule($rule);
			0 ignored issues – show Documentation introduced 2018-09-26 03:06 UTC by Report Bug Copy Issue Report `$rule` is of type `string`, but the function expects a `object<AsyncPHP\Doorman\Rule>`. 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...
75			}
76			}
77
78			$descriptor = $this->getNextJobDescriptorWithoutMutex($queue);
79
80			while ($manager->tick() \|\| $descriptor) {
81			if (QueuedJobService::singleton()->isMaintenanceLockActive()) {
82			$service->getLogger()->info('Skipped queued job descriptor since maintenance log is active.');
83			return;
84			}
85
86			$this->logDescriptorStatus($descriptor, $queue);
			0 ignored issues – show Bug introduced 2017-10-04 23:47 UTC by Report Bug Copy Issue Report It seems like `$descriptor` can also be of type `object<SilverStripe\ORM\DataObject>`; however, `Symbiote\QueuedJobs\Task...::logDescriptorStatus()` does only seem to accept `boolean\|null\|object<Symb...ts\QueuedJobDescriptor>`, 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...
87
88			if ($descriptor instanceof QueuedJobDescriptor) {
89			$descriptor->JobStatus = QueuedJob::STATUS_INIT;
90			$descriptor->write();
91
92			$manager->addTask(new DoormanQueuedJobTask($descriptor));
93			}
94
95			sleep(1);
96
97			$descriptor = $this->getNextJobDescriptorWithoutMutex($queue);
98			}
99			}
100
101			/**
102			* @param string $queue
103			* @return null\|QueuedJobDescriptor
104			*/
105			protected function getNextJobDescriptorWithoutMutex($queue)
106			{
107			$list = QueuedJobDescriptor::get()
108			->filter('JobType', $queue)
109			->sort('ID', 'ASC');
110
111			$descriptor = $list
112			->filter('JobStatus', QueuedJob::STATUS_WAIT)
113			->first();
114
115			if ($descriptor) {
116			return $descriptor;
117			}
118
119			return $list
120			->filter('JobStatus', QueuedJob::STATUS_NEW)
121			->where(sprintf(
122			'"StartAfter" < \'%s\' OR "StartAfter" IS NULL',
123			DBDatetime::now()->getValue()
124			))
125			->first();
126			}
127			}
128

symbiote / silverstripe-queuedjobs

GitHub Access Token became invalid

DoormanRunner::setDefaultRules() A last analyzed 2019-12-18 20:39 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

DoormanRunner::setDefaultRules() A
last analyzed 2019-12-18 20:39 UTC