Explicit result iteration and require filter/pipeline args

Remove automatic result iteration in Operation::execute(), since ChangeStreams will no longer be the lone exception once createFindCursor is implemented.

Additionally, filter/pipeline args need not default since they are required by the CRUD and change stream specs and present in all valid spec tests. The previous behavior would conflict with a forthcoming "createFindCursor fails if filter is not specified" test.

Author: jmikola

tests/UnifiedSpecTests/Operation.php

@@ -18,7 +18,6 @@
 use PHPUnit\Framework\AssertionFailedError;
 use stdClass;
 use Throwable;
-use Traversable;
 use function array_diff_key;
 use function array_key_exists;
 use function array_map;
@@ -204,10 +203,6 @@ private function execute()
                 Assert::fail('Unsupported entity type: ' . get_class($object));
         }
 
-        if ($result instanceof Traversable && ! $result instanceof ChangeStream) {
-            return iterator_to_array($result);
-        }
-
         return $result;
     }
 
@@ -249,16 +244,16 @@ private function executeForClient(Client $client)
         switch ($this->name) {
             case 'createChangeStream':
                 $changeStream = $client->watch(
-                    $args['pipeline'] ?? [],
+                    $args['pipeline'],
                     array_diff_key($args, ['pipeline' => 1])
                 );
                 $changeStream->rewind();
 
                 return $changeStream;
             case 'listDatabaseNames':
-                return $client->listDatabaseNames($args);
+                return iterator_to_array($client->listDatabaseNames($args));
             case 'listDatabases':
-                return $client->listDatabases($args);
+                return iterator_to_array($client->listDatabases($args));
             default:
                 Assert::fail('Unsupported client operation: ' . $this->name);
         }
@@ -270,18 +265,18 @@ private function executeForCollection(Collection $collection)
 
         switch ($this->name) {
             case 'aggregate':
-                return $collection->aggregate(
+                return iterator_to_array($collection->aggregate(
                     $args['pipeline'],
                     array_diff_key($args, ['pipeline' => 1])
-                );
+                ));
             case 'bulkWrite':
                 return $collection->bulkWrite(
                     array_map('self::prepareBulkWriteRequest', $args['requests']),
                     array_diff_key($args, ['requests' => 1])
                 );
             case 'createChangeStream':
                 $changeStream = $collection->watch(
-                    $args['pipeline'] ?? [],
+                    $args['pipeline'],
                     array_diff_key($args, ['pipeline' => 1])
                 );
                 $changeStream->rewind();
@@ -299,9 +294,8 @@ private function executeForCollection(Collection $collection)
                 );
             case 'count':
             case 'countDocuments':
-            case 'find':
                 return $collection->{$this->name}(
-                    $args['filter'] ?? [],
+                    $args['filter'],
                     array_diff_key($args, ['filter' => 1])
                 );
             case 'estimatedDocumentCount':
@@ -321,11 +315,16 @@ private function executeForCollection(Collection $collection)
 
                 return $collection->distinct(
                     $args['fieldName'],
-                    $args['filter'] ?? [],
+                    $args['filter'],
                     array_diff_key($args, ['fieldName' => 1, 'filter' => 1])
                 );
             case 'drop':
                 return $collection->drop($args);
+            case 'find':
+                return iterator_to_array($collection->find(
+                    $args['filter'],
+                    array_diff_key($args, ['filter' => 1])
+                ));
             case 'findOne':
                 return $collection->findOne($args['filter'], array_diff_key($args, ['filter' => 1]));
             case 'findOneAndReplace':
@@ -378,7 +377,7 @@ private function executeForCollection(Collection $collection)
                     array_diff_key($args, ['document' => 1])
                 );
             case 'listIndexes':
-                return $collection->listIndexes($args);
+                return iterator_to_array($collection->listIndexes($args));
             case 'mapReduce':
                 return $collection->mapReduce(
                     $args['map'],
@@ -397,13 +396,13 @@ private function executeForDatabase(Database $database)
 
         switch ($this->name) {
             case 'aggregate':
-                return $database->aggregate(
+                return iterator_to_array($database->aggregate(
                     $args['pipeline'],
                     array_diff_key($args, ['pipeline' => 1])
-                );
+                ));
             case 'createChangeStream':
                 $changeStream = $database->watch(
-                    $args['pipeline'] ?? [],
+                    $args['pipeline'],
                     array_diff_key($args, ['pipeline' => 1])
                 );
                 $changeStream->rewind();
@@ -420,9 +419,9 @@ private function executeForDatabase(Database $database)
                     array_diff_key($args, ['collection' => 1])
                 );
             case 'listCollectionNames':
-                return $database->listCollectionNames($args);
+                return iterator_to_array($database->listCollectionNames($args));
             case 'listCollections':
-                return $database->listCollections($args);
+                return iterator_to_array($database->listCollections($args));
             case 'runCommand':
                 return $database->command(
                     $args['command'],