Merge pull request #105 from TheDragonCode/3.x

[3.x] Isolating Action Execution

Author: andrey-helldar

config/actions.php

@@ -24,7 +24,7 @@
     |
     */
 
-    'table' => 'migration_actions',
+    'table'      => 'migration_actions',
 
     /*
     |--------------------------------------------------------------------------
@@ -35,7 +35,7 @@
     |
     */
 
-    'path' => base_path('actions'),
+    'path'       => base_path('actions'),
 
     /*
     |--------------------------------------------------------------------------
@@ -56,5 +56,5 @@
     |
     */
 
-    'exclude' => null,
+    'exclude'    => null,
 ];

docs/how-to-use/running.md

@@ -22,6 +22,18 @@ bar/2022_10_14_000003_test3  # 3
 2022_10_14_000004_test4      # 4
 ```
 
+## Isolating Action Execution
+
+If you are deploying your application across multiple servers and running migrations as part of your deployment process, you likely do not want two servers attempting to migrate
+the database at the same time. To avoid this, you may use the `isolated` option when invoking the `migrate:actions` command.
+
+When the `isolated` option is provided, Laravel will acquire an atomic lock using your application's cache driver before attempting to run your migrations. All other attempts to
+run the `migrate:actions` command while that lock is held will not execute; however, the command will still exit with a successful exit status code:
+
+```bash
+php artisan migrate:actions --isolated
+```
+
 ## Split Launch Option
 
 Sometimes it becomes necessary to launch actions separately, for example, to notify about the successful deployment of a project.
@@ -39,7 +51,7 @@ For backwards compatibility, the `before` parameter is set to `true` by default,
 ```php
 use DragonCode\LaravelActions\Action;
 
-return new class () extends Action
+return new class extends Action
 {
     protected $before = false;
 
@@ -95,7 +107,7 @@ To do this, override the `$once` variable in the action file:
 ```php
 use DragonCode\LaravelActions\Action;
 
-return new class () extends Action
+return new class extends Action
 {
     protected $once = false;
 
@@ -123,7 +135,7 @@ For this you can use the `$environment` parameter:
 ```php
 use DragonCode\LaravelActions\Action;
 
-return new class () extends Action
+return new class extends Action
 {
     /** @var string|array|null */
     protected $environment = 'production';
@@ -140,7 +152,7 @@ You can also specify multiple environment names:
 ```php
 use DragonCode\LaravelActions\Action;
 
-return new class () extends Action
+return new class extends Action
 {
     /** @var string|array|null */
     protected $environment = ['testing', 'staging'];
@@ -163,7 +175,7 @@ For this you can use the `$except_environment` parameter:
 ```php
 use DragonCode\LaravelActions\Action;
 
-return new class () extends Action
+return new class extends Action
 {
     /** @var string|array|null */
     protected $exceptEnvironment = 'production';
@@ -180,7 +192,7 @@ You can also specify multiple environment names:
 ```php
 use DragonCode\LaravelActions\Action;
 
-return new class () extends Action
+return new class extends Action
 {
     /** @var string|array|null */
     protected $exceptEnvironment = ['testing', 'staging'];
@@ -205,7 +217,7 @@ will reduce the time it takes to create the action.
 ```php
 use DragonCode\LaravelActions\Action;
 
-return new class () extends Action
+return new class extends Action
 {
     protected $transactions = true;
 

src/Concerns/Isolatable.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\LaravelActions\Concerns;
+
+use DragonCode\LaravelActions\Constants\Options;
+use DragonCode\LaravelActions\Services\Mutex;
+
+trait Isolatable
+{
+    protected function isolationMutex(): Mutex
+    {
+        return $this->getLaravel()->make(Mutex::class);
+    }
+
+    protected function isolatedStatusCode(): int
+    {
+        if ($isolate = $this->getIsolateOption()) {
+            return is_numeric($isolate) ? $isolate : self::SUCCESS;
+        }
+
+        return self::SUCCESS;
+    }
+
+    protected function getIsolateOption(): int|bool
+    {
+        return $this->hasIsolateOption() ? $this->option(Options::ISOLATED) : false;
+    }
+
+    protected function hasIsolateOption(): bool
+    {
+        return $this->hasOption(Options::ISOLATED) && $this->option(Options::ISOLATED);
+    }
+}

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', false],
         ];
     }
 

src/Console/Command.php

@@ -5,15 +5,19 @@
 namespace DragonCode\LaravelActions\Console;
 
 use DragonCode\LaravelActions\Concerns\ConfirmableTrait;
+use DragonCode\LaravelActions\Concerns\Isolatable;
 use DragonCode\LaravelActions\Concerns\Optionable;
 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 +28,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->getIsolateOption() !== false && ! $this->isolationMutex()->create($this)) {
+            $this->comment(sprintf('The [%s] command is already running.', $this->getName()));
+
+            return $this->isolatedStatusCode();
+        }
+
+        try {
+            return parent::execute($input, $output);
+        }
+        finally {
+            if ($this->getIsolateOption() !== false) {
+                $this->isolationMutex()->forget($this);
+            }
+        }
     }
 
     protected function resolveProcessor(): Processor

src/Console/Fresh.php

@@ -23,5 +23,6 @@ class Fresh extends Command
         Options::PATH,
         Options::REALPATH,
         Options::MUTE,
+        Options::ISOLATED,
     ];
 }

src/Console/Migrate.php

@@ -23,5 +23,6 @@ class Migrate extends Command
         Options::PATH,
         Options::REALPATH,
         Options::MUTE,
+        Options::ISOLATED,
     ];
 }

src/Console/Refresh.php

@@ -21,5 +21,6 @@ class Refresh extends Command
         Options::PATH,
         Options::REALPATH,
         Options::MUTE,
+        Options::ISOLATED,
     ];
 }

src/Console/Reset.php

@@ -21,5 +21,6 @@ class Reset extends Command
         Options::PATH,
         Options::REALPATH,
         Options::MUTE,
+        Options::ISOLATED,
     ];
 }

src/Console/Rollback.php

@@ -22,5 +22,6 @@ class Rollback extends Command
         Options::REALPATH,
         Options::STEP,
         Options::MUTE,
+        Options::ISOLATED,
     ];
 }