AbstractWorker::getMaxIterations() - Code Metrics - Inspection of "fix coverage issues" - hutnikau/job-scheduler - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/support_parallel_worke... ( fceac2...357018 )

by Aleh

created 2018-07-30 06:24 UTC

AbstractWorker::getMaxIterations() A

↳ Parent: AbstractWorker

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
dl	0
loc	4
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0
nc	1
nop	0

<?php

namespace Scheduler\Worker;

use DateInterval;
use DateTime;
use Scheduler\Exception\SchedulerException;
use Scheduler\JobRunner\JobRunnerInterface;
use Scheduler\SchedulerInterface;

/**
 * Class AbstractWorker
 * @package Scheduler\Worker
 * @author Aleh Hutnikau, <[email protected]>
 */
abstract class AbstractWorker implements WorkerInterface
{
    const DEFAULT_ITERATION_INTERVAL = 'PT60S';

    /** @var DateTime */
    private $from;

    /** @var DateInterval */
    private $interval;

    /** @var bool */
    private $shutdown = false;

    /** @var integer */
    private $iteration = 0;

    /** @var integer */
    private $maxIterations = 1000;

    /**
     * @param integer $startTime
     * @param string $interval
     * @return mixed|string
     * @throws SchedulerException
     */
    public function run($startTime, $interval)
    {
        $this->init($startTime, $interval);
        $jobRunner = $this->getJobRunner();

        $from = clone($this->from);
        $oneSecondInterval = new \DateInterval('PT1S');

        while ($this->isRunning()) {
            $to = DateTime::createFromFormat('U', time(), new \DateTimeZone('UTC'));
            $jobRunner->run($this->getScheduler(), $from, $to, true);
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}
            $from = clone($to);
            $from->add($oneSecondInterval);
            sleep($this->getSeconds($this->interval));
            $this->iteration++;
        }

        return 'Shut down scheduler worker';
    }

    /**
     * @return JobRunnerInterface
     */
    abstract protected function getJobRunner();

    /**
     * @return SchedulerInterface
     */
    abstract protected function getScheduler();

    /**
     * @return bool
     */
    public function isRunning()
    {
        pcntl_signal_dispatch();

        if ($this->iteration >= $this->getMaxIterations()) {
            $this->shutdown();
        }

        if ($this->shutdown) {
            return false;
        }

        return true;
    }

    /**
     * Set marker to shutdown after finishing current iteration
     */
    public function shutdown()
    {
        $this->shutdown = true;
    }

    /**
     * @param $iterations
     * @throws SchedulerException
     * @return mixed|void
     */
    public function setMaxIterations($iterations)
    {
        if (!is_integer($iterations)) {
            throw new SchedulerException('$iterations parameter must be integer');
        }
        $this->maxIterations = $iterations;
    }

    /**
     * Get amount of seconds in date interval
     *
     * @param DateInterval $interval
     * @return int
     * @throws \Exception
     */
    private function getSeconds(DateInterval $interval)
    {
        $date = new \DateTimeImmutable('now', new \DateTimeZone('UTC'));
        $date2 = $date->add($interval);
        return $date2->getTimestamp() - $date->getTimestamp();
    }

    /**
     * @param integer $startTime
     * @param string $interval
     * @throws
     */
    private function init($startTime, $interval)
    {
        if (!is_numeric($startTime)) {
            throw new SchedulerException('Start time parameter must be numeric');
        }
        $this->from = new DateTime('@' . $startTime, new \DateTimeZone('UTC'));

        $this->interval = new \DateInterval(self::DEFAULT_ITERATION_INTERVAL);
        if ($interval !== null) {
            $this->interval = new \DateInterval($interval);
        }

        $this->registerSigHandlers();
    }

    /**
     * Register signal handlers that a worker should respond to.
     *
     * TERM/INT/QUIT: Shutdown after the current job is finished then exit.
     */
    private function registerSigHandlers()
    {
        if (!function_exists('pcntl_signal')) {function pcntl_signal() {/*do nothing*/}};
        if (!function_exists('pcntl_signal_dispatch')) {function pcntl_signal_dispatch() {/*do nothing*/}};

        if (!defined('SIGTERM')) {define('SIGTERM', 15);};
        if (!defined('SIGINT')) {define('SIGINT', 2);};
        if (!defined('SIGQUIT')) {define('SIGQUIT', 3);};

        declare(ticks = 1);

        pcntl_signal(SIGTERM, [$this, 'shutdown']);
        pcntl_signal(SIGINT, [$this, 'shutdown']);
        pcntl_signal(SIGQUIT, [$this, 'shutdown']);
    }

    /**
     * @return integer
     */
    public function getMaxIterations()
    {
        return $this->maxIterations;
    }
}

