Merge pull request #1282 from algolia/update/MAGE-373

Deprecated the Synonyms settings from the magento dashboard

Author: mohitalgolia

Helper/ConfigHelper.php

@@ -62,11 +62,6 @@ class ConfigHelper
     public const XML_PATH_IMAGE_HEIGHT = 'algoliasearch_images/image/height';
     public const XML_PATH_IMAGE_TYPE = 'algoliasearch_images/image/type';
 
-    public const ENABLE_SYNONYMS = 'algoliasearch_synonyms/synonyms_group/enable_synonyms';
-    public const SYNONYMS = 'algoliasearch_synonyms/synonyms_group/synonyms';
-    public const ONEWAY_SYNONYMS = 'algoliasearch_synonyms/synonyms_group/oneway_synonyms';
-    public const SYNONYMS_FILE = 'algoliasearch_synonyms/synonyms_group/synonyms_file';
-
     public const CC_ANALYTICS_ENABLE = 'algoliasearch_cc_analytics/cc_analytics_group/enable';
     public const CC_ANALYTICS_IS_SELECTOR = 'algoliasearch_cc_analytics/cc_analytics_group/is_selector';
     public const CC_CONVERSION_ANALYTICS_MODE = 'algoliasearch_cc_analytics/cc_analytics_group/conversion_analytics_mode';
@@ -1454,64 +1449,6 @@ public function getAttributesToFilter($groupId)
         return count($attributes) ? ['filters' => implode(' AND ', $attributes)] : [];
     }
 
