[Translator] Deprecated transChoice and moved it away from contracts #28375

Nyholm · 2018-09-05T20:27:03Z

Q	A
Branch?	master
Bug fix?	no
New feature?	no
BC breaks?	no
Deprecations?	yes
Tests pass?	yes
Fixed tickets	n/a
License	MIT
Doc PR	Issue: symfony/symfony-docs#10264

This will address comment made here: #27399 (review)

This PR moves the transChoice() method away from Contracts and back to the component. I also reverted changes in the IdentityTranslator. I will still use the deprecated MessageSelector but this is not fine since transChoice() is also deprecated.

Nyholm

I added some comments that I think will help the review.

Nyholm · 2018-09-05T20:28:32Z

UPGRADE-4.2.md

@@ -155,6 +155,7 @@ Translation
 -----------

 * The `TranslatorInterface` has been deprecated in favor of `Symfony\Contracts\Translation\TranslatorInterface`
+ * The `Translator::transChoice()` has been deprecated in favor of using `Translator::trans()` with intl message format 


I choose to use the implementation (Translator) here. We already say that the full interface is deprecated.

Nyholm · 2018-09-05T20:35:14Z

src/Symfony/Component/Translation/MessageSelector.php

-     * @param int    $number  The number of items represented for the message
-     * @param string $locale  The locale to use for choosing
+     * @param string    $message The message being translated
+     * @param int|float $number  The number of items represented for the message


We actually support floats.

Nyholm · 2018-09-05T20:35:43Z

src/Symfony/Component/Translation/IdentityTranslator.php

-    private function getPluralizationRule(int $number, string $locale): int
-    {
-        return PluralizationRules::get($number, $locale, false);
+        return strtr($this->selector->choose((string) $id, $number, $locale ?: $this->getLocale()), $parameters);


FYI: In 4.1 we use (int) $number.

Nyholm · 2018-09-05T20:36:48Z

src/Symfony/Component/Translation/Tests/IdentityTranslatorTest.php

@@ -20,4 +20,193 @@ public function getTranslator()
    {
        return new IdentityTranslator();
    }
+


These tests are moved from Contracts.

Nyholm · 2018-09-05T20:37:19Z

src/Symfony/Component/Translation/TranslatorInterface.php

 */
 interface TranslatorInterface extends BaseTranslatorInterface
 {
+    /**


Moved this back from Contracts

Nyholm · 2018-09-05T20:38:32Z

src/Symfony/Contracts/Translation/TranslatorTrait.php

-    /**
-     * {@inheritdoc}
-     */
-    public function transChoice($id, $number, array $parameters = array(), $domain = null, $locale = null)


This function was removed. It was a replacement for the deprecated MessageSelector. I do not think it is needed anymore, right?

right, ~~same for getPluralizationRule below~~

nicolas-grekas

Open questions:

what should happen when the intl extension is not installed?
should be ship a command converting from one format to the other in this PR?

nicolas-grekas · 2018-09-06T08:19:30Z

src/Symfony/Contracts/Translation/TranslatorTrait.php

-    /**
-     * {@inheritdoc}
-     */
-    public function transChoice($id, $number, array $parameters = array(), $domain = null, $locale = null)


right, ~~same for getPluralizationRule below~~

Nyholm · 2018-09-06T08:24:22Z

what should happen when the intl extension is not installed?

I think we should ship with "SimpleIntlFormat" that maybe covers some use cases.

should be ship a command converting from one format to the other in this PR?

I think that is a good idea. But that is not a requirement for this PR (nor for 4.2). But the sooner the better.

nicolas-grekas · 2018-09-06T08:34:10Z

I think it would be friendly to make migrating to the new format as seamless as possible, running a command to update existing catalogs would be awesome. It should be shipped at the same time as the deprecation to me. If doable of course.

We should also deprecate the twig helpers btw! (as highlighted by the CI ;) )

Nyholm · 2018-09-06T08:36:11Z

Okey. I'll will not do it in this PR. It is a lot of code and hard to review already. I will work on a migration script now and add that in a other PR.

We should also deprecate the twig helpers btw! (as highlighted by the CI ;) )

Thank you. I saw those now. 👍

Label: Needs work

stof · 2018-09-06T10:53:35Z

Well, you cannot deprecate the transChoice API if catalogues are still using the old format.

And we also need to figure out the migration path between format.
And that path should take into account bundles which might need to keep support for 3.4 and 4.1. Forcing bundles to either use the deprecated API or drop support for 3.4 and 4.1 is hurting the upgrade path for bundles (dropping support for the LTS is often not an option for them)

stof · 2018-09-06T10:54:29Z

src/Symfony/Component/Translation/IdentityTranslator.php

@@ -43,15 +41,11 @@ public function __construct(MessageSelector $selector = null)
     */
    public function transChoice($id, $number, array $parameters = array(), $domain = null, $locale = null)
    {
-        if ($this->selector) {
-            return strtr($this->selector->choose((string) $id, (int) $number, $locale ?: $this->getLocale()), $parameters);
+        @trigger_error(sprintf('The "%s()" method is deprecated since Symfony 4.1, use the "trans()" method with intl formatted messages instead.', __METHOD__), E_USER_DEPRECATED);


4.1 ? That's too late for that

Nyholm · 2018-09-17T16:44:07Z

This PR is blocked by #28486 and related to #28492.

nicolas-grekas · 2018-09-21T13:03:24Z

I just rebased+squashed the PR by pushing on your fork.
There is now #28523 we need to take care of.
I'd suggest moving forward the implementation as if MessageFormatter was always available.
We'll then be able to move #28486 forward independently.

Nyholm · 2018-09-22T12:02:58Z

src/Symfony/Component/Translation/LoggingTranslator.php

+        if ($this->translator instanceof LegacyTranslatorInterface) {
+            $trans = $this->translator->transChoice($id, $number, $parameters, $domain, $locale);
+        } else {
+            $trans = $this->doTransChoice($id, $number, $parameters, $domain, $locale);


Is this correct to use the trait here and in the DataCollector?

Nyholm · 2018-09-22T12:04:21Z

src/Symfony/Component/Validator/Violation/ConstraintViolationBuilder.php

@@ -141,7 +142,7 @@ public function setCause($cause)
     */
    public function addViolation()
    {
-        if (null === $this->plural) {
+        if (null === $this->plural || !$this->translator instanceof LegacyTranslatorInterface) {


This will cause some deprecations. How can I know if I should use transChoice or not?

Nyholm · 2018-09-22T12:08:04Z

@stof Thank you for the review.

Well, you cannot deprecate the transChoice API if catalogues are still using the old format.

The migration path would be to run the translation:convert-to-intl-message. See #28486

About supporting both formats: That is a fair point, do you have any suggestions?

Status: needs review

nicolas-grekas · 2018-10-01T19:39:34Z

I pushed a new approach here, see 2nd commit: I think we should not deprecate the current plural format as this would create a too steep migration path for devs. Instead, I think we should make "trans()" able to resolve plurals. That's already the case when using the INTL message format, so let's make it work with the Symfony format.

What is proposed now is to make the %count% parameter special: when it is defined and is numeric, then the message is parsed using the plural rules.

For Twig, {% transchoice 5 %} is replaced by {% trans count 5 %} or {% trans with {"%count%": 5} %}
and {{ 'message'|transchoice(5) }} by {{ 'message'|trans(count=5) }} or {{ 'message'|trans({"%count%": 5}) }}

There is a potential for conflicts with existing messages when these two conditions are met together:

a %count% parameter is used with trans(),
the message embeds a pipe character (|).

We could choose another special parameter name if we think the risk is unreasonable (to me it's OK).
WDYT?

Ready for review.

Nyholm

I've reviewed this carefully. I think it looks alright.

About %count%. I was considering to use # because that is that INTL is using. However, the potential conflicts are larger and we do not need to take this step towards INTL format right now.

👍

Nyholm · 2018-10-06T08:27:32Z

src/Symfony/Component/Translation/DataCollectorTranslator.php

        $trans = $this->translator->transChoice($id, $number, $parameters, $domain, $locale);
-        $this->collectMessage($locale, $domain, $id, $trans, $parameters, $number);
+
+        $this->collectMessage($locale, $domain, $id, $trans, array('%count%' => $number) + $parameters);


I've always got problems when adding arrays. Shouldn't we use the more easy-to-read array_merge?

array_merge is a function call, personally I prefer using the language directly.

fabpot · 2018-10-06T16:12:50Z

src/Symfony/Component/Form/Extension/Csrf/EventListener/CsrfValidationListener.php

    {
+        if (null !== $translator && !$translator instanceof LegacyTranslatorInterface && !$translator instanceof TranslatorInterface) {
+            throw new \TypeError(sprintf('Argument 5 passed to %s() must be an instance of %s, %s given', __METHOD__, TranslatorInterface::class, \is_object($translator) ? \get_class($translator) : \gettype($translator)));


missing . at the end of the exception message.

There are many other occurrences.

oups, now all of them are fixed

fabpot · 2018-10-06T16:27:05Z

Thank you @Nyholm.

…from contracts (Nyholm, nicolas-grekas) This PR was merged into the 4.2-dev branch. Discussion ---------- [Translator] Deprecated transChoice and moved it away from contracts | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | Issue: symfony/symfony-docs#10264 This will address comment made here: #27399 (review) This PR moves the `transChoice()` method away from Contracts and back to the component. I also reverted changes in the `IdentityTranslator`. I will still use the deprecated `MessageSelector` but this is not fine since `transChoice()` is also deprecated. Commits ------- dc5f3bf Make trans + %count% parameter resolve plurals d870a85 [Translator] Deprecated transChoice and moved it away from contracts

carsonbot added Status: Needs Review Translation Deprecation labels Sep 5, 2018

Nyholm commented Sep 5, 2018

View reviewed changes

nicolas-grekas reviewed Sep 6, 2018

View reviewed changes

stof requested changes Sep 6, 2018

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Sep 6, 2018

nicolas-grekas added this to the next milestone Sep 6, 2018

Nyholm mentioned this pull request Sep 17, 2018

[Translator] Intl message converter #28486

Closed

nicolas-grekas force-pushed the transchoice-deprecation branch from 1a5de0a to 868e9bd Compare September 21, 2018 12:59

Nyholm force-pushed the transchoice-deprecation branch from 868e9bd to 39fcccf Compare September 22, 2018 10:45

Nyholm commented Sep 22, 2018

View reviewed changes

carsonbot added Status: Needs Review and removed Status: Needs Work labels Sep 22, 2018

nicolas-grekas force-pushed the transchoice-deprecation branch 4 times, most recently from 562bdff to 7cdef58 Compare October 1, 2018 19:35

nicolas-grekas force-pushed the transchoice-deprecation branch from 7cdef58 to 943f23b Compare October 1, 2018 19:47

nicolas-grekas modified the milestones: next, 4.2 Oct 1, 2018

[Translator] Deprecated transChoice and moved it away from contracts

d870a85

nicolas-grekas force-pushed the transchoice-deprecation branch from 943f23b to 54421ed Compare October 6, 2018 08:01

Nyholm commented Oct 6, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Oct 6, 2018

fabpot approved these changes Oct 6, 2018

View reviewed changes

nicolas-grekas force-pushed the transchoice-deprecation branch from 54421ed to 211e8af Compare October 6, 2018 16:16

Make trans + %count% parameter resolve plurals

dc5f3bf

nicolas-grekas force-pushed the transchoice-deprecation branch from 211e8af to dc5f3bf Compare October 6, 2018 16:22

fabpot merged commit dc5f3bf into symfony:master Oct 6, 2018

This was referenced Nov 3, 2018

Release v4.2.0-BETA1 #29072

Closed

Release v4.2.0-BETA1 #29073

Merged

ogizanagi mentioned this pull request May 23, 2019

[Translation] Fixed issue with new vs old TranslatorInterface in TranslationDataCollector #31599

Merged

noniagriconomie mentioned this pull request Feb 12, 2020

[Translation] TransChoice invalid plural translation #31110

Closed

Kocal mentioned this pull request Aug 9, 2020

Support for ICU-based message formatting, close #256 willdurand/BazingaJsTranslationBundle#288

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Translator] Deprecated transChoice and moved it away from contracts #28375

[Translator] Deprecated transChoice and moved it away from contracts #28375

Nyholm commented Sep 5, 2018

Nyholm left a comment

Nyholm Sep 5, 2018

Nyholm Sep 5, 2018

Nyholm Sep 5, 2018

Nyholm Sep 5, 2018

Nyholm Sep 5, 2018

Nyholm Sep 5, 2018

nicolas-grekas Sep 6, 2018 •

edited

Loading

nicolas-grekas left a comment

nicolas-grekas Sep 6, 2018 •

edited

Loading

Nyholm commented Sep 6, 2018

nicolas-grekas commented Sep 6, 2018

Nyholm commented Sep 6, 2018

stof commented Sep 6, 2018

stof Sep 6, 2018

Nyholm commented Sep 17, 2018

nicolas-grekas commented Sep 21, 2018

Nyholm Sep 22, 2018

Nyholm Sep 22, 2018

Nyholm commented Sep 22, 2018

nicolas-grekas commented Oct 1, 2018 •

edited

Loading

Nyholm left a comment

Nyholm Oct 6, 2018

nicolas-grekas Oct 6, 2018

fabpot Oct 6, 2018

nicolas-grekas Oct 6, 2018

fabpot Oct 6, 2018

nicolas-grekas Oct 6, 2018

fabpot commented Oct 6, 2018

[Translator] Deprecated transChoice and moved it away from contracts #28375

[Translator] Deprecated transChoice and moved it away from contracts #28375

Conversation

Nyholm commented Sep 5, 2018

Nyholm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas Sep 6, 2018 • edited Loading

Choose a reason for hiding this comment

nicolas-grekas left a comment

Choose a reason for hiding this comment

nicolas-grekas Sep 6, 2018 • edited Loading

Choose a reason for hiding this comment

Nyholm commented Sep 6, 2018

nicolas-grekas commented Sep 6, 2018

Nyholm commented Sep 6, 2018

stof commented Sep 6, 2018

Choose a reason for hiding this comment

Nyholm commented Sep 17, 2018

nicolas-grekas commented Sep 21, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Nyholm commented Sep 22, 2018

nicolas-grekas commented Oct 1, 2018 • edited Loading

Nyholm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabpot commented Oct 6, 2018

nicolas-grekas Sep 6, 2018 •

edited

Loading

nicolas-grekas Sep 6, 2018 •

edited

Loading

nicolas-grekas commented Oct 1, 2018 •

edited

Loading