1		<?php
2
3		namespace Scheduler\Worker;
4
5		use DateInterval;
6		use DateTime;
7		use Scheduler\Exception\SchedulerException;
8		use Scheduler\JobRunner\JobRunnerInterface;
9		use Scheduler\SchedulerInterface;
10
11		/**
12		* Class AbstractWorker
13		* @package Scheduler\Worker
14		* @author Aleh Hutnikau, <[email protected]>
15		*/
16		abstract class AbstractWorker implements WorkerInterface
17		{
18		const DEFAULT_ITERATION_INTERVAL = 'PT60S';
19
20		/** @var DateTime */
21		private $from;
22
23		/** @var DateInterval */
24		private $interval;
25
26		/** @var bool */
27		private $shutdown = false;
28
29		/** @var integer */
30		private $iteration = 0;
31
32		/** @var integer */
33		private $maxIterations = 1000;
34
35		/**
36		* @param integer $startTime
37		* @param string $interval
38		* @return mixed\|string
39		* @throws SchedulerException
40		*/
41	2	public function run($startTime, $interval)
42		{
43	2	$this->init($startTime, $interval);
44	1	$jobRunner = $this->getJobRunner();
45
46	1	$from = clone($this->from);
47	1	$oneSecondInterval = new \DateInterval('PT1S');
48
49	1	while ($this->isRunning()) {
50	1	$to = DateTime::createFromFormat('U', time(), new \DateTimeZone('UTC'));
51	1	$jobRunner->run($this->getScheduler(), $from, $to, true);
		0 ignored issues – show Security Bug introduced 2018-07-27 10:47 UTC by Report Bug Copy Issue Report It seems like `$from` defined by `clone $to` on line `52` can also be of type `false`; however, `Scheduler\JobRunner\JobRunnerInterface::run()` does only seem to accept `object<DateTimeInterface>`, did you maybe forget to handle an error condition? This check looks for type mismatches where the missing type is `false`. This is usually indicative of an error condtion. Consider the follow example <?php function getDate($date) { if ($date !== null) { return new DateTime($date); } return false; } This function either returns a new `DateTime` object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned `false` before passing on the value to another function or method that may not be able to handle a `false`. Loading history... Security Bug introduced 2018-07-27 10:47 UTC by Report Bug Copy Issue Report It seems like `$to` defined by `\DateTime::createFromFor...w \DateTimeZone('UTC'))` on line `50` can also be of type `false`; however, `Scheduler\JobRunner\JobRunnerInterface::run()` does only seem to accept `null\|object<DateTimeInterface>`, did you maybe forget to handle an error condition? This check looks for type mismatches where the missing type is `false`. This is usually indicative of an error condtion. Consider the follow example <?php function getDate($date) { if ($date !== null) { return new DateTime($date); } return false; } This function either returns a new `DateTime` object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned `false` before passing on the value to another function or method that may not be able to handle a `false`. Loading history...
52	1	$from = clone($to);
53	1	$from->add($oneSecondInterval);
54	1	sleep($this->getSeconds($this->interval));
55	1	$this->iteration++;
56		}
57
58	1	return 'Shut down scheduler worker';
59		}
60
61		/**
62		* @return JobRunnerInterface
63		*/
64		abstract protected function getJobRunner();
65
66		/**
67		* @return SchedulerInterface
68		*/
69		abstract protected function getScheduler();
70
71		/**
72		* @return bool
73		*/
74	1	public function isRunning()
75		{
76	1	pcntl_signal_dispatch();
77
78	1	if ($this->iteration >= $this->getMaxIterations()) {
79	1	$this->shutdown();
80		}
81
82	1	if ($this->shutdown) {
83	1	return false;
84		}
85
86	1	return true;
87		}
88
89		/**
90		* Set marker to shutdown after finishing current iteration
91		*/
92	1	public function shutdown()
93		{
94	1	$this->shutdown = true;
95	1	}
96
97		/**
98		* @param $iterations
99		* @throws SchedulerException
100		* @return mixed\|void
101		*/
102	2	public function setMaxIterations($iterations)
103		{
104	2	if (!is_integer($iterations)) {
105	1	throw new SchedulerException('$iterations parameter must be integer');
106		}
107	1	$this->maxIterations = $iterations;
108	1	}
109
110		/**
111		* Get amount of seconds in date interval
112		*
113		* @param DateInterval $interval
114		* @return int
115		* @throws \Exception
116		*/
117	1	private function getSeconds(DateInterval $interval)
118		{
119	1	$date = new \DateTimeImmutable('now', new \DateTimeZone('UTC'));
120	1	$date2 = $date->add($interval);
121	1	return $date2->getTimestamp() - $date->getTimestamp();
122		}
123
124		/**
125		* @param integer $startTime
126		* @param string $interval
127		* @throws
128		*/
129	2	private function init($startTime, $interval)
130		{
131	2	if (!is_numeric($startTime)) {
132	1	throw new SchedulerException('Start time parameter must be numeric');
133		}
134	1	$this->from = new DateTime('@' . $startTime, new \DateTimeZone('UTC'));
135
136	1	$this->interval = new \DateInterval(self::DEFAULT_ITERATION_INTERVAL);
137	1	if ($interval !== null) {
138	1	$this->interval = new \DateInterval($interval);
139		}
140
141	1	$this->registerSigHandlers();
142	1	}
143
144		/**
145		* Register signal handlers that a worker should respond to.
146		*
147		* TERM/INT/QUIT: Shutdown after the current job is finished then exit.
148		*/
149		private function registerSigHandlers()
150		{
151		if (!function_exists('pcntl_signal')) {function pcntl_signal() {/do nothing/}};
152		if (!function_exists('pcntl_signal_dispatch')) {function pcntl_signal_dispatch() {/do nothing/}};
		0 ignored issues – show Best Practice introduced 2018-07-30 06:26 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
153	1	if (!defined('SIGTERM')) {define('SIGTERM', 15);};
154	1	if (!defined('SIGINT')) {define('SIGINT', 2);};
155	1	if (!defined('SIGQUIT')) {define('SIGQUIT', 3);};
156
157		declare(ticks = 1);
158
159	1	pcntl_signal(SIGTERM, [$this, 'shutdown']);
160	1	pcntl_signal(SIGINT, [$this, 'shutdown']);
161	1	pcntl_signal(SIGQUIT, [$this, 'shutdown']);
162	1	}
163
164		/**
165		* @return integer
166		*/
167	1	public function getMaxIterations()
168		{
169	1	return $this->maxIterations;
170		}
171		}

hutnikau / job-scheduler

GitHub Access Token became invalid

Push — feature/support_parallel_worke... ( fceac2...357018 )

AbstractWorker::getMaxIterations() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like