#37796: Fixed issue with adding new country regions

Author: Yaroslav1301

app/code/Magento/Directory/Setup/DataInstaller.php

@@ -6,46 +6,53 @@
 
 namespace Magento\Directory\Setup;
 
+use Magento\Directory\Helper\Data;
 use Magento\Framework\App\ResourceConnection;
 use Magento\Framework\DB\Adapter\AdapterInterface;
 
 /**
- * Class DataInstaller
- * @package Magento\Directory\Setup
+ * Add Required Regions for Country
  */
 class DataInstaller
 {
-    /**
-     * @var \Magento\Directory\Helper\Data
-     */
-    private $data;
-
     /**
      * @var ResourceConnection
      */
     private $resourceConnection;
 
     /**
      * DatInstaller constructor.
-     * @param \Magento\Directory\Helper\Data $data
+     *
      * @param ResourceConnection $resourceConnection
      */
     public function __construct(
-        \Magento\Directory\Helper\Data $data,
         ResourceConnection $resourceConnection
     ) {
-        $this->data = $data;
         $this->resourceConnection = $resourceConnection;
     }
 
     /**
      * Add country-region data.
      *
-     * @param AdapterInterface $adapter
-     * @param array $data
+     * @param  AdapterInterface $adapter
+     * @param  array $data
+     * @return void
      */
-    public function addCountryRegions(AdapterInterface $adapter, array $data)
+    public function addCountryRegions(AdapterInterface $adapter, array $data): void
     {
+        $where = [
+            $adapter->quoteInto('path = ?', Data::XML_PATH_STATES_REQUIRED),
+            $adapter->quoteInto('scope = ?', 'default'),
+            $adapter->quoteInto('scope_id = ?', 0),
+        ];
+
+        $select = $adapter->select()
+            ->from($this->resourceConnection->getTableName('core_config_data'), 'value')
+            ->where(implode(' AND ', $where));
+
+        $currRequiredStates = $adapter->fetchOne($select);
+        $currRequiredStates = (!empty($currRequiredStates)) ? explode(',', $currRequiredStates) : [];
+
         /**
          * Fill table directory/country_region
          * Fill table directory/country_region_name for en_US locale
@@ -56,21 +63,21 @@ public function addCountryRegions(AdapterInterface $adapter, array $data)
             $regionId = $adapter->lastInsertId($this->resourceConnection->getTableName('directory_country_region'));
             $bind = ['locale' => 'en_US', 'region_id' => $regionId, 'name' => $row[2]];
             $adapter->insert($this->resourceConnection->getTableName('directory_country_region_name'), $bind);
+
+            if (!in_array($row[0], $currRequiredStates)) {
+                $currRequiredStates[] = $row[0];
+            }
         }
+
         /**
          * Upgrade core_config_data general/region/state_required field.
          */
-        $countries = $this->data->getCountryCollection()->getCountriesWithRequiredStates();
         $adapter->update(
             $this->resourceConnection->getTableName('core_config_data'),
             [
-                'value' => implode(',', array_keys($countries))
+                'value' => implode(',', $currRequiredStates)
             ],
-            [
-                'scope="default"',
-                'scope_id=0',
-                'path=?' => \Magento\Directory\Helper\Data::XML_PATH_STATES_REQUIRED
-            ]
+            $where
         );
     }
 }

dev/tests/integration/testsuite/Magento/Directory/Setup/DataInstallerTest.php

@@ -0,0 +1,122 @@
+<?php
+
+namespace integration\testsuite\Magento\Directory\Setup;
+
+use PHPUnit\Framework\TestCase;
+use Magento\TestFramework\Helper\Bootstrap;
+use Magento\Directory\Setup\DataInstaller;
+use Magento\Framework\App\ResourceConnection;
+
+/**
+ * Provide test for DataInstaller
+ */
+class DataInstallerTest extends TestCase
+{
+    /**
+     * @var DataInstaller
+     */
+    private $dataInstaller;
+
+    /**
+     * @var ResourceConnection
+     */
+    private $resourceConnection;
+
+    /**
+     * @return void
+     */
+    protected function setUp(): void
+    {
+        $objectManager = Bootstrap::getObjectManager();
+        $this->dataInstaller = $objectManager->create(DataInstaller::class);
+        $this->resourceConnection = $objectManager->create(ResourceConnection::class);
+    }
+
+    /**
+     * @return void
+     */
+    public function testAddCountryRegions(): void
+    {
+        $adapter = $this->resourceConnection->getConnection();
+        $expectedCountries = $this->getCountries(true);
+
+        $regionsBefore = $this->getTableRowsCount('directory_country_region');
+        $regionsNamesBefore = $this->getTableRowsCount('directory_country_region_name');
+
+        $this->dataInstaller->addCountryRegions(
+            $adapter,
+            $this->getDataForRegions()
+        );
+
+        $regionsAfter = $this->getTableRowsCount('directory_country_region');
+        $regionsNamesAfter = $this->getTableRowsCount('directory_country_region_name');
+
+        $this->assertEquals(4, ($regionsAfter - $regionsBefore));
+        $this->assertEquals(4, ($regionsNamesAfter - $regionsNamesBefore));
+        $this->assertEquals($expectedCountries, $this->getCountries());
+    }
+
+    /**
+     * Count table rows
+     *
+     * @param string $tableName
+     * @return int
+     */
+    private function getTableRowsCount(string $tableName): int
+    {
+        $connection = $this->resourceConnection->getConnection();
+        $select = $connection->select()->from(
+            $this->resourceConnection->getTableName($tableName),
+            ['count(*)']
+        );
+
+        return (int)$connection->fetchOne($select);
+    }
+
+    /**
+     * Return required countries with regions
+     *
+     * @param bool $isConfig
+     * @return string
+     */
+    private function getCountries(bool $isConfig = false): string
+    {
+        $connection = $this->resourceConnection->getConnection();
+        $select = $connection->select()
+            ->from($connection->getTableName('core_config_data'), 'value')
+            ->where('path = ?', 'general/region/state_required')
+            ->where('scope = ?', 'default')
+            ->where('scope_id = ?', 0);
+
+        $countries = $connection->fetchOne($select);
+        $countries = (!empty($countries)) ? explode(',', $countries) : [];
+
+        if (!$isConfig) {
+            return implode(',', $countries);
+        }
+
+        $countryCodes = ['JP', 'UA'];
+        foreach ($countryCodes as $country) {
+            if (!in_array($country, $countries)) {
+                $countries[] = $country;
+            }
+        }
+
+        return implode(',', $countries);
+    }
+
+    /**
+     * Return test data for new regions
+     *
+     * @return array[]
+     */
+    private function getDataForRegions(): array
+    {
+        return [
+            ['JP', 'JP-01', 'State1'],
+            ['JP', 'JP-02', 'State2'],
+            ['JP', 'JP-03', 'State3'],
+            ['UA', 'UA-410', 'State4'],
+        ];
+    }
+}