Merge pull request #159 from TheDragonCode/6.x

The `$async` property moved to configuration file

Author: andrey-helldar

config/deploy-operations.php

@@ -77,6 +77,18 @@
 
     'exclude' => null,
 
+    /*
+    |--------------------------------------------------------------------------
+    | Asynchronous settings
+    |--------------------------------------------------------------------------
+    |
+    | Defines whether the operation will run synchronously or asynchronously.
+    |
+    | When this option is activated, each operation will be performed through jobs.
+    */
+
+    'async' => false,
+
     /*
     |--------------------------------------------------------------------------
     | Queue

docs/how-to-use/running.md

@@ -236,19 +236,22 @@ return new class extends Operation
 
 In some cases, it becomes necessary to execute operations in an asynchronous manner without delaying the deployment process.
 
-To do this, you need to override the `$async` property in the operation class:
+To do this, you need to override the `async` method in the operation class:
 
 ```php
 use DragonCode\LaravelDeployOperations\Operation;
 
 return new class extends Operation
 {
-    protected bool $async = true;
-
     public function __invoke(): void
     {
         // some code
     }
+
+    public function isAsync(): bool
+    {
+        return true;
+    }
 };
 ```
 

docs/prologue/upgrade-guide/6.x.md

@@ -13,6 +13,7 @@
 
 - [Changed directory location](#changed-directory-location)
 - [Removed database transaction properties](#removed-database-transaction-properties)
+- [Removed `$async` property](#removed-async-property)
 
 ## Low-Impact Changes
 
@@ -150,7 +151,10 @@ The following properties have been removed:
 
 Instead, you can use the previously available `enabledTransactions` and `transactionAttempts` methods.
 
-The default setting for these parameters has been moved to the `transactions` section of the configuration file.
+## Removed `$async` property
+
+The `$async` property has been removed from the base class.
+You can use the previously available `isAsync` method instead.
 
 ## Stub name changed
 

src/Operation.php

@@ -30,9 +30,6 @@ abstract class Operation
     /** Defines a possible "pre-launch" of the operation. */
     protected bool $before = true;
 
-    /** Defines whether the operation will run synchronously or asynchronously. */
-    protected bool $async = false;
-
     public function getConnection(): ?string
     {
         return config('deploy-operations.connection');
@@ -102,7 +99,7 @@ public function hasBefore(): bool
      */
     public function isAsync(): bool
     {
-        return $this->async;
+        return (bool) config('deploy-operations.async');
     }
 
     /**

tests/fixtures/app/async/2021_04_06_212742_every_time.php

@@ -8,8 +8,6 @@
 return new class extends Operation {
     protected bool $once = false;
 
-    protected bool $async = true;
-
     public function __invoke(): void
     {
         $this->table()->insert([
@@ -21,4 +19,9 @@ protected function table(): Builder
     {
         return DB::table('every_time');
     }
+
+    public function isAsync(): bool
+    {
+        return true;
+    }
 };

tests/fixtures/app/async/2023_04_06_212637_foo_bar.php

@@ -6,8 +6,6 @@
 use Ramsey\Uuid\Uuid;
 
 return new class extends Operation {
-    protected bool $async = true;
-
     public function __invoke(): void
     {
         $this->table()->insert([
@@ -19,4 +17,9 @@ protected function table(): Builder
     {
         return DB::table('test');
     }
+
+    public function isAsync(): bool
+    {
+        return true;
+    }
 };