Introduce new exception factory for expected document type

mongodb · Jun 27, 2023 · e9e5636 · e9e5636
1 parent 72cbcc1
commit e9e5636
Show file tree

Hide file tree

Showing 34 changed files with 96 additions and 85 deletions.
diff --git a/src/Command/ListCollections.php b/src/Command/ListCollections.php
@@ -79,7 +79,7 @@ public function __construct(string $databaseName, array $options = [])
         }
 
         if (isset($options['filter']) && ! is_document($options['filter'])) {
-            throw InvalidArgumentException::invalidType('"filter" option', $options['filter'], 'document');
+            throw InvalidArgumentException::expectedDocumentType('"filter" option', $options['filter']);
         }
 
         if (isset($options['maxTimeMS']) && ! is_integer($options['maxTimeMS'])) {

diff --git a/src/Command/ListDatabases.php b/src/Command/ListDatabases.php
@@ -77,7 +77,7 @@ public function __construct(array $options = [])
         }
 
         if (isset($options['filter']) && ! is_document($options['filter'])) {
-            throw InvalidArgumentException::invalidType('"filter" option', $options['filter'], 'document');
+            throw InvalidArgumentException::expectedDocumentType('"filter" option', $options['filter']);
         }
 
         if (isset($options['maxTimeMS']) && ! is_integer($options['maxTimeMS'])) {

diff --git a/src/Exception/InvalidArgumentException.php b/src/Exception/InvalidArgumentException.php
@@ -46,6 +46,17 @@ public static function invalidType(string $name, $value, $expectedType)
         return new static(sprintf('Expected %s to have type "%s" but found "%s"', $name, $expectedType, get_debug_type($value)));
     }
 
