https://github.com/mxl/laravel-queue-rate-limit

Simple Laravel queue rate limiting
https://github.com/mxl/laravel-queue-rate-limit

laravel laravel-framework php php-library queue rate-limiting

Last synced: 27 days ago
JSON representation

Simple Laravel queue rate limiting

• Host: GitHub
• URL: https://github.com/mxl/laravel-queue-rate-limit
• Owner: mxl
• License: mit
• Created: 2019-08-02T08:03:58.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-09-21T06:50:18.000Z (about 2 months ago)
• Last Synced: 2024-09-28T19:22:57.957Z (about 1 month ago)
• Topics: laravel, laravel-framework, php, php-library, queue, rate-limiting
• Language: PHP
• Size: 22.5 KB
• Stars: 92
• Watchers: 7
• Forks: 19
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# laravel-queue-rate-limit

[![Current version](https://img.shields.io/packagist/v/mxl/laravel-queue-rate-limit.svg?logo=composer)](https://packagist.org/packages/mxl/laravel-queue-rate-limit)

[![Monthly Downloads](https://img.shields.io/packagist/dm/mxl/laravel-queue-rate-limit.svg)](https://packagist.org/packages/mxl/laravel-queue-rate-limit/stats)

[![Total Downloads](https://img.shields.io/packagist/dt/mxl/laravel-queue-rate-limit.svg)](https://packagist.org/packages/mxl/laravel-queue-rate-limit/stats)

[![Build Status](https://travis-ci.org/mxl/laravel-queue-rate-limit.svg?branch=master)](https://travis-ci.org/mxl/laravel-queue-rate-limit)

Simple Laravel queue rate limiting

## Installation

3.* versions are compatible only with Laravel 7+.

```bash

$ composer require mxl/laravel-queue-rate-limit

```

For Laravel 6 use 2.* versions:

```bash

$ composer require mxl/laravel-queue-rate-limit "^2.0"

```

For Laravel 5 use 1.* versions:

```bash

$ composer require mxl/laravel-queue-rate-limit "^1.0"

```

Laravel 5.5+ will use the [auto-discovery](https://medium.com/@taylorotwell/package-auto-discovery-in-laravel-5-5-ea9e3ab20518) feature to add `MichaelLedin\LaravelQueueRateLimit\QueueServiceProvider::class` to providers.

This package is not compatible with older Laravel versions.

Add rate limits to `config/queue.php`:

```php

'rateLimits' => [

     'mail' => [ // queue name

        'allows' => 1, // 1 job

        'every' => 5 // per 5 seconds

     ]

]

```

## Usage

Make sure that you don't use `sync` connection when queueing jobs. See `default` property in `config/queue.php`.

Run queue worker:

```bash

$ php artisan queue:work --queue default,mail

```

Then push several jobs to `default` and `mail` queues:

```php

Mail::queue(..., 'mail');

Mail::queue(..., 'mail');

Mail::queue(..., 'mail');

Mail::queue(..., 'default');

Mail::queue(..., 'default');

```

You'll see that only `mail` queue jobs will be rate limited while `default` queue jobs will run normally.

## Disable logging

Extend `QueueServiceProvider`:

```php

app->singleton('queue.logger', function () {

            return null;

        });

    }

}

```

Add it to `providers` array in `config/app.php`:

```php

 [

        // Laravel Framework Service Providers

        // ...

        // Application Service Providers

        // ...

        App\Providers\QueueServiceProvider::class,

        // ...

    ]

];

```

## Maintainers

- [@mxl](https://github.com/mxl)

## Other useful Laravel packages from the author

- [mxl/laravel-api-key](https://github.com/mxl/laravel-api-key) - API Key Authorization for Laravel with replay attack prevention;

- [mxl/laravel-job](https://github.com/mxl/laravel-job) - dispatch a job from command line and more;

## License

See the [LICENSE](https://github.com/mxl/laravel-queue-rate-limit/blob/master/LICENSE) file for details.