PHPLIB-1419 Encode Agg builder objects in Collection methods #1383

GromNaN · 2024-09-10T09:09:07Z

~~Requires #1382~~

The encoding is done in the Collection methods, not in the various Operation classes:

No option to validate in each Operation class
Very little code duplicate in each method, whereas handling in operation classes would require the documentation and validation of the new option in each class.
In the future, it is still possible to move the encoding and add an option to the methods without breaking change.

Only the BulkWrite operation has the option, because the processing of each operation is already organised in this operation class.

The Collection methods does not accept the builderEncoder option for now. If a specific encoder is necessary for an operation, if can be called just before the operation:

$pipeline = new Pipeline(...);

// Required for now, as we could not change the argument type. In 2.0 this will not be necessary.
$pipeline = iterator_to_array($pipeline);

$pipeline = (new CustomBuilderEncoder)->encode($pipeline);
$collection->aggregate($pipeline);

src/Operation/BulkWrite.php


                case self::DELETE_MANY:
                case self::DELETE_ONE:
+                    $operations[$i][$type][0] = $builderEncoder->encodeIfSupported($args[0]);


src/Operation/BulkWrite.php


                case self::DELETE_MANY:
                case self::DELETE_ONE:
+                    $operations[$i][$type][0] = $builderEncoder->encodeIfSupported($args[0]);


src/Operation/BulkWrite.php


                case self::DELETE_MANY:
                case self::DELETE_ONE:
+                    $operations[$i][$type][0] = $builderEncoder->encodeIfSupported($args[0]);


src/Operation/BulkWrite.php

                    break;

                case self::REPLACE_ONE:
+                    $operations[$i][$type][0] = $builderEncoder->encodeIfSupported($args[0]);


src/Operation/BulkWrite.php

                    break;

                case self::REPLACE_ONE:
+                    $operations[$i][$type][0] = $builderEncoder->encodeIfSupported($args[0]);


src/Operation/BulkWrite.php

                        throw new InvalidArgumentException(sprintf('Missing second argument for $operations[%d]["%s"]', $i, $type));
                    }

+                    $operations[$i][$type][1] = $args[1] = $builderEncoder->encodeIfSupported($args[1]);


src/Operation/BulkWrite.php

                        throw new InvalidArgumentException(sprintf('Missing second argument for $operations[%d]["%s"]', $i, $type));
                    }

+                    $operations[$i][$type][1] = $args[1] = $builderEncoder->encodeIfSupported($args[1]);


src/Operation/BulkWrite.php

                        throw new InvalidArgumentException(sprintf('Missing second argument for $operations[%d]["%s"]', $i, $type));
                    }

+                    $operations[$i][$type][1] = $args[1] = $builderEncoder->encodeIfSupported($args[1]);


src/Operation/BulkWrite.php

                        throw new InvalidArgumentException(sprintf('Missing second argument for $operations[%d]["%s"]', $i, $type));
                    }

+                    $operations[$i][$type][1] = $args[1] = $builderEncoder->encodeIfSupported($args[1]);


src/Operation/BulkWrite.php

                        throw new InvalidArgumentException(sprintf('Missing second argument for $operations[%d]["%s"]', $i, $type));
                    }

+                    $operations[$i][$type][1] = $args[1] = $builderEncoder->encodeIfSupported($args[1]);


GromNaN

Tests failing only in evergreen "test-mongodb-4.0-replicaset-noauth-nossl"

tests/Collection/BuilderCollectionFunctionalTest.php

alcaeus

We missed a BC break while planning this, so we'll have to think about how we can accomplish this.

The changes made to aggregate and watch will also have to be applied to the Client::watch, Database::watch, and Database::aggregate methods.

alcaeus · 2024-09-11T07:04:51Z

src/Collection.php

     * @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 = [])


I don't know how I missed this while we were planning things, but this is a BC break, as any class extending Collection and overriding aggregate will be incompatible due to a narrower parameter type. I don't know if there's a way to solve this in 1.x, as I'd hate to defer this feature to 2.x.

The compromise we can make for the moment is to accept an array of stages.

$pipeline = new Pipeline(...); $results = $collection->aggregate(iterator_to_array($pipeline));

src/Collection.php

tests/Collection/BuilderCollectionFunctionalTest.php

Ignore static analysis issues PHPLIB-1419 Fix BC break

