chore: move webhook specific logic for v2 pixel, address comments

src/v0/sources/shopify/transform.js

@@ -292,4 +292,7 @@ module.exports = {
   processEvent,
   isIdentifierEvent,
   processIdentifierEvent,
+  identifyPayloadBuilder,
+  ecomPayloadBuilder,
+  trackPayloadBuilder,
 };

src/v1/sources/shopify/pixelTransform.js

@@ -80,12 +80,11 @@ function processPixelEvent(inputEvent) {
   return message;
 }
 
-const processEventV2 = async (event) => {
+const processEventFromPixel = async (event) => {
   const pixelEvent = processPixelEvent(event);
   return removeUndefinedAndNullValues(pixelEvent);
 };
 
 module.exports = {
-  processEventV2,
-  processPixelEvent,
+  processEventFromPixel,
 };

src/v1/sources/shopify/pixelWebhookEventTransform.js

@@ -0,0 +1,86 @@
+const lodash = require('lodash');
+const get = require('get-value');
+const stats = require('../../../util/stats');
+const { getShopifyTopic, extractEmailFromPayload } = require('../../../v0/sources/shopify/util');
+const {
+  identifyPayloadBuilder,
+  trackPayloadBuilder,
+  ecomPayloadBuilder,
+} = require('../../../v0/sources/shopify/transform');
+const { removeUndefinedAndNullValues, generateUUID } = require('../../../v0/util');
+const Message = require('../../../v0/sources/message');
+const {
+  INTEGERATION,
+  IDENTIFY_TOPICS,
+  ECOM_TOPICS,
+  SUPPORTED_TRACK_EVENTS,
+} = require('../../../v0/sources/shopify/config');
+
+const NO_OPERATION_SUCCESS = {
+  outputToSource: {
+    body: Buffer.from('OK').toString('base64'),
+    contentType: 'text/plain',
+  },
+  statusCode: 200,
+};
+
+const processPixelWebhookEvent = async (inputEvent, metricMetadata) => {
+  let message = new Message(INTEGERATION);
+  const event = lodash.cloneDeep(inputEvent);
+  const shopifyTopic = getShopifyTopic(event);
+  delete event.query_parameters;
+  switch (shopifyTopic) {
+    case IDENTIFY_TOPICS.CUSTOMERS_CREATE:
+    case IDENTIFY_TOPICS.CUSTOMERS_UPDATE:
+      message = identifyPayloadBuilder(event);
+      break;
+    case ECOM_TOPICS.ORDERS_CREATE:
+    case ECOM_TOPICS.ORDERS_UPDATE:
+    case ECOM_TOPICS.CHECKOUTS_CREATE:
+    case ECOM_TOPICS.CHECKOUTS_UPDATE:
+      message = ecomPayloadBuilder(event, shopifyTopic);
+      break;
+    case 'carts_update':
+      message = trackPayloadBuilder(event, shopifyTopic);
+      break;
+    default:
+      if (!SUPPORTED_TRACK_EVENTS.includes(shopifyTopic)) {
+        stats.increment('invalid_shopify_event', {
+          writeKey: metricMetadata.writeKey,
+          source: metricMetadata.source,
+          shopifyTopic: metricMetadata.shopifyTopic,
+        });
+        return NO_OPERATION_SUCCESS;
+      }
+      message = trackPayloadBuilder(event, shopifyTopic);
+      break;
+  }
+
+  if (message.userId) {
+    message.userId = String(message.userId);
+  }
+  message.anonymousId = generateUUID();
+
+  if (!get(message, 'traits.email')) {
+    const email = extractEmailFromPayload(event);
+    if (email) {
+      message.setProperty('traits.email', email);
+    }
+  }
+  message.setProperty(`integrations.${INTEGERATION}`, true);
+  message.setProperty('context.library', {
+    name: 'RudderStack Shopify Cloud',
+    version: '2.0.0',
+  });
+  message.setProperty('context.topic', shopifyTopic);
+  // attaching cart, checkout and order tokens in context object
+  message.setProperty(`context.cart_token`, event.cart_token);
+  message.setProperty(`context.checkout_token`, event.checkout_token);
+  if (shopifyTopic === 'orders_updated') {
+    message.setProperty(`context.order_token`, event.token);
+  }
+  message = removeUndefinedAndNullValues(message);
+  return message;
+};
+
+module.exports = { processPixelWebhookEvent };

src/v1/sources/shopify/transform.js

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/naming-convention */
 const { isDefinedAndNotNull } = require('../../../v0/util');
-const { processEventV2 } = require('./pixelTransform');
+const { processEventFromPixel } = require('./pixelTransform');
+const { processPixelWebhookEvent } = require('./pixelWebhookEventTransform');
 const {
   processEvent,
   isIdentifierEvent,
@@ -22,14 +23,10 @@ const process = async (inputEvent) => {
     if (pixelEventLabel) {
       // this is a event fired from the web pixel loaded on the browser
       // by the user interactions with the store.
-      const responseV2 = await processEventV2(event);
+      const responseV2 = await processEventFromPixel(event);
       return responseV2;
     }
-    const webhookEventResponse = await processEvent(event, metricMetadata, source);
-    webhookEventResponse.context.library = {
-      name: 'RudderStack Shopify Cloud',
-      version: '2.0.0',
-    };
+    const webhookEventResponse = await processPixelWebhookEvent(event, metricMetadata, source);
     return webhookEventResponse;
   }
   if (isIdentifierEvent(event)) {

test/integrations/sources/shopify/data.ts

@@ -1,4 +1,8 @@
 import { skip } from 'node:test';
+import utils from '../../../../src/v0/util';
+const defaultMockFns = () => {
+  jest.spyOn(utils, 'generateUUID').mockReturnValue('97fcd7b2-cc24-47d7-b776-057b7b199513');
+};
 
 const dummySourceConfig = {
   ID: 'dummy-source-id',
@@ -5546,14 +5550,17 @@ const v1ServerSideEventsScenarios = [
                     },
                   },
                   timestamp: '2024-09-17T07:29:02.000Z',
-                  anonymousId: '5d3e2cb6-4011-5c9c-b7ee-11bc1e905097',
+                  anonymousId: '97fcd7b2-cc24-47d7-b776-057b7b199513',
                 },
               ],
             },
           },
         ],
       },
     },
+    mockFns: () => {
+      defaultMockFns();
+    },
   },
   {
     name: 'shopify',
@@ -5758,14 +5765,17 @@ const v1ServerSideEventsScenarios = [
                       },
                     ],
                   },
-                  anonymousId: '5d3e2cb6-4011-5c9c-b7ee-11bc1e905097',
+                  anonymousId: '97fcd7b2-cc24-47d7-b776-057b7b199513',
                 },
               ],
             },
           },
         ],
       },
     },
+    mockFns: () => {
+      defaultMockFns();
+    },
   },
 ];