Fix "w" option

doctrine · Mar 10, 2021 · 116f6ac · 116f6ac
1 parent a88db3e
commit 116f6ac
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 7 deletions.
diff --git a/lib/Doctrine/ODM/MongoDB/Configuration.php b/lib/Doctrine/ODM/MongoDB/Configuration.php
@@ -21,6 +21,7 @@
 use Doctrine\Persistence\Mapping\Driver\MappingDriver;
 use Doctrine\Persistence\ObjectRepository;
 use InvalidArgumentException;
+use MongoDB\Driver\WriteConcern;
 use ProxyManager\Configuration as ProxyManagerConfiguration;
 use ProxyManager\Factory\LazyLoadingGhostFactory;
 use ProxyManager\GeneratorStrategy\EvaluatingGeneratorStrategy;
@@ -347,7 +348,7 @@ public function getClassMetadataFactoryName(): string
 
     public function getDefaultCommitOptions(): array
     {
-        return $this->attributes['defaultCommitOptions'] ?? ['w' => 1];
+        return $this->attributes['defaultCommitOptions'] ?? ['writeConcern' => new WriteConcern(1)];
     }
 
     public function setDefaultCommitOptions(array $defaultCommitOptions): void

diff --git a/lib/Doctrine/ODM/MongoDB/Persisters/DocumentPersister.php b/lib/Doctrine/ODM/MongoDB/Persisters/DocumentPersister.php
@@ -32,13 +32,15 @@
 use MongoDB\Driver\Cursor;
 use MongoDB\Driver\Exception\Exception as DriverException;
 use MongoDB\Driver\Exception\WriteException;
+use MongoDB\Driver\WriteConcern;
 use MongoDB\GridFS\Bucket;
 use ProxyManager\Proxy\GhostObjectInterface;
 use stdClass;
 
 use function array_combine;
 use function array_fill;
 use function array_intersect_key;
+use function array_key_exists;
 use function array_keys;
 use function array_map;
 use function array_merge;
@@ -61,6 +63,9 @@
 use function sprintf;
 use function strpos;
 use function strtolower;
+use function trigger_error;
+
+use const E_USER_DEPRECATED;
 
 /**
  * The DocumentPersister is responsible for persisting documents.
@@ -1493,10 +1498,17 @@ private function getWriteOptions(array $options = []): array
         $defaultOptions  = $this->dm->getConfiguration()->getDefaultCommitOptions();
         $documentOptions = [];
         if ($this->class->hasWriteConcern()) {
-            $documentOptions['w'] = $this->class->getWriteConcern();
+            $documentOptions['writeConcern'] = new WriteConcern($this->class->getWriteConcern());
+        }
+
+        $writeOptions = array_merge($defaultOptions, $documentOptions, $options);
+        if (array_key_exists('w', $writeOptions)) {
+            @trigger_error(sprintf('The "w" option as commit option is deprecated, please pass %s object.', WriteConcern::class), E_USER_DEPRECATED);
+            $writeOptions['writeConcern'] = new WriteConcern($writeOptions['w']);
+            unset($writeOptions['w']);
         }
 
-        return array_merge($defaultOptions, $documentOptions, $options);
+        return $writeOptions;
     }
 
     private function prepareReference(string $fieldName, $value, array $mapping, bool $inNewObj): array

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Functional/DocumentPersisterTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Functional/DocumentPersisterTest.php
@@ -19,6 +19,7 @@
 use MongoDB\BSON\ObjectId;
 use MongoDB\BSON\UTCDateTime;
 use MongoDB\Collection;
+use MongoDB\Driver\WriteConcern;
 use ReflectionProperty;
 
 use function get_class;
@@ -644,7 +645,7 @@ public function testExecuteInsertsRespectsWriteConcern($class, $writeConcern)
         $collection = $this->createMock(Collection::class);
         $collection->expects($this->once())
             ->method('insertMany')
-            ->with($this->isType('array'), $this->logicalAnd($this->arrayHasKey('w'), $this->containsEqual($writeConcern)));
+            ->with($this->isType('array'), $this->logicalAnd($this->arrayHasKey('writeConcern'), $this->containsEqual(new WriteConcern($writeConcern))));
 
         $reflectionProperty = new ReflectionProperty($documentPersister, 'collection');
         $reflectionProperty->setAccessible(true);
@@ -668,7 +669,7 @@ public function testExecuteUpsertsRespectsWriteConcern($class, $writeConcern)
         $collection = $this->createMock(Collection::class);
         $collection->expects($this->once())
             ->method('updateOne')
-            ->with($this->isType('array'), $this->isType('array'), $this->logicalAnd($this->arrayHasKey('w'), $this->containsEqual($writeConcern)));
+            ->with($this->isType('array'), $this->isType('array'), $this->logicalAnd($this->arrayHasKey('writeConcern'), $this->containsEqual(new WriteConcern($writeConcern))));
 
         $reflectionProperty = new ReflectionProperty($documentPersister, 'collection');
         $reflectionProperty->setAccessible(true);
@@ -693,7 +694,7 @@ public function testRemoveRespectsWriteConcern($class, $writeConcern)
         $collection = $this->createMock(Collection::class);
         $collection->expects($this->once())
             ->method('deleteOne')
-            ->with($this->isType('array'), $this->logicalAnd($this->arrayHasKey('w'), $this->containsEqual($writeConcern)));
+            ->with($this->isType('array'), $this->logicalAnd($this->arrayHasKey('writeConcern'), $this->containsEqual(new WriteConcern($writeConcern))));
 
         $reflectionProperty = new ReflectionProperty($documentPersister, 'collection');
         $reflectionProperty->setAccessible(true);
@@ -715,7 +716,28 @@ public function testDefaultWriteConcernIsRespected()
         $collection = $this->createMock(Collection::class);
         $collection->expects($this->once())
             ->method('insertMany')
-            ->with($this->isType('array'), $this->equalTo(['w' => 0]));
+            ->with($this->isType('array'), $this->equalTo(['writeConcern' => new WriteConcern(0)]));
+
+        $reflectionProperty = new ReflectionProperty($documentPersister, 'collection');
+        $reflectionProperty->setAccessible(true);
+        $reflectionProperty->setValue($documentPersister, $collection);
+
+        $this->dm->getConfiguration()->setDefaultCommitOptions(['writeConcern' => new WriteConcern(0)]);
+
+        $testDocument = new $class();
+        $this->dm->persist($testDocument);
+        $this->dm->flush();
+    }
+
+    public function testDefaultWriteConcernIsRespectedBackwardCompatibility()
+    {
+        $class             = DocumentPersisterTestDocument::class;
+        $documentPersister = $this->uow->getDocumentPersister($class);
+
+        $collection = $this->createMock(Collection::class);
+        $collection->expects($this->once())
+            ->method('insertMany')
+            ->with($this->isType('array'), $this->equalTo(['writeConcern' => new WriteConcern(0)]));
 
         $reflectionProperty = new ReflectionProperty($documentPersister, 'collection');
         $reflectionProperty->setAccessible(true);