Simplify using Octane (#43)

* Provide a default `serverless.yml` with FPM by default

* Move Bref initialization code in the service provider so that it applies to all runtime types

* Enable direct deployments by default because they are faster

* Remove the population of env vars from SSM parameters

This is a native Bref feature since Bref 2.0.

* Remove `deploymentMethod` as it is set by default in Bref 2.0

* Run `config:cache` on cold starts using the new Bref hooks

* Simplify the Octane handler

* Simplify the Octane runtime usage

* Make sure file handlers are still supported

* flatten

* inline

* formatting

* fix

---------

Co-authored-by: Till Krüss <tillkruss@users.noreply.github.com>

Author: mnapoli

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [v2.0.0]
 ### Breaking Changes
 - 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`.
 
 ## [Unreleased]
 ## [v0.3.0] - 2022-11-15

README.md

@@ -28,7 +28,7 @@ composer require cachewerk/bref-laravel-bridge
 php artisan vendor:publish --tag=bref-runtime
 ```
 
-By default the runtime is published to `php/` where Bref's PHP configuration resides, but it can be move anywhere.
+This will create the `serverless.yml` config file.
 
 Next, we need to set up in the `AWS_ACCOUNT_ID` environment variable in your `serverless.yml`:
 
@@ -38,67 +38,62 @@ provider:
     AWS_ACCOUNT_ID: ${aws:accountId}
 ```
 
-Then set up your functions:
+Finally, deploy your app:
 
-```yml
-functions:
-  web:
-    handler: php/runtime.php
-    environment:
-      APP_RUNTIME: octane
-      BREF_LOOP_MAX: 250
-    layers:
-      - ${bref:layer.php-81}
-    events:
-      - httpApi: '*'
+```bash
+serverless deploy
+```
 
-  queue:
-    handler: php/runtime.php
-    timeout: 59
-    environment:
-      APP_RUNTIME: queue
-    layers:
-      - ${bref:layer.php-81}
-    events:
-      - sqs:
-          arn: !GetAtt Queue.Arn
-          batchSize: 1
-          maximumBatchingWindow: 60
-
-  cli:
-    handler: php/runtime.php
-    timeout: 720
-    environment:
-      APP_RUNTIME: cli
-    layers:
-      - ${bref:layer.php-81}
-      - ${bref:layer.console}
-    events:
-      - schedule:
-          rate: rate(1 minute)
-          input: '"schedule:run"'
+When running in AWS Lambda, the Laravel application will automatically cache its configuration when booting. You don't need to run `php artisan config:cache` before deploying.
+
+You can deploy to different environments (aka "stages") by using the `--stage` option:
+
+```bash
+serverless deploy --stage=staging
 ```
 
-If you don't want to use Octane, simply remove `APP_RUNTIME` and `BREF_LOOP_MAX` from the `web` function.
+Check out some more [comprehensive examples](examples/).
+
+## Octane
 
-To avoid setting secrets as environment variables on your Lambda functions, you can inject them directly into the Lambda runtime:
+If you want to run the HTTP application with Laravel Octane, you will to change the following options in the `web` function:
 
 ```yml
-provider:
-  environment:
-    APP_SSM_PREFIX: /${self:service}-${sls:stage}/
-    APP_SSM_PARAMETERS: "APP_KEY, DATABASE_URL"
+functions:
+    web:
+        handler: CacheWerk\BrefLaravelBridge\Http\OctaneHandler
+        environment:
+            BREF_LOOP_MAX: 250
+        layers:
+            - ${bref:layer.php-81}
+        # ...
 ```
 
-This will inject `APP_KEY` and `DATABASE_URL` using your service name and stage, for example from `/myapp-staging/APP_KEY`.
+## Laravel Queues
 
-Finally, deploy your app:
+If you want to run Laravel Queues, you will need to publish the PHP runtime (just like in the "Octane" section above):
 
 ```
-sls deploy --stage=staging
+php artisan vendor:publish --tag=bref-runtime
 ```
 
-Check out some more [comprehensive examples](examples/).
+Then, you can add a `queue` function to `serverless.yml`:
+
+```yml
+functions:
+    queue:
+        handler: php/runtime.php
+        timeout: 59 # in seconds
+        environment:
+            APP_RUNTIME: queue
+        layers:
+            - ${bref:layer.php-81}
+        events:
+            -   sqs:
+                    arn: !GetAtt Queue.Arn
+                    batchSize: 1
+                    maximumBatchingWindow: 60
+```
 
 ## Configuration
 

composer.json

@@ -10,7 +10,7 @@
     "require": {
         "php": "^8.0",
         "aws/aws-sdk-php": "^3.222",
-        "bref/bref": "^1.5",
+        "bref/bref": "^2.0.0-beta14",
         "illuminate/container": "^8.0 || ^9.0",
         "illuminate/contracts": "^8.0 || ^9.0",
         "illuminate/http": "^8.0 || ^9.0",
@@ -30,7 +30,10 @@
     "autoload": {
         "psr-4": {
             "CacheWerk\\BrefLaravelBridge\\": "src"
-        }
+        },
+        "files": [
+            "src/bref-init.php"
+        ]
     },
     "config": {
         "sort-packages": true

examples/getting-started/serverless.yml

@@ -23,8 +23,6 @@ provider:
     APP_URL: ${param:appUrl}
     APP_ENV: ${sls:stage}
     APP_DEBUG: ${param:debug}
-    APP_SSM_PREFIX: /${self:service}-${sls:stage}/
-    APP_SSM_PARAMETERS: "APP_KEY"
     AWS_ACCOUNT_ID: ${aws:accountId}
     ASSET_URL: https://${param:assetsBucket}/${sls:instanceId}
     LOG_LEVEL: ${param:logLevel}
@@ -44,9 +42,6 @@ provider:
         - Effect: Allow
           Resource: !GetAtt Queue.Arn
           Action: [sqs:GetQueueUrl, sqs:GetQueueAttributes, sqs:SendMessage, sqs:receiveMessage, sqs:DeleteMessage, sqs:PurgeQueue]
-        - Effect: Allow
-          Resource: arn:aws:ssm:${aws:region}:${aws:accountId}:parameter/${self:service}-${sls:stage}/*
-          Action: [ssm:GetParameters]
         # Allow Lambda to read and write files in the S3 storage bucket
         - Effect: Allow
           Action: s3:*
@@ -60,10 +55,9 @@ plugins:
 
 functions:
   web:
-    handler: php/runtime.php
+    handler: CacheWerk\BrefLaravelBridge\Http\OctaneHandler
     timeout: 20
     environment:
-      APP_RUNTIME: octane
       BREF_LOOP_MAX: 250
       BREF_BINARY_RESPONSES: 1
     layers:

phpcs.xml.dist

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

src/BrefServiceProvider.php

@@ -67,7 +67,13 @@ public function register()
      */
     public function boot(Dispatcher $dispatcher, LogManager $logManager, FailedJobProviderInterface $queueFailer)
     {
+        $this->app->useStoragePath(StorageDirectories::Path);
+
         if ($this->app->runningInConsole()) {
+            $this->publishes([
+                __DIR__ . '/../stubs/serverless.yml' => config_path('serverless.yml'),
+            ], 'serverless-config');
+
             $this->publishes([
                 __DIR__ . '/../config/bref.php' => config_path('bref.php'),
             ], 'bref-config');

src/HandlerResolver.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace CacheWerk\BrefLaravelBridge;
+
+use RuntimeException;
+use Bref\Runtime\FileHandlerLocator;
+use Psr\Container\ContainerInterface;
+use Illuminate\Foundation\Application;
+
+/**
+ * This class resolves Lambda handlers.
+ *
+ * It extends the default Bref behavior (that resolves handlers from files)
+ * to also resolve class handlers from the Laravel container.
+ */
+class HandlerResolver implements ContainerInterface
+{
+    private ?Application $laravelApp;
+    private FileHandlerLocator $fileLocator;
+
+    public function __construct()
+    {
+        // Bref's default handler resolver
+        $this->fileLocator = new FileHandlerLocator;
+        $this->laravelApp = null;
+    }
+
+    public function get(string $id)
+    {
+        // By default, we check if the handler is a file name (classic Bref behavior)
+        if ($this->fileLocator->has($id)) {
+            return $this->fileLocator->get($id);
+        }
+
+        // If not, we try to get the handler from the Laravel container
+        return $this->laravelApp()->get($id);
+    }
+
+    public function has(string $id): bool
+    {
+        // By default, we check if the handler is a file name (classic Bref behavior)
+        if ($this->fileLocator->has($id)) {
+            return true;
+        }
+
+        // If not, we try to get the handler from the Laravel container
+        return $this->laravelApp()->has($id);
+    }
+
+    /**
+     * Create and return the Laravel application.
+     */
+    private function laravelApp(): Application
+    {
+        // Only create it once
+        if ($this->laravelApp) {
+            return $this->laravelApp;
+        }
+
+        $bootstrapFile = getcwd() . '/bootstrap/app.php';
+
+        if (! file_exists($bootstrapFile)) {
+            throw new RuntimeException(
+                "Unable to locate `{$bootstrapFile}`: Bref tried to load that file to retrieve the Laravel app"
+            );
+        }
+
+        $this->laravelApp = require $bootstrapFile;
+
+        if (! $this->laravelApp 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),
+            ));
+        }
+
+        return $this->laravelApp;
+    }
+}

src/Http/OctaneHandler.php

@@ -16,10 +16,20 @@
 
 class OctaneHandler extends HttpHandler
 {
+    private OctaneClient $octaneClient;
+
+    public function __construct()
+    {
+        $this->octaneClient = new OctaneClient(
+            getcwd(),
+            (bool) ($_ENV['OCTANE_PERSIST_DATABASE_SESSIONS'] ?? false)
+        );
+    }
+
     /**
      * {@inheritDoc}
      */
-    public function handleRequest(?HttpRequestEvent $event, ?Context $context): HttpResponse
+    public function handleRequest(HttpRequestEvent $event, Context $context): HttpResponse
     {
         $request = Request::createFromBase(
             SymfonyRequestBridge::convertRequest($event, $context)
@@ -28,7 +38,7 @@ public function handleRequest(?HttpRequestEvent $event, ?Context $context): Http
         if (MaintenanceMode::active()) {
             $response = MaintenanceMode::response($request)->prepare($request);
         } else {
-            $response = OctaneClient::handle($request);
+            $response = $this->octaneClient->handle($request);
         }
 
         if (! $response->headers->has('Content-Type')) {

src/Octane/OctaneClient.php

@@ -20,29 +20,18 @@ class OctaneClient implements Client
 {
     /**
      * The Octane worker.
-     *
-     * @var \Laravel\Octane\Worker
      */
-    protected static $worker;
+    private Worker $worker;
 
     /**
-     * The Octane response.
-     *
-     * @var \Laravel\Octane\OctaneResponse|null
+     * The response of the last request that was processed.
      */
-    protected static $response;
+    private OctaneResponse|null $response;
 
-    /**
-     * Boots an Octane worker instance.
-     *
-     * @param  string  $basePath
-     * @param  bool  $persistDatabaseSession
-     * @return void
-     */
-    public static function boot(string $basePath, bool $persistDatabaseSession)
+    public function __construct(string $basePath, bool $persistDatabaseSession)
     {
-        static::$worker = tap(
-            new Worker(new ApplicationFactory($basePath), new self)
+        $this->worker = tap(
+            new Worker(new ApplicationFactory($basePath), $this)
         )->boot()->onRequestHandled(
             static::manageDatabaseSessions($persistDatabaseSession)
         );
@@ -54,14 +43,14 @@ public static function boot(string $basePath, bool $persistDatabaseSession)
      * @param  \Illuminate\Http\Request  $request
      * @return \Symfony\Component\HttpFoundation\Response
      */
-    public static function handle(Request $request): Response
+    public function handle(Request $request): Response
     {
-        static::$worker->application()->useStoragePath('/tmp/storage');
+        $this->worker->application()->useStoragePath('/tmp/storage');
 
-        static::$worker->handle($request, new RequestContext);
+        $this->worker->handle($request, new RequestContext);
 
-        $response = clone static::$response->response;
-        static::$response = null;
+        $response = clone $this->response->response;
+        $this->response = null;
 
         return $response;
     }
@@ -72,14 +61,14 @@ public static function handle(Request $request): Response
     public function error(Throwable $exception, Application $app, Request $request, RequestContext $context): void
     {
         try {
-            static::$response = new OctaneResponse(
+            $this->response = new OctaneResponse(
                 $app[ExceptionHandler::class]->render($request, $exception)
             );
         } catch (Throwable $throwable) {
             fwrite(STDERR, $throwable->getMessage());
             fwrite(STDERR, $exception->getMessage());
 
-            static::$response = new OctaneResponse(
+            $this->response = new OctaneResponse(
                 new Response('Internal Server Error', 500)
             );
         }
@@ -90,7 +79,7 @@ public function error(Throwable $exception, Application $app, Request $request,
      */
     public function respond(RequestContext $context, OctaneResponse $response): void
     {
-        static::$response = $response;
+        $this->response = $response;
     }
 
     /**