v1.0.0

Update docs

Author: mxl

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+
+[*.json]
+indent_size = 4
+
+[*.md]
+trim_trailing_whitespace = false
+indent_size = 2

.gitignore

@@ -0,0 +1,4 @@
+/vendor
+composer.lock
+.DS_Store
+/.idea

.travis.yml

@@ -0,0 +1,13 @@
+language: php
+
+php:
+  - 7.0
+  - 7.1
+  - 7.2
+  - 7.3
+
+before_script:
+  - travis_retry composer self-update
+  - travis_retry composer install --prefer-source --no-interaction --dev
+
+script: ./vendor/phpunit/phpunit/phpunit

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Michael Ledin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,2 +1,54 @@
 # laravel-queue-rate-limit
 Simple Laravel queue rate limiting
+
+## Installation
+```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.
+
+## Maintainers
+
+- [@mxl](https://github.com/mxl)
+
+## License
+
+See the [LICENSE](https://github.com/mxl/laravel-queue-rate-limit/blob/master/LICENSE) file for details.
+
+

composer.json

@@ -0,0 +1,46 @@
+{
+    "name": "mxl/laravel-queue-rate-limit",
+    "description": "Simple Laravel queue rate limiting",
+    "keywords": [
+        "queue",
+        "rate",
+        "limit",
+        "laravel"
+    ],
+    "license": "MIT",
+    "homepage": "https://github.com/mxl/laravel-queue-rate-limit",
+    "support": {
+        "issues": "https://github.com/mxl/laravel-queue-rate-limit/issues",
+        "source": "https://github.com/mxl/laravel-queue-rate-limit"
+    },
+    "type": "library",
+    "require": {
+        "php": ">=7.0",
+        "illuminate/queue": "^5.5",
+        "illuminate/contracts": "^5.5",
+        "illuminate/cache": "^5.5",
+        "illuminate/log": "^5.5"
+    },
+    "authors": [
+        {
+            "name": "Michael Ledin",
+            "email": "mledin89@gmail.com"
+        }
+    ],
+    "autoload": {
+        "psr-4": {
+            "MichaelLedin\\LaravelQueueRateLimit\\": "src/"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "MichaelLedin\\LaravelQueueRateLimit\\QueueServiceProvider"
+            ]
+        }
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^7.5"
+    },
+    "minimum-stability": "stable"
+}

phpunit.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false"
+>
+    <testsuites>
+        <testsuite name="Package Test Suite">
+            <directory suffix=".php">./tests/</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>

src/QueueServiceProvider.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace MichaelLedin\LaravelQueueRateLimit;
+
+use Illuminate\Cache\RateLimiter;
+use Illuminate\Contracts\Debug\ExceptionHandler;
+use Illuminate\Log\LogManager;
+
+class QueueServiceProvider extends \Illuminate\Queue\QueueServiceProvider
+{
+    protected function registerWorker()
+    {
+        $this->app->singleton('queue.worker', function () {
+            return new Worker(
+                $this->app['queue'], $this->app['events'], $this->app[ExceptionHandler::class],
+                $this->app['config']->get('queue.rateLimits'), $this->app[RateLimiter::class], $this->app[LogManager::class]
+            );
+        });
+    }
+}

src/Worker.php

@@ -0,0 +1,85 @@
+<?php
+
+namespace MichaelLedin\LaravelQueueRateLimit;
+
+use Illuminate\Cache\RateLimiter;
+use Illuminate\Contracts\Debug\ExceptionHandler;
+use Illuminate\Contracts\Events\Dispatcher;
+use Illuminate\Log\LogManager;
+use Illuminate\Queue\QueueManager;
+
+class Worker extends \Illuminate\Queue\Worker
+{
+    /**
+     * @var array
+     */
+    private $rateLimits;
+
+    /**
+     * @var RateLimiter
+     */
+    private $rateLimiter;
+
+    /**
+     * @var LogManager
+     */
+    private $logger;
+
+    /**
+     * @inheritDoc
+     * @param array|null $rateLimits
+     * @param RateLimiter $rateLimiter
+     * @param LogManager $logger
+     */
+    public function __construct(QueueManager $manager, Dispatcher $events, ExceptionHandler $exceptions, $rateLimits, $rateLimiter, $logger)
+    {
+        parent::__construct($manager, $events, $exceptions);
+
+        $this->rateLimits = $rateLimits ?? [];
+        $this->rateLimiter = $rateLimiter;
+        $this->logger = $logger;
+    }
+
+    protected function getNextJob($connection, $queue)
+    {
+        $job = null;
+        foreach (explode(',', $queue) as $queue) {
+            $rateLimit = $this->rateLimits[$queue] ?? null;
+            if ($rateLimit) {
+                if (!isset($rateLimit['allows']) || !isset($rateLimit['every'])) {
+                    throw new \RuntimeException('Set "allows" and "every" fields for "' . $queue . '" rate limit.');
+                }
+                $this->log('Rate limit is set for queue ' . $queue);
+                if ($this->rateLimiter->tooManyAttempts($queue, $rateLimit['allows'])) {
+                    $availableIn = $this->rateLimiter->availableIn($queue);
+                    $this->log('Rate limit is reached for queue ' . $queue . '. Next job will be started in ' . $availableIn . ' seconds');
+                    continue;
+                } else {
+                    $this->log('Rate limit check is passed for queue ' . $queue);
+                }
+            } else {
+                $this->log('No rate limit is set for queue ' . $queue . '.');
+            }
+
+            $job = parent::getNextJob($connection, $queue);
+            if ($job) {
+                if ($rateLimit) {
+                    $this->rateLimiter->hit($queue, $rateLimit['every']);
+                }
+                $this->log('Running job ' . $job->getJobId() . ' on queue ' . $queue);
+                break;
+            } else {
+                $this->log('No available jobs on queue ' . $queue);
+            }
+        }
+        return $job;
+    }
+
+
+    private function log(string $message)
+    {
+        if ($this->logger) {
+            $this->logger->debug($message);
+        }
+    }
+}