CIF-1696: Migrate add to cart code to new generic addProductsToCart mutation (#884)

Author: Laurentiu Magureanu

README.md

@@ -20,6 +20,7 @@ See the [AEM Content & Commerce documentation](https://experienceleague.adobe.co
 
 - [Product v1](ui.apps/src/main/content/jcr_root/apps/core/cif/components/commerce/product/v1/product)
 - [Product v2](ui.apps/src/main/content/jcr_root/apps/core/cif/components/commerce/product/v2/product) - Adobe Commerce EE only with version >= 2.4.2
+- [Product v3](ui.apps/src/main/content/jcr_root/apps/core/cif/components/commerce/product/v3/product) - Adobe Commerce EE only with version >= 2.4.4
 - [Product List v1](ui.apps/src/main/content/jcr_root/apps/core/cif/components/commerce/productlist/v1/productlist)
 - [Product List v2](ui.apps/src/main/content/jcr_root/apps/core/cif/components/commerce/productlist/v2/productlist) - Adobe Commerce EE only with version >= 2.4.2
 - [Product Collection v1](ui.apps/src/main/content/jcr_root/apps/core/cif/components/commerce/productcollection/v1/productcollection)

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

@@ -352,7 +352,7 @@ public AbstractProductRetriever getProductRetriever() {
     }
 
     /* --- Mapping methods --- */
-    private Variant mapVariant(ConfigurableVariant variant) {
+    protected Variant mapVariant(ConfigurableVariant variant) {
         SimpleProduct product = variant.getProduct();
 
         VariantImpl productVariant = new VariantImpl();
@@ -408,15 +408,15 @@ private Asset mapAsset(MediaGalleryInterface entry) {
         return asset;
     }
 
-    private VariantValue mapVariantValue(ConfigurableProductOptionsValues value) {
+    protected VariantValue mapVariantValue(ConfigurableProductOptionsValues value) {
         VariantValueImpl variantValue = new VariantValueImpl();
         variantValue.setId(value.getValueIndex());
         variantValue.setLabel(value.getLabel());
 
         return variantValue;
     }
 
-    private VariantAttribute mapVariantAttribute(ConfigurableProductOptions option) {
+    protected VariantAttribute mapVariantAttribute(ConfigurableProductOptions option) {
         // Get list of values
         List<VariantValue> values = option.getValues().parallelStream().map(this::mapVariantValue).collect(Collectors.toList());
 
@@ -429,7 +429,7 @@ private VariantAttribute mapVariantAttribute(ConfigurableProductOptions option)
         return attribute;
     }
 
-    private String safeDescription(ProductInterface product) {
+    protected String safeDescription(ProductInterface product) {
         ComplexTextValue description = product.getDescription();
         if (description == null) {
             return null;

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

@@ -40,6 +40,8 @@ public class VariantImpl implements Variant {
 
     private Map<String, Integer> variantAttributes = new HashMap<>();
 
+    private Map<String, String> variantAttributesUid = new HashMap<>();
+
     private Price priceRange;
 
     @Override
@@ -106,6 +108,11 @@ public Map<String, Integer> getVariantAttributes() {
         return variantAttributes;
     }
 
+    @Override
+    public Map<String, String> getVariantAttributesUid() {
+        return variantAttributesUid;
+    }
+
     public void setColor(Integer color) {
         this.color = color;
     }

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

@@ -23,6 +23,8 @@ public class VariantValueImpl implements VariantValue {
 
     private Integer id;
 
+    private String uid;
+
     @Override
     public String getLabel() {
         return label;
@@ -40,4 +42,13 @@ public Integer getId() {
     public void setId(Integer id) {
         this.id = id;
     }
+
+    @Override
+    public String getUid() {
+        return uid;
+    }
+
+    public void setUid(String uid) {
+        this.uid = uid;
+    }
 }

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/internal/models/v3/product/ProductImpl.java

@@ -0,0 +1,91 @@
+/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ ~ Copyright 2021 Adobe
+ ~
+ ~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~ you may not use this file except in compliance with the License.
+ ~ You may obtain a copy of the License at
+ ~
+ ~     http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
+package com.adobe.cq.commerce.core.components.internal.models.v3.product;
+
+import java.util.List;
+import java.util.stream.Collectors;
+
+import javax.annotation.PostConstruct;
+
+import org.apache.sling.api.SlingHttpServletRequest;
+import org.apache.sling.models.annotations.Model;
+
+import com.adobe.cq.commerce.core.components.internal.models.v1.product.VariantAttributeImpl;
+import com.adobe.cq.commerce.core.components.internal.models.v1.product.VariantValueImpl;
+import com.adobe.cq.commerce.core.components.models.product.Product;
+import com.adobe.cq.commerce.core.components.models.product.Variant;
+import com.adobe.cq.commerce.core.components.models.product.VariantAttribute;
+import com.adobe.cq.commerce.core.components.models.product.VariantValue;
+import com.adobe.cq.commerce.magento.graphql.ConfigurableAttributeOption;
+import com.adobe.cq.commerce.magento.graphql.ConfigurableProductOptions;
+import com.adobe.cq.commerce.magento.graphql.ConfigurableProductOptionsValues;
+import com.adobe.cq.commerce.magento.graphql.ConfigurableVariant;
+
+@Model(adaptables = SlingHttpServletRequest.class, adapters = Product.class, resourceType = ProductImpl.RESOURCE_TYPE)
+public class ProductImpl extends com.adobe.cq.commerce.core.components.internal.models.v2.product.ProductImpl
+    implements Product {
+
+    public static final String RESOURCE_TYPE = "core/cif/components/commerce/product/v3/product";
+
+    @PostConstruct
+    protected void initModel() {
+        super.initModel();
+        if (productRetriever != null) {
+            productRetriever.extendProductQueryWith(p -> p.onConfigurableProduct(cp -> cp
+                .configurableOptions(o -> o
+                    .values(v -> v.uid()))
+                .variants(v -> v
+                    .attributes(a -> a.uid()))));
+        }
+    }
+
+    @Override
+    protected VariantValue mapVariantValue(ConfigurableProductOptionsValues value) {
+        VariantValueImpl variantValue = new VariantValueImpl();
+        variantValue.setId(value.getValueIndex());
+        variantValue.setUid(value.getUid().toString());
+        variantValue.setLabel(value.getLabel());
+
+        return variantValue;
+    }
+
+    @Override
+    protected VariantAttribute mapVariantAttribute(ConfigurableProductOptions option) {
+        // Get list of values
+        List<VariantValue> values = option.getValues().parallelStream().map(this::mapVariantValue)
+            .collect(Collectors.toList());
+
+        // Create attribute map
+        VariantAttributeImpl attribute = new VariantAttributeImpl();
+        attribute.setLabel(option.getLabel());
+        attribute.setId(option.getAttributeCode());
+        attribute.setValues(values);
+
+        return attribute;
+    }
+
+    @Override
+    protected Variant mapVariant(ConfigurableVariant variant) {
+        Variant mappedVariant = super.mapVariant(variant);
+
+        // Map variant attributes
+        for (ConfigurableAttributeOption option : variant.getAttributes()) {
+            mappedVariant.getVariantAttributesUid().put(option.getCode(), option.getUid().toString());
+        }
+
+        return mappedVariant;
+    }
+}

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/models/product/Variant.java

@@ -15,6 +15,7 @@
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
 package com.adobe.cq.commerce.core.components.models.product;
 
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
@@ -44,5 +45,9 @@ public interface Variant {
 
     Map<String, Integer> getVariantAttributes();
 
+    default Map<String, String> getVariantAttributesUid() {
+        return new HashMap<>();
+    }
+
     List<Asset> getAssets();
 }

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/models/product/VariantValue.java

@@ -26,4 +26,8 @@ public interface VariantValue {
     String getLabel();
 
     Integer getId();
+
+    default String getUid() {
+        return null;
+    }
 }

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

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

bundles/core/src/test/java/com/adobe/cq/commerce/core/components/internal/models/v1/product/ProductImplTest.java

@@ -113,9 +113,9 @@ public class ProductImplTest {
 
     private Resource productResource;
     private Resource pageResource;
-    private ProductInterface product;
     private GraphqlClient graphqlClient;
 
+    protected ProductInterface product;
     protected Product productModel;
     protected CloseableHttpClient httpClient;
     protected Style style;

bundles/core/src/test/java/com/adobe/cq/commerce/core/components/internal/models/v3/product/ProductImplTest.java

@@ -0,0 +1,77 @@
+/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ ~ Copyright 2022 Adobe
+ ~
+ ~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~ you may not use this file except in compliance with the License.
+ ~ You may obtain a copy of the License at
+ ~
+ ~     http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
+package com.adobe.cq.commerce.core.components.internal.models.v3.product;
+
+import java.io.IOException;
+import java.util.List;
+
+import org.junit.Before;
+import org.junit.Test;
+
+import com.adobe.cq.commerce.core.components.models.product.Variant;
+import com.adobe.cq.commerce.core.components.models.product.VariantAttribute;
+import com.adobe.cq.commerce.core.components.models.product.VariantValue;
+import com.adobe.cq.commerce.core.testing.Utils;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+public class ProductImplTest extends com.adobe.cq.commerce.core.components.internal.models.v2.product.ProductImplTest {
+
+    @Override
+    protected void adaptToProduct() {
+        // This ensures we re-run all the unit tests with version 3 of ProductImpl
+        productModel = context.request().adaptTo(ProductImpl.class);
+    }
+
+    @Before
+    public void updateGraphQlResponse() throws IOException {
+        Utils.setupHttpResponse("graphql/magento-graphql-product-result-uid-variants.json", httpClient, 200,
+            "{products(filter:{url_key");
+        Utils.setupHttpResponse("graphql/magento-graphql-product-result-uid-variants.json", httpClient, 200,
+            "{products(filter:{sku");
+    }
+
+    @Test
+    public void testUidVariants() throws IOException {
+        ObjectMapper mapper = new ObjectMapper();
+        adaptToProduct();
+        List<Variant> variants = productModel.getVariants();
+        assertNotNull(variants);
+        String jsonVariants = productModel.getVariantsJson();
+        String expectedJsonVariants = Utils.getResource("results/result-product-variants-uid.json");
+        assertEquals(mapper.readTree(expectedJsonVariants), mapper.readTree(jsonVariants));
+    }
+
+    @Test
+    public void testGetVariantAttributesUid() throws IOException {
+        adaptToProduct();
+        List<VariantAttribute> attributes = productModel.getVariantAttributes();
+
+        assertNotNull(attributes);
+
+        for (int i = 0; i < attributes.size(); i++) {
+            VariantAttribute attribute = attributes.get(i);
+
+            for (int j = 0; j < attribute.getValues().size(); j++) {
+                VariantValue value = attribute.getValues().get(j);
+                assertNotNull(value.getUid());
+            }
+        }
+    }
+
+}