Dispatch Events after a DB Transaction in Laravel 10.30

This week, the Laravel team released v10.30, which includes the ability to dispatch events based on a database transaction result. This week's release saw a lot of minor fixes, added tests, and miscellaneous changes. See the changelog for a complete list of updates.

Dispatch events based on a DB transaction result

Mateus Guimarães and Taylor Otwell collaborated on dispatching an event based on the result of an in-progress database transaction:

What this PR aims to do is to make the event itself aware of transactions. So, if a transaction fails, the event doesn't even get published. That way, it doesn't matter if the listeners are queued or not or if they have afterCommit enabled, and you can ensure, in the tests, that the event did not get published.

Thanks to this contribution, you can now add the ShouldDispatchAfterCommit interface to an event, which instructs the event dispatcher to hold off on dispatching the event until the transaction is committed; if the transaction is rolled back, the event does not fire.

Here's a contrived example of how it might work—given the following transaction and dispatch amid the transaction:

DB::beginTransaction();
 
Log::info("Transaction started");
$order = Order::create(['amount' => 5000]);
 
// More stuff...
 
Log::info("Dispatching OrderCreated event");
OrderCreated::dispatch($order);
 
Log::info("Closing transaction");
DB::commit();

Here's what the logs might look like:

local.INFO: Transaction started
local.INFO: Dispatching OrderCreated event
local.INFO: Closing transaction
local.INFO: Order created event handled...

And finally, the event might look like the following:

use Illuminate\Contracts\Events\ShouldDispatchAfterCommit;
 
class OrderCreated implements ShouldDispatchAfterCommit
{
    // ...
}

Along with ShouldDispatchAfterCommit, the pull request expanded to include other interfaces like ShouldHandleEventsAfterCommit for listeners and ShouldQueueAfterCommit, which may be implemented on jobs, listeners, mail, and notifications.

Test Improvements

Mior Muhammad Zaki contributed test improvements, getting Laravel compatible with the future release of PHPUnit 11—see Pull Request #48815 for details.

Release notes

You can see the complete list of new features and updates below and the diff between 10.29.0 and 10.30.1 on GitHub. The following release notes are directly from the changelog:

v10.30.1

• [10.x] Fix postgreSQL reserved word column names w/ guarded attributes broken in native column attributes implementation by @hafezdivandari in https://github.com/laravel/framework/pull/48877

v10.30.0

• [10.x] Test Improvements by @crynobone in https://github.com/laravel/framework/pull/48815
• [10.x] Verify hash config by @timacdonald in https://github.com/laravel/framework/pull/48814
• [10.x] Fix the issue of using the now function within the ArrayCache in Lumen by @cxlblm in https://github.com/laravel/framework/pull/48826
• [10.x] Match service provider after resolved by @timacdonald in https://github.com/laravel/framework/pull/48824
• [10.x] Fix type error registering PSR Request by @kpicaza in https://github.com/laravel/framework/pull/48823
• [10.x] Ability to configure default session block timeouts by @bytestream in https://github.com/laravel/framework/pull/48795
• [10.x] Improvements for artisan migrate --pretend command 🚀 by @NickSdot in https://github.com/laravel/framework/pull/48768
• [10.x] Add support for getting native columns' attributes by @hafezdivandari in https://github.com/laravel/framework/pull/48357
• fix(Eloquent/Builder): calling the methods on passthru base object should be case-insensitive by @luka-papez in https://github.com/laravel/framework/pull/48852
• [10.x] Fix QueriesRelationships[@getRelationHashedColumn](https://github.com/getRelationHashedColumn)() typehint by @cosmastech in https://github.com/laravel/framework/pull/48847
• [10.x] Remember the job on the exception by @timacdonald in https://github.com/laravel/framework/pull/48830
• fix bug for always throwing exception when we pass a callable to throwUnlessStatus method [test included] by @mhfereydouni in https://github.com/laravel/framework/pull/48844
• [10.x] Dispatch events based on a DB transaction result by @mateusjatenee in https://github.com/laravel/framework/pull/48705
• [10.x] Reset ShouldDispatchAfterCommitEventTest objects properties by @mateusjatenee in https://github.com/laravel/framework/pull/48858
• [10.x] Throw exception when trying to escape array for database connection by @sidneyprins in https://github.com/laravel/framework/pull/48836
• [10.x] Fix Stringable objects not converted to string in HTTP facade Query parameters and Body by @LasseRafn in https://github.com/laravel/framework/pull/48849