CIF-2526 - Add add-to-cart button in all product collections (#853)

* CIF-2526 - Add add-to-cart button in all product collections

 * implemented 'Add to Cart' and 'Add to Wish List' button for the components: productcollection, productlist, searchresults, productcarousel, relatedproducts
 * updated UI tests, uint tests and intergation tests
 * updated exmamples library pages
 * updated the readme of related components

* CIF-2526 - Add add-to-cart button in all product collections

 * fixing IT failures

Author: LSantha

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

@@ -25,6 +25,10 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.adobe.cq.commerce.magento.graphql.DownloadableProduct;
+import com.adobe.cq.commerce.magento.graphql.ProductInterface;
+import com.adobe.cq.commerce.magento.graphql.SimpleProduct;
+import com.adobe.cq.commerce.magento.graphql.VirtualProduct;
 import com.day.cq.wcm.api.designer.Designer;
 import com.day.cq.wcm.api.designer.Style;
 import com.day.cq.wcm.api.policies.ContentPolicy;
@@ -91,4 +95,17 @@ public static NumberFormat buildPriceFormatter(Locale locale, String currencyCod
 
         return formatter;
     }
+
+    /**
+     * Returns true if add to cart is possible for the the given product.
+     *
+     * @param product a ProductInterface instance
+     *
+     * @return {@code true} if the product can be added to the shopping cart, {@code false} otherwise
+     */
+    public static boolean isShoppableProduct(ProductInterface product) {
+        return product instanceof SimpleProduct ||
+            product instanceof VirtualProduct ||
+            product instanceof DownloadableProduct;
+    }
 }

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

@@ -26,6 +26,7 @@
 
 import com.adobe.cq.commerce.core.components.internal.datalayer.DataLayerListItem;
 import com.adobe.cq.commerce.core.components.internal.datalayer.ProductDataImpl;
+import com.adobe.cq.commerce.core.components.internal.models.v1.Utils;
 import com.adobe.cq.commerce.core.components.models.common.CommerceIdentifier;
 import com.adobe.cq.commerce.core.components.models.common.Price;
 import com.adobe.cq.commerce.core.components.models.common.ProductListItem;
