voodoo-mobile/yii2-queue

Queue component for Yii2

Thursday, May 12, 2016
by voodoo-rocks
Repository
1 Watchers
0 Stars
2,027 Installations

PHP
0 Dependents
0 Suggesters
47 Forks
0 Open issues
12 Versions
0 % Grown

The README.md

Queue Component for Yii2

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

Installation

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

Either run, _(*3)

php composer.phar require --prefer-dist vm/yii2-queue "^1.4.0"

or add, _(*4)

"vm/yii2-queue": "^1.4.0"

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

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

Setting Up

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

return [
    // ...
    'controllerMap' => [
        'queue' => [
            'class' => 'vm\queue\Console\Controller',
            //'sleepTimeout' => 1
        ],

    ],
];

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

'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, _(*9)

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

Or using Database queue, _(*10)

'components' => [
    'db' => [
        //the db component
    ],
    'queue' => [
        'class' => 'vm\queue\Queues\DbQueue',
        'db' => 'db',
        'tableName' => 'queue',
        'module' => 'task',
    ]
]

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 vm\queue\Worker\Controller, _(*11)

e.g., _(*12)

class FooController extends vm\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., _(*13)

e.g., _(*14)

class FooController extends vm\queue\Worker\Controller {

    public function actionBar($param1, $param2){
        try {
        } 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., _(*15)

./yii queue/listen

Posting A Job

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

use vm\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., _(*17)

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

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

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., _(*19)

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

    public function behaviors() {
        return array_merge([
            [
                'class' => \vm\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., _(*21)

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 \vm\queue\Behaviors\ActiveRecordDeferredEventBehavior instead. The difference is in the object in which the deferred event handler invoked., _(*22)

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., _(*23)

Web End Point

We can use web endpoint to use the queue by adding \vm\queue\Web\Controller to the controller map., _(*24)

For example, _(*25)

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

To post this use, _(*26)

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., _(*27)

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

    'controllerMap' => [
        'queue' => [
            /* @var $queue vm\queue\Web\Controller */
            'class' => 'vm\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., _(*29)

./vendor/bin/phpunit

Road Map

Add more queue provider such as MemCache, IronMQ.

The Versions

12/05 2016

dev-master

9999999-dev

Queue component for Yii2

Sources Download

MIT

The Requires

php >=5.5.0
yiisoft/yii2 *
aws/aws-sdk-php >=2.4
symfony/process >=2.4
jeremeamia/superclosure ~2.0

The Development Requires

by Petra Barus

by Voodoo Mobile Ltd.

12/05 2016

1.4.1

1.4.1.0

Queue component for Yii2

Sources Download

MIT

The Requires

php >=5.5.0
yiisoft/yii2 *
aws/aws-sdk-php >=2.4
symfony/process >=2.4
jeremeamia/superclosure ~2.0

The Development Requires

by Petra Barus

by Voodoo Mobile Ltd.

12/05 2016

1.4.0

1.4.0.0

Queue component for Yii2

Sources Download

MIT

The Requires

php >=5.5.0
yiisoft/yii2 *
aws/aws-sdk-php >=2.4
symfony/process >=2.4
jeremeamia/superclosure ~2.0

php >=5.5.0
yiisoft/yii2 *
aws/aws-sdk-php >=2.4
symfony/process >=2.4
jeremeamia/superclosure ~2.0

by Petra Barus

08/04 2015

1.0.0

1.0.0.0

Queue component for Yii2

Sources Download

MIT

The Requires

php >=5.5.0
yiisoft/yii2 *
aws/aws-sdk-php >=2.4
symfony/process >=2.4
jeremeamia/superclosure ~2.0

library yii2-queue