PHPLIB-261: Omit default read and write concern from commands

jmikola · jmikola · commit 236657b5ce89 · 2017-09-14T13:55:08.000-04:00
diff --git a/src/Operation/Aggregate.php b/src/Operation/Aggregate.php
@@ -182,6 +182,14 @@ public function __construct($databaseName, $collectionName, array $pipeline, arr
             throw new InvalidArgumentException('"typeMap" option should not be used if "useCursor" is false');
         }
 
+        if (isset($options['readConcern']) && $options['readConcern']->isDefault()) {
+            unset($options['readConcern']);
+        }
+
+        if (isset($options['writeConcern']) && $options['writeConcern']->isDefault()) {
+            unset($options['writeConcern']);
+        }
+
         $this->databaseName = (string) $databaseName;
         $this->collectionName = (string) $collectionName;
         $this->pipeline = $pipeline;
diff --git a/src/Operation/BulkWrite.php b/src/Operation/BulkWrite.php
@@ -266,6 +266,10 @@ public function __construct($databaseName, $collectionName, array $operations, a
             throw InvalidArgumentException::invalidType('"writeConcern" option', $options['writeConcern'], 'MongoDB\Driver\WriteConcern');
         }
 
+        if (isset($options['writeConcern']) && $options['writeConcern']->isDefault()) {
+            unset($options['writeConcern']);
+        }
+
         $this->databaseName = (string) $databaseName;
         $this->collectionName = (string) $collectionName;
         $this->operations = $operations;
diff --git a/src/Operation/Count.php b/src/Operation/Count.php
@@ -117,6 +117,10 @@ public function __construct($databaseName, $collectionName, $filter = [], array
             throw InvalidArgumentException::invalidType('"skip" option', $options['skip'], 'integer');
         }
 
+        if (isset($options['readConcern']) && $options['readConcern']->isDefault()) {
+            unset($options['readConcern']);
+        }
+
         $this->databaseName = (string) $databaseName;
         $this->collectionName = (string) $collectionName;
         $this->filter = $filter;
diff --git a/src/Operation/CreateCollection.php b/src/Operation/CreateCollection.php
@@ -157,6 +157,10 @@ public function __construct($databaseName, $collectionName, array $options = [])
             throw InvalidArgumentException::invalidType('"writeConcern" option', $options['writeConcern'], 'MongoDB\Driver\WriteConcern');
         }
 
+        if (isset($options['writeConcern']) && $options['writeConcern']->isDefault()) {
+            unset($options['writeConcern']);
+        }
+
         $this->databaseName = (string) $databaseName;
         $this->collectionName = (string) $collectionName;
         $this->options = $options;
diff --git a/src/Operation/CreateIndexes.php b/src/Operation/CreateIndexes.php
@@ -96,6 +96,10 @@ public function __construct($databaseName, $collectionName, array $indexes, arra
             throw InvalidArgumentException::invalidType('"writeConcern" option', $options['writeConcern'], 'MongoDB\Driver\WriteConcern');
         }
 
+        if (isset($options['writeConcern']) && $options['writeConcern']->isDefault()) {
+            unset($options['writeConcern']);
+        }
+
         $this->databaseName = (string) $databaseName;
         $this->collectionName = (string) $collectionName;
         $this->options = $options;
diff --git a/src/Operation/Delete.php b/src/Operation/Delete.php
@@ -83,6 +83,10 @@ public function __construct($databaseName, $collectionName, $filter, $limit, arr
             throw InvalidArgumentException::invalidType('"writeConcern" option', $options['writeConcern'], 'MongoDB\Driver\WriteConcern');
         }
 
+        if (isset($options['writeConcern']) && $options['writeConcern']->isDefault()) {
+            unset($options['writeConcern']);
+        }
+
         $this->databaseName = (string) $databaseName;
         $this->collectionName = (string) $collectionName;
         $this->filter = $filter;
diff --git a/src/Operation/Distinct.php b/src/Operation/Distinct.php
@@ -93,6 +93,10 @@ public function __construct($databaseName, $collectionName, $fieldName, $filter
             throw InvalidArgumentException::invalidType('"readPreference" option', $options['readPreference'], 'MongoDB\Driver\ReadPreference');
         }
 
+        if (isset($options['readConcern']) && $options['readConcern']->isDefault()) {
+            unset($options['readConcern']);
+        }
+
         $this->databaseName = (string) $databaseName;
         $this->collectionName = (string) $collectionName;
         $this->fieldName = (string) $fieldName;
