[Validator] Add a Length::$allowEmptyString option to reject empty strings #31528
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Author
|
Status: Needs work to only account when a |
ogizanagi
commented
May 22, 2019
Contributor
Author
There was a problem hiding this comment.
Status: Needs Review
|
|
||
| public static function loadValidatorMetadata(ClassMetadata $metadata): void | ||
| { | ||
| $allowEmptyString = property_exists(Assert\Length::class, 'allowEmptyString') ? ['allowEmptyString' => true] : []; |
Contributor
Author
There was a problem hiding this comment.
Trying to keep compatibility with lowest symfony/validator versions for this bridge, as the code isn't impacted, only the tests fixtures are.
Same for the Form component.
fabpot
requested changes
Jun 4, 2019
Contributor
Author
|
Rebased & comments fixed Status: Needs Review |
…rings which defaults to `true` in 4.4 but will trigger a deprecation if not set explicitly in order to make the default `false` in 5.0.
fabpot
approved these changes
Jul 3, 2019
Member
|
Thank you @ogizanagi. |
fabpot
added a commit
that referenced
this pull request
Jul 3, 2019
…reject empty strings (ogizanagi) This PR was merged into the 4.4 branch. Discussion ---------- [Validator] Add a Length::$allowEmptyString option to reject empty strings | Q | A | ------------- | --- | Branch? | 4.4 <!-- see below --> | Bug fix? | no | New feature? | yes <!-- please update src/**/CHANGELOG.md files --> | BC breaks? | no <!-- see https://symfony.com/bc --> | Deprecations? | yes <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files --> | Tests pass? | yes <!-- please add some, will be required by reviewers --> | Fixed tickets | N/A <!-- #-prefixed issue number(s), if any --> | License | MIT | Doc PR | Todo (change the warning on top of https://symfony.com/doc/current/reference/constraints/Length.html) which defaults to `true` in 4.4 but will trigger a deprecation if not set explicitly in order to make the default `false` in 5.0. While it could be solved now thanks to #29641 by using both `@Length(min=1)` & `@NotBlank(allowNull=true)` constraints, as expressed in #27876 (comment) and following comments, the `@Length(min=1)` behavior doesn't match our expectations when reading it: it feels logical to invalidate empty strings, but it actually doesn't. Hence the proposal of making the behavior of rejecting empty strings the default in 5.0. In my opinion, the flag could even be removed later. Commits ------- e113e7f [Validator] Add a Length::$allowEmptyString option to reject empty strings
This was referenced Jul 3, 2019
fabpot
added a commit
that referenced
this pull request
Jul 5, 2019
…o false & make it optional (ogizanagi) This PR was merged into the 5.0-dev branch. Discussion ---------- [Validator] Change Length::$allowEmptyString default to false & make it optional | Q | A | ------------- | --- | Branch? | master <!-- see below --> | Bug fix? | no | New feature? | yes <!-- please update src/**/CHANGELOG.md files --> | BC breaks? | yes <!-- see https://symfony.com/bc --> | Deprecations? | no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files --> | Tests pass? | should pass after #32372 <!-- please add some, will be required by reviewers --> | Fixed tickets | #31528 <!-- #-prefixed issue number(s), if any --> | License | MIT | Doc PR | ~TODO: change default value and mention it's optional~ Done. Thx @javiereguiluz Commits ------- 26b804e [Validator] Change Length::$allowEmptyString default to false & make it optional
nicolas-grekas
added a commit
that referenced
this pull request
Oct 23, 2019
…NotBlank contraint is defined (nicolas-grekas) This PR was merged into the 4.4 branch. Discussion ---------- [Validator] Set Length::$allowEmptyString to false when a NotBlank contraint is defined | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - Since #31528, we are told to do this kind of changes to our entities: ```diff /** * @Assert\NotBlank() - * @Assert\Length(min="10") + * @Assert\Length(min="10", allowEmptyString=false) */ public $description; ``` But the `NotBlank` already says it - this is just boilerplate. More critically, this also means we cannot write annotations that are compatible with 3.4, 4.4 and 5.0 at the same time, making FC/BC hard. By setting `Length::$allowEmptyString` to `false` when a `NotBlank` contraint is defined, we fix both issues. /cc @ogizanagi Commits ------- 840f7e7 [Validator] Set Length::$allowEmptyString to false when a NotBlank contraint is defined
This was referenced Nov 12, 2019
Merged
Merged
This was referenced May 14, 2020
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
which defaults to
truein 4.4 but will trigger a deprecation if not set explicitlyin order to make the default
falsein 5.0.While it could be solved now thanks to #29641 by using both
@Length(min=1)&@NotBlank(allowNull=true)constraints,as expressed in #27876 (comment) and following comments, the
@Length(min=1)behavior doesn't match our expectations when reading it: it feels logical to invalidate empty strings, but it actually doesn't.Hence the proposal of making the behavior of rejecting empty strings the default in 5.0.
In my opinion, the flag could even be removed later.