PHPLIB-254 Support maxTimeMS option for CreateIndexes operation (#431)

* PHPLIB-254 Support maxTimeMS option for CreateIndexes operation

Author: kvwalker

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

@@ -41,6 +41,10 @@ interface: phpmethod
 operation: ~
 optional: true
 ---
+source:
+  file: apiargs-common-option.yaml
+  ref: maxTimeMS
+---
 arg_name: option
 name: name
 type: string

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

@@ -1,3 +1,7 @@
+source:
+  file: apiargs-common-option.yaml
+  ref: maxTimeMS
+---
 source:
   file: apiargs-MongoDBCollection-common-option.yaml
   ref: writeConcern

src/Collection.php

@@ -282,8 +282,8 @@ public function count($filter = [], array $options = [])
      */
     public function createIndex($key, array $options = [])
     {
-        $indexOptions = array_diff_key($options, ['writeConcern' => 1]);
-        $commandOptions = array_intersect_key($options, ['writeConcern' => 1]);
+        $indexOptions = array_diff_key($options, ['maxTimeMS' => 1, 'writeConcern' => 1]);
+        $commandOptions = array_intersect_key($options, ['maxTimeMS' => 1, 'writeConcern' => 1]);
 
         return current($this->createIndexes([['key' => $key] + $indexOptions], $commandOptions));
     }

src/Operation/CreateIndexes.php

@@ -51,6 +51,9 @@ class CreateIndexes implements Executable
      *
      * Supported options:
      *
+     *  * maxTimeMS (integer): The maximum amount of time to allow the query to
+     *    run.
+     *
      *  * writeConcern (MongoDB\Driver\WriteConcern): Write concern.
      *
      *    This is not supported for server versions < 3.4 and will result in an
@@ -92,6 +95,10 @@ public function __construct($databaseName, $collectionName, array $indexes, arra
             $expectedIndex += 1;
         }
 
+        if (isset($options['maxTimeMS']) && !is_integer($options['maxTimeMS'])) {
+            throw InvalidArgumentException::invalidType('"maxTimeMS" option', $options['maxTimeMS'], 'integer');
+        }
+
         if (isset($options['writeConcern']) && ! $options['writeConcern'] instanceof WriteConcern) {
             throw InvalidArgumentException::invalidType('"writeConcern" option', $options['writeConcern'], 'MongoDB\Driver\WriteConcern');
         }
@@ -150,6 +157,10 @@ private function executeCommand(Server $server)
             'indexes' => $this->indexes,
         ];
 
+        if (isset($this->options['maxTimeMS'])) {
+            $cmd['maxTimeMS'] = $this->options['maxTimeMS'];
+        }
+
         if (isset($this->options['writeConcern'])) {
             $cmd['writeConcern'] = \MongoDB\write_concern_as_document($this->options['writeConcern']);
         }

tests/Operation/CreateIndexesTest.php

@@ -28,6 +28,10 @@ public function provideInvalidConstructorOptions()
     {
         $options = [];
 
+        foreach ($this->getInvalidIntegerValues() as $value) {
+            $options[][] = ['maxTimeMS' => $value];
+        }
+
         foreach ($this->getInvalidWriteConcernValues() as $value) {
             $options[][] = ['writeConcern' => $value];
         }