[Validator] Deprecated email validation mode `loose` #43505

ThomasLandauer · 2021-10-14T12:06:23Z

Q	A
Branch?	5.4
Bug fix?	no
New feature?	no
Deprecations?	yes
Tickets	Fix #41855
License	MIT
Doc PR	TODO

Closes #41855

Don't know what else needs to be done... ;-)

Closes symfony#41855

carsonbot · 2021-10-14T12:06:24Z

Hey!

To help keep things organized, we don't allow "Draft" pull requests. Could you please click the "ready for review" button or close this PR and open a new one when you are done?

Note that a pull request does not have to be "perfect" or "ready for merge" when you first open it. We just want it to be ready for a first review.

Cheers!

Carsonbot

src/Symfony/Component/Validator/Constraints/EmailValidator.php

nicolas-grekas

a similar notice is needed in validate(), isn't it?

src/Symfony/Component/Validator/Constraints/EmailValidator.php

src/Symfony/Component/Validator/Constraints/Email.php

UPGRADE-6.0.md

src/Symfony/Component/Validator/Constraints/Email.php

ThomasLandauer · 2021-10-27T15:47:53Z

Should I commit the actual removal of "loose" to the 6.0 branch already, or when is the "usual" time to do this?

src/Symfony/Component/Validator/CHANGELOG.md

src/Symfony/Component/Validator/Constraints/EmailValidator.php

nicolas-grekas

the constraint should also trigger a deprecation when you instantiate it with a config putting it in loose mode

Not sure this is required to me. Not doing that would prevent triggering two very similar deprecations instead, thus reducing confusion.

xabbuh · 2021-10-28T15:17:55Z

So am I right that (at least as a first step) those 98 "self deprecation notices" need to get fixed? But how?

You need to update these tests to use the html5 mode instead of the implicit loose default mode.

stof · 2021-10-28T15:18:59Z

So from what you said above ("and probably also assert that they expect the deprecation") I figured I had to add $this->expectDeprecation();. But the result is:

There was 1 failure:

Symfony\Component\Validator\Tests\Constraints\EmailValidatorTest::testModeLoose
Failed asserting that exception of type "PHPUnit\Framework\Error\Deprecated" is thrown.

So am I right that (at least as a first step) those 98 "self deprecation notices" need to get fixed? But how?

you need to use the ExpectDeprecationTrait from the PHPUnit bridge, not the API defined in PHPUnit 8+ (which does not work for our silenced deprecations)

ThomasLandauer · 2021-10-28T20:06:05Z

At least I managed to get rid of the 4 coming from ValidationTest.php. But I'm stuck with the 94 from EmailValidatorTest.php :-(

94x in EmailValidatorTest::setUp from Symfony\Component\Validator\Tests\Constraints

Don't even know what setUp refers to - there is no such method in that file.

xabbuh · 2021-10-28T20:44:26Z

src/Symfony/Component/Validator/Tests/Constraints/EmailValidatorTest.php

