ENGCOM-8717: The country / region of mail sent from the admin panel is translated into the admin locale. #31875

Author: gabrieldagama

app/code/Magento/Customer/Block/Address/Renderer/DefaultRenderer.php

@@ -172,9 +172,9 @@ public function renderArray($addressAttributes, $format = null)
             }
             $attributeCode = $attributeMetadata->getAttributeCode();
             if ($attributeCode == 'country_id' && isset($addressAttributes['country_id'])) {
-                $data['country'] = $this->_countryFactory->create()->loadByCode(
-                    $addressAttributes['country_id']
-                )->getName();
+                $data['country'] = $this->_countryFactory->create()
+                    ->loadByCode($addressAttributes['country_id'])
+                    ->getName($addressAttributes['locale'] ?? null);
             } elseif ($attributeCode == 'region' && isset($addressAttributes['region'])) {
                 $data['region'] = (string)__($addressAttributes['region']);
             } elseif (isset($addressAttributes[$attributeCode])) {
@@ -198,6 +198,7 @@ public function renderArray($addressAttributes, $format = null)
             }
         }
         $format = $format !== null ? $format : $this->getFormatArray($addressAttributes);
+
         return $this->filterManager->template($format, ['variables' => $data]);
     }
 }

app/code/Magento/Sales/Model/Order/Address/Renderer.php

@@ -7,8 +7,12 @@
 namespace Magento\Sales\Model\Order\Address;
 
 use Magento\Customer\Model\Address\Config as AddressConfig;
+use Magento\Directory\Helper\Data;
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Event\ManagerInterface as EventManager;
 use Magento\Sales\Model\Order\Address;
+use Magento\Store\Model\ScopeInterface;
 
 /**
  * Class Renderer used for formatting an order address
@@ -27,18 +31,26 @@ class Renderer
      */
     protected $eventManager;
 
+    /**
+     * @var ScopeConfigInterface
+     */
+    private $scopeConfig;
+
     /**
      * Constructor
      *
      * @param AddressConfig $addressConfig
      * @param EventManager $eventManager
+     * @param ScopeConfigInterface|null $scopeConfig
      */
     public function __construct(
         AddressConfig $addressConfig,
-        EventManager $eventManager
+        EventManager $eventManager,
+        ?ScopeConfigInterface $scopeConfig = null
     ) {
         $this->addressConfig = $addressConfig;
         $this->eventManager = $eventManager;
+        $this->scopeConfig = $scopeConfig ?: ObjectManager::getInstance()->get(ScopeConfigInterface::class);
     }
 
     /**
@@ -50,12 +62,27 @@ public function __construct(
      */
     public function format(Address $address, $type)
     {
-        $this->addressConfig->setStore($address->getOrder()->getStoreId());
+        $storeId = $address->getOrder()->getStoreId();
+        $this->addressConfig->setStore($storeId);
         $formatType = $this->addressConfig->getFormatByCode($type);
         if (!$formatType || !$formatType->getRenderer()) {
             return null;
         }
         $this->eventManager->dispatch('customer_address_format', ['type' => $formatType, 'address' => $address]);
-        return $formatType->getRenderer()->renderArray($address->getData());
+        $addressData = $address->getData();
+        $addressData['locale'] = $this->getLocaleByStoreId((int) $storeId);
+
+        return $formatType->getRenderer()->renderArray($addressData);
+    }
+
+    /**
+     * Returns locale by storeId
+     *
+     * @param int $storeId
+     * @return string
+     */
+    private function getLocaleByStoreId(int $storeId): string
+    {
+        return $this->scopeConfig->getValue(Data::XML_PATH_DEFAULT_LOCALE, ScopeInterface::SCOPE_STORE, $storeId);
     }
 }

app/code/Magento/Sales/Test/Unit/Model/Order/Address/RendererTest.php

@@ -9,6 +9,7 @@
 
 use Magento\Customer\Block\Address\Renderer\RendererInterface as CustomerAddressBlockRenderer;
 use Magento\Customer\Model\Address\Config as CustomerAddressConfig;
+use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\DataObject;
 use Magento\Framework\Event\ManagerInterface as EventManager;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;
