Merge pull request #10 from diconium/feature/release_2.2

Feature/release 2.2

Author: rafaelbarbosa-diconium

CHANGELOG.md

@@ -0,0 +1,56 @@
+[![CircleCI](https://circleci.com/gh/adobe/commerce-cif-graphql-integration-reference.svg?style=svg)](https://circleci.com/gh/adobe/commerce-cif-graphql-integration-reference)
+[![codecov](https://codecov.io/gh/adobe/commerce-cif-graphql-integration-reference/branch/master/graph/badge.svg)](https://codecov.io/gh/adobe/commerce-cif-graphql-integration-reference)
+
+# 3rd-Party GraphQL integration with AEM Commerce and CIF on Adobe I/O Runtime
+
+## 2.3 (Unreleased)
+
+## 2.2 (June 11, 2021)
+##### ENHANCEMENTS: 
+  * Functionality for Individual Package deployments are added to store the node modules independently with respect to each module.
+  * Added Sinon Spies for data loaders in order to test function callback handing.
+  * Code Optimisation and improvisation on security code check 
+  
+##### BUGFIXES:
+  * Sonar fixes on Code smell issues.
+  
+
+## 2.1 (June 3, 2021)
+
+##### ENHANCEMENTS:
+
+  * Options.JSON is changed to options.yml to store constants
+  * Removal of deprecated attribute category_id and cart_item_id and replaced with uid as per latest schema
+  * Sort functionality Implementation
+  * Code Optimization
+  
+  
+##### BUGFIXES:
+  
+  * Updated Unit test Cases  
+
+## 2.0 (May 21, 2021)
+
+##### ENHANCEMENTS: 
+* Implementation of latest Schema on I/O Connector
+* Implementation of latest CIF and query API changes
+* Project Execution of AEM CIF - Hybris connectivity through GraphQL API and adapting rest response from Hybris
+* Implementation of complete commerce flow from fetching products to order generation
+* Revert of all previous code modifications and schema modifications done in 1.0 as Schema was upgraded and core cif components are released with latest patch.
+* Removal of request promise
+
+##### BUGFIXES:  
+
+* Unit test upgrade
+* Introspection query changes
+* Hybris URL endpoint configuration management
+
+## 1.0 (August 16, 2020)
+##### ENHANCEMENTS: 
+* Initial Commit of Topology design and Architecture planning of I/O Connector
+* Project Creation of I/O Connector to connect Hybris and Adobe CIF using Magento Graphql Schema 2.3 version.
+* Implementation of complete commerce flow from fetching products to order generation
+* Schema modifications as per required input and output for different endpoints
+* CIF Core components modification to fetch media based URL
+* Schema Attribute changes for cart_item_id from Int to String as per Hybris data retrieval. 
+

README.md

@@ -64,7 +64,7 @@ OpenWhisk CLI must be available in your systems PATH and set up correctly to eit
 
 ### Configuration
 To be able to use this CIF connector you will need to provid some Hybris configurations to connect to your Hybris endpoint.
-Under [cif/common/options.json.example](cif/common/options.json.example) you will find an example json file you should use as an example.
+Under [cif/common/options.yml.example](cif/common/options.yml.example) you will find an example yml file you should use as an example.
 
 The example file should look something like this
 ```
@@ -80,7 +80,7 @@ The example file should look something like this
 }
 ```
 
-You should copy the example file to an options.json file under the same path, this will be the real file that will have your configurations.
+You should copy the example file to an options.yml file under the same path, this will be the real file that will have your configurations.
 This file is under .gitignore and should not be commited to the repository since it has client secrets.
 
 
@@ -92,12 +92,17 @@ $ npm install
 $ npm test
 ```
 
+To deploy the actions on the Adobe I/O Runtime platform, we use the [serverless](https://serverless.com/framework/docs/providers/openwhisk/) framework. The deployment of independent packages and actions is defined in each package `serverless.yml` file. To deploy everything individually, simply run:
+```
+$ npm run deploy-packages
+```
+
 To deploy the actions on the Adobe I/O Runtime platform, we use the [serverless](https://serverless.com/framework/docs/providers/openwhisk/) framework. The deployment of packages and actions is defined in the `serverless.yml` file. To deploy everything, simply run:
 ```
 $ npm run deploy
 ```
 
-This will deploy the `graphql-reference/dispatcher` and all other actions like cart, oder etc in your namespace (Complete list in serverless.yml file). The dispatcher is a web action that is accessible with the URL `https://adobeioruntime.net/api/v1/web/NAMESPACE/graphql-reference/dispatcher`. To test the GraphQL endpoint, you can for example use the `GraphiQL` plugin in the Chrome browser.
+This will deploy the `hybris-graphql/dispatcher` and all other actions like cart, oder etc in your namespace (Complete list in serverless.yml file). The dispatcher is a web action that is accessible with the URL `https://adobeioruntime.net/api/v1/web/NAMESPACE/graphql-reference/dispatcher`. To test the GraphQL endpoint, you can for example use the `GraphiQL` plugin in the Chrome browser.
 
 ### Contributing
 

cif/cart/src/AddProductToCartLoader.js

@@ -24,7 +24,7 @@ class AddProductToCartResolverLoader {
    */
   constructor(actionParameters) {
     this.actionParameters = actionParameters;
-    let loadingFunction = inputs => {
+    const loadingFunction = inputs => {
       return Promise.resolve(
         inputs.map(input => {
           console.debug(`--> Fetching cart with id ${JSON.stringify(input)}`);
@@ -71,7 +71,7 @@ class AddProductToCartResolverLoader {
     const { cart_id, cart_items } = input;
     const { data } = cart_items[0];
 
-    let body = {
+    const body = {
       product: {
         code: data.sku,
       },

cif/cart/src/ApplyCouponToCart.js

@@ -50,18 +50,21 @@ class ApplyCouponToCart {
 
   /**
    * get cart method call cart loader to get the cart entries
+   * @returns {Promise} a promise return null after resolved successfully other wise return the error.
    */
   get cart() {
     const { cart_id: cartId } = this.input;
 
-    return this.__load().then(() => {
-      return new Cart({
-        graphqlContext: this.graphqlContext,
-        actionParameters: this.actionParameters,
-        cartLoader: this.cartLoader,
-        cartId: cartId,
-      });
-    });
+    return this.__load()
+      .then(() => {
+        return new Cart({
+          graphqlContext: this.graphqlContext,
+          actionParameters: this.actionParameters,
+          cartLoader: this.cartLoader,
+          cartId: cartId,
+        });
+      })
+      .catch(errorOutput => Promise.reject(errorOutput));
   }
 }
 

cif/cart/src/ApplyCouponToCartLoader.js

@@ -21,7 +21,7 @@ class ApplyCouponToCartLoader {
    * @param {Object} [actionParameters] Some optional parameters of the I/O Runtime action, like for example customerId, bearer token, query and url info.
    */
   constructor(actionParameters) {
-    let loadingFunction = inputs => {
+    const loadingFunction = inputs => {
       return Promise.resolve(
         inputs.map(input => {
           console.debug(`--> Fetching cart with id ${JSON.stringify(input)}`);
@@ -65,7 +65,7 @@ class ApplyCouponToCartLoader {
 
     const { cart_id, coupon_code } = input;
     const uri = `${HB_PROTOCOL}://${HB_API_HOST}${HB_API_BASE_PATH}${HB_BASESITEID}/users/${customerId}/carts/${cart_id}/vouchers?voucherId=${coupon_code}`;
-    let body = {};
+    const body = {};
     const config = {
       headers: {
         Authorization: `Bearer ${bearer}`,

cif/cart/src/Cart.js

@@ -62,7 +62,11 @@ class Cart {
    */
   getRegionCode(address) {
     let code = address !== undefined ? address.region.isocode.split('-') : '';
-    code = code !== '' ? (code.length === 2 ? code[1] : code[0]) : '';
+    if (code !== '') {
+      code = code.length === 2 ? code[1] : code[0];
+    } else {
+      code = '';
+    }
     return code;
   }
 
@@ -71,7 +75,7 @@ class Cart {
    * @returns {[]}
    */
   getShippingMethods(deliveryModes) {
-    let shippingMethods = [];
+    const shippingMethods = [];
     deliveryModes.map(shippingMethod => {
       if (shippingMethod.code !== 'pickup') {
         shippingMethods.push({
@@ -116,12 +120,12 @@ class Cart {
       deliveryModes,
       deliveryMode,
     } = data;
-    let regionCode = this.getRegionCode(deliveryAddress);
-    let billingRegionCode =
+    const regionCode = this.getRegionCode(deliveryAddress);
+    const billingRegionCode =
       paymentInfo !== undefined
         ? this.getRegionCode(paymentInfo.billingAddress)
         : '';
-    let availableShippingMethods =
+    const availableShippingMethods =
       deliveryModes !== undefined ? this.getShippingMethods(deliveryModes) : [];
     const { appliedVouchers } = data;
     const { items } = new CartItemInterface(data.entries);

cif/cart/src/CartLoader.js

@@ -20,14 +20,13 @@ const axios = require('axios');
 class CartLoader {
   /**
    * @param {Object} [actionParameters] Some optional parameters of the I/O Runtime action, like for example authentication info.
+   * @returns {loadingFunction}  -This loader loads each cart one by one, but if the 3rd party backend allows it,
+   * it could also fetch all carts in one single request. In this case, the method must still return an Array of
+   * carts with the same order as the keys.
+   * @param {Array} [cartIds] is an Array of cart ids
    */
   constructor(actionParameters) {
-    let loadingFunction = cartIds => {
-      /**
-       * This loader loads each cart one by one, but if the 3rd party backend allows it,
-       *it could also fetch all carts in one single request. In this case, the method
-       *must still return an Array of carts with the same order as the keys.
-       */
+    const loadingFunction = cartIds => {
       return Promise.resolve(
         cartIds.map(cartId => {
           console.debug(`--> Fetching cart with id ${cartId}`);

cif/cart/src/CreateEmptyCart.js

@@ -62,7 +62,7 @@ class CreateEmptyCart {
       HB_PROTOCOL,
       HB_BASESITEID,
     } = actionParameters.context.settings;
-    let uri = `${HB_PROTOCOL}://${HB_API_HOST}${HB_API_BASE_PATH}${HB_BASESITEID}/users/${customerId}/carts?fields=DEFAULT`;
+    const uri = `${HB_PROTOCOL}://${HB_API_HOST}${HB_API_BASE_PATH}${HB_BASESITEID}/users/${customerId}/carts?fields=DEFAULT`;
     const config = {
       headers: {
         Authorization: `Bearer ${bearer}`,

cif/cart/src/RemoveCouponFromCart.js

@@ -26,6 +26,7 @@ class RemoveCouponFromCart {
    * @param {String} parameters.vouchersList parameter contains the vouchersList
    * @param {Object} [parameters.graphqlContext] The optional GraphQL execution context passed to the resolver.
    * @param {Object} [parameters.actionParameters] Some optional parameters of the I/O Runtime action, like for example customerId, bearer token, query and url info.
+   * LoaderProxy class returns a Proxy to avoid having to implement a getter for all properties.
    */
   constructor(parameters) {
     this.cartId = parameters.cartId;
@@ -36,24 +37,24 @@ class RemoveCouponFromCart {
       parameters
     );
     this.cartLoader = new CartLoader(parameters.actionParameters);
-    /**
-     * This class returns a Proxy to avoid having to implement a getter for all properties.
-     */
     return new LoaderProxy(this);
   }
 
   /**
    * method used to get the cart details based on the cart Id
+   * @returns {Promise} a promise return null after resolved successfully other wise return the error.
    */
   get cart() {
-    return this.__load().then(() => {
-      return new Cart({
-        graphqlContext: this.graphqlContext,
-        actionParameters: this.actionParameters,
-        cartLoader: this.cartLoader,
-        cartId: this.cartId,
-      });
-    });
+    return this.__load()
+      .then(() => {
+        return new Cart({
+          graphqlContext: this.graphqlContext,
+          actionParameters: this.actionParameters,
+          cartLoader: this.cartLoader,
+          cartId: this.cartId,
+        });
+      })
+      .catch(errorOutput => Promise.reject(errorOutput));
   }
 
   /**

cif/cart/src/RemoveCouponFromCartLoader.js

@@ -19,21 +19,17 @@ const axios = require('axios');
 class RemoveCouponFromCartLoader {
   /**
    * @param {Object} [actionParameters] Some optional parameters of the I/O Runtime action, like for example customerId, bearer token, query and url info.
+   * @returns {loadingFunction}  -This loader loads each cart one by one, but if the 3rd party backend allows it,
+   * it could also fetch all carts in one single request. In this case, the method must still return an Array of
+   * carts with the same order as the keys.
+   * @param {Array} [cartIds] is an Array of cart ids.
    */
 
   constructor(actionParameters) {
     this.vouchersList = actionParameters.vouchersList;
     this.actionParameters = actionParameters.actionParameters;
-    /**
-     *this.actionParameters = parameters.actionParameters;
-     *The loading function: "cartIds" is an Array of cart ids
-     */
-    let loadingFunction = cartIds => {
-      /**
-       *This loader loads each cart one by one, but if the 3rd party backend allows it,
-       *it could also fetch all carts in one single request. In this case, the method
-       *must still return an Array of carts with the same order as the keys.
-       */
+
+    const loadingFunction = cartIds => {
       return Promise.resolve(
         cartIds.map(cartId => {
           return this._removeCouponsFromCart(
@@ -77,7 +73,7 @@ class RemoveCouponFromCartLoader {
     return new Promise((resolve, reject) => {
       vouchersList &&
         vouchersList.vouchers.map(({ code }) => {
-          let uri = `${HB_PROTOCOL}://${HB_API_HOST}${HB_API_BASE_PATH}${HB_BASESITEID}/users/${customerId}/carts/${cartId}/vouchers/${code}?fields=FULL`;
+          const uri = `${HB_PROTOCOL}://${HB_API_HOST}${HB_API_BASE_PATH}${HB_BASESITEID}/users/${customerId}/carts/${cartId}/vouchers/${code}?fields=FULL`;
           axios
             .delete(uri, {
               params: {