diff --git a/src/Operation/DropCollection.php b/src/Operation/DropCollection.php
@@ -69,6 +69,10 @@ public function __construct($databaseName, $collectionName, array $options = [])
             throw InvalidArgumentException::invalidType('"writeConcern" option', $options['writeConcern'], 'MongoDB\Driver\WriteConcern');
         }
 
+        if (isset($options['writeConcern']) && $options['writeConcern']->isDefault()) {
+            unset($options['writeConcern']);
+        }
+
         $this->databaseName = (string) $databaseName;
         $this->collectionName = (string) $collectionName;
         $this->options = $options;
diff --git a/src/Operation/DropDatabase.php b/src/Operation/DropDatabase.php
@@ -66,6 +66,10 @@ public function __construct($databaseName, array $options = [])
             throw InvalidArgumentException::invalidType('"writeConcern" option', $options['writeConcern'], 'MongoDB\Driver\WriteConcern');
         }
 
+        if (isset($options['writeConcern']) && $options['writeConcern']->isDefault()) {
+            unset($options['writeConcern']);
+        }
+
         $this->databaseName = (string) $databaseName;
         $this->options = $options;
     }
diff --git a/src/Operation/DropIndexes.php b/src/Operation/DropIndexes.php
@@ -75,6 +75,10 @@ public function __construct($databaseName, $collectionName, $indexName, array $o
             throw InvalidArgumentException::invalidType('"writeConcern" option', $options['writeConcern'], 'MongoDB\Driver\WriteConcern');
         }
 
+        if (isset($options['writeConcern']) && $options['writeConcern']->isDefault()) {
+            unset($options['writeConcern']);
+        }
+
         $this->databaseName = (string) $databaseName;
         $this->collectionName = (string) $collectionName;
         $this->indexName = $indexName;
diff --git a/src/Operation/Find.php b/src/Operation/Find.php
@@ -190,6 +190,10 @@ public function __construct($databaseName, $collectionName, $filter, array $opti
             throw InvalidArgumentException::invalidType('"typeMap" option', $options['typeMap'], 'array');
         }
 
+        if (isset($options['readConcern']) && $options['readConcern']->isDefault()) {
+            unset($options['readConcern']);
+        }
+
         $this->databaseName = (string) $databaseName;
         $this->collectionName = (string) $collectionName;
         $this->filter = $filter;
diff --git a/src/Operation/FindAndModify.php b/src/Operation/FindAndModify.php
@@ -157,6 +157,10 @@ public function __construct($databaseName, $collectionName, array $options)
             throw new InvalidArgumentException('The "remove" option must be true or an "update" document must be specified, but not both');
         }
 
+        if (isset($options['writeConcern']) && $options['writeConcern']->isDefault()) {
+            unset($options['writeConcern']);
+        }
+
         $this->databaseName = (string) $databaseName;
         $this->collectionName = (string) $collectionName;
         $this->options = $options;
diff --git a/src/Operation/InsertMany.php b/src/Operation/InsertMany.php
@@ -97,6 +97,10 @@ public function __construct($databaseName, $collectionName, array $documents, ar
             throw InvalidArgumentException::invalidType('"writeConcern" option', $options['writeConcern'], 'MongoDB\Driver\WriteConcern');
         }
 
+        if (isset($options['writeConcern']) && $options['writeConcern']->isDefault()) {
+            unset($options['writeConcern']);
+        }
+
         $this->databaseName = (string) $databaseName;
         $this->collectionName = (string) $collectionName;
         $this->documents = $documents;
diff --git a/src/Operation/InsertOne.php b/src/Operation/InsertOne.php
@@ -73,6 +73,10 @@ public function __construct($databaseName, $collectionName, $document, array $op
             throw InvalidArgumentException::invalidType('"writeConcern" option', $options['writeConcern'], 'MongoDB\Driver\WriteConcern');
         }
 
+        if (isset($options['writeConcern']) && $options['writeConcern']->isDefault()) {
+            unset($options['writeConcern']);
+        }
+
         $this->databaseName = (string) $databaseName;
         $this->collectionName = (string) $collectionName;
         $this->document = $document;
diff --git a/src/Operation/MapReduce.php b/src/Operation/MapReduce.php
@@ -203,6 +203,14 @@ public function __construct($databaseName, $collectionName, Javascript $map, Jav
             throw InvalidArgumentException::invalidType('"writeConcern" option', $options['writeConcern'], 'MongoDB\Driver\WriteConcern');
         }
 
