MAGE-1404: Refactored config.xml

Setup/Patch/Data/MigrateLegacyConfigPatch.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Setup\Patch\Data;
+
+use Algolia\AlgoliaSearch\Setup\Patch\DataMigrationTrait;
+use Magento\Framework\Setup\ModuleDataSetupInterface;
+use Magento\Framework\Setup\Patch\DataPatchInterface;
+use Magento\Framework\Setup\Patch\PatchInterface;
+
+class MigrateLegacyConfigPatch implements DataPatchInterface
+{
+    use DataMigrationTrait;
+
+    public function __construct(
+        protected ModuleDataSetupInterface $moduleDataSetup,
+    ) {}
+
+    /**
+     * @inheritDoc
+     */
+    public function apply(): PatchInterface
+    {
+        $this->moduleDataSetup->getConnection()->startSetup();
+
+        $this->moveIndexingSettings();
+
+        $this->moduleDataSetup->getConnection()->endSetup();
+
+        return $this;
+    }
+
+    /**
+     * Migrate legacy configurations
+     * @return void
+     */
+    protected function moveIndexingSettings(): void
+    {
+        $movedConfig = [
+            'algoliasearch_credentials/credentials/use_adaptive_image' => 'algoliasearch_products/products/use_adaptive_image',
+            'algoliasearch_products/products/number_product_results' => 'algoliasearch_instant/instant/number_product_results',
+            'algoliasearch_products/products/show_suggestions_on_no_result_page' => 'algoliasearch_instant/instant/show_suggestions_on_no_result_page',
+            'algoliasearch_credentials/credentials/is_popup_enabled' => 'algoliasearch_autocomplete/autocomplete/is_popup_enabled',
+            'algoliasearch_credentials/credentials/is_instant_enabled' => 'algoliasearch_instant/instant/is_instant_enabled',
+       ];
+
+        $this->migrateConfig($movedConfig);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public static function getDependencies(): array
+    {
+        return [];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getAliases(): array
+    {
+        return [];
+    }
+}

Setup/Patch/Schema/ConfigPatch.php → Test/Integration/Config/DefaultConfigProvider.php

@@ -1,31 +1,9 @@
 <?php
 
-namespace Algolia\AlgoliaSearch\Setup\Patch\Schema;
+namespace Algolia\AlgoliaSearch\Test\Integration\Config;
 
-use Magento\Framework\App\Config\ConfigResource\ConfigInterface;
-use Magento\Framework\App\ProductMetadataInterface;
-use Magento\Framework\Indexer\IndexerInterfaceFactory;
-use Magento\Framework\Mview\View\SubscriptionFactory;
-use Magento\Framework\Setup\ModuleDataSetupInterface;
-use Magento\Framework\Setup\Patch\SchemaPatchInterface;
-
-class ConfigPatch implements SchemaPatchInterface
+class DefaultConfigProvider
 {
-    /**
-     * @var ConfigInterface
-     */
-    protected $config;
-
-    /**
-     * @var ProductMetadataInterface
-     */
-    protected $productMetadata;
-
-    /**
-     * @var ModuleDataSetupInterface
-     */
-    protected $moduleDataSetup;
-
     /**
      * @var string[]
      */
@@ -257,108 +235,34 @@ class ConfigPatch implements SchemaPatchInterface
         ],
     ];
 
-    /**
-     * @param ConfigInterface $config
-     * @param ProductMetadataInterface $productMetadata
-     * @param ModuleDataSetupInterface $moduleDataSetup Magento\Framework\App\ResourceConnection
-     */
-    public function __construct(
-        ConfigInterface $config,
-        ProductMetadataInterface $productMetadata,
-        ModuleDataSetupInterface $moduleDataSetup
-    ) {
-        $this->config = $config;
-        $this->productMetadata = $productMetadata;
-        $this->moduleDataSetup = $moduleDataSetup;
-
+    public function __construct()
+    {
         $this->serializeDefaultArrayConfigData();
         $this->mergeDefaultDataWithArrayData();
     }
 
-    /**
-     * @return array|string[]
-     */
-    public static function getDependencies()
-    {
-        return [];
-    }
-
-    /**
-     * @return array|string[]
-     */
-    public function getAliases()
-    {
-        return [];
-    }
-
-    /**
-     * @return ConfigPatch|void
-     */
-    public function apply()
-    {
-        $movedConfigDirectives = [
-            'algoliasearch_credentials/credentials/use_adaptive_image' => 'algoliasearch_products/products/use_adaptive_image',
-            'algoliasearch_products/products/number_product_results' => 'algoliasearch_instant/instant/number_product_results',
-            'algoliasearch_products/products/show_suggestions_on_no_result_page' => 'algoliasearch_instant/instant/show_suggestions_on_no_result_page',
-            'algoliasearch_credentials/credentials/is_popup_enabled' => 'algoliasearch_autocomplete/autocomplete/is_popup_enabled',
-            'algoliasearch_credentials/credentials/is_instant_enabled' => 'algoliasearch_instant/instant/is_instant_enabled',
-        ];
-
-        $this->moduleDataSetup->getConnection()->startSetup();
-        $connection = $this->moduleDataSetup->getConnection();
-        $table = $this->moduleDataSetup->getTable('core_config_data');
-        foreach ($movedConfigDirectives as $from => $to) {
-            try {
-                $connection->query('UPDATE ' . $table . ' SET path = "' . $to . '" WHERE path = "' . $from . '"');
-            } catch (\Magento\Framework\DB\Adapter\DuplicateException) {
-                // Skip
-            }
-        }
-
-        /* SET DEFAULT CONFIG DATA */
-        $alreadyInserted = $connection->getConnection()
-            ->query('SELECT path, value FROM ' . $table . ' WHERE path LIKE "algoliasearch_%"')
-            ->fetchAll(\PDO::FETCH_KEY_PAIR);
-
-        foreach ($this->defaultConfigData as $path => $value) {
-            if (isset($alreadyInserted[$path])) {
-                continue;
-            }
-            $this->config->saveConfig($path, $value, 'default', 0);
-        }
-
-        $this->moduleDataSetup->getConnection()->endSetup();
-    }
-
     /**
      * @return string[]
      */
-    public function getDefaultConfigData()
+    public function getDefaultConfigData(): array
     {
         return $this->defaultConfigData;
     }
 
     /**
      * @return void
      */
-    protected function serializeDefaultArrayConfigData()
+    protected function serializeDefaultArrayConfigData(): void
     {
-        $serializeMethod = 'serialize';
-
-        $magentoVersion = $this->productMetadata->getVersion();
-        if (version_compare($magentoVersion, '2.2.0-dev', '>=') === true) {
-            $serializeMethod = 'json_encode';
-        }
-
         foreach ($this->defaultArrayConfigData as $path => $array) {
-            $this->defaultArrayConfigData[$path] = $serializeMethod($array);
+            $this->defaultArrayConfigData[$path] = json_encode($array);
         }
     }
 
     /**
      * @return void
      */
-    protected function mergeDefaultDataWithArrayData()
+    protected function mergeDefaultDataWithArrayData(): void
     {
         $this->defaultConfigData = array_merge($this->defaultConfigData, $this->defaultArrayConfigData);
     }

Test/Integration/TestCase.php

@@ -8,11 +8,11 @@
 use Algolia\AlgoliaSearch\Service\AlgoliaConnector;
 use Algolia\AlgoliaSearch\Service\IndexNameFetcher;
 use Algolia\AlgoliaSearch\Service\IndexOptionsBuilder;
-use Algolia\AlgoliaSearch\Setup\Patch\Schema\ConfigPatch;
 use Algolia\AlgoliaSearch\Test\Integration\AssertValues\Magento246CE;
 use Algolia\AlgoliaSearch\Test\Integration\AssertValues\Magento246EE;
 use Algolia\AlgoliaSearch\Test\Integration\AssertValues\Magento247CE;
 use Algolia\AlgoliaSearch\Test\Integration\AssertValues\Magento247EE;
+use Algolia\AlgoliaSearch\Test\Integration\Config\DefaultConfigProvider;
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\App\ProductMetadataInterface;
 use Magento\Framework\ObjectManagerInterface;
@@ -70,9 +70,9 @@ protected function getIndexName(string $storeIndexPart): string
 
     protected function resetConfigs($configs = [])
     {
-        /** @var ConfigPatch $installClass */
-        $installClass = $this->getObjectManager()->get(ConfigPatch::class);
-        $defaultConfigData = $installClass->getDefaultConfigData();
+        /** @var DefaultConfigProvider $defaultConfigProvider */
+        $defaultConfigProvider = $this->getObjectManager()->get(DefaultConfigProvider::class);
+        $defaultConfigData = $defaultConfigProvider->getDefaultConfigData();
 
         foreach ($configs as $config) {
             $value = (string) $defaultConfigData[$config];