Simplify the configuration of Laravel Queues functions (#46)

Author: mnapoli

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Logs are now written in plain text by default instead of JSON. To enable JSON logs, set `channels.stderr.formatter` to `Monolog\Formatter\JsonFormatter::class` in `config/logging.php`.
 - The automatic population of environment variables via `APP_SSM_PREFIX` and `APP_SSM_PARAMETERS` has been removed. The native Bref 2.0 feature to load SSM parameters into environment variables can be used instead ([#36](https://github.com/cachewerk/bref-laravel-bridge/pull/36))
 - If you use Octane, remove the `bref/runtime.php` file, remove the `APP_RUNTIME` environment variable (in `serverless.yml`) and set your Octane function handler to: `handler: CacheWerk\BrefLaravelBridge\Http\OctaneHandler`.
+- If you use Laravel Queues, remove the `bref/runtime.php` file, remove the `APP_RUNTIME` environment variable (in `serverless.yml`) and set your Octane function handler to: `handler: CacheWerk\BrefLaravelBridge\Queue\QueueHandler`.
 
 ## [Unreleased]
 ## [v0.3.0] - 2022-11-15

README.md

@@ -25,7 +25,7 @@ Next, install the package and publish the custom Bref runtime:
 ```
 composer require cachewerk/bref-laravel-bridge
 
-php artisan vendor:publish --tag=bref-runtime
+php artisan vendor:publish --tag=serverless-config
 ```
 
 This will create the `serverless.yml` config file.
@@ -71,21 +71,13 @@ functions:
 
 ## Laravel Queues
 
-If you want to run Laravel Queues, you will need to publish the PHP runtime (just like in the "Octane" section above):
-
-```
-php artisan vendor:publish --tag=bref-runtime
-```
-
-Then, you can add a `queue` function to `serverless.yml`:
+If you want to run Laravel Queues, you will need to add a `queue` function to `serverless.yml`:
 
 ```yml
 functions:
     queue:
-        handler: php/runtime.php
+        handler: CacheWerk\BrefLaravelBridge\Queue\QueueHandler
         timeout: 59 # in seconds
-        environment:
-            APP_RUNTIME: queue
         layers:
             - ${bref:layer.php-81}
         events:
@@ -114,7 +106,7 @@ Lastly tell Bref to support binary responses on your `web` function:
 ```yml
 functions:
   web:
-    handler: php/runtime.php
+    handler: public/index.php
     environment:
       BREF_BINARY_RESPONSES: 1
 ```
@@ -134,9 +126,8 @@ Lastly, set the `OCTANE_PERSIST_DATABASE_SESSIONS` environment variable.
 ```yml
 functions:
   web:
-    handler: php/runtime.php
+    handler: CacheWerk\BrefLaravelBridge\Http\OctaneHandler
     environment:
-      APP_RUNTIME: octane
       BREF_LOOP_MAX: 250
       OCTANE_PERSIST_DATABASE_SESSIONS: 1
 ```

examples/getting-started/serverless.yml

@@ -66,10 +66,8 @@ functions:
       - httpApi: '*'
 
   cli:
-    handler: php/runtime.php
+    handler: artisan
     timeout: 720
-    environment:
-      APP_RUNTIME: cli
     layers:
       - ${bref:layer.php-81}
       - ${bref:layer.console}
@@ -79,10 +77,8 @@ functions:
           input: '"schedule:run"'
 
   queue:
-    handler: php/runtime.php
+    handler: CacheWerk\BrefLaravelBridge\Queue\QueueHandler
     timeout: 59
-    environment:
-      APP_RUNTIME: queue
     layers:
       - ${bref:layer.php-81}
     events:

phpcs.xml.dist

@@ -7,7 +7,6 @@
     </rule>
 
     <rule ref="PSR1.Files.SideEffects.FoundWithSymbols">
-        <exclude-pattern>*/stubs/runtime.php</exclude-pattern>
         <exclude-pattern>src/bref-init.php</exclude-pattern>
     </rule>
 

src/BrefServiceProvider.php

@@ -2,6 +2,8 @@
 
 namespace CacheWerk\BrefLaravelBridge;
 
+use CacheWerk\BrefLaravelBridge\Queue\QueueHandler;
+
 use Illuminate\Log\LogManager;
 
 use Illuminate\Support\Facades\Config;
@@ -58,6 +60,10 @@ public function register()
         Config::set('queue.connections.sqs.secret');
         Config::set('queue.connections.sqs.token', env('AWS_SESSION_TOKEN'));
         Config::set('queue.connections.sqs.prefix', env('SQS_PREFIX', "https://sqs.{$region}.amazonaws.com/{$account}"));
+
+        $this->app->when(QueueHandler::class)
+            ->needs('$connection')
+            ->giveConfig('queue.default');
     }
 
     /**
@@ -77,10 +83,6 @@ public function boot(Dispatcher $dispatcher, LogManager $logManager, FailedJobPr
             $this->publishes([
                 __DIR__ . '/../config/bref.php' => config_path('bref.php'),
             ], 'bref-config');
-
-            $this->publishes([
-                __DIR__ . '/../stubs/runtime.php' => base_path('php/runtime.php'),
-            ], 'bref-runtime');
         }
 
         $dispatcher->listen(

src/HandlerResolver.php

@@ -6,7 +6,10 @@
 
 use Bref\Runtime\FileHandlerLocator;
 use Psr\Container\ContainerInterface;
+
 use Illuminate\Foundation\Application;
+use Illuminate\Foundation\Console\Kernel;
+
 use CacheWerk\BrefLaravelBridge\Http\OctaneHandler;
 
 /**
@@ -17,14 +20,14 @@
  */
 class HandlerResolver implements ContainerInterface
 {
-    private ?Application $laravelApp;
+    private ?Application $laravel;
     private FileHandlerLocator $fileLocator;
 
     public function __construct()
     {
         // Bref's default handler resolver
         $this->fileLocator = new FileHandlerLocator;
-        $this->laravelApp = null;
+        $this->laravel = null;
     }
 
     public function get(string $id)
@@ -40,7 +43,7 @@ public function get(string $id)
         }
 
         // If not, we try to get the handler from the Laravel container
-        return $this->laravelApp()->get($id);
+        return $this->laravel()->get($id);
     }
 
     public function has(string $id): bool
@@ -56,17 +59,17 @@ public function has(string $id): bool
         }
 
         // If not, we try to get the handler from the Laravel container
-        return $this->laravelApp()->has($id);
+        return $this->laravel()->has($id);
     }
 
     /**
      * Create and return the Laravel application.
      */
-    private function laravelApp(): Application
+    private function laravel(): Application
     {
         // Only create it once
-        if ($this->laravelApp) {
-            return $this->laravelApp;
+        if ($this->laravel) {
+            return $this->laravel;
         }
 
         $bootstrapFile = getcwd() . '/bootstrap/app.php';
@@ -77,17 +80,20 @@ private function laravelApp(): Application
             );
         }
 
-        $this->laravelApp = require $bootstrapFile;
+        $this->laravel = require $bootstrapFile;
 
-        if (! $this->laravelApp instanceof Application) {
+        if (! $this->laravel instanceof Application) {
             throw new RuntimeException(sprintf(
                 "Expected the `%s` file to return a %s object, instead it returned `%s`",
                 $bootstrapFile,
                 Application::class,
-                is_object($this->laravelApp) ? get_class($this->laravelApp) : gettype($this->laravelApp),
+                is_object($this->laravel) ? get_class($this->laravel) : gettype($this->laravel),
             ));
         }
 
-        return $this->laravelApp;
+        $kernel = $this->laravel->make(Kernel::class);
+        $kernel->bootstrap();
+
+        return $this->laravel;
     }
 }

src/Queue/QueueHandler.php

@@ -36,22 +36,27 @@ class QueueHandler extends SqsHandler
      */
     protected const JOB_TIMEOUT_SAFETY_MARGIN = 1.0;
 
+    /**
+     * The name of the SQS queue.
+     *
+     * @var string
+     */
+    protected string $queueName;
+
     /**
      * Creates a new SQS queue handler instance.
      *
      * @param  \Illuminate\Container\Container  $container
      * @param  \Illuminate\Contracts\Events\Dispatcher  $events
      * @param  \Illuminate\Contracts\Debug\ExceptionHandler  $exceptions
      * @param  string  $connection
-     * @param  string  $queue
      * @return void
      */
     public function __construct(
         protected Container $container,
         protected Dispatcher $events,
         protected ExceptionHandler $exceptions,
         protected string $connection,
-        protected string $queue,
     ) {
         $queue = $container->make(QueueManager::class)
             ->connection($connection);
@@ -60,6 +65,7 @@ public function __construct(
             throw new RuntimeException('Default queue connection is not a SQS connection');
         }
 
+        $this->queueName = $queue->getQueue(null);
         $this->sqs = $queue->getSqs();
     }
 
@@ -112,7 +118,7 @@ protected function marshalJob(SqsRecord $sqsRecord): SqsJob
             $this->sqs,
             $message,
             $this->connection,
-            $this->queue,
+            $this->queueName,
         );
     }