[Form] fix ViolationMapper was always generating a localized label for each FormType #38435
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
b912391 to
8ed5407
Compare
9ecb1b7 to
dce8e92
Compare
nicolas-grekas
approved these changes
Oct 7, 2020
xabbuh
reviewed
Oct 7, 2020
| $label = $scope->getConfig()->getOption('label'); | ||
| } | ||
|
|
||
| if (false !== $label) { |
There was a problem hiding this comment.
Why is this necessary? If $label is null, it will never be false. So the previous code was already working as expected, wasn't it?
There was a problem hiding this comment.
Yes, both versions are giving the same result. But moving up the false !== $label test, instead of leaving it around line 162, avoid an extra an extra test (null === $label).
xabbuh
reviewed
Oct 7, 2020
src/Symfony/Component/Form/Tests/Extension/Validator/ViolationMapper/ViolationMapperTest.php
Outdated
Show resolved
Hide resolved
dce8e92 to
a211d13
Compare
a211d13 to
ca96885
Compare
|
(rebased branch, to try get CI green) |
|
We've just moved away from |
|
Done |
fabpot
added a commit
that referenced
this pull request
Oct 12, 2020
…ed label for each FormType (romaricdrigon) This PR was merged into the 5.x branch. Discussion ---------- [Form] fix ViolationMapper was always generating a localized label for each FormType | Q | A | ------------- | --- | Branch? | 5.x (fix new behavior from 5.2) | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | / | License | MIT | Doc PR | / Follow-up of #38435, with branch changed **Explanation of the issue** In Symfony 5.2, the `{{ label }}` placeholder can be used in constraint messages (-> introduced in commit 0d9f442) However, the way it was coded is introducing a small side effect: now, every time there is validation error, `ViolationMapper` will ask the Form Type its `label`, and if not `false`, it will try to translate it. **Why it is important/why it causes a BC break** Since by default `AbstractType` does not have any `label`, it also introduces a minor BC break. I will explain it with an example: in a project I work on, we check we don't have any missing translation. Sometimes we have violation errors bound to form ; then current code will get Form `label`, which in `null` in form type classes (which is quite usual I believe), so it will generate one, and pass that one to translator. And we see a lot on erroneous missing translations. **Proposed fix** This fix moves all this logic into a `if`, so `ViolationMapper` call the translator component only if `{{ label }}` placeholder is used in constraint error message. On top of fixing BC, it has the benefit of lowering the performance cost for every violation when the feature is not used. I added a test, as I believe the behavior should be guaranteed from now on. Commits ------- aee5571 [Form] fix ViolationMapper was always generating a localized label for each FormType
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Explanation of the issue
In Symfony 5.2, the
{{ label }}placeholder can be used in constraint messages (-> introduced in commit 0d9f442)However, the way it was coded is introducing a small side effect: now, every time there is validation error,
ViolationMapperwill ask the Form Type itslabel, and if notfalse, it will try to translate it.Why it is important/why it causes a BC break
Since by default
AbstractTypedoes not have anylabel, it also introduces a minor BC break.I will explain it with an example: in a project I work on, we check we don't have any missing translation. Sometimes we have violation errors bound to form ; then current code will get Form
label, which innullin form type classes (which is quite usual I believe), so it will generate one, and pass that one to translator. And we see a lot on erroneous missing translations.Proposed fix
This fix moves all this logic into a
if, soViolationMappercall the translator component only if{{ label }}placeholder is used in constraint error message.On top of fixing BC, it has the benefit of lowering the performance cost for every violation when the feature is not used.
I added a test, as I believe the behavior should be guaranteed from now on.