-    /**
-     * @param $storeId
-     * @return bool
-     */
-    public function isEnabledSynonyms($storeId = null)
-    {
-        return $this->configInterface->isSetFlag(self::ENABLE_SYNONYMS, ScopeInterface::SCOPE_STORE, $storeId);
-    }
-
-    /**
-     * @param $storeId
-     * @return array
-     */
-    public function getSynonyms($storeId = null)
-    {
-        $synonyms = $this->unserialize($this->configInterface->getValue(
-            self::SYNONYMS,
-            ScopeInterface::SCOPE_STORE,
-            $storeId
-        ));
-        if (is_array($synonyms)) {
-            return $synonyms;
-        }
-        return [];
-    }
-
-    /**
-     * @param $storeId
-     * @return array
-     */
-    public function getOnewaySynonyms($storeId = null)
-    {
-        $onewaySynonyms = $this->unserialize($this->configInterface->getValue(
-            self::ONEWAY_SYNONYMS,
-            ScopeInterface::SCOPE_STORE,
-            $storeId
-        ));
-        if (is_array($onewaySynonyms)) {
-            return $onewaySynonyms;
-        }
-        return [];
-    }
-
-    /**
-     * @param $storeId
-     * @return string|null
-     * @throws Magento\Framework\Exception\FileSystemException
-     */
-    public function getSynonymsFile($storeId = null)
-    {
-        $filename = $this->configInterface->getValue(self::SYNONYMS_FILE, ScopeInterface::SCOPE_STORE, $storeId);
-        if (!$filename) {
-            return null;
-        }
-        $baseDirectory = $this->directoryList->getPath(DirectoryList::MEDIA);
-        return $baseDirectory . '/algoliasearch_admin_config_uploads/' . $filename;
-    }
-
     /**
      * @param $storeId
      * @return bool

Helper/Configuration/AssetHelper.php

@@ -40,11 +40,6 @@ class AssetHelper extends \Magento\Framework\App\Helper\AbstractHelper
             'url' => 'https://www.youtube.com/watch?v=0V1BSKlCm10',
             'thumbnail' => 'https://img.youtube.com/vi/0V1BSKlCm10/mqdefault.jpg',
         ],
-        'algoliasearch_synonyms' => [
-            'title' => 'Notable features',
-            'url' => 'https://www.youtube.com/watch?v=45NKJbrs1Z4',
-            'thumbnail' => 'https://img.youtube.com/vi/45NKJbrs1Z4/mqdefault.jpg',
-        ],
         'algoliasearch_cc_analytics' => [
             'title' => 'Notable features',
             'url' => 'https://www.youtube.com/watch?v=45NKJbrs1Z4',
@@ -143,13 +138,6 @@ class AssetHelper extends \Magento\Framework\App\Helper\AbstractHelper
                 'icon' => 'iconDocs',
             ],
         ],
-        'algoliasearch_synonyms' => [
-            [
-                'title' => 'Synonyms documentation',
-                'url' => 'https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/?utm_source=magento&utm_medium=extension&utm_campaign=magento_2&utm_term=shop-owner&utm_content=doc-link',
-                'icon' => 'iconDocs',
-            ],
-        ],
         'algoliasearch_cc_analytics' => [
             [
                 'title' => 'Click & Conversion Analytics',

Helper/Entity/ProductHelper.php

@@ -500,46 +500,6 @@ public function setSettings($indexName, $indexNameTmp, $storeId, $saveToTmpIndic
         // Commented out as it doesn't delete anything now because of merging replica indices earlier
         // $this->deleteUnusedReplicas($indexName, $replicas, $setReplicasTaskId);
 
-        if ($this->configHelper->isEnabledSynonyms($storeId) === true) {
-            if ($synonymsFile = $this->configHelper->getSynonymsFile($storeId)) {
-                $synonymsToSet = json_decode(file_get_contents($synonymsFile), true);
-            } else {
-                $synonymsToSet = [];
-
-                $synonyms = $this->configHelper->getSynonyms($storeId);
-                foreach ($synonyms as $objectID => $synonym) {
-                    $synonymsToSet[] = [
-                        'objectID' => $objectID,
-                        'type' => 'synonym',
-                        'synonyms' => $this->explodeSynonyms($synonym['synonyms']),
-                    ];
-                }
-
-                $onewaySynonyms = $this->configHelper->getOnewaySynonyms($storeId);
-                foreach ($onewaySynonyms as $objectID => $onewaySynonym) {
-                    $synonymsToSet[] = [
-                        'objectID' => $objectID,
-                        'type' => 'oneWaySynonym',
-                        'input' => $onewaySynonym['input'],
-                        'synonyms' => $this->explodeSynonyms($onewaySynonym['synonyms']),
-                    ];
-                }
-            }
-
-            $this->algoliaHelper->setSynonyms($indexName, $synonymsToSet);
-            $this->logger->log('Setting synonyms to "' . $indexName . '"');
-            if ($saveToTmpIndicesToo === true) {
-                $this->algoliaHelper->setSynonyms($indexNameTmp, $synonymsToSet);
-                $this->logger->log('Setting synonyms to "' . $indexNameTmp . '"');
-            }
-        } elseif ($saveToTmpIndicesToo === true) {
-            $this->algoliaHelper->copySynonyms($indexName, $indexNameTmp);
-            $this->logger->log('
-                Synonyms management disabled.
-                Copying synonyms from production index to TMP one to not to erase them with the index move.
-            ');
-        }
-
         if ($saveToTmpIndicesToo === true) {
             try {
                 $this->algoliaHelper->copyQueryRules($indexName, $indexNameTmp);
@@ -1344,15 +1304,6 @@ protected function clearFacetsQueryRules(SearchIndex $index)
         }
     }
 
-    /**
-     * @param $synonyms
-     * @return array
-     */
-    protected function explodeSynonyms($synonyms)
-    {
-        return array_map('trim', explode(',', $synonyms));
-    }
-
     /**
      * Check if product can be index on Algolia
      *

Model/Source/OnewaySynonyms.php

@@ -779,62 +779,10 @@
             <resource>Algolia_AlgoliaSearch::algolia_algoliasearch</resource>
             <group id="synonyms_group" translate="label" type="text" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">
                 <label>Synonyms</label>
-                <comment>
-                    <![CDATA[
-                    <div class="algolia-admin-content"></div>
-                ]]>
-                </comment>
-                <field id="enable_synonyms" translate="label comment" type="select" sortOrder="5" showInDefault="1" showInWebsite="1" showInStore="1">
-                    <label>Enable Synonyms Management</label>
-                    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+                <field id="notice" translate="label comment" type="label" sortOrder="10" showInDefault="1">
+                    <label>Notice:</label>
                     <comment>
-                        <![CDATA[
-                            Do you want to manage <a target="_blank" href="https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/?utm_source=magento&utm_medium=extension&utm_campaign=magento_2&utm_term=shop-owner&utm_content=doc-link">synonyms</a> in Magento?
-                            If not, synonyms will be managed only in <a target="_blank" href="https://www.algolia.com/dashboard/">Algolia's dashboard</a> and won't be overridden by Magento.
-                        ]]>
-                    </comment>
-                </field>
-                <field id="synonyms" translate="label comment" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">
-                    <label>Synonyms</label>
-                    <frontend_model>Algolia\AlgoliaSearch\Model\Source\Synonyms</frontend_model>
-                    <backend_model>Magento\Config\Model\Config\Backend\Serialized\ArraySerialized</backend_model>
-                    <comment>
-                        <![CDATA[
-                            <a href="https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/?utm_source=magento&utm_medium=extension&utm_campaign=magento_2&utm_term=shop-owner&utm_content=doc-link#regular-synonyms-default" target="_blank">Synonyms</a> can be defined by a comma-separated list of words that will be considered equivalent by the Algolia engine.<br>
-                            For instance: <code>tv, television, tv set</code><br>
-                            Using that set, if a record contains “television” and a user searches for “TV”, this record will be returned.
-                        ]]>
-                    </comment>
-                </field>
-                <field id="oneway_synonyms" translate="label comment" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1">
-                    <label>One-way Synonyms</label>
-                    <frontend_model>Algolia\AlgoliaSearch\Model\Source\OnewaySynonyms</frontend_model>
-                    <backend_model>Magento\Config\Model\Config\Backend\Serialized\ArraySerialized</backend_model>
-                    <comment>
-                        <![CDATA[
-                        <a href="https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/?utm_source=magento&utm_medium=extension&utm_campaign=magento_2&utm_term=shop-owner&utm_content=doc-link#one-way-synonyms" target="_blank">One-way synonyms</a>
-                        allow you to define alternative words for a search term, which are not synonyms to each other.<br>
-                        Let’s take an example: when a user searches for “tablet”, you want him to be able to find iPads and Galaxy Note tablets alike, but you might not want Android tablets to show up when he searches for “iPad”.<br>
-                        To do this, you’d define a one-way synonym set between <code>tablet</code> (as input) and <code>ipad, galaxy note</code> (as synonyms). When the user types in “tablet”, records containing “iPad” and “Galaxy Note” will be returned. However records containing only “tablet” or “Galaxy Note” won’t be returned if he searches for “iPad”.
-                        <br>
-                        <br>
-                        Algolia offers more synonymys’ types - placeholders and alternative corrections. These types can be managed directly from your <a href="https://www.algolia.com/dashboard" target="_blank">Algolia’s dashboard</a>.
-                        Any changes you make to placeholders and alternative corrections in Algolia’s dashboard won’t be overridden.
-                        ]]>
-                    </comment>
-                </field>
-                <field id="synonyms_file" translate="label comment" type="file" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1">
-                    <label>Synonyms File</label>
-                    <backend_model>Algolia\AlgoliaSearch\Model\Source\SynonymsFile</backend_model>
-                    <upload_dir config="system/filesystem/media" scope_info="1">algoliasearch_admin_config_uploads</upload_dir>
-                    <base_url type="media" scope_info="1">algoliasearch_admin_config_uploads</base_url>
-                    <comment>
-                        <![CDATA[
-                            If you have a large amount of synonyms (more than 1 hundred), you don't have to manually enter them in the inputs above.
-                            You can upload a <a href="https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/how-to/managing-synonyms-from-the-dashboard/?utm_source=magento&utm_medium=extension&utm_campaign=magento_2&utm_term=shop-owner&utm_content=doc-link&language=php#importing-synonyms-from-a-file" target="_blank">JSON file</a> with synonyms instead.
-                            <br><span class="algolia-config-warning">&#9888;</span>
-                            When you upload a JSON file, all the synonyms settings from above will be ignored and only synonyms from the JSON file will be pushed to Algolia.
-                        ]]>
+                        <![CDATA[Configurations related to Synonyms have been deprecated from the Magento dashboard. We advise you to configure synonyms from the Algolia dashboard]]>
                     </comment>
                 </field>
             </group>