@@ -21,6 +22,8 @@
 */
 class EmailValidatorTest extends ConstraintValidatorTestCase
 {
+    use ExpectDeprecationTrait;
+
    protected function createValidator()
    {
        return new EmailValidator(Email::VALIDATION_MODE_LOOSE);


The createValidator() method is called in setUp() in the base ConstraintValidatorTestCase class. That call will lead to the deprecation being triggered here.

So I need to add @group legacy and $this->expectDeprecation at ConstraintValidatorTestCase::setUp?

Cause I'm sure I already tried it here at EmailValidatorTest::createValidator() and it didn't work...

No, you need to update this method to not pass loose but html5 as the mode instead. The legacy loose mode needs to be tested explicitly in legacy test methods instead.

I think since we changed this, the deprecation warning is gone:

1) Symfony\Component\Validator\Tests\Constraints\EmailValidatorTest::testValidEmailsLoose with data set #0 ('fabien@symfony.com') Failed asserting that string matches format description. --- Expected +++ Actual @@ @@ @expectedDeprecation: -%A Since symfony/validator 5.4: The "loose" email validation mode is deprecated, use "html5" instead +

So do I need to trigger_deprecation() in createValidator() too? But wouldn't this result in what @nicolas-grekas said he doesn't want? #43505 (review)

Not sure this is required to me. Not doing that would prevent triggering two very similar deprecations instead, thus reducing confusion.

src/Symfony/Component/Validator/Tests/Constraints/EmailValidatorTest.php

src/Symfony/Component/Validator/Tests/ValidationTest.php

ThomasLandauer · 2021-10-28T22:50:02Z

The purpose of EmailValidatorTest::testValidNormalizedEmails() seems to be to test the normalizer. So should I just delete all "html5-failing" email addresses from the data provider?

fabpot · 2022-07-23T13:11:04Z

Closing as it has been finished in #46518

Deprecating "loose" mode

5929f1c

Closes symfony#41855

ThomasLandauer marked this pull request as ready for review October 14, 2021 12:07

carsonbot added Status: Needs Review Deprecation labels Oct 14, 2021

carsonbot added this to the 5.4 milestone Oct 14, 2021

ThomasLandauer added 2 commits October 14, 2021 14:08

Update EmailValidator.php

74f7563

Update UPGRADE-6.0.md

0c73136

ro0NL reviewed Oct 14, 2021

View reviewed changes

src/Symfony/Component/Validator/Constraints/EmailValidator.php Outdated Show resolved Hide resolved

nicolas-grekas reviewed Oct 27, 2021

View reviewed changes

src/Symfony/Component/Validator/Constraints/EmailValidator.php Outdated Show resolved Hide resolved

src/Symfony/Component/Validator/Constraints/Email.php Outdated Show resolved Hide resolved

UPGRADE-6.0.md Outdated Show resolved Hide resolved

ThomasLandauer added 4 commits October 27, 2021 17:30

Update UPGRADE-6.0.md

aed6e3f

Update UPGRADE-5.4.md

0f17b9d

Update CHANGELOG.md

8a76eae

Update Email.php

cfa86c7

stof requested changes Oct 27, 2021

View reviewed changes

src/Symfony/Component/Validator/Constraints/Email.php Show resolved Hide resolved

carsonbot added Status: Needs Work and removed Status: Needs Review labels Oct 27, 2021

Update EmailValidator.php

67a2150

nicolas-grekas changed the title ~~Deprecating "loose" mode~~ Deprecated email validation mode loose Oct 27, 2021

nicolas-grekas added the Validator label Oct 27, 2021

carsonbot changed the title ~~Deprecated email validation mode loose~~ [Validator] Deprecated email validation mode loose Oct 27, 2021

nicolas-grekas reviewed Oct 27, 2021

View reviewed changes

ThomasLandauer added 4 commits October 27, 2021 18:03

Update CHANGELOG.md

77b3e84

Update EmailValidator.php

45357c4

Update EmailValidator.php

717b3cf

Update EmailValidator.php

8662b25

nicolas-grekas approved these changes Oct 27, 2021

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Work labels Oct 27, 2021

ThomasLandauer added 7 commits October 28, 2021 20:41

Update EmailValidatorTest.php

08a59ba

Update ValidationTest.php

356236f

Update ValidationTest.php

71427ac

Update EmailValidatorTest.php

ca4345a

Update EmailValidatorTest.php

e159032

Update ValidationTest.php

ceb9b3d

Update EmailValidatorTest.php

b265fbd

xabbuh reviewed Oct 28, 2021

View reviewed changes

src/Symfony/Component/Validator/Tests/Constraints/EmailValidatorTest.php Outdated Show resolved Hide resolved

xabbuh reviewed Oct 28, 2021

View reviewed changes

src/Symfony/Component/Validator/Tests/ValidationTest.php Outdated Show resolved Hide resolved

ThomasLandauer added 8 commits October 28, 2021 23:04

Update EmailValidatorTest.php

a44a14c

Update ValidationTest.php

7a279e9

Update ValidationTest.php

dc52691

Update ValidationTest.php

7b5fca1

Update EmailValidatorTest.php

8dd3937

Update ValidationTest.php

2a90782

Renaming testValidEmails => testValidEmailsLoose

fd7522e

Update EmailValidatorTest.php

973e624

fabpot modified the milestones: 5.4, 6.1 Oct 30, 2021

fabpot modified the milestones: 6.1, 6.2 May 20, 2022

fabpot closed this Jul 23, 2022

ThomasLandauer deleted the patch-2 branch July 23, 2022 20:52

ro0NL mentioned this pull request Dec 9, 2022

[Validator] Since symfony/validator 6.2: The "loose" mode is deprecated. The default mode will be changed to "html5" in 7.0. #48541

Closed

Uh oh!

[Validator] Deprecated email validation mode loose #43505

[Validator] Deprecated email validation mode loose #43505

Uh oh!

Conversation

ThomasLandauer commented Oct 14, 2021

Uh oh!

carsonbot commented Oct 14, 2021

Uh oh!

Uh oh!

nicolas-grekas left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ThomasLandauer commented Oct 27, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nicolas-grekas left a comment

Choose a reason for hiding this comment

Uh oh!

xabbuh commented Oct 28, 2021

Uh oh!

stof commented Oct 28, 2021

Uh oh!

ThomasLandauer commented Oct 28, 2021

Uh oh!

xabbuh Oct 28, 2021

Choose a reason for hiding this comment

Uh oh!

ThomasLandauer Oct 28, 2021

Choose a reason for hiding this comment

Uh oh!

xabbuh Oct 28, 2021

Choose a reason for hiding this comment

Uh oh!

ThomasLandauer Oct 28, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ThomasLandauer commented Oct 28, 2021

Uh oh!

fabpot commented Jul 23, 2022

Uh oh!

Uh oh!

[Validator] Deprecated email validation mode `loose` #43505

[Validator] Deprecated email validation mode `loose` #43505