SITES-22965: Add function to set category filter type

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/internal/models/v1/categorylist/FeaturedCategoryListImpl.java

@@ -47,6 +47,7 @@
 import com.adobe.cq.commerce.core.components.models.categorylist.FeaturedCategoryListItem;
 import com.adobe.cq.commerce.core.components.models.common.CommerceIdentifier;
 import com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoriesRetriever;
+import com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever;
 import com.adobe.cq.commerce.core.components.services.urls.CategoryUrlFormat;
 import com.adobe.cq.commerce.core.components.services.urls.UrlProvider;
 import com.adobe.cq.commerce.magento.graphql.CategoryTree;
@@ -106,6 +107,7 @@ private void initModel() {
         // After the identifier type has been determined, the specific list will be used further
         List<String> categoryIdentifiers = new ArrayList<>();
         assetOverride = new HashMap<>();
+        String categoryIdType = null;
 
         // Iterate entries of composite multifield
         Resource items = resource.getChild(ITEMS_PROP);
@@ -117,6 +119,8 @@ private void initModel() {
                 ValueMap props = item.getValueMap();
 
                 String categoryIdentifier = props.get(CATEGORY_IDENTIFIER, String.class);
+                categoryIdType = props.get(CATEGORY_IDENTIFIER_TYPE, String.class);
+
                 if (StringUtils.isEmpty(categoryIdentifier)) {
                     continue;
                 }
@@ -141,6 +145,9 @@ private void initModel() {
                 categoriesRetriever = new CategoriesRetriever(magentoGraphqlClient);
                 // Setting the identifiers list based on the determined identifier type
                 categoriesRetriever.setIdentifiers(categoryIdentifiers);
+                if (AbstractCategoryRetriever.CATEGORY_IDENTIFIER_URL_PATH.equals(categoryIdType)) {
+                    categoriesRetriever.setCategoryIdType(categoryIdType);
+                }
             }
         }
     }

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/internal/models/v2/button/ButtonImpl.java

@@ -37,6 +37,8 @@
 import org.apache.sling.models.factory.ModelFactory;
 
 import com.adobe.cq.commerce.core.components.client.MagentoGraphqlClient;
+import com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever;
+import com.adobe.cq.commerce.core.components.services.urls.CategoryUrlFormat;
 import com.adobe.cq.commerce.core.components.services.urls.UrlProvider;
 import com.adobe.cq.wcm.core.components.commons.link.Link;
 import com.adobe.cq.wcm.core.components.models.Button;
