Merge pull request #89 from scheduleonce/technocrats/ONCEHUB-94733

feature: ONCEHUB-94733: Block PAGE calls for mixpanel destination

Author: SoniRani

src/services/destination/preTransformation.ts

@@ -13,12 +13,18 @@ export class DestinationPreTransformationService {
       (event: ProcessorTransformationRequest | RouterTransformationRequestData) => {
         // look for traits under every object in file v0\util\data\GenericFieldMapping.json like
         // "traits": ["traits", "context.traits"]
-        const destination = event?.destination?.DestinationDefinition?.Name;        
+        const destination = event?.destination?.DestinationDefinition?.Name;
         let parsedEvent = oncehubTransformer(destination, event);
-        parsedEvent.request = { query: reqParams };
+        if (parsedEvent) {
+          parsedEvent.request = { query: reqParams };
+        }
         return parsedEvent;
       },
     );
-    return eventsProcessed;
+    // Filter out any undefined or null events after processing
+    // This is important to ensure that we only return valid events to the next step in the pipeline
+    const filteredEvents = eventsProcessed.filter((event: any) => !!event);
+
+    return filteredEvents;
   }
 }

src/util/oncehub-custom-transformer.js

@@ -1,75 +1,93 @@
 const { EventType } = require('../constants');
 
 const getPIIDestinationList = () => {
-    return (process.env.WHITELIST_PII_DESTINATION || "customerio")
-      .trim()
-      .split(",");
-  };
-  
-  const doesEventContainsTraits = event => {
-    return event && event.message && event.message.traits;
-  };
-  
-  const doesEventContainContextTraits = event => {
-    return event && event.message && event.message.context  && event.message.context.traits;
-  };
+  return (process.env.WHITELIST_PII_DESTINATION || 'customerio').trim().split(',');
+};
+
+const doesEventContainsTraits = (event) => {
+  return event && event.message && event.message.traits;
+};
+
+const doesEventContainContextTraits = (event) => {
+  return event && event.message && event.message.context && event.message.context.traits;
+};
+
+const getPageEventBlockedDestinationsList = () => {
+  return (process.env.BLOCKED_PAGE_DESTINATIONS || 'mp').trim().split(',');
+};
 
 const handleFirstLoginGA4Property = (destination, event, traits) => {
   // delete firstLoginGA4 property from traits when destination is not GA4
   if (destination !== 'ga4') {
     delete traits.firstLoginGA4;
     return;
-      }
+  }
 
   // add firstLoginGA4 property in traits when Identify call is for GA4 destination
   if (event.message.type === EventType.IDENTIFY) {
     traits.firstLoginGA4 = true;
     traits.value = 0;
-    }
+  }
+};
 
-  };
-
-  const changeDateFormatForCustomerio = (contextTraitsPresent, eventTraitsPresent,checkDestinationList, event) => {
-    if (checkDestinationList) {
-      if (contextTraitsPresent) {
-        // eslint-disable-next-line no-param-reassign
-        event.message.context.traits.accountCreatedDate = Math.floor(
-          Date.parse(event.message.context.traits.accountCreatedDate) / 1000,
-        );
-      }
-      if (eventTraitsPresent) {
-        // eslint-disable-next-line no-param-reassign
-        event.message.traits.accountCreatedDate = Math.floor(
-          Date.parse(event.message.traits.accountCreatedDate) / 1000,
-        );
-      }
-    }
-  };
-
-  const oncehubTransformer = (destination, event) => {
-    destination= destination.toString().toLowerCase();
-    const contextTraitsPresent = doesEventContainContextTraits(event);
-    const eventTraitsPresent = doesEventContainsTraits(event);
-    const checkDestinationList=getPIIDestinationList().includes(destination);
-    changeDateFormatForCustomerio(contextTraitsPresent, eventTraitsPresent,checkDestinationList,event);
-  
-    if (!checkDestinationList && eventTraitsPresent) {
-      // eslint-disable-next-line no-param-reassign
-      delete event.message.traits.email;
+const changeDateFormatForCustomerio = (
+  contextTraitsPresent,
+  eventTraitsPresent,
+  checkDestinationList,
+  event,
+) => {
+  if (checkDestinationList) {
+    if (contextTraitsPresent) {
       // eslint-disable-next-line no-param-reassign
-      delete event.message.traits.firstName;
+      event.message.context.traits.accountCreatedDate = Math.floor(
+        Date.parse(event.message.context.traits.accountCreatedDate) / 1000,
+      );
+    }
+    if (eventTraitsPresent) {
       // eslint-disable-next-line no-param-reassign
-      delete event.message.traits.lastName;
+      event.message.traits.accountCreatedDate = Math.floor(
+        Date.parse(event.message.traits.accountCreatedDate) / 1000,
+      );
+    }
+  }
+};
+
+const oncehubTransformer = (destination, event) => {
+  destination = destination.toString().toLowerCase();
+  const contextTraitsPresent = doesEventContainContextTraits(event);
+  const eventTraitsPresent = doesEventContainsTraits(event);
+  const checkDestinationList = getPIIDestinationList().includes(destination);
+  const checkPageEventBlockedDestination =
+    getPageEventBlockedDestinationsList().includes(destination);
+  if (event.message.type === EventType.PAGE && checkPageEventBlockedDestination) {
+    // eslint-disable-next-line no-param-reassign
+    return null;
+  }
+
+  changeDateFormatForCustomerio(
+    contextTraitsPresent,
+    eventTraitsPresent,
+    checkDestinationList,
+    event,
+  );
+
+  if (!checkDestinationList && eventTraitsPresent) {
+    // eslint-disable-next-line no-param-reassign
+    delete event.message.traits.email;
+    // eslint-disable-next-line no-param-reassign
+    delete event.message.traits.firstName;
+    // eslint-disable-next-line no-param-reassign
+    delete event.message.traits.lastName;
 
     if (contextTraitsPresent) {
-        // eslint-disable-next-line no-param-reassign
-        delete event.message.context.traits.email;
-        // eslint-disable-next-line no-param-reassign
-        delete event.message.context.traits.firstName;
-        // eslint-disable-next-line no-param-reassign
-        delete event.message.context.traits.lastName;
-      }
+      // eslint-disable-next-line no-param-reassign
+      delete event.message.context.traits.email;
+      // eslint-disable-next-line no-param-reassign
+      delete event.message.context.traits.firstName;
+      // eslint-disable-next-line no-param-reassign
+      delete event.message.context.traits.lastName;
     }
+  }
 
   // Adding check for firstLoginGA4 property
   if (eventTraitsPresent) {
@@ -80,11 +98,12 @@ const handleFirstLoginGA4Property = (destination, event, traits) => {
     handleFirstLoginGA4Property(destination, event, event.message.context.traits);
   }
 
-    // eslint-disable-next-line no-console
-    // if(doesEventContainsTraits(event)) console.log("event log=>destination : ", JSON.stringify(destination), " , ==> event traits : ", JSON.stringify(event.message.traits), " , ==> event here : ",JSON.stringify(event));
-    return event;
-  };
-  
-  module.exports = {
-    oncehubTransformer
-  };
+  // eslint-disable-next-line no-console
+  // if(doesEventContainsTraits(event)) console.log("event log=>destination : ", JSON.stringify(destination), " , ==> event traits : ", JSON.stringify(event.message.traits), " , ==> event here : ",JSON.stringify(event));
+
+  return event;
+};
+
+module.exports = {
+  oncehubTransformer,
+};