PHPLIB-1523: Remove iterators for database, collection, and index enu…

…meration
mongodb · Sep 26, 2024 · f95d1cb · f95d1cb
1 parent f4cc84e
commit f95d1cb
Show file tree

Hide file tree

Showing 26 changed files with 93 additions and 529 deletions.
diff --git a/UPGRADE-2.0.md b/UPGRADE-2.0.md
@@ -6,10 +6,18 @@ UPGRADE FROM 1.x to 2.0
  * The `MongoDB\ChangeStream::CURSOR_NOT_FOUND` constant is now private.
  * The `MongoDB\Operation\Watch::FULL_DOCUMENT_DEFAULT` constant has been
    removed.
- * The `MongoDB\Model\IndexInfo::isGeoHaystack` method has been removed.
+ * The `getNamespace` and `isGeoHaystack` methods hav been removed from the
+   `MongoDB\Model\IndexInfo` class.
  * The `maxScan`, `modifiers`, `oplogReplay`, and `snapshot` options for `find`
    and `findOne` operations have been removed.
- * The `MongoDB\Operation\Executable` interface has been removed.
+ * The following classes and interfaces have been removed without replacement:
+   * `MongoDB\Operation\Executable`
+   * `MongoDB\Model\CollectionInfoCommandIterator`
+   * `MongoDB\Model\CollectionInfoIterator`
+   * `MongoDB\Model\DatabaseInfoIterator`
+   * `MongoDB\Model\DatabaseInfoLegacyIterator`
+   * `MongoDB\Model\IndexInfoIterator`
+   * `MongoDB\Model\IndexInfoIteratorIterator`
 
 GridFS
 ------

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -180,22 +180,13 @@
     </RedundantConditionGivenDocblockType>
   </file>
   <file src="src/Client.php">
-    <DeprecatedInterface>
-      <code><![CDATA[DatabaseInfoIterator]]></code>
-    </DeprecatedInterface>
-    <MismatchingDocblockReturnType>
-      <code><![CDATA[Iterator<int, DatabaseInfo>]]></code>
-    </MismatchingDocblockReturnType>
     <MixedArgument>
       <code><![CDATA[$driverOptions['driver'] ?? []]]></code>
       <code><![CDATA[$pipeline]]></code>
     </MixedArgument>
     <MixedAssignment>
       <code><![CDATA[$mergedDriver['platform']]]></code>
     </MixedAssignment>
-    <MixedInferredReturnType>
-      <code><![CDATA[Iterator<int, DatabaseInfo>]]></code>
-    </MixedInferredReturnType>
     <MixedPropertyTypeCoercion>
       <code><![CDATA[$driverOptions['builderEncoder'] ?? new BuilderEncoder()]]></code>
     </MixedPropertyTypeCoercion>
@@ -227,19 +218,10 @@
     </MixedArgumentTypeCoercion>
   </file>
   <file src="src/Collection.php">
-    <DeprecatedInterface>
-      <code><![CDATA[IndexInfoIterator]]></code>
-    </DeprecatedInterface>
-    <MismatchingDocblockReturnType>
-      <code><![CDATA[Iterator<int, IndexInfo>]]></code>
-    </MismatchingDocblockReturnType>
     <MixedArgument>
       <code><![CDATA[$pipeline]]></code>
       <code><![CDATA[$pipeline]]></code>
     </MixedArgument>
-    <MixedInferredReturnType>
-      <code><![CDATA[Iterator<int, IndexInfo>]]></code>
-    </MixedInferredReturnType>
     <MixedPropertyTypeCoercion>
       <code><![CDATA[$options['builderEncoder'] ?? new BuilderEncoder()]]></code>
     </MixedPropertyTypeCoercion>
@@ -266,19 +248,10 @@
     </MixedAssignment>
   </file>
   <file src="src/Database.php">
-    <DeprecatedInterface>
-      <code><![CDATA[CollectionInfoIterator]]></code>
-    </DeprecatedInterface>
-    <MismatchingDocblockReturnType>
-      <code><![CDATA[Iterator<int, CollectionInfo>]]></code>
-    </MismatchingDocblockReturnType>
     <MixedArgument>
       <code><![CDATA[$pipeline]]></code>
       <code><![CDATA[$pipeline]]></code>
     </MixedArgument>
-    <MixedInferredReturnType>
-      <code><![CDATA[Iterator<int, CollectionInfo>]]></code>
-    </MixedInferredReturnType>
     <MixedPropertyTypeCoercion>
       <code><![CDATA[$options['builderEncoder'] ?? new BuilderEncoder()]]></code>
     </MixedPropertyTypeCoercion>
