Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[10.x] After commit callback throwing an exception causes transaction level to be incorrect #50087

Closed
wants to merge 2 commits into from
Closed

[10.x] After commit callback throwing an exception causes transaction level to be incorrect #50087

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c823b0
Fix after commit callback throwing an exception causing the transacti…
oprypkhantc Feb 14, 2024
6464b3f
Extract level being committed
oprypkhantc Feb 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions src/Illuminate/Database/Concerns/ManagesTransactions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,22 +41,15 @@ public function transaction(Closure $callback, $attempts = 1)
continue;
}

$levelBeingCommitted = $this->transactions;

try {
if ($this->transactions == 1) {
$this->fireConnectionEvent('committing');
$this->getPdo()->commit();
}

[$levelBeingCommitted, $this->transactions] = [
$this->transactions,
max(0, $this->transactions - 1),
];

$this->transactionsManager?->commit(
$this->getName(),
$levelBeingCommitted,
$this->transactions
);
$this->transactions = max(0, $this->transactions - 1);
} catch (Throwable $e) {
$this->handleCommitTransactionException(
$e, $currentAttempt, $attempts
Expand All @@ -65,6 +58,12 @@ public function transaction(Closure $callback, $attempts = 1)
continue;
}

$this->transactionsManager?->commit(
$this->getName(),
$levelBeingCommitted,
oprypkhantc marked this conversation as resolved.
Show resolved Hide resolved
$this->transactions
);

$this->fireConnectionEvent('committed');

return $callbackResult;
Expand Down
52 changes: 52 additions & 0 deletions tests/Integration/Database/EloquentTransactionWithAfterCommitTests.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,45 @@ public function testObserverIsCalledEvenWhenDeeplyNestingTransactions()
$this->assertTrue($user1->exists);
$this->assertEquals(1, $observer::$calledTimes, 'Failed to assert the observer was called once.');
}

public function testTransactionCallbackExceptions()
{
[$firstObject, $secondObject] = [
new EloquentTransactionWithAfterCommitTestsTestObjectForTransactions(),
new EloquentTransactionWithAfterCommitTestsTestObjectForTransactions(),
];

$rootTransactionLevel = DB::transactionLevel();

// After commit callbacks may fail with an exception. When they do, the rest of the callbacks are not
// executed. It's important that the transaction would already be committed by that point, so the
// transaction level should be modified before executing any callbacks. Also, exceptions in the
// callbacks should not affect the connection's transaction level.
$this->assertThrows(function () use ($rootTransactionLevel, $secondObject, $firstObject) {
DB::transaction(function () use ($rootTransactionLevel, $firstObject, $secondObject) {
DB::transaction(function () use ($rootTransactionLevel, $firstObject) {
$this->assertSame($rootTransactionLevel + 2, DB::transactionLevel());

DB::afterCommit(function () use ($rootTransactionLevel, $firstObject) {
$this->assertSame($rootTransactionLevel, DB::transactionLevel());

$firstObject->handle();
});
});

$this->assertSame($rootTransactionLevel + 1, DB::transactionLevel());

DB::afterCommit(fn () => throw new \RuntimeException());
DB::afterCommit(fn () => $secondObject->handle());
});
}, \RuntimeException::class);

$this->assertSame($rootTransactionLevel, DB::transactionLevel());

$this->assertTrue($firstObject->ran);
$this->assertFalse($secondObject->ran);
$this->assertEquals(1, $firstObject->runs);
}
}

class EloquentTransactionWithAfterCommitTestsUserObserver
Expand Down Expand Up @@ -150,3 +189,16 @@ public function handle(): void
});
}
}

class EloquentTransactionWithAfterCommitTestsTestObjectForTransactions
{
public $ran = false;

public $runs = 0;

public function handle()
{
$this->ran = true;
$this->runs++;
}
}
Loading