Fix notInRangeMessage usage for a few Range validations

[diimpp]

Q	A
Branch?	1.11
Bug fix?	yes
New feature?	no
BC breaks?	no
Deprecations?	yes
Related tickets	fixes #13883
License	MIT

Issue
Symfony validation constraint Range instroduced new behavior since 4.4 release -- if both min and max options are defined, then notInRangeMessage will be shown and minMessage/maxMessage will be disregarded.

Example

If you will try to generate coupons for promotion with code length larger than 40, then you will see symfony standard message notInRangeMessage: This value should be between {{ min }} and {{ max }}. instead of sylius maxMessage: Coupon code must not be longer than {{ limit }} characters.

Case 1

Sylius/src/Sylius/Bundle/PromotionBundle/Resources/config/validation/PromotionCouponGeneratorInstruction.xml

Lines 33 to 37 in 9506c80

	<constraint name="Range">
	<option name="min">1</option>
	<option name="minMessage">sylius.promotion_coupon_generator_instruction.code_length.min</option>
	<option name="max">40</option>
	<option name="maxMessage">sylius.promotion_coupon_generator_instruction.code_length.max</option>

• Remove minMessage, maxMessage and their translations
• Introduce notInRangeMessage and new translation
• Cover case with behat scenario

Case 2

Sylius/src/Sylius/Bundle/PromotionBundle/Form/Type/Action/UnitPercentageDiscountConfigurationType.php

Lines 35 to 41 in 9506c80

	new Range([
	'min' => 0,
	'max' => 1,
	'minMessage' => 'sylius.promotion_action.percentage_discount_configuration.min',
	'maxMessage' => 'sylius.promotion_action.percentage_discount_configuration.max',
	'groups' => ['sylius'],
	]),

• Remove minMessage, maxMessage usage; Their translations were already removed.
• Introduce notInRangeMessage; Translation already exists as it's shared between order/item percentage discount
• Cover case with behat scenario

Case 3

Sylius/src/Sylius/Bundle/ApiBundle/Resources/config/validation/AddProductReview.xml

Lines 23 to 28 in 9506c80

	<constraint name="Range">
	<option name="min">1</option>
	<option name="max">5</option>
	<option name="minMessage">sylius.review.rating.range</option>
	<option name="maxMessage">sylius.review.rating.range</option>
	<option name="notInRangeMessage">sylius.review.rating.range</option>

• Remove minMessage, maxMessage
• Rename translation key range to not_in_range
• Move to separate Fix product review validation's notInRangeMessage #14584 due deprecation.

Questions

1. Does removal of sylius.promotion_coupon_generator_instruction.code_length.min and ...max messages constitute a deprecation entry? Because those translation strings were inactive (effectively deprecated by symfony upgrade) since project was upgraded to symfony 4.4 and even if somebody has custom translation over there, it has no effect whatsoever.
2. Please advise on adding/removal of translation strings, do I need to do anything else? I do recall some translation service was in use.

[Zales0123]

Nice change, @diimpp! I would leave these min/max messages, as someone can use them in other places in their application. I would also add an UPGRADE file note about it and it's good to be merged 🏅 🎉

[diimpp]

@Zales0123 Hi, can we mention removal of translation min,max messages as BC break instead? Or is it a part of hard BC policy?

My point is why leave dead codemessage, if it's unused by the app since 1.6.0. (symfony/*: ^3.4|^4.3)
While it's possible, that somebody made use of Coupon code must be at least {{ limit }} characters long. in their custom promotion validation, it doesn't look likely.

But I will update PR to keep them, if it's required.

P.S. In related #14584 I've changed sylius.review.rating.range to sylius.review.rating.not_in_range -- Do I keep old trans key as well?

[jakubtobiasz]

Hi @diimpp!
Thanks for your contribution. We decided we should leave the message keys. We don't use them, maybe you aren't either. But it doesn't change in some projects they might be used across the system, and we shouldn't break these places. Thanks in advance!

[TheMilek]

Thank you, Dmitri! 🎉