src/Client.php

    public function watch(array $pipeline = [], array $options = [])
    {
+        if (is_builder_pipeline($pipeline)) {
+            $pipeline = new Pipeline(...$pipeline);


src/Client.php

    public function watch(array $pipeline = [], array $options = [])
    {
+        if (is_builder_pipeline($pipeline)) {
+            $pipeline = new Pipeline(...$pipeline);


src/Collection.php

    public function aggregate(array $pipeline, array $options = [])
    {
+        if (is_builder_pipeline($pipeline)) {
+            $pipeline = new Pipeline(...$pipeline);


src/Collection.php

    public function aggregate(array $pipeline, array $options = [])
    {
+        if (is_builder_pipeline($pipeline)) {
+            $pipeline = new Pipeline(...$pipeline);


src/Collection.php

    public function watch(array $pipeline = [], array $options = [])
    {
+        if (is_builder_pipeline($pipeline)) {
+            $pipeline = new Pipeline(...$pipeline);


src/Collection.php

    public function watch(array $pipeline = [], array $options = [])
    {
+        if (is_builder_pipeline($pipeline)) {
+            $pipeline = new Pipeline(...$pipeline);


src/Database.php

    public function aggregate(array $pipeline, array $options = [])
    {
+        if (is_builder_pipeline($pipeline)) {
+            $pipeline = new Pipeline(...$pipeline);


src/Database.php

    public function aggregate(array $pipeline, array $options = [])
    {
+        if (is_builder_pipeline($pipeline)) {
+            $pipeline = new Pipeline(...$pipeline);


src/Database.php

    public function watch(array $pipeline = [], array $options = [])
    {
+        if (is_builder_pipeline($pipeline)) {
+            $pipeline = new Pipeline(...$pipeline);


src/Database.php

    public function watch(array $pipeline = [], array $options = [])
    {
+        if (is_builder_pipeline($pipeline)) {
+            $pipeline = new Pipeline(...$pipeline);


tests/Database/BuilderDatabaseFunctionalTest.php

src/functions.php

src/Client.php

src/functions.php

+        return false;
+    }
+
+    foreach ($pipeline as $stage) {


jmikola · 2024-09-12T15:26:56Z

tests/ClientFunctionalTest.php

+
+        if ($this->isShardedCluster()) {
+            $this->markTestSkipped('Test does not apply on sharded clusters: need more than a single getMore call on the change stream.');
+        }


I assume this was copied from testChangeStreamExample_1_4 in DocumentationExamplesTest. I think this skip was only done for documentation examples to avoid complicating the code snippets.

32bade4 also introduced advanceCursorUntilValid() to fix change stream iteration for sharded clusters in our other tests.

I won't push for changing this, but wanted to provide some context.

Thanks for the context. In fact, I've simplified the documentation example you pointed. Given what's being tested, I don't think it's essential for the test to run on all server typologies.

* v1.x: (87 commits) Performance: Keep collections and indexes between GridFS tests (#1421) Add final annotations to non-internal Operation classes (#1410) Fix types accepted by $round (#1401) Replace arrayHasKey with assertArrayHasKey in tests (#1403) PHPLIB-1514 Make data providers static (#1404) PHPLIB-1515 Replace assertObjectHasAttribute with assertObjectHasProperty (#1405) Restore Prose22_RangeExplicitEncryptionTest (#1400) Remove Prose22_RangeExplicitEncryptionTest that requires ext-mongodb < 1.20 (#1394) Use `match` instead of `switch` when a simple value is returned (#1393) Remove PHPUnit functions polyfill (#1395) Update branch names for GHA workflows (#1390) PHPLIB-1419 Encode Agg builder objects in Collection methods (#1383) PHPLIB-1420 Integrate query builder for non-aggregation APIs (#1385) Fix optional parameter declared before required parameter (#1384) PHPLIB-1505 Add driver option "builderEncoder" (#1382) Exclude rector.php from the artifact Check generated files are up-to-date Replace composer package mongodb/builder Skip Pedentry method sort for generated files Remove composer constraints already imposed by the main package ...

* v1.x: (90 commits) Merge v1.20 into v1.x (#1447) PHPLIB-1525 Removes dependency to Symfony PHPUnit bridge (#1413) Change deprecated assertObjectHasAttribute to assertObjectHasProperty (#1432) Performance: Keep collections and indexes between GridFS tests (#1421) Add final annotations to non-internal Operation classes (#1410) Fix types accepted by $round (#1401) Replace arrayHasKey with assertArrayHasKey in tests (#1403) PHPLIB-1514 Make data providers static (#1404) PHPLIB-1515 Replace assertObjectHasAttribute with assertObjectHasProperty (#1405) Restore Prose22_RangeExplicitEncryptionTest (#1400) Remove Prose22_RangeExplicitEncryptionTest that requires ext-mongodb < 1.20 (#1394) Use `match` instead of `switch` when a simple value is returned (#1393) Remove PHPUnit functions polyfill (#1395) Update branch names for GHA workflows (#1390) PHPLIB-1419 Encode Agg builder objects in Collection methods (#1383) PHPLIB-1420 Integrate query builder for non-aggregation APIs (#1385) Fix optional parameter declared before required parameter (#1384) PHPLIB-1505 Add driver option "builderEncoder" (#1382) Exclude rector.php from the artifact Check generated files are up-to-date ...

* v1.x: (95 commits) PHPLIB-1369 Upgrade to PHPUnit 10 (#1412) Higher phpunit version required (#1463) Fix deprecations in tests (#1458) Deprecate functionality to be removed (#1441) Expect BulkWriteException (#1455) Merge v1.20 into v1.x (#1447) PHPLIB-1525 Removes dependency to Symfony PHPUnit bridge (#1413) Change deprecated assertObjectHasAttribute to assertObjectHasProperty (#1432) Performance: Keep collections and indexes between GridFS tests (#1421) Add final annotations to non-internal Operation classes (#1410) Fix types accepted by $round (#1401) Replace arrayHasKey with assertArrayHasKey in tests (#1403) PHPLIB-1514 Make data providers static (#1404) PHPLIB-1515 Replace assertObjectHasAttribute with assertObjectHasProperty (#1405) Restore Prose22_RangeExplicitEncryptionTest (#1400) Remove Prose22_RangeExplicitEncryptionTest that requires ext-mongodb < 1.20 (#1394) Use `match` instead of `switch` when a simple value is returned (#1393) Remove PHPUnit functions polyfill (#1395) Update branch names for GHA workflows (#1390) PHPLIB-1419 Encode Agg builder objects in Collection methods (#1383) ...

GromNaN force-pushed the PHPLIB-1419 branch 3 times, most recently from f8213b2 to da71fcc Compare September 10, 2024 19:57

github-advanced-security bot found potential problems Sep 10, 2024

View reviewed changes

GromNaN marked this pull request as ready for review September 10, 2024 20:09

GromNaN requested a review from a team as a code owner September 10, 2024 20:09

GromNaN requested a review from jmikola September 10, 2024 20:09

GromNaN force-pushed the PHPLIB-1419 branch from da71fcc to 0ba9938 Compare September 10, 2024 20:22

github-advanced-security bot found potential problems Sep 10, 2024

View reviewed changes

GromNaN requested a review from alcaeus September 10, 2024 20:28

GromNaN force-pushed the PHPLIB-1419 branch from 0ba9938 to 5949533 Compare September 10, 2024 21:04

GromNaN commented Sep 11, 2024

View reviewed changes

tests/Collection/BuilderCollectionFunctionalTest.php Show resolved Hide resolved

tests/Collection/BuilderCollectionFunctionalTest.php Show resolved Hide resolved

alcaeus requested changes Sep 11, 2024

View reviewed changes

GromNaN mentioned this pull request Sep 11, 2024

PHPLIB-1420 Integrate query builder for non-aggregation APIs #1385

Merged

PHPLIB-1419 Encode Agg builder objects in Collection methods

d3caa38

Ignore static analysis issues PHPLIB-1419 Fix BC break

GromNaN force-pushed the PHPLIB-1419 branch from acc21d4 to 7b4886b Compare September 11, 2024 10:13

github-advanced-security bot found potential problems Sep 11, 2024

View reviewed changes

GromNaN requested a review from alcaeus September 11, 2024 10:16

GromNaN commented Sep 11, 2024

View reviewed changes

tests/Database/BuilderDatabaseFunctionalTest.php Show resolved Hide resolved

alcaeus reviewed Sep 11, 2024

View reviewed changes

src/functions.php Outdated Show resolved Hide resolved

src/Client.php Show resolved Hide resolved

PHPLIB-1419 Support builder Pipeline in Client and Database watch

f3b4961

GromNaN force-pushed the PHPLIB-1419 branch from 7b4886b to f3b4961 Compare September 11, 2024 13:23

GromNaN requested a review from alcaeus September 11, 2024 13:51

Simplify is_builder_pipeline

f9539b6

GromNaN force-pushed the PHPLIB-1419 branch from 7f8b5c4 to f9539b6 Compare September 11, 2024 16:47

github-advanced-security bot found potential problems Sep 11, 2024

View reviewed changes

src/functions.php

return false;

}

foreach ($pipeline as $stage) {

Check notice

Code scanning / Psalm

MixedAssignment

Unable to determine the type that $stage is being assigned to

alcaeus approved these changes Sep 12, 2024

View reviewed changes

GromNaN merged commit a829d24 into mongodb:v1.x Sep 12, 2024

GromNaN deleted the PHPLIB-1419 branch September 12, 2024 08:20

jmikola reviewed Sep 12, 2024

View reviewed changes

GromNaN mentioned this pull request Feb 7, 2025

PHPLIB-1617 Accept a Pipeline instance in aggregate and watch methods #1580

Merged

PHPLIB-1419 Encode Agg builder objects in Collection methods #1383

PHPLIB-1419 Encode Agg builder objects in Collection methods #1383

Uh oh!

Conversation

GromNaN commented Sep 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

GromNaN left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

alcaeus left a comment

Choose a reason for hiding this comment

Uh oh!

alcaeus Sep 11, 2024

Choose a reason for hiding this comment

Uh oh!

GromNaN Sep 11, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Uh oh!

Uh oh!

Uh oh!

Check notice

jmikola Sep 12, 2024

Choose a reason for hiding this comment

Uh oh!

GromNaN Sep 12, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

GromNaN commented Sep 10, 2024 •

edited

Loading