urbanindo/yii2-queue

Queue component for Yii2

Wednesday, June 20, 2018
by petrabarus
Repository
13 Watchers
111 Stars
25,217 Installations

PHP
1 Dependents
0 Suggesters
47 Forks
14 Open issues
18 Versions
3 % Grown

The README.md

Queue Component for Yii2

This provides queue component for Yii2., _(*1)

, _(*2)

Requirements

You need PCNT extension enabled to run listener, _(*3)

Installation

The preferred way to install this extension is through composer., _(*4)

Either run, _(*5)

php composer.phar require --prefer-dist urbanindo/yii2-queue "*"

or add, _(*6)

"urbanindo/yii2-queue": "*"

to the require section of your composer.json file., _(*7)

To use Redis queue or RabbitMQ, you have to add yiisoft/yii2-redis:* or videlalvaro/php-amqplib: 2.5.* respectively., _(*8)

Setting Up

After the installation, first step is to set the console controller., _(*9)

return [
    // ...
    'controllerMap' => [
        'queue' => [
            'class' => 'UrbanIndo\Yii2\Queue\Console\Controller',
            //'sleepTimeout' => 1
        ],
    ],
];

For the task worker, set a new module, e.g. task and declare it in the config., _(*10)

'modules' => [
    'task' => [
        'class' => 'app\modules\task\Module',
    ]
]

And then set the queue component. Don't forget to set the module name that runs the task in the component. For example, queue using AWS SQS, _(*11)

'components' => [
    'queue' => [
        'class' => 'UrbanIndo\Yii2\Queue\Queues\SqsQueue',
            'module' => 'task',
            'url' => 'https://sqs.ap-southeast-1.amazonaws.com/123456789012/queue',
            'config' => [
                'credentials' => [
                    'key' => 'AKIA1234567890123456',
                    'secret' => '1234567890123456789012345678901234567890'
                ],
                'region' => 'ap-southeast-1',
                'version' => 'latest'
            ]
        ]
    ]
]

Or using Database queue, _(*12)

'components' => [
    'db' => [
        // the db component
    ],
    'queue' => [
        'class' => 'UrbanIndo\Yii2\Queue\Queues\DbQueue',
        'db' => 'db',
        'tableName' => 'queue',
        'module' => 'task',
        // sleep for 10 seconds if there's no item in the queue (to save CPU)
        'waitSecondsIfNoQueue' => 10,
    ]
]

Usage

Creating A Worker

Creating a worker is just the same with creating console or web controller. In the task module create a controller that extends UrbanIndo\Yii2\Queue\Worker\Controller, _(*13)

e.g., _(*14)

class FooController extends UrbanIndo\Yii2\Queue\Worker\Controller
{
    public function actionBar($param1, $param2)
    {
        echo $param1;
    }
}

To prevent the job got deleted from the queue, for example when the job is not completed, return false in the action. The job will be run again the next chance., _(*15)

e.g., _(*16)

class FooController extends UrbanIndo\Yii2\Queue\Worker\Controller
{
    public function actionBar($param1, $param2)
    {
        try {
            // do some stuff
        } catch (\Exception $ex) {
            \Yii::error('Ouch something just happened');
            return false;
        }
    }
}

Running The Listener

To run the listener, run the console that set in the above config. If the controller mapped as queue then run., _(*17)

yii queue/listen

Posting A Job

To post a job from source code, put something like this., _(*18)

use UrbanIndo\Yii2\Queue\Job;

$route = 'foo/bar';
$data = ['param1' => 'foo', 'param2' => 'bar'];
Yii::$app->queue->post(new Job(['route' => $route, 'data' => $data]));

Job can also be posted from the console. The data in the second parameter is in JSON string., _(*19)

yii queue/post 'foo/bar' '{"param1": "foo", "param2": "bar"}'

Job can also be posted as anonymous function. Be careful using this., _(*20)

Yii::$app->queue->post(new Job(function() {
    echo 'Hello World!';
}));

Deferred Event

In this queue, there is a feature called Deferred Event. Basically using this feature, we can defer a process executed after a certain event using queue., _(*21)

To use this, add behavior in a component and implement the defined event handler., _(*22)

    public function behaviors()
    {
        return [
            [
                'class' => \UrbanIndo\Yii2\Queue\Behaviors\DeferredEventBehavior::class,
                'events' => [
                    self::EVENT_AFTER_VALIDATE => 'deferAfterValidate',
                ]
            ]
        ];
    }

    public function deferAfterValidate()
    {
        // do something here
    }

NOTE Due to reducing the message size, the $event object that usually passed when triggered the event will not be passed to the deferred event. Also, the object in which the method invoked is merely a clone object, so it won't have the behavior and the event attached in the original object., _(*23)

As for ActiveRecord class, since the object can not be passed due to limitation of SuperClosure in serializing PDO (I personally think that's bad too), the behavior should use \UrbanIndo\Yii2\Queue\Behaviors\ActiveRecordDeferredEventBehavior instead. The difference is in the object in which the deferred event handler invoked., _(*24)

Since we can not pass the original object, the invoking object will be re-fetched from the table using the primary key. And for the afterDelete event, since the respective row is not in the table anymore, the invoking object is a new object whose attributes are assigned from the attributes of the original object., _(*25)

Web End Point

We can use web endpoint to use the queue by adding \UrbanIndo\Yii2\Queue\Web\Controller to the controller map., _(*26)

For example, _(*27)

'controllerMap' => [
    'queue' => [
        /* @var $queue UrbanIndo\Yii2\Queue\Web\Controller */
        'class' => 'UrbanIndo\Yii2\Queue\Web\Controller'
    ]
],

To post this use, _(*28)

curl -XPOST http://example.com/queue/post --data route='test/test' --data data='{"data":"data"}'

To limit the access to the controller, we can use \yii\filters\AccessControl filter., _(*29)

For example to filter by IP address, we can use something like this., _(*30)

'controllerMap' => [
    'queue' => [
        /* @var $queue UrbanIndo\Yii2\Queue\Web\Controller */
        'class' => 'UrbanIndo\Yii2\Queue\Web\Controller',
        'as access' => [
            'class' => '\yii\filters\AccessControl',
            'rules' => [
                [
                    'allow' => true,
                    'ips' => [
                        '127.0.0.1'
                    ]
                ]
            ]
        ]
    ]
],

Testing

To run the tests, in the root directory execute below., _(*31)

./vendor/bin/phpunit

Road Map

Add more queue provider such as MemCache, IronMQ, RabbitMQ.

The Versions

20/06 2018

dev-master

9999999-dev

Queue component for Yii2

library yii2-queue