PHPLIB-544: Add commitQuorum option to createIndexes

Author: alcaeus

docs/includes/apiargs-MongoDBCollection-method-createIndex-option.yaml

@@ -1,4 +1,23 @@
 arg_name: option
+name: commitQuorum
+type: string|integer
+description: |
+  Specifies how many data-bearing members of a replica set, including the
+  primary, must complete the index builds successfully before the primary marks
+  the indexes as ready.
+
+  This option accepts the same values for the "w" field in a write concern plus
+  "votingMembers", which indicates all voting data-bearing nodes.
+
+  This is not supported for server versions prior to 4.4 and will result in an
+  exception at execution time if used.
+
+  .. versionadded:: 1.7
+interface: phpmethod
+operation: ~
+optional: true
+---
+arg_name: option
 name: unique
 type: boolean
 description: |

docs/includes/apiargs-MongoDBCollection-method-createIndexes-option.yaml

@@ -1,3 +1,22 @@
+arg_name: option
+name: commitQuorum
+type: string|integer
+description: |
+  Specifies how many data-bearing members of a replica set, including the
+  primary, must complete the index builds successfully before the primary marks
+  the indexes as ready.
+
+  This option accepts the same values for the "w" field in a write concern plus
+  "votingMembers", which indicates all voting data-bearing nodes.
+
+  This is not supported for server versions prior to 4.4 and will result in an
+  exception at execution time if used.
+
+  .. versionadded:: 1.7
+interface: phpmethod
+operation: ~
+optional: true
+---
 source:
   file: apiargs-common-option.yaml
   ref: maxTimeMS

src/Collection.php

@@ -356,7 +356,7 @@ public function countDocuments($filter = [], array $options = [])
      */
     public function createIndex($key, array $options = [])
     {
-        $commandOptionKeys = ['maxTimeMS' => 1, 'session' => 1, 'writeConcern' => 1];
+        $commandOptionKeys = ['commitQuorum' => 1, 'maxTimeMS' => 1, 'session' => 1, 'writeConcern' => 1];
         $indexOptions = array_diff_key($options, $commandOptionKeys);
         $commandOptions = array_intersect_key($options, $commandOptionKeys);
 

src/Operation/CreateIndexes.php

@@ -18,6 +18,7 @@
 namespace MongoDB\Operation;
 
 use MongoDB\Driver\Command;
+use MongoDB\Driver\Exception\CommandException;
 use MongoDB\Driver\Exception\RuntimeException as DriverRuntimeException;
 use MongoDB\Driver\Server;
 use MongoDB\Driver\Session;
@@ -28,6 +29,7 @@
 use function array_map;
 use function is_array;
 use function is_integer;
+use function is_string;
 use function MongoDB\server_supports_feature;
 use function sprintf;
 
@@ -47,6 +49,9 @@ class CreateIndexes implements Executable
     /** @var integer */
     private static $wireVersionForWriteConcern = 5;
 
+    /** @var integer */
+    private static $wireVersionForCommitQuorum = 9;
+
     /** @var string */
     private $databaseName;
 
@@ -67,6 +72,8 @@ class CreateIndexes implements Executable
      *
      * Supported options:
      *
+     *  * commitQuorum (integer|string):
+     *
      *  * maxTimeMS (integer): The maximum amount of time to allow the query to
      *    run.
      *
@@ -115,6 +122,10 @@ public function __construct($databaseName, $collectionName, array $indexes, arra
             $expectedIndex += 1;
         }
 
+        if (isset($options['commitQuorum']) && ! is_string($options['commitQuorum']) && ! is_integer($options['commitQuorum'])) {
+            throw InvalidArgumentException::invalidType('"commitQuorum" option', $options['commitQuorum'], ['integer', 'string']);
+        }
+
         if (isset($options['maxTimeMS']) && ! is_integer($options['maxTimeMS'])) {
             throw InvalidArgumentException::invalidType('"maxTimeMS" option', $options['maxTimeMS'], 'integer');
         }
@@ -202,6 +213,16 @@ private function executeCommand(Server $server)
             'indexes' => $this->indexes,
         ];
 
+        if (isset($this->options['commitQuorum'])) {
+            /* Drivers MUST manually raise an error if this option is specified
+             * when creating an index on a pre 4.4 server. */
+            if (! server_supports_feature($server, self::$wireVersionForCommitQuorum)) {
+                throw new CommandException('Invalid field specified for createIndexes command: commitQuorum', 2);
+            }
+
+            $cmd['commitQuorum'] = $this->options['commitQuorum'];
+        }
+
         if (isset($this->options['maxTimeMS'])) {
             $cmd['maxTimeMS'] = $this->options['maxTimeMS'];
         }

tests/Operation/CreateIndexesFunctionalTest.php

@@ -3,7 +3,9 @@
 namespace MongoDB\Tests\Operation;
 
 use InvalidArgumentException;
+use MongoDB\Driver\Exception\CommandException;
 use MongoDB\Driver\Exception\RuntimeException;
+use MongoDB\Driver\Server;
 use MongoDB\Model\IndexInfo;
 use MongoDB\Operation\CreateIndexes;
 use MongoDB\Operation\ListIndexes;
@@ -171,6 +173,52 @@ function (array $event) {
         );
     }
 
+    public function testCommitQuorumOption()
+    {
+        if (version_compare($this->getServerVersion(), '4.3.4', '<')) {
+            $this->markTestSkipped('commitQuorum is not supported');
+        }
+
+        if ($this->getPrimaryServer()->getType() !== Server::TYPE_RS_PRIMARY) {
+            $this->markTestSkipped('commitQuorum is only supported on replica sets');
+        }
+
+        (new CommandObserver())->observe(
+            function () {
+                $operation = new CreateIndexes(
+                    $this->getDatabaseName(),
+                    $this->getCollectionName(),
+                    [['key' => ['x' => 1]]],
+                    ['commitQuorum' => 'majority']
+                );
+
+                $operation->execute($this->getPrimaryServer());
+            },
+            function (array $event) {
+                $this->assertObjectHasAttribute('commitQuorum', $event['started']->getCommand());
+            }
+        );
+    }
+
+    public function testCommitQuorumUnsupported()
+    {
+        if (version_compare($this->getServerVersion(), '4.3.4', '>=')) {
+            $this->markTestSkipped('commitQuorum is supported');
+        }
+
+        $operation = new CreateIndexes(
+            $this->getDatabaseName(),
+            $this->getCollectionName(),
+            [['key' => ['x' => 1]]],
+            ['commitQuorum' => 'majority']
+        );
+
+        $this->expectException(CommandException::class);
+        $this->expectExceptionMessage('Invalid field specified for createIndexes command: commitQuorum');
+
+        $operation->execute($this->getPrimaryServer());
+    }
+
     /**
      * Asserts that an index with the given name exists for the collection.
      *

tests/Operation/CreateIndexesTest.php

@@ -4,6 +4,7 @@
 
 use MongoDB\Exception\InvalidArgumentException;
 use MongoDB\Operation\CreateIndexes;
+use stdClass;
 
 class CreateIndexesTest extends TestCase
 {
@@ -27,6 +28,10 @@ public function provideInvalidConstructorOptions()
     {
         $options = [];
 
+        foreach ([3.14, true, [], new stdClass()] as $value) {
+            $options[][] = ['commitQuorum' => $value];
+        }
+
         foreach ($this->getInvalidIntegerValues() as $value) {
             $options[][] = ['maxTimeMS' => $value];
         }