Scheduler\Worker\AbstractWorker

Complexity

Total Complexity

18

Size/Duplication

Total Lines	156
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
	getJobRunner()	0	1	?
	getScheduler()	0	1	?
A	run()	0	19	2
A	isRunning()	0	14	3
A	shutdown()	0	4	1
A	setMaxIterations()	0	7	2
A	getSeconds()	0	6	1
A	init()	0	14	3
A	hp ➔ pcntl_signal()	0	1	1
A	hp ➔ pcntl_signal_dispatch()	0	1	1
A	registerSigHandlers()	0	14	5
A	getMaxIterations()	0	4	1

<?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, <goodnickoff@gmail.com>
 */
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);

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?

It seems like $to defined by \DateTime::createFromFormat('U', time(), new \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?

            $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*/}};

It is generally recommended to explicitly declare the visibility for methods.

        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;
    }
}