MAGE-569 Feature flag category navigation for future enablement via custom renderer

Author: cammonro

Block/Configuration.php

@@ -9,6 +9,9 @@
 
 class Configuration extends Algolia implements CollectionDataSourceInterface
 {
+    //Placeholder for future implementation (requires customer renderer for hierarchicalMenu widget)
+    private const IS_CATEGORY_NAVIGATION_ENABLED = false;
+
     public function isSearchPage()
     {
         if ($this->getConfigHelper()->isInstantEnabled()) {
@@ -57,7 +60,7 @@ protected function getChildCategoryUrls(\Magento\Catalog\Model\Category $cat, st
         }
 
         foreach ($cat->getChildrenCategories() as $child) {
-            $key = $parent ? $parent . $this->getConfigHelper()->getCategorySeparator() . $child->getName() : $child ->getName();
+            $key = $parent ? $parent . $this->getConfigHelper()->getCategorySeparator($this->getStoreId()) . $child->getName() : $child ->getName();
             $arr[$key]['url'] = $child->getUrl();
             $arr = array_merge($arr, $this->getChildCategoryUrls($child, $key, $arr));
         }
@@ -123,7 +126,9 @@ public function getConfiguration()
 
             if ($category && $category->getDisplayMode() !== 'PAGE') {
                 $category->getUrlInstance()->setStore($this->getStoreId());
-                $childCategories = $this->getChildCategoryUrls($category);
+                if (self::IS_CATEGORY_NAVIGATION_ENABLED) {
+                    $childCategories = $this->getChildCategoryUrls($category);
+                }
 
                 $categoryId = $category->getId();
 
@@ -180,7 +185,6 @@ public function getConfiguration()
         }
 
         $attributesToFilter = $config->getAttributesToFilter($customerGroupId);
-
         $algoliaJsConfig = [
             'instant' => [
                 'enabled' => $config->isInstantEnabled(),
@@ -192,7 +196,8 @@ public function getConfiguration()
                 'isSearchBoxEnabled' => $config->isInstantSearchBoxEnabled(),
                 'isVisualMerchEnabled' => $config->isVisualMerchEnabled(),
                 'categorySeparator' => $config->getCategorySeparator(),
-                'categoryPageIdAttribute' => $config->getCategoryPageIdAttributeName()
+                'categoryPageIdAttribute' => $config->getCategoryPageIdAttributeName(),
+                'isCategoryNavigationEnabled' => self::IS_CATEGORY_NAVIGATION_ENABLED
             ],
             'autocomplete' => [
                 'enabled' => $config->isAutoCompleteEnabled(),

view/frontend/web/instantsearch.js

@@ -258,6 +258,7 @@ requirejs(['algoliaBundle', 'Magento_Catalog/js/price-utils'], function (algolia
 			 **/
 			currentRefinements: {
 				container: '#current-refinements',
+                // TODO: Remove this - it does nothing
 				templates: {
 					item: $('#current-refinements-template').html()
 				},
@@ -464,12 +465,12 @@ requirejs(['algoliaBundle', 'Magento_Catalog/js/price-utils'], function (algolia
                     transformItems(items) {
                         return (algoliaConfig.isCategoryPage)
                             ? findRoot(items).map(
+                                // TODO: Make recursive and implement custom renderer
                                 item => {
-                                    if (true) {
-                                        item.categoryUrl = algoliaConfig.request.childCategories[item.value]['url'];
-                                    }
-                                    console.log('item:', item);
-                                    return item;
+                                    return {
+                                        ...item,
+                                        categoryUrl: algoliaConfig.instant.isCategoryNavigationEnabled ? algoliaConfig.request.childCategories[item.value]['url'] : ''
+                                    };
                                 }
                             )
                             : items;