Merge pull request #158 from TheDragonCode/6.x

Database transaction settings moved to configuration file

Author: andrey-helldar

config/deploy-operations.php

@@ -26,6 +26,25 @@
 
     'table' => 'operations',
 
+    /*
+    |--------------------------------------------------------------------------
+    | Database Transations
+    |--------------------------------------------------------------------------
+    |
+    | This setting defines the rules for working with database transactions.
+    | This specifies a common value for all operations, but you can override this
+    | value directly in the class of the operation itself.
+    */
+
+    'transactions' => [
+        // | Determines whether the use of database transactions is enabled.
+
+        'enabled' => false,
+
+        // | The number of attempts to execute a request within a transaction before throwing an error.
+        'attempts' => 1,
+    ],
+
     /*
     |--------------------------------------------------------------------------
     | Operations Path

docs/how-to-use/running.md

@@ -215,14 +215,20 @@ use DragonCode\LaravelDeployOperations\Operation;
 
 return new class extends Operation
 {
-    protected bool $transactions = true;
-
-    protected int $transactionAttempts = 3;
-
     public function __invoke(): void
     {
         // some code
     }
+
+    public function enabledTransactions(): bool
+    {
+        return true;
+    }
+
+    public function transactionAttempts(): int
+    {
+        return 4;
+    }
 };
 ```
 

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

@@ -11,7 +11,8 @@
 
 ## Minor-Impact Changes
 
-- [Changed file location](#changed-file-location)
+- [Changed directory location](#changed-directory-location)
+- [Removed database transaction properties](#removed-database-transaction-properties)
 
 ## Low-Impact Changes
 
@@ -136,10 +137,21 @@ class Names
 }
 ```
 
-## Changed file location
+## Changed directory location
 
 File storage directory changed to `operations` from `actions`.
 
+## Removed database transaction properties
+
+The following properties have been removed:
+
+- `$transactions`
+- `$transactionAttempts`
+
+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.
+
 ## Stub name changed
 
 If you published a stub file, then you also need to rename it from `stubs/action.stub` to `stubs/deploy-operation.stub`

src/Operation.php

@@ -17,16 +17,6 @@ abstract class Operation
      */
     protected bool $once = true;
 
-    /**
-     * Determines a call to database transactions.
-     *
-     * By default, false.
-     */
-    protected bool $transactions = false;
-
-    /** The number of attempts to execute a request within a transaction before throwing an error. */
-    protected int $transactionAttempts = 1;
-
     /**
      * Determines which environment to run on.
      */
@@ -64,15 +54,15 @@ public function isOnce(): bool
      */
     public function enabledTransactions(): bool
     {
-        return $this->transactions;
+        return (bool) config('deploy-operations.transactions.enabled');
     }
 
     /**
      * The number of attempts to execute a request within a transaction before throwing an error.
      */
     public function transactionAttempts(): int
     {
-        return $this->transactionAttempts;
+        return config('deploy-operations.transactions.attempts', 1);
     }
 
     /**

tests/fixtures/app/stubs/2021_02_15_124237_test_success_transactions.stub

@@ -5,8 +5,6 @@ use Illuminate\Support\Facades\DB;
 use Ramsey\Uuid\Uuid;
 
 return new class extends Operation {
-    protected bool $transactions = true;
-
     public function up(): void
     {
         $this->table()->insert([
@@ -16,6 +14,11 @@ return new class extends Operation {
         ]);
     }
 
+    public function enabledTransactions(): bool
+    {
+        return true;
+    }
+
     protected function table()
     {
         return DB::table('transactions');

tests/fixtures/app/stubs/2021_02_15_124852_test_failed_transactions.stub

@@ -5,8 +5,6 @@ use Illuminate\Support\Facades\DB;
 use Ramsey\Uuid\Uuid;
 
 return new class extends Operation {
-    protected bool $transactions = true;
-
     public function up(): void
     {
         $this->table()->insert([
@@ -18,6 +16,11 @@ return new class extends Operation {
         throw new Exception('Random message');
     }
 
+    public function enabledTransactions(): bool
+    {
+        return true;
+    }
+
     protected function table()
     {
         return DB::table('transactions');