tomzx\Job\Throttler

Complexity

Total Complexity

16

Size/Duplication

Total Lines	134
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	push()	0	6	1
A	pushAndStart()	0	6	1
B	wait()	0	14	5
A	getCompletedJobs()	0	4	1
A	onJobWaiting()	0	4	1
A	onJobRunning()	0	4	1
A	onJobCompleted()	0	4	1
A	tryStart()	0	18	3
A	runningJobsIsFull()	0	4	1

<?php

namespace tomzx\Job;

use Evenement\EventEmitter;

class Throttler
{
    /**
     * @var int
     */
    private $maxCount;
    /**
     * @var \tomzx\Job\JobQueue
     */
    private $waitingJobs;
    /**
     * @var \tomzx\Job\JobQueue
     */
    private $runningJobs;
    /**
     * @var \tomzx\Job\JobQueue
     */
    private $completedJobs;
    /**
     * @var \tomzx\Job\JobQueue
     */
    private $eventEmitter;

    /**
     * @param int $maxCount
     * @param int $resolutionMicroSeconds
     */
    public function __construct(int $maxCount, int $resolutionMicroSeconds = 100000)
    {
        $this->maxCount = $maxCount;
        $this->waitingJobs = new JobQueue();
        $this->runningJobs = new JobQueue();
        $this->completedJobs = new JobQueue();
        $this->eventEmitter = new EventEmitter();

It seems like new \Evenement\EventEmitter() of type object<Evenement\EventEmitter> is incompatible with the declared type object<tomzx\Job\JobQueue> of property $eventEmitter.

        $this->awaiter = new Awaiter($resolutionMicroSeconds);

The property awaiter does not exist. Did you maybe forget to declare it?

    }

    /**
     * @param \tomzx\Job\Job $job
     */
    public function push(Job $job)
    {
        $this->waitingJobs->push($job);

        $this->eventEmitter->emit('job.waiting', [$job]);

The method emit() does not seem to exist on object<tomzx\Job\JobQueue>.

    }

    /**
     * @param \tomzx\Job\Job $job
     */
    public function pushAndStart(Job $job)
    {
        $this->push($job);

        $this->tryStart();
    }

    public function wait()
    {
        while ( ! $this->runningJobs->isEmpty() || ! $this->waitingJobs->isEmpty()) {
            $this->tryStart();

            if ($this->runningJobsIsFull() || $this->waitingJobs->isEmpty()) {
                $completedJob = $this->awaiter->any($this->runningJobs);
                $this->runningJobs->remove($completedJob);
                $this->completedJobs->push($completedJob);

                $this->eventEmitter->emit('job.completed', [$completedJob]);

The method emit() does not seem to exist on object<tomzx\Job\JobQueue>.

            }
        }
    }

    /**
     * @return \tomzx\Job\JobQueue
     */
    public function getCompletedJobs()
    {
        return $this->completedJobs;
    }

    /**
     * @param callable $callback
     */
    public function onJobWaiting(callable $callback)
    {
        $this->eventEmitter->on('job.waiting', $callback);

The method on() does not seem to exist on object<tomzx\Job\JobQueue>.

    }

    /**
     * @param callable $callback
     */
    public function onJobRunning(callable $callback)
    {
        $this->eventEmitter->on('job.running', $callback);

The method on() does not seem to exist on object<tomzx\Job\JobQueue>.

    }

    /**
     * @param callable $callback
     */
    public function onJobCompleted(callable $callback)
    {
        $this->eventEmitter->on('job.completed', $callback);

The method on() does not seem to exist on object<tomzx\Job\JobQueue>.

    }

    /**
     * @return \tomzx\Job\Job|void
     */
    private function tryStart()
    {
        if ($this->waitingJobs->isEmpty()) {
            return;
        }

        if ($this->runningJobsIsFull()) {
            return;
        }

        $job = $this->waitingJobs->pop();
        $job->handle();
        $this->runningJobs->push($job);

It seems like $job defined by $this->waitingJobs->pop() on line 124 can be null; however, tomzx\Job\JobQueue::push() does not accept null, maybe add an additional type check?

        $this->eventEmitter->emit('job.running', [$job]);

The method emit() does not seem to exist on object<tomzx\Job\JobQueue>.

        return $job;
    }

    /**
     * @return bool
     */
    private function runningJobsIsFull()
    {
        return $this->runningJobs->count() >= $this->maxCount;
    }
}