[Checkout] Fix supported locales resolving (Sylius#402)

GSadee · web-flow · commit 53d751885d42 · 2025-10-20T14:23:12.000+02:00
| Q | A | --------------- | ----- | Branch? | 1.7 | Bug fix? | yes | New feature? | kinda | Related tickets | fixes Sylius#207 Introduced a new configuration node `supported_locales` which sets the `sylius_paypal.supported_locales` parameter, further used in locale processing. The default value of this node is set based on [PayPal's documentation](https://developer.paypal.com/reference/locale-codes/) table.
diff --git a/spec/Processor/LocaleProcessorSpec.php b/spec/Processor/LocaleProcessorSpec.php
@@ -14,9 +14,22 @@
 namespace spec\Sylius\PayPalPlugin\Processor;
 
 use PhpSpec\ObjectBehavior;
+use Sylius\PayPalPlugin\Resolver\SupportedLocaleResolverInterface;
 
 final class LocaleProcessorSpec extends ObjectBehavior
 {
+    function let(SupportedLocaleResolverInterface $supportedLocaleResolver): void
+    {
+        $supportedLocaleResolver->resolve('et')->willReturn('et_EE');
+        $supportedLocaleResolver->resolve('pl')->willReturn('pl_PL');
+        $supportedLocaleResolver->resolve('ja')->willReturn('ja_JP');
+        $supportedLocaleResolver->resolve('it_IT')->willReturn('it_IT');
+        $supportedLocaleResolver->resolve('de_DE')->willReturn('de_DE');
+        $supportedLocaleResolver->resolve('en')->willReturn('en_US');
+
+        $this->beConstructedWith($supportedLocaleResolver);
+    }
+
     function it_always_processes_locale_to_version_with_region(): void
     {
         $this->process('et')->shouldReturn('et_EE');
@@ -27,12 +40,34 @@ function it_always_processes_locale_to_version_with_region(): void
     function it_returns_same_locale_if_it_is_valid(): void
     {
         $this->process('it_IT')->shouldReturn('it_IT');
+        $this->process('de_DE')->shouldReturn('de_DE');
+    }
+
+    function it_returns_correct_locale_for_en_locale(): void
+    {
+        $this->process('en')->shouldReturn('en_US');
+    }
+
+    function it_always_processes_locale_to_version_with_region_using_legacy_mode(): void
+    {
+        $this->beConstructedWith(null);
+        $this->process('et')->shouldReturn('et_EE');
+        $this->process('pl')->shouldReturn('pl_PL');
+        $this->process('ja')->shouldReturn('ja_JP');
+    }
+
+    function it_returns_same_locale_if_it_is_valid_using_legacy_mode(): void
+    {
+        $this->beConstructedWith(null);
+        $this->process('it_IT')->shouldReturn('it_IT');
+        $this->process('de_DE')->shouldReturn('de_DE');
         $this->process('ja_JP_TRADITIONAL')->shouldReturn('ja_JP_TRADITIONAL');
         $this->process('sd_Arab_PK')->shouldReturn('sd_Arab_PK');
     }
 
-    function it_returns_correct_locale_for_en_locale(): void
+    function it_returns_correct_locale_for_en_locale_using_legacy_mode(): void
     {
+        $this->beConstructedWith(null);
         $this->process('en')->shouldReturn('en_US');
     }
 }
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -18,6 +18,14 @@
 
 final class Configuration implements ConfigurationInterface
 {
+    private const ALL_PAYPAL_SUPPORTED_LOCALES = [
+        'ar_EG', 'cs_CZ', 'da_DK', 'de_DE', 'el_GR', 'en_US', 'en_AU', 'en_GB',
+        'en_IN', 'es_ES', 'es_XC', 'fi_FI', 'fr_FR', 'fr_CA', 'fr_XC', 'he_IL',
+        'hu_HU', 'id_ID', 'it_IT', 'ja_JP', 'ko_KR', 'nl_NL', 'no_NO', 'pl_PL',
+        'pt_BR', 'pt_PT', 'ru_RU', 'sk_SK', 'sv_SE', 'th_TH', 'zh_CN', 'zh_HK',
+        'zh_TW', 'zh_XC',
+    ];
+
     public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('sylius_pay_pal_plugin');
@@ -34,6 +42,11 @@ public function getConfigTreeBuilder(): TreeBuilder
                         ->end()
                     ->end()
                 ->end()
+                ->arrayNode('supported_locales')
+                    ->scalarPrototype()->end()
+                    ->defaultValue(self::ALL_PAYPAL_SUPPORTED_LOCALES)
+                    ->performNoDeepMerging()
+                ->end()
             ->end()
         ;
 
diff --git a/src/DependencyInjection/SyliusPayPalExtension.php b/src/DependencyInjection/SyliusPayPalExtension.php
@@ -34,6 +34,8 @@ public function load(array $configs, ContainerBuilder $container): void
 
         $this->setCommunicationParameters($container, $config);
 
+        $container->setParameter('sylius_paypal.supported_locales', $config['supported_locales']);
+
         $loaderResolver = new LoaderResolver([
             new PhpFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config')),
             new XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config')),
diff --git a/src/Processor/LocaleProcessor.php b/src/Processor/LocaleProcessor.php
@@ -13,13 +13,46 @@
 
 namespace Sylius\PayPalPlugin\Processor;
 
+use Sylius\PayPalPlugin\Resolver\SupportedLocaleResolverInterface;
 use Symfony\Component\Intl\Locales;
 
 final class LocaleProcessor implements LocaleProcessorInterface
 {
+    private const ALLOWED_LOCALE_PATTERN = '/^[a-z]{2}(_[A-Z]{2})?$/';
+
+    public function __construct(
+        private readonly ?SupportedLocaleResolverInterface $supportedLocaleResolver = null,
+    ) {
+        if (null === $this->supportedLocaleResolver) {
+            trigger_deprecation(
+                'sylius/paypal-plugin',
+                '1.7',
+                sprintf(
+                    'Not passing an instance of "%s" is deprecated and will be prohibited in 3.0',
+                    SupportedLocaleResolverInterface::class,
+                ),
+            );
+        }
+    }
+
     public function process(string $locale): string
     {
-        if ($this->isValidLocale($locale)) {
+        if (null !== $this->supportedLocaleResolver) {
+            $locale = trim($locale);
+
+            if ($this->isValidLocale($locale)) {
+                return $this->supportedLocaleResolver->resolve($locale);
+            }
+
+            throw new \UnexpectedValueException(sprintf('Locale "%s" is not valid.', $locale));
+        }
+
+        return $this->legacyProcess($locale);
+    }
+
+    private function legacyProcess(string $locale): string
+    {
+        if (str_contains($locale, '_')) {
             return $locale;
         }
 
@@ -29,21 +62,24 @@ public function process(string $locale): string
 
         $locales = array_filter(Locales::getLocales(), function (string $targetLocale) use ($locale): bool {
             return
-                strpos($targetLocale, $locale) === 0 &&
-                strpos($targetLocale, '_') !== false &&
-                strlen($targetLocale) === 5
+                str_starts_with($targetLocale, $locale) &&
+                strlen($targetLocale) === 5 &&
+                $this->isValidLocale($targetLocale)
             ;
         });
 
         if ([] === $locales) {
             throw new \UnexpectedValueException(sprintf('Locale "%s" is not supported by PayPal.', $locale));
         }
 
-        return $locales[array_key_first($locales)];
+        return array_shift($locales);
     }
 
     private function isValidLocale(string $locale): bool
     {
-        return strpos($locale, '_') !== false;
+        return
+            false === str_contains($locale, ' ') &&
+            1 === preg_match(self::ALLOWED_LOCALE_PATTERN, $locale)
+        ;
     }
 }
diff --git a/src/Resolver/SupportedLocaleResolver.php b/src/Resolver/SupportedLocaleResolver.php
@@ -0,0 +1,63 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\PayPalPlugin\Resolver;
+
+final class SupportedLocaleResolver implements SupportedLocaleResolverInterface
+{
+    private readonly array $supportedLocales;
+
+    public function __construct(
+        array $supportedLocales = [],
+    ) {
+        $this->supportedLocales = array_unique($supportedLocales);
+    }
+
+    public function resolve(string $locale): string
+    {
+        if (empty(trim($locale))) {
+            throw new \UnexpectedValueException('Locale cannot be empty.');
+        }
+
+        $length = strlen($locale);
+        if (5 === $length) {
+            if (in_array($locale, $this->supportedLocales, true)) {
+                return $locale;
+            }
+
+            throw new \UnexpectedValueException(
+                sprintf('Locale "%s" is not supported by PayPal.', $locale),
+            );
+        }
+        if (2 === $length) {
+            return $this->findSupportedLocaleByLanguageCode($locale);
+        }
+
+        throw new \UnexpectedValueException(
+            sprintf('Locale "%s" is not supported by PayPal.', $locale),
+        );
+    }
+
+    private function findSupportedLocaleByLanguageCode(string $languageCode): string
+    {
+        foreach ($this->supportedLocales as $locale) {
+            if (str_starts_with($locale, $languageCode)) {
+                return $locale;
+            }
+        }
+
+        throw new \UnexpectedValueException(
+            sprintf('Language "%s" could not be resolved into a locale supported by PayPal.', $languageCode),
+        );
+    }
+}
diff --git a/src/Resolver/SupportedLocaleResolverInterface.php b/src/Resolver/SupportedLocaleResolverInterface.php
@@ -0,0 +1,20 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\PayPalPlugin\Resolver;
+
+interface SupportedLocaleResolverInterface
+{
+    /** @throw \UnexpectedValueException */
+    public function resolve(string $locale): string;
+}
diff --git a/src/Resources/config/services.xml b/src/Resources/config/services.xml
@@ -356,5 +356,13 @@
             <argument type="service" id="sylius.repository.payment_method" />
         </service>
         <service id="Sylius\PayPalPlugin\Resolver\PayPalPaymentMethodsResolverInterface" alias="sylius_paypal.resolver.paypal_payment_methods" />
+
+        <service
+            id="sylius_paypal.resolver.supported_locale"
+            class="Sylius\PayPalPlugin\Resolver\SupportedLocaleResolver"
+        >
+            <argument>%sylius_paypal.supported_locales%</argument>
+        </service>
+        <service id="Sylius\PayPalPlugin\Resolver\SupportedLocaleResolverInterface" alias="sylius_paypal.resolver.supported_locale" />
     </services>
 </container>
diff --git a/tests/Unit/Resolver/SupportedLocaleResolverTest.php b/tests/Unit/Resolver/SupportedLocaleResolverTest.php
