MC-33730: Import address with region for a country that does not have regions defined failes in import/export

Author: yelahin-serhiy

app/code/Magento/CustomerImportExport/Model/Import/Address.php

@@ -54,6 +54,8 @@ class Address extends AbstractCustomer
 
     /**#@-*/
 
+    const COLUMN_REGION_ID = 'region_id';
+
     /**#@+
      * Particular columns that contains of customer default addresses
      */
@@ -666,13 +668,17 @@ protected function _prepareDataForUpdate(array $rowData): array
             }
         }
         // let's try to find region ID
-        $entityRow['region_id'] = null;
+        $entityRow[self::COLUMN_REGION_ID] = null;
 
-        if (!empty($rowData[self::COLUMN_REGION])
-            && $this->getCountryRegionId($rowData[self::COLUMN_COUNTRY_ID], $rowData[self::COLUMN_REGION]) !== false) {
-            $regionId = $this->getCountryRegionId($rowData[self::COLUMN_COUNTRY_ID], $rowData[self::COLUMN_REGION]);
-            $entityRow[self::COLUMN_REGION] = $this->_regions[$regionId];
-            $entityRow['region_id'] = $regionId;
+        if (!empty($entityRow[self::COLUMN_REGION]) && !empty($entityRow[self::COLUMN_COUNTRY_ID])) {
+            $entityRow[self::COLUMN_REGION_ID] = $this->getCountryRegionId(
+                $entityRow[self::COLUMN_COUNTRY_ID],
+                $entityRow[self::COLUMN_REGION]
+            );
+            // override the region name with its proper name if region ID is found
+            $entityRow[self::COLUMN_REGION] = $entityRow[self::COLUMN_REGION_ID] !== null
+                ? $this->_regions[$entityRow[self::COLUMN_REGION_ID]]
+                : $entityRow[self::COLUMN_REGION];
         }
         if ($newAddress) {
             $entityRowNew = $entityRow;
@@ -833,7 +839,7 @@ public static function getDefaultAddressAttributeMapping()
      * Check if address for import is empty (for customer composite mode)
      *
      * @param array $rowData
-     * @return array
+     * @return bool
      */
     protected function _isOptionalAddressEmpty(array $rowData)
     {
@@ -914,7 +920,8 @@ protected function _validateRowForUpdate(array $rowData, $rowNumber)
 
                     if (isset($rowData[self::COLUMN_REGION])
                         && !empty($rowData[self::COLUMN_REGION])
-                        && false === $this->getCountryRegionId(
+                        && count($this->getCountryRegions($rowData[self::COLUMN_COUNTRY_ID])) > 0
+                        && null === $this->getCountryRegionId(
                             $rowData[self::COLUMN_COUNTRY_ID],
                             $rowData[self::COLUMN_REGION]
                         )
@@ -994,18 +1001,22 @@ public function setCustomerAttributes($customerAttributes)
      *
      * @param string $countryId
      * @param string $region
-     * @return bool|int
+     * @return int|null
      */
-    private function getCountryRegionId(string $countryId, string $region)
+    private function getCountryRegionId(string $countryId, string $region): ?int
     {
-        $countryNormalized = strtolower($countryId);
-        $regionNormalized = strtolower($region);
-
-        if (isset($this->_countryRegions[$countryNormalized])
-            && isset($this->_countryRegions[$countryNormalized][$regionNormalized])) {
-            return $this->_countryRegions[$countryNormalized][$regionNormalized];
-        }
+        $countryRegions = $this->getCountryRegions($countryId);
+        return $countryRegions[strtolower($region)] ?? null;
+    }
 
-        return false;
+    /**
+     * Get country regions
+     *
+     * @param string $countryId
+     * @return array
+     */
+    private function getCountryRegions(string $countryId): array
+    {
+        return $this->_countryRegions[strtolower($countryId)] ?? [];
     }
 }

dev/tests/integration/testsuite/Magento/CustomerImportExport/Model/Import/AddressTest.php

@@ -9,10 +9,15 @@
  */
 namespace Magento\CustomerImportExport\Model\Import;
 
+use Magento\Customer\Api\AddressRepositoryInterface;
+use Magento\Customer\Api\CustomerRepositoryInterface;
+use Magento\Customer\Api\Data\AddressInterface;
+use Magento\Framework\Api\SearchCriteriaBuilder;
 use Magento\Framework\App\Filesystem\DirectoryList;
 use Magento\Framework\Filesystem;
 use Magento\ImportExport\Model\Import as ImportModel;
 use Magento\ImportExport\Model\Import\Adapter as ImportAdapter;
+use Magento\ImportExport\Model\Import\Source\Csv;
 use Magento\TestFramework\Helper\Bootstrap;
 use Magento\Framework\Indexer\StateInterface;
 use ReflectionClass;
@@ -483,4 +488,54 @@ public function testCustomerIndexer(): void
         $this->assertEquals(StateInterface::STATUS_VALID, $statusBeforeImport);
         $this->assertEquals(StateInterface::STATUS_INVALID, $statusAfterImport);
     }
+
+    /**
+     * Test import address with region for a country that does not have regions defined
+     *
+     * @magentoDataFixture Magento/Customer/_files/import_export/customer_with_addresses.php
+     */
+    public function testImportAddressWithOptionalRegion()
+    {
+        $objectManager = Bootstrap::getObjectManager();
+        $customerRepository = $objectManager->get(CustomerRepositoryInterface::class);
+        $customer = $customerRepository->get('BetsyParker@example.com');
+        $file = __DIR__ . '/_files/import_uk_address.csv';
+        $filesystem = Bootstrap::getObjectManager()->create(Filesystem::class);
+        $directoryWrite = $filesystem->getDirectoryWrite(DirectoryList::ROOT);
+        $source = new Csv($file, $directoryWrite);
+        $errors = $this->_entityAdapter
+            ->setParameters(['behavior' => ImportModel::BEHAVIOR_ADD_UPDATE])
+            ->setSource($source)
+            ->validateData();
+        $this->assertEmpty($errors->getAllErrors(), 'Import validation failed');
+        $this->_entityAdapter->importData();
+        $address = $this->getAddresses(
+            [
+                'parent_id' => $customer->getId(),
+                'country_id' => 'GB',
+            ]
+        );
+        $this->assertCount(1, $address);
+        $this->assertNull($address[0]->getRegionId());
+        $this->assertEquals('Liverpool', $address[0]->getRegion()->getRegion());
+    }
+
+    /**
+     * Get Addresses by filter
+     *
+     * @param array $filter
+     * @return AddressInterface[]
+     */
+    private function getAddresses(array $filter): array
+    {
+        $objectManager = Bootstrap::getObjectManager();
+        /** @var AddressRepositoryInterface $repository */
+        $repository = $objectManager->create(AddressRepositoryInterface::class);
+        /** @var SearchCriteriaBuilder $searchCriteriaBuilder */
+        $searchCriteriaBuilder = $objectManager->get(SearchCriteriaBuilder::class);
+        foreach ($filter as $attr => $value) {
+            $searchCriteriaBuilder->addFilter($attr, $value);
+        }
+        return $repository->getList($searchCriteriaBuilder->create())->getItems();
+    }
 }

dev/tests/integration/testsuite/Magento/CustomerImportExport/Model/Import/_files/import_uk_address.csv

@@ -0,0 +1,2 @@
+_website,_email,_entity_id,city,company,country_id,fax,firstname,lastname,middlename,postcode,prefix,region,region_id,street,suffix,telephone,vat_id,vat_is_valid,vat_request_date,vat_request_id,vat_request_success,_address_default_billing_,_address_default_shipping_
+base,"BetsyParker@example.com",,Liverpool,,GB,,Mike,Miller,,"L2 2AY",,"Liverpool",0,"Moorfields, Vernon St",," +443450507080",,,,,,,