bug #61091 [Lock] [MongoDB] Enforce readPreference=primary and writeConcern=majority (notrix)

fabpot · fabpot · commit 758082ae0e75 · 2025-07-12T11:41:03.000+02:00
This PR was squashed before being merged into the 6.4 branch. Discussion ---------- [Lock] [MongoDB] Enforce readPreference=primary and writeConcern=majority | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #58397 | License | MIT ### The Problem A scenario was identified, similar to issue #58397, where a lock cannot be successfully released. This occurs when the application: 1. Provides a MongoDB Collection to the `MongoDbStore` with `readPreference` set to `primary`. 2. Has a default `readPreference` of `nearest` configured on the MongoDB manager. When `release()` is called on a lock, the component first issues a `DELETE` command to the primary MongoDB node. Immediately after, it sends a query to verify the deletion. However, this verification query incorrectly uses the `nearest` read preference from the Doctrine connection, often hitting a secondary node. If replication to the secondary has not yet completed, the verification fails, and an exception is thrown, incorrectly reporting that the lock release failed. ### The Solution This update enforces `readPreference`=`primary` for and `writeConcern`=`majority`. This ensures that read and write operations related to the lock are consistently routed, preventing the race condition and ensuring reliable lock releases. Commits ------- f0c00db [Lock] [MongoDB] Enforce readPreference=primary and writeConcern=majority
diff --git a/src/Symfony/Component/Lock/Store/MongoDbStore.php b/src/Symfony/Component/Lock/Store/MongoDbStore.php
@@ -20,6 +20,8 @@
 use MongoDB\Driver\Exception\BulkWriteException;
 use MongoDB\Driver\Manager;
 use MongoDB\Driver\Query;
+use MongoDB\Driver\ReadPreference;
+use MongoDB\Driver\WriteConcern;
 use MongoDB\Exception\DriverRuntimeException;
 use MongoDB\Exception\InvalidArgumentException as MongoInvalidArgumentException;
 use MongoDB\Exception\UnsupportedException;
@@ -61,9 +63,9 @@ class MongoDbStore implements PersistingStoreInterface
     private float $initialTtl;
 
     /**
-     * @param Collection|Client|Manager|string $mongo      An instance of a Collection or Client or URI @see https://docs.mongodb.com/manual/reference/connection-string/
-     * @param array                            $options    See below
-     * @param float                            $initialTtl The expiration delay of locks in seconds
+     * @param Collection|Database|Client|Manager|string $mongo      An instance of a Collection or Client or URI @see https://docs.mongodb.com/manual/reference/connection-string/
+     * @param array                                     $options    See below
+     * @param float                                     $initialTtl The expiration delay of locks in seconds
      *
      * @throws InvalidArgumentException If required options are not provided
      * @throws InvalidTtlException      When the initial ttl is not valid
@@ -89,8 +91,10 @@ class MongoDbStore implements PersistingStoreInterface
      * to 0.0 and optionally leverage
      * self::createTtlIndex(int $expireAfterSeconds = 0).
      *
-     * writeConcern and readConcern are not specified by MongoDbStore meaning the connection's settings will take effect.
-     * readPreference is primary for all queries.
+     * readConcern is not specified by MongoDbStore meaning the connection's settings will take effect.
+     * writeConcern is majority for all update queries.
+     * readPreference is primary for all read queries.
+     *
      * @see https://docs.mongodb.com/manual/applications/replication/
      */
     public function __construct(Collection|Database|Client|Manager|string $mongo, array $options = [], float $initialTtl = 300.0)
@@ -286,7 +290,11 @@ public function delete(Key $key)
             ['limit' => 1]
         );
 
-        $this->getManager()->executeBulkWrite($this->namespace, $write);
+        $this->getManager()->executeBulkWrite(
+            $this->namespace,
+            $write,
+            ['writeConcern' => new WriteConcern(WriteConcern::MAJORITY)]
+        );
     }
 
     public function exists(Key $key): bool
@@ -303,7 +311,9 @@ public function exists(Key $key): bool
                 'limit' => 1,
                 'projection' => ['_id' => 1],
             ]
-        ));
+        ), [
+            'readPreference' => new ReadPreference(ReadPreference::PRIMARY)
+        ]);
 
         return [] !== $cursor->toArray();
     }
@@ -345,7 +355,11 @@ private function upsert(Key $key, float $ttl): void
             ]
         );
 
-        $this->getManager()->executeBulkWrite($this->namespace, $write);
+        $this->getManager()->executeBulkWrite(
+            $this->namespace,
+            $write,
+            ['writeConcern' => new WriteConcern(WriteConcern::MAJORITY)]
+        );
     }
 
     private function isDuplicateKeyException(BulkWriteException $e): bool
