Update createSearchIndex signature

Author: GromNaN

src/Collection.php

@@ -402,15 +402,21 @@ public function createIndexes(array $indexes, array $options = [])
      *
      * @see https://www.mongodb.com/docs/manual/reference/command/createSearchIndexes/
      * @see https://mongodb.com/docs/manual/reference/method/db.collection.createSearchIndex/
-     * @param array{name?: string, definition: array|object} $index   Atlas Search index specification
-     * @param array                                          $options Command options
+     * @param array|object         $definition Atlas Search index mapping definition
+     * @param array{name?: string} $options    Command options
      * @return string The name of the created search index
      * @throws UnsupportedException if options are not supported by the selected server
      * @throws InvalidArgumentException for parameter/option parsing errors
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */
-    public function createSearchIndex(array $index, array $options = []): string
+    public function createSearchIndex($definition, array $options = []): string
     {
+        $index = ['definition' => $definition];
+        if (isset($options['name'])) {
+            $index['name'] = $options['name'];
+            unset($options['name']);
+        }
+
         $names = $this->createSearchIndexes([$index], $options);
 
         return current($names);

src/Operation/UpdateSearchIndex.php

@@ -29,9 +29,8 @@
 /**
  * Operation for the createIndexes command.
  *
- * @see \MongoDB\Collection::createSearchIndex()
- * @see \MongoDB\Collection::createSearchIndexes()
- * @see https://mongodb.com/docs/manual/reference/command/createSearchIndexes/
+ * @see \MongoDB\Collection::updateSearchIndexes()
+ * @see https://mongodb.com/docs/manual/reference/command/updateSearchIndexes/
  */
 class UpdateSearchIndex implements Executable
 {

tests/Collection/SearchIndexFunctionalTest.php

@@ -48,19 +48,18 @@ public function testCreateSearchIndexesWithEmptyList(): void
     public function testCreateSearchIndexWithDefaultName(): void
     {
         $collection = $this->createCollection($this->getDatabaseName(), $this->getCollectionName());
-        $name = $collection->createSearchIndex(['definition' => ['mappings' => ['dynamic' => true]]]);
+        $name = $collection->createSearchIndex(['mappings' => ['dynamic' => true]]);
 
         $this->assertSame('default', $name);
     }
 
     public function testIndexLifecycle(): void
     {
         $collection = $this->createCollection($this->getDatabaseName(), $this->getCollectionName());
-
-        $name = 'search_index_' . bin2hex(random_bytes(5));
+        $name = 'search_index';
 
         // Create a search index
-        $createdName = $collection->createSearchIndex(['name' => $name, 'definition' => ['mappings' => ['dynamic' => true]]]);
+        $createdName = $collection->createSearchIndex(['mappings' => ['dynamic' => true]], ['name' => $name]);
         $this->assertSame($name, $createdName);
 
         // Wait for the index to be ready
@@ -84,6 +83,7 @@ public function testIndexLifecycle(): void
         // Delete the search index
         $collection->dropSearchIndex($name);
 
+        // Wait for the index to be deleted
         $count = 0;
         do {
             sleep(1);
@@ -97,8 +97,8 @@ public function testIndexLifecycle(): void
     }
 
     /**
-     * Randomize the collection name to avoid duplicate index names when Atlas takes several seconds to be cleaned up
-     * the indexes when their parent collection is dropped.
+     * Randomize the collection name to avoid duplicate index names when running tests concurrently.
+     * Search index operations are asynchronous and can take up to 1 minute.
      */
     protected function getCollectionName(): string
     {

tests/UnifiedSpecTests/Operation.php

@@ -36,7 +36,6 @@
 use function hex2bin;
 use function iterator_to_array;
 use function key;
-use function MongoDB\document_to_array;
 use function MongoDB\with_transaction;
 use function PHPUnit\Framework\assertArrayHasKey;
 use function PHPUnit\Framework\assertContains;
@@ -559,7 +558,12 @@ function (IndexInfo $info) {
                 );
 
             case 'createSearchIndex':
-                return $collection->createSearchIndex((array) $args['model']);
+                $options = [];
+                if (isset($args['name'])) {
+                    $options['name'] = $args['name'];
+                }
+
+                return $collection->createSearchIndex($args['model']->definition, $options);
 
             case 'createSearchIndexes':
                 return $collection->createSearchIndexes($args['models']);
@@ -579,7 +583,7 @@ function (IndexInfo $info) {
                 return $collection->updateSearchIndex($args['name'], $args['definition']);
 
             case 'listSearchIndexes':
-                return $collection->listSearchIndexes($args['name'] ?? null, document_to_array($args['aggregationOptions'] ?? []));
+                return $collection->listSearchIndexes($args['name'] ?? null, (array) ($args['aggregationOptions'] ?? []));
 
             default:
                 Assert::fail('Unsupported collection operation: ' . $this->name);