Merge pull request #11 from SalesforceCommerceCloud/202109_typos

More unused code removed

Author: njparadis

CHANGELOG.md

@@ -11,6 +11,10 @@ bumped for multiple releases during one month.
 - Order Confirmation event will now correctly fire for orders with coupons.
 ##### Updated
 - Rename sendEmail function to trackEvent
+- Fix grammar/typos in comments and docstrings
+- Remove unused functions from Core and SG cartridges
+    - sendOrderEmail from Core emailUtils
+    - sendKlaviyoShipmentEmail from SG Klaviyo.js controller
 
 ### [21.7.0] - 2021-7-27
 ##### Updated

cartridges/int_klaviyo/cartridge/controllers/Klaviyo.js

@@ -9,40 +9,40 @@ var ISML = require('dw/template/ISML');
 
 
 /**
- * Controller that will send the necessary data required for klaviyo to track the user event's
- * such as checkout,order confirmation,searching etc and renders the renders the klaviyoTag isml file
+ * Controller that sends the necessary data required for klaviyo to track user events
+ * such as checkout, order confirmation, searching etc and renders the renders the klaviyoTag isml file
  *
  * @module controllers/Klaviyo
 */
 
 
-var RenderKlaviyo = function () {
-    if (!dw.system.Site.getCurrent().getCustomPreferenceValue('klaviyo_enabled')) {
-        return;
-    }
-    var logger = Logger.getLogger('renderKlaviyo', 'Klaviyo - Render Klaviyo Controller');
-    try {
-        var klaviyoUtils = require('*/cartridge/scripts/utils/klaviyo/klaviyoUtils');
-        var klaviyoTags = require('*/cartridge/scripts/utils/klaviyo/klaviyoOnSiteTags.js').klaviyoOnSiteTags;
-
-        var klaviyoDataLayer = klaviyoUtils.buildDataLayer();
-        var sendToDom = klaviyoTags(klaviyoDataLayer);
-
-        ISML.renderTemplate('klaviyo/klaviyoTag', {
-            klaviyoData: sendToDom
-        });
-    } catch (e) {
-        logger.debug('error rendering klaviyo ' + e.message + ' at ' + e.lineNumber);
-    }
+var RenderKlaviyo = function () {
+    if (!dw.system.Site.getCurrent().getCustomPreferenceValue('klaviyo_enabled')) {
+        return;
+    }
+    var logger = Logger.getLogger('renderKlaviyo', 'Klaviyo - Render Klaviyo Controller');
+    try {
+        var klaviyoUtils = require('*/cartridge/scripts/utils/klaviyo/klaviyoUtils');
+        var klaviyoTags = require('*/cartridge/scripts/utils/klaviyo/klaviyoOnSiteTags.js').klaviyoOnSiteTags;
+
+        var klaviyoDataLayer = klaviyoUtils.buildDataLayer();
+        var sendToDom = klaviyoTags(klaviyoDataLayer);
+
+        ISML.renderTemplate('klaviyo/klaviyoTag', {
+            klaviyoData: sendToDom
+        });
+    } catch (e) {
+        logger.debug('error rendering klaviyo ' + e.message + ' at ' + e.lineNumber);
+    }
 };
 
 /**
- * Controller that will send the necessary data  to klaviyo when an add to cart event happens
+ * Controller that sends the necessary data to klaviyo when an add to cart event happens
  * @module controllers/Klaviyo
 */
 
 
-var RenderKlaviyoAddToCart = function () {
+var RenderKlaviyoAddToCart = function () {
     if (!dw.system.Site.getCurrent().getCustomPreferenceValue('klaviyo_enabled')) {
         return;
     }
@@ -58,29 +58,7 @@ var RenderKlaviyoAddToCart = function () {
 };
 
 
-/**
- *end point for testing shipping confirmation event
- *
-*/
-
-function sendKlaviyoShipmentEmail() {
-    var parameterMap = request.httpParameterMap;
-    var orderID = null;
-    if (!empty(parameterMap)) {
-        orderID = parameterMap.orderID.stringValue;
-    }
-    if (orderID) {
-        var klaviyoUtils = require('*/cartridge/scripts/utils/klaviyo/klaviyoUtils');
-        if (klaviyoUtils.sendMailForShipmentConfirmation(orderID)) {
-            r.renderJSON({ status: 'success' });
-        } else {
-            r.renderJSON({ status: 'failed sending email' });
-        }
-    }
-}
-
 /** Handles the form submission for subscription.
  * @see {@link module:controllers/Klaviyo~Subscribe} */
-exports.sendKlaviyoShipmentEmail = guard.ensure(['get'], sendKlaviyoShipmentEmail);
 exports.RenderKlaviyo = guard.ensure(['get'], RenderKlaviyo);
 exports.RenderKlaviyoAddToCart = guard.ensure(['get'], RenderKlaviyoAddToCart);

cartridges/int_klaviyo_core/cartridge/scripts/utils/klaviyo/emailUtils.js

@@ -6,25 +6,6 @@ var URLUtils = require('dw/web/URLUtils');
 var productMgr = require('dw/catalog/ProductMgr');
 var imageSize = Site.getCurrent().getCustomPreferenceValue('klaviyo_image_size') || null;
 
-/**
- * Sends an order to Klaviyo with the order email type.
- *
- * @param order
- * @param mailType
- * @returns
- */
-function sendOrderEmail(order, mailType) {
-    var logger = Logger.getLogger('Klaviyo', 'emailUtils - sendOrderEmail()');
-    try {
-        var isFutureOrder = (mailType == 'Auto Delivery Order Confirmation');
-        var orderPayload = prepareOrderPayload(order, isFutureOrder, mailType);
-        require('*/cartridge/scripts/utils/klaviyo/klaviyoUtils').trackEvent(order.getCustomerEmail(), orderPayload, mailType);
-    } catch (e) {
-        logger.error('sendOrderEmail() failed for order: ' + order.getOrderNo() + ', mailType: ' + mailType + '. Error: ' + e.message);
-    }
-}
-
-
 /**
  * Prepares the order in JSON format for email send.
  * @param order
@@ -369,6 +350,5 @@ function prepareOrderPayload(order, isFutureOrder, mailType) {
 }
 
 module.exports = {
-    sendOrderEmail      : sendOrderEmail,
-    prepareOrderPayload : prepareOrderPayload
+    prepareOrderPayload : prepareOrderPayload,
 };

cartridges/int_klaviyo_core/cartridge/scripts/utils/klaviyo/klaviyoTagUtils.js

@@ -5,7 +5,7 @@
  */
 
 
-// prepare viewed product event's data for klaviyo
+// Prepare viewed product event data for klaviyo
 
 function prepareViewedProductObject(klData) {
     var viewedProductObj = new Object();
@@ -23,7 +23,7 @@ function prepareViewedProductObject(klData) {
 }
 
 
-// prepare checkout product event's data for klaviyo
+// Prepare checkout product event data for klaviyo
 
 function prepareCheckoutObj(klData) {
     var checkoutObj = new Object();
@@ -35,7 +35,7 @@ function prepareCheckoutObj(klData) {
     return checkoutObj;
 }
 
-// prepare checkout add to cart  event's data for klaviyo
+// Prepare checkout add to cart event data for klaviyo
 
 function prepareAddToCartObj(klData) {
     var cartObj = new Object();
@@ -45,12 +45,11 @@ function prepareAddToCartObj(klData) {
     cartObj['Primary Categories'] = klData.primaryCategories;
     cartObj.$value = klData.basketGross;
     cartObj['Item Count'] = klData.itemCount.toString();
-    return cartObj;
+    return cartObj;
 }
 
 
-//  Setting customer basic details and information to klaviyo
-
+// Sends customer basic details and information to klaviyo
 
 function setCustomerDetails(currentUser) {
     var klCustomer = new Object();

cartridges/int_klaviyo_core/cartridge/scripts/utils/klaviyo/klaviyoUtils.js

@@ -16,7 +16,7 @@ var WHITELISTED_EVENTS = ['Searched Site', 'Viewed Product', 'Viewed Category',
  * (please see metadata/klaviyo-services.xml) and executes a get call with the payload generated from the
  * preparePayload() method.
  *
- * This is a track API call. Please refer https://www.klaviyo.com/docs/http-api
+ * This is a track API call. Please refer https://apidocs.klaviyo.com/reference/track-identify#track-get
  *
  * @param email
  * @param data
@@ -59,7 +59,7 @@ function trackEvent(email, data, event) {
 
 /**
  * Prepares Track API Payload Data in format per
- * https://www.klaviyo.com/docs/http-api
+ * https://apidocs.klaviyo.com/reference/track-identify#track-get
  *
  * @param email
  * @param data
@@ -107,7 +107,7 @@ function preparegiftCardObject(giftCard) {
 
 /**
  * Prepares Product Object and set necessary product details
- * https://www.klaviyo.com/docs/http-api
+ * https://apidocs.klaviyo.com/reference/track-identify#track-get
  *
  * @param lineItem
  * @param basketProduct
@@ -402,8 +402,9 @@ var buildDataLayer = function () {
 
     return klData;
 };
+
 /**
- * Prepare data's needs to be send to klaviyo in klData object for add to cart
+ * Prepare data to be sent to klaviyo in klData object for add to cart
  */
 var buildCartDataLayer = function () {
     var klData = {};

test/mocks/EmailUtils.js

@@ -8,7 +8,6 @@ var StringUtils = require('../mocks/dw/util/StringUtils');
 var LocalServiceRegistry = require('../mocks/dw/svc/LocalServiceRegistry');
 var URLUtils = require('../mocks/dw/web/URLUtils');
 var ProductMgr = require('../mocks/dw/catalog/ProductMgr');
-var EmailUtils = require('../mocks/EmailUtils');
 var BasketMgr = require('../mocks/dw/order/BasketMgr')
 var OrderMgr = require('../mocks/dw/order/OrderMgr');
 
@@ -29,7 +28,6 @@ describe('klaviyoUtils.js script', function() {
     'dw/util/StringUtils': StringUtils,
     'dw/svc/LocalServiceRegistry': LocalServiceRegistry,
     'dw/web/URLUtils': URLUtils,
-    '~/cartridge/scripts/utils/klaviyo/EmailUtils': EmailUtils,
     'dw/order/OrderMgr': OrderMgr,
     'dw/order/BasketMgr': BasketMgr,
     'dw/catalog/ProductMgr': ProductMgr