feat: add support for identity stitching for shopify pixel flow

src/v1/sources/shopify/config.js

@@ -1,6 +1,9 @@
 const path = require('path');
 const fs = require('fs');
 
+const commonCartTokenLocation = 'context.document.location.pathname';
+const commonCartTokenLocationContextual = 'context.cart_token';
+
 const PIXEL_EVENT_TOPICS = {
   CART_VIEWED: 'cart_viewed',
   PRODUCT_ADDED_TO_CART: 'product_added_to_cart',
@@ -61,6 +64,25 @@ const checkoutStartedCompletedEventMappingJSON = JSON.parse(
   ),
 );
 
+const pixelEventToCartTokenLocationMapping = {
+  cart_viewed: 'properties.cart_id',
+  checkout_address_info_submitted: commonCartTokenLocation,
+  checkout_contact_info_submitted: commonCartTokenLocation,
+  checkout_shipping_info_submitted: commonCartTokenLocation,
+  payment_info_submitted: commonCartTokenLocation,
+  checkout_started: commonCartTokenLocation,
+  checkout_completed: commonCartTokenLocation,
+};
+
+const serverEventToCartTokenLocationMapping = {
+  'Cart Update': 'properties.token',
+  'Checkout Started': commonCartTokenLocationContextual,
+  'Checkout Updated': commonCartTokenLocationContextual,
+  'Order Created': commonCartTokenLocationContextual,
+  'Order Fulfilled': commonCartTokenLocationContextual,
+  'Order Cancelled': commonCartTokenLocationContextual,
+};
+
 const INTEGERATION = 'SHOPIFY';
 
 module.exports = {
@@ -73,4 +95,6 @@ module.exports = {
   productViewedEventMappingJSON,
   productToCartEventMappingJSON,
   checkoutStartedCompletedEventMappingJSON,
+  pixelEventToCartTokenLocationMapping,
+  serverEventToCartTokenLocationMapping,
 };

src/v1/sources/shopify/pixelTransform.js

@@ -1,6 +1,9 @@
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const _ = require('lodash');
 const stats = require('../../../util/stats');
 const logger = require('../../../logger');
-const { removeUndefinedAndNullValues } = require('../../../v0/util');
+const { generateUUID, removeUndefinedAndNullValues } = require('../../../v0/util');
+const { RedisDB } = require('../../../util/redis/redisConnector');
 const {
   pageViewedEventBuilder,
   cartViewedEventBuilder,
@@ -11,7 +14,7 @@
   checkoutStepEventBuilder,
   searchEventBuilder,
 } = require('./pixelUtils');
-const { INTEGERATION, PIXEL_EVENT_TOPICS } = require('./config');
+const { INTEGERATION, PIXEL_EVENT_TOPICS, eventToCartTokenLocationMapping } = require('./config');
 
 const NO_OPERATION_SUCCESS = {
   outputToSource: {
@@ -21,6 +24,33 @@
   statusCode: 200,
 };
 
+const handleRedisOperations = async (inputEvent) => {
+  try {
+    const cartTokenLocation = eventToCartTokenLocationMapping[inputEvent.name];
+    if (!cartTokenLocation) {
+      logger.info(`Cart token location not found for event: ${inputEvent.name}`);
+      return;
+    }
+
+    const cartToken = _.get(inputEvent, cartTokenLocation);
+    if (!cartToken) {
+      logger.info(`Cart token not found in input event: ${inputEvent.name}`);
+      return;
+    }
+
+    const storedAnonymousIdInRedis = await RedisDB.getVal(cartToken);
+    if (!storedAnonymousIdInRedis) {
+      const anonymousId = generateUUID();
+      await RedisDB.setVal(cartToken, anonymousId);
+      logger.info(`New anonymousId set in Redis for cartToken: ${cartToken}`);
+    } else {
+      logger.info(`AnonymousId already exists in Redis for cartToken: ${cartToken}`);
+    }
+  } catch (error) {
+    logger.error(`Error handling Redis operations for event: ${inputEvent.name}`, error);
+  }
+};
+
 function processPixelEvent(inputEvent) {
   // eslint-disable-next-line @typescript-eslint/naming-convention
   const { name, query_parameters, clientId, data } = inputEvent;
@@ -48,13 +78,15 @@
     case PIXEL_EVENT_TOPICS.CHECKOUT_STARTED:
     case PIXEL_EVENT_TOPICS.CHECKOUT_COMPLETED:
       if (customer.id) message.userId = customer.id || '';
+      handleRedisOperations(inputEvent);
       message = checkoutEventBuilder(inputEvent);
       break;
     case PIXEL_EVENT_TOPICS.CHECKOUT_ADDRESS_INFO_SUBMITTED:
     case PIXEL_EVENT_TOPICS.CHECKOUT_CONTACT_INFO_SUBMITTED:
     case PIXEL_EVENT_TOPICS.CHECKOUT_SHIPPING_INFO_SUBMITTED:
     case PIXEL_EVENT_TOPICS.PAYMENT_INFO_SUBMITTED:
       if (customer.id) message.userId = customer.id || '';
+      handleRedisOperations(inputEvent);
       message = checkoutStepEventBuilder(inputEvent);
       break;
     case PIXEL_EVENT_TOPICS.SEARCH_SUBMITTED:

src/v1/sources/shopify/transform.js

@@ -1,6 +1,27 @@
 /* eslint-disable @typescript-eslint/naming-convention */
+const _ = require('lodash');
+const logger = require('../../../logger');
 const { processEventFromPixel } = require('./pixelTransform');
 const { process: processWebhookEvents } = require('../../../v0/sources/shopify/transform');
+const { RedisDB } = require('../../../util/redis/redisConnector');
+const { serverEventToCartTokenLocationMapping } = require('./config');
+
+const enrichServerSideResponseWithAnonymousId = async (response) => {
+  if (serverEventToCartTokenLocationMapping[response.event]) {
+    const cartTokenLocation = serverEventToCartTokenLocationMapping[response.event];
+    const cartToken = _.get(response, cartTokenLocation);
+    if (cartToken) {
+      try {
+        const anonymousId = await RedisDB.getVal(cartToken);
+        response.anonymousId = anonymousId;
+      } catch (error) {
+        logger.error(`Error getting value from Redis: ${error.message}`, error);
+      }
+    } else {
+      logger.info(`Cart token not found for event: ${response.event}`);
+    }
+  }
+};
 
 const process = async (inputEvent) => {
   const { event } = inputEvent;
@@ -15,6 +36,8 @@
   }
   // this is for common logic for server-side events processing for both pixel and tracker apps.
   const response = await processWebhookEvents(event);
+  // get value for anonymousId to enrich the event coming from the webhook.
+  enrichServerSideResponseWithAnonymousId(response);
   return response;
 };