Skip to content
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.

Sign up for GitHub

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

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

Merged
merged 4 commits into from
Sep 11, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
26bb3a1
PHPLIB-1419 Encode Agg builder objects in Collection methods
GromNaN Sep 10, 2024
5949533
Ignore static analysis issues
GromNaN Sep 10, 2024
acc21d4
Skip pipeline in update operations for server version < 4.0
GromNaN Sep 11, 2024
ba9f715
Revert BC break on Collection::aggregate and watch
GromNaN Sep 11, 2024
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
15 changes: 13 additions & 2 deletions psalm-baseline.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -417,8 +417,9 @@
<code><![CDATA[$args[0]]]></code>
<code><![CDATA[$args[0]]]></code>
<code><![CDATA[$args[0]]]></code>
<code><![CDATA[$args[1]]]></code>
<code><![CDATA[$args[1]]]></code>
<code><![CDATA[$args[0]]]></code>
<code><![CDATA[$args[0]]]></code>
<code><![CDATA[$args[0]]]></code>
<code><![CDATA[$args[1]]]></code>
<code><![CDATA[$args[1]]]></code>
<code><![CDATA[$args[1]]]></code>
Expand Down Expand Up @@ -448,6 +449,7 @@
<code><![CDATA[$args[1]]]></code>
<code><![CDATA[$args[1]]]></code>
<code><![CDATA[$args[1]]]></code>
<code><![CDATA[$args[1]]]></code>
<code><![CDATA[$args[1]['limit']]]></code>
<code><![CDATA[$args[2]]]></code>
<code><![CDATA[$args[2]]]></code>
Expand All @@ -458,6 +460,10 @@
<code><![CDATA[$args[2]['multi']]]></code>
<code><![CDATA[$args[2]['multi']]]></code>
<code><![CDATA[$operations[$i][$type][0]]]></code>
<code><![CDATA[$operations[$i][$type][0]]]></code>
<code><![CDATA[$operations[$i][$type][0]]]></code>
<code><![CDATA[$operations[$i][$type][0]]]></code>
<code><![CDATA[$operations[$i][$type][1]]]></code>
<code><![CDATA[$operations[$i][$type][1]]]></code>
<code><![CDATA[$operations[$i][$type][1]]]></code>
<code><![CDATA[$operations[$i][$type][2]]]></code>
Expand All @@ -466,9 +472,14 @@
<MixedAssignment>
<code><![CDATA[$args]]></code>
<code><![CDATA[$args]]></code>
<code><![CDATA[$args[1]]]></code>
<code><![CDATA[$args[2]]]></code>
<code><![CDATA[$args[2]]]></code>
<code><![CDATA[$insertedIds[$i]]]></code>
<code><![CDATA[$operations[$i][$type][0]]]></code>
<code><![CDATA[$operations[$i][$type][0]]]></code>
<code><![CDATA[$operations[$i][$type][0]]]></code>
<code><![CDATA[$operations[$i][$type][1]]]></code>
<code><![CDATA[$operations[$i][$type][1]]]></code>
<code><![CDATA[$operations[$i][$type][2]]]></code>
<code><![CDATA[$operations[$i][$type][2]]]></code>
Expand Down
21 changes: 21 additions & 0 deletions src/Collection.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,7 @@ public function aggregate(array $pipeline, array $options = [])
*/
public function bulkWrite(array $operations, array $options = [])
{
$options = $this->inheritBuilderEncoder($options);
$options = $this->inheritWriteOptions($options);
$options = $this->inheritCodec($options);

Expand All @@ -286,6 +287,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);
Expand All @@ -307,6 +309,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);
Expand Down Expand Up @@ -444,6 +447,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);
Expand All @@ -465,6 +469,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);
Expand All @@ -487,6 +492,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);

Expand Down Expand Up @@ -645,6 +651,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);

Expand All @@ -667,6 +674,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);

Expand All @@ -692,6 +700,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);

Expand Down Expand Up @@ -722,6 +731,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);

Expand Down Expand Up @@ -752,6 +762,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);

Expand Down Expand Up @@ -1000,6 +1011,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);

Expand All @@ -1023,6 +1035,8 @@ 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);
$update = $this->builderEncoder->encodeIfSupported($update);
$options = $this->inheritWriteOptions($options);

