CIF-2461: refactored specific page logic to use new parameter objects (#776)

* refactored specific page logic to not mess with selectors anymore

* fix formatting

* improve coverage of SpecificPageStrategy

* make SpecificPageFilter work with CatalogPageNotFoundFilter

* fix issues caused by differences of parsable parameters from format parameters

* prevent params copy when deep linking is disabled

* add coverage for the specific page filter when resource is not a page

* revert changes to NavigationImplTest

* CIF-2081: Implement specific PDP for product categories (#784)

* extract category url_key from product urls if possible

* use a CategoryUrlFormat.Params object to carry category infromation encoded in product urls

* implement specific product page selection by category

* add product url formats that encode category url_key

* CIF-2503: category context aware product urls (#785)

* add selection of url_rewrite from category context to ProductPageWithSkuAndUrlPath

* implement prefix and partial matching of category context
* retain the category information form the url if not given otherwise
* score either the contextUrlPath and contextUrlKey

* set the category context to product urls for product list / search component

* fix examples/bundle tests

* format code

* make breadcrumb context aware

* make the context aware product urls configureable

* fix tests

* set category context before selecting specific product page

* do not copy ref to immutable objects

* update TODO comments with the jira issue

* fix category aware urls in search result

* fix tests

Co-authored-by: Mark J. Becker <herzog31@users.noreply.github.com>

Author: buuhuu

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/internal/models/v1/breadcrumb/BreadcrumbImpl.java

@@ -21,6 +21,7 @@
 import java.util.Comparator;
 import java.util.List;
 import java.util.function.Function;
+import java.util.stream.Collectors;
 
 import javax.annotation.PostConstruct;
 
@@ -39,9 +40,11 @@
 
 import com.adobe.cq.commerce.core.components.client.MagentoGraphqlClient;
 import com.adobe.cq.commerce.core.components.internal.datalayer.DataLayerComponent;
+import com.adobe.cq.commerce.core.components.internal.services.urlformats.UrlFormatBase;
 import com.adobe.cq.commerce.core.components.models.breadcrumb.Breadcrumb;
 import com.adobe.cq.commerce.core.components.models.navigation.Navigation;
 import com.adobe.cq.commerce.core.components.services.urls.CategoryUrlFormat;
+import com.adobe.cq.commerce.core.components.services.urls.ProductUrlFormat;
 import com.adobe.cq.commerce.core.components.services.urls.UrlProvider;
 import com.adobe.cq.commerce.core.components.utils.SiteNavigation;
 import com.adobe.cq.commerce.magento.graphql.CategoryInterface;
@@ -132,7 +135,8 @@ private void populateItems(NavigationItem item) {
                 if (StringUtils.isEmpty(productSku)) {
                     return;
                 }
-                categoriesBreadcrumbs = fetchProductBreadcrumbs(productSku, magentoGraphqlClient);
+                ProductUrlFormat.Params urlParmas = urlProvider.parseProductUrlFormatParameters(request);
+                categoriesBreadcrumbs = fetchProductBreadcrumbs(productSku, urlParmas, magentoGraphqlClient);
             } else if (isCategoryPage) {
                 String categoryUid = urlProvider.getCategoryIdentifier(request);
                 if (StringUtils.isEmpty(categoryUid)) {
@@ -221,11 +225,20 @@ public Comparator<CategoryInterface> getCategoryInterfaceComparator() {
             .reversed();
     }
 
-    private List<? extends CategoryInterface> fetchProductBreadcrumbs(String productSku, MagentoGraphqlClient magentoGraphqlClient) {
+    private List<? extends CategoryInterface> fetchProductBreadcrumbs(String productSku, ProductUrlFormat.Params urlParams,
+        MagentoGraphqlClient magentoGraphqlClient) {
         retriever = new BreadcrumbRetriever(magentoGraphqlClient);
         retriever.setProductIdentifier(productSku);
 
-        return retriever.fetchCategoriesBreadcrumbs();
+        List<? extends CategoryInterface> categories = retriever.fetchCategoriesBreadcrumbs();
+        List<String> alternatives = categories.stream().map(CategoryInterface::getUrlPath).collect(Collectors.toList());
+        String contextUrlPath = UrlFormatBase.selectUrlPath(null, alternatives, null, urlParams.getCategoryUrlParams().getUrlKey(),
+            urlParams.getCategoryUrlParams().getUrlPath());
+
+        // include only categories that are ancestors or descendants of the contextUrlPath
+        return categories.stream()
+            .filter(category -> contextUrlPath.startsWith(category.getUrlPath() + "/") || contextUrlPath.equals(category.getUrlPath()))
+            .collect(Collectors.toList());
     }
 
     private List<? extends CategoryInterface> fetchCategoryBreadcrumbs(String categoryUid, MagentoGraphqlClient magentoGraphqlClient) {

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/internal/models/v1/common/ProductListItemImpl.java

@@ -17,6 +17,7 @@
 
 import java.util.List;
 import java.util.Objects;
+import java.util.function.Function;
 
 import javax.annotation.Nullable;
 
@@ -30,6 +31,7 @@
 import com.adobe.cq.commerce.core.components.models.common.ProductListItem;
 import com.adobe.cq.commerce.core.components.services.urls.ProductUrlFormat;
 import com.adobe.cq.commerce.core.components.services.urls.UrlProvider;
+import com.adobe.cq.commerce.magento.graphql.CategoryInterface;
 import com.adobe.cq.commerce.magento.graphql.GroupedProduct;
 import com.adobe.cq.commerce.magento.graphql.ProductImage;
 import com.adobe.cq.commerce.magento.graphql.ProductInterface;
@@ -58,10 +60,12 @@ public class ProductListItemImpl extends DataLayerListItem implements ProductLis
     private CommerceIdentifier identifier;
     private Boolean isStaged;
     private ProductInterface product;
+    private CategoryInterface categoryContext;
 
     private ProductListItemImpl(ProductInterface product, String sku, String urlKey, String urlPath, List<UrlRewrite> urlRewrites,
                                 String name, Price price, String imageURL, String imageAlt, Page productPage, String activeVariantSku,
-                                SlingHttpServletRequest request, UrlProvider urlProvider, String parentId, Boolean isStaged) {
+                                SlingHttpServletRequest request, UrlProvider urlProvider, String parentId, Boolean isStaged,
+                                CategoryInterface categoryContext) {
         super(parentId, productPage.getContentResource());
         this.product = product;
         this.sku = sku;
@@ -80,6 +84,7 @@ private ProductListItemImpl(ProductInterface product, String sku, String urlKey,
         this.identifier = activeVariantSku != null
             ? new CommerceIdentifierImpl(activeVariantSku, CommerceIdentifier.IdentifierType.SKU, CommerceIdentifier.EntityType.PRODUCT)
             : new CommerceIdentifierImpl(sku, CommerceIdentifier.IdentifierType.SKU, CommerceIdentifier.EntityType.PRODUCT);
+        this.categoryContext = categoryContext;
     }
 
     @Deprecated
@@ -137,6 +142,11 @@ public String getURL() {
         params.setUrlPath(urlPath);
         params.setUrlRewrites(urlRewrites);
 
+        if (categoryContext != null) {
+            params.getCategoryUrlParams().setUrlKey(categoryContext.getUrlKey());
+            params.getCategoryUrlParams().setUrlPath(categoryContext.getUrlPath());
+        }
+
         return urlProvider.toProductUrl(request, productPage, params);
     }
 
@@ -225,6 +235,7 @@ public static class Builder {
         private String name;
         private String urlPath;
         private List<UrlRewrite> urlRewrites;
+        private CategoryInterface categoryContext;
 
         public Builder(String parentId, @NotNull Page productPage, SlingHttpServletRequest request, UrlProvider urlProvider) {
             this.parentId = parentId;
@@ -278,22 +289,42 @@ public Builder price(Price price) {
             return this;
         }
 
+        /**
+         * Sets the category as context for the product item. This will case the {@link UrlProvider} to generate product urls in the context
+         * of this category if applicable.
+         *
+         * @param category
+         * @return
+         */
+        public Builder categoryContext(CategoryInterface category) {
+            this.categoryContext = category;
+            return this;
+        }
+
         public ProductListItem build() {
-            String sku = this.sku == null && product != null ? product.getSku() : this.sku;
-            String urlKey = this.urlKey == null && product != null ? product.getUrlKey() : this.urlKey;
-            String urlPath = this.urlPath == null && product != null ? product.getUrlPath() : this.urlPath;
-            List<UrlRewrite> urlRewrites = this.urlRewrites == null && product != null ? product.getUrlRewrites() : this.urlRewrites;
-            String name = this.name == null && product != null ? product.getName() : this.name;
-            Price price = this.price == null && product != null
-                ? new PriceImpl(product.getPriceRange(), productPage.getLanguage(false), product instanceof GroupedProduct)
-                : this.price;
-            ProductImage image = this.image == null && product != null ? product.getSmallImage() : this.image;
+            String sku = getFromProductIfNull(this.sku, product, ProductInterface::getSku);
+            String urlKey = getFromProductIfNull(this.urlKey, product, ProductInterface::getUrlKey);
+            String urlPath = getFromProductIfNull(this.urlPath, product, ProductInterface::getUrlPath);
+            List<UrlRewrite> urlRewrites = getFromProductIfNull(this.urlRewrites, product, ProductInterface::getUrlRewrites);
+            String name = getFromProductIfNull(this.name, product, ProductInterface::getName);
+            // TODO: target to be refactored with 3.0 (CIF-2634)
+            // The price is required, either set by the builder or as a price range of the product. Some code expects the exception being
+            // thrown by PriceImpl when the price range is null, for example the ProductCarouselImpl (validated by unit tests). However
+            // Exceptions must not be used for control flow, meaning this implementation should return null if the price is really required
+            // or, if not the impl should deal with null prices.
+            Price price = getFromProductIfNull(this.price, product,
+                p -> new PriceImpl(p.getPriceRange(), productPage.getLanguage(false), p instanceof GroupedProduct));
+            ProductImage image = getFromProductIfNull(this.image, product, ProductInterface::getSmallImage);
             String imageUrl = image != null ? image.getUrl() : null;
             String imageLabel = image != null ? StringUtils.defaultIfBlank(image.getLabel(), name) : null;
             boolean isStaged = product != null && Boolean.TRUE.equals(product.getStaged());
 
             return new ProductListItemImpl(product, sku, urlKey, urlPath, urlRewrites, name, price, imageUrl, imageLabel, productPage,
-                variantSku, request, urlProvider, parentId, isStaged);
+                variantSku, request, urlProvider, parentId, isStaged, categoryContext);
         }
     }
+
+    private static <T> T getFromProductIfNull(T value, ProductInterface product, Function<ProductInterface, T> getter) {
+        return value == null && product != null ? getter.apply(product) : value;
+    }
 }

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/internal/models/v1/productlist/ProductListImpl.java

@@ -159,11 +159,6 @@ public boolean showTitle() {
         return showTitle;
     }
 
-    // Not OSGi exported but public so UrlProviderImpl can use it
-    public String getUrlPath() {
-        return getCategory() != null ? getCategory().getUrlPath() : null;
-    }
-
     @Override
     public String getImage() {
         if (getCategory() != null) {
@@ -185,8 +180,10 @@ public boolean showImage() {
     @Override
     public Collection<ProductListItem> getProducts() {
         if (usePlaceholderData) {
-            CategoryProducts categoryProducts = getCategory().getProducts();
-            ProductToProductListItemConverter converter = new ProductToProductListItemConverter(productPage, request, urlProvider, getId());
+            CategoryInterface category = getCategory();
+            CategoryProducts categoryProducts = category.getProducts();
+            ProductToProductListItemConverter converter = new ProductToProductListItemConverter(productPage, request, urlProvider, getId(),
+                category);
             return categoryProducts.getItems().stream()
                 .map(converter)
                 .filter(Objects::nonNull) // the converter returns null if the conversion fails

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/internal/services/CategoryUrlParameterRetriever.java

@@ -20,16 +20,16 @@
 import com.adobe.cq.commerce.magento.graphql.CategoryTreeQuery;
 import com.adobe.cq.commerce.magento.graphql.CategoryTreeQueryDefinition;
 
-class CategoryUrlParameterRetriever extends AbstractCategoryRetriever {
+public class CategoryUrlParameterRetriever extends AbstractCategoryRetriever {
 
-    CategoryUrlParameterRetriever(MagentoGraphqlClient client) {
+    public CategoryUrlParameterRetriever(MagentoGraphqlClient client) {
         super(client);
     }
 
     @Override
     protected CategoryTreeQueryDefinition generateCategoryQuery() {
         return (CategoryTreeQuery q) -> {
-            q.urlPath().urlKey();
+            q.uid().urlPath().urlKey();
 
             if (categoryQueryHook != null) {
                 categoryQueryHook.accept(q);