Added asynchronous actions

Author: andrey-helldar

composer.json

@@ -71,7 +71,10 @@
     "autoload": {
         "psr-4": {
             "DragonCode\\LaravelActions\\": "src"
-        }
+        },
+        "classmap": [
+            "polyfill"
+        ]
     },
     "autoload-dev": {
         "psr-4": {

config/actions.php

@@ -24,7 +24,7 @@
     |
     */
 
-    'table'      => 'actions',
+    'table' => 'actions',
 
     /*
     |--------------------------------------------------------------------------
@@ -35,7 +35,7 @@
     |
     */
 
-    'path'       => base_path('actions'),
+    'path' => base_path('actions'),
 
     /*
     |--------------------------------------------------------------------------
@@ -56,5 +56,25 @@
     |
     */
 
-    'exclude'    => null,
+    'exclude' => null,
+
+    /*
+    |--------------------------------------------------------------------------
+    | Queue
+    |--------------------------------------------------------------------------
+    |
+    | This option specifies the queue settings that will process
+    | asynchronous actions.
+    |
+    */
+
+    'queue' => [
+        // Connection name
+
+        'connection' => env('ACTIONS_QUEUE_CONNECTION', env('QUEUE_CONNECTION', 'sync')),
+
+        // Queue name
+
+        'name' => env('ACTIONS_QUEUE_NAME'),
+    ],
 ];

docs/how-to-use/running.md

@@ -229,3 +229,33 @@ return new class extends Action
     }
 };
 ```
+
+## Asynchronous Call
+
+In some cases, it becomes necessary to execute actions in an asynchronous manner without delaying the deployment process.
+
+To do this, you need to override the `$async` property in the action class:
+
+```php
+use DragonCode\LaravelActions\Action;
+
+return new class extends Action
+{
+    protected bool $async = true;
+
+    public function __invoke(): void
+    {
+        // some code
+    }
+};
+```
+
+In this case, the action file that defines this parameter will run asynchronously using the `DragonCode\LaravelActions\Jobs\ActionJob` class.
+
+The name of the connection and queue can be changed through the [settings](https://github.com/TheDragonCode/laravel-actions/tree/main/config).
+
+::: Info
+We remind you that in this case the [queuing system](https://laravel.com/docs/queues) must work in your application.
+
+Using Laravel version 8.37 and above, checking for the [uniqueness](https://laravel.com/docs/10.x/queues#unique-jobs) of the execution is supported.
+:::

polyfill/ShouldBeUnique.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Illuminate\Contracts\Queue;
+
+if (! interface_exists(ShouldBeUnique::class)) {
+    interface ShouldBeUnique
+    {
+    }
+}

src/Action.php

@@ -57,6 +57,13 @@ abstract class Action extends Migration
      */
     protected bool $before = true;
 
+    /**
+     * Defines whether the action will run synchronously or asynchronously.
+     *
+     * @var bool
+     */
+    protected bool $async = false;
+
     /**
      * Determines the type of launch of the action.
      *
@@ -130,6 +137,16 @@ public function hasBefore(): bool
         return $this->before;
     }
 
+    /**
+     * Defines whether the action will run synchronously or asynchronously.
+     *
+     * @return bool
+     */
+    public function isAsync(): bool
+    {
+        return $this->async;
+    }
+
     /**
      * Method to be called when the job completes successfully.
      *

src/Concerns/Optionable.php

@@ -51,6 +51,7 @@ protected function availableOptions(): array
             [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],
+            [Options::SYNC, null, InputOption::VALUE_OPTIONAL, 'Makes all actions run synchronously', false],
         ];
     }
 

src/Console/Actions.php

@@ -24,5 +24,6 @@ class Actions extends Command
         Options::REALPATH,
         Options::MUTE,
         Options::ISOLATED,
+        Options::SYNC,
     ];
 }

src/Constants/Options.php

@@ -23,4 +23,6 @@ class Options
     public const REALPATH = 'realpath';
 
     public const STEP = 'step';
+
+    public const SYNC = 'sync';
 }

src/Jobs/ActionJob.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\LaravelActions\Jobs;
+
+use DragonCode\LaravelActions\Constants\Names;
+use DragonCode\LaravelActions\Constants\Options;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldBeUnique;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Support\Facades\Artisan;
+
+class ActionJob implements ShouldQueue, ShouldBeUnique
+{
+    use Dispatchable;
+    use InteractsWithQueue;
+    use Queueable;
+    use SerializesModels;
+
+    public function __construct(
+        public string $filename
+    ) {
+        $this->setQueueConnection();
+        $this->setQueueName();
+    }
+
+    public function handle(): void
+    {
+        Artisan::call(Names::ACTIONS, [
+            '--' . Options::PATH => $this->filename,
+            '--' . Options::SYNC => true,
+        ]);
+    }
+
+    public function uniqueId(): string
+    {
+        return $this->filename;
+    }
+
+    protected function setQueueConnection(): void
+    {
+        $this->onConnection(config('actions.queue.connection'));
+    }
+
+    protected function setQueueName(): void
+    {
+        $this->onQueue(config('actions.queue.name'));
+    }
+}

src/Notifications/Beautiful.php

@@ -36,10 +36,10 @@ public function task(string $description, Closure $task): void
     {
         if ($this->canSpeak()) {
             $this->components()->task($description, $task);
-            
+
             return;
         }
-        
+
         $task();
     }