PHPLIB-1492: Support sort option for updateOne and replaceOne

src/Operation/BulkWrite.php

@@ -91,6 +91,14 @@ class BulkWrite implements Executable
      *  * upsert (boolean): When true, a new document is created if no document
      *    matches the query. The default is false.
      *
+     * Supported options for replaceOne and updateOne operations:
+     *
+     *  * sort (document): Determines which document the operation modifies if
+     *    the query selects multiple documents.
+     *
+     *    This is not supported for server versions < 8.0 and will result in an
+     *    exception at execution time if used.
+     *
      * Supported options for updateMany and updateOne operations:
      *
      *  * arrayFilters (document array): A set of filters specifying to which
@@ -372,6 +380,10 @@ private function validateOperations(array $operations, ?DocumentCodec $codec, En
                         throw InvalidArgumentException::expectedDocumentType(sprintf('$operations[%d]["%s"][2]["collation"]', $i, $type), $args[2]['collation']);
                     }
 
+                    if (isset($args[2]['sort']) && ! is_document($args[2]['sort'])) {
+                        throw InvalidArgumentException::expectedDocumentType(sprintf('$operations[%d]["%s"][2]["sort"]', $i, $type), $args[2]['sort']);
+                    }
+
                     if (! is_bool($args[2]['upsert'])) {
                         throw InvalidArgumentException::invalidType(sprintf('$operations[%d]["%s"][2]["upsert"]', $i, $type), $args[2]['upsert'], 'boolean');
                     }
@@ -413,6 +425,14 @@ private function validateOperations(array $operations, ?DocumentCodec $codec, En
                         throw InvalidArgumentException::expectedDocumentType(sprintf('$operations[%d]["%s"][2]["collation"]', $i, $type), $args[2]['collation']);
                     }
 
+                    if (isset($args[2]['sort']) && ! is_document($args[2]['sort'])) {
+                        throw InvalidArgumentException::expectedDocumentType(sprintf('$operations[%d]["%s"][2]["sort"]', $i, $type), $args[2]['sort']);
+                    }
+
+                    if (isset($args[2]['sort']) && $args[2]['multi']) {
+                        throw new InvalidArgumentException(sprintf('"sort" option cannot be used with $operations[%d]["%s"]', $i, $type));
+                    }
+
                     if (! is_bool($args[2]['upsert'])) {
                         throw InvalidArgumentException::invalidType(sprintf('$operations[%d]["%s"][2]["upsert"]', $i, $type), $args[2]['upsert'], 'boolean');
                     }

src/Operation/ReplaceOne.php

@@ -74,6 +74,12 @@ class ReplaceOne implements Executable
      *    Parameters can then be accessed as variables in an aggregate
      *    expression context (e.g. "$$var").
      *
+     *   * sort (document): Determines which document the operation modifies if
+     *     the query selects multiple documents.
+     *
+     *     This is not supported for server versions < 8.0 and will result in an
+     *     exception at execution time if used.
+     *
      *  * writeConcern (MongoDB\Driver\WriteConcern): Write concern.
      *
      * @param string       $databaseName   Database name

src/Operation/Update.php

@@ -149,6 +149,14 @@ public function __construct(private string $databaseName, private string $collec
             throw InvalidArgumentException::expectedDocumentType('"let" option', $options['let']);
         }
 
+        if (isset($options['sort']) && ! is_document($options['sort'])) {
+            throw InvalidArgumentException::expectedDocumentType('"sort" option', $options['sort']);
+        }
+
+        if (isset($options['sort']) && $options['multi']) {
+            throw new InvalidArgumentException('"sort" option cannot be used with multi-document updates');
+        }
+
         if (isset($options['bypassDocumentValidation']) && ! $options['bypassDocumentValidation']) {
             unset($options['bypassDocumentValidation']);
         }
@@ -270,8 +278,10 @@ private function createUpdateOptions(): array
             }
         }
 
-        if (isset($this->options['collation'])) {
-            $updateOptions['collation'] = (object) $this->options['collation'];
+        foreach (['collation', 'sort'] as $option) {
+            if (isset($this->options[$option])) {
+                $updateOptions[$option] = (object) $this->options[$option];
+            }
         }
 
         return $updateOptions;

src/Operation/UpdateOne.php

@@ -72,6 +72,12 @@ class UpdateOne implements Executable, Explainable
      *    Parameters can then be accessed as variables in an aggregate
      *    expression context (e.g. "$$var").
      *
+     *  * sort (document): Determines which document the operation modifies if
+     *    the query selects multiple documents.
+     *
+     *    This is not supported for server versions < 8.0 and will result in an
+     *    exception at execution time if used.
+     *
      *  * writeConcern (MongoDB\Driver\WriteConcern): Write concern.
      *
      * @param string       $databaseName   Database name

tests/Operation/BulkWriteTest.php

@@ -217,6 +217,16 @@ public function testReplaceOneCollationOptionTypeCheck($collation): void
         ]);
     }
 
+    #[DataProvider('provideInvalidDocumentValues')]
+    public function testReplaceOneSortOptionTypeCheck($sort): void
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessageMatches('/Expected \$operations\[0\]\["replaceOne"\]\[2\]\["sort"\] to have type "document" \(array or object\) but found ".+"/');
+        new BulkWrite($this->getDatabaseName(), $this->getCollectionName(), [
+            [BulkWrite::REPLACE_ONE => [['x' => 1], ['y' => 1], ['sort' => $sort]]],
+        ]);
+    }
+
     #[DataProvider('provideInvalidBooleanValues')]
     public function testReplaceOneUpsertOptionTypeCheck($upsert): void
     {
@@ -322,6 +332,15 @@ public function testUpdateManyCollationOptionTypeCheck($collation): void
         ]);
     }
 
+    public function testUpdateManyProhibitsSortOption(): void
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('"sort" option cannot be used with $operations[0]["updateMany"]');
+        new BulkWrite($this->getDatabaseName(), $this->getCollectionName(), [
+            [BulkWrite::UPDATE_MANY => [['x' => 1], ['$set' => ['y' => 1]], ['sort' => ['z' => 1]]]],
+        ]);
+    }
+
     #[DataProvider('provideInvalidBooleanValues')]
     public function testUpdateManyUpsertOptionTypeCheck($upsert): void
     {
@@ -410,6 +429,16 @@ public function testUpdateOneCollationOptionTypeCheck($collation): void
         ]);
     }
 
+    #[DataProvider('provideInvalidDocumentValues')]
+    public function testUpdateOneSortOptionTypeCheck($sort): void
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessageMatches('/Expected \$operations\[0\]\["updateOne"\]\[2\]\["sort"\] to have type "document" \(array or object\) but found ".+"/');
+        new BulkWrite($this->getDatabaseName(), $this->getCollectionName(), [
+            [BulkWrite::UPDATE_ONE => [['x' => 1], ['$set' => ['y' => 1]], ['sort' => $sort]]],
+        ]);
+    }
+
     #[DataProvider('provideInvalidBooleanValues')]
     public function testUpdateOneUpsertOptionTypeCheck($upsert): void
     {

tests/Operation/UpdateTest.php

@@ -40,6 +40,7 @@ public static function provideInvalidConstructorOptions()
             'collation' => self::getInvalidDocumentValues(),
             'hint' => self::getInvalidHintValues(),
             'multi' => self::getInvalidBooleanValues(),
+            'sort' => self::getInvalidDocumentValues(),
             'session' => self::getInvalidSessionValues(),
             'upsert' => self::getInvalidBooleanValues(),
             'writeConcern' => self::getInvalidWriteConcernValues(),
@@ -55,6 +56,13 @@ public function testConstructorMultiOptionProhibitsReplacementDocumentOrEmptyPip
         new Update($this->getDatabaseName(), $this->getCollectionName(), ['x' => 1], $update, ['multi' => true]);
     }
 
+    public function testConstructorMultiOptionProhibitsSortOption(): void
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('"sort" option cannot be used with multi-document updates');
+        new Update($this->getDatabaseName(), $this->getCollectionName(), ['x' => 1], ['$set' => ['x' => 2]], ['multi' => true, 'sort' => ['x' => 1]]);
+    }
+
     public function testExplainableCommandDocument(): void
     {
         $options = [

tests/UnifiedSpecTests/UnifiedSpecTest.php

@@ -37,11 +37,6 @@ class UnifiedSpecTest extends FunctionalTestCase
         // mongoc_cluster_stream_for_server does not retry handshakes (CDRIVER-4532, PHPLIB-1033, PHPLIB-1042)
         'retryable-reads/retryable reads handshake failures' => 'Handshakes are not retried (CDRIVER-4532)',
         'retryable-writes/retryable writes handshake failures' => 'Handshakes are not retried (CDRIVER-4532)',
-        // sort option for update operations is not supported (PHPLIB-1492)
-        'crud/BulkWrite replaceOne-sort' => 'Sort for replace operations is not supported (PHPLIB-1492)',
-        'crud/BulkWrite updateOne-sort' => 'Sort for update operations is not supported (PHPLIB-1492)',
-        'crud/replaceOne-sort' => 'Sort for replace operations is not supported (PHPLIB-1492)',
-        'crud/updateOne-sort' => 'Sort for update operations is not supported (PHPLIB-1492)',
         'crud/bypassDocumentValidation' => 'bypassDocumentValidation is handled by libmongoc (PHPLIB-1576)',
     ];
 

tests/UnifiedSpecTests/Util.php

@@ -105,10 +105,10 @@ final class Util
             'findOne' => ['let', 'filter', 'session', 'allowDiskUse', 'allowPartialResults', 'batchSize', 'collation', 'comment', 'cursorType', 'hint', 'max', 'maxAwaitTimeMS', 'maxScan', 'maxTimeMS', 'min', 'modifiers', 'noCursorTimeout', 'oplogReplay', 'projection', 'returnKey', 'showRecordId', 'skip', 'snapshot', 'sort'],
             'findOneAndReplace' => ['let', 'returnDocument', 'filter', 'replacement', 'session', 'projection', 'returnDocument', 'upsert', 'arrayFilters', 'bypassDocumentValidation', 'collation', 'hint', 'maxTimeMS', 'new', 'remove', 'sort', 'comment'],
             'rename' => ['to', 'comment', 'dropTarget'],
-            'replaceOne' => ['let', 'filter', 'replacement', 'session', 'upsert', 'arrayFilters', 'bypassDocumentValidation', 'collation', 'hint', 'comment'],
+            'replaceOne' => ['let', 'filter', 'replacement', 'session', 'upsert', 'arrayFilters', 'bypassDocumentValidation', 'collation', 'hint', 'comment', 'sort'],
             'findOneAndUpdate' => ['let', 'returnDocument', 'filter', 'update', 'session', 'upsert', 'projection', 'remove', 'arrayFilters', 'bypassDocumentValidation', 'collation', 'hint', 'maxTimeMS', 'sort', 'comment'],
             'updateMany' => ['let', 'filter', 'update', 'session', 'upsert', 'arrayFilters', 'bypassDocumentValidation', 'collation', 'hint', 'comment'],
-            'updateOne' => ['let', 'filter', 'update', 'session', 'upsert', 'arrayFilters', 'bypassDocumentValidation', 'collation', 'hint', 'comment'],
+            'updateOne' => ['let', 'filter', 'update', 'session', 'upsert', 'arrayFilters', 'bypassDocumentValidation', 'collation', 'hint', 'comment', 'sort'],
             'updateSearchIndex' => ['name', 'definition'],
             'insertMany' => ['documents', 'session', 'ordered', 'bypassDocumentValidation', 'comment'],
             'insertOne' => ['document', 'session', 'bypassDocumentValidation', 'comment'],