Скачать или смотреть How to Ensure your Laravel Event Listeners are Queued for Asynchronous Execution

A comprehensive guide on configuring Laravel event listeners so that they are queued correctly for asynchronous processing.
---
This video is based on the question https://stackoverflow.com/q/67619237/ asked by the user 'Viacheslav Zhabonos' ( https://stackoverflow.com/u/6496434/ ) and on the answer https://stackoverflow.com/a/67621585/ provided by the user 'Viacheslav Zhabonos' ( https://stackoverflow.com/u/6496434/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: Laravel 8.24 listeners/events doesn't adds to queue

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Implementing Asynchronous Email Notifications in Laravel

When building applications, especially those that involve sending notifications, there arises a need for efficient processing. In Laravel, leveraging the built-in event and listener system allows us to handle these tasks effectively. However, one common issue developers face is ensuring that their listeners are correctly queued for asynchronous execution instead of being processed synchronously. This guide will guide you through resolving this issue by ensuring that your Laravel 8.24 event listeners and notifications are queued properly.

The Problem

You may have set up your events and listeners to implement email notifications for certain actions in your application. You may also want these notifications processed asynchronously by utilizing a database queue. However, after configuring everything correctly, you notice that instead of queuing the job for later processing, the email notifications are being sent synchronously. This can lead to performance bottlenecks, especially when the event triggers involve heavy processing.

Here’s a case study based on real code:

An event named NewServerReviewVote is created when a user votes on a server review.

A listener SendNewServerReviewVoteNotification is supposed to send an email notification to the review author.

Expectations were set to have the job added to the jobs database table, processed asynchronously using php artisan queue:work, but it resulted in synchronous email sending.

The Solution

To resolve the issue of event listeners not being queued, follow these organized steps:

Step 1: Ensure Listener Implements ShouldQueue

The listener class must implement the ShouldQueue interface. This tells Laravel that the listener should be executed in the queue rather than immediately.

Example code:

[[See Video to Reveal this Text or Code Snippet]]

Step 2: Specify the Queue Connection (If Necessary)

In some cases, even though you implement ShouldQueue, the listeners might still not get queued. To solve this, you can specify the connection explicitly by adding a public property in your listener class.

Example:

[[See Video to Reveal this Text or Code Snippet]]

Including this property ensures that the listener is dispatched to the database queue.

Step 3: Modify the Notification Class

In the case where the notification does not need to be queued, it does not have to implement the ShouldQueue interface. It can simply use the Queueable trait instead.

Updated Notification Example:

[[See Video to Reveal this Text or Code Snippet]]

Conclusion

After making sure your listener implements ShouldQueue, specifying the $connection property, and modifying your notification class, you’ll find that events are now dispatched correctly into the queue. This change allows you to run php artisan queue:work and process these notifications asynchronously.

By following these steps, you ensure that your application remains responsive, especially when dealing with multiple notifications or time-consuming tasks. Don't forget to check your jobs table to confirm that jobs are being queued correctly!

Implementing asynchronous processing is a game-changer in application performance, making it essential to follow the above guidelines to harness the full power of Laravel’s queuing system.