Merge pull request #1710 from algolia/feat/MAGE-975-dynamic-widgets

MAGE-975 dynamic facets

Author: cammonro

Block/Configuration.php

@@ -197,7 +197,8 @@ public function getConfiguration()
                 'categorySeparator' => $config->getCategorySeparator(),
                 'categoryPageIdAttribute' => $config->getCategoryPageIdAttributeName(),
                 'isCategoryNavigationEnabled' => self::IS_CATEGORY_NAVIGATION_ENABLED,
-                'hidePagination' => $config->hidePaginationInInstantSearchPage()
+                'hidePagination' => $config->hidePaginationInInstantSearchPage(),
+                'isDynamicFacetsEnabled' => $config->isDynamicFacetsEnabled()
             ],
             'autocomplete' => [
                 'enabled' => $config->isAutoCompleteEnabled(),

Helper/ConfigHelper.php

@@ -38,6 +38,8 @@ class ConfigHelper
     public const NUMBER_OF_PRODUCT_RESULTS = 'algoliasearch_instant/instant/number_product_results';
     public const FACETS = 'algoliasearch_instant/instant_facets/facets';
     public const MAX_VALUES_PER_FACET = 'algoliasearch_instant/instant_facets/max_values_per_facet';
+    public const ENABLE_DYNAMIC_FACETS = 'algoliasearch_instant/instant_facets/enable_dynamic_facets';
+
     public const SORTING_INDICES = 'algoliasearch_instant/instant_sorts/sorts';
     public const SEARCHBOX_ENABLE = 'algoliasearch_instant/instant_options/instantsearch_searchbox';
     public const SHOW_SUGGESTIONS_NO_RESULTS = 'algoliasearch_instant/instant_options/show_suggestions_on_no_result_page';
@@ -1343,6 +1345,19 @@ public function getFacets($storeId = null)
         return [];
     }
 
+    /**
+     * @param int|null $storeId
+     * @return bool
+     */
+    public function isDynamicFacetsEnabled(?int $storeId = null): bool
+    {
+        return $this->configInterface->isSetFlag(
+            self::ENABLE_DYNAMIC_FACETS,
+            ScopeInterface::SCOPE_STORE,
+            $storeId
+        );
+    }
+
     /**
      * @param $storeId
      * @return array

Helper/Entity/ProductHelper.php

@@ -285,11 +285,14 @@ public function getIndexSettings(?int $storeId = null): array
             'customRanking'           => $this->getCustomRanking($storeId),
             'unretrievableAttributes' => $this->getUnretrieveableAttributes($storeId),
             'attributesForFaceting'   => $this->facetBuilder->getAttributesForFaceting($storeId),
-            'renderingContent'        => $this->facetBuilder->getRenderingContent($storeId),
             'maxValuesPerFacet'       => $this->configHelper->getMaxValuesPerFacet($storeId),
             'removeWordsIfNoResults'  => $this->configHelper->getRemoveWordsIfNoResult($storeId),
         ];
 
+        if ($this->configHelper->isDynamicFacetsEnabled($storeId)) {
+            $indexSettings['renderingContent'] = $this->facetBuilder->getRenderingContent($storeId);
+        }
+
         // Additional index settings from event observer
         $transport = new DataObject($indexSettings);
         // Only for backward compatibility

etc/adminhtml/system.xml

@@ -434,6 +434,29 @@
                         ]]>
                     </comment>
                 </field>
+                <field id="enable_dynamic_facets" translate="label comment" type="select" sortOrder="10" showInDefault="1"
+                       showInWebsite="1" showInStore="1">
+                    <label>Enable dynamic facets</label>
+                    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+                    <comment>
+                        <![CDATA[
+                            While the rendering of facets is configured based on your Magento admin settings, it is possible to override
+                            these settings via merchandising rules in Algolia. Enable "dynamic facets" to allow InstantSearch
+                            to render facets based on the rule conditions you define in either the Algolia Dashboard or Merchandising Studio.
+                            <br><br>
+                            This feature utilizes the "Facet display" configuration in the Algolia Dashboard (a.k.a. <code>renderingContent</code>).
+                            If you have customized this setting in the Dashboard for your products index, please note that enabling this option will allow Magento to overwrite your configuration.
+                            <br><br>
+                            <span class="algolia-config-warning">&#9888;</span>
+                            <strong>IMPORTANT!</strong> Do not enable dynamic facets unless you have the "renderingContent" feature enabled on your Algolia application. Otherwise this configuration
+                            can cause your indexing to fail.
+
+                        ]]>
+                    </comment>
+                    <depends>
+                        <field id="is_instant_enabled">1</field>
+                    </depends>
+                </field>
                 <depends>
                     <field id="algoliasearch_instant/instant/is_instant_enabled">1</field>
                 </depends>

etc/config.xml

@@ -31,6 +31,7 @@
             <instant_facets>
                 <facets><![CDATA[{"_1458145454535_587":{"attribute":"price","type":"slider","label":"Price","searchable":"2","create_rule":"2"},"_2541608784525_123":{"attribute":"categories","type":"conjunctive","label":"Categories","searchable":"2","create_rule":"2"},"_3211608784535_456":{"attribute":"color","type":"disjunctive","label":"Colors","searchable":"1","create_rule":"2"}}]]></facets>
                 <max_values_per_facet>10</max_values_per_facet>
+                <enable_dynamic_facets>0</enable_dynamic_facets>
             </instant_facets>
             <instant_sorts>
                 <sorts><![CDATA[{"_4581608784535_789":{"attribute":"price","sort":"asc","sortLabel":"Lowest price"},"_2541555584535_585":{"attribute":"price","sort":"desc","sortLabel":"Highest price"},"_5581608784535_898":{"attribute":"created_at","sort":"desc","sortLabel":"Newest first"}}]]></sorts>

view/adminhtml/web/js/config.js

@@ -11,7 +11,8 @@ require(
 			// rows
 			const rowIds = [
 				'#row_algoliasearch_instant_instant_facets_facets',
-				'#row_algoliasearch_instant_instant_facets_max_values_per_facet'
+				'#row_algoliasearch_instant_instant_facets_max_values_per_facet',
+				'#row_algoliasearch_instant_instant_facets_enable_dynamic_facets'
 			];
 
 			let rowWarning = '<div class="algolia_dashboard_warning">';