[2.x] Add support for FrankenPHP

.editorconfig

@@ -13,3 +13,6 @@ trim_trailing_whitespace = false
 
 [*.{yml,yaml}]
 indent_size = 2
+
+[Caddyfile]
+indent_style = tab

CHANGELOG.md

@@ -10,7 +10,7 @@
 
 - Fix passing invalid connection session id to `Swoole\Http\Response::create()` by [@smortexa](https://github.com/smortexa) in https://github.com/laravel/octane/pull/737
 - Fix missing mode config by [@sy-records](https://github.com/sy-records) in https://github.com/laravel/octane/pull/740
-- Add “raw” type in handleStream method for custom json in stdout by [@mphamid](https://github.com/mphamid) in https://github.com/laravel/octane/pull/742
+- Add `raw` type in handleStream method for custom json in stdout by [@mphamid](https://github.com/mphamid) in https://github.com/laravel/octane/pull/742
 
 ## [v2.0.5](https://github.com/laravel/octane/compare/v2.0.4...v2.0.5) - 2023-08-08
 

README.md

@@ -9,7 +9,7 @@
 
 ## Introduction
 
-Laravel Octane supercharges your application's performance by serving your application using high-powered application servers, including [Open Swoole](https://openswoole.com), [Swoole](https://github.com/swoole/swoole-src), and [RoadRunner](https://roadrunner.dev). Octane boots your application once, keeps it in memory, and then feeds it requests at supersonic speeds.
+Laravel Octane supercharges your application's performance by serving your application using high-powered application servers, including [Open Swoole](https://openswoole.com), [Swoole](https://github.com/swoole/swoole-src), [RoadRunner](https://roadrunner.dev), and [FrankenPHP](https://frankenphp.dev). Octane boots your application once, keeps it in memory, and then feeds it requests at supersonic speeds.
 
 ## Official Documentation
 

bin/bootstrap.php

@@ -1,6 +1,7 @@
 <?php
 
 use Laravel\Octane\Exceptions\DdException;
+use Laravel\Octane\Octane;
 
 ini_set('display_errors', 'stderr');
 
@@ -20,7 +21,7 @@
 $basePath = $_SERVER['APP_BASE_PATH'] ?? $_ENV['APP_BASE_PATH'] ?? $serverState['octaneConfig']['base_path'] ?? null;
 
 if (! is_string($basePath)) {
-    fwrite(STDERR, 'Cannot find application base path.'.PHP_EOL);
+    Octane::writeError('Cannot find application base path.');
 
     exit(11);
 }
@@ -45,7 +46,7 @@ function dd(...$vars)
 */
 
 if (! is_file($autoload_file = $basePath.'/vendor/autoload.php')) {
-    fwrite(STDERR, "Composer autoload file was not found. Did you install the project's dependencies?".PHP_EOL);
+    Octane::writeError("Composer autoload file was not found. Did you install the project's dependencies?");
 
     exit(10);
 }

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "laravel/octane",
     "description": "Supercharge your Laravel application's performance.",
-    "keywords": ["laravel", "octane", "roadrunner", "swoole"],
+    "keywords": ["laravel", "octane", "roadrunner", "swoole", "frankenphp"],
     "license": "MIT",
     "support": {
         "issues": "https://github.com/laravel/octane/issues",

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"
     |
     */
 
@@ -137,7 +137,25 @@
 
     /*
     |--------------------------------------------------------------------------
-    | Octane Cache Table
+    | Octane Swoole Tables
+    |--------------------------------------------------------------------------
+    |
+    | While using Swoole, you may define additional tables as required by the
+    | application. These tables can be used to store data that needs to be
+    | quickly accessed by other workers on the particular Swoole server.
+    |
+    */
+
+    'tables' => [
+        'example:1000' => [
+            'name' => 'string:1000',
+            'votes' => 'int',
+        ],
+    ],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Octane Swoole Cache Table
     |--------------------------------------------------------------------------
     |
     | While using Swoole, you may leverage the Octane cache, which is powered
@@ -153,20 +171,22 @@
 
     /*
     |--------------------------------------------------------------------------
-    | Octane Swoole Tables
+    | FrankenPHP Mercure Hub
     |--------------------------------------------------------------------------
     |
-    | While using Swoole, you may define additional tables as required by the
-    | application. These tables can be used to store data that needs to be
-    | quickly accessed by other workers on the particular Swoole server.
+    | This option configures the Mercure hub (event broadcasting) that ships
+    | with FrankenPHP. The defaults provided here should be sufficient on
+    | most applications. However, you are free to tweak them as needed.
+    |
+    | See: https://mercure.rocks
     |
     */
 
-    'tables' => [
-        'example:1000' => [
-            'name' => 'string:1000',
-            'votes' => 'int',
-        ],
+    'mercure' => [
+        'publisher_jwt' => env('MERCURE_PUBLISHER_JWT_KEY', 'your-publisher-key'),
+        'subscriber_jwt' => env('MERCURE_SUBSCRIBER_JWT_KEY', 'your-subscriber-key'),
+        'anonymous' => true, // Enable anonymous subscriptions...
+        'subscriptions' => true, // Enable subscription API
     ],
 
     /*

src/Commands/Concerns/InstallsFrankenPhpDependencies.php

@@ -0,0 +1,104 @@
+<?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'));
+            copy(__DIR__.'/../stubs/frankenphp-worker.php', public_path('frankenphp-worker.php'));
+        }
+
+        return base_path('frankenphp');
+    }
+
+    /**
+     * Download the latest version of the FrankenPHP binary.
+     *
+     * @return bool
+     */
+    protected function downloadFrankenPhpBinary()
+    {
+        $arch = php_uname('m');
+
+        $assetName = match (true) {
+            PHP_OS_FAMILY === 'Linux' && $arch === 'x86_64' => 'frankenphp-linux-x86_64',
+            PHP_OS_FAMILY === 'Darwin' => "frankenphp-mac-$arch",
+            default => null,
+        };
+
+        if ($assetName === null) {
+            $this->error('FrankenPHP binaries are currently only available for Linux (x86_64) and macOS. Other systems should use the Docker images or compile FrankenPHP manually.');
+
+            return false;
+        }
+
+        $assets = Http::accept('application/vnd.github+json')
+            ->withHeaders(['X-GitHub-Api-Version' => '2022-11-28'])
+            ->get('https://api.github.com/repos/dunglas/frankenphp/releases/latest')['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();
+
+            $this->newLine();
+
+            if (PHP_OS_FAMILY === 'Darwin') {
+                $this->warn("You may need to 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/InteractsWithIO.php

@@ -7,6 +7,7 @@
 use Laravel\Octane\Exceptions\DdException;
 use Laravel\Octane\Exceptions\ServerShutdownException;
 use Laravel\Octane\Exceptions\WorkerException;
+use Laravel\Octane\Octane;
 use Laravel\Octane\WorkerExceptionInspector;
 use NunoMaduro\Collision\Writer;
 use Symfony\Component\VarDumper\VarDumper;
@@ -46,7 +47,7 @@ public function raw($string)
     {
         if (! Str::startsWith($string, $this->ignoreMessages)) {
             $this->output instanceof OutputStyle
-                ? fwrite(STDERR, $string."\n")
+                ? Octane::writeError($string)
                 : $this->output->writeln($string);
         }
     }

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->hasOption('https') && $this->option('https') ? 'https://' : 'http://').$this->getHost().':'.$this->getPort().' </>',
             '',
             '  <fg=yellow>Press Ctrl+C to stop the server</>',
             '',
@@ -114,10 +114,14 @@ protected function writeServerRunningMessage()
      */
     protected function getServerOutput($server)
     {
-        return tap([
+        $output = [
             $server->getIncrementalOutput(),
             $server->getIncrementalErrorOutput(),
-        ], fn () => $server->clearOutput()->clearErrorOutput());
+        ];
+
+        $server->clearOutput()->clearErrorOutput();
+
+        return $output;
     }
 
     /**

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,30 @@ public function installSwooleServer()
         return true;
     }
 
+    /**
+     * Install the FrankenPHP server.
+     *
+     * @return bool
+     */
+    public function installFrankenPhpServer()
+    {
+        $gitIgnorePath = base_path('.gitignore');
+
+        if (File::exists($gitIgnorePath)) {
+            $contents = File::get($gitIgnorePath);
+
+            $filesToAppend = collect(['frankenphp', 'Caddyfile', 'frankenphp-worker.php'])
+                ->filter(fn ($file) => ! str_contains($contents, $file.PHP_EOL))
+                ->implode(PHP_EOL);
+
+            if ($filesToAppend !== '') {
+                File::append($gitIgnorePath, PHP_EOL.$filesToAppend.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.
      *