Correctly re-throw exception when callback attempts have been exceeded.

Author: alcaeus

src/Concerns/ManagesTransactions.php

@@ -6,6 +6,7 @@
 use MongoDB\Client;
 use MongoDB\Driver\Exception\RuntimeException;
 use MongoDB\Driver\Session;
+use Throwable;
 use function MongoDB\with_transaction;
 
 /**
@@ -83,8 +84,9 @@ public function transaction(Closure $callback, $attempts = 1, array $options = [
     {
         $attemptsLeft = $attempts;
         $callbackResult = null;
+        $throwable = null;
 
-        $callbackFunction = function (Session $session) use ($callback, &$attemptsLeft, &$callbackResult) {
+        $callbackFunction = function (Session $session) use ($callback, &$attemptsLeft, &$callbackResult, &$throwable) {
             $attemptsLeft--;
 
             if ($attemptsLeft < 0) {
@@ -93,11 +95,22 @@ public function transaction(Closure $callback, $attempts = 1, array $options = [
                 return;
             }
 
-            $callbackResult = $callback($this);
+            // Catch, store and re-throw any exception thrown during execution
+            // of the callable. The last exception is re-thrown if the transaction
+            // was aborted because the number of callback attempts has been exceeded.
+            try {
+                $callbackResult = $callback($this);
+            } catch (Throwable $throwable) {
+                throw $throwable;
+            }
         };
 
         with_transaction($this->getSessionOrCreate(), $callbackFunction, $options);
 
+        if ($attemptsLeft < 0 && $throwable) {
+            throw $throwable;
+        }
+
         return $callbackResult;
     }
 }

tests/TransactionTest.php

@@ -4,6 +4,7 @@
 use Jenssegers\Mongodb\Connection;
 use Jenssegers\Mongodb\Eloquent\Model;
 use MongoDB\BSON\ObjectId;
+use MongoDB\Driver\Exception\BulkWriteException;
 use MongoDB\Driver\Server;
 
 class TransactionTest extends TestCase
@@ -317,6 +318,8 @@ public function testTransaction(): void
     {
         User::create(['name' => 'klinson', 'age' => 20, 'title' => 'admin']);
 
+        // The $connection parameter may be unused, but is implicitly used to
+        // test that the closure is executed with the connection as an argument.
         DB::transaction(function (Connection $connection): void {
             User::create(['name' => 'alcaeus', 'age' => 38, 'title' => 'admin']);
             User::where(['name' => 'klinson'])->update(['age' => 21]);
@@ -336,14 +339,18 @@ public function testTransactionRepeatsOnTransientFailure(): void
         $timesRun = 0;
 
         DB::transaction(function () use (&$timesRun): void {
-            User::where(['name' => 'klinson'])->update(['age' => 21]);
+            $timesRun++;
+
+            // Run a query to start the transaction on the server
+            User::create(['name' => 'alcaeus', 'age' => 38, 'title' => 'admin']);
 
-            // Update user during transaction to simulate a simultaneous update
-            if ($timesRun == 0) {
+            // Update user outside of the session
+            if ($timesRun == 1) {
                 DB::getCollection('users')->updateOne(['name' => 'klinson'], ['$set' => ['age' => 22]]);
             }
 
-            $timesRun++;
+            // This update will create a write conflict, aborting the transaction
+            User::where(['name' => 'klinson'])->update(['age' => 21]);
         }, 2);
 
         $this->assertSame(2, $timesRun);
@@ -356,14 +363,25 @@ public function testTransactionRespectsRepetitionLimit(): void
 
         $timesRun = 0;
 
-        DB::transaction(function () use (&$timesRun): void {
-            User::where(['name' => 'klinson'])->update(['age' => 21]);
+        try {
+            DB::transaction(function () use (&$timesRun): void {
+                $timesRun++;
 
-            // Update user during transaction to simulate a simultaneous update
-            DB::getCollection('users')->updateOne(['name' => 'klinson'], ['$inc' => ['age' => 2]]);
+                // Run a query to start the transaction on the server
+                User::create(['name' => 'alcaeus', 'age' => 38, 'title' => 'admin']);
 
-            $timesRun++;
-        }, 2);
+                // Update user outside of the session
+                DB::getCollection('users')->updateOne(['name' => 'klinson'], ['$inc' => ['age' => 2]]);
+
+                // This update will create a write conflict, aborting the transaction
+                User::where(['name' => 'klinson'])->update(['age' => 21]);
+            }, 2);
+
+            $this->fail('Expected exception during transaction');
+        } catch (BulkWriteException $e) {
+            $this->assertInstanceOf(BulkWriteException::class, $e);
+            $this->assertStringContainsString('WriteConflict', $e->getMessage());
+        }
 
         $this->assertSame(2, $timesRun);