Improve type of Collection Bulk Write operations #1694
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| @@ -306,14 +310,14 @@ | |||
| // $args[0] was already validated above. Since DocumentCodec::encode will always return a Document | |||
| // instance, there is no need to re-validate the returned value here. | |||
| if ($codec) { | |||
| $operations[$i][$type][0] = $codec->encode($args[0]); | |||
| $operation[$type][0] = $codec->encode($args[0]); | |||
Check notice
Code scanning / Psalm
PossiblyInvalidArgument Note
| } | ||
|
|
||
| break; | ||
|
|
||
| case self::DELETE_MANY: | ||
| case self::DELETE_ONE: | ||
| $operations[$i][$type][0] = $builderEncoder->encodeIfSupported($args[0]); | ||
| $operation[$type][0] = $builderEncoder->encodeIfSupported($args[0]); |
Check notice
Code scanning / Psalm
MixedAssignment Note
|
|
||
| break; | ||
|
|
||
| case self::REPLACE_ONE: | ||
| $operations[$i][$type][0] = $builderEncoder->encodeIfSupported($args[0]); | ||
| $operation[$type][0] = $builderEncoder->encodeIfSupported($args[0]); |
Check notice
Code scanning / Psalm
MixedAssignment Note
|
|
||
| if (! isset($args[1]) && ! array_key_exists(1, $args)) { | ||
| throw new InvalidArgumentException(sprintf('Missing second argument for $operations[%d]["%s"]', $i, $type)); | ||
| } | ||
|
|
||
| if ($codec) { | ||
| $operations[$i][$type][1] = $codec->encode($args[1]); | ||
| $operation[$type][1] = $codec->encode($args[1]); |
Check notice
Code scanning / Psalm
PossiblyInvalidArgument Note
|
|
||
| break; | ||
|
|
||
| case self::UPDATE_MANY: | ||
| case self::UPDATE_ONE: | ||
| $operations[$i][$type][0] = $builderEncoder->encodeIfSupported($args[0]); | ||
| $operation[$type][0] = $builderEncoder->encodeIfSupported($args[0]); |
Check notice
Code scanning / Psalm
MixedAssignment Note
|
|
||
| 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]); | ||
| $operation[$type][1] = $args[1] = $builderEncoder->encodeIfSupported($args[1]); |
Check notice
Code scanning / Psalm
MixedAssignment Note
|
|
||
| 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]); | ||
| $operation[$type][1] = $args[1] = $builderEncoder->encodeIfSupported($args[1]); |
Check notice
Code scanning / Psalm
MixedAssignment Note
| @@ -45,6 +45,9 @@ | |||
| * Operation for executing multiple write operations. | |||
| * | |||
| * @see \MongoDB\Collection::bulkWrite() | |||
| * | |||
| * @psalm-type Document = object|array | |||
| * @psalm-type OperationType = array{deleteMany: array{0: Document, 1?: array}}|array{deleteOne: array{0: Document, 1?: array}}|array{insertOne: array{0: Document}}|array{replaceOne: array{0: Document, 1: Document, 2?: array}}|array{updateMany: array{0: Document, 1: Document, 2?: array}}|array{updateOne: array{0: Document, 1: Document, 2?: array}} | |||
There was a problem hiding this comment.
Per our conversation yesterday, I think we still need confirmation on whether this can be utilized by the IDE. If not, is this worth adding at all?
The
Collection::bulkWrite($operations)method requires a complex array structure for the operations list. Describing this type using psalm custom type feature to helps static analysis. I don't think the IDE completion can really leverage this new type.