WIP: Add isolated option

Author: andrey-helldar

src/Concerns/Isolatable.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\LaravelActions\Concerns;
+
+use DragonCode\LaravelActions\Constants\Options;
+use DragonCode\LaravelActions\Services\Mutex;
+
+trait Isolatable
+{
+    protected function isolationCreate(): bool
+    {
+        return $this->isolationMutex()->create($this);
+    }
+
+    protected function isolationForget(): void
+    {
+        $this->isolationMutex()->forget($this);
+    }
+
+    protected function isolationMutex(): Mutex
+    {
+        return $this->getLaravel()->make(Mutex::class);
+    }
+
+    protected function isolatedStatusCode(): int
+    {
+        return (int) (is_numeric($this->option(Options::ISOLATED)) ? $this->option(Options::ISOLATED) : self::SUCCESS);
+    }
+}

src/Concerns/Optionable.php

@@ -18,6 +18,7 @@ trait Optionable
         Options::CONNECTION,
         Options::FORCE,
         Options::MUTE,
+        Options::ISOLATED,
     ];
 
     protected function configure(): void
@@ -49,6 +50,7 @@ protected function availableOptions(): array
             [Options::REALPATH, null, InputOption::VALUE_NONE, 'Indicate any provided action file paths are pre-resolved absolute path'],
             [Options::STEP, null, InputOption::VALUE_OPTIONAL, 'Force the actions to be run so they can be rolled back individually'],
             [Options::MUTE, null, InputOption::VALUE_NONE, 'Turns off the output of informational messages'],
+            [Options::ISOLATED, null, InputOption::VALUE_OPTIONAL, 'Do not run the actions command if another instance of the actions command is already running'],
         ];
     }
 

src/Console/Command.php

@@ -5,15 +5,20 @@
 namespace DragonCode\LaravelActions\Console;
 
 use DragonCode\LaravelActions\Concerns\ConfirmableTrait;
+use DragonCode\LaravelActions\Concerns\Isolatable;
 use DragonCode\LaravelActions\Concerns\Optionable;
+use DragonCode\LaravelActions\Constants\Options;
 use DragonCode\LaravelActions\Processors\Processor;
 use DragonCode\LaravelActions\Values\Options as OptionsDto;
 use Illuminate\Console\Command as BaseCommand;
 use Illuminate\Container\Container;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
 
 abstract class Command extends BaseCommand
 {
     use ConfirmableTrait;
+    use Isolatable;
     use Optionable;
 
     protected Processor|string $processor;
@@ -24,10 +29,28 @@ public function handle(): int
             $this->resolveProcessor()->handle();
             $this->forgetProcessor();
 
-            return 0;
+            return self::SUCCESS;
         }
 
-        return 1;
+        return self::FAILURE;
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        if ($this->option(Options::ISOLATED) !== false && ! $this->isolationCreate()) {
+            $this->comment(sprintf('The [%s] command is already running.', $this->getName()));
+
+            return $this->isolatedStatusCode();
+        }
+
+        try {
+            return parent::execute($input, $output);
+        }
+        finally {
+            if ($this->option(Options::ISOLATED) !== false) {
+                $this->isolationForget();
+            }
+        }
     }
 
     protected function resolveProcessor(): Processor

src/Constants/Options.php

@@ -12,6 +12,8 @@ class Options
 
     public const FORCE = 'force';
 
+    public const ISOLATED = 'isolated';
+
     public const MUTE = 'mute';
 
     public const NAME = 'name';

src/Services/Mutex.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\LaravelActions\Services;
+
+use Carbon\CarbonInterval;
+use DragonCode\LaravelActions\Console\Command;
+use Illuminate\Contracts\Cache\Factory as Cache;
+use Illuminate\Contracts\Cache\Repository;
+
+class Mutex
+{
+    protected ?string $store = null;
+
+    public function __construct(
+        protected Cache $cache
+    ) {
+    }
+
+    public function create(Command $command): bool
+    {
+        return $this->store()->add($this->name($command), true, $this->ttl());
+    }
+
+    public function forget(Command $command): void
+    {
+        $this->store()->forget(
+            $this->name($command)
+        );
+    }
+
+    protected function store(): Repository
+    {
+        return $this->cache->store($this->store);
+    }
+
+    protected function ttl(): CarbonInterval
+    {
+        return CarbonInterval::hour();
+    }
+
+    protected function name(Command $command): string
+    {
+        return 'framework' . DIRECTORY_SEPARATOR . 'action-' . $command->getName();
+    }
+}