[2.x] Add support for FrankenPHP

bin/frankenphp-worker.php

@@ -0,0 +1,43 @@
+<?php
+
+use Laravel\Octane\ApplicationFactory;
+use Laravel\Octane\FrankenPhp\FrankenPhpClient;
+use Laravel\Octane\RequestContext;
+use Laravel\Octane\Worker;
+
+$basePath = require __DIR__.'/bootstrap.php';
+
+/*
+|--------------------------------------------------------------------------
+| Start The Octane Worker
+|--------------------------------------------------------------------------
+|
+| Next we will start the Octane worker, which is a long running process to
+| handle incoming requests to the application.
+|
+*/
+
+$frankenPhpClient = new FrankenPhpClient();
+
+$worker = null;
+$nbRequests = 0;
+try {
+    while (
+        $nbRequests < ($_ENV['MAX_REQUESTS'] ?? $_SERVER['MAX_REQUESTS']) &&
+        frankenphp_handle_request(function () use (&$worker, $basePath, $frankenPhpClient) {
+            $worker = $worker ?: tap(
+                new Worker(
+                    new ApplicationFactory($basePath), $frankenPhpClient
+                )
+            )->boot();
+
+            [$request, $context] = $frankenPhpClient->marshalRequest(new RequestContext());
+
+            $worker->handle($request, $context);
+        })
+    ) {
+        $nbRequests++;
+    }
+} finally {
+    $worker?->terminate();
+}

config/octane.php

@@ -32,7 +32,7 @@
     | when starting, restarting, or stopping your server via the CLI. You
     | are free to change this to the supported server of your choosing.
     |
-    | Supported: "roadrunner", "swoole"
+    | Supported: "roadrunner", "swoole", "frankenphp"
     |
     */
 
@@ -51,6 +51,29 @@
 
     'https' => env('OCTANE_HTTPS', false),
 