@@ -383,34 +356,6 @@
       <code><![CDATA[$this->current()]]></code>
     </PossiblyNullArgument>
   </file>
-  <file src="src/Model/CollectionInfoCommandIterator.php">
-    <DeprecatedInterface>
-      <code><![CDATA[CollectionInfoCommandIterator]]></code>
-    </DeprecatedInterface>
-    <MixedArrayAssignment>
-      <code><![CDATA[$info['idIndex']['ns']]]></code>
-    </MixedArrayAssignment>
-    <MixedOperand>
-      <code><![CDATA[$info['name']]]></code>
-    </MixedOperand>
-  </file>
-  <file src="src/Model/DatabaseInfoLegacyIterator.php">
-    <DeprecatedInterface>
-      <code><![CDATA[DatabaseInfoLegacyIterator]]></code>
-    </DeprecatedInterface>
-    <MixedArgument>
-      <code><![CDATA[current($this->databases)]]></code>
-    </MixedArgument>
-    <MixedReturnTypeCoercion>
-      <code><![CDATA[int]]></code>
-      <code><![CDATA[key($this->databases)]]></code>
-    </MixedReturnTypeCoercion>
-  </file>
-  <file src="src/Model/IndexInfoIteratorIterator.php">
-    <DeprecatedInterface>
-      <code><![CDATA[IndexInfoIteratorIterator]]></code>
-    </DeprecatedInterface>
-  </file>
   <file src="src/Model/IndexInput.php">
     <LessSpecificReturnStatement>
       <code><![CDATA[(object) $this->index]]></code>
@@ -793,47 +738,11 @@
       <code><![CDATA[$document]]></code>
     </PossiblyInvalidArgument>
   </file>
-  <file src="src/Operation/ListCollections.php">
-    <DeprecatedInterface>
-      <code><![CDATA[CollectionInfoIterator]]></code>
-    </DeprecatedInterface>
-    <MismatchingDocblockReturnType>
-      <code><![CDATA[Iterator<int, CollectionInfo>]]></code>
-    </MismatchingDocblockReturnType>
-    <MixedInferredReturnType>
-      <code><![CDATA[Iterator<int, CollectionInfo>]]></code>
-    </MixedInferredReturnType>
-  </file>
-  <file src="src/Operation/ListDatabases.php">
-    <DeprecatedInterface>
-      <code><![CDATA[DatabaseInfoIterator]]></code>
-    </DeprecatedInterface>
-    <MismatchingDocblockReturnType>
-      <code><![CDATA[Iterator<int, DatabaseInfo>]]></code>
-    </MismatchingDocblockReturnType>
-    <MixedInferredReturnType>
-      <code><![CDATA[Iterator<int, DatabaseInfo>]]></code>
-    </MixedInferredReturnType>
-  </file>
   <file src="src/Operation/ListIndexes.php">
-    <DeprecatedClass>
-      <code><![CDATA[IndexInfoIteratorIterator]]></code>
-      <code><![CDATA[new IndexInfoIteratorIterator($iterator, $this->databaseName . '.' . $this->collectionName)]]></code>
-      <code><![CDATA[new IndexInfoIteratorIterator(new EmptyIterator())]]></code>
-    </DeprecatedClass>
-    <DeprecatedInterface>
-      <code><![CDATA[IndexInfoIterator]]></code>
-    </DeprecatedInterface>
-    <MismatchingDocblockReturnType>
-      <code><![CDATA[Iterator<int, IndexInfo>]]></code>
-    </MismatchingDocblockReturnType>
     <MixedAssignment>
       <code><![CDATA[$cmd[$option]]]></code>
       <code><![CDATA[$options['session']]]></code>
     </MixedAssignment>
-    <MixedInferredReturnType>
-      <code><![CDATA[Iterator<int, IndexInfo>]]></code>
-    </MixedInferredReturnType>
   </file>
   <file src="src/Operation/MapReduce.php">
     <MixedArgument>

diff --git a/src/Client.php b/src/Client.php
@@ -39,7 +39,6 @@
 use MongoDB\Model\BSONArray;
 use MongoDB\Model\BSONDocument;
 use MongoDB\Model\DatabaseInfo;
-use MongoDB\Model\DatabaseInfoIterator;
 use MongoDB\Operation\DropDatabase;
 use MongoDB\Operation\ListDatabaseNames;
 use MongoDB\Operation\ListDatabases;
