[Messenger] Reduce lock time when using MySQL for transport #60207

JanPaulBeumer · 2025-04-13T07:19:13Z

Q	A
Branch?	7.3
Bug fix?	no
New feature?	yes
Deprecations?	no
Issues	no
License	MIT

i experienced alot of lock wait time and some deadlocks on my database when working with multiple workers handling the same queue. so i fixed it in my application with a decorater. i want to contribute back to symfony.

introduce a algorithm in Connection for mysql platforms to minimize exclusive locking

[TODO list]

update pr description
let tests pass
discuss

introduce a algorithm in `Connection` for mysql platforms to minimize exclusive locking

carsonbot · 2025-04-13T07:19:16Z

Hey!

To help keep things organized, we don't allow "Draft" pull requests. Could you please click the "ready for review" button or close this PR and open a new one when you are done?

Note that a pull request does not have to be "perfect" or "ready for merge" when you first open it. We just want it to be ready for a first review.

Cheers!

Carsonbot

JanPaulBeumer · 2025-04-13T07:41:13Z

src/Symfony/Component/Messenger/Bridge/Doctrine/Transport/Connection.php

            try {
-                $this->driverConnection->delete($this->configuration['table_name'], ['delivered_at' => '9999-12-31 23:59:59']);


this made an exclusive lock on more than a row or record level. this is problematic since it blocks all other processes

JanPaulBeumer · 2025-04-13T07:47:52Z

src/Symfony/Component/Messenger/Bridge/Doctrine/Transport/Connection.php

+
+    private function getMessageForMySQLPlatform(): ?array
+    {
+        $possibleIdsToClaim = $this->createAvailableMessagesQueryBuilder()


fetch only ids till a message is claimed to not load all the payloads unnecessary (they can be huge)

JanPaulBeumer · 2025-04-13T07:48:17Z

src/Symfony/Component/Messenger/Bridge/Doctrine/Transport/Connection.php

+            return null;
+        }
+
+        $messageData = $this->createQueryBuilder()


load the data only for the claimed message

JanPaulBeumer · 2025-04-13T07:51:46Z

src/Symfony/Component/Messenger/Bridge/Doctrine/Transport/Connection.php

+
+        $claimed = $this->driverConnection->createQueryBuilder()
+                ->update($this->configuration['table_name'])
+                ->set('delivered_at', ':now')


this will invoke an exclusive lock on row/record level to ensure we wont have race conditions and multiple workers handling the same message.

either we can update the message, that means the message id has not been updated (delivered_at)
or we wont find the message to update and go on with the next message id we can try

JanPaulBeumer · 2025-04-13T07:53:18Z

src/Symfony/Component/Messenger/Bridge/Doctrine/Transport/Connection.php

+            $ids = $this->selectMessageIdsToDelete();
+            $this->driverConnection->createQueryBuilder()
+                ->delete($this->configuration['table_name'])
+                ->where('id IN (:ids)')


row/record level exclusive lock to not interfere with the selecting part

would it work to replace this by a subquery instead of doing a roundtrip to get the ids?

id rather not use subqueries. they are very often a cause of performance flaws

JanPaulBeumer · 2025-04-13T07:59:53Z

maybe someone competent enough in other platforms like oracle or postgres can decide if it should be adapted there aswell 🤷‍♂️

JanPaulBeumer · 2025-04-13T15:53:45Z

what do you think? shall we approach to merge this? then the tests must be fixed... should this be first controlled with a flag to have an opt in? to not possibly break anything?

src/Symfony/Component/Messenger/Bridge/Doctrine/Transport/Connection.php

nicolas-grekas · 2025-04-16T09:51:17Z

src/Symfony/Component/Messenger/Bridge/Doctrine/Transport/Connection.php

+            }
+        }
+
+        if (!isset($claimedId)) {


the var should be declared before

Suggested change

if (!isset($claimedId)) {

if (null === $claimedId) {

nicolas-grekas · 2025-04-16T09:52:40Z

src/Symfony/Component/Messenger/Bridge/Doctrine/Transport/Connection.php

+            $ids = $this->selectMessageIdsToDelete();
+            $this->driverConnection->createQueryBuilder()
+                ->delete($this->configuration['table_name'])
+                ->where('id IN (:ids)')


would it work to replace this by a subquery instead of doing a roundtrip to get the ids?

nicolas-grekas · 2025-04-16T09:53:05Z

src/Symfony/Component/Messenger/Bridge/Doctrine/Transport/Connection.php

+                Types::STRING,
+                Types::STRING,
+            ])
+            ->setMaxResults(5_000)


what if there are more?

no problem. each time one message gets claimed 5k are being deleted.

src/Symfony/Component/Messenger/Bridge/Doctrine/Transport/Connection.php

nicolas-grekas · 2025-04-16T09:54:14Z

src/Symfony/Component/Messenger/Bridge/Doctrine/Tests/Transport/ConnectionTest.php

@@ -668,46 +668,41 @@ public function testGeneratedSql(AbstractPlatform $platform, string $expectedSql
        $connection->get();
    }

-    public static function providePlatformSql(): iterable


it'd be nice to reduce the diff on this file, doable?

tbh no. i changed the algorithm and the queries. i tried to, but that was the best i could do here on the unit test

…ection.php Co-authored-by: Nicolas Grekas <[email protected]>

introduce a variable instead of checking isset.

rosier · 2025-04-23T15:39:42Z

src/Symfony/Component/Messenger/Bridge/Doctrine/Transport/Connection.php

+            }
+        }
+
+        if (!null === $claimedId) {


Suggested change

if (!null === $claimedId) {

if (null === $claimedId) {

Typo i gues

rosier · 2025-04-23T15:41:27Z

src/Symfony/Component/Messenger/Bridge/Doctrine/Transport/Connection.php

+
+        $claimedId = null;
+        foreach ($possibleIdsToClaim as $id) {
+            if (null === $claimedId = $this->claimMessage($id)) {


Suggested change

if (null === $claimedId = $this->claimMessage($id)) {

if (null !== $claimedId = $this->claimMessage($id)) {

[Messenger][Doctrine][Transport]

bc1fbeb

introduce a algorithm in `Connection` for mysql platforms to minimize exclusive locking

JanPaulBeumer commented Apr 13, 2025

View reviewed changes

JanPaulBeumer marked this pull request as ready for review April 13, 2025 07:54

carsonbot added Status: Needs Work Doctrine Messenger labels Apr 13, 2025

carsonbot added this to the 7.3 milestone Apr 13, 2025

carsonbot changed the title ~~[WIP] [Messenger][Doctrine][Transport] reduce lock time~~ [Doctrine][Messenger] [WIP] [Transport] reduce lock time Apr 13, 2025

JanPaulBeumer changed the title ~~[Doctrine][Messenger] [WIP] [Transport] reduce lock time~~ [WIP] [Doctrine][Messenger][Transport] reduce lock time Apr 13, 2025

JanPaulBeumer changed the title ~~[WIP] [Doctrine][Messenger][Transport] reduce lock time~~ [Doctrine][Messenger][Transport] reduce lock time Apr 13, 2025

wouterj added Status: Needs Review and removed Status: Needs Work labels Apr 14, 2025

carsonbot changed the title ~~[Doctrine][Messenger][Transport] reduce lock time~~ [Doctrine][Messenger] [Transport] reduce lock time Apr 14, 2025

nicolas-grekas reviewed Apr 16, 2025

View reviewed changes

nicolas-grekas removed the Doctrine label Apr 16, 2025

carsonbot changed the title ~~[Doctrine][Messenger] [Transport] reduce lock time~~ [Messenger] [Transport] reduce lock time Apr 16, 2025

nicolas-grekas changed the title ~~[Messenger] [Transport] reduce lock time~~ [Messenger] Reduce lock time when using MySQL for transport Apr 16, 2025

symfony deleted a comment from carsonbot Apr 16, 2025

JanPaulBeumer and others added 4 commits April 20, 2025 08:44

Update src/Symfony/Component/Messenger/Bridge/Doctrine/Transport/Conn…

ef84582

…ection.php Co-authored-by: Nicolas Grekas <[email protected]>

Update src/Symfony/Component/Messenger/Bridge/Doctrine/Transport/Conn…

110629a

…ection.php Co-authored-by: Nicolas Grekas <[email protected]>

Update src/Symfony/Component/Messenger/Bridge/Doctrine/Transport/Conn…

4259f68

…ection.php Co-authored-by: Nicolas Grekas <[email protected]>

[Messenger][Doctrine][Transport]

d5db0bf

introduce a variable instead of checking isset.

OskarStark added the Feature label Apr 20, 2025

rosier reviewed Apr 23, 2025

View reviewed changes

fabpot modified the milestones: 7.3, 7.4 May 26, 2025

		try {
		$this->driverConnection->delete($this->configuration['table_name'], ['delivered_at' => '9999-12-31 23:59:59']);

	if (null === $claimedId = $this->claimMessage($id)) {
	if (null !== $claimedId = $this->claimMessage($id)) {

Uh oh!

[Messenger] Reduce lock time when using MySQL for transport #60207

Are you sure you want to change the base?

[Messenger] Reduce lock time when using MySQL for transport #60207

Uh oh!

Conversation

JanPaulBeumer commented Apr 13, 2025 • edited by OskarStark Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

carsonbot commented Apr 13, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JanPaulBeumer commented Apr 13, 2025

Uh oh!

JanPaulBeumer commented Apr 13, 2025

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

JanPaulBeumer commented Apr 13, 2025 •

edited by OskarStark

Loading