CIF-2686 - Filter by category in product list component UI (#921)

LSantha · web-flow · commit ede79c013ce9 · 2022-06-10T15:06:00.000+02:00
* CIF-2686 - Filter by category in product list component UI

 * enabled category filter for product list, only direct child categories are included
 * updated unit tests

* CIF-2686 - Filter by category in product list component UI

 * addressing code review: better support for custom aggregation options

* CIF-2686 - Filter by category in product list component UI

 * small fixes
diff --git a/bundles/core/src/main/java/com/adobe/cq/commerce/core/components/internal/models/v1/productlist/CategoryRetriever.java b/bundles/core/src/main/java/com/adobe/cq/commerce/core/components/internal/models/v1/productlist/CategoryRetriever.java
@@ -38,7 +38,8 @@ protected CategoryTreeQueryDefinition generateCategoryQuery() {
                 .metaKeywords()
                 .metaTitle()
                 .urlKey()
-                .urlPath();
+                .urlPath()
+                .children(cq -> cq.id().uid().urlKey().urlPath());
 
             if (categoryQueryHook != null) {
                 categoryQueryHook.accept(q);
diff --git a/bundles/core/src/main/java/com/adobe/cq/commerce/core/components/internal/models/v1/productlist/ProductListImpl.java b/bundles/core/src/main/java/com/adobe/cq/commerce/core/components/internal/models/v1/productlist/ProductListImpl.java
@@ -18,9 +18,11 @@
 import java.io.IOException;
 import java.util.Collection;
 import java.util.Collections;
+import java.util.List;
 import java.util.Locale;
 import java.util.Map;
 import java.util.Objects;
+import java.util.Optional;
 import java.util.function.Consumer;
 import java.util.stream.Collectors;
 
@@ -52,12 +54,16 @@
 import com.adobe.cq.commerce.core.components.storefrontcontext.CategoryStorefrontContext;
 import com.adobe.cq.commerce.core.components.utils.SiteNavigation;
 import com.adobe.cq.commerce.core.search.internal.converters.ProductToProductListItemConverter;
+import com.adobe.cq.commerce.core.search.internal.models.SearchAggregationOptionImpl;
 import com.adobe.cq.commerce.core.search.internal.models.SearchOptionsImpl;
 import com.adobe.cq.commerce.core.search.internal.models.SearchResultsSetImpl;
+import com.adobe.cq.commerce.core.search.models.SearchAggregation;
+import com.adobe.cq.commerce.core.search.models.SearchAggregationOption;
 import com.adobe.cq.commerce.core.search.models.SearchResultsSet;
 import com.adobe.cq.commerce.core.search.models.Sorter;
 import com.adobe.cq.commerce.magento.graphql.CategoryInterface;
 import com.adobe.cq.commerce.magento.graphql.CategoryProducts;
+import com.adobe.cq.commerce.magento.graphql.CategoryTree;
 import com.adobe.cq.commerce.magento.graphql.ProductInterfaceQuery;
 import com.adobe.cq.sightly.SightlyWCMMode;
 import com.day.cq.wcm.api.Page;
@@ -76,6 +82,7 @@ public class ProductListImpl extends ProductCollectionImpl implements ProductLis
     private static final boolean SHOW_TITLE_DEFAULT = true;
     private static final boolean SHOW_IMAGE_DEFAULT = true;
     private static final String CATEGORY_PROPERTY = "category";
+    static final String CATEGORY_AGGREGATION_ID = "category_id";
 
     private boolean showTitle;
     private boolean showImage;
@@ -160,8 +167,7 @@ protected void initModel() {
     @Nullable
     @Override
     public String getTitle() {
-        return getCategory() != null ? getCategory().getName()
-            : StringUtils.EMPTY;
+        return getCategory() != null ? getCategory().getName() : StringUtils.EMPTY;
     }
 
     @Override
@@ -209,15 +215,66 @@ public SearchResultsSet getSearchResultsSet() {
         if (searchResultsSet == null) {
             searchResultsSet = getCategorySearchResultsSet().getRight();
 
-            ((SearchResultsSetImpl) searchResultsSet).setSearchAggregations(
-                searchResultsSet.getSearchAggregations()
-                    .stream()
-                    .filter(searchAggregation -> !SearchOptionsImpl.CATEGORY_UID_PARAMETER_ID.equals(searchAggregation.getIdentifier()))
-                    .collect(Collectors.toList()));
+            List<SearchAggregation> searchAggregations = searchResultsSet.getSearchAggregations()
+                .stream()
+                .filter(searchAggregation -> !SearchOptionsImpl.CATEGORY_UID_PARAMETER_ID.equals(searchAggregation.getIdentifier()))
+                .collect(Collectors.toList());
+
+            CategoryTree categoryTree = (CategoryTree) getCategorySearchResultsSet().getLeft();
+            processCategoryAggregation(searchAggregations, categoryTree);
+
+            ((SearchResultsSetImpl) searchResultsSet).setSearchAggregations(searchAggregations);
         }
         return searchResultsSet;
     }
 
+    private void processCategoryAggregation(List<SearchAggregation> searchAggregations, CategoryTree categoryTree) {
+        if (categoryTree != null && categoryTree.getChildren() != null) {
+            List<CategoryTree> childCategories = categoryTree.getChildren();
+            searchAggregations.stream().filter(aggregation -> CATEGORY_AGGREGATION_ID.equals(aggregation.getIdentifier())).findAny()
+                .ifPresent(categoryAggregation -> {
+                    List<SearchAggregationOption> options = categoryAggregation.getOptions();
+
+                    // find and process category aggregation options related to child categories of current category
+                    List<SearchAggregationOption> filteredOptions = options.stream().map(
+                        option -> option instanceof SearchAggregationOptionImpl ? (SearchAggregationOptionImpl) option
+                            : new SearchAggregationOptionImpl(option)).filter(option -> {
+                                Optional<CategoryTree> categoryRef = childCategories.stream().filter(c -> String.valueOf(c.getId()).equals(
+                                    option.getFilterValue())).findAny();
+
+                                if (categoryRef.isPresent()) {
+                                    CategoryTree category = categoryRef.get();
+                                    CategoryUrlFormat.Params params = new CategoryUrlFormat.Params();
+                                    params.setUid(category.getUid().toString());
+                                    params.setUrlKey(category.getUrlKey());
+                                    params.setUrlPath(category.getUrlPath());
+                                    option.setPageUrl(urlProvider.toCategoryUrl(request, currentPage, params));
+                                    option.getAddFilterMap().remove(CATEGORY_AGGREGATION_ID);
+                                    return true;
+                                } else {
+                                    return false;
+                                }
+                            }).collect(Collectors.toList());
+
+                    // keep filtered options only or remove category aggregation if no option was found
+                    if (filteredOptions.isEmpty()) {
+                        searchAggregations.removeIf(a -> CATEGORY_AGGREGATION_ID.equals(a.getIdentifier()));
+                    } else {
+                        options.clear();
+                        options.addAll(filteredOptions);
+                        // move category aggregation to front
+                        searchAggregations.stream().filter(a -> CATEGORY_AGGREGATION_ID.equals(a.getIdentifier())).findAny().ifPresent(
+                            aggregation -> {
+                                searchAggregations.remove(aggregation);
+                                searchAggregations.add(0, aggregation);
+                            });
+                    }
+                });
+        } else {
+            searchAggregations.removeIf(a -> CATEGORY_AGGREGATION_ID.equals(a.getIdentifier()));
+        }
+    }
+
     private Pair<CategoryInterface, SearchResultsSet> getCategorySearchResultsSet() {
         if (categorySearchResultsSet == null) {
             Consumer<ProductInterfaceQuery> productQueryHook = categoryRetriever != null ? categoryRetriever.getProductQueryHook() : null;
diff --git a/bundles/core/src/main/java/com/adobe/cq/commerce/core/search/internal/models/SearchAggregationOptionImpl.java b/bundles/core/src/main/java/com/adobe/cq/commerce/core/search/internal/models/SearchAggregationOptionImpl.java
@@ -30,6 +30,17 @@ public class SearchAggregationOptionImpl implements SearchAggregationOption {
     private String displayLabel;
     private int count;
     private Map<String, String> addFilterMap;
+    private String pageUrl;
+
+    public SearchAggregationOptionImpl() {}
+
+    public SearchAggregationOptionImpl(SearchAggregationOption that) {
+        this.filterValue = that.getFilterValue();
+        this.displayLabel = that.getDisplayLabel();
+        this.count = that.getCount();
+        this.addFilterMap = that.getAddFilterMap();
+        this.pageUrl = that.getPageUrl();
+    }
 
     @Nonnull
     @Override
@@ -55,6 +66,15 @@ public Map<String, String> getAddFilterMap() {
         return addFilterMap;
     }
 
+    @Override
+    public String getPageUrl() {
+        return pageUrl;
+    }
+
+    public void setPageUrl(String pageUrl) {
+        this.pageUrl = pageUrl;
+    }
+
     public void setFilterValue(final String filterValue) {
         this.filterValue = filterValue;
     }
@@ -70,4 +90,5 @@ public void setCount(final int count) {
     public void setAddFilterMap(final Map<String, String> addFilterMap) {
         this.addFilterMap = addFilterMap;
     }
+
 }
diff --git a/bundles/core/src/main/java/com/adobe/cq/commerce/core/search/internal/services/SearchResultsServiceImpl.java b/bundles/core/src/main/java/com/adobe/cq/commerce/core/search/internal/services/SearchResultsServiceImpl.java
@@ -207,7 +207,6 @@ public Pair<QueryQuery.CategoryListArgumentsDefinition, CategoryTreeQueryDefinit
             mutableSearchOptions.getAllFilters(), availableFilters);
 
         // special handling of category identifier(s)
-        removeCategoryIdAggregationIfNecessary(searchAggregations, mutableSearchOptions);
         removeCategoryUidFilterEntriesIfPossible(searchAggregations, request);
 
         searchResultsSet.setTotalResults(products.getTotalCount());
@@ -508,20 +507,6 @@ private List<SearchAggregation> extractSearchAggregationsFromResponse(
             .collect(Collectors.toList());
     }
 
-    /**
-     * Removes the category_id filter from the search aggregations when category_uid filter is present because either cannot be combined
-     * with the other.
-     *
-     * @param aggs
-     * @param searchOptions
-     */
-    private void removeCategoryIdAggregationIfNecessary(List<SearchAggregation> aggs, SearchOptionsImpl searchOptions) {
-        // Special treatment for category_id filter as this is always present and collides with category_uid filter (CIF-2206)
-        if (searchOptions.getCategoryUid().isPresent()) {
-            aggs.removeIf(agg -> CATEGORY_ID_FILTER.equals(agg.getIdentifier()));
-        }
-    }
-
     /**
      * Removes the category_uid filter from all filter options' filter maps when the category uid can be retrieved from the request already.
      *
diff --git a/bundles/core/src/main/java/com/adobe/cq/commerce/core/search/models/SearchAggregationOption.java b/bundles/core/src/main/java/com/adobe/cq/commerce/core/search/models/SearchAggregationOption.java
@@ -59,4 +59,13 @@ public interface SearchAggregationOption {
     @Nonnull
     Map<String, String> getAddFilterMap();
 
+    /**
+     * Get the page URL for this aggregation option.
+     *
+     * @return page url
+     */
+    default String getPageUrl() {
+        return null;
+    }
+
 }
diff --git a/bundles/core/src/main/java/com/adobe/cq/commerce/core/search/models/package-info.java b/bundles/core/src/main/java/com/adobe/cq/commerce/core/search/models/package-info.java
@@ -13,7 +13,7 @@
  ~ See the License for the specific language governing permissions and
  ~ limitations under the License.
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
-@Version("3.1.0")
+@Version("3.2.0")
 package com.adobe.cq.commerce.core.search.models;
 
 import org.osgi.annotation.versioning.Version;
diff --git a/bundles/core/src/test/java/com/adobe/cq/commerce/core/components/internal/models/v1/productlist/ProductListImplTest.java b/bundles/core/src/test/java/com/adobe/cq/commerce/core/components/internal/models/v1/productlist/ProductListImplTest.java
@@ -16,15 +16,18 @@
 package com.adobe.cq.commerce.core.components.internal.models.v1.productlist;
 
 import java.io.IOException;
+import java.lang.reflect.Proxy;
 import java.text.NumberFormat;
 import java.util.Collection;
 import java.util.Currency;
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;
 import java.util.Optional;
+import java.util.function.Consumer;
 import java.util.stream.Collectors;
 
+import org.apache.commons.lang3.tuple.Pair;
 import org.apache.http.HttpStatus;
 import org.apache.http.impl.client.CloseableHttpClient;
 import org.apache.http.osgi.services.HttpClientBuilderFactory;
@@ -58,17 +61,22 @@
 import com.adobe.cq.commerce.core.search.internal.services.SearchFilterServiceImpl;
 import com.adobe.cq.commerce.core.search.internal.services.SearchResultsServiceImpl;
 import com.adobe.cq.commerce.core.search.models.SearchAggregation;
+import com.adobe.cq.commerce.core.search.models.SearchAggregationOption;
+import com.adobe.cq.commerce.core.search.models.SearchOptions;
 import com.adobe.cq.commerce.core.search.models.SearchResultsSet;
 import com.adobe.cq.commerce.core.search.models.Sorter;
 import com.adobe.cq.commerce.core.search.models.SorterKey;
+import com.adobe.cq.commerce.core.search.services.SearchResultsService;
 import com.adobe.cq.commerce.core.testing.Utils;
 import com.adobe.cq.commerce.graphql.client.GraphqlClient;
 import com.adobe.cq.commerce.graphql.client.GraphqlRequest;
 import com.adobe.cq.commerce.graphql.client.impl.GraphqlClientImpl;
+import com.adobe.cq.commerce.magento.graphql.CategoryInterface;
 import com.adobe.cq.commerce.magento.graphql.CategoryTree;
 import com.adobe.cq.commerce.magento.graphql.GroupedProduct;
 import com.adobe.cq.commerce.magento.graphql.ProductImage;
 import com.adobe.cq.commerce.magento.graphql.ProductInterface;
+import com.adobe.cq.commerce.magento.graphql.ProductInterfaceQuery;
 import com.adobe.cq.commerce.magento.graphql.Products;
 import com.adobe.cq.commerce.magento.graphql.Query;
 import com.adobe.cq.commerce.magento.graphql.gson.QueryDeserializer;
@@ -305,12 +313,103 @@ public void getProducts() {
 
         SearchResultsSet searchResultsSet = productListModel.getSearchResultsSet();
         List<SearchAggregation> searchAggregations = searchResultsSet.getSearchAggregations();
-        Assert.assertEquals(7, searchAggregations.size());
+        Assert.assertEquals(8, searchAggregations.size());
 
-        // We want to make sure the category_id aggregation is not present
-        Optional<SearchAggregation> categoryIdAggregation = searchAggregations.stream().filter(a -> a.getIdentifier().equals("category_id"))
+        // check category aggregation
+        Optional<SearchAggregation> categoryIdAggregation = searchAggregations.stream().filter(a -> a.getIdentifier().equals(
+            ProductListImpl.CATEGORY_AGGREGATION_ID))
             .findAny();
-        Assert.assertFalse(categoryIdAggregation.isPresent());
+        Assert.assertTrue(categoryIdAggregation.isPresent());
+        List<SearchAggregationOption> options = categoryIdAggregation.get().getOptions();
+        Assert.assertEquals(2, options.size());
+
+        SearchAggregationOption opt = options.get(0);
+        Assert.assertEquals("3", opt.getFilterValue());
+        Assert.assertEquals("Gear", opt.getDisplayLabel());
+        Assert.assertEquals("/content/pageA.html/running/gear.html", opt.getPageUrl());
+
+        opt = options.get(1);
+        Assert.assertEquals("4", opt.getFilterValue());
+        Assert.assertEquals("Bags", opt.getDisplayLabel());
+        Assert.assertEquals("/content/pageA.html/running/bags.html", opt.getPageUrl());
+
+        // We want to make sure all price ranges are properly processed
+        SearchAggregation priceAggregation = searchAggregations.stream().filter(a -> a.getIdentifier().equals("price")).findFirst().get();
+        Assert.assertEquals(3, priceAggregation.getOptions().size());
+        Assert.assertEquals(3, priceAggregation.getOptionCount());
+        Assert.assertTrue(priceAggregation.getOptions().stream().anyMatch(o -> o.getDisplayLabel().equals("30-40")));
+        Assert.assertTrue(priceAggregation.getOptions().stream().anyMatch(o -> o.getDisplayLabel().equals("40-*")));
+        Assert.assertTrue(priceAggregation.getOptions().stream().anyMatch(o -> o.getDisplayLabel().equals("14")));
+    }
+
+    // custom marker interface for search aggregation options
+    private interface MySearchAggregationOption {};
+
+    @Test
+    public void getProductsWithCustomAggregationOptions() {
+        adaptToProductList();
+
+        // inject custom search results service which returns custom search aggregation objects
+        SearchResultsService searchResultsService = (SearchResultsService) Whitebox.getInternalState(productListModel,
+            "searchResultsService");
+        ClassLoader classLoader = getClass().getClassLoader();
+        Whitebox.setInternalState(productListModel, "searchResultsService", Proxy.newProxyInstance(classLoader,
+            new Class[] { SearchResultsService.class }, (proxy, method, args) -> {
+                if (method.getName().equals("performSearch") && method.getParameterCount() == 6) {
+                    Pair<CategoryInterface, SearchResultsSet> pair = searchResultsService.performSearch(
+                        (SearchOptions) args[0],
+                        (Resource) args[1],
+                        (Page) args[2],
+                        (SlingHttpServletRequest) args[3],
+                        (Consumer<ProductInterfaceQuery>) args[4],
+                        (AbstractCategoryRetriever) args[5]);
+
+                    Class[] optionInterfaces = { SearchAggregationOption.class, MySearchAggregationOption.class };
+                    for (SearchAggregation aggregation : pair.getRight().getSearchAggregations()) {
+                        List<SearchAggregationOption> options = aggregation.getOptions();
+                        List<SearchAggregationOption> myOptions = options.stream().map(
+                            o -> (SearchAggregationOption) Proxy.newProxyInstance(classLoader, optionInterfaces,
+                                (oProxy, oMethod, oArgs) -> oMethod.invoke(o, oArgs))).collect(Collectors.toList());
+                        options.clear();
+                        options.addAll(myOptions);
+                    }
+
+                    return pair;
+                } else {
+                    return method.invoke(searchResultsService, args);
+                }
+            }));
+
+        Collection<ProductListItem> products = productListModel.getProducts();
+        Assert.assertNotNull(products);
+
+        // We introduce one "faulty" product data in the response, it should be skipped
+        Assert.assertEquals(4, products.size());
+
+        SearchResultsSet searchResultsSet = productListModel.getSearchResultsSet();
+        List<SearchAggregation> searchAggregations = searchResultsSet.getSearchAggregations();
+        Assert.assertEquals(8, searchAggregations.size());
+
+        // check category aggregation
+        Optional<SearchAggregation> categoryIdAggregation = searchAggregations.stream().filter(a -> a.getIdentifier().equals(
+            ProductListImpl.CATEGORY_AGGREGATION_ID))
+            .findAny();
+        Assert.assertTrue(categoryIdAggregation.isPresent());
+        List<SearchAggregationOption> options = categoryIdAggregation.get().getOptions();
+        Assert.assertEquals(2, options.size());
+
+        SearchAggregationOption opt = options.get(0);
+        // for category aggregation custom options are replaced
+        Assert.assertFalse(opt instanceof MySearchAggregationOption);
+        Assert.assertEquals("3", opt.getFilterValue());
+        Assert.assertEquals("Gear", opt.getDisplayLabel());
+        Assert.assertEquals("/content/pageA.html/running/gear.html", opt.getPageUrl());
+
+        opt = options.get(1);
+        Assert.assertFalse(opt instanceof MySearchAggregationOption);
+        Assert.assertEquals("4", opt.getFilterValue());
+        Assert.assertEquals("Bags", opt.getDisplayLabel());
+        Assert.assertEquals("/content/pageA.html/running/bags.html", opt.getPageUrl());
 
         // We want to make sure all price ranges are properly processed
         SearchAggregation priceAggregation = searchAggregations.stream().filter(a -> a.getIdentifier().equals("price")).findFirst().get();
@@ -319,6 +418,9 @@ public void getProducts() {
         Assert.assertTrue(priceAggregation.getOptions().stream().anyMatch(o -> o.getDisplayLabel().equals("30-40")));
         Assert.assertTrue(priceAggregation.getOptions().stream().anyMatch(o -> o.getDisplayLabel().equals("40-*")));
         Assert.assertTrue(priceAggregation.getOptions().stream().anyMatch(o -> o.getDisplayLabel().equals("14")));
+
+        // for other aggregations custom options are preserved
+        Assert.assertTrue(priceAggregation.getOptions().get(0) instanceof MySearchAggregationOption);
     }
 
     @Test
diff --git a/bundles/core/src/test/java/com/adobe/cq/commerce/core/search/internal/services/SearchResultsServiceImplTest.java b/bundles/core/src/test/java/com/adobe/cq/commerce/core/search/internal/services/SearchResultsServiceImplTest.java
diff --git a/bundles/core/src/test/resources/graphql/magento-graphql-search-category-result-category.json b/bundles/core/src/test/resources/graphql/magento-graphql-search-category-result-category.json
diff --git a/ui.apps/src/main/content/jcr_root/apps/core/cif/components/commerce/productcollection/v2/productcollection/filters.html b/ui.apps/src/main/content/jcr_root/apps/core/cif/components/commerce/productcollection/v2/productcollection/filters.html