+    /*
+    |--------------------------------------------------------------------------
+    | Mercure hub
+    |--------------------------------------------------------------------------
+    |
+    | This option configures the Mercure hub (events broadcasting) that is included in FrankenPHP.
+    | The defaults are good enough for most applications.
+    | "publisher_jwt" configures the key and algorithm to use for verifying JWTs provided by publishers.
+    | "subscriber_jwt" configures the key and algorithm to use for verifying JWTs provided by subscribers.
+    | Set "anonymous" to false to disable anonymous subscribing.
+    | Set "subscriptions" to false to disable the subscription API.
+    | Set "mercure" to false to entirely disable the Mercure hub.
+    |
+    | More information about Mercure can be found on https://mercure.rocks.
+    */
+
+    'mercure' => [
+        'publisher_jwt' => env('MERCURE_SUBSCRIBER_JWT_KEY', '!ChangeThisMercureHubJWTSecretKey!'),
+        'subscriber_jwt' => env('MERCURE_SUBSCRIBER_JWT_KEY', '!ChangeThisMercureHubJWTSecretKey!'),
+        'anonymous' => true,
+        'subscriptions' => true,
+    ],
+
     /*
     |--------------------------------------------------------------------------
     | Octane Listeners

phpstan.neon.dist

@@ -10,3 +10,4 @@ parameters:
     - "#Unsafe usage of new static\\(\\)#"
     - "#\\(void\\) is used.#"
     - "#Function Swoole\\\\Coroutine\\\\run not found.#"
+    - "#Function frankenphp_handle_request not found.#"

src/Commands/Concerns/InstallsFrankenPhpDependencies.php

@@ -0,0 +1,103 @@
+<?php
+
+namespace Laravel\Octane\Commands\Concerns;
+
+use GuzzleHttp\Client;
+use Illuminate\Support\Facades\Http;
+use Laravel\Octane\FrankenPhp\Concerns\FindsFrankenPhpBinary;
+
+trait InstallsFrankenPhpDependencies
+{
+    use FindsFrankenPhpBinary;
+
+    /**
+     * Ensure the FrankenPHP binary is installed into the project.
+     */
+    protected function ensureFrankenPhpBinaryIsInstalled(): string
+    {
+        if (! is_null($frankenphpBinary = $this->findFrankenPhpBinary())) {
+            return $frankenphpBinary;
+        }
+
+        if ($this->confirm('Unable to locate FrankenPHP binary. Should Octane download the binary for your operating system?', true)) {
+            $this->downloadFrankenPhpBinary();
+
+            copy(__DIR__.'/../stubs/Caddyfile', base_path('Caddyfile'));
+        }
+
+        return base_path('frankenphp');
+    }
+
+    /**
+     * Download the latest version of the FrankenPHP binary.
+     *
+     * @return bool
+     */
+    protected function downloadFrankenPhpBinary()
+    {
+        $arch = php_uname('m');
+
+        $assetName = null;
+        if (PHP_OS_FAMILY === 'Linux') {
+            if ($arch !== 'x86_64') {
+                $assetName = 'frankenphp-linux-x86_64';
+            }
+        } elseif (PHP_OS_FAMILY === 'Darwin') {
+            $assetName = "frankenphp-mac-$arch";
+        }
+
+        if ($assetName === null) {
+            $this->error('FrankenPHP binaries are currently only available for Linux (x86_64) and macOS. Use the Docker images or compile FrankenPHP yourself.');
+
+            return false;
+        }
+
+        // TODO: use https://api.github.com/repos/dunglas/frankenphp/releases/latest when a stable version will be available
+        $assets = Http::accept('application/vnd.github+json')
+            ->withHeaders(['X-GitHub-Api-Version' => '2022-11-28'])
+            ->get('https://api.github.com/repos/dunglas/frankenphp/releases', ['per_page' => 1])[0]['assets'];
+
+        foreach ($assets as $asset) {
+            if ($asset['name'] !== $assetName) {
+                continue;
+            }
+
+            $path = base_path('frankenphp');
+
+            $progressBar = null;
+            (new Client())->get(
+                $asset['browser_download_url'],
+                [
+                    'sink' => $path,
+                    'progress' => function ($downloadTotal, $downloadedBytes) use (&$progressBar) {
+                        if ($downloadTotal === 0) {
+                            return;
+                        }
+
+                        if ($progressBar === null) {
+                            $progressBar = $this->output->createProgressBar($downloadTotal);
+                            $progressBar->start($downloadTotal, $downloadedBytes);
+
+                            return;
+                        }
+
+                        $progressBar->setProgress($downloadedBytes);
+                    },
+                ]
+            );
+            chmod($path, 0755);
+
+            $progressBar->finish();
+
+            if (PHP_OS_FAMILY === 'Darwin') {
+                $this->warn("Run `xattr -d com.apple.quarantine $path` to release FrankenPHP from Apple's quarantine before starting the server.");
+            }
+
+            return $path;
+        }
+
+        $this->error('FrankenPHP asset not found.');
+
+        return $path;
+    }
+}

src/Commands/Concerns/InteractsWithServers.php