$operation = new UpdateMany($this->databaseName, $this->collectionName, $filter, $update, $options);
Expand All @@ -1045,6 +1059,8 @@ 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);
$update = $this->builderEncoder->encodeIfSupported($update);
$options = $this->inheritWriteOptions($options);

$operation = new UpdateOne($this->databaseName, $this->collectionName, $filter, $update, $options);
Expand Down Expand Up @@ -1112,6 +1128,11 @@ public function withOptions(array $options = [])
return new Collection($this->manager, $this->databaseName, $this->collectionName, $options);
}

private function inheritBuilderEncoder(array $options): array
{
return ['builderEncoder' => $this->builderEncoder] + $options;
}

private function inheritCodec(array $options): array
{
// If the options contain a type map, don't inherit anything
Expand Down
21 changes: 19 additions & 2 deletions src/Operation/BulkWrite.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,10 @@

namespace MongoDB\Operation;

use MongoDB\Builder\BuilderEncoder;
use MongoDB\BulkWriteResult;
use MongoDB\Codec\DocumentCodec;
use MongoDB\Codec\Encoder;
use MongoDB\Driver\BulkWrite as Bulk;
use MongoDB\Driver\Exception\RuntimeException as DriverRuntimeException;
use MongoDB\Driver\Server;
Expand Down Expand Up @@ -94,6 +96,9 @@
*
* Supported options for the bulk write operation:
*
* * builderEncoder (MongoDB\Builder\Encoder): Encoder for query and
* aggregation builders. If not given, the default encoder will be used.
*
* * bypassDocumentValidation (boolean): If true, allows the write to
* circumvent document level validation. The default is false.
*
Expand Down Expand Up @@ -137,6 +142,10 @@

$options += ['ordered' => true];

if (isset($options['builderEncoder']) && ! $options['builderEncoder'] instanceof Encoder) {
throw InvalidArgumentException::invalidType('"builderEncoder" option', $options['builderEncoder'], Encoder::class);
}

if (isset($options['bypassDocumentValidation']) && ! is_bool($options['bypassDocumentValidation'])) {
throw InvalidArgumentException::invalidType('"bypassDocumentValidation" option', $options['bypassDocumentValidation'], 'boolean');
}
Expand Down Expand Up @@ -169,7 +178,7 @@
unset($options['writeConcern']);
}

$this->operations = $this->validateOperations($operations, $options['codec'] ?? null);
$this->operations = $this->validateOperations($operations, $options['codec'] ?? null, $options['builderEncoder'] ?? new BuilderEncoder());
$this->options = $options;
}

Expand Down Expand Up @@ -264,7 +273,7 @@
* @param array[] $operations
* @return array[]
*/
private function validateOperations(array $operations, ?DocumentCodec $codec): array
private function validateOperations(array $operations, ?DocumentCodec $codec, Encoder $builderEncoder): array
{
foreach ($operations as $i => $operation) {
if (! is_array($operation)) {
Expand Down Expand Up @@ -298,6 +307,8 @@

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

if (! isset($args[1])) {
$args[1] = [];
}
Expand All @@ -317,6 +328,8 @@
break;

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

if (! isset($args[1]) && ! array_key_exists(1, $args)) {
throw new InvalidArgumentException(sprintf('Missing second argument for $operations[%d]["%s"]', $i, $type));
}
Expand Down Expand Up @@ -367,10 +380,14 @@

case self::UPDATE_MANY:
case self::UPDATE_ONE:
$operations[$i][$type][0] = $builderEncoder->encodeIfSupported($args[0]);
Dismissed Show dismissed Hide dismissed
Dismissed Show dismissed Hide dismissed
Dismissed Show dismissed Hide dismissed

if (! isset($args[1]) && ! array_key_exists(1, $args)) {
throw new InvalidArgumentException(sprintf('Missing second argument for $operations[%d]["%s"]', $i, $type));
}

$operations[$i][$type][1] = $args[1] = $builderEncoder->encodeIfSupported($args[1]);
Dismissed Show dismissed Hide dismissed
Dismissed Show dismissed Hide dismissed
Dismissed Show dismissed Hide dismissed
Dismissed Show dismissed Hide dismissed
Dismissed Show dismissed Hide dismissed

if ((! is_document($args[1]) || ! is_first_key_operator($args[1])) && ! is_pipeline($args[1])) {
throw new InvalidArgumentException(sprintf('Expected update operator(s) or non-empty pipeline for $operations[%d]["%s"][1]', $i, $type));
}
Expand Down
Loading