├── .gitignore
├── src
    ├── Queue
    │   ├── Traits
    │   │   └── UniquelyQueueable.php
    │   ├── Connectors
    │   │   ├── RedisUniqueConnector.php
    │   │   └── HorizonUniqueConnector.php
    │   ├── HorizonUniqueQueue.php
    │   └── RedisUniqueQueue.php
    └── Providers
    │   ├── QueueServiceProvider.php
    │   └── LumenQueueServiceProvider.php
├── composer.json
└── readme.md


/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor
2 | /.idea
3 | /.vscode


--------------------------------------------------------------------------------
/src/Queue/Traits/UniquelyQueueable.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Mlntn\Queue\Traits;
 4 | 
 5 | trait UniquelyQueueable
 6 | {
 7 | 
 8 |     /**
 9 |      * Provides a unique identifier for existence check
10 |      * This should be implemented in each job
11 |      *
12 |      * @return string
13 |      */
14 |     abstract public function getUniqueIdentifier();
15 | 
16 | }


--------------------------------------------------------------------------------
/src/Queue/Connectors/RedisUniqueConnector.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Mlntn\Queue\Connectors;
 4 | 
 5 | use Illuminate\Support\Arr;
 6 | use Mlntn\Queue\RedisUniqueQueue;
 7 | use Illuminate\Queue\Connectors\RedisConnector;
 8 | 
 9 | class RedisUniqueConnector extends RedisConnector
10 | {
11 | 
12 |     /**
13 |      * Establish a queue connection.
14 |      *
15 |      * @param  array  $config
16 |      * @return \Illuminate\Contracts\Queue\Queue
17 |      */
18 |     public function connect(array $config)
19 |     {
20 |         return new RedisUniqueQueue(
21 |             $this->redis, $config['queue'],
22 |             $config['connection'] ?? $this->connection,
23 |             $config['retry_after'] ?? 60,
24 |             $config['block_for'] ?? null
25 |         );
26 |     }
27 | 
28 | }


--------------------------------------------------------------------------------
/src/Queue/Connectors/HorizonUniqueConnector.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Mlntn\Queue\Connectors;
 4 | 
 5 | use Illuminate\Support\Arr;
 6 | use Mlntn\Queue\HorizonUniqueQueue;
 7 | use Laravel\Horizon\Connectors\RedisConnector;
 8 | 
 9 | class HorizonUniqueConnector extends RedisConnector
10 | {
11 | 
12 |     /**
13 |      * Establish a queue connection.
14 |      *
15 |      * @param  array  $config
16 |      * @return \Illuminate\Contracts\Queue\Queue
17 |      */
18 |     public function connect(array $config)
19 |     {
20 |         return new HorizonUniqueQueue(
21 |             $this->redis, $config['queue'],
22 |             Arr::get($config, 'connection', $this->connection),
23 |             Arr::get($config, 'retry_after', 60),
24 |             Arr::get($config, 'block_for', null)
25 |         );
26 |     }
27 | 
28 | }


--------------------------------------------------------------------------------
/src/Providers/QueueServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Mlntn\Providers;
 4 | 
 5 | use Illuminate\Support\ServiceProvider;
 6 | use Mlntn\Queue\Connectors\RedisUniqueConnector;
 7 | use Mlntn\Queue\Connectors\HorizonUniqueConnector;
 8 | 
 9 | class QueueServiceProvider extends ServiceProvider
