feat: add RabbitMQHandler (#67)

* feat: RabbitMQ handler

* better cleanup with tests

* use AMQPConnectionConfig and AMQPConnectionFactory for connection handling

Author: michalsn

.github/workflows/phpunit.yml

@@ -117,6 +117,19 @@ jobs:
           --health-timeout=5s
           --health-retries=3
 
+      rabbitmq:
+        image: rabbitmq
+        env:
+          RABBITMQ_DEFAULT_USER: guest
+          RABBITMQ_DEFAULT_PASS: guest
+        ports:
+          - 5672
+        options: >-
+          --health-cmd="rabbitmq-diagnostics -q ping"
+          --health-interval=10s
+          --health-timeout=5s
+          --health-retries=5
+
     steps:
       - name: Free Disk Space (Ubuntu)
         uses: jlumbroso/free-disk-space@main

composer.json

@@ -19,7 +19,8 @@
         "codeigniter4/devkit": "^1.0",
         "codeigniter4/framework": "^4.3",
         "predis/predis": "^2.0",
-        "phpstan/phpstan-strict-rules": "^1.5"
+        "phpstan/phpstan-strict-rules": "^1.5",
+        "php-amqplib/php-amqplib": "^3.7"
     },
     "minimum-stability": "dev",
     "prefer-stable": true,
@@ -38,7 +39,8 @@
     },
     "suggest": {
         "ext-redis": "If you want to use RedisHandler",
-        "predis/predis": "If you want to use PredisHandler"
+        "predis/predis": "If you want to use PredisHandler",
+        "php-amqplib/php-amqplib": "If you want to use RabbitMQHandler"
     },
     "config": {
         "allow-plugins": {

docs/configuration.md

@@ -17,6 +17,7 @@ Available options:
 - [$database](#database)
 - [$redis](#redis)
 - [$predis](#predis)
+- [$rabbitmq](#rabbitmq)
 - [$keepDoneJobs](#keepdonejobs)
 - [$keepFailedJobs](#keepfailedjobs)
 - [$queueDefaultPriority](#queuedefaultpriority)
@@ -29,7 +30,7 @@ The default handler used by the library. Default value: `database`.
 
 ### $handlers
 
-An array of available handlers. By now only `database`, `redis` and `predis` handlers are implemented.
+An array of available handlers. Available handlers: `database`, `redis`, `predis`, and `rabbitmq`.
 
 ### $database
 
@@ -66,6 +67,16 @@ The configuration settings for `predis` handler. You need to have [Predis](https
 * `database` - The database number. Default value: `0`.
 * `prefix` - The default key prefix. Default value: `''` (not set).
 
+### $rabbitmq
+
+The configuration settings for `rabbitmq` handler. You need to have [php-amqplib](https://github.com/php-amqplib/php-amqplib) installed to use it.
+
+* `host` - The RabbitMQ server host. Default value: `127.0.0.1`.
+* `port` - The port number. Default value: `5672`.
+* `username` - The username for authentication. Default value: `guest`.
+* `password` - The password for authentication. Default value: `guest`.
+* `vhost` - The virtual host to use. Default value: `/`.
+
 ### $keepDoneJobs
 
 If the job is done, should we keep it in the table? Default value: `false`.

docs/index.md

@@ -35,6 +35,10 @@ If you use `Redis` (you still need a relational database to store failed jobs):
 - PHPRedis
 - Predis
 
+If you use `RabbitMQ` (you still need a relational database to store failed jobs):
+
+- php-amqplib
+
 ### Table of Contents
 
 * [Installation](installation.md)

phpstan.neon.dist

@@ -15,6 +15,7 @@ parameters:
 	        paths:
 	            - src/Handlers/RedisHandler.php
 	            - src/Handlers/PredisHandler.php
+	            - src/Handlers/RabbitMQHandler.php
 	    -
 	        message: '#Call to an undefined method CodeIgniter\\Queue\\Models\\QueueJobFailedModel::affectedRows\(\).#'
 	        paths:

src/Config/Queue.php

@@ -17,6 +17,7 @@
 use CodeIgniter\Queue\Exceptions\QueueException;
 use CodeIgniter\Queue\Handlers\DatabaseHandler;
 use CodeIgniter\Queue\Handlers\PredisHandler;
+use CodeIgniter\Queue\Handlers\RabbitMQHandler;
 use CodeIgniter\Queue\Handlers\RedisHandler;
 use CodeIgniter\Queue\Interfaces\JobInterface;
 use CodeIgniter\Queue\Interfaces\QueueInterface;
@@ -37,6 +38,7 @@ class Queue extends BaseConfig
         'database' => DatabaseHandler::class,
         'redis'    => RedisHandler::class,
         'predis'   => PredisHandler::class,
+        'rabbitmq' => RabbitMQHandler::class,
     ];
 
     /**
@@ -75,6 +77,17 @@ class Queue extends BaseConfig
         'prefix'   => '',
     ];
 
+    /**
+     * RabbitMQ handler config.
+     */
+    public array $rabbitmq = [
+        'host'     => '127.0.0.1',
+        'port'     => 5672,
+        'user'     => 'guest',
+        'password' => 'guest',
+        'vhost'    => '/',
+    ];
+
     /**
      * Whether to keep the DONE jobs in the queue.
      */

src/Exceptions/QueueException.php

@@ -56,4 +56,9 @@ public static function forIncorrectDelayValue(): static
     {
         return new self(lang('Queue.incorrectDelayValue'));
     }
+
+    public static function forFailedJsonEncode(string $error): static
+    {
+        return new self(lang('Queue.failedToJsonEncode', [$error]));
+    }
 }