@@ -44,6 +45,8 @@
 public class ProductListItemImpl extends DataLayerListItem implements ProductListItem {
 
     public static final String TYPE = "core/cif/components/commerce/productlistitem";
+    public static final String CALL_TO_ACTION_ADD_TO_CART = "add-to-cart";
+    public static final String CALL_TO_ACTION_DETAILS = "details";
 
     private String sku;
     private String urlKey;
@@ -220,6 +223,11 @@ public ProductInterface getProduct() {
         return product;
     }
 
+    @Override
+    public String getCallToAction() {
+        return Utils.isShoppableProduct(product) ? CALL_TO_ACTION_ADD_TO_CART : CALL_TO_ACTION_DETAILS;
+    }
+
     public static class Builder {
 
         private final String parentId;

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/internal/models/v1/productcarousel/ProductCarouselBase.java

@@ -15,7 +15,12 @@
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
 package com.adobe.cq.commerce.core.components.internal.models.v1.productcarousel;
 
+import javax.annotation.PostConstruct;
+
 import org.apache.sling.api.SlingHttpServletRequest;
+import org.apache.sling.api.resource.Resource;
+import org.apache.sling.api.resource.ValueMap;
+import org.apache.sling.models.annotations.injectorspecific.ScriptVariable;
 import org.apache.sling.models.annotations.injectorspecific.Self;
 
 import com.adobe.cq.commerce.core.components.internal.datalayer.DataLayerComponent;
@@ -24,13 +29,46 @@
 import com.adobe.cq.commerce.core.components.internal.models.v1.common.CommerceIdentifierImpl;
 import com.adobe.cq.commerce.core.components.internal.models.v1.common.ProductListItemImpl;
 import com.adobe.cq.commerce.core.components.models.common.CommerceIdentifier;
+import com.adobe.cq.commerce.core.components.services.ComponentsConfiguration;
 import com.adobe.cq.wcm.core.components.models.datalayer.ComponentData;
+import com.day.cq.wcm.api.Page;
+import com.day.cq.wcm.api.designer.Style;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 
 public class ProductCarouselBase extends DataLayerComponent {
 
+    protected static final boolean ENABLE_ADD_TO_CART_DEFAULT = false;
+    protected static final boolean ENABLE_ADD_TO_WISH_LIST_DEFAULT = false;
+    static final String PN_ENABLE_ADD_TO_CART = "enableAddToCart";
+    static final String PN_ENABLE_ADD_TO_WISH_LIST = "enableAddToWishList";
+    static final String PN_CONFIG_ENABLE_WISH_LISTS = "enableWishLists";
     @Self
     protected SlingHttpServletRequest request;
+    @ScriptVariable
+    protected Page currentPage;
+    @ScriptVariable
+    protected Style currentStyle;
+    protected boolean addToCartEnabled;
+    protected boolean addToWishListEnabled;
+
+    @PostConstruct
+    private void initModel0() {
+        ValueMap properties = resource.getValueMap();
+        ComponentsConfiguration configProperties = currentPage.adaptTo(Resource.class).adaptTo(ComponentsConfiguration.class);
+        addToCartEnabled = properties.get(PN_ENABLE_ADD_TO_CART, currentStyle.get(PN_ENABLE_ADD_TO_CART, ENABLE_ADD_TO_CART_DEFAULT));
+        addToWishListEnabled = (configProperties != null ? configProperties.get(PN_CONFIG_ENABLE_WISH_LISTS,
+            ENABLE_ADD_TO_WISH_LIST_DEFAULT) : ENABLE_ADD_TO_WISH_LIST_DEFAULT);
+        addToWishListEnabled = addToWishListEnabled && properties.get(PN_ENABLE_ADD_TO_WISH_LIST, currentStyle.get(
+            PN_ENABLE_ADD_TO_WISH_LIST, ENABLE_ADD_TO_WISH_LIST_DEFAULT));
+    }
+
+    public boolean isAddToCartEnabled() {
+        return addToCartEnabled;
+    }
+
+    public boolean isAddToWishListEnabled() {
+        return addToWishListEnabled;
+    }
 
     /**
      * And implementation of {@link CommerceIdentifier} that serializes to the same json format a {@link ProductListItemImpl} would

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/internal/models/v1/productcarousel/ProductCarouselImpl.java

@@ -33,7 +33,6 @@
 import org.apache.sling.models.annotations.Model;
 import org.apache.sling.models.annotations.injectorspecific.InjectionStrategy;
 import org.apache.sling.models.annotations.injectorspecific.OSGiService;
-import org.apache.sling.models.annotations.injectorspecific.ScriptVariable;
 import org.apache.sling.models.annotations.injectorspecific.Self;
 import org.apache.sling.models.annotations.injectorspecific.ValueMapValue;
 import org.slf4j.Logger;
@@ -57,7 +56,6 @@
 import com.adobe.cq.export.json.ComponentExporter;
 import com.adobe.cq.export.json.ExporterConstants;
 import com.day.cq.wcm.api.Page;
-import com.day.cq.wcm.api.designer.Style;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
@@ -99,15 +97,9 @@ public class ProductCarouselImpl extends ProductCarouselBase implements ProductC
         injectionStrategy = InjectionStrategy.OPTIONAL)
     private String categoryUid;
 
-    @ScriptVariable
-    private Page currentPage;
-
     @OSGiService
     private UrlProvider urlProvider;
 
-    @ScriptVariable
-    protected Style currentStyle;
-
     private Integer productCount;
     private Page productPage;
     private List<String> baseProductSkus = Collections.emptyList();

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/internal/models/v1/productcollection/ProductCollectionImpl.java

@@ -23,6 +23,7 @@
 import javax.annotation.PostConstruct;
 
 import org.apache.sling.api.SlingHttpServletRequest;
+import org.apache.sling.api.resource.Resource;
 import org.apache.sling.api.resource.ValueMap;
 import org.apache.sling.models.annotations.Model;
 import org.apache.sling.models.annotations.Via;
@@ -35,6 +36,7 @@
 import com.adobe.cq.commerce.core.components.internal.models.v1.Utils;
 import com.adobe.cq.commerce.core.components.models.common.ProductListItem;
 import com.adobe.cq.commerce.core.components.models.productcollection.ProductCollection;
+import com.adobe.cq.commerce.core.components.services.ComponentsConfiguration;
 import com.adobe.cq.commerce.core.components.services.urls.UrlProvider;
 import com.adobe.cq.commerce.core.components.utils.SiteNavigation;
 import com.adobe.cq.commerce.core.search.internal.models.SearchOptionsImpl;
@@ -58,7 +60,10 @@ public class ProductCollectionImpl extends DataLayerComponent implements Product
     public static final String RESOURCE_TYPE = "core/cif/components/commerce/productcollection/v1/productcollection";
 
     protected static final boolean LOAD_CLIENT_PRICE_DEFAULT = true;
+    protected static final boolean ENABLE_ADD_TO_CART_DEFAULT = false;
+    protected static final boolean ENABLE_ADD_TO_WISH_LIST_DEFAULT = false;
     protected static final String PAGINATION_TYPE_DEFAULT = "paginationbar";
+    protected static final String PN_CONFIG_ENABLE_WISH_LISTS = "enableWishLists";
 
     protected Page productPage;
     protected boolean loadClientPrice;
@@ -87,6 +92,8 @@ public class ProductCollectionImpl extends DataLayerComponent implements Product
 
     protected SearchOptionsImpl searchOptions;
     protected SearchResultsSet searchResultsSet;
+    protected boolean addToCartEnabled;
+    protected boolean addToWishListEnabled;
 
     @PostConstruct
     private void baseInitModel() {
@@ -104,6 +111,14 @@ private void baseInitModel() {
         loadClientPrice = properties.get(PN_LOAD_CLIENT_PRICE, currentStyle.get(PN_LOAD_CLIENT_PRICE, LOAD_CLIENT_PRICE_DEFAULT));
         paginationType = properties.get(PN_PAGINATION_TYPE, currentStyle.get(PN_PAGINATION_TYPE, PAGINATION_TYPE_DEFAULT));
 
+        ComponentsConfiguration configProperties = currentPage.adaptTo(Resource.class).adaptTo(ComponentsConfiguration.class);
+
+        addToCartEnabled = currentStyle.get(PN_ENABLE_ADD_TO_CART, ENABLE_ADD_TO_CART_DEFAULT);
+
+        addToWishListEnabled = (configProperties != null ? configProperties.get(PN_CONFIG_ENABLE_WISH_LISTS,
+            ENABLE_ADD_TO_WISH_LIST_DEFAULT) : ENABLE_ADD_TO_WISH_LIST_DEFAULT);
+        addToWishListEnabled = addToWishListEnabled && currentStyle.get(PN_ENABLE_ADD_TO_WISH_LIST, ENABLE_ADD_TO_WISH_LIST_DEFAULT);
+
         // get product template page
         productPage = SiteNavigation.getProductPage(currentPage);
         if (productPage == null) {
@@ -134,6 +149,16 @@ public String getPaginationType() {
         return paginationType;
     }
 
+    @Override
+    public boolean isAddToCartEnabled() {
+        return addToCartEnabled;
+    }
+
+    @Override
+    public boolean isAddToWishListEnabled() {
+        return addToWishListEnabled;
+    }
+
     protected Map<String, String> createFilterMap(final Map<String, String[]> parameterMap) {
         Map<String, String> filters = new HashMap<>();
         parameterMap.forEach((code, value) -> {

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/internal/models/v1/productteaser/ProductTeaserImpl.java

@@ -36,6 +36,7 @@
 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.datalayer.ProductDataImpl;
+import com.adobe.cq.commerce.core.components.internal.models.v1.Utils;
 import com.adobe.cq.commerce.core.components.internal.models.v1.common.CommerceIdentifierImpl;
 import com.adobe.cq.commerce.core.components.internal.models.v1.common.PriceImpl;
 import com.adobe.cq.commerce.core.components.models.common.CommerceIdentifier;
@@ -48,7 +49,6 @@
 import com.adobe.cq.commerce.core.components.utils.SiteNavigation;
 import com.adobe.cq.commerce.magento.graphql.ConfigurableProduct;
 import com.adobe.cq.commerce.magento.graphql.ConfigurableVariant;
-import com.adobe.cq.commerce.magento.graphql.DownloadableProduct;
 import com.adobe.cq.commerce.magento.graphql.ProductInterface;
 import com.adobe.cq.commerce.magento.graphql.SimpleProduct;
 import com.adobe.cq.commerce.magento.graphql.VirtualProduct;
@@ -131,18 +131,14 @@ protected void initModel() {
             if (magentoGraphqlClient != null) {
                 productRetriever = new ProductRetriever(magentoGraphqlClient);
                 productRetriever.setIdentifier(combinedSku.getLeft());
-                ctaOverride = CALL_TO_ACTION_TYPE_ADD_TO_CART.equals(cta) && !oneClickShoppable(getProduct());
+                ctaOverride = CALL_TO_ACTION_TYPE_ADD_TO_CART.equals(cta) && !Utils.isShoppableProduct(getProduct());
             }
         }
 
         enableAddToWishList = (configProperties != null ? configProperties.get(PN_CONFIG_ENABLE_WISH_LISTS, Boolean.TRUE) : Boolean.TRUE)
             && currentStyle.get(PN_STYLE_ADD_TO_WISHLIST_ENABLED, ProductTeaser.super.getAddToWishListEnabled());
     }
 
-    private boolean oneClickShoppable(ProductInterface product) {
-        return product instanceof SimpleProduct || product instanceof VirtualProduct || product instanceof DownloadableProduct;
-    }
-
     @JsonIgnore
     private ProductInterface getProduct() {
         if (productRetriever == null) {

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/internal/models/v1/relatedproducts/RelatedProductsImpl.java

@@ -50,7 +50,6 @@
 import com.adobe.cq.export.json.ComponentExporter;
 import com.adobe.cq.export.json.ExporterConstants;
 import com.day.cq.wcm.api.Page;
-import com.day.cq.wcm.api.designer.Style;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
@@ -73,18 +72,12 @@ public class RelatedProductsImpl extends ProductCarouselBase implements ProductC
     @Self(injectionStrategy = InjectionStrategy.OPTIONAL)
     private MagentoGraphqlClient magentoGraphqlClient;
 
-    @ScriptVariable
-    private Page currentPage;
-
     @OSGiService
     private UrlProvider urlProvider;
 
     @ScriptVariable
     private ValueMap properties;
 
-    @ScriptVariable
-    protected Style currentStyle;
-
     private Page productPage;
     private AbstractProductsRetriever productsRetriever;
     private RelationType relationType;

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

@@ -85,4 +85,13 @@ default Boolean isStaged() {
      * @return The product.
      */
     ProductInterface getProduct();
+
+    /**
+     * Returns the call to action command for the 'Add to Cart' button of the product list item.
+     *
+     * @return {@code add-to-cart} if the related product can be added to the shopping cart, {@code details} otherwise
+     */
+    default String getCallToAction() {
+        return "";
+    }
 }

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.1.0")
+@Version("2.2.0")
 package com.adobe.cq.commerce.core.components.models.common;
 
 import org.osgi.annotation.versioning.Version;

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/models/productcarousel/ProductCarousel.java

@@ -57,4 +57,22 @@ public interface ProductCarousel extends Component {
      * @return The HTML tag type that should be used to display the component title.
      */
     String getTitleType();
+
+    /**
+     * Indicates whether the 'Add to Cart' button should be displayed on the product carousel item.
+     *
+     * @return {@code true} if the button should be displayed, {@code false} otherwise
+     */
+    default boolean isAddToCartEnabled() {
+        return false;
+    }
+
+    /**
+     * Indicates whether the 'Add to Wish List' button should be displayed on the product carousel item.
+     *
+     * @return {@code true} if the button should be displayed, {@code false} otherwise
+     */
+    default boolean isAddToWishListEnabled() {
+        return false;
+    }
 }