[HttpKernel][Framework] Locale aware services #28929

neghmurken · 2018-10-19T21:45:24Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	yes
Tests pass?	yes
Fixed tickets
License	MIT
Doc PR

Added a LocaleAwareInterface (and also a new service tag kernel.locale_aware) to be implemented on services that require the current locale at request time.
Also, refactored the actual Translator service to implement the overmentioned interface

Todo :

Documention PR (will be written after some feedback)

ro0NL

i think this is a nice approach/feature :)

src/Symfony/Bundle/FrameworkBundle/Resources/config/translation.xml

src/Symfony/Component/HttpKernel/DependencyInjection/RegisterLocaleAwareServicesPass.php

src/Symfony/Component/HttpKernel/EventListener/LocaleAwareListener.php

src/Symfony/Component/Translation/LocaleAwareInterface.php

src/Symfony/Component/HttpKernel/EventListener/LocaleAwareListener.php

ro0NL

the autoconfiguration should also be updated (each service being an instance of LocaleAwareInterface should get the locale_aware tag automatically.

src/Symfony/Component/HttpKernel/EventListener/LocaleAwareListener.php

src/Symfony/Component/HttpKernel/Tests/EventListener/LocaleAwareListenerTest.php

src/Symfony/Component/HttpKernel/EventListener/LocaleAwareListener.php

src/Symfony/Bundle/FrameworkBundle/Resources/config/translation.xml

src/Symfony/Contracts/Service/LocaleAwareInterface.php

src/Symfony/Component/HttpKernel/EventListener/TranslatorListener.php

src/Symfony/Component/HttpKernel/EventListener/LocaleAwareListener.php

src/Symfony/Component/HttpKernel/Tests/EventListener/LocaleAwareListenerTest.php

ro0NL · 2018-10-28T18:00:52Z

curious.. what about using the existing LocaleListener for this? Then we can use tagged again maybe?

cc @stof

javiereguiluz · 2018-11-07T12:23:08Z

@neghmurken this is an interesting proposal! Thanks for contributing it.

If this is decided to be merged, we'd need some examples of how can we use this new feature in practice (inside a Symfony app and/or as a stand-alone component). If this feature improves an existing feature, please show a before/after example. Thanks a lot!

nicolas-grekas

I'm mixed here:

on one side this is very pragmatic;
on the other side, this is building on top of service mutation - while services should be stateless.

I'd very prefer we could think about a stateless approach instead.

src/Symfony/Component/HttpKernel/DependencyInjection/RegisterLocaleAwareServicesPass.php

src/Symfony/Component/HttpKernel/EventListener/LocaleAwareListener.php

src/Symfony/Contracts/Service/LocaleAwareInterface.php

…Interface (nicolas-grekas) This PR was merged into the 4.2 branch. Discussion ---------- [Contracts] extract LocaleAwareInterface out of TranslatorInterface | Q | A | ------------- | --- | Branch? | 4.2 | Bug fix? | yes | New feature? | no | BC breaks? | yes | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - While reviewing #28929, I realized we have a design issue in the Translation contract: we missed segregating `setLocale()`/`getLocale()` out of `TranslatorInterface`. E.g. when people type-hint for `TranslatorInterface`, they *should not* be auto-suggested with the `setLocale()` mutator. Technically, that's a BC break. I think we should do it. The release is close enough in time and that will save us from maintenance issues this will create in the future otherwise. Commits ------- 73e4a1a [Contracts] extract LocaleAwareInterface out of TranslatorInterface

nicolas-grekas · 2018-12-13T14:14:11Z

I completely swapped my mind here and actually, we merged LocaleAwareInterface in Contracts v1.0.2 as a bug fix, see #29461

Would you mind rebasing, please?

nicolas-grekas

thanks, here are some comments to help move forward.

src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md

src/Symfony/Bundle/FrameworkBundle/Resources/config/services.xml

src/Symfony/Component/HttpKernel/CHANGELOG.md

src/Symfony/Component/HttpKernel/DependencyInjection/RegisterLocaleAwareServicesPass.php

src/Symfony/Component/HttpKernel/EventListener/LocaleAwareListener.php

src/Symfony/Component/HttpKernel/EventListener/TranslatorListener.php

src/Symfony/Component/HttpKernel/EventListener/LocaleAwareListener.php

src/Symfony/Contracts/CHANGELOG.md

nicolas-grekas · 2019-01-26T21:49:02Z

Small rebase needed + lowest version of httpkernel should be bumped in framework bundle to make tests pass.
Good to me after that!

src/Symfony/Component/HttpKernel/DependencyInjection/RegisterLocaleAwareServicesPass.php

xabbuh · 2019-01-27T08:07:46Z

src/Symfony/Bundle/FrameworkBundle/Resources/config/translation.xml

@@ -140,11 +141,5 @@
            <tag name="kernel.cache_warmer" />
            <argument type="service" id="Psr\Container\ContainerInterface" />
        </service>
-
-        <service id="translator_listener" class="Symfony\Component\HttpKernel\EventListener\TranslatorListener">


Should we deprecate the service instead in case someone is relying on its presence?

How can we deprecate without it conflicting with the new LocaleAwareListener ?

Does it do any harm if both listeners are executed?

Yeah you're right. There is no undesirable side effect beside setting the locale twice

I removed the translator_listener service completely as keeping it would trigger deprecation notices. I don't think that's an issue.

xabbuh

looks good apart from a few remaining minor comments

src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md

src/Symfony/Component/HttpKernel/EventListener/LocaleAwareListener.php

src/Symfony/Component/HttpKernel/EventListener/TranslatorListener.php

...mfony/Component/HttpKernel/Tests/DependencyInjection/RegisterLocaleAwareServicesPassTest.php

src/Symfony/Component/HttpKernel/Tests/EventListener/LocaleAwareListenerTest.php

nicolas-grekas

Green. I rebased this PR on latest master and made some tweaks to polish it. I removed the translator_listener service completely as keeping it would trigger deprecation notices. I don't think that's an issue.

fabpot · 2019-04-03T14:27:13Z

Thank you @neghmurken.

…ken) This PR was merged into the 4.3-dev branch. Discussion ---------- [HttpKernel][Framework] Locale aware services | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | Added a `LocaleAwareInterface` (and also a new service tag `kernel.locale_aware`) to be implemented on services that require the current locale at request time. Also, refactored the actual Translator service to implement the overmentioned interface Todo : * [ ] Documention PR (will be written after some feedback) Commits ------- b9ac645 Locale aware service registration

winzou · 2019-10-28T09:39:31Z

Hello @neghmurken, @nicolas-grekas
I'm not sure to understand this block in the onKernelFinishRequest method:

    if (null === $parentRequest = $this->requestStack->getParentRequest()) {
        $this->setLocale($event->getRequest()->getDefaultLocale());

        return;
    }

My usecase:

I have a request with locale=fr and defaultLocale=en
No subquery (hence a null $parentRequest in the above block)
all strings translated in templates are done in fr, that's perfect
but I also have strings translated in an event subscriber during the kernel.terminate event. These strings are translated in en => this is not what I want.

In the if I pasted, during the kernel.finish event, the LocaleAwareListener is defining the locale aware services (translator in my case) to the value of the request defaultLocale. Why? Why changing unilaterally the current locale of these services by the default locale of the request? If I define my current locale to fr, I want fr until the very end of the process, right?

This was not mentionned in the changelog and looks like a BC break (and a bug?) to me. Am I missing something?

Thanks for your insights!

xabbuh · 2019-10-28T10:07:42Z

@winzou Would you mind opening a new issue with your insights? Otherwise I am afraid that your input is likely to get lost.

carsonbot added Status: Needs Review Translation Feature Deprecation labels Oct 19, 2018

ro0NL reviewed Oct 20, 2018

View reviewed changes

jvasseur reviewed Oct 20, 2018

View reviewed changes

src/Symfony/Component/HttpKernel/EventListener/LocaleAwareListener.php Outdated Show resolved Hide resolved

nicolas-grekas added this to the next milestone Oct 20, 2018

ro0NL reviewed Oct 24, 2018

View reviewed changes

stof requested changes Oct 24, 2018

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Oct 24, 2018

xabbuh requested changes Oct 25, 2018

View reviewed changes

nicolas-grekas requested changes Dec 1, 2018

View reviewed changes

nicolas-grekas mentioned this pull request Dec 5, 2018

[Contracts] extract LocaleAwareInterface out of TranslatorInterface #29461

Merged

nicolas-grekas changed the title ~~[Translation] [Framework] Locale aware services~~ [HttpKernel][Framework] Locale aware services Dec 14, 2018

nicolas-grekas reviewed Dec 14, 2018

View reviewed changes

xabbuh reviewed Jan 27, 2019

View reviewed changes

xabbuh reviewed Feb 8, 2019

View reviewed changes

Locale aware service registration

b9ac645

nicolas-grekas approved these changes Apr 3, 2019

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Work labels Apr 3, 2019

nicolas-grekas added the Ready label Apr 3, 2019

fabpot approved these changes Apr 3, 2019

View reviewed changes

fabpot merged commit b9ac645 into symfony:master Apr 3, 2019

neghmurken deleted the feature/locale-aware-services branch April 9, 2019 13:39

nicolas-grekas modified the milestones: next, 4.3 Apr 30, 2019

fabpot mentioned this pull request May 9, 2019

Release v4.3.0-BETA1 #31435

Merged

rjwebdev mentioned this pull request Jun 21, 2019

Wrong locale since SF update 4.3.1 lexik/LexikTranslationBundle#348

Open

acrobat mentioned this pull request Sep 6, 2019

[TranslatorBundle] Tag translator to inject correct locale on sf4.3 Kunstmaan/KunstmaanBundlesCMS#2548

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[HttpKernel][Framework] Locale aware services #28929

[HttpKernel][Framework] Locale aware services #28929

neghmurken commented Oct 19, 2018 •

edited by nicolas-grekas

Loading

ro0NL left a comment

ro0NL left a comment

ro0NL commented Oct 28, 2018

javiereguiluz commented Nov 7, 2018

nicolas-grekas left a comment

nicolas-grekas commented Dec 13, 2018

nicolas-grekas left a comment

nicolas-grekas commented Jan 26, 2019 •

edited

Loading

xabbuh Jan 27, 2019

neghmurken Jan 29, 2019

xabbuh Jan 29, 2019

neghmurken Feb 5, 2019

nicolas-grekas Apr 3, 2019

xabbuh left a comment

nicolas-grekas left a comment •

edited

Loading

fabpot commented Apr 3, 2019

winzou commented Oct 28, 2019

xabbuh commented Oct 28, 2019

[HttpKernel][Framework] Locale aware services #28929

[HttpKernel][Framework] Locale aware services #28929

Conversation

neghmurken commented Oct 19, 2018 • edited by nicolas-grekas Loading

ro0NL left a comment

Choose a reason for hiding this comment

ro0NL left a comment

Choose a reason for hiding this comment

ro0NL commented Oct 28, 2018

javiereguiluz commented Nov 7, 2018

nicolas-grekas left a comment

Choose a reason for hiding this comment

nicolas-grekas commented Dec 13, 2018

nicolas-grekas left a comment

Choose a reason for hiding this comment

nicolas-grekas commented Jan 26, 2019 • edited Loading

xabbuh Jan 27, 2019

Choose a reason for hiding this comment

neghmurken Jan 29, 2019

Choose a reason for hiding this comment

xabbuh Jan 29, 2019

Choose a reason for hiding this comment

neghmurken Feb 5, 2019

Choose a reason for hiding this comment

nicolas-grekas Apr 3, 2019

Choose a reason for hiding this comment

xabbuh left a comment

Choose a reason for hiding this comment

nicolas-grekas left a comment • edited Loading

Choose a reason for hiding this comment

fabpot commented Apr 3, 2019

winzou commented Oct 28, 2019

xabbuh commented Oct 28, 2019

neghmurken commented Oct 19, 2018 •

edited by nicolas-grekas

Loading

nicolas-grekas commented Jan 26, 2019 •

edited

Loading

nicolas-grekas left a comment •

edited

Loading