use productEquals to compare products in o2m

Author: tkostuch

src/platform/magento2/helpers/productChecksum.js

@@ -0,0 +1,52 @@
+const { sha3_224 } = require('js-sha3')
+const get = require('lodash/get')
+const flow = require('lodash/flow')
+const cloneDeep = require('lodash/cloneDeep')
+
+const replaceNumberToString = obj => {
+  Object.keys(obj).forEach(key => {
+    if (obj[key] !== null && typeof obj[key] === 'object') {
+      return replaceNumberToString(obj[key]);
+    } else if (typeof obj[key] === 'number') {
+      obj[key] = String(obj[key]);
+    }
+  });
+  return obj;
+}
+
+const transformToArray = value => Array.isArray(value) ? value : Object.values(value)
+
+const getProductOptions = (product, optionsName) => {
+  return flow([
+    get,
+    cloneDeep,
+    transformToArray,
+    replaceNumberToString
+  ])(product, `product_option.extension_attributes.${optionsName}`, [])
+}
+
+const getDataToHash = (product) => {
+  if (!product.product_option) {
+    return null
+  }
+
+  const supportedProductOptions = ['bundle_options', 'custom_options', 'configurable_item_options']
+
+  // returns first options that has array with options
+  for (let optionName of supportedProductOptions) {
+    const options = getProductOptions(product, optionName)
+    if (options.length) {
+      return options
+    }
+  }
+
+  // if there are options that are not supported then just return all options
+  return product.product_option
+}
+
+const productChecksum = (product) => sha3_224(JSON.stringify(getDataToHash(product)))
+
+module.exports = {
+  getProductOptions,
+  productChecksum
+}

src/platform/magento2/helpers/productsEquals.js

@@ -0,0 +1,93 @@
+const { getProductOptions, productChecksum } = require('./productChecksum');
+
+// 'id' check
+const getServerItemId = (product) =>
+  product.server_item_id || product.item_id
+const isServerIdsEquals = (product1, product2) => {
+  const product1ItemId = getServerItemId(product1)
+  const product2ItemId = getServerItemId(product2)
+
+  const areItemIdsDefined = product1ItemId !== undefined && product2ItemId !== undefined
+
+  return areItemIdsDefined && product1ItemId === product2ItemId
+}
+
+// 'checksum' check
+const getChecksum = (product) => {
+  if (product.checksum) {
+    return product.checksum
+  }
+  return productChecksum(product)
+}
+const isChecksumEquals = (product1, product2) =>
+  getChecksum(product1) === getChecksum(product2)
+
+// 'sku' check
+const isSkuEqual = (product1, product2) =>
+  String(product1.sku) === String(product2.sku)
+
+/**
+ * Returns product equality check function
+ * @param checkName - determines what type of check we want to do
+ */
+const getCheckFn = (checkName) => {
+  switch (checkName) {
+    case 'id': {
+      return isServerIdsEquals
+    }
+    case 'checksum': {
+      return isChecksumEquals
+    }
+    case 'sku': {
+      return isSkuEqual
+    }
+    default: {
+      return isSkuEqual
+    }
+  }
+}
+
+/**
+ * It passes all types of checks and returns the first passed. The order of checks matters!
+ */
+const makeCheck = (product1, product2, checks) => {
+  for (let checkName of checks) {
+    const fn = getCheckFn(checkName)
+    if (fn(product1, product2)) {
+      return true
+    }
+  }
+  return false
+}
+
+const productsEquals = (product1, product2) => {
+  if (!product1 || !product2) {
+    return false
+  }
+
+  const check = makeCheck.bind(null, product1, product2)
+
+  if (getProductOptions(product1, 'bundle_options').length || getProductOptions(product2, 'bundle_options').length) {
+    // bundle options skus are merged into one sku so we can't rely on 'sku'
+    // by default we want to check server_item_id ('id'), we can also use 'checksum'
+    return check(['id', 'checksum'])
+  }
+
+  if (getProductOptions(product1, 'custom_options').length || getProductOptions(product2, 'custom_options').length) {
+    // in admin panel we can add different sku for specific custom option so we can't rely on 'sku'
+    // by default we want to check server_item_id ('id'), we can also use 'checksum'
+    return check(['id', 'checksum'])
+  }
+
+  if (getProductOptions(product1, 'configurable_item_options').length || getProductOptions(product2, 'configurable_item_options').length) {
+    // 'sku' should be uniq for configurable products
+    // we can't check 'id' because it is the same when user edit product in microcart, so it can give wrong result
+    return check(['sku'])
+  }
+
+  // by default we want to check if server_item_id is equal and check sku as fallback
+  // this is for 'simple' and 'group' products
+  return check(['id', 'sku'])
+}
+
+module.exports = productsEquals

src/platform/magento2/o2m.js

@@ -15,6 +15,7 @@ if (fs.existsSync('../../models/order.schema.extension.json')) {
   orderSchemaExtension = require('../../models/order.schema.extension.json')
 }
 const validate = ajv.compile(merge(orderSchema, orderSchemaExtension));
+const productsEquals = require('./helpers/productsEquals')
 
 function isNumeric (val) {
   return Number(parseFloat(val)).toString() === val;
@@ -107,9 +108,7 @@ function processSingleOrder (orderData, config, job, done, logger = console) {
       logger.info(THREAD_ID + '> ... and serverItems', serverItems)
 
       for (const clientItem of clientItems) {
-        const serverItem = serverItems.find((itm) => {
-          return itm.sku === clientItem.sku || itm.sku.indexOf(clientItem.sku + '-') >= 0 /* bundle products */
-        })
+        const serverItem = serverItems.find(itm => productsEquals(itm, clientItem))
         if (!serverItem) {
           logger.info(THREAD_ID + '< No server item for ' + clientItem.sku)
           syncPromises.push(api.cart.update(null, cartId, { // use magento API
@@ -134,9 +133,7 @@ function processSingleOrder (orderData, config, job, done, logger = console) {
 
       for (const serverItem of serverItems) {
         if (serverItem) {
-          const clientItem = clientItems.find((itm) => {
-            return itm.sku === serverItem.sku || serverItem.sku.indexOf(itm.sku + '-') >= 0 /* bundle products */
-          })
+          const clientItem = clientItems.find(itm => productsEquals(itm, serverItem))
           if (!clientItem) {
             logger.info(THREAD_ID + '< No client item for ' + serverItem.sku + ', removing from server cart') // use magento API
             syncPromises.push(api.cart.delete(null, cartId, { // delete server side item if not present if client's cart