BrainExe\Core\MessageQueue\Gateway

Complexity

Total Complexity

21

Size/Duplication

Total Lines	169
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getEventsByType()	0	4	1
A	deleteEvent()	0	21	4
A	addEvent()	0	9	1
A	addJob()	0	18	2
A	getEventsByTypeGenerator()	0	21	4
A	restoreJob()	0	8	1
A	countAllJobs()	0	7	1
A	getFromTimesQueue()	0	11	3
A	getFromImmediateQueue()	0	12	4

<?php

namespace BrainExe\Core\MessageQueue;

use BrainExe\Annotations\Annotations\Service;
use BrainExe\Core\EventDispatcher\AbstractEvent;
use BrainExe\Core\Traits\IdGeneratorTrait;
use BrainExe\Core\Traits\RedisTrait;
use BrainExe\Core\Traits\TimeTrait;
use Generator;

/**
 * @api
 * @Service("MessageQueue.Gateway", public=false)
 */
class Gateway
{

    use TimeTrait;
    use RedisTrait;
    use IdGeneratorTrait;

    const QUEUE_DELAYED   = 'message_queue:delayed';
    const QUEUE_IMMEDIATE = 'message_queue:immediate';
    const META_DATA       = 'message_queue:meta_data';
    const RETRY_TIME      = 3600; // try again after 1 hour

    /**
     * @param string $eventId
     * @param string $eventType
     * @return bool success
     */
    public function deleteEvent(string $eventId, string $eventType = null) : bool
    {
        $eventId = sprintf('%s:%s', $eventType, $eventId);

        $redis = $this->getRedis();
        $delayed = $redis->zrem(self::QUEUE_DELAYED, $eventId);
        if ($delayed) {
            $redis->hdel(self::META_DATA, [$eventId]);
            return true;
        }

        $immediate = $this->getRedis()->lrange(self::QUEUE_IMMEDIATE, 0, 100);
        foreach ($immediate as $rawJob) {
            list($jobId) = explode('#', $rawJob, 2);
            if (strpos($jobId, "$eventId") === 0) {

As per coding-style, please use concatenation or sprintf for the variable $eventId instead of interpolation.

                return (bool)$this->redis->lrem(self::QUEUE_IMMEDIATE, 1, $rawJob);
            }
        }

        return false;
    }

    /**
     * @param AbstractEvent $event
     * @param int $timestamp
     * @return string
     */
    public function addEvent(AbstractEvent $event, int $timestamp = 0)
    {
        $jobId = $this->generateUniqueId('jobid:' . $event->getEventName());
        $jobId = sprintf('%s:%s', $event->getEventName(), $jobId);

        $job = new Job($event, $jobId, $timestamp);

        $this->addJob($job);
    }

    /**
     * @param Job $job
     */
    public function addJob(Job $job)
    {
        $serialized = base64_encode(serialize($job));

        $pipeline = $this->getRedis()->pipeline(['fire-and-forget' => true]);
        if (empty($job->timestamp)) {
            // immediate execution in background
            $pipeline->lpush(self::QUEUE_IMMEDIATE, $job->jobId . '#' . $serialized);
        } else {
            // delayed execution
            $pipeline->hset(self::META_DATA, $job->jobId, $serialized);
            $pipeline->zadd(self::QUEUE_DELAYED, [
                $job->jobId => (int)$job->timestamp
            ]);
        }

        $pipeline->execute();
    }

    /**
     * @param string $eventType
     * @param int $since
     * @return Job[]
     */
    public function getEventsByType(string $eventType = null, int $since = 0) : array
    {
        return iterator_to_array($this->getEventsByTypeGenerator($eventType, $since));
    }

    /**
     * @param string $eventType
     * @param int $since
     * @return Generator|Job[]
     */
    public function getEventsByTypeGenerator(string $eventType = null, int $since = 0) : Generator
    {
        $redis = $this->getRedis();

        $resultRaw = $redis->zrangebyscore(
            self::QUEUE_DELAYED,
            $since,
            '+inf',
            ['withscores' => true]
        );

        $keys = [];
        foreach ($resultRaw as $jobId => $timestamp) {
            if (empty($eventType) || strpos($jobId, $eventType . ":") === 0) {

The string literal : does not require double quotes, as per coding-style, please use single quotes.

                $keys[$jobId] = $timestamp;
            }
        }

        yield from $this->getFromTimesQueue($keys);
        yield from $this->getFromImmediateQueue($eventType);
    }

    /**
     * @param Job $job
     */
    public function restoreJob(Job $job)
    {
        $now = $this->now();

        $job->timestamp = $now + self::RETRY_TIME;
        $job->errorCounter++;
        $this->addJob($job);
    }

    /**
     * @return int
     */
    public function countAllJobs() : int
    {
        $delayed   = $this->getRedis()->zcard(self::QUEUE_DELAYED);
        $immediate = $this->getRedis()->llen(self::QUEUE_IMMEDIATE);

        return $delayed + $immediate;
    }

    /**
     * @param array $keys
     * @return Generator
     */
    private function getFromTimesQueue(array $keys) : Generator
    {
        if (!empty($keys)) {
            $events = $this->getRedis()->hmget(self::META_DATA, array_keys($keys));
            foreach ($events as $jobId => $rawJob) {
                /** @var Job $job */
                $job = unserialize(base64_decode($rawJob));
                yield $job->jobId => $job;
            }
        }
    }

    /**
     * @param string $eventType
     * @return Generator
     */
    private function getFromImmediateQueue(string $eventType = null) : Generator
    {
        $immediate = $this->getRedis()->lrange(self::QUEUE_IMMEDIATE, 0, 100);
        foreach ($immediate as $rawJob) {
            list($jobId, $rawJob) = explode('#', $rawJob, 2);
            if (empty($eventType) || strpos($jobId, $eventType . ":") === 0) {

The string literal : does not require double quotes, as per coding-style, please use single quotes.

                /** @var Job $job */
                $job = unserialize(base64_decode($rawJob));
                yield $job->jobId => $job;
            }
        }
    }
}