[Validator] Breaking changes in Collection

[axzx]

Symfony version(s) affected

5.4

Description

Before this symfony/validator@b125357

$violations = $this->validator->validate(
            $input,
            new Assert\Collection([
                'channelName' => null,
                'reportType' => null,
                'period' => new Assert\Choice(
                    choices: (new CreateReportScheduleSpecification())->getPeriodAllowableValues(),
                ),
            ]),
        );

After this symfony/validator@b125357

$violations = $this->validator->validate(
            $input,
            new Assert\Collection([
                'fields' => [
                    'channelName' => null,
                    'reportType' => null,
                    'period' => new Assert\Choice(
                        choices: (new CreateReportScheduleSpecification())->getPeriodAllowableValues(),
                    ),
                ],
            ]),
        );

@nicolas-grekas My application stopped working as before after this commit.

How to reproduce

$input = [
            'channelName' => $input->getArgument('channelName'),
            'reportType' => $input->getArgument('reportType'),
            'period' => $input->getArgument('period'),
        ];

$violations = $this->validator->validate(
            $input,
            new Assert\Collection([
                'channelName' => null,
                'reportType' => null,
                'period' => new Assert\Choice(
                    choices: (new CreateReportScheduleSpecification())->getPeriodAllowableValues(),
                ),
            ]),
        );

Possible Solution

No response

Additional Context

No response

[xabbuh]

@axzx There is a pending PR (see #53443) that tries to fix cases that we broke with previous PRs fixing other bugs. I will take your report into account there too.

[HypeMC]

@axzx Could you see if #53755 fixes your issue?

[axzx]

@HypeMC

I tested your solution. I have this code:

$constraints['packAccessory'] = [new Assert\NotNull()];
$violations = $this->validator->validate(
            $inputValues,
            new Assert\Collection($constraints),
//            new Assert\Collection([
//                'fields' => $constraints,
//            ]),
        );

I run the tests and get an error 500:

The options \"packAccessory\" do not exist in constraint \"Symfony\\Component\\Validator\\Constraints\\Collection\".

I tested second version:

$violations = $this->validator->validate(
            $inputValues,
//            new Assert\Collection($constraints),
            new Assert\Collection([
                'fields' => $constraints,
            ]),
        );

I run the tests and get an error 422:

"detail":"[fields]: This field is missing."

[HypeMC]

@axzx I'm having trouble reproducing your problem. What is the value of $inputValues?

[axzx]

@HypeMC

$inputValues = ['packAccessory' => null];
$constraints = ['packAccessory' => [new Assert\NotNull()]];
$violations = $this->validator->validate(
            $inputValues,
            new Assert\Collection($constraints),
        );

[HypeMC]

@axzx I've tried your example and didn't get the error. Are you sure you're using the fix?

[axzx]

@HypeMC

OK, your solution actually worked, but it stopped working in a certain case.

what about this:

$inputValues = [];
$constraints = [];
$violations = $this->validator->validate(
            $inputValues,
            new Assert\Collection(['fields' => $constraints]),
        );

?

I get an error response:
"detail":"[fields]: This field is missing."

Applications will again stop working after this change.

[HypeMC]

@axzx Yes, unfortunately, this all comes down to the fact that there's no way of knowing whether fields refers to the fields option or to a field named fields.

[axzx]

@HypeMC
The name fields should be reserved;)

Could the fields option be dropped?

[HypeMC]

@axzx Reserving fields or dropping the option are both BC breaks. I'm not sure there's a solution here that works for all cases.