ACP2E-885: GraphqI call sets wrong value for region field

Author: viktym

app/code/Magento/Customer/Model/Address/AbstractAddress.php

@@ -120,6 +120,11 @@ class AbstractAddress extends AbstractExtensibleModel implements AddressModelInt
     /** @var CompositeValidator */
     private $compositeValidator;
 
+    /**
+     * @var array
+     */
+    private array $regionIdCountry = [];
+
     /**
      * @param \Magento\Framework\Model\Context $context
      * @param \Magento\Framework\Registry $registry
@@ -398,7 +403,13 @@ public function getRegionCode()
         $region = $this->getData('region');
 
         if (!$regionId && is_numeric($region)) {
-            if ($this->getRegionModel($region)->getCountryId() == $this->getCountryId()) {
+            $regionId = $this->getRegionIdByCode(
+                (string)$region,
+                (string)$this->getCountryId()
+            );
+            if ($regionId) {
+                $this->setData('region_code', $region);
+            } elseif ($this->getRegionModel($region)->getCountryId() == $this->getCountryId()) {
                 $this->setData('region_code', $this->getRegionModel($region)->getCode());
             }
         } elseif ($regionId) {
@@ -419,20 +430,53 @@ public function getRegionCode()
     public function getRegionId()
     {
         $regionId = $this->getData('region_id');
+        if ($regionId) {
+            return $regionId;
+        }
+
         $region = $this->getData('region');
-        if (!$regionId) {
-            if (is_numeric($region)) {
-                $this->setData('region_id', $region);
+        if (is_numeric($region)) {
+            $regionId = $this->getRegionIdByCode(
+                (string)$region,
+                (string)$this->getCountryId()
+            );
+            if ($regionId) {
+                $this->setData('region_id', $regionId);
                 $this->unsRegion();
             } else {
-                $regionModel = $this->_createRegionInstance()->loadByCode(
-                    $this->getRegionCode(),
-                    $this->getCountryId()
-                );
-                $this->setData('region_id', $regionModel->getId());
+                $this->setData('region_id', $region);
             }
+        } else {
+            $regionId = $this->getRegionIdByCode(
+                (string)$this->getRegionCode(),
+                (string)$this->getCountryId()
+            );
+            $this->setData('region_id', $regionId);
         }
-        return $this->getData('region_id');
+
+        return $regionId;
+    }
+
+    /**
+     * Returns region id.
+     *
+     * @param string $regionCode
+     * @param string $countryId
+     * @return int|null
+     */
+    private function getRegionIdByCode(string $regionCode, string $countryId): ?int
+    {
+        $key = $countryId . '_' . $regionCode;
+        if (!array_key_exists($key, $this->regionIdCountry)) {
+            $regionModel = $this->_createRegionInstance()->loadByCode(
+                $regionCode,
+                $countryId
+            );
+
+            $this->regionIdCountry[$key] = $regionModel->getId() ? (int)$regionModel->getId() : null;
+        }
+
+        return $this->regionIdCountry[$key];
     }
 
     /**

app/code/Magento/Customer/Test/Unit/Model/Address/AbstractAddressTest.php

@@ -217,17 +217,18 @@ protected function prepareGetRegionCode($countryId, $regionCode = 'UK')
     {
         $region = $this->getMockBuilder(Region::class)
             ->addMethods(['getCountryId', 'getCode'])
-            ->onlyMethods(['__wakeup', 'load'])
+            ->onlyMethods(['__wakeup', 'load', 'loadByCode'])
             ->disableOriginalConstructor()
             ->getMock();
+        $region->method('loadByCode')
+            ->willReturnSelf();
         $region->expects($this->once())
             ->method('getCode')
             ->willReturn($regionCode);
         $region->expects($this->once())
             ->method('getCountryId')
             ->willReturn($countryId);
-        $this->regionFactoryMock->expects($this->once())
-            ->method('create')
+        $this->regionFactoryMock->method('create')
             ->willReturn($region);
     }
 

app/code/Magento/QuoteGraphQl/Model/Cart/QuoteAddressFactory.php

@@ -100,10 +100,6 @@ public function createBasedOnInputData(array $addressInput): QuoteAddress
             throw new GraphQlInputException(__('Country is not available'));
         }
 
-        if (!empty($addressInput['region'])) {
-            $this->normalizeRegion($addressInput);
-        }
-
         $this->validateRegion($addressInput);
 
         $maxAllowedLineCount = $this->addressHelper->getStreetLines();
@@ -148,26 +144,6 @@ private function validateRegion(array $addressInput): void
         }
     }
 
-    /**
-     * Normalize region code to region id while requesting to setShippingAddress
-     *
-     * @param array $addressInput
-     */
-    private function normalizeRegion(array &$addressInput)
-    {
-        $shippingAddressRegion = $addressInput['region'];
-        if (is_numeric($shippingAddressRegion)) {
-            $regionCollection = $this->regionCollectionFactory
-                ->create()
-                ->addCountryFilter($addressInput['country_code']);
-            $allRegions = $regionCollection->toOptionArray();
-            $regionId = (int) $addressInput['region'];
-            if (array_key_exists($regionId, $allRegions)) {
-                $addressInput['region'] = $allRegions[$regionId]['value'];
-            }
-        }
-    }
-
     /**
      * Validate the address region when region is required for the country
      *

dev/tests/api-functional/testsuite/Magento/GraphQl/Quote/Customer/SetShippingAddressOnCartTest.php

@@ -162,7 +162,7 @@ public function testSetShippingAddressOnCartWithRegionIdForSimpleProduct()
             company: "Magento"
             street: ["Via Solferino", "45"]
             city: "Ceriano Laghetto"
-            region: "1"
+            region: "58"
             postcode: "20816"
             country_code: "FR"
             telephone: "3273581975",
@@ -1898,7 +1898,7 @@ private function assertShippingAddressWithRegionIdFields(array $shippingAddressR
             ['response_field' => 'city', 'expected_value' => 'Ceriano Laghetto'],
             ['response_field' => 'postcode', 'expected_value' => '20816'],
             ['response_field' => 'telephone', 'expected_value' => '3273581975'],
-            ['response_field' => 'region', 'expected_value' => ['code' => '1', 'label' => 'Ain']],
+            ['response_field' => 'region', 'expected_value' => ['code' => '58', 'label' => 'Nièvre']],
             ['response_field' => 'country', 'expected_value' => ['code' => 'FR', 'label' => 'FR']]
         ];