Use Laravel Horizon as a queue supervisor (#753)

* feat(queue): manage queue using laravel/horizon package

* chore: only export prometheus metrics from backend pods

* chore: source horizon config from env

* fix: composer.lock is out of sync

* fix: install fails on platform reqs

* chore: only run horizon when explicitly enabled

* chore: scope down ignore arg

* docs: add CHANGELOG

Author: m90

.github/workflows/composer.test.yml

@@ -24,6 +24,7 @@ jobs:
       with:
         php_version: 8.2
         command: install
+        args: --ignore-platform-req=ext-pcntl
 
     - name: Copy example .env file
       run: cp .env.example .env

CHANGELOG.md

@@ -1,5 +1,8 @@
 # api
 
+## 10x.1.0 - 14 March 2024
+- Use Laravel Horizon to supervise queue workers if enabled T342866
+
 ## 10x.0.0 - 26 February 2024
 - Update Laravel to v10.10 - T341797
   - schedule redis stale tag pruning

Dockerfile

@@ -4,21 +4,24 @@ COPY ./composer.json /tmp/src1/composer.json
 COPY ./composer.lock /tmp/src1/composer.lock
 
 WORKDIR /tmp/src1
-RUN composer install --no-dev --no-progress --no-autoloader
+RUN composer install --no-dev --no-progress --no-autoloader --ignore-platform-req=ext-pcntl
 
 COPY ./ /tmp/src2
 RUN cp -r /tmp/src1/vendor /tmp/src2/vendor
 WORKDIR /tmp/src2
-RUN composer install --no-dev --no-progress --optimize-autoloader
+RUN composer install --no-dev --no-progress --optimize-autoloader --ignore-platform-req=ext-pcntl
 
 
 FROM php:8.2-apache
 
 RUN apt-get update \
 	# Needed for the imagick php extension install
-	&& apt-get install -y --no-install-recommends libmagickwand-dev \
+	&& apt-get install -y --no-install-recommends libmagickwand-dev libpq-dev \
 	&& echo "" | pecl install imagick \
 	&& docker-php-ext-enable imagick \
+	&& docker-php-ext-configure pcntl --enable-pcntl \
+	&& docker-php-ext-install pcntl \
+	&& docker-php-ext-enable pcntl \
 	# Obviously needed for mysql connection
 	&& docker-php-ext-install pdo pdo_mysql \
 	# For rewrite rules

app/Providers/HorizonServiceProvider.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace App\Providers;
+
+use Illuminate\Support\Facades\Gate;
+use Laravel\Horizon\Horizon;
+use Laravel\Horizon\HorizonApplicationServiceProvider;
+
+class HorizonServiceProvider extends HorizonApplicationServiceProvider
+{
+    /**
+     * Bootstrap any application services.
+     */
+    public function boot(): void
+    {
+        parent::boot();
+
+        // Horizon::routeSmsNotificationsTo('15556667777');
+        // Horizon::routeMailNotificationsTo('[email protected]');
+        // Horizon::routeSlackNotificationsTo('slack-webhook-url', '#channel');
+    }
+
+    /**
+     * Register the Horizon gate.
+     *
+     * This gate determines who can access Horizon in non-local environments.
+     */
+    protected function gate(): void
+    {
+        Gate::define('viewHorizon', function ($user) {
+            return in_array($user->email, [
+                //
+            ]);
+        });
+    }
+}

composer.json

@@ -18,11 +18,13 @@
         "hackzilla/password-generator": "^1.6",
         "intervention/image": "^2.5",
         "laravel/framework": "^10.10",
+        "laravel/horizon": "^5.23",
         "laravel/passport": "^11.0",
         "laravel/tinker": "^2.8",
         "laravel/ui": "^4.4",
         "lcobucci/jwt": "^4.1",
         "league/flysystem-aws-s3-v3": "^3.22",
+        "lkaemmerling/laravel-horizon-prometheus-exporter": "^1.7",
         "maclof/kubernetes-client": "^0.29.0",
         "mxl/laravel-job": "^1.5",
         "percymamedy/laravel-dev-booter": "^4.0",