@@ -100,7 +100,7 @@ protected function writeServerRunningMessage()
 
         $this->output->writeln([
             '',
-            '  Local: <fg=white;options=bold>http://'.$this->getHost().':'.$this->getPort().' </>',
+            '  Local: <fg=white;options=bold>'.($this->option('https') ? 'https://' : 'http://').$this->getHost().':'.$this->getPort().' </>',
             '',
             '  <fg=yellow>Press Ctrl+C to stop the server</>',
             '',

src/Commands/InstallCommand.php

@@ -8,7 +8,8 @@
 
 class InstallCommand extends Command
 {
-    use Concerns\InstallsRoadRunnerDependencies;
+    use Concerns\InstallsFrankenPhpDependencies,
+        Concerns\InstallsRoadRunnerDependencies;
 
     /**
      * The command's signature.
@@ -34,12 +35,13 @@ public function handle()
     {
         $server = $this->option('server') ?: $this->choice(
             'Which application server you would like to use?',
-            ['roadrunner', 'swoole'],
+            ['roadrunner', 'swoole', 'frankenphp'],
         );
 
         return (int) ! tap(match ($server) {
             'swoole' => $this->installSwooleServer(),
             'roadrunner' => $this->installRoadRunnerServer(),
+            'frankenphp' => $this->installFrankenPhpServer(),
             default => $this->invalidServer($server),
         }, function ($installed) use ($server) {
             if ($installed) {
@@ -116,6 +118,29 @@ public function installSwooleServer()
         return true;
     }
 
+    /**
+     * Install the FrankenPHP server.
+     *
+     * @return bool
+     */
+    public function installFrankenPhpServer()
+    {
+        if (File::exists(base_path('.gitignore'))) {
+            collect(['frankenphp', 'Caddyfile'])
+                ->each(function ($file) {
+                    $contents = File::get(base_path('.gitignore'));
+                    if (! Str::contains($contents, $file.PHP_EOL)) {
+                        File::append(
+                            base_path('.gitignore'),
+                            $file.PHP_EOL
+                        );
+                    }
+                });
+        }
+
+        return $this->ensureFrankenPhpBinaryIsInstalled();
+    }
+
     /**
      * Inform the user that the server type is invalid.
      *

src/Commands/ReloadCommand.php

@@ -2,6 +2,7 @@
 
 namespace Laravel\Octane\Commands;
 
+use Laravel\Octane\FrankenPhp\ServerProcessInspector as FrankenPhpServerProcessInspector;
 use Laravel\Octane\RoadRunner\ServerProcessInspector as RoadRunnerServerProcessInspector;
 use Laravel\Octane\Swoole\ServerProcessInspector as SwooleServerProcessInspector;
 
@@ -33,6 +34,7 @@ public function handle()
         return match ($server) {
             'swoole' => $this->reloadSwooleServer(),
             'roadrunner' => $this->reloadRoadRunnerServer(),
+            'frankenphp' => $this->reloadFrankenPhpServer(),
             default => $this->invalidServer($server),
         };
     }
@@ -81,6 +83,28 @@ protected function reloadRoadRunnerServer()
         return 0;
     }
 
+    /**
+     * Reload the FrankenPHP server for Octane.
+     *
+     * @return int
+     */
+    protected function reloadFrankenPhpServer()
+    {
+        $inspector = app(FrankenPhpServerProcessInspector::class);
+
+        if (! $inspector->serverIsRunning()) {
+            $this->error('Octane server is not running.');
+
+            return 1;
+        }
+
+        $this->info('Reloading workers...');
+
+        $inspector->reloadServer();
+
+        return 0;
+    }
+
     /**
      * Inform the user that the server type is invalid.
      *

src/Commands/StartCommand.php

@@ -23,6 +23,8 @@ class StartCommand extends Command implements SignalableCommandInterface
                     {--task-workers=auto : The number of task workers that should be available to handle tasks}
                     {--max-requests=500 : The number of requests to process before reloading the server}
                     {--rr-config= : The path to the RoadRunner .rr.yaml file}
+                    {--frankenphp-config= : The path to the FrankenPHP Caddyfile file}
+                    {--https : Enable HTTPS, HTTP/2 and HTTP/3, automatically generate and renew certificates}
                     {--watch : Automatically reload the server when the application is modified}
                     {--poll : Use file system polling while watching in order to watch files over a network}
                     {--log-level= : Log messages at or above the specified log level}';
@@ -46,6 +48,7 @@ public function handle()
         return match ($server) {
             'swoole' => $this->startSwooleServer(),
             'roadrunner' => $this->startRoadRunnerServer(),
+            'frankenphp' => $this->startFrankenPhpServer(),
             default => $this->invalidServer($server),
         };
     }
@@ -89,6 +92,24 @@ protected function startRoadRunnerServer()
         ]);
     }
 
+    /**
+     * Start the FrankenPHP server for Octane.
+     *
+     * @return int
+     */
+    protected function startFrankenPhpServer()
+    {
+        return $this->call('octane:frankenphp', [
+            '--host' => $this->getHost(),
+            '--port' => $this->getPort(),
+            '--workers' => $this->option('workers'),
+            '--max-requests' => $this->option('max-requests'),
+            '--https' => $this->option('https'),
+            '--watch' => $this->option('watch'),
+            '--poll' => $this->option('poll'),
+        ]);
+    }
+
     /**
      * Inform the user that the server type is invalid.
      *