+        if (isset($options['readConcern']) && $options['readConcern']->isDefault()) {
+            unset($options['readConcern']);
+        }
+
+        if (isset($options['writeConcern']) && $options['writeConcern']->isDefault()) {
+            unset($options['writeConcern']);
+        }
+
         $this->databaseName = (string) $databaseName;
         $this->collectionName = (string) $collectionName;
         $this->map = $map;
diff --git a/src/Operation/Update.php b/src/Operation/Update.php
@@ -117,6 +117,10 @@ public function __construct($databaseName, $collectionName, $filter, $update, ar
             throw InvalidArgumentException::invalidType('"writeConcern" option', $options['writeConcern'], 'MongoDB\Driver\WriteConcern');
         }
 
+        if (isset($options['writeConcern']) && $options['writeConcern']->isDefault()) {
+            unset($options['writeConcern']);
+        }
+
         $this->databaseName = (string) $databaseName;
         $this->collectionName = (string) $collectionName;
         $this->filter = $filter;
diff --git a/tests/CommandObserver.php b/tests/CommandObserver.php
@@ -0,0 +1,44 @@
+<?php
+
+namespace MongoDB\Tests;
+
+use MongoDB\Driver\Monitoring\CommandFailedEvent;
+use MongoDB\Driver\Monitoring\CommandStartedEvent;
+use MongoDB\Driver\Monitoring\CommandSucceededEvent;
+use MongoDB\Driver\Monitoring\CommandSubscriber;
+
+/**
+ * Observes command documents using the driver's monitoring API.
+ */
+class CommandObserver implements CommandSubscriber
+{
+    private $commands = [];
+
+    public function observe(callable $execution, callable $commandCallback)
+    {
+        $this->commands = [];
+
+        \MongoDB\Driver\Monitoring\addSubscriber($this);
+
+        call_user_func($execution);
+
+        \MongoDB\Driver\Monitoring\removeSubscriber($this);
+
+        foreach ($this->commands as $command) {
+            call_user_func($commandCallback, $command);
+        }
+    }
+
+    public function commandStarted(CommandStartedEvent $event)
+    {
+        $this->commands[] = $event->getCommand();
+    }
+
+    public function commandSucceeded(CommandSucceededEvent $event)
+    {
+    }
+
+    public function commandFailed(CommandFailedEvent $event)
+    {
+    }
+}
diff --git a/tests/Operation/AggregateFunctionalTest.php b/tests/Operation/AggregateFunctionalTest.php
@@ -4,11 +4,55 @@
 
 use MongoDB\Driver\BulkWrite;
 use MongoDB\Operation\Aggregate;
+use MongoDB\Tests\CommandObserver;
+use stdClass;
 
 class AggregateFunctionalTest extends FunctionalTestCase
 {
     private static $wireVersionForCursor = 2;
 
+    public function testDefaultReadConcernIsOmitted()
+    {
+        (new CommandObserver)->observe(
+            function() {
+                $operation = new Aggregate(
+                    $this->getDatabaseName(),
+                    $this->getCollectionName(),
+                    [['$match' => ['x' => 1]]],
+                    ['readConcern' => $this->createDefaultReadConcern()]
+                );
+
+                $operation->execute($this->getPrimaryServer());
+            },
+            function(stdClass $command) {
+                $this->assertObjectNotHasAttribute('readConcern', $command);
+            }
+        );
+    }
+
+    public function testDefaultWriteConcernIsOmitted()
+    {
+        if (version_compare($this->getServerVersion(), '2.6.0', '<')) {
+            $this->markTestSkipped('$out pipeline operator is not supported');
+        }
+
+        (new CommandObserver)->observe(
+            function() {
+                $operation = new Aggregate(
+                    $this->getDatabaseName(),
+                    $this->getCollectionName(),
+                    [['$out' => $this->getCollectionName() . '.output']],
+                    ['writeConcern' => $this->createDefaultWriteConcern()]
+                );
+
+                $operation->execute($this->getPrimaryServer());
+            },
+            function(stdClass $command) {
+                $this->assertObjectNotHasAttribute('writeConcern', $command);
+            }
+        );
+    }
+
     /**
      * @expectedException MongoDB\Driver\Exception\RuntimeException
      */
diff --git a/tests/Operation/CountFunctionalTest.php b/tests/Operation/CountFunctionalTest.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace MongoDB\Tests\Operation;
+
+use MongoDB\Operation\Count;
+use MongoDB\Tests\CommandObserver;
+use stdClass;
+
+class CountFunctionalTest extends FunctionalTestCase
+{
+    public function testDefaultReadConcernIsOmitted()
+    {
+        (new CommandObserver)->observe(
+            function() {
+                $operation = new Count(
+                    $this->getDatabaseName(),
+                    $this->getCollectionName(),
+                    [],
+                    ['readConcern' => $this->createDefaultReadConcern()]
+                );
+
+                $operation->execute($this->getPrimaryServer());
+            },
+            function(stdClass $command) {
+                $this->assertObjectNotHasAttribute('readConcern', $command);
+            }
+        );
+    }
+}
diff --git a/tests/Operation/CreateCollectionFunctionalTest.php b/tests/Operation/CreateCollectionFunctionalTest.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace MongoDB\Tests\Operation;
+
+use MongoDB\Operation\CreateCollection;
+use MongoDB\Tests\CommandObserver;
+use stdClass;
+
+class CreateCollectionFunctionalTest extends FunctionalTestCase
+{
+    public function testDefaultWriteConcernIsOmitted()
+    {
+        (new CommandObserver)->observe(
+            function() {
+                $operation = new CreateCollection(
+                    $this->getDatabaseName(),
+                    $this->getCollectionName(),
+                    ['writeConcern' => $this->createDefaultWriteConcern()]
+                );
+
+                $operation->execute($this->getPrimaryServer());
+            },
+            function(stdClass $command) {
+                $this->assertObjectNotHasAttribute('writeConcern', $command);
+            }
+        );
+    }
+}
diff --git a/tests/Operation/CreateIndexesFunctionalTest.php b/tests/Operation/CreateIndexesFunctionalTest.php
@@ -6,7 +6,9 @@
 use MongoDB\Operation\CreateIndexes;
 use MongoDB\Operation\DropIndexes;
 use MongoDB\Operation\ListIndexes;
+use MongoDB\Tests\CommandObserver;
 use InvalidArgumentException;
+use stdClass;
 
 class CreateIndexesFunctionalTest extends FunctionalTestCase
 {
@@ -157,6 +159,32 @@ public function testCreateConflictingIndexesWithLegacyInsert()
         });
     }
 