10 | {
11 | 
12 |     /**
13 |      * Register any application services.
14 |      *
15 |      * @return void
16 |      */
17 |     public function register()
18 |     {
19 |         $this->app->resolving('queue', function ($manager) {
20 |             $manager->addConnector('unique', function () {
21 |                 if (defined('HORIZON_PATH')) {
22 |                     return new HorizonUniqueConnector($this->app['redis']);
23 |                 }
24 | 
25 |                 return new RedisUniqueConnector($this->app['redis']);
26 |             });
27 |         });
28 |     }
29 | 
30 | }
31 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "mlntn/laravel-unique-queue",
 3 |     "type": "library",
 4 |     "description": "Laravel queue connection that prevents identical jobs from being queued",
 5 |     "keywords": ["laravel", "queue", "unique"],
 6 |     "homepage": "http://github.com/mlntn/laravel-unique-queue",
 7 |     "license": "MIT",
 8 |     "authors": [
 9 |         {
10 |             "name": "Jared Mellentine",
11 |             "email": "jared@mellentine.com"
12 |         }
13 |     ],
14 |     "minimum-stability": "stable",
15 | 
16 |     "require": {
17 |         "php": "~7.1",
18 |         "illuminate/queue": "~5.7||~6||~7||~8",
19 |         "illuminate/redis": "~5.7||~6||~7||~8"
20 |     },
21 |     "autoload": {
22 |         "classmap": ["src/"]
23 |     },
24 |     "extra": {
25 |         "laravel": {
26 |             "providers": [
27 |                 "Mlntn\\Providers\\QueueServiceProvider"
28 |             ]
29 |         }
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Providers/LumenQueueServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Mlntn\Providers;
 4 | 
 5 | use Mlntn\Queue\Connectors\RedisUniqueConnector;
 6 | use Illuminate\Queue\QueueManager;
 7 | use Illuminate\Support\ServiceProvider;
 8 | 
 9 | /**
10 |  * LumenQueueServiceProvider
11 |  *
12 |  * Lumen binds queue factory onto "queue" key, differently to Laravel.
13 |  * See Laravel\Lumen\Application::registerQueueBindings()
14 |  *
15 |  * @package Mlntn\Providers
16 |  */
17 | class LumenQueueServiceProvider extends ServiceProvider
18 | {
19 |     /**
20 |      * Register unique queuing using Mlntn\Queue\Connectors\RedisUniqueConnector
21 |      *
22 |      * @return void
23 |      */
24 |     public function register()
25 |     {
26 |         // Make sure $app['redis'] is available
27 |         $this->app->resolving('queue', function (QueueManager $manager) {
28 |             $manager->addConnector('unique', function () {
29 |                 return new RedisUniqueConnector($this->app['redis']);
30 |             });
31 |         });
32 |     }
33 | }


--------------------------------------------------------------------------------
/src/Queue/HorizonUniqueQueue.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Mlntn\Queue;
 4 | 
 5 | use Illuminate\Queue\LuaScripts;
 6 | use Illuminate\Queue\Jobs\RedisJob;
 7 | use Laravel\Horizon\RedisQueue;
 8 | 
 9 | class HorizonUniqueQueue extends RedisQueue
10 | {
11 | 
12 |     /**
13 |      * Push a raw payload onto the queue.
14 |      *
15 |      * @param  string  $payload
16 |      * @param  string  $queue
17 |      * @param  array   $options
18 |      * @return mixed
19 |      */
20 |     public function pushRaw($payload, $queue = null, array $options = [])
21 |     {
22 |         $connection = $this->getConnection();
23 | 
24 |         $tracker = $this->getTrackerName($queue);
25 | 
26 |         $data = json_decode($payload, true);
27 | 
28 |         $exists = $connection->hexists($tracker, $data['uniqueIdentifier']);
29 | 
30 |         if ($exists) {
31 |             return null;
32 |         }
33 | 
34 |         if (parent::pushRaw($payload, $queue, $options)) {
35 |             $connection->hset($tracker, $data['uniqueIdentifier'], $data['id']);
36 |         }
37 |     }
38 | 
39 |     /**
40 |      * Create a payload for an object-based queue handler.
41 |      *
42 |      * @param  mixed  $job
43 |      * @return array
44 |      */
45 |     protected function createObjectPayload($job,$queue)
46 |     {
47 |         return array_merge([
48 |             'uniqueIdentifier' => isset($job->class)
49 |                 ? (new $job->class)->getUniqueIdentifier()
50 |                 : $job->getUniqueIdentifier(),
51 |         ], parent::createObjectPayload($job,$queue));
52 |     }
53 | 
54 |     /**
55 |      * Delete a reserved job from the queue.
56 |      *
57 |      * @param  string  $queue
58 |      * @param  RedisJob  $job
59 |      * @return void
60 |      */
61 |     public function deleteReserved($queue, $job)
62 |     {
63 |         parent::deleteReserved($queue, $job);
64 | 
65 |         $data = json_decode($job->getRawBody(), true);
66 | 
67 |         $this->getConnection()->hdel($this->getTrackerName($queue), $data['uniqueIdentifier']);
68 |     }
69 | 
70 |     protected function getTrackerName($queue)
71 |     {
72 |         return $this->getQueue($queue).':tracker';
73 |     }
74 | 
75 | }
76 | 


--------------------------------------------------------------------------------
/src/Queue/RedisUniqueQueue.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Mlntn\Queue;
 4 | 
 5 | use Illuminate\Queue\LuaScripts;
 6 | use Illuminate\Queue\Jobs\RedisJob;
 7 | use Illuminate\Queue\RedisQueue;
 8 | 
 9 | class RedisUniqueQueue extends RedisQueue
10 | {
11 | 
12 |     /**
13 |      * Push a raw payload onto the queue.
14 |      *
15 |      * @param  string  $payload
16 |      * @param  string  $queue
17 |      * @param  array   $options
18 |      * @return mixed
19 |      */
20 |     public function pushRaw($payload, $queue = null, array $options = [])
21 |     {
22 |         $connection = $this->getConnection();
23 | 
24 |         $tracker = $this->getTrackerName($queue);
25 | 
26 |         $data = json_decode($payload, true);
27 | 
28 |         $exists = $connection->hexists($tracker, $data['uniqueIdentifier']);
29 | 
30 |         if ($exists) {
31 |             return null;
32 |         }
33 | 
34 |         if (parent::pushRaw($payload, $queue, $options)) {
35 |             $connection->hset($tracker, $data['uniqueIdentifier'], $data['id']);
36 |         }
37 |     }
38 | 
39 |     /**
40 |      * Create a payload for an object-based queue handler.
41 |      *
42 |      * @param  mixed  $job
43 |      * @return array
44 |      */
45 |     protected function createObjectPayload($job,$queue)
46 |     {
47 |         return array_merge([
48 |             'uniqueIdentifier' => isset($job->class)
49 |                 ? (new $job->class)->getUniqueIdentifier()
50 |                 : $job->getUniqueIdentifier(),
51 |         ], parent::createObjectPayload($job,$queue));
52 |     }
53 | 
54 |     /**
55 |      * Delete a reserved job from the queue.
56 |      *
57 |      * @param  string  $queue
58 |      * @param  RedisJob  $job
59 |      * @return void
60 |      */
61 |     public function deleteReserved($queue, $job)
62 |     {
63 |         parent::deleteReserved($queue, $job);
64 | 
65 |         $data = json_decode($job->getRawBody(), true);
66 | 
67 |         $this->getConnection()->hdel($this->getTrackerName($queue), $data['uniqueIdentifier']);
68 |     }
69 | 
70 |     protected function getTrackerName($queue)
71 |     {
72 |         return $this->getQueue($queue).':tracker';
73 |     }
74 | 
75 | }
76 | 


--------------------------------------------------------------------------------
/readme.md:
--------------------------------------------------------------------------------
  1 | :warning: **DEPRECATED**:
  2 | 
  3 | [Unique jobs have been implemented in laravel/framework](https://github.com/laravel/framework/releases/tag/v8.14.0). Please use the official implementation in Laravel 8.14.0 or higher. No further updates will be made to this repository and it will be archived in the future.
  4 | 
  5 | # Laravel Unique Queue
  6 | 
  7 | This redis queue driver works just like the standard Laravel redis queue driver, however, it prevents the same job from being queued multiple times.
  8 | 
  9 | ## Requirements
 10 | 
 11 | Needs PHP >= 7.1 to be installed.
 12 | 
 13 | Requires `illuminate/redis` and `illuminate/queue`, both `"~5.7"`, `"~6"` or `"~7"`
 14 | 
 15 | ## Installation
 16 | 
 17 | ### Require via Composer
 18 | ```
 19 | composer require mlntn/laravel-unique-queue
 20 | ```
 21 | 
 22 | 
 23 | ### Configure
 24 | Create a new connection in `config/queue.php`
 25 | 
 26 | ```
 27 | return [
 28 |     // ...
 29 |     'connections' => [
 30 |         'my_unique_queue_connection_name' => [
 31 |             'driver'      => 'unique',
 32 |             'connection'  => 'default',
 33 |             'queue'       => env('UNIQUE_QUEUE_NAME', 'my_unique_queue_name'),
 34 |             'retry_after' => 90,
 35 |         ],
 36 |         //...
 37 |     ]
 38 | ];
 39 | ```
 40 | 
 41 | ## Implementation
 42 | 
 43 | ### Implement a uniquely-queueable job
 44 | 
 45 | Your job should use the UniquelyQueueable trait and have the getUniqueIdentifier method:
 46 | 
 47 |     <?php
 48 | 
 49 |     namespace App\Jobs;
 50 | 
 51 |     use Illuminate\Bus\Queueable;
 52 |     use Illuminate\Queue\SerializesModels;
 53 |     use Illuminate\Queue\InteractsWithQueue;
 54 |     use Illuminate\Contracts\Queue\ShouldQueue;
 55 |     use Illuminate\Foundation\Bus\Dispatchable;
 56 |     use Mlntn\Queue\Traits\UniquelyQueueable;
 57 | 
 58 |     class MyUniqueJob implements ShouldQueue {
 59 | 
 60 |         use Dispatchable, InteractsWithQueue, Queueable, UniquelyQueueable, SerializesModels;
 61 | 
 62 |         /* ... */
 63 | 
 64 |         public function getUniqueIdentifier()
 65 |         {
 66 |             return 'some-unique-identifier';
 67 |         }
 68 | 
 69 |     }
 70 | 
 71 | If the connection is not the default, you will need to specify the connection when dispatching the job:
 72 | 
 73 |     dispatch(new UniqueJob)->onConnection('my_unique_queue_connection_name');
 74 | 
 75 | 
 76 | ### Implement a unique-queueable listener
 77 | 
 78 | Just like with a job the listener class should use the UniquelyQueueable trait and make sure you've set the connection and queue:
 79 | 
 80 |     <?php
 81 | 
 82 |     namespace App\Listeners;
 83 | 
 84 |     use Illuminate\Contracts\Queue\ShouldQueue;
 85 |     use Mlntn\Queue\Traits\UniquelyQueueable;
 86 | 
 87 |     class MyListener implements ShouldQueue {
 88 | 
 89 |         public $connection = 'my_unique_queue_connection_name';
 90 | 
 91 |         public $queue = 'my_unique_queue_name';
 92 | 
 93 |         public function handle($event)
 94 |         {
 95 |             //
 96 |         }
 97 | 
 98 |         public function getUniqueIdentifier()
 99 |         {
100 |             return 'some-unique-identifier';
101 |         }
102 |     }
103 | 
104 | ## Using Lumen
105 | Lumen handles binding slightly different. Use LumenQueueServiceProvider to enable unique queueing in Lumen.
106 | 
107 | Register service provider in `app.php`:
108 | ```
109 | $app->register(Mlntn\Providers\LumenQueueServiceProvider::class);
110 | ```
111 | 
112 | 
113 | ## Using Horizon
114 | 
115 | Set up a worker configuration:
116 | ```
117 |     'worker_name' => [
118 |         'connection' => 'my_unique_queue_connection_name',
119 |         'queue'      => ['default'],
120 |         'balance'    => 'auto',
121 |         'processes'  => 16,
122 |         'tries'      => 3,
123 |     ],
124 | ```
125 | 
126 | ## Run Queue Worker
127 | The unique queue behavior acts internally. Run queue worker as known using artisan (via cli, supervisor or another method).
128 | For more detailed information head over to https://github.com/illuminate/queue
129 | Specify the connection name used in `config/queue.php`
130 | 
131 | ```
132 | php artisan queue:work my_unique_queue_connection_name
133 | ```
134 | 


--------------------------------------------------------------------------------