Skip to content

PHPLIB-1654: Support new $concatArrays and $setUnion aggregation accumulators #1732

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions generator/config/accumulator/concatArrays.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# $schema: ../schema.json
name: $concatArrays
link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/concatArrays/'
type:
- accumulator
- window
- resolvesToArray
encode: single
description: |
Concatenates arrays to return the concatenated array.
arguments:
-
name: array
type:
- resolvesToArray # of arrays
variadic: array
description: |
An array of expressions that resolve to an array.
If any argument resolves to a value of null or refers to a field that is missing, `$concatArrays` returns `null`.
tests:
-
name: 'Warehouse collection'
link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/concatArrays/#example'
pipeline:
-
$project:
items:
$concatArrays:
- '$instock'
- '$ordered'
32 changes: 32 additions & 0 deletions generator/config/accumulator/setUnion.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# $schema: ../schema.json
name: $setUnion
link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/setUnion/'
type:
- accumulator
- window
- resolvesToArray
encode: single
description: |
Takes two or more arrays and returns an array containing the elements that appear in any input array.
arguments:
-
name: array
type:
- resolvesToArray # of arrays
variadic: array
description: |
An array of expressions that resolve to an array.
tests:
-
name: 'Flowers collection'
link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/setUnion/#example'
pipeline:
-
$project:
flowerFieldA: 1
flowerFieldB: 1
allValues:
$setUnion:
- "$flowerFieldA"
- "$flowerFieldB"
_id: 0
57 changes: 57 additions & 0 deletions src/Builder/Accumulator/ConcatArraysAccumulator.php

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

26 changes: 26 additions & 0 deletions src/Builder/Accumulator/FactoryTrait.php

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

53 changes: 53 additions & 0 deletions src/Builder/Accumulator/SetUnionAccumulator.php

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

33 changes: 33 additions & 0 deletions tests/Builder/Accumulator/ConcatArraysAccumulatorTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?php

declare(strict_types=1);

namespace MongoDB\Tests\Builder\Accumulator;

use MongoDB\Builder\Accumulator;
use MongoDB\Builder\Expression;
use MongoDB\Builder\Pipeline;
use MongoDB\Builder\Stage;
use MongoDB\Tests\Builder\PipelineTestCase;

/**
* Test $concatArrays accumulator
*/
class ConcatArraysAccumulatorTest extends PipelineTestCase
{
public function testWarehouseCollection(): void
{
$concatArrays = Accumulator::concatArrays(...);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ha, our code from discussing different ways to write agg pipelines found its way in here. I'll let you decide whether you want to keep it this way or inline it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I liked this :)


$pipeline = new Pipeline(
Stage::project(
items: $concatArrays(
Expression::arrayFieldPath('instock'),
Expression::arrayFieldPath('ordered'),
),
),
);

$this->assertSamePipeline(Pipelines::ConcatArraysWarehouseCollection, $pipeline);
}
}
49 changes: 49 additions & 0 deletions tests/Builder/Accumulator/Pipelines.php

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

36 changes: 36 additions & 0 deletions tests/Builder/Accumulator/SetUnionAccumulatorTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<?php

declare(strict_types=1);

namespace MongoDB\Tests\Builder\Accumulator;

use MongoDB\Builder\Accumulator;
use MongoDB\Builder\Expression;
use MongoDB\Builder\Pipeline;
use MongoDB\Builder\Stage;
use MongoDB\Tests\Builder\PipelineTestCase;

/**
* Test $setUnion accumulator
*/
class SetUnionAccumulatorTest extends PipelineTestCase
{
public function testFlowersCollection(): void
{
$setUnion = Accumulator::setUnion(...);

$pipeline = new Pipeline(
Stage::project(
flowerFieldA: 1,
flowerFieldB: 1,
allValues: $setUnion(
Expression::arrayFieldPath('flowerFieldA'),
Expression::arrayFieldPath('flowerFieldB'),
),
_id: 0,
),
);

$this->assertSamePipeline(Pipelines::SetUnionFlowersCollection, $pipeline);
}
}
2 changes: 1 addition & 1 deletion tests/specifications
Submodule specifications updated 36 files
+2 −29 .github/workflows/json-regenerate-check.yml
+0 −2 .github/workflows/lint.yml
+32 −0 .github/workflows/unified-test-format-schema-check.yml
+3 −23 source/mongodb-handshake/handshake.md
+0 −125 source/mongodb-handshake/tests/README.md
+0 −100 source/mongodb-handshake/tests/unified/metadata-not-propagated.json
+0 −58 source/mongodb-handshake/tests/unified/metadata-not-propagated.yml
+0 −1,163 source/unified-test-format/schema-1.24.json
+1 −3 source/unified-test-format/schema-latest.json
+18 −0 source/unified-test-format/tests/invalid/entity-client-storeEventsAsEntities-minItems.json
+12 −0 source/unified-test-format/tests/invalid/entity-client-storeEventsAsEntities-minItems.yml
+18 −0 source/unified-test-format/tests/invalid/entity-client-storeEventsAsEntities-type.json
+12 −0 source/unified-test-format/tests/invalid/entity-client-storeEventsAsEntities-type.yml
+26 −0 source/unified-test-format/tests/invalid/storeEventsAsEntity-additionalProperties.json
+15 −0 source/unified-test-format/tests/invalid/storeEventsAsEntity-additionalProperties.yml
+25 −0 source/unified-test-format/tests/invalid/storeEventsAsEntity-events-enum.json
+14 −0 source/unified-test-format/tests/invalid/storeEventsAsEntity-events-enum.yml
+23 −0 source/unified-test-format/tests/invalid/storeEventsAsEntity-events-minItems.json
+14 −0 source/unified-test-format/tests/invalid/storeEventsAsEntity-events-minItems.yml
+22 −0 source/unified-test-format/tests/invalid/storeEventsAsEntity-events-required.json
+13 −0 source/unified-test-format/tests/invalid/storeEventsAsEntity-events-required.yml
+23 −0 source/unified-test-format/tests/invalid/storeEventsAsEntity-events-type.json
+14 −0 source/unified-test-format/tests/invalid/storeEventsAsEntity-events-type.yml
+24 −0 source/unified-test-format/tests/invalid/storeEventsAsEntity-id-required.json
+13 −0 source/unified-test-format/tests/invalid/storeEventsAsEntity-id-required.yml
+25 −0 source/unified-test-format/tests/invalid/storeEventsAsEntity-id-type.json
+14 −0 source/unified-test-format/tests/invalid/storeEventsAsEntity-id-type.yml
+28 −0 source/unified-test-format/tests/valid-fail/entity-client-storeEventsAsEntities-conflict_with_client_id.json
+16 −0 source/unified-test-format/tests/valid-fail/entity-client-storeEventsAsEntities-conflict_with_client_id.yml
+43 −0 ...ified-test-format/tests/valid-fail/entity-client-storeEventsAsEntities-conflict_within_different_array.json
+19 −0 ...nified-test-format/tests/valid-fail/entity-client-storeEventsAsEntities-conflict_within_different_array.yml
+36 −0 ...ce/unified-test-format/tests/valid-fail/entity-client-storeEventsAsEntities-conflict_within_same_array.json
+16 −0 source/unified-test-format/tests/valid-fail/entity-client-storeEventsAsEntities-conflict_within_same_array.yml
+67 −0 source/unified-test-format/tests/valid-pass/entity-client-storeEventsAsEntities.json
+37 −0 source/unified-test-format/tests/valid-pass/entity-client-storeEventsAsEntities.yml
+184 −21 source/unified-test-format/unified-test-format.md