+    public function testDefaultWriteConcernIsOmitted()
+    {
+        /* Earlier server versions do not support the createIndexes command. Per
+         * the Index Management specification, inserts on system.indexes must
+         * use the write concern {w:1}. */
+        if (version_compare($this->getServerVersion(), '2.6.0', '<')) {
+            $this->markTestSkipped('createIndexes command is not supported');
+        }
+
+        (new CommandObserver)->observe(
+            function() {
+                $operation = new CreateIndexes(
+                    $this->getDatabaseName(),
+                    $this->getCollectionName(),
+                    [['key' => ['x' => 1]]],
+                    ['writeConcern' => $this->createDefaultWriteConcern()]
+                );
+
+                $operation->execute($this->getPrimaryServer());
+            },
+            function(stdClass $command) {
+                $this->assertObjectNotHasAttribute('writeConcern', $command);
+            }
+        );
+    }
+
     /**
      * Asserts that an index with the given name exists for the collection.
      *
diff --git a/tests/Operation/DistinctFunctionalTest.php b/tests/Operation/DistinctFunctionalTest.php
diff --git a/tests/Operation/DropCollectionFunctionalTest.php b/tests/Operation/DropCollectionFunctionalTest.php
diff --git a/tests/Operation/DropDatabaseFunctionalTest.php b/tests/Operation/DropDatabaseFunctionalTest.php
diff --git a/tests/Operation/DropIndexesFunctionalTest.php b/tests/Operation/DropIndexesFunctionalTest.php
diff --git a/tests/Operation/FindAndModifyFunctionalTest.php b/tests/Operation/FindAndModifyFunctionalTest.php
diff --git a/tests/Operation/FindFunctionalTest.php b/tests/Operation/FindFunctionalTest.php
diff --git a/tests/Operation/FunctionalTestCase.php b/tests/Operation/FunctionalTestCase.php
diff --git a/tests/Operation/MapReduceFunctionalTest.php b/tests/Operation/MapReduceFunctionalTest.php

Original file line number	Diff line number	Diff line change
`@@ -66,6 +66,10 @@ public function __construct($databaseName, array $options = [])`
`66`	`66`	`throw InvalidArgumentException::invalidType('"writeConcern" option', $options['writeConcern'], 'MongoDB\Driver\WriteConcern');`
`67`	`67`	`}`
`68`	`68`
	`69`	`+ if (isset($options['writeConcern']) && $options['writeConcern']->isDefault()) {`
	`70`	`+ unset($options['writeConcern']);`
	`71`	`+ }`
	`72`	`+`
`69`	`73`	`$this->databaseName = (string) $databaseName;`
`70`	`74`	`$this->options = $options;`
`71`	`75`	`}`