Octane wrapper

Author: nickverschoor

.gitignore

@@ -1,6 +1,5 @@
 composer.phar
+composer.lock
 /vendor/
 
-# Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
-# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
-# composer.lock
+/.idea

bin/file-watcher.cjs

@@ -0,0 +1,15 @@
+const chokidar = require('chokidar');
+
+const paths = JSON.parse(process.argv[2]);
+const poll = process.argv[3] ? true : false;
+
+const watcher = chokidar.watch(paths, {
+    ignoreInitial: true,
+    usePolling: poll,
+});
+
+watcher
+    .on('add', () => console.log('File added...'))
+    .on('change', () => console.log('File changed...'))
+    .on('unlink', () => console.log('File deleted...'))
+    .on('unlinkDir', () => console.log('Directory deleted...'));

composer.json

@@ -0,0 +1,28 @@
+{
+    "name": "programic/laravel-kubernetes",
+    "description": "Programic Laravel Kubernetes",
+    "autoload": {
+        "psr-4": {
+            "Programic\\LaravelKubernetes\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "Nick Verschoor",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "php": "^8.2",
+        "laravel/octane": "^2.6"
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Programic\\LaravelKubernetes\\KubernetesServiceProvider"
+            ]
+        }
+    },
+    "minimum-stability": "stable",
+    "prefer-stable": true
+}

config/kubernetes.php

@@ -0,0 +1,40 @@
+<?php
+
+return [
+    /*
+    |--------------------------------------------------------------------------
+    | File Watching
+    |--------------------------------------------------------------------------
+    |
+    | The following list of files and directories will be watched when using
+    | the --watch option offered by Octane. If any of the directories and
+    | files are changed, Octane will automatically reload your workers.
+    |
+    */
+    'watch' => [
+        'enabled' => env('KUBERNETES_WATCH_ENABLED', env('APP_ENV') === 'local'),
+        'paths' => [
+            'app',
+            'bootstrap',
+            'config/**/*.php',
+            'database/**/*.php',
+            'public/**/*.php',
+            'resources/**/*.php',
+            'routes',
+            'composer.lock',
+            '.env',
+        ],
+    ],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Maximum Execution Time
+    |--------------------------------------------------------------------------
+    |
+    | The following setting configures the maximum execution time for requests
+    | being handled by Octane. You may set this value to 0 to indicate that
+    | there isn't a specific time limit on Octane request execution time.
+    |
+    */
+    'max_execution_time' => env('MAX_EXECUTION_TIME', 60),
+];

src/Commands/InstallCommand.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Programic\LaravelKubernetes\Commands;
+
+use Illuminate\Console\Command;
+use function Laravel\Prompts\spin;
+
+class InstallCommand extends Command
+{
+    protected $signature = 'kubernetes:install
+                            {--force : Overwrite any existing configuration files}';
+
+    protected $description = 'Install components and resources';
+
+    public function handle(): int
+    {
+        $this->callSilent('vendor:publish', [
+            '--tag' => 'kubernetes-config',
+            '--force' => $this->option('force'),
+        ]);
+
+        spin(
+            function (): void {
+                $this->callSilent(InstallOctaneCommand::class, ['--server' => 'frankenphp']);
+            },
+            'Installing Octane components and resources'
+        );
+
+        $this->components->info('Laravel kubernetes installed successfully.');
+
+        return 0;
+    }
+}

src/Commands/InstallOctaneCommand.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Programic\LaravelKubernetes\Commands;
+
+use Laravel\Octane\Commands\InstallCommand;
+use function Laravel\Prompts\select;
+
+class InstallOctaneCommand extends InstallCommand
+{
+    public function handle()
+    {
+        return (int) ! tap(
+            $this->installFrankenPhpServer()
+        );
+    }
+}

src/Commands/StartCommand.php

@@ -0,0 +1,93 @@
+<?php
+
+namespace Programic\LaravelKubernetes\Commands;
+
+use Illuminate\Support\Str;
+use Laravel\Octane\Commands\StartFrankenPhpCommand;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Process\ExecutableFinder;
+use Symfony\Component\Process\Process;
+
+#[AsCommand(name: 'kubernetes:start')]
+class StartCommand extends StartFrankenPhpCommand
+{
+    protected $hidden = false;
+
+    /**
+     * The command's signature.
+     *
+     * @var string
+     */
+    public $signature = 'kubernetes:start
+                    {--host=127.0.0.1 : The IP address the server should bind to}
+                    {--port=80 : The port the server should be available on}
+                    {--admin-host=localhost : The host the admin server should be available on}
+                    {--admin-port=2019 : The port the admin server should be available on}
+                    {--workers=auto : The number of workers that should be available to handle requests}
+                    {--max-requests=500 : The number of requests to process before reloading the server}
+                    {--caddyfile= : The path to the FrankenPHP Caddyfile file}
+                    {--https : Enable HTTPS, HTTP/2, and HTTP/3, and automatically generate and renew certificates}
+                    {--http-redirect : Enable HTTP to HTTPS redirection (only enabled if --https is passed)}
+                    {--watch : Automatically reload the server when the application is modified (enable by default if APP_ENV is local)}
+                    {--poll : Use file system polling while watching in order to watch files over a network}
+                    {--log-level=INFO : Log messages at or above the specified log level}';
+
+    public $description = 'Start the server';
+
+    protected function writeServerOutput($server): void
+    {
+        [$output, $errorOutput] = $this->getServerOutput($server);
+
+        Str::of($output)
+            ->explode("\n")
+            ->filter()
+            ->each(function ($output): void {
+                $this->output->writeln($output);
+            });
+
+        Str::of($errorOutput)
+            ->explode("\n")
+            ->filter()
+            ->each(function ($output): void {
+                $debug = json_decode($output, true);
+
+                if (! is_array($debug)) {
+                    $this->components->info($output);
+
+                    return;
+                }
+
+                if (isset($debug['logger']) && Str::startsWith($debug['logger'], 'http.log.access.log')) {
+                    $this->output->writeln($output);
+                }
+            });
+    }
+
+    protected function startServerWatcher()
+    {
+        $watch = config('kubernetes.watch.enabled') || $this->option('watch');
+
+        if (! $watch) {
+            return new class
+            {
+                public function __call($method, $parameters)
+                {
+                    return null;
+                }
+            };
+        }
+
+        if (empty($paths = config('octane.watch'))) {
+            throw new InvalidArgumentException(
+                'List of directories/files to watch not found. Please update your "config/octane.php" configuration file.',
+            );
+        }
+
+        return tap(new Process([
+            (new ExecutableFinder)->find('node'),
+            'file-watcher.cjs',
+            json_encode(collect(config('octane.watch'))->map(fn ($path) => base_path($path))),
+            $this->option('poll'),
+        ], realpath(__DIR__.'/../../bin'), null, null, null))->start();
+    }
+}

src/KubernetesServiceProvider.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Programic\LaravelKubernetes;
+
+use Illuminate\Support\Facades\Config;
+use Illuminate\Support\ServiceProvider;
+
+class KubernetesServiceProvider extends ServiceProvider
+{
+    public function register()
+    {
+        $this->mergeConfigFrom(__DIR__.'/../config/kubernetes.php', 'kubernetes');
+    }
+
+    public function boot()
+    {
+        $this->registerPublishing();
+        $this->setOctaneConfig();
+        $this->registerCommands();
+    }
+
+    protected function registerCommands(): void
+    {
+        if ($this->app->runningInConsole()) {
+            $this->commands([
+                Commands\InstallCommand::class,
+                Commands\StartCommand::class,
+            ]);
+        }
+    }
+
+    protected function setOctaneConfig(): void
+    {
+        config()->set('octane.server', 'frankenphp');
+        config()->set('octane.watch', config('kubernetes.watch.paths'));
+        config()->set('octane.max_execution_time', config('kubernetes.max_execution_time'));
+    }
+
+    protected function registerPublishing()
+    {
+        if ($this->app->runningInConsole()) {
+            $this->publishes([
+                __DIR__.'/../config/kubernetes.php' => config_path('kubernetes.php'),
+            ], 'kubernetes-config');
+        }
+    }
+}