AL 2023 Updates and Support up to Laravel 11.x

- increased Laravel version constraint to 11
- dropped support for Laravel 5
- updated Readme
- updated supervisor deploy script to work on Amazon Linux 2023

Author: MbahDjoe

README.md

@@ -1,8 +1,8 @@
-# Laravel 5 - 9.x Queue Worker for Elastic Beanstalk
+# Laravel 6 - 11.x Queue Worker for Elastic Beanstalk
 
 *Use your Laravel application as a worker to consume queues on AWS Elasticbeanstalk*
 
-Laravel provides a [wonderful array](https://laravel.com/docs/5.1/queues) of drivers for consuming queues within your application as well as [some documentation](https://laravel.com/docs/5.1/queues#supervisor-configuration) on how to manage your application with [Supervisord](http://supervisord.org/) when it is acting as a worker.
+Laravel provides a [wonderful array](https://laravel.com/docs/11.x/queues) of drivers for consuming queues within your application as well as [some documentation](https://laravel.com/docs/11.x/queues#supervisor-configuration) on how to manage your application with [Supervisord](http://supervisord.org/) when it is acting as a worker.
 
 Unfortunately that's where the documentation ends. There is no guidance on how to manage multiple workers from a devops context which is a huge bummer. But don't worry fam I've got your covered.
 
@@ -16,11 +16,11 @@ Unfortunately that's where the documentation ends. There is no guidance on how t
   * **Parsing of EB environmental variables to generate supervisor config**
   * **Or using a pre-built supervisor config supplied in project**
 
-## Amazon Linux 1 deprecation
+## Amazon Linux 1 is deprecated and Amazon Linux 2023 is recommended
 
-Amazon Linux 1 (AL1) is going to be unsupported soon, it is advised to migrate to use Amazon Linux 2 (AL2)
+Amazon Linux 1 (AL1) is already retired, even Amazon Linux 2 (AL2) will soon going to be unsupported too, so it's recommended to migrate to use Amazon Linux 2023 (AL2023)
 https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features.migration-al.html
-Starts from this release will only support AL2, please use previous releases for use in AL1
+Starts from this release will only support AL2023, please use previous releases for use in AL2, with this release will also drop support for Laravel 5 (PHP 7) since EB only support starting from PHP 8.1
 
 # Let's get down to business
 
@@ -32,21 +32,15 @@ Require this package
 composer require "foxxmd/laravel-elasticbeanstalk-queue-worker"
 ```
 
-or for Amazon Linux 1,
+or for Amazon Linux 2,
 
 ```bash
-composer require "foxxmd/laravel-elasticbeanstalk-queue-worker@^0.3"
+composer require "foxxmd/laravel-elasticbeanstalk-queue-worker@^1.0"
 ```
 
 **After installing the package you can either:**
 
-Add the ServiceProvider to the providers array in `config/app.php` (for Laravel 5.4 or lower)
-
-```php
-FoxxMD\LaravelElasticBeanstalkQueueWorker\ElasticBeanstalkQueueWorkerProvider::class
-```
-
-Then, publish using artisan
+Publish using artisan
 
 ```php
 php artisan vendor:publish --tag=ebworker
@@ -58,7 +52,7 @@ Copy everything from `src/.ebextensions` into your own `.ebextensions` folder an
 
 **Note:** This library only consists of the EB deploy steps -- the provider is only for a convenience -- so if you want to you can modify/consolidate the `.ebextensions` / `.platform` folder if you're not into me overwriting your stuff.
 
-Don't forget to add +x permission to the EB Platform Hooks scripts
+Don't forget to add +x permission to the EB Platform Hooks scripts ([no longer required for Amazon Linux platform that released on or after April 29, 2022](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-linux-extend.hooks.html#platforms-linux-extend.hooks.more))
 
 ```bash
 find .platform -type f -iname "*.sh" -exec chmod +x {} +
@@ -79,13 +73,7 @@ IS_WORKER = true
 
 ### Set Queue Driver / Connection
 
-Set the [driver](https://laravel.com/docs/5.1/queues#introduction) in your your EB environmental variables:
-
-```bash
-QUEUE_DRIVER = [driver]
-```
-
-Since Laravel 5.7 the variable name got changed so will also support the new name:
+Set the [driver](https://laravel.com/docs/11.x/queues#driver-prerequisites) in your your EB environmental variables:
 
 ```bash
 QUEUE_CONNECTION = [driver]
@@ -98,15 +86,15 @@ All queues are configured using EB environmental variables with the following sy
 **Note**: brackets are placeholders only, do not use them in your actual configuration
 
 ```bash
-queue[QueueName]     = [queueName]   # Required. The name of the queue that should be run.
+queue[QueueName]     = [driver]   # Required. The name of the queue that should be run. Value is driver/connection name
 [QueueName]NumProcs  = [value]       # Optional. The number of instances supervisor should run for this queue. Defaults to 1
 [QueueName]Tries     = [value]       # Optional. The number of times the worker should attempt to run in the event an unexpected exit code occurs. Defaults to 5
 [QueueName]Sleep     = [value]       # Optional. The number of seconds the worker should sleep if no new jobs are in the queue. Defaults to 5
 [QueueName]StartSecs = [value]       # Optional. How long a job should run for to be considered successful. Defaults to 1
 [QueueName]Delay     = [value]       # Optional. Time in seconds a job should be delayed before returning to the ready queue. Defaults to 0
 ```
 
-Add one `queue[QueueName] = [queueName]` entry in your EB environmental variables for each queue you want to run. The rest of the parameters are optional.
+Add one `queue[QueueName] = [driver]` entry in your EB environmental variables for each queue you want to run. The rest of the parameters are optional.
 
 That's it! On your next deploy supervisor will have its configuration updated/generated and start chugging along on your queues.
 
@@ -158,11 +146,11 @@ Otherwise `parseConfig.php` looks for a json file generated earlier that contain
 
 ```bash
 [program:$queue]
-command=php artisan queue:work $connection --queue=$queue --tries=$tries --sleep=$sleep --daemon
+process_name=%(program_name)s_%(process_num)02d
+command=php artisan queue:work $connection --queue=$queue --tries=$tries --sleep=$sleep --delay=$delay --daemon
 directory=/var/app/current/
 autostart=true
 autorestart=true
-process_name=$queue-%(process_num)s
 numprocs=$numProcs
 startsecs=$startSecs
 user=webapp
@@ -173,16 +161,16 @@ After parsing all queues it then appends the programs to a clean `supervisord.co
 
 ### 3. Deploy Supervisor
 
-Now a bash script `workerDeploy.sh` checks for `IS_WORKER=TRUE` in the EB environmental variables:
+Now a bash script `02worker-deploy.sh` checks for `IS_WORKER=TRUE` in the EB environmental variables:
 
-* If none is found the script does nothing and exists.
+* If none is found the script does nothing and exits.
 * If it is found
-  * And there is no `init.d` script
-    * Supervisor is installed using pip and the custom `supervisord` init script in this project is copied to `/etc/init.d`
+  * And there is no `supervisord.conf`
+    * Supervisor is installed using pip
     * Configuration is parsed
-    * Supervisor is started
     * Supervisor is set to start at boot
-  * And there is an `init.d` script
+    * Supervisor is started
+  * And there is an `supervisord.conf`
     * Supervisor is stopped
     * Configuration is parsed
     * Laravel artisan is used to restart the queue to refresh the daemon

composer.json

@@ -11,8 +11,8 @@
         }
     ],
     "require": {
-        "illuminate/console": "5 - 9",
-        "illuminate/support": "5 - 9"
+        "illuminate/console": "6 - 11",
+        "illuminate/support": "6 - 11"
     },
     "autoload": {
         "psr-4": {

src/.platform/confighooks/postdeploy/02worker-deploy.sh

@@ -3,27 +3,27 @@
 #
 # Description: For use with AWS elasticbeanstalk and Laravel. As part of a deployment will either skip, install,
 #              or update supervisord depending on environmental variables set in EB.
-#              This script has been modified as necessary to support Amazon Linux 2
+#              This script has been modified as necessary to support Amazon Linux 2023
 
 updateSupervisor(){
     cp .platform/queue-worker/supervisord.conf /etc/supervisord.conf
-    sudo service supervisord stop
+    systemctl stop supervisord
     php /var/app/current/artisan queue:restart # If this worker is running in daemon mode (most likely) we need to restart it with the new build
     echo "Sleeping a few seconds to make sure supervisor shuts down..." # https://github.com/Supervisor/supervisor/issues/48#issuecomment-2684400
     sleep 5
-    sudo service supervisord start
+    systemctl start supervisord
 }
 
 installSupervisor(){
-    easy_install supervisor
-    cp /var/app/current/.platform/queue-worker/supervisord /etc/init.d/supervisord
-    chmod 777 /etc/init.d/supervisord
-    mkdir -m 766 /var/log/supervisor
-    umask 022
-    touch /var/log/supervisor/supervisord.log
+    dnf install python3-pip -y
+    pip install supervisor
+    mkdir -p /var/log/supervisor
+    mkdir -p /var/run/supervisor
+    cp .platform/queue-worker/supervisord.service /usr/lib/systemd/system/supervisord.service
     cp .platform/queue-worker/supervisord.conf /etc/supervisord.conf
-    /etc/init.d/supervisord  start
-    sudo chkconfig supervisord  on
+    systemctl daemon-reload
+    systemctl enable supervisord
+    systemctl start supervisord
 }
 
 /opt/elasticbeanstalk/bin/get-config --output YAML environment | sed -e 's/^\(.*\): /\1=/g' > bashEnv
@@ -47,7 +47,7 @@ then
         echo 'Found worker key!';
         echo 'Starting worker deploy process...';
 
-        if [ -f /etc/init.d/supervisord ]
+        if [ -f /etc/supervisord.conf ]
         then
            echo 'Config found. Supervisor already installed';
            updateSupervisor;

src/.platform/hooks/postdeploy/02worker-deploy.sh

@@ -3,27 +3,27 @@
 #
 # Description: For use with AWS elasticbeanstalk and Laravel. As part of a deployment will either skip, install,
 #              or update supervisord depending on environmental variables set in EB.
-#              This script has been modified as necessary to support Amazon Linux 2
+#              This script has been modified as necessary to support Amazon Linux 2023
 
 updateSupervisor(){
     cp .platform/queue-worker/supervisord.conf /etc/supervisord.conf
-    sudo service supervisord stop
+    systemctl stop supervisord
     php /var/app/current/artisan queue:restart # If this worker is running in daemon mode (most likely) we need to restart it with the new build
     echo "Sleeping a few seconds to make sure supervisor shuts down..." # https://github.com/Supervisor/supervisor/issues/48#issuecomment-2684400
     sleep 5
-    sudo service supervisord start
+    systemctl start supervisord
 }
 
 installSupervisor(){
-    easy_install supervisor
-    cp /var/app/current/.platform/queue-worker/supervisord /etc/init.d/supervisord
-    chmod 777 /etc/init.d/supervisord
-    mkdir -m 766 /var/log/supervisor
-    umask 022
-    touch /var/log/supervisor/supervisord.log
+    dnf install python3-pip -y
+    pip install supervisor
+    mkdir -p /var/log/supervisor
+    mkdir -p /var/run/supervisor
+    cp .platform/queue-worker/supervisord.service /usr/lib/systemd/system/supervisord.service
     cp .platform/queue-worker/supervisord.conf /etc/supervisord.conf
-    /etc/init.d/supervisord  start
-    sudo chkconfig supervisord  on
+    systemctl daemon-reload
+    systemctl enable supervisord
+    systemctl start supervisord
 }
 
 /opt/elasticbeanstalk/bin/get-config --output YAML environment | sed -e 's/^\(.*\): /\1=/g' > bashEnv
@@ -47,7 +47,7 @@ then
         echo 'Found worker key!';
         echo 'Starting worker deploy process...';
 
-        if [ -f /etc/init.d/supervisord ]
+        if [ -f /etc/supervisord.conf ]
         then
            echo 'Config found. Supervisor already installed';
            updateSupervisor;

src/.platform/queue-worker/parseConfig.php

@@ -1,7 +1,8 @@
 <?php
 
-function generateProgram($connection, $queue, $tries, $sleep, $numProcs, $delay, $startSecs, $environmentVal) {
-    $queueVal = $queue !== null ? " --queue=$queue": '';
+function generateProgram($connection, $queue, $tries, $sleep, $numProcs, $delay, $startSecs, $environmentVal)
+{
+    $queueVal = $queue !== null ? " --queue=$queue" : '';
     $program = <<<EOT
 
 [program:$queue]
@@ -20,7 +21,8 @@ function generateProgram($connection, $queue, $tries, $sleep, $numProcs, $delay,
     return $program;
 }
 
-function getEBWorkerConfig($path) {
+function getEBWorkerConfig($path)
+{
     if (null === $path) {
         return null;
     } else {
@@ -84,7 +86,7 @@ function getEBWorkerConfig($path) {
     foreach ($envVars as $key => $val) {
         if (
             ctype_alnum($val) // alphanumeric doesn't need quotes
-            || (strpos($val, '"') === 0 && strrpos($val, '"') === count($val) -1) // if the value is already quoted don't double-quote it
+            || (strpos($val, '"') === 0 && strrpos($val, '"') === count($val) - 1) // if the value is already quoted don't double-quote it
         ) {
             $formattedVal = $val;
         } else { // otherwise put everything in quotes for environment param http://supervisord.org/configuration.html#program-x-section-values
@@ -97,15 +99,12 @@ function getEBWorkerConfig($path) {
     $programs = '';
 
     $isBeanstalk = false;
-    if (
-        !empty($lowerEnvVars['queue_connection']) && $lowerEnvVars['queue_connection'] === 'beanstalkd' ||
-        !empty($lowerEnvVars['queue_driver']) && $lowerEnvVars['queue_driver'] === 'beanstalkd'
-    ) {
+    if (!empty($lowerEnvVars['queue_connection']) && $lowerEnvVars['queue_connection'] === 'beanstalkd') {
         $isBeanstalk = true;
     }
 
     foreach ($lowerEnvVars as $key => $val) {
-        if (strpos($key, 'queue') !== false && !in_array($key, ['queue_driver', 'queue_connection'])) {
+        if (substr($key, 0, 5) === 'queue' && $key !== 'queue_connection') {
             $tryKey       = substr($key, 5) . 'tries'; //get queue $key + tries to see if custom tries is set
             $sleepKey     = substr($key, 5) . 'sleep'; //get queue $key + sleep to see if custom sleep is set
             $numProcKey   = substr($key, 5) . 'numprocs'; //get queue $key + num process to see if custom number of processes is set
@@ -117,7 +116,7 @@ function getEBWorkerConfig($path) {
             $numProcs   = isset($lowerEnvVars[$numProcKey]) ? $lowerEnvVars[$numProcKey] : 1;
             $startSecs  = isset($lowerEnvVars[$startSecsKey]) ? $lowerEnvVars[$startSecsKey] : 1;
             $delay      = isset($lowerEnvVars[$delayKey]) ? $lowerEnvVars[$delayKey] : 0;
-            // if using beanstalk connection should always be beanstalkd and specify tube in queue, otherwise us queue name as connection
+            // if using beanstalk connection should always be beanstalkd and specify tube in queue, otherwise use queue driver name as connection
             $connection = $isBeanstalk ? 'beanstalkd' : $val;
             // if not using beanstalk we don't need queue probably
             $queue = $isBeanstalk ? $val : null;