MAGE-975 Add configuration to enable dynamic facets (disabled by default)

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';
@@ -1328,6 +1330,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

etc/adminhtml/system.xml

@@ -434,6 +434,21 @@
                         ]]>
                     </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.
+                        ]]>
+                    </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/frontend/web/js/instantsearch.js

@@ -208,16 +208,20 @@ define([
 
             const configuredWidget = widget(config);
 
-            if (algoliaConfig.instant.isDynamicWidgetsEnabled ?? true) { //TODO: Implement this config
-                if (this.isDynamicWidgetsEligible(type)) {
-                    this.dynamicWidgets.push(configuredWidget);
-                    return;
-                }
+            if (algoliaConfig.instant.isDynamicFacetsEnabled && this.isDynamicFacetsEligible(type)) {
+                this.dynamicWidgets.push(configuredWidget);
+                return;
             }
 
             search.addWidgets([configuredWidget]);
         },
 
+        /**
+         * Assigns designated facets to InstantSearch dynamicWidgets
+         *
+         * Docs: https://www.algolia.com/doc/api-reference/widgets/dynamic-facets/js/
+         * @param search
+         */
         initializeDynamicWidgets(search) {
             const { dynamicWidgets } = instantsearch.widgets;
             search.addWidget(
@@ -235,7 +239,7 @@ define([
          * @param widgetType
          * @returns {boolean}
          */
-        isDynamicWidgetsEligible(widgetType) {
+        isDynamicFacetsEligible(widgetType) {
             return [
                 'refinementList',
                 'menu',
@@ -467,7 +471,7 @@ define([
         /**
          * Add all facet widgets to allWidgetConfiguration
          * This is dynamically driven by the Magento facet configuration
-         * Invokes facet builder function by attribute or type (where attribute builders take precendence)
+         * Invokes facet builder function by attribute or type (where attribute builders take precedence)
          * The builders are responsible for flushing out the widget configuration for each facet
          *
          * @param allWidgetConfiguration