Merge v2.4 into v2.x

composer.json

@@ -19,7 +19,7 @@
     "require-dev": {
         "doctrine/coding-standard": "^12.0",
         "phpunit/phpunit": "^10.5.35",
-        "rector/rector": "^2.3.4",
+        "rector/rector": "~2.5.9",
         "squizlabs/php_codesniffer": "^3.7",
         "vimeo/psalm": "~6.14.2"
     },

src/Collection.php

@@ -77,6 +77,7 @@
 use function current;
 use function is_array;
 use function is_bool;
+use function str_contains;
 use function strlen;
 
 /**
@@ -174,11 +175,11 @@ class Collection implements Stringable
      */
     public function __construct(private Manager $manager, private string $databaseName, private string $collectionName, array $options = [])
     {
-        if (strlen($databaseName) < 1) {
+        if (strlen($databaseName) < 1 || str_contains($databaseName, '.') || str_contains($databaseName, "\0")) {
             throw new InvalidArgumentException('$databaseName is invalid: ' . $databaseName);
         }
 
-        if (strlen($collectionName) < 1) {
+        if (strlen($collectionName) < 1 || str_contains($collectionName, "\0")) {
             throw new InvalidArgumentException('$collectionName is invalid: ' . $collectionName);
         }
 

src/Database.php

@@ -56,6 +56,7 @@
 
 use function is_array;
 use function is_bool;
+use function str_contains;
 use function strlen;
 
 /** @psalm-no-seal-properties */
@@ -112,7 +113,7 @@ class Database implements Stringable
      */
     public function __construct(private Manager $manager, private string $databaseName, array $options = [])
     {
-        if (strlen($databaseName) < 1) {
+        if (strlen($databaseName) < 1 || str_contains($databaseName, '.') || str_contains($databaseName, "\0")) {
             throw new InvalidArgumentException('$databaseName is invalid: ' . $databaseName);
         }
 

src/Operation/BulkWrite.php

@@ -36,6 +36,7 @@
 use function is_array;
 use function is_bool;
 use function key;
+use function MongoDB\create_namespace;
 use function MongoDB\is_document;
 use function MongoDB\is_first_key_operator;
 use function MongoDB\is_pipeline;
@@ -63,6 +64,8 @@ final class BulkWrite
 
     private array $options;
 
+    private string $namespace;
+
     /**
      * Constructs a bulk write operation.
      *
@@ -142,8 +145,10 @@ final class BulkWrite
      * @param array  $options        Command options
      * @throws InvalidArgumentException for parameter/option parsing errors
      */
-    public function __construct(private string $databaseName, private string $collectionName, array $operations, array $options = [])
+    public function __construct(string $databaseName, string $collectionName, array $operations, array $options = [])
     {
+        $this->namespace = create_namespace($databaseName, $collectionName);
+
         if (empty($operations)) {
             throw new InvalidArgumentException('$operations is empty');
         }
@@ -232,7 +237,7 @@ public function execute(Server $server): BulkWriteResult
             }
         }
 
-        $writeResult = $server->executeBulkWrite($this->databaseName . '.' . $this->collectionName, $bulk, $this->createExecuteOptions());
+        $writeResult = $server->executeBulkWrite($this->namespace, $bulk, $this->createExecuteOptions());
 
         return new BulkWriteResult($writeResult, $insertedIds);
     }

src/Operation/Delete.php

@@ -27,6 +27,7 @@
 use MongoDB\Exception\UnsupportedException;
 
 use function is_string;
+use function MongoDB\create_namespace;
 use function MongoDB\is_document;
 use function MongoDB\is_write_concern_acknowledged;
 use function MongoDB\server_supports_feature;
@@ -44,6 +45,8 @@ final class Delete implements Explainable
 {
     private const WIRE_VERSION_FOR_HINT = 9;
 
+    private string $namespace;
+
     /**
      * Constructs a delete command.
      *
@@ -80,8 +83,10 @@ final class Delete implements Explainable
      * @param array        $options        Command options
      * @throws InvalidArgumentException for parameter/option parsing errors
      */
-    public function __construct(private string $databaseName, private string $collectionName, private array|object $filter, private int $limit, private array $options = [])
+    public function __construct(string $databaseName, private string $collectionName, private array|object $filter, private int $limit, private array $options = [])
     {
+        $this->namespace = create_namespace($databaseName, $collectionName);
+
         if (! is_document($filter)) {
             throw InvalidArgumentException::expectedDocumentType('$filter', $filter);
         }
@@ -140,7 +145,7 @@ public function execute(Server $server): DeleteResult
         $bulk = new Bulk($this->createBulkWriteOptions());
         $bulk->delete($this->filter, $this->createDeleteOptions());
 
-        $writeResult = $server->executeBulkWrite($this->databaseName . '.' . $this->collectionName, $bulk, $this->createExecuteOptions());
+        $writeResult = $server->executeBulkWrite($this->namespace, $bulk, $this->createExecuteOptions());
 
         return new DeleteResult($writeResult);
     }

src/Operation/Find.php

@@ -34,6 +34,7 @@
 use function is_bool;
 use function is_integer;
 use function is_string;
+use function MongoDB\create_namespace;
 use function MongoDB\is_document;
 
 /**
@@ -49,6 +50,8 @@ final class Find implements Explainable
     public const TAILABLE = 2;
     public const TAILABLE_AWAIT = 3;
 
+    private string $namespace;
+
     /**
      * Constructs a find command.
      *
@@ -130,8 +133,10 @@ final class Find implements Explainable
      * @param array        $options        Command options
      * @throws InvalidArgumentException for parameter/option parsing errors
      */
-    public function __construct(private string $databaseName, private string $collectionName, private array|object $filter, private array $options = [])
+    public function __construct(string $databaseName, private string $collectionName, private array|object $filter, private array $options = [])
     {
+        $this->namespace = create_namespace($databaseName, $collectionName);
+
         if (! is_document($filter)) {
             throw InvalidArgumentException::expectedDocumentType('$filter', $filter);
         }
@@ -260,7 +265,7 @@ public function execute(Server $server): CursorInterface
             throw UnsupportedException::readConcernNotSupportedInTransaction();
         }
 
-        $cursor = $server->executeQuery($this->databaseName . '.' . $this->collectionName, new Query($this->filter, $this->createQueryOptions()), $this->createExecuteOptions());
+        $cursor = $server->executeQuery($this->namespace, new Query($this->filter, $this->createQueryOptions()), $this->createExecuteOptions());
 
         if (isset($this->options['codec'])) {
             return CodecCursor::fromCursor($cursor, $this->options['codec']);

src/Operation/InsertMany.php

@@ -29,6 +29,7 @@
 
 use function array_is_list;
 use function is_bool;
+use function MongoDB\create_namespace;
 use function MongoDB\is_document;
 use function sprintf;
 
@@ -45,6 +46,8 @@ final class InsertMany
 
     private array $options;
 
+    private string $namespace;
+
     /**
      * Constructs an insert command.
      *
@@ -75,8 +78,10 @@ final class InsertMany
      * @param array              $options        Command options
      * @throws InvalidArgumentException for parameter/option parsing errors
      */
-    public function __construct(private string $databaseName, private string $collectionName, array $documents, array $options = [])
+    public function __construct(string $databaseName, string $collectionName, array $documents, array $options = [])
     {
+        $this->namespace = create_namespace($databaseName, $collectionName);
+
         $options += ['ordered' => true];
 
         if (isset($options['bypassDocumentValidation']) && ! is_bool($options['bypassDocumentValidation'])) {
@@ -131,7 +136,7 @@ public function execute(Server $server): InsertManyResult
             $insertedIds[$i] = $bulk->insert($document);
         }
 
-        $writeResult = $server->executeBulkWrite($this->databaseName . '.' . $this->collectionName, $bulk, $this->createExecuteOptions());
+        $writeResult = $server->executeBulkWrite($this->namespace, $bulk, $this->createExecuteOptions());
 
         return new InsertManyResult($writeResult, $insertedIds);
     }

src/Operation/InsertOne.php

@@ -28,6 +28,7 @@
 use MongoDB\InsertOneResult;
 
 use function is_bool;
+use function MongoDB\create_namespace;
 use function MongoDB\is_document;
 
 /**
@@ -40,6 +41,8 @@ final class InsertOne
 {
     private array|object $document;
 
+    private string $namespace;
+
     /**
      * Constructs an insert command.
      *
@@ -65,8 +68,10 @@ final class InsertOne
      * @param array        $options        Command options
      * @throws InvalidArgumentException for parameter/option parsing errors
      */
-    public function __construct(private string $databaseName, private string $collectionName, array|object $document, private array $options = [])
+    public function __construct(string $databaseName, string $collectionName, array|object $document, private array $options = [])
     {
+        $this->namespace = create_namespace($databaseName, $collectionName);
+
         if (isset($this->options['bypassDocumentValidation']) && ! is_bool($this->options['bypassDocumentValidation'])) {
             throw InvalidArgumentException::invalidType('"bypassDocumentValidation" option', $this->options['bypassDocumentValidation'], 'boolean');
         }
@@ -111,7 +116,7 @@ public function execute(Server $server): InsertOneResult
 
         $insertedId = $bulk->insert($this->document);
 
-        $writeResult = $server->executeBulkWrite($this->databaseName . '.' . $this->collectionName, $bulk, $this->createExecuteOptions());
+        $writeResult = $server->executeBulkWrite($this->namespace, $bulk, $this->createExecuteOptions());
 
         return new InsertOneResult($writeResult, $insertedId);
     }

src/Operation/RenameCollection.php

@@ -26,6 +26,7 @@
 use MongoDB\Exception\UnsupportedException;
 
 use function is_bool;
+use function MongoDB\create_namespace;
 
 /**
  * Operation for the renameCollection command.
@@ -81,8 +82,8 @@ public function __construct(string $fromDatabaseName, string $fromCollectionName
             throw InvalidArgumentException::invalidType('"dropTarget" option', $this->options['dropTarget'], 'boolean');
         }
 
-        $this->fromNamespace = $fromDatabaseName . '.' . $fromCollectionName;
-        $this->toNamespace = $toDatabaseName . '.' . $toCollectionName;
+        $this->fromNamespace = create_namespace($fromDatabaseName, $fromCollectionName);
+        $this->toNamespace = create_namespace($toDatabaseName, $toCollectionName);
     }
 
     /**

src/Operation/Update.php

@@ -29,6 +29,7 @@
 use function is_array;
 use function is_bool;
 use function is_string;
+use function MongoDB\create_namespace;
 use function MongoDB\is_document;
 use function MongoDB\is_first_key_operator;
 use function MongoDB\is_pipeline;
@@ -46,6 +47,8 @@ final class Update implements Explainable
 {
     private array $options;
 
+    private string $namespace;
+
     /**
      * Constructs a update command.
      *
@@ -94,8 +97,10 @@ final class Update implements Explainable
      * @param array        $options        Command options
      * @throws InvalidArgumentException for parameter/option parsing errors
      */
-    public function __construct(private string $databaseName, private string $collectionName, private array|object $filter, private array|object $update, array $options = [])
+    public function __construct(string $databaseName, private string $collectionName, private array|object $filter, private array|object $update, array $options = [])
     {
+        $this->namespace = create_namespace($databaseName, $collectionName);
+
         if (! is_document($filter)) {
             throw InvalidArgumentException::expectedDocumentType('$filter', $filter);
         }
@@ -180,7 +185,7 @@ public function execute(Server $server): UpdateResult
         $bulk = new Bulk($this->createBulkWriteOptions());
         $bulk->update($this->filter, $this->update, $this->createUpdateOptions());
 
-        $writeResult = $server->executeBulkWrite($this->databaseName . '.' . $this->collectionName, $bulk, $this->createExecuteOptions());
+        $writeResult = $server->executeBulkWrite($this->namespace, $bulk, $this->createExecuteOptions());
 
         return new UpdateResult($writeResult);
     }

src/functions.php

@@ -45,6 +45,7 @@
 use function is_array;
 use function is_object;
 use function is_string;
+use function str_contains;
 use function str_ends_with;
 use function substr;
 
@@ -435,6 +436,30 @@ function is_string_array(mixed $input): bool
     return true;
 }
 
+/**
+ * Validates a database and collection name and returns the namespace formed
+ * by concatenating them.
+ *
+ * A "." or NUL byte in the database name, or a NUL byte in the collection
+ * name, would shift the namespace split performed by the server and cause
+ * the operation to silently target a different database or collection.
+ *
+ * @internal
+ * @throws InvalidArgumentException if either name is invalid
+ */
+function create_namespace(string $databaseName, string $collectionName): string
+{
+    if ($databaseName === '' || str_contains($databaseName, '.') || str_contains($databaseName, "\0")) {
+        throw new InvalidArgumentException('$databaseName is invalid: ' . $databaseName);
+    }
+
+    if ($collectionName === '' || str_contains($collectionName, "\0")) {
+        throw new InvalidArgumentException('$collectionName is invalid: ' . $collectionName);
+    }
+
+    return $databaseName . '.' . $collectionName;
+}
+
 /**
  * Performs a deep copy of a value.
  *

tests/Collection/CollectionFunctionalTest.php

@@ -35,27 +35,45 @@
  */
 class CollectionFunctionalTest extends FunctionalTestCase
 {
-    #[DataProvider('provideInvalidDatabaseAndCollectionNames')]
+    #[DataProvider('provideInvalidDatabaseNames')]
     public function testConstructorDatabaseNameArgument($databaseName, string $expectedExceptionClass): void
     {
         $this->expectException($expectedExceptionClass);
         // TODO: Move to unit test once ManagerInterface can be mocked (PHPC-378)
         new Collection($this->manager, $databaseName, $this->getCollectionName());
     }
 
-    #[DataProvider('provideInvalidDatabaseAndCollectionNames')]
+    #[DataProvider('provideInvalidCollectionNames')]
     public function testConstructorCollectionNameArgument($collectionName, string $expectedExceptionClass): void
     {
         $this->expectException($expectedExceptionClass);
         // TODO: Move to unit test once ManagerInterface can be mocked (PHPC-378)
         new Collection($this->manager, $this->getDatabaseName(), $collectionName);
     }
 
-    public static function provideInvalidDatabaseAndCollectionNames()
+    public function testConstructorAllowsDotInCollectionName(): void
+    {
+        $collection = new Collection($this->manager, $this->getDatabaseName(), 'foo.bar');
+
+        $this->assertSame('foo.bar', $collection->getCollectionName());
+    }
+
+    public static function provideInvalidDatabaseNames()
+    {
+        return [
+            [null, TypeError::class],
+            ['', InvalidArgumentException::class],
+            ['foo.bar', InvalidArgumentException::class],
+            ["foo\0bar", InvalidArgumentException::class],
+        ];
+    }
+
+    public static function provideInvalidCollectionNames()
     {
         return [
             [null, TypeError::class],
             ['', InvalidArgumentException::class],
+            ["foo\0bar", InvalidArgumentException::class],
         ];
     }
 

tests/Database/DatabaseFunctionalTest.php

@@ -39,6 +39,8 @@ public static function provideInvalidDatabaseNames()
         return [
             [null, TypeError::class],
             ['', InvalidArgumentException::class],
+            ['foo.bar', InvalidArgumentException::class],
+            ["foo\0bar", InvalidArgumentException::class],
         ];
     }