@@ -71,6 +73,8 @@ public class ButtonImpl implements Button {
     private String productIdentifier;
     @ValueMapValue(name = "categoryId", injectionStrategy = InjectionStrategy.OPTIONAL)
     private String categoryIdentifier;
+    @ValueMapValue(name = "categoryIdType", injectionStrategy = InjectionStrategy.OPTIONAL)
+    private String categoryIdType;
     @ValueMapValue(injectionStrategy = InjectionStrategy.OPTIONAL)
     private String externalLink;
     @ValueMapValue(injectionStrategy = InjectionStrategy.OPTIONAL)
@@ -100,7 +104,13 @@ private void initModel() {
         } else if (PRODUCT.equals(linkType) && productIdentifier != null) {
             link = urlProvider.toProductUrl(request, currentPage, productIdentifier);
         } else if (CATEGORY.equals(linkType) && categoryIdentifier != null) {
-            link = urlProvider.toCategoryUrl(request, currentPage, categoryIdentifier);
+            CategoryUrlFormat.Params params = new CategoryUrlFormat.Params();
+            if (AbstractCategoryRetriever.CATEGORY_IDENTIFIER_URL_PATH.equals(categoryIdType)) {
+                params.setUrlPath(categoryIdentifier);
+            } else {
+                params.setUid(categoryIdentifier);
+            }
+            link = urlProvider.formatCategoryUrl(request, currentPage, params);
         } else if (StringUtils.isNotEmpty(linkTo)) {
             link = linkTo + ".html";
         }

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/internal/models/v3/teaser/CommerceTeaserImpl.java

@@ -34,7 +34,9 @@
 
 import com.adobe.cq.commerce.core.components.internal.models.v1.common.CommerceIdentifierImpl;
 import com.adobe.cq.commerce.core.components.models.common.CommerceIdentifier;
+import com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever;
 import com.adobe.cq.commerce.core.components.models.teaser.CommerceTeaser;
+import com.adobe.cq.commerce.core.components.services.urls.CategoryUrlFormat;
 import com.adobe.cq.commerce.core.components.services.urls.UrlProvider;
 import com.adobe.cq.export.json.ComponentExporter;
 import com.adobe.cq.export.json.ExporterConstants;
@@ -90,16 +92,25 @@ void populateActions() {
             for (Resource action : configuredActions) {
                 ValueMap actionProperties = action.getValueMap();
                 String productSku = actionProperties.get(PN_ACTION_PRODUCT_SKU, String.class);
-                String categoryUid = actionProperties.get(PN_ACTION_CATEGORY_ID, String.class);
+                String categoryId = actionProperties.get(PN_ACTION_CATEGORY_ID, String.class);
+                String categoryIdType = actionProperties.get(PN_ACTION_CATEGORY_ID_TYPE, String.class);
                 String link = actionProperties.get(Teaser.PN_ACTION_LINK, String.class);
 
                 ListItem wcmAction = null;
                 String actionUrl;
                 CommerceIdentifier identifier = null;
 
-                if (StringUtils.isNotBlank(categoryUid)) {
-                    actionUrl = urlProvider.toCategoryUrl(request, currentPage, categoryUid);
-                    identifier = new CommerceIdentifierImpl(categoryUid, CommerceIdentifier.IdentifierType.UID,
+                if (StringUtils.isNotBlank(categoryId)) {
+                    CommerceIdentifier.IdentifierType identifierType = CommerceIdentifier.IdentifierType.UID;
+                    CategoryUrlFormat.Params params = new CategoryUrlFormat.Params();
+                    if (AbstractCategoryRetriever.CATEGORY_IDENTIFIER_URL_PATH.equals(categoryIdType)) {
+                        params.setUrlPath(categoryId);
+                        identifierType = CommerceIdentifier.IdentifierType.URL_PATH;
+                    } else {
+                        params.setUid(categoryId);
+                    }
+                    actionUrl = urlProvider.formatCategoryUrl(request, currentPage, params);
+                    identifier = new CommerceIdentifierImpl(categoryId, identifierType,
                         CommerceIdentifier.EntityType.CATEGORY);
                 } else if (StringUtils.isNotBlank(productSku)) {
                     actionUrl = urlProvider.toProductUrl(request, currentPage, productSku);

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

@@ -55,6 +55,7 @@
 import com.adobe.cq.commerce.core.components.internal.services.urlformats.ProductPageWithUrlKey;
 import com.adobe.cq.commerce.core.components.internal.services.urlformats.ProductPageWithUrlPath;
 import com.adobe.cq.commerce.core.components.models.common.SiteStructure;
+import com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever;
 import com.adobe.cq.commerce.core.components.services.ComponentsConfiguration;
 import com.adobe.cq.commerce.core.components.services.urls.CategoryUrlFormat;
 import com.adobe.cq.commerce.core.components.services.urls.GenericUrlFormat;
@@ -365,40 +366,120 @@ public String toCategoryUrl(SlingHttpServletRequest request, Page page, String c
         CategoryUrlFormat.Params params = new CategoryUrlFormat.Params();
         params.setUid(categoryIdentifier);
 
+        CategoryInterface category = callCategoryApi(request, categoryIdentifier, null);
+        if (category != null) {
+            params.setUrlKey(category.getUrlKey());
+            params.setUrlPath(category.getUrlPath());
+        }
+        return toCategoryUrl(request, page, params);
+    }
+
+    /**
+     * Call the category Api whenever required
+     *
+     * @param request The current Sling HTTP request
+     * @param categoryIdentifier The category identifier
+     * @return CategoryInterface
+     */
+    protected CategoryInterface callCategoryApi(
+        SlingHttpServletRequest request,
+        String categoryIdentifier,
+        String categoryIdType) {
+        CategoryInterface category = null;
         MagentoGraphqlClient magentoGraphqlClient = request != null ? request.adaptTo(MagentoGraphqlClient.class)
             : null;
         if (magentoGraphqlClient != null && StringUtils.isNotBlank(categoryIdentifier)) {
             CategoryUrlParameterRetriever retriever = new CategoryUrlParameterRetriever(magentoGraphqlClient);
             retriever.setIdentifier(categoryIdentifier);
-            CategoryInterface category = retriever.fetchCategory();
-            if (category != null) {
-                params.setUrlKey(category.getUrlKey());
-                params.setUrlPath(category.getUrlPath());
-            } else {
+            if (AbstractCategoryRetriever.CATEGORY_IDENTIFIER_URL_PATH.equals(categoryIdType)) {
+                retriever.setCategoryIdType(AbstractCategoryRetriever.CATEGORY_IDENTIFIER_URL_PATH);
+            }
+
+            category = retriever.fetchCategory();
+            if (category == null) {
                 LOGGER.debug("Could not generate category page URL for {}.", categoryIdentifier);
             }
         }
-        return toCategoryUrl(request, page, params);
+        return category;
+    }
+
+    /**
+     * Set the page parameter for the category URL format
+     *
+     * @param request The current Sling HTTP request
+     * @param categoryUrlFormat The current category URL format
+     * @param givenPage This parameter can be null if the URL template does set a
+     *            {{page}} parameter and a request is given.
+     * @param params The parameters used in the URL template.
+     * @return CategoryInterface
+     */
+    protected Pair<CategoryUrlFormat, CategoryUrlFormat.Params> getSpecificPageFormatAndParams(SlingHttpServletRequest request,
+        CategoryUrlFormat categoryUrlFormat, @Nullable Page givenPage, CategoryUrlFormat.Params params) {
+        SiteStructure siteStructure = siteStructureFactory.getSiteStructure(request, givenPage);
+        Pair<Page, CategoryUrlFormat> pair = getSpecificPageAndFormat(siteStructure, params,
+            this::getCategoryUrlFormatFromContext, specificPageStrategy::getGenericPage, specificPageStrategy::getSpecificPage);
+
+        if (pair != null) {
+            Page specificPage = pair.getLeft();
+            categoryUrlFormat = pair.getRight();
+
+            if (!specificPage.getPath().equals(params.getPage())) {
+                params = new CategoryUrlFormat.Params(params);
+                params.setPage(specificPage.getPath());
+            }
+        }
+        return Pair.of(categoryUrlFormat, params);
     }
 
     @Override
     public String toCategoryUrl(SlingHttpServletRequest request, @Nullable Page givenPage, CategoryUrlFormat.Params params) {
         CategoryUrlFormat categoryUrlFormat = getCategoryUrlFormatFromContext(request, givenPage);
+
         if (givenPage != null) {
-            SiteStructure siteStructure = siteStructureFactory.getSiteStructure(request, givenPage);
-            Pair<Page, CategoryUrlFormat> pair = getSpecificPageAndFormat(siteStructure, params,
-                this::getCategoryUrlFormatFromContext, specificPageStrategy::getGenericPage, specificPageStrategy::getSpecificPage);
+            Pair<CategoryUrlFormat, CategoryUrlFormat.Params> pair = getSpecificPageFormatAndParams(request, categoryUrlFormat, givenPage,
+                params);
+            categoryUrlFormat = pair.getLeft();
+            params = pair.getRight();
+        }
 
-            if (pair != null) {
-                Page specificPage = pair.getLeft();
-                categoryUrlFormat = pair.getRight();
+        return categoryUrlFormat.format(params);
+    }
 
-                if (!specificPage.getPath().equals(params.getPage())) {
-                    params = new CategoryUrlFormat.Params(params);
-                    params.setPage(specificPage.getPath());
+    @Override
+    public String formatCategoryUrl(SlingHttpServletRequest request, @Nullable Page givenPage, CategoryUrlFormat.Params params) {
+        CategoryUrlFormat categoryUrlFormat = getCategoryUrlFormatFromContext(request, givenPage);
+        String categoryIdentifier = StringUtils.isNotEmpty(params.getUid()) ? params.getUid() : params.getUrlKey();
+        boolean urlPathFlag = false;
+
+        // Checks all the required parameters for the category URL format
+        if (!categoryUrlFormat.validateRequiredParams(params)) {
+            // Ignore the urlKey checks as it is not unique
+            if (StringUtils.isNotEmpty(params.getUrlPath())) {
+                categoryIdentifier = params.getUrlPath();
+                urlPathFlag = true;
+            }
+
+            // Call the MagentoGraphqlClient to get the category details
+            CategoryInterface category = callCategoryApi(
+                request,
+                categoryIdentifier,
+                urlPathFlag ? AbstractCategoryRetriever.CATEGORY_IDENTIFIER_URL_PATH : null);
+            if (category != null) {
+                // Set the required parameters for the category URL format on the basis of the category details
+                if (urlPathFlag) {
+                    params.setUid(category.get("uid").toString());
+                } else {
+                    params.setUrlPath(category.getUrlPath());
                 }
+                params.setUrlKey(category.getUrlKey());
             }
         }
+        if (givenPage != null) {
+            Pair<CategoryUrlFormat, CategoryUrlFormat.Params> pair = getSpecificPageFormatAndParams(request, categoryUrlFormat, givenPage,
+                params);
+            categoryUrlFormat = pair.getLeft();
+            params = pair.getRight();
+        }
 
         return categoryUrlFormat.format(params);
     }

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

@@ -30,6 +30,11 @@ private CategoryPageWithUrlKey() {
         super();
     }
 
+    @Override
+    public boolean validateRequiredParams(Params parameters) {
+        return StringUtils.isNotEmpty(parameters.getUrlPath()) || StringUtils.isNotEmpty(parameters.getUrlKey());
+    }
+
     @Override
     public String format(Params parameters) {
         return StringUtils.defaultIfEmpty(parameters.getPage(), "{{page}}")

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

@@ -29,6 +29,11 @@ private CategoryPageWithUrlPath() {
         super();
     }
 
+    @Override
+    public boolean validateRequiredParams(Params parameters) {
+        return StringUtils.isNotEmpty(parameters.getUrlPath());
+    }
+
     @Override
     public String format(Params parameters) {
         String urlKey = StringUtils.defaultIfEmpty(parameters.getUrlKey(), "{{url_path}}");

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/models/categorylist/FeaturedCategoryList.java

@@ -29,6 +29,13 @@
 @ConsumerType
 public interface FeaturedCategoryList extends Component {
 
+    /**
+     * Name of the resource property that stores category id type
+     * which is used to build call-to-action link for category page
+     *
+     */
+    String CATEGORY_IDENTIFIER_TYPE = "categoryIdType";
+
     /**
      * Returns the categories data in a list from Magento depending on configurations.
      *

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/models/categorylist/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.components.models.categorylist;
 
-import org.osgi.annotation.versioning.Version;
+import org.osgi.annotation.versioning.Version;

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/models/common/CommerceIdentifier.java

@@ -19,7 +19,7 @@ public interface CommerceIdentifier {
      * The type of this identifier
      */
     enum IdentifierType {
-        SKU, URL_KEY, UID
+        SKU, URL_KEY, UID, URL_PATH
     }
 
     /**

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/models/common/package-info.java

@@ -13,7 +13,7 @@
  ~ See the License for the specific language governing permissions and
  ~ limitations under the License.
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
-@Version("2.4.0")
+@Version("2.5.0")
 package com.adobe.cq.commerce.core.components.models.common;
 
-import org.osgi.annotation.versioning.Version;
+import org.osgi.annotation.versioning.Version;

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/models/productlist/package-info.java

@@ -13,7 +13,7 @@
  ~ See the License for the specific language governing permissions and
  ~ limitations under the License.
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
-@Version("5.1.0")
+@Version("5.2.0")
 package com.adobe.cq.commerce.core.components.models.productlist;
 
-import org.osgi.annotation.versioning.Version;
+import org.osgi.annotation.versioning.Version;

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/models/retriever/AbstractCategoriesRetriever.java

@@ -66,6 +66,12 @@ public abstract class AbstractCategoriesRetriever extends AbstractRetriever {
      */
     protected List<String> identifiers;
 
+    /**
+     * CategoryIdType that should be used when fetched. Usually uid but we can define it explicitly in the implementation
+     * specific and should be checked in subclass implementations.
+     */
+    protected String categoryIdType;
+
     public AbstractCategoriesRetriever(MagentoGraphqlClient client) {
         super(client);
     }
@@ -93,6 +99,16 @@ public void setIdentifiers(List<String> identifiers) {
         this.identifiers = identifiers;
     }
 
+    /**
+     * Set the type category identifier which will using during fetch. Categories are retrieved using
+     * this categoryIdType if not set then it will use UID.
+     *
+     * @param categoryIdType Type category identifier
+     */
+    public void setCategoryIdType(String categoryIdType) {
+        this.categoryIdType = categoryIdType;
+    }
+
     /**
      * Extend the category query part of the category GraphQL query with a partial query provided by a lambda hook that sets additional
      * fields.
@@ -163,7 +179,13 @@ public void extendCategoryFilterWith(Function<CategoryFilterInput, CategoryFilte
     protected String generateQuery(List<String> identifiers) {
         CategoryFilterInput filter = new CategoryFilterInput();
         FilterEqualTypeInput identifiersFilter = new FilterEqualTypeInput().setIn(identifiers);
-        filter.setCategoryUid(identifiersFilter);
+
+        // Set the filter type
+        if (AbstractCategoryRetriever.CATEGORY_IDENTIFIER_URL_PATH.equals(this.categoryIdType)) {
+            filter.setUrlPath(identifiersFilter);
+        } else {
+            filter.setCategoryUid(identifiersFilter);
+        }
 
         // Apply category filter hook
         if (this.categoryFilterHook != null) {