Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

[Messenger] Remove indices in messenger table on MySQL to prevent deadlocks while removing messages when running multiple consumers #42345

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.

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

Conversation

jeroennoten
Copy link
Contributor

@jeroennoten jeroennoten commented Aug 2, 2021

SELECT ... FOR UPDATE locks rows but also relevant indices. Since locking rows and indices is not one atomic operation,
this might cause deadlocks when running multiple workers. Removing indices on queue_name and available_at
resolves this problem.

Q A
Branch? 4.4
Bug fix? yes
New feature? no
Deprecations? no
Tickets Fix #41541 #39041
License MIT

Using Doctrine transport with multiple consumers occasionally results in MySQL deadlocks while removing a message from the messages database table.

This can be reproduced consistently by setting up a default async queue with the Doctrine transport and creating an empty TestMessage and TestMessageHandler. Create a command that dispatches 10000 of these messages in a for loop en start 4 message consumers. After a while, several consumers report a deadlock:

In Connection.php line 227:
                                                                                                                   
  [Symfony\Component\Messenger\Exception\TransportException]                                                       
  An exception occurred while executing 'DELETE FROM messenger_messages WHERE id = ?' with params ["32903"]:       
                                                                                                                   
  SQLSTATE[40001]: Serialization failure: 1213 Deadlock found when trying to get lock; try restarting transaction  
                                                                                                                   

Exception trace:
  at /var/www/vendor/symfony/messenger/Transport/Doctrine/Connection.php:227
 Symfony\Component\Messenger\Transport\Doctrine\Connection->ack() at /var/www/vendor/symfony/messenger/Transport/Doctrine/DoctrineReceiver.php:79
 Symfony\Component\Messenger\Transport\Doctrine\DoctrineReceiver->ack() at /var/www/vendor/symfony/messenger/Transport/Doctrine/DoctrineTransport.php:50
 Symfony\Component\Messenger\Transport\Doctrine\DoctrineTransport->ack() at /var/www/vendor/symfony/messenger/Worker.php:150
 Symfony\Component\Messenger\Worker->handleMessage() at /var/www/vendor/symfony/messenger/Worker.php:81
 Symfony\Component\Messenger\Worker->run() at /var/www/vendor/symfony/messenger/Command/ConsumeMessagesCommand.php:202
 Symfony\Component\Messenger\Command\ConsumeMessagesCommand->execute() at /var/www/vendor/symfony/console/Command/Command.php:255
 Symfony\Component\Console\Command\Command->run() at /var/www/vendor/symfony/console/Application.php:1027
 Symfony\Component\Console\Application->doRunCommand() at /var/www/vendor/symfony/framework-bundle/Console/Application.php:97
 Symfony\Bundle\FrameworkBundle\Console\Application->doRunCommand() at /var/www/vendor/symfony/console/Application.php:273
 Symfony\Component\Console\Application->doRun() at /var/www/vendor/symfony/framework-bundle/Console/Application.php:83
 Symfony\Bundle\FrameworkBundle\Console\Application->doRun() at /var/www/vendor/symfony/console/Application.php:149
 Symfony\Component\Console\Application->run() at /var/www/bin/console:42

A similar problem with Laravel's queue worker (and a solution) is reported here: laravel/framework#31660

The solution is to remove indices on the queue_name and available_at columns. After removing these indices, I could not reproduce the issue anymore. Also, I did not notice any performance degradations.

@fabpot
Copy link
Member

fabpot commented Aug 26, 2021

IIUC, this issue only exists on MySQL. It this is the case, the change should only be done for MySQL and not for all database engines.

@jeroennoten jeroennoten force-pushed the feature/remove-index-from-messenger-database-table branch 3 times, most recently from 790721a to ee0c97b Compare August 26, 2021 10:30
@jeroennoten
Copy link
Contributor Author

@fabpot, you are right. To be sure, I tested with PostgreSQL and I could not reproduce the issues there.

So I changed this to only apply to MySQL. I also added a unit test for these changes.

@jeroennoten jeroennoten changed the title [Messenger] Remove indices in messenger table to prevent deadlocks while removing messages when running multiple consumers [Messenger] Remove indices in messenger table on MySQL to prevent deadlocks while removing messages when running multiple consumers Aug 26, 2021
@jeroennoten jeroennoten force-pushed the feature/remove-index-from-messenger-database-table branch 2 times, most recently from 364079e to f7cc0b1 Compare August 26, 2021 10:55
… removing messages when running multiple consumers

SELECT ... FOR UPDATE row locks also locks indices. Since locking rows and indices is not one atomic operation,
this might cause deadlocks when running multiple workers. Removing indices on queue_name and available_at
resolves this problem.
@jeroennoten jeroennoten force-pushed the feature/remove-index-from-messenger-database-table branch from f7cc0b1 to 8c3c0a3 Compare August 26, 2021 10:55
@jeroennoten jeroennoten requested a review from fabpot August 26, 2021 11:00
@fabpot
Copy link
Member

fabpot commented Aug 26, 2021

Thank you @jeroennoten.

@fabpot fabpot merged commit 7080940 into symfony:4.4 Aug 26, 2021
This was referenced Aug 30, 2021
@bobvandevijver
Copy link
Contributor

Thank you @jeroennoten, I just saw this exact error in production for the very first time this weekend. Very nice to see it has already been resolved!

@jeroennoten
Copy link
Contributor Author

@bobvandevijver, you're welcome!

Don't forget to run bin/console messenger:setup-transports after updating Symfony to the latest version to apply these changes to the database. The command will update the existing table or create a new one if it does not exist.

@jeroennoten jeroennoten deleted the feature/remove-index-from-messenger-database-table branch August 30, 2021 15:16
@bobvandevijver
Copy link
Contributor

We're using migrations to define the table, but thanks for the tip!

@palttamas
Copy link

palttamas commented Sep 3, 2021

@jeroennoten removing the indexes fixes the lock issue but caused us significant performance issues. I was searching the issues and it seems to me that multiple consumers are not working very well for others either, be it redis or doctrine transport, no matter.

@nicolas-grekas
Copy link
Member

I'm proposing to revert this PR and replace it by another approach in #45888

nicolas-grekas added a commit that referenced this pull request Mar 31, 2022
…ks using soft-delete (nicolas-grekas)

This PR was merged into the 4.4 branch.

Discussion
----------

[Messenger] Add mysql indexes back and work around deadlocks using soft-delete

| Q             | A
| ------------- | ---
| Branch?       | 4.4
| Bug fix?      | yes
| New feature?  | no
| Deprecations? | no
| Tickets       | Fix #42868
| License       | MIT
| Doc PR        | -

#42345 removed some indexes because they create too many deadlocks when running many concurrent consumers.
Yet, as reported in the linked issue, those indexes are useful when processing large queues (typically the failed messages queue).

#45007 is proposing to add an option to force the indexes back, but I don't like it because it requires ppl to learn about the issue. I looked for a more seamless solution and here is my proposal.

Instead of possibly triggering the deadlock during `ack()`/`reject()`, I propose to use a soft-delete there, and do the real delete in `get()`. This makes ack/reject safe because they don't alter any indexes anymore (the delete was), and this moves deadlock exceptions to the same function that creates the locks. This allows the retry mechanism in `DoctrineReceiver` to recover from at most 3 consecutive deadlock exceptions. There can be more, and in this case, the consumer will stop. But this should be much less likely.

(yes, I did create a reproducer to work on this issue ;) )

Commits
-------

12271a4 [Messenger] Add mysql indexes back and work around deadlocks using soft-delete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.