Revert change on modifyCollection

Author: GromNaN

UPGRADE-2.0.md

@@ -34,7 +34,8 @@ type changed to `void`. In case of an error, an exception is thrown.
  * `MongoDB\Database`: `createCollection`, `drop`, `dropCollection`, `modifyCollection`, `renameCollection`
  * `MongoDB\Database::createEncryptedCollection()` returns the list of encrypted fields
 
-If you still need to access the raw command result, you can use a `CommandSubscriber`.
+If you still need to access the raw command result, you can use a
+[`CommandSubscriber`](https://www.php.net/manual/en/class.mongodb-driver-monitoring-commandsubscriber.php).
 
 GridFS
 ------

psalm-baseline.xml

@@ -733,6 +733,9 @@
     </MixedAssignment>
   </file>
   <file src="src/Operation/ModifyCollection.php">
+    <MixedArgument>
+      <code><![CDATA[$this->options['typeMap']]]></code>
+    </MixedArgument>
     <MixedAssignment>
       <code><![CDATA[$cmd['comment']]]></code>
       <code><![CDATA[$options['session']]]></code>

src/Database.php

@@ -478,8 +478,12 @@ public function listCollections(array $options = []): Iterator
      * @throws InvalidArgumentException for parameter/option parsing errors
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */
-    public function modifyCollection(string $collectionName, array $collectionOptions, array $options = []): void
+    public function modifyCollection(string $collectionName, array $collectionOptions, array $options = []): array|object
     {
+        if (! isset($options['typeMap'])) {
+            $options['typeMap'] = $this->typeMap;
+        }
+
         $server = select_server_for_write($this->manager, $options);
 
         if (! isset($options['writeConcern']) && ! is_in_transaction($options)) {
@@ -488,7 +492,7 @@ public function modifyCollection(string $collectionName, array $collectionOption
 
         $operation = new ModifyCollection($this->databaseName, $collectionName, $collectionOptions, $options);
 
-        $operation->execute($server);
+        return $operation->execute($server);
     }
 
     /**

src/Operation/ModifyCollection.php

@@ -24,6 +24,9 @@
 use MongoDB\Driver\WriteConcern;
 use MongoDB\Exception\InvalidArgumentException;
 
+use function current;
+use function is_array;
+
 /**
  * Operation for the collMod command.
  *
@@ -43,6 +46,9 @@ final class ModifyCollection
      *
      *  * session (MongoDB\Driver\Session): Client session.
      *
+     *  * typeMap (array): Type map for BSON deserialization. This will only be
+     *    used for the returned command result document.
+     *
      *  * writeConcern (MongoDB\Driver\WriteConcern): Write concern.
      *
      * @param string $databaseName      Database name
@@ -61,6 +67,10 @@ public function __construct(private string $databaseName, private string $collec
             throw InvalidArgumentException::invalidType('"session" option', $this->options['session'], Session::class);
         }
 
+        if (isset($this->options['typeMap']) && ! is_array($this->options['typeMap'])) {
+            throw InvalidArgumentException::invalidType('"typeMap" option', $this->options['typeMap'], 'array');
+        }
+
         if (isset($this->options['writeConcern']) && ! $this->options['writeConcern'] instanceof WriteConcern) {
             throw InvalidArgumentException::invalidType('"writeConcern" option', $this->options['writeConcern'], WriteConcern::class);
         }
@@ -73,11 +83,18 @@ public function __construct(private string $databaseName, private string $collec
     /**
      * Execute the operation.
      *
+     * @return array|object Command result document
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */
-    public function execute(Server $server): void
+    public function execute(Server $server): array|object
     {
-        $server->executeWriteCommand($this->databaseName, $this->createCommand(), $this->createOptions());
+        $cursor = $server->executeWriteCommand($this->databaseName, $this->createCommand(), $this->createOptions());
+
+        if (isset($this->options['typeMap'])) {
+            $cursor->setTypeMap($this->options['typeMap']);
+        }
+
+        return current($cursor->toArray());
     }
 
     private function createCommand(): Command

tests/Database/DatabaseFunctionalTest.php

@@ -16,9 +16,8 @@
 use PHPUnit\Framework\Attributes\Group;
 use TypeError;
 
+use function array_key_exists;
 use function current;
-use function iterator_to_array;
-use function json_encode;
 
 /**
  * Functional tests for the Database class.
@@ -182,25 +181,27 @@ public function testModifyCollection(): void
         $createIndexes = new CreateIndexes($this->getDatabaseName(), $this->getCollectionName(), $indexes);
         $createIndexes->execute($this->getPrimaryServer());
 
-        $this->database->modifyCollection(
+        $commandResult = $this->database->modifyCollection(
             $this->getCollectionName(),
             ['index' => ['keyPattern' => ['lastAccess' => 1], 'expireAfterSeconds' => 1000]],
+            ['typeMap' => ['root' => 'array', 'document' => 'array']],
         );
-
-        $indexes = $this->database->selectCollection($this->getCollectionName())->listIndexes();
-        $indexes = iterator_to_array($indexes);
-        $this->assertCount(2, $indexes);
-
-        foreach ($indexes as $index) {
-            switch ($index['key']) {
-                case ['_id' => 1]:
-                    break;
-                case ['lastAccess' => 1]:
-                    $this->assertSame(1000, $index['expireAfterSeconds']);
-                    break;
-                default:
-                    $this->fail('Unexpected index key: ' . json_encode($index->key));
+        $this->assertCommandSucceeded($commandResult);
+        $commandResult = (array) $commandResult;
+
+        if (array_key_exists('raw', $commandResult)) {
+            /* Sharded environment, where we only assert if a shard had a successful update. For
+             * non-primary shards that don't have chunks for the collection, the result contains a
+             * "ns does not exist" error. */
+            foreach ($commandResult['raw'] as $shard) {
+                if (array_key_exists('ok', $shard) && $shard['ok'] == 1) {
+                    $this->assertSame(3, $shard['expireAfterSeconds_old']);
+                    $this->assertSame(1000, $shard['expireAfterSeconds_new']);
+                }
             }
+        } else {
+            $this->assertSame(3, $commandResult['expireAfterSeconds_old']);
+            $this->assertSame(1000, $commandResult['expireAfterSeconds_new']);
         }
     }
 

tests/Operation/ModifyCollectionFunctionalTest.php

@@ -3,13 +3,9 @@
 namespace MongoDB\Tests\Operation;
 
 use MongoDB\Operation\CreateIndexes;
-use MongoDB\Operation\ListIndexes;
 use MongoDB\Operation\ModifyCollection;
 use PHPUnit\Framework\Attributes\Group;
 
-use function iterator_to_array;
-use function json_encode;
-
 class ModifyCollectionFunctionalTest extends FunctionalTestCase
 {
     #[Group('matrix-testing-exclude-server-4.2-driver-4.0-topology-sharded_cluster')]
@@ -33,23 +29,9 @@ public function testCollMod(): void
             ['index' => ['keyPattern' => ['lastAccess' => 1], 'expireAfterSeconds' => 1000]],
             ['typeMap' => ['root' => 'array', 'document' => 'array']],
         );
-        $modifyCollection->execute($this->getPrimaryServer());
-
-        $listIndexes = new ListIndexes($this->getDatabaseName(), $this->getCollectionName());
-        $indexes = $listIndexes->execute($this->getPrimaryServer());
-        $indexes = iterator_to_array($indexes);
-        $this->assertCount(2, $indexes);
+        $result = $modifyCollection->execute($this->getPrimaryServer());
 
-        foreach ($indexes as $index) {
-            switch ($index['key']) {
-                case ['_id' => 1]:
-                    break;
-                case ['lastAccess' => 1]:
-                    $this->assertSame(1000, $index['expireAfterSeconds']);
-                    break;
-                default:
-                    $this->fail('Unexpected index key: ' . json_encode($index->key));
-            }
-        }
+        $this->assertSame(3, $result['expireAfterSeconds_old']);
+        $this->assertSame(1000, $result['expireAfterSeconds_new']);
     }
 }