@@ -305,7 +304,7 @@ public function listDatabaseNames(array $options = []): Iterator
      * @throws InvalidArgumentException for parameter/option parsing errors
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */
-    public function listDatabases(array $options = []): DatabaseInfoIterator
+    public function listDatabases(array $options = []): Iterator
     {
         $operation = new ListDatabases($options);
         $server = select_server($this->manager, $options);

diff --git a/src/Collection.php b/src/Collection.php
@@ -38,7 +38,6 @@
 use MongoDB\Model\BSONArray;
 use MongoDB\Model\BSONDocument;
 use MongoDB\Model\IndexInfo;
-use MongoDB\Model\IndexInfoIterator;
 use MongoDB\Operation\Aggregate;
 use MongoDB\Operation\BulkWrite;
 use MongoDB\Operation\Count;
@@ -884,7 +883,7 @@ public function insertOne(array|object $document, array $options = []): InsertOn
      * @throws InvalidArgumentException for parameter/option parsing errors
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */
-    public function listIndexes(array $options = []): IndexInfoIterator
+    public function listIndexes(array $options = []): Iterator
     {
         $operation = new ListIndexes($this->databaseName, $this->collectionName, $options);
 

diff --git a/src/Command/ListCollections.php b/src/Command/ListCollections.php
@@ -18,12 +18,11 @@
 namespace MongoDB\Command;
 
 use MongoDB\Driver\Command;
-use MongoDB\Driver\Cursor;
+use MongoDB\Driver\CursorInterface;
 use MongoDB\Driver\Exception\RuntimeException as DriverRuntimeException;
 use MongoDB\Driver\Server;
 use MongoDB\Driver\Session;
 use MongoDB\Exception\InvalidArgumentException;
-use MongoDB\Model\CachingIterator;
 
 use function is_bool;
 use function is_integer;
@@ -92,16 +91,16 @@ public function __construct(private string $databaseName, private array $options
     /**
      * Execute the operation.
      *
-     * @return CachingIterator<int, array>
+     * @return CursorInterface<array>
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */
-    public function execute(Server $server): CachingIterator
+    public function execute(Server $server): CursorInterface
     {
-        /** @var Cursor<array> $cursor */
+        /** @var CursorInterface<array> $cursor */
         $cursor = $server->executeReadCommand($this->databaseName, $this->createCommand(), $this->createOptions());
         $cursor->setTypeMap(['root' => 'array', 'document' => 'array']);
 
-        return new CachingIterator($cursor);
+        return $cursor;
     }
 
     /**

diff --git a/src/Command/ListDatabases.php b/src/Command/ListDatabases.php
@@ -100,6 +100,7 @@ public function execute(Server $server): array
     {
         $cursor = $server->executeReadCommand('admin', $this->createCommand(), $this->createOptions());
         $cursor->setTypeMap(['root' => 'array', 'document' => 'array']);
+
         $result = current($cursor->toArray());
 
         if (! isset($result['databases']) || ! is_array($result['databases'])) {

diff --git a/src/Database.php b/src/Database.php
@@ -38,7 +38,6 @@
 use MongoDB\Model\BSONArray;
 use MongoDB\Model\BSONDocument;
 use MongoDB\Model\CollectionInfo;
-use MongoDB\Model\CollectionInfoIterator;
 use MongoDB\Operation\Aggregate;
 use MongoDB\Operation\CreateCollection;
 use MongoDB\Operation\CreateEncryptedCollection;
@@ -479,7 +478,7 @@ public function listCollectionNames(array $options = []): Iterator
      * @throws InvalidArgumentException for parameter/option parsing errors
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */
-    public function listCollections(array $options = []): CollectionInfoIterator
+    public function listCollections(array $options = []): Iterator
     {
         $operation = new ListCollections($this->databaseName, $options);
         $server = select_server($this->manager, $options);

diff --git a/src/Model/CallbackIterator.php b/src/Model/CallbackIterator.php
@@ -28,7 +28,7 @@
  *
  * @internal
  *
- * @template TKey
+ * @template TKey of array-key
  * @template TValue
  * @template TCallbackValue
  * @template-implements Iterator<TKey, TCallbackValue>

diff --git a/src/Model/CollectionInfoCommandIterator.php b/src/Model/CollectionInfoCommandIterator.php
diff --git a/src/Model/CollectionInfoIterator.php b/src/Model/CollectionInfoIterator.php