PHPLIB-1419 Encode Agg builder objects in Collection methods

Author: GromNaN

src/Collection.php

@@ -21,6 +21,7 @@
 use Iterator;
 use MongoDB\BSON\JavascriptInterface;
 use MongoDB\Builder\BuilderEncoder;
+use MongoDB\Builder\Pipeline;
 use MongoDB\Codec\DocumentCodec;
 use MongoDB\Codec\Encoder;
 use MongoDB\Driver\CursorInterface;
@@ -216,8 +217,9 @@ public function __toString()
      * @throws InvalidArgumentException for parameter/option parsing errors
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */
-    public function aggregate(array $pipeline, array $options = [])
+    public function aggregate(array|Pipeline $pipeline, array $options = [])
     {
+        $pipeline = $this->builderEncoder->encodeIfSupported($pipeline);
         $hasWriteStage = is_last_pipeline_operator_write($pipeline);
 
         $options = $this->inheritReadPreference($options);
@@ -257,6 +259,7 @@ public function aggregate(array $pipeline, array $options = [])
      */
     public function bulkWrite(array $operations, array $options = [])
     {
+        // @todo encode each operation in $operations
         $options = $this->inheritWriteOptions($options);
         $options = $this->inheritCodec($options);
 
@@ -281,6 +284,7 @@ public function bulkWrite(array $operations, array $options = [])
      */
     public function count(array|object $filter = [], array $options = [])
     {
+        $filter = $this->builderEncoder->encodeIfSupported($filter);
         $options = $this->inheritReadOptions($options);
 
         $operation = new Count($this->databaseName, $this->collectionName, $filter, $options);
@@ -302,6 +306,7 @@ public function count(array|object $filter = [], array $options = [])
      */
     public function countDocuments(array|object $filter = [], array $options = [])
     {
+        $filter = $this->builderEncoder->encodeIfSupported($filter);
         $options = $this->inheritReadOptions($options);
 
         $operation = new CountDocuments($this->databaseName, $this->collectionName, $filter, $options);
@@ -439,6 +444,7 @@ public function createSearchIndexes(array $indexes, array $options = []): array
      */
     public function deleteMany(array|object $filter, array $options = [])
     {
+        $filter = $this->builderEncoder->encodeIfSupported($filter);
         $options = $this->inheritWriteOptions($options);
 
         $operation = new DeleteMany($this->databaseName, $this->collectionName, $filter, $options);
@@ -460,6 +466,7 @@ public function deleteMany(array|object $filter, array $options = [])
      */
     public function deleteOne(array|object $filter, array $options = [])
     {
+        $filter = $this->builderEncoder->encodeIfSupported($filter);
         $options = $this->inheritWriteOptions($options);
 
         $operation = new DeleteOne($this->databaseName, $this->collectionName, $filter, $options);
@@ -482,6 +489,7 @@ public function deleteOne(array|object $filter, array $options = [])
      */
     public function distinct(string $fieldName, array|object $filter = [], array $options = [])
     {
+        $filter = $this->builderEncoder->encodeIfSupported($filter);
         $options = $this->inheritReadOptions($options);
         $options = $this->inheritTypeMap($options);
 
@@ -640,6 +648,7 @@ public function explain(Explainable $explainable, array $options = [])
      */
     public function find(array|object $filter = [], array $options = [])
     {
+        $filter = $this->builderEncoder->encodeIfSupported($filter);
         $options = $this->inheritReadOptions($options);
         $options = $this->inheritCodecOrTypeMap($options);
 
@@ -662,6 +671,7 @@ public function find(array|object $filter = [], array $options = [])
      */
     public function findOne(array|object $filter = [], array $options = [])
     {
+        $filter = $this->builderEncoder->encodeIfSupported($filter);
         $options = $this->inheritReadOptions($options);
         $options = $this->inheritCodecOrTypeMap($options);
 
@@ -687,6 +697,7 @@ public function findOne(array|object $filter = [], array $options = [])
      */
     public function findOneAndDelete(array|object $filter, array $options = [])
     {
+        $filter = $this->builderEncoder->encodeIfSupported($filter);
         $options = $this->inheritWriteOptions($options);
         $options = $this->inheritCodecOrTypeMap($options);
 
@@ -717,6 +728,7 @@ public function findOneAndDelete(array|object $filter, array $options = [])
      */
     public function findOneAndReplace(array|object $filter, array|object $replacement, array $options = [])
     {
+        $filter = $this->builderEncoder->encodeIfSupported($filter);
         $options = $this->inheritWriteOptions($options);
         $options = $this->inheritCodecOrTypeMap($options);
 
@@ -747,6 +759,7 @@ public function findOneAndReplace(array|object $filter, array|object $replacemen
      */
     public function findOneAndUpdate(array|object $filter, array|object $update, array $options = [])
     {
+        $filter = $this->builderEncoder->encodeIfSupported($filter);
         $options = $this->inheritWriteOptions($options);
         $options = $this->inheritCodecOrTypeMap($options);
 
@@ -995,6 +1008,7 @@ public function rename(string $toCollectionName, ?string $toDatabaseName = null,
      */
     public function replaceOne(array|object $filter, array|object $replacement, array $options = [])
     {
+        $filter = $this->builderEncoder->encodeIfSupported($filter);
         $options = $this->inheritWriteOptions($options);
         $options = $this->inheritCodec($options);
 
@@ -1018,6 +1032,7 @@ public function replaceOne(array|object $filter, array|object $replacement, arra
      */
     public function updateMany(array|object $filter, array|object $update, array $options = [])
     {
+        $filter = $this->builderEncoder->encodeIfSupported($filter);
         $options = $this->inheritWriteOptions($options);
 
         $operation = new UpdateMany($this->databaseName, $this->collectionName, $filter, $update, $options);
@@ -1040,6 +1055,7 @@ public function updateMany(array|object $filter, array|object $update, array $op
      */
     public function updateOne(array|object $filter, array|object $update, array $options = [])
     {
+        $filter = $this->builderEncoder->encodeIfSupported($filter);
         $options = $this->inheritWriteOptions($options);
 
         $operation = new UpdateOne($this->databaseName, $this->collectionName, $filter, $update, $options);
@@ -1077,6 +1093,7 @@ public function updateSearchIndex(string $name, array|object $definition, array
      */
     public function watch(array $pipeline = [], array $options = [])
     {
+        $pipeline = $this->builderEncoder->encodeIfSupported($pipeline);
         $options = $this->inheritReadOptions($options);
         $options = $this->inheritCodecOrTypeMap($options);
 

tests/Collection/BuilderCollectionFunctionalTest.php

@@ -0,0 +1,119 @@
+<?php
+
+namespace MongoDB\Tests\Collection;
+
+use MongoDB\Builder\Expression;
+use MongoDB\Builder\Pipeline;
+use MongoDB\Builder\Query;
+use MongoDB\Builder\Stage;
+
+class BuilderCollectionFunctionalTest extends FunctionalTestCase
+{
+    public function testAggregate(): void
+    {
+        $this->collection->insertMany([['x' => 10], ['x' => 2], ['x' => 5]]);
+        $pipeline = new Pipeline(
+            Stage::bucketAuto(
+                groupBy: Expression::intFieldPath('x'),
+                buckets: 2,
+            ),
+        );
+        $results = $this->collection->aggregate($pipeline)->toArray();
+
+        $this->assertCount(2, $results);
+    }
+
+    public function testBulkWrite(): void
+    {
+        $this->markTestIncomplete(__FUNCTION__);
+    }
+
+    public function testCountDocuments(): void
+    {
+        $this->markTestIncomplete(__FUNCTION__);
+    }
+
+    public function testDeleteMany(): void
+    {
+        $this->markTestIncomplete(__FUNCTION__);
+    }
+
+    public function testDeleteOne(): void
+    {
+        $this->markTestIncomplete(__FUNCTION__);
+    }
+
+    public function testDistinct(): void
+    {
+        $this->markTestIncomplete(__FUNCTION__);
+    }
+
+    public function testFind(): void
+    {
+        $this->collection->insertMany([['x' => 1], ['x' => 2]]);
+
+        $results = $this->collection->find(Query::query(x: Query::gt(1)))->toArray();
+        $this->assertCount(1, $results);
+        $this->assertEquals(2, $results[0]->x);
+    }
+
+    public function testFindOne(): void
+    {
+        $this->markTestIncomplete(__FUNCTION__);
+    }
+
+    public function testFindOneAndDelete(): void
+    {
+        $this->markTestIncomplete(__FUNCTION__);
+    }
+
+    public function testFindAndReplace(): void
+    {
+        $this->markTestIncomplete(__FUNCTION__);
+    }
+
+    public function testFindAndUpdate(): void
+    {
+        $this->markTestIncomplete(__FUNCTION__);
+    }
+
+    public function testReplaceOne(): void
+    {
+        $this->markTestIncomplete(__FUNCTION__);
+    }
+
+    public function testUpdateOne(): void
+    {
+        $this->collection->insertOne(['x' => 1]);
+
+        $result = $this->collection->updateOne(
+            Query::query(x: Query::eq(1)),
+            // @todo Use Builder when update operators are supported by PHPLIB-1507
+            ['$set' => ['x' => 2]],
+        );
+        $this->assertEquals(1, $result->getModifiedCount());
+
+        $result = $this->collection->findOne();
+        $this->assertEquals(2, $result->x);
+    }
+
+    public function testUpdateWithPipeline(): void
+    {
+        $this->markTestIncomplete(__FUNCTION__);
+    }
+
+    public function testUpdateMany(): void
+    {
+        $this->markTestIncomplete(__FUNCTION__);
+    }
+
+    public function testUpdateManyWithPipeline(): void
+    {
+        $this->markTestIncomplete(__FUNCTION__);
+    }
+
+    public function testWatch(): void
+    {
+        $this->markTestIncomplete(__FUNCTION__);
+    }
+}