feat: initial commit

Author: Steve Porter

.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+.phpunit.result.cache
+/.idea
+/.vscode
+/vendor
+composer.lock
+composer.phar
+Thumbs.db

.styleci.yml

@@ -0,0 +1,7 @@
+preset: laravel
+
+enabled:
+  - alpha_ordered_imports
+
+disabled:
+  - length_ordered_imports

CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+All notable changes to `laravel-horizon-rabbitmq` will be documented in this file
+
+## 0.1.0 - 2018-09-14
+- BETA release

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 DesignMyNight
+
+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.

composer.json

@@ -0,0 +1,37 @@
+{
+    "name": "designmynight/laravel-horizon-rabbitmq",
+    "description": "A package to support horizon with RabbitMQ",
+    "homepage": "https://github.com/designmynight/laravel-horizon-rabbitmq",
+    "license": "MIT",
+    "keywords": [
+        "laravel",
+        "laravel-horizon",
+        "laravel-horizon-rabbitmq",
+        "rabbitmq",
+        "designmynight"
+    ],
+    "require": {
+        "illuminate/support": "^5.6",
+        "laravel/horizon": "^1.4",
+        "vladimir-yuldashev/laravel-queue-rabbitmq": "7.1.*"
+    },
+    "autoload": {
+        "psr-4": {
+            "DesignMyNight\\Laravel\\Horizon\\": "src"
+        }
+    },
+    "authors": [
+        {
+            "name": "Steve Porter",
+            "email": "[email protected]",
+            "role": "Developer"
+        }
+    ],
+    "extra": {
+        "laravel": {
+            "providers": [
+                "DesignMyNight\\Laravel\\Horizon\\HorizonServiceProvider"
+            ]
+        }
+    }
+}

src/Connectors/RabbitMQConnector.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace DesignMyNight\Laravel\Horizon\Connectors;
+
+use DesignMyNight\Laravel\Horizon\RabbitMQQueue;
+use Enqueue\AmqpTools\DelayStrategyAware;
+use Enqueue\AmqpTools\RabbitMqDlxDelayStrategy;
+use Illuminate\Contracts\Events\Dispatcher;
+use Illuminate\Contracts\Queue\Queue;
+use Illuminate\Queue\Events\WorkerStopping;
+use Interop\Amqp\AmqpConnectionFactory as InteropAmqpConnectionFactory;
+use Interop\Amqp\AmqpConnectionFactory;
+use Interop\Amqp\AmqpContext;
+use VladimirYuldashev\LaravelQueueRabbitMQ\Queue\Connectors\RabbitMQConnector as BaseConnector;
+
+class RabbitMQConnector extends BaseConnector
+{
+    protected $dispatcher;
+
+    public function __construct(Dispatcher $dispatcher)
+    {
+        $this->dispatcher = $dispatcher;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function connect(array $config): Queue
+    {
+        if (false === array_key_exists('factory_class', $config)) {
+            throw new \LogicException('The factory_class option is missing though it is required.');
+        }
+
+        $factoryClass = $config['factory_class'];
+        if (false === class_exists($factoryClass) || false === (new \ReflectionClass($factoryClass))->implementsInterface(InteropAmqpConnectionFactory::class)) {
+            throw new \LogicException(sprintf('The factory_class option has to be valid class that implements "%s"', InteropAmqpConnectionFactory::class));
+        }
+
+        /** @var AmqpConnectionFactory $factory */
+        $factory = new $factoryClass([
+            'dsn' => $config['dsn'],
+            'host' => $config['host'],
+            'port' => $config['port'],
+            'user' => $config['login'],
+            'pass' => $config['password'],
+            'vhost' => $config['vhost'],
+            'ssl_on' => $config['ssl_params']['ssl_on'],
+            'ssl_verify' => $config['ssl_params']['verify_peer'],
+            'ssl_cacert' => $config['ssl_params']['cafile'],
+            'ssl_cert' => $config['ssl_params']['local_cert'],
+            'ssl_key' => $config['ssl_params']['local_key'],
+            'ssl_passphrase' => $config['ssl_params']['passphrase'],
+        ]);
+
+        if ($factory instanceof DelayStrategyAware) {
+            $factory->setDelayStrategy(new RabbitMqDlxDelayStrategy());
+        }
+
+        /** @var AmqpContext $context */
+        $context = $factory->createContext();
+
+        $this->dispatcher->listen(WorkerStopping::class, function () use ($context) {
+            $context->close();
+        });
+
+        return new RabbitMQQueue($context, $config);
+    }
+}

src/HorizonServiceProvider.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace DesignMyNight\Laravel\Horizon;
+
+use DesignMyNight\Laravel\Horizon\Connectors\RabbitMQConnector;
+use Illuminate\Contracts\Events\Dispatcher;
+use Illuminate\Support\ServiceProvider;
+
+class HorizonServiceProvider extends ServiceProvider
+{
+    /**
+     * All of the Horizon event / listener mappings.
+     *
+     * @var array
+     */
+    protected $events = [
+        \Illuminate\Queue\Events\JobFailed::class => [
+            Listeners\MarshalFailedEvent::class,
+        ],
+    ];
+
+    /**
+     * Register the Horizon job events.
+     *
+     * @return void
+     */
+    protected function registerEvents()
+    {
+        $events = $this->app->make(Dispatcher::class);
+
+        foreach ($this->events as $event => $listeners) {
+            foreach ($listeners as $listener) {
+                $events->listen($event, $listener);
+            }
+        }
+    }
+
+    /**
+     * Register the custom queue connectors for Horizon.
+     *
+     * @return void
+     */
+    protected function registerQueueConnectors()
+    {
+        $queue = $this->app['queue'];
+
+        $queue->addConnector('rabbitmq', function () {
+            return new RabbitMQConnector($this->app['events']);
+        });
+    }
+
+    /**
+     * Register any application services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        $this->registerEvents();
+        $this->registerQueueConnectors();
+    }
+}

src/Jobs/RabbitMQJob.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace DesignMyNight\Laravel\Horizon\Jobs;
+
+use VladimirYuldashev\LaravelQueueRabbitMQ\Queue\Jobs\RabbitMQJob as BaseJob;
+
+class RabbitMQJob extends BaseJob
+{
+    /**
+     * @inheritDoc
+     */
+    public function delete()
+    {
+        parent::delete();
+
+        $this->connection->deleteReserved($this->queue, $this);
+    }
+}

src/Listeners/MarshalFailedEvent.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace DesignMyNight\Laravel\Horizon\Listeners;
+
+use Illuminate\Contracts\Events\Dispatcher;
+use Illuminate\Queue\Events\JobFailed as LaravelJobFailed;
+use Laravel\Horizon\Events\JobFailed;
+
+class MarshalFailedEvent
+{
+    /**
+     * The event dispatcher implementation.
+     *
+     * @var \Illuminate\Contracts\Events\Dispatcher
+     */
+    public $events;
+
+    /**
+     * Create a new listener instance.
+     *
+     * @param  \Illuminate\Contracts\Events\Dispatcher  $events
+     * @return void
+     */
+    public function __construct(Dispatcher $events)
+    {
+        $this->events = $events;
+    }
+
+    /**
+     * Handle the event.
+     *
+     * @param  \Illuminate\Queue\Events\JobFailed  $event
+     * @return void
+     */
+    public function handle(LaravelJobFailed $event)
+    {
+        $this->events->dispatch((new JobFailed(
+            $event->exception, $event->job, $event->job->getRawBody()
+        ))->connection($event->connectionName)->queue($event->job->getQueue()));
+    }
+}

src/README.md

@@ -0,0 +1,55 @@
+Laravel Horizon RabbitMQ
+===============
+
+[![Latest Stable Version](http://img.shields.io/github/release/designmynight/laravel-horizon-rabbitmq.svg)](https://packagist.org/packages/designmynight/laravel-horizon-rabbitmq) [![Total Downloads](http://img.shields.io/packagist/dm/designmynight/laravel-horizon-rabbitmq.svg)](https://packagist.org/packages/designmynight/laravel-horizon-rabbitmq)
+[![StyleCI](https://github.styleci.io/repos/147424037/shield?branch=master)](https://github.styleci.io/repos/147424037)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+A service provider to add support for a [RabbitMQ](https://github.com/vyuldashev/laravel-queue-rabbitmq) queue driver to [Laravel Horizon](https://github.com/laravel/horizon).
+
+Table of contents
+-----------------
+* [Installation](#installation)
+* [Configuration](#configuration)
+
+Installation
+------------
+
+Installation using composer:
+
+```sh
+composer require designmynight/laravel-horizon-rabbitmq
+```
+
+### Laravel version Compatibility
+
+ Laravel  | Package |
+:---------|:--------|
+ 5.6.x    | 0.1.x   |
+
+And add the service provider in `config/app.php`:
+
+```php
+DesignMyNight\Laravel\Horizon\HorizonServiceProvider::class,
+```
+
+Configuration
+------------
+
+Be sure to set the connection of your supervisor queue to `rabbitmq` in `config/horizon.php`:
+
+```php
+'environments' => [
+        'production' => [
+            'supervisor-1' => [
+                'connection' => 'rabbitmq',
+                'queue' => ['default'],
+                'balance' => 'simple',
+                'processes' => 8,
+                'tries' => 3,
+            ],
+        ],
+```
+
+
+The service provider will overide the default laravel horizon redis queue and redis job classes with a RabbitMQ implentation in order to trigger the necessary events for horizon to function correctly.