https://github.com/mcfedr/periodic-queue-driver-bundle

A driver for Queue Manager Bundle that uses runs jobs periodically.
https://github.com/mcfedr/periodic-queue-driver-bundle

Last synced: about 2 months ago
JSON representation

A driver for Queue Manager Bundle that uses runs jobs periodically.

• Host: GitHub
• URL: https://github.com/mcfedr/periodic-queue-driver-bundle
• Owner: mcfedr
• License: mit
• Created: 2017-02-13T18:01:13.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-10-11T06:51:00.000Z (about 6 years ago)
• Last Synced: 2024-10-11T13:13:33.601Z (3 months ago)
• Language: PHP
• Size: 104 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Periodic Queue Driver Bundle

A driver for [Queue Manager Bundle](https://github.com/mcfedr/queue-manager-bundle) that uses runs jobs periodically.

This driver doesn't run jobs, it requires another driver to actually process jobs.

[![Latest Stable Version](https://poser.pugx.org/mcfedr/periodic-queue-driver-bundle/v/stable.png)](https://packagist.org/packages/mcfedr/periodic-queue-driver-bundle)

[![License](https://poser.pugx.org/mcfedr/periodic-queue-driver-bundle/license.png)](https://packagist.org/packages/mcfedr/periodic-queue-driver-bundle)

[![Build Status](https://travis-ci.org/mcfedr/periodic-queue-driver-bundle.svg?branch=master)](https://travis-ci.org/mcfedr/periodic-queue-driver-bundle)

## Usage

There is no runner daemon for this driver as it just plugs into other drivers. Use it by

`put`ting jobs into this driver with the `period` option.

## Install

### Composer

    composer require mcfedr/periodic-queue-driver-bundle

### AppKernel

Include the bundle in your AppKernel

    public function registerBundles()

    {

        $bundles = [

            ...

            new Mcfedr\QueueManagerBundle\McfedrQueueManagerBundle(),

            new Mcfedr\PeriodicQueueDriverBundle\McfedrPeriodicQueueDriverBundle(),

## Config

With this bundle installed you can setup your queue manager config similar to this:

    mcfedr_queue_manager:

        managers:

            periodic:

                driver: periodic

                options:

                    default_manager: delay

                    default_manager_options: []

This will create a `QueueManager` service named `"mcfedr_queue_manager.periodic"`

* `default_manager` - Default job processor, must support delayed jobs, for example [Doctrine Delay](https://packagist.org/packages/mcfedr/doctrine-delay-queue-driver-bundle)

* `default_manager_options` - Default options to pass to job processor `put`

## Options to `QueueManager::put`

* `period` - The average number of seconds between job runs

* `manager` - Use a different job processor for this job

* `manager_options` - Options to pass to the processors `put` method

## Explanation

### Commands

There are two commands that can be used to investigate how well spread jobs will. A simple way to visualize is to

pipe into [feedgnuplot](https://github.com/dkogan/feedgnuplot).

`rand-add` uses a naive implementation of just adding a random number of seconds to get the time for the next run:

    ./tests/console test:distribution:rand-add -v | feedgnuplot --histogram 0 --binwidth 60 --hardcopy "rand-add.png" --exit

    

![Graph of rand-add](rand-add.png)

`periodic` uses the bundle implementation:

    ./tests/console test:distribution:periodic -v | feedgnuplot --histogram 0 --binwidth 60 --hardcopy "periodic.png" --exit

![Graph of periodic](periodic.png)

## Job Token

There is job_tokens argument which can help with job uniqueness.

Usage example

When put new periodic job, you get PeriodicJob object.

        $periodicJob = $this->manager->put('some_service', [

            'some_argument' => 'some_value',

        ], [

            'period' => 'some_seconds',

        ], 'periodic');

        

You can do $periodicJob->getToken() of it and store the token for job execution

While execution

     public function execute(array $arguments)

        {

            // Get the stored token

            ...

    

            if ($storedToken != $arguments['job_tokens']['token']) {

                throw new InvalidTokenException();

            }

            

            ...

            

            $storedToken = ($arguments['job_tokens']['next_token']);

            // Save stored token for next execition.

        }

        

Each job execution new token is generated so if some job duplication will appear only one will be executed and other jobs will fail