+    /**
+     * Thrown when an argument or option is expected to be a document.
+     *
+     * @param string $name  Name of the argument or option
+     * @param mixed  $value Actual value (used to derive the type)
+     */
+    public static function expectedDocumentType(string $name, $value): self
+    {
+        return new self(sprintf('Expected %s to have type "document" (array or object) but found "%s"', $name, get_debug_type($value)));
+    }
+
     /** @param list<string> $types */
     private static function expectedTypesToString(array $types): string
     {

diff --git a/src/GridFS/WritableStream.php b/src/GridFS/WritableStream.php
@@ -130,7 +130,7 @@ public function __construct(CollectionWrapper $collectionWrapper, string $filena
         }
 
         if (isset($options['metadata']) && ! is_document($options['metadata'])) {
-            throw InvalidArgumentException::invalidType('"metadata" option', $options['metadata'], 'document');
+            throw InvalidArgumentException::expectedDocumentType('"metadata" option', $options['metadata']);
         }
 
         $this->chunkSize = $options['chunkSizeBytes'];

diff --git a/src/Model/ChangeStreamIterator.php b/src/Model/ChangeStreamIterator.php
@@ -77,7 +77,7 @@ class ChangeStreamIterator extends IteratorIterator implements CommandSubscriber
     public function __construct(Cursor $cursor, int $firstBatchSize, $initialResumeToken, ?object $postBatchResumeToken)
     {
         if (isset($initialResumeToken) && ! is_document($initialResumeToken)) {
-            throw InvalidArgumentException::invalidType('$initialResumeToken', $initialResumeToken, 'document');
+            throw InvalidArgumentException::expectedDocumentType('$initialResumeToken', $initialResumeToken);
         }
 
         parent::__construct($cursor);
@@ -236,7 +236,7 @@ public function valid(): bool
     private function extractResumeToken($document)
     {
         if (! is_document($document)) {
-            throw InvalidArgumentException::invalidType('$document', $document, 'document');
+            throw InvalidArgumentException::expectedDocumentType('$document', $document);
         }
 
         if ($document instanceof Serializable) {

diff --git a/src/Model/IndexInput.php b/src/Model/IndexInput.php
@@ -53,7 +53,7 @@ public function __construct(array $index)
         }
 
         if (! is_document($index['key'])) {
-            throw InvalidArgumentException::invalidType('"key" option', $index['key'], 'document');
+            throw InvalidArgumentException::expectedDocumentType('"key" option', $index['key']);
         }
 
         foreach ($index['key'] as $fieldName => $order) {

diff --git a/src/Operation/Aggregate.php b/src/Operation/Aggregate.php
@@ -157,7 +157,7 @@ public function __construct(string $databaseName, ?string $collectionName, array
         }
 
         if (isset($options['collation']) && ! is_document($options['collation'])) {
-            throw InvalidArgumentException::invalidType('"collation" option', $options['collation'], 'document');
+            throw InvalidArgumentException::expectedDocumentType('"collation" option', $options['collation']);
         }
 
         if (isset($options['explain']) && ! is_bool($options['explain'])) {
@@ -169,7 +169,7 @@ public function __construct(string $databaseName, ?string $collectionName, array
         }
 
         if (isset($options['let']) && ! is_document($options['let'])) {
-            throw InvalidArgumentException::invalidType('"let" option', $options['let'], 'document');
+            throw InvalidArgumentException::expectedDocumentType('"let" option', $options['let']);
         }
 
         if (isset($options['maxAwaitTimeMS']) && ! is_integer($options['maxAwaitTimeMS'])) {

diff --git a/src/Operation/BulkWrite.php b/src/Operation/BulkWrite.php
@@ -154,7 +154,7 @@ public function __construct(string $databaseName, string $collectionName, array
             }
 
             if (! is_document($args[0])) {
-                throw InvalidArgumentException::invalidType(sprintf('$operations[%d]["%s"][0]', $i, $type), $args[0], 'document');
+                throw InvalidArgumentException::expectedDocumentType(sprintf('$operations[%d]["%s"][0]', $i, $type), $args[0]);
             }
 
             switch ($type) {
@@ -174,7 +174,7 @@ public function __construct(string $databaseName, string $collectionName, array
                     $args[1]['limit'] = ($type === self::DELETE_ONE ? 1 : 0);
 
                     if (isset($args[1]['collation']) && ! is_document($args[1]['collation'])) {
-                        throw InvalidArgumentException::invalidType(sprintf('$operations[%d]["%s"][1]["collation"]', $i, $type), $args[1]['collation'], 'document');
+                        throw InvalidArgumentException::expectedDocumentType(sprintf('$operations[%d]["%s"][1]["collation"]', $i, $type), $args[1]['collation']);
                     }
 
                     $operations[$i][$type][1] = $args[1];
@@ -187,7 +187,7 @@ public function __construct(string $databaseName, string $collectionName, array
                     }
 
                     if (! is_document($args[1])) {
-                        throw InvalidArgumentException::invalidType(sprintf('$operations[%d]["%s"][1]', $i, $type), $args[1], 'document');
+                        throw InvalidArgumentException::expectedDocumentType(sprintf('$operations[%d]["%s"][1]', $i, $type), $args[1]);
                     }
 
                     // Treat empty arrays as replacement documents for BC
@@ -215,7 +215,7 @@ public function __construct(string $databaseName, string $collectionName, array
                     $args[2] += ['upsert' => false];
 
                     if (isset($args[2]['collation']) && ! is_document($args[2]['collation'])) {
-                        throw InvalidArgumentException::invalidType(sprintf('$operations[%d]["%s"][2]["collation"]', $i, $type), $args[2]['collation'], 'document');
+                        throw InvalidArgumentException::expectedDocumentType(sprintf('$operations[%d]["%s"][2]["collation"]', $i, $type), $args[2]['collation']);
                     }
 
                     if (! is_bool($args[2]['upsert'])) {
@@ -252,7 +252,7 @@ public function __construct(string $databaseName, string $collectionName, array
                     }
 
                     if (isset($args[2]['collation']) && ! is_document($args[2]['collation'])) {
-                        throw InvalidArgumentException::invalidType(sprintf('$operations[%d]["%s"][2]["collation"]', $i, $type), $args[2]['collation'], 'document');
+                        throw InvalidArgumentException::expectedDocumentType(sprintf('$operations[%d]["%s"][2]["collation"]', $i, $type), $args[2]['collation']);
                     }
 
                     if (! is_bool($args[2]['upsert'])) {
@@ -287,7 +287,7 @@ public function __construct(string $databaseName, string $collectionName, array
         }
 
         if (isset($options['let']) && ! is_document($options['let'])) {
-            throw InvalidArgumentException::invalidType('"let" option', $options['let'], 'document');
+            throw InvalidArgumentException::expectedDocumentType('"let" option', $options['let']);
         }
 
         if (isset($options['bypassDocumentValidation']) && ! $options['bypassDocumentValidation']) {

diff --git a/src/Operation/Count.php b/src/Operation/Count.php
@@ -93,11 +93,11 @@ class Count implements Executable, Explainable
     public function __construct(string $databaseName, string $collectionName, $filter = [], array $options = [])
     {
         if (! is_document($filter)) {
-            throw InvalidArgumentException::invalidType('$filter', $filter, 'document');
+            throw InvalidArgumentException::expectedDocumentType('$filter', $filter);
         }
 
         if (isset($options['collation']) && ! is_document($options['collation'])) {
-            throw InvalidArgumentException::invalidType('"collation" option', $options['collation'], 'document');
+            throw InvalidArgumentException::expectedDocumentType('"collation" option', $options['collation']);
         }
 
         if (isset($options['hint']) && ! is_string($options['hint']) && ! is_array($options['hint']) && ! is_object($options['hint'])) {

diff --git a/src/Operation/CountDocuments.php b/src/Operation/CountDocuments.php
@@ -97,7 +97,7 @@ class CountDocuments implements Executable
     public function __construct(string $databaseName, string $collectionName, $filter, array $options = [])
     {
         if (! is_document($filter)) {
-            throw InvalidArgumentException::invalidType('$filter', $filter, 'document');
+            throw InvalidArgumentException::expectedDocumentType('$filter', $filter);
         }
 
         if (isset($options['limit']) && ! is_integer($options['limit'])) {

diff --git a/src/Operation/CreateCollection.php b/src/Operation/CreateCollection.php
@@ -153,19 +153,19 @@ public function __construct(string $databaseName, string $collectionName, array
         }
 
         if (isset($options['changeStreamPreAndPostImages']) && ! is_document($options['changeStreamPreAndPostImages'])) {
-            throw InvalidArgumentException::invalidType('"changeStreamPreAndPostImages" option', $options['changeStreamPreAndPostImages'], 'document');
+            throw InvalidArgumentException::expectedDocumentType('"changeStreamPreAndPostImages" option', $options['changeStreamPreAndPostImages']);
         }
 
         if (isset($options['clusteredIndex']) && ! is_document($options['clusteredIndex'])) {
-            throw InvalidArgumentException::invalidType('"clusteredIndex" option', $options['clusteredIndex'], 'document');
+            throw InvalidArgumentException::expectedDocumentType('"clusteredIndex" option', $options['clusteredIndex']);
         }
 
         if (isset($options['collation']) && ! is_document($options['collation'])) {
-            throw InvalidArgumentException::invalidType('"collation" option', $options['collation'], 'document');
+            throw InvalidArgumentException::expectedDocumentType('"collation" option', $options['collation']);
         }
 
         if (isset($options['encryptedFields']) && ! is_document($options['encryptedFields'])) {
-            throw InvalidArgumentException::invalidType('"encryptedFields" option', $options['encryptedFields'], 'document');
+            throw InvalidArgumentException::expectedDocumentType('"encryptedFields" option', $options['encryptedFields']);
         }
 
         if (isset($options['expireAfterSeconds']) && ! is_integer($options['expireAfterSeconds'])) {
@@ -177,7 +177,7 @@ public function __construct(string $databaseName, string $collectionName, array
         }
 
         if (isset($options['indexOptionDefaults']) && ! is_document($options['indexOptionDefaults'])) {
-            throw InvalidArgumentException::invalidType('"indexOptionDefaults" option', $options['indexOptionDefaults'], 'document');
+            throw InvalidArgumentException::expectedDocumentType('"indexOptionDefaults" option', $options['indexOptionDefaults']);
         }
 
         if (isset($options['max']) && ! is_integer($options['max'])) {
@@ -201,11 +201,11 @@ public function __construct(string $databaseName, string $collectionName, array
         }
 
         if (isset($options['storageEngine']) && ! is_document($options['storageEngine'])) {
-            throw InvalidArgumentException::invalidType('"storageEngine" option', $options['storageEngine'], 'document');
+            throw InvalidArgumentException::expectedDocumentType('"storageEngine" option', $options['storageEngine']);
         }
 
         if (isset($options['timeseries']) && ! is_document($options['timeseries'])) {
-            throw InvalidArgumentException::invalidType('"timeseries" option', $options['timeseries'], 'document');
+            throw InvalidArgumentException::expectedDocumentType('"timeseries" option', $options['timeseries']);
         }
 
         if (isset($options['typeMap']) && ! is_array($options['typeMap'])) {
@@ -221,7 +221,7 @@ public function __construct(string $databaseName, string $collectionName, array
         }
 
         if (isset($options['validator']) && ! is_document($options['validator'])) {
-            throw InvalidArgumentException::invalidType('"validator" option', $options['validator'], 'document');
+            throw InvalidArgumentException::expectedDocumentType('"validator" option', $options['validator']);
         }
 
         if (isset($options['viewOn']) && ! is_string($options['viewOn'])) {

diff --git a/src/Operation/CreateEncryptedCollection.php b/src/Operation/CreateEncryptedCollection.php
@@ -84,7 +84,7 @@ public function __construct(string $databaseName, string $collectionName, array
         }
 
         if (! is_document($options['encryptedFields'])) {
-            throw InvalidArgumentException::invalidType('"encryptedFields" option', $options['encryptedFields'], 'document');
+            throw InvalidArgumentException::expectedDocumentType('"encryptedFields" option', $options['encryptedFields']);
         }
 
         $this->createCollection = new CreateCollection($databaseName, $collectionName, $options);

diff --git a/src/Operation/DatabaseCommand.php b/src/Operation/DatabaseCommand.php
@@ -67,7 +67,7 @@ class DatabaseCommand implements Executable
     public function __construct(string $databaseName, $command, array $options = [])
     {
         if (! is_document($command)) {
-            throw InvalidArgumentException::invalidType('$command', $command, 'document');
+            throw InvalidArgumentException::expectedDocumentType('$command', $command);
         }
 
         if (isset($options['readPreference']) && ! $options['readPreference'] instanceof ReadPreference) {

diff --git a/src/Operation/Delete.php b/src/Operation/Delete.php
@@ -100,15 +100,15 @@ class Delete implements Executable, Explainable
     public function __construct(string $databaseName, string $collectionName, $filter, int $limit, array $options = [])
     {
         if (! is_document($filter)) {
-            throw InvalidArgumentException::invalidType('$filter', $filter, 'document');
+            throw InvalidArgumentException::expectedDocumentType('$filter', $filter);
         }
 
         if ($limit !== 0 && $limit !== 1) {
             throw new InvalidArgumentException('$limit must be 0 or 1');
         }
 
         if (isset($options['collation']) && ! is_document($options['collation'])) {
-            throw InvalidArgumentException::invalidType('"collation" option', $options['collation'], 'document');
+            throw InvalidArgumentException::expectedDocumentType('"collation" option', $options['collation']);
         }
 
         if (isset($options['hint']) && ! is_string($options['hint']) && ! is_array($options['hint']) && ! is_object($options['hint'])) {
@@ -124,7 +124,7 @@ public function __construct(string $databaseName, string $collectionName, $filte
         }
 
         if (isset($options['let']) && ! is_document($options['let'])) {
-            throw InvalidArgumentException::invalidType('"let" option', $options['let'], 'document');
+            throw InvalidArgumentException::expectedDocumentType('"let" option', $options['let']);
         }
 
         if (isset($options['writeConcern']) && $options['writeConcern']->isDefault()) {

diff --git a/src/Operation/Distinct.php b/src/Operation/Distinct.php
@@ -89,11 +89,11 @@ class Distinct implements Executable, Explainable
     public function __construct(string $databaseName, string $collectionName, string $fieldName, $filter = [], array $options = [])
     {
         if (! is_document($filter)) {
-            throw InvalidArgumentException::invalidType('$filter', $filter, 'document');
+            throw InvalidArgumentException::expectedDocumentType('$filter', $filter);
         }
 
         if (isset($options['collation']) && ! is_document($options['collation'])) {
-            throw InvalidArgumentException::invalidType('"collation" option', $options['collation'], 'document');
+            throw InvalidArgumentException::expectedDocumentType('"collation" option', $options['collation']);
         }
 
         if (isset($options['maxTimeMS']) && ! is_integer($options['maxTimeMS'])) {

diff --git a/src/Operation/DropEncryptedCollection.php b/src/Operation/DropEncryptedCollection.php
@@ -68,7 +68,7 @@ public function __construct(string $databaseName, string $collectionName, array
         }
 
         if (! is_document($options['encryptedFields'])) {
-            throw InvalidArgumentException::invalidType('"encryptedFields" option', $options['encryptedFields'], 'document');
+            throw InvalidArgumentException::expectedDocumentType('"encryptedFields" option', $options['encryptedFields']);
         }
 
         /** @psalm-var array{ecocCollection?: ?string, escCollection?: ?string} */