Create daemons on initial site provisioning

app/Actions/LineBreaksToArray.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Actions;
+
+use Illuminate\Support\Str;
+use Lorisleiva\Actions\Concerns\AsAction;
+
+class LineBreaksToArray
+{
+    use AsAction;
+
+    public function handle(?string $content): ?array
+    {
+        return str($content)
+            ->explode("\n")
+            ->map(Str::squish(...))
+            ->filter()
+            ->values()
+            ->all();
+    }
+}

app/Actions/ParseDaemonCommands.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace App\Actions;
+
+use App\Services\Syntax\CommandParser;
+use App\Traits\CommandSyntax;
+use App\Traits\CommandSyntaxParser;
+use App\Traits\Outputifier;
+use Lorisleiva\Actions\Concerns\AsAction;
+
+class ParseDaemonCommands
+{
+    use AsAction,
+        Outputifier,
+        CommandSyntax;
+
+    protected string $signature = '{command* : The command you want to run}
+                                   {--directory= : Working directory}
+                                   {--user= : User to run the command under}
+                                   {--processes=1 : How many processes to run}
+                                   {--startsecs= : The total number of seconds the program must stay running in order to consider the start successful}
+                                   {--stopwaitsecs=10 : The number of seconds Supervisor will allow for the daemon to gracefully stop before forced termination}
+                                   {--stopsignal=SIGTERM : The signal used to kill the program when a stop is requested}';
+
+    public function handle(array $commands): array
+    {
+        $definition = $this->definition($this->signature);
+
+        return array_map(function (string $command) use ($definition) {
+            $input = $this->input($command, $definition);
+
+            if (blank($input->getArgument('command'))) {
+                $this->failCommand("No command was specified for daemon creation: {$command}");
+
+                return [];
+            }
+
+            return array_filter([
+                'command' => implode(' ', $input->getArgument('command')),
+                ...$input->getOptions(),
+            ], fn ($value) => ! is_null($value));
+        }, $commands);
+    }
+}

app/Actions/ParseQueueCommands.php

@@ -2,16 +2,16 @@
 
 namespace App\Actions;
 
+use App\Services\Syntax\CommandParser;
+use App\Traits\CommandSyntax;
 use App\Traits\Outputifier;
-use Illuminate\Console\Parser;
 use Lorisleiva\Actions\Concerns\AsAction;
-use Symfony\Component\Console\Input\InputDefinition;
-use Symfony\Component\Console\Input\StringInput;
 
 class ParseQueueCommands
 {
     use AsAction,
-        Outputifier;
+        Outputifier,
+        CommandSyntax;
 
     protected string $signature = '{connection : The name of the queue connection to work}
                                    {--queue= : The names of the queues to work}
@@ -30,11 +30,10 @@ class ParseQueueCommands
 
     public function handle(array $commands): array
     {
-        $definition = $this->definition();
+        $definition = $this->definition($this->signature);
 
-        return array_map(function ($command) use ($definition) {
-            $input = new StringInput($command);
-            $input->bind($definition);
+        return array_map(function (string $command) use ($definition) {
+            $input = $this->input($command, $definition);
 
             if (blank($input->getArgument('connection'))) {
                 $this->failCommand("No queue connection was specified for command: {$command}");
@@ -48,15 +47,4 @@ public function handle(array $commands): array
             ], fn ($value) => ! is_null($value));
         }, $commands);
     }
-
-    protected function definition(): InputDefinition
-    {
-        [, $arguments, $options] = Parser::parse($this->signature);
-
-        $definition = new InputDefinition();
-        $definition->setArguments($arguments);
-        $definition->setOptions($options);
-
-        return $definition;
-    }
 }

app/Commands/ProvisionCommand.php

@@ -15,6 +15,7 @@
 
 use App\Services\Forge\ForgeService;
 use App\Services\Forge\Pipeline\AnnounceSiteOnSlack;
+use App\Services\Forge\Pipeline\CreateDaemons;
 use App\Services\Forge\Pipeline\CreateDatabase;
 use App\Services\Forge\Pipeline\CreateQueueWorkers;
 use App\Services\Forge\Pipeline\CreateWebhook;
@@ -62,6 +63,7 @@ public function handle(ForgeService $service): void
                 CreateWebhook::class,
                 RunOptionalCommands::class,
                 EnsureJobScheduled::class,
+                CreateDaemons::class,
                 CreateQueueWorkers::class,
                 PutCommentOnPullRequest::class,
                 AnnounceSiteOnSlack::class,

app/Commands/TearDownCommand.php

@@ -17,6 +17,7 @@
 use App\Services\Forge\Pipeline\DestroySite;
 use App\Services\Forge\Pipeline\FindServer;
 use App\Services\Forge\Pipeline\FindSiteOrFail;
+use App\Services\Forge\Pipeline\RemoveDaemons;
 use App\Services\Forge\Pipeline\RemoveDatabaseUser;
 use App\Services\Forge\Pipeline\RemoveExistingDeployKey;
 use App\Services\Forge\Pipeline\RemoveInertiaSupport;
@@ -43,6 +44,7 @@ public function handle(ForgeService $service): void
                 RunOptionalCommands::class,
                 RemoveDatabaseUser::class,
                 RemoveExistingDeployKey::class,
+                RemoveDaemons::class,
                 DestroySite::class,
             ])
             ->then(fn () => $this->success('Environment teardown successful! All provisioned resources have been removed.'));

app/Services/Forge/ForgeService.php

@@ -156,6 +156,9 @@ public function getSiteLink(): string
 
     public function siteDirectory(): string
     {
-        return sprintf('/home/%s/%s', $this->site->username, $this->site->name);
+        return Str::chopEnd(
+            subject: $this->site->attributes['web_directory'],
+            needle: $this->site->directory // usually only contains /public
+        );
     }
 }

app/Services/Forge/ForgeSetting.php

@@ -214,6 +214,11 @@ class ForgeSetting
      */
     public ?string $queueWorkers;
 
+    /**
+     * The daemons to create on new site installation
+     */
+    public ?string $daemons;
+
     public function __construct()
     {
         $this->init(config('forge'));
@@ -271,6 +276,7 @@ protected function validate(array $configurations): \Illuminate\Validation\Valid
             'inertia_ssr_enabled' => ['required', 'boolean'],
             'github_create_deploy_key' => ['required', 'boolean'],
             'queue_workers' => ['nullable', 'string'],
+            'daemons' => ['nullable', 'string'],
         ])->sometimes('git_provider', 'in:custom', function (Fluent $input) {
             return $input->github_create_deploy_key === true;
         });

app/Services/Forge/Pipeline/CreateDaemons.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Services\Forge\Pipeline;
+
+use App\Actions\LineBreaksToArray;
+use App\Actions\ParseDaemonCommands;
+use App\Services\Forge\ForgeService;
+use App\Traits\Outputifier;
+use Closure;
+
+class CreateDaemons
+{
+    use Outputifier;
+
+    public function __invoke(ForgeService $service, Closure $next)
+    {
+        if (! $service->setting->daemons || ! $service->siteNewlyMade) {
+            return $next($service);
+        }
+
+        $daemons = ParseDaemonCommands::run(
+            LineBreaksToArray::run($service->setting->daemons),
+        );
+
+        $this->information('Creating daemons.');
+
+        foreach ($daemons as $daemon) {
+            $service->forge->createDaemon(
+                serverId: $service->server->id,
+                data: array_merge(
+                    [
+                        // Defaults a daemon to run under the same user and directory as the current site.
+                        'user' => $service->site->username,
+                        'directory' => $service->siteDirectory(),
+                    ],
+                    $daemon
+                )
+            );
+        }
+
+        return $next($service);
+    }
+}

app/Services/Forge/Pipeline/CreateQueueWorkers.php

@@ -4,11 +4,11 @@
 
 namespace App\Services\Forge\Pipeline;
 
+use App\Actions\LineBreaksToArray;
 use App\Actions\ParseQueueCommands;
 use App\Services\Forge\ForgeService;
 use App\Traits\Outputifier;
 use Closure;
-use Illuminate\Support\Str;
 
 class CreateQueueWorkers
 {
@@ -21,12 +21,7 @@ public function __invoke(ForgeService $service, Closure $next)
         }
 
         $workers = ParseQueueCommands::run(
-            str($service->setting->queueWorkers)
-                ->explode("\n")
-                ->map(Str::squish(...))
-                ->filter()
-                ->values()
-                ->all()
+            LineBreaksToArray::run($service->setting->queueWorkers),
         );
 
         $this->information('Creating queue workers.');

app/Services/Forge/Pipeline/RemoveDaemons.php

@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Services\Forge\Pipeline;
+
+use App\Actions\LineBreaksToArray;
+use App\Actions\ParseDaemonCommands;
+use App\Services\Forge\ForgeService;
+use App\Services\Forge\ForgeSetting;
+use App\Traits\Outputifier;
+use Closure;
+use Illuminate\Support\Str;
+use Laravel\Forge\Resources\Daemon;
+
+class RemoveDaemons
+{
+    use Outputifier;
+
+    public function __invoke(ForgeService $service, Closure $next)
+    {
+        $daemons = $service->forge->daemons($service->server->id);
+
+        $this->information('Deleting daemons');
+
+        foreach ($daemons as $daemon) {
+            // If the daemon is running under the same user as the site in user isolation mode.
+            if ($service->setting->siteIsolationRequired && $daemon->user === $service->site->username) {
+                $service->forge->deleteDaemon($service->server->id, $daemon->id);
+                $this->information("--> Deleted daemon under user: {$daemon->command}");
+
+                continue;
+            }
+
+            // If the daemon is running from the same directory as the site.
+            if (Str::contains(haystack: $daemon->directory, needles: $service->siteDirectory())) {
+                $service->forge->deleteDaemon($service->server->id, $daemon->id);
+                $this->information("--> Deleted daemon under directory: {$daemon->command}");
+
+                continue;
+            }
+
+            // If a daemon can be detected as being one that was configured by us.
+            if ($this->daemonWasAddedForThisSite($daemon, $service->setting)) {
+                $service->forge->deleteDaemon($service->server->id, $daemon->id);
+                $this->information("--> Deleted daemon created with site: {$daemon->command}");
+            }
+        }
+
+        return $next($service);
+    }
+
+    protected function daemonWasAddedForThisSite(Daemon $daemon, ForgeSetting $setting): bool
+    {
+        if (empty($setting->daemons)) {
+            return false;
+        }
+
+        $configuredDaemons = ParseDaemonCommands::run(
+            LineBreaksToArray::run($setting->daemons),
+        );
+
+        return collect($configuredDaemons)->contains(
+            fn (array $configuredDaemon) => $configuredDaemon['command'] === $daemon->command
+                && $configuredDaemon['user'] === $daemon->user
+                && $configuredDaemon['directory'] === $daemon->directory
+        );
+    }
+}

app/Traits/CommandSyntax.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace App\Traits;
+
+use Illuminate\Console\Parser;
+use Symfony\Component\Console\Input\InputDefinition;
+use Symfony\Component\Console\Input\StringInput;
+
+trait CommandSyntax
+{
+    protected function input(string $command, InputDefinition $definition): StringInput
+    {
+        $input = new StringInput($command);
+        $input->bind($definition);
+
+        return $input;
+    }
+
+    protected function definition(string $signature): InputDefinition
+    {
+        [, $arguments, $options] = Parser::parse($signature);
+
+        $definition = new InputDefinition();
+        $definition->setArguments($arguments);
+        $definition->setOptions($options);
+
+        return $definition;
+    }
+}

config/forge.php

@@ -111,4 +111,7 @@
 
     // The queue workers to be added to Forge site
     'queue_workers' => env('FORGE_QUEUE_WORKERS'),
+
+    // The daemons to create on a Forge server
+    'daemons' => env('FORGE_DAEMONS'),
 ];