@@ -18,6 +19,9 @@
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
+/**
+ * Test for \Magento\Sales\Model\Order\Address\Renderer.
+ */
 class RendererTest extends TestCase
 {
     /**
@@ -55,6 +59,14 @@ class RendererTest extends TestCase
      */
     private $customerAddressBlockRendererMock;
 
+    /**
+     * @var ScopeConfigInterface|MockObject
+     */
+    private $storeConfigMock;
+
+    /**
+     * @ingeritdoc
+     */
     protected function setUp(): void
     {
         $this->customerAddressConfigMock = $this->getMockBuilder(CustomerAddressConfig::class)
@@ -75,12 +87,15 @@ protected function setUp(): void
             ->method('getOrder')
             ->willReturn($this->orderMock);
 
+        $this->storeConfigMock = $this->createMock(ScopeConfigInterface::class);
+
         $this->objectManagerHelper = new ObjectManagerHelper($this);
         $this->orderAddressRenderer = $this->objectManagerHelper->getObject(
             OrderAddressRenderer::class,
             [
                 'addressConfig' => $this->customerAddressConfigMock,
-                'eventManager' => $this->eventManagerMock
+                'eventManager' => $this->eventManagerMock,
+                'scopeConfig' => $this->storeConfigMock
             ]
         );
     }
@@ -89,7 +104,7 @@ public function testFormat()
     {
         $type = 'html';
         $formatType = new DataObject(['renderer' => $this->customerAddressBlockRendererMock]);
-        $addressData = ['address', 'data'];
+        $addressData = ['address', 'data', 'locale' => 1];
         $result = 'result string';
 
         $this->setStoreExpectations(1);
@@ -103,6 +118,9 @@ public function testFormat()
         $this->orderAddressMock->expects(static::atLeastOnce())
             ->method('getData')
             ->willReturn($addressData);
+        $this->storeConfigMock->expects($this->once())
+            ->method('getValue')
+            ->willReturn(1);
         $this->customerAddressBlockRendererMock->expects(static::once())
             ->method('renderArray')
             ->with($addressData, null)

dev/tests/integration/testsuite/Magento/Sales/Model/Order/Address/RendererTest.php

@@ -5,16 +5,21 @@
  */
 namespace Magento\Sales\Model\Order\Address;
 
-use Magento\TestFramework\Helper\Bootstrap;
-use Magento\Framework\ObjectManagerInterface;
-use Magento\Sales\Model\Order\Address\Renderer as OrderAddressRenderer;
 use Magento\Config\Model\ResourceModel\Config as ConfigResourceModel;
 use Magento\Framework\App\Config;
-use Magento\Store\Model\Store;
-use Magento\Sales\Model\Order\Address as OrderAddress;
+use Magento\Framework\Locale\TranslatedLists;
+use Magento\Framework\ObjectManagerInterface;
 use Magento\Sales\Model\Order;
+use Magento\Sales\Model\Order\Address as OrderAddress;
+use Magento\Sales\Model\Order\Address\Renderer as OrderAddressRenderer;
+use Magento\Store\Model\Store;
+use Magento\TestFramework\Helper\Bootstrap;
+use PHPUnit\Framework\TestCase;
 
-class RendererTest extends \PHPUnit\Framework\TestCase
+/**
+ * Test for \Magento\Sales\Model\Order\Address\Renderer.
+ */
+class RendererTest extends TestCase
 {
     /**
      * @var ObjectManagerInterface
@@ -103,4 +108,30 @@ public function testFormat()
         $this->assertEquals($addressTemplates['html'], $this->orderAddressRenderer->format($address, 'html'));
         $this->assertEquals($addressTemplates['pdf'], $this->orderAddressRenderer->format($address, 'pdf'));
     }
+
+    /**
+     * Order country will be translated to locale on which was placed an order
+     *
+     * @magentoDbIsolation disabled
+     * @magentoDataFixture Magento/Sales/_files/order_fixture_store.php
+     *
+     * @return void
+     */
+    public function testRenderOrderAddressCountry(): void
+    {
+        /** @var TranslatedLists $localeResolver */
+        $this->objectManager->create(TranslatedLists::class, ['locale' => 'ko_KR']);
+
+        /** @var Order $order */
+        $order = $this->objectManager->create(Order::class)
+            ->loadByIncrementId('100000004');
+
+        /** @var OrderAddress $address */
+        $address = $order->getBillingAddress();
+
+        $this->assertStringContainsString(
+            'United States',
+            $this->orderAddressRenderer->format($address, 'html')
+        );
+    }
 }