ENGCOM-4674: [#19908] locale in rest calls is always default locale #19913

 - Merge Pull Request #19913 from jwundrak/magento2:issue/19908-rest-api-locale
 - Merged commits:
   1. 5abd330
   2. ef724a6
   3. 29b4b39

Author: magento-engcom-team

app/code/Magento/Webapi/Controller/PathProcessor.php

@@ -6,6 +6,7 @@
  */
 namespace Magento\Webapi\Controller;
 
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Exception\NoSuchEntityException;
 
 /**
@@ -21,12 +22,23 @@ class PathProcessor
      */
     private $storeManager;
 
+    /**
+     * @var \Magento\Framework\Locale\ResolverInterface
+     */
+    private $localeResolver;
+
     /**
      * @param \Magento\Store\Model\StoreManagerInterface $storeManager
+     * @param \Magento\Framework\Locale\ResolverInterface $localeResolver
      */
-    public function __construct(\Magento\Store\Model\StoreManagerInterface $storeManager)
-    {
+    public function __construct(
+        \Magento\Store\Model\StoreManagerInterface $storeManager,
+        \Magento\Framework\Locale\ResolverInterface $localeResolver = null
+    ) {
         $this->storeManager = $storeManager;
+        $this->localeResolver = $localeResolver ?: ObjectManager::getInstance()->get(
+            \Magento\Framework\Locale\ResolverInterface::class
+        );
     }
 
     /**
@@ -57,9 +69,11 @@ public function process($pathInfo)
         $stores = $this->storeManager->getStores(false, true);
         if (isset($stores[$storeCode])) {
             $this->storeManager->setCurrentStore($storeCode);
+            $this->localeResolver->emulate($this->storeManager->getStore()->getId());
             $path = '/' . (isset($pathParts[1]) ? $pathParts[1] : '');
         } elseif ($storeCode === self::ALL_STORE_CODE) {
             $this->storeManager->setCurrentStore(\Magento\Store\Model\Store::ADMIN_CODE);
+            $this->localeResolver->emulate($this->storeManager->getStore()->getId());
             $path = '/' . (isset($pathParts[1]) ? $pathParts[1] : '');
         } else {
             $path = '/' . implode('/', $pathParts);

app/code/Magento/Webapi/Test/Unit/Controller/PathProcessorTest.php

@@ -13,6 +13,9 @@ class PathProcessorTest extends \PHPUnit\Framework\TestCase
     /** @var \PHPUnit_Framework_MockObject_MockObject | \Magento\Store\Model\StoreManagerInterface */
     private $storeManagerMock;
 
+    /** @var \PHPUnit_Framework_MockObject_MockObject | \Magento\Framework\Locale\ResolverInterface */
+    private $localeResolverMock;
+
     /** @var \Magento\Webapi\Controller\PathProcessor */
     private $model;
 
@@ -24,13 +27,22 @@ class PathProcessorTest extends \PHPUnit\Framework\TestCase
 
     protected function setUp()
     {
-        $this->storeManagerMock = $this->getMockBuilder(\Magento\Store\Model\StoreManagerInterface::class)
-            ->disableOriginalConstructor()
-            ->getMock();
-        $this->storeManagerMock->expects($this->once())
-            ->method('getStores')
-            ->willReturn([$this->arbitraryStoreCode => 'store object', 'default' => 'default store object']);
-        $this->model = new \Magento\Webapi\Controller\PathProcessor($this->storeManagerMock);
+        $store = $this->createMock(\Magento\Store\Api\Data\StoreInterface::class);
+        $store->method('getId')->willReturn(2);
+
+        $this->storeManagerMock = $this->createConfiguredMock(
+            \Magento\Store\Model\StoreManagerInterface::class,
+            [
+                'getStores' => [$this->arbitraryStoreCode => 'store object', 'default' => 'default store object'],
+                'getStore'  => $store,
+            ]
+        );
+        $this->storeManagerMock->expects($this->once())->method('getStores');
+
+        $this->localeResolverMock = $this->createMock(\Magento\Framework\Locale\ResolverInterface::class);
+        $this->localeResolverMock->method('emulate')->with(2);
+
+        $this->model = new \Magento\Webapi\Controller\PathProcessor($this->storeManagerMock, $this->localeResolverMock);
     }
 
     /**
@@ -47,6 +59,10 @@ public function testAllStoreCode($storeCodeInPath, $storeCodeSet, $setCurrentSto
         $this->storeManagerMock->expects($this->exactly($setCurrentStoreCallCtr))
             ->method('setCurrentStore')
             ->with($storeCodeSet);
+        if($setCurrentStoreCallCtr > 0) {
+            $this->localeResolverMock->expects($this->once())
+                ->method('emulate');
+        }
         $result = $this->model->process($inPath);
         $this->assertSame($this->endpointPath, $result);
     }
@@ -60,7 +76,7 @@ public function processPathDataProvider()
             'All store code' => ['all', Store::ADMIN_CODE],
             'Default store code' => ['', 'default', 0],
             'Arbitrary store code' => [$this->arbitraryStoreCode, $this->arbitraryStoreCode],
-            'Explicit default store code' => ['default', 'default']
+            'Explicit default store code' => ['default', 'default'],
         ];
     }
 }

app/code/Magento/WebapiAsync/Test/Unit/Controller/PathProcessorTest.php

@@ -15,6 +15,9 @@ class PathProcessorTest extends \PHPUnit\Framework\TestCase
     /** @var \PHPUnit_Framework_MockObject_MockObject | \Magento\Store\Model\StoreManagerInterface */
     private $storeManagerMock;
 
+    /** @var \PHPUnit_Framework_MockObject_MockObject | \Magento\Framework\Locale\ResolverInterface */
+    private $localeResolverMock;
+
     /** @var \Magento\Webapi\Controller\PathProcessor */
     private $model;
 
@@ -26,16 +29,22 @@ class PathProcessorTest extends \PHPUnit\Framework\TestCase
 
     protected function setUp()
     {
-        $this->storeManagerMock = $this->getMockBuilder(\Magento\Store\Model\StoreManagerInterface::class)
-           ->disableOriginalConstructor()
-           ->getMock();
-        $this->storeManagerMock->expects($this->once())
-           ->method('getStores')
-           ->willReturn([
-               $this->arbitraryStoreCode => 'store object',
-               'default' => 'default store object',
-           ]);
-        $this->model = new \Magento\Webapi\Controller\PathProcessor($this->storeManagerMock);
+        $store = $this->createMock(\Magento\Store\Api\Data\StoreInterface::class);
+        $store->method('getId')->willReturn(2);
+
+        $this->storeManagerMock = $this->createConfiguredMock(
+            \Magento\Store\Model\StoreManagerInterface::class,
+            [
+                'getStores' => [$this->arbitraryStoreCode => 'store object', 'default' => 'default store object'],
+                'getStore'  => $store,
+            ]
+        );
+        $this->storeManagerMock->expects($this->once())->method('getStores');
+
+        $this->localeResolverMock = $this->createMock(\Magento\Framework\Locale\ResolverInterface::class);
+        $this->localeResolverMock->method('emulate')->with(2);
+
+        $this->model = new \Magento\Webapi\Controller\PathProcessor($this->storeManagerMock, $this->localeResolverMock);
     }
 
     /**

dev/tests/integration/testsuite/Magento/Webapi/Controller/PathProcessorTest.php

@@ -15,6 +15,11 @@ class PathProcessorTest extends \PHPUnit\Framework\TestCase
      */
     protected $storeManager;
 
+    /**
+     * @var \Magento\Framework\Locale\ResolverInterface::class
+     */
+    private $localeResolver;
+
     /**
      * @var \Magento\Webapi\Controller\PathProcessor
      */
@@ -25,6 +30,7 @@ protected function setUp()
         $objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
         $this->storeManager = $objectManager->get(\Magento\Store\Model\StoreManagerInterface::class);
         $this->storeManager->reinitStores();
+        $this->localeResolver = $objectManager->get(\Magento\Framework\Locale\ResolverInterface::class);
         $this->pathProcessor = $objectManager->get(\Magento\Webapi\Controller\PathProcessor::class);
     }
 
@@ -59,4 +65,20 @@ public function testProcessWithoutStoreCode()
         $this->assertEquals($path, $result);
         $this->assertEquals('default', $this->storeManager->getStore()->getCode());
     }
+
+    /**
+     * @magentoDataFixture Magento/Store/_files/core_fixturestore.php
+     * @magentoConfigFixture default_store general/locale/code en_US
+     * @magentoConfigFixture fixturestore_store general/locale/code de_DE
+     */
+    public function testProcessWithValidStoreCodeApplyLocale()
+    {
+        $locale = 'de_DE';
+        $storeCode = 'fixturestore';
+        $basePath = "rest/{$storeCode}";
+        $path = $basePath . '/V1/customerAccounts/createCustomer';
+        $this->pathProcessor->process($path);
+        $this->assertEquals($locale, $this->localeResolver->getLocale());
+        $this->assertNotEquals('en_US', $this->localeResolver->getLocale());
+    }
 }