feat: added backward compatability to support both old and new VDM

rudderlabs · Sep 5, 2024 · 9589ab7 · 9589ab7
1 parent 9a9340f
commit 9589ab7
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 8 deletions.
diff --git a/src/v0/destinations/fb_custom_audience/config.js b/src/v0/destinations/fb_custom_audience/config.js
@@ -4,6 +4,8 @@ function getEndPoint(audienceId) {
   return `${BASE_URL}/${audienceId}/users`;
 }
 
+const VDM_V2_SCHEMA_VERSION = '1.1';
+
 const schemaFields = [
   'EXTERN_ID',
   'EMAIL',
@@ -105,4 +107,5 @@ module.exports = {
   typeFields,
   subTypeFields,
   maxPayloadSize,
+  VDM_V2_SCHEMA_VERSION,
 };
diff --git a/src/v0/destinations/fb_custom_audience/recordTransform.js b/src/v0/destinations/fb_custom_audience/recordTransform.js
@@ -2,7 +2,7 @@
 const lodash = require('lodash');
 const get = require('get-value');
 const { InstrumentationError, ConfigurationError } = require('@rudderstack/integrations-lib');
-const { schemaFields } = require('./config');
+const { schemaFields, VDM_V2_SCHEMA_VERSION } = require('./config');
 const { MappedToDestinationKey } = require('../../../constants');
 const stats = require('../../../util/stats');
 const {
@@ -17,6 +17,7 @@ const {
   ensureApplicableFormat,
   getUpdatedDataElement,
   getSchemaForEventMappedToDest,
+  getSchemaForEventMappedToDestForVDMv2,
   batchingWithPayloadSize,
   responseBuilderSimple,
   getDataSource,
@@ -103,8 +104,15 @@ async function processRecordInputs(groupedRecordInputs) {
   const { destination, connection } = groupedRecordInputs[0];
   const { message } = groupedRecordInputs[0];
   const { accessToken, disableFormat, type, subType, isRaw, maxUserCount } = destination.Config;
-  const audienceId = connection?.config?.destination?.audienceId;
-  const isHashRequired = connection?.config?.destination?.isHashRequired;
+  let audienceId;
+  let isHashRequired;
+  if (connection?.config?.destination?.schemaVersion === VDM_V2_SCHEMA_VERSION) {
+    audienceId = connection?.config?.destination?.audienceId;
+    isHashRequired = connection?.config?.destination?.isHashRequired;
+  } else {
+    audienceId = destination.Config?.audienceId;
+    isHashRequired = destination.Config?.isHashRequired;
+  }
   const prepareParams = {
     access_token: accessToken,
   };
@@ -129,7 +137,11 @@ async function processRecordInputs(groupedRecordInputs) {
   // user schema validation
   let { userSchema } = destination.Config;
   if (mappedToDestination) {
-    userSchema = getSchemaForEventMappedToDest(message);
+    if (connection?.config?.destination?.schemaVersion === VDM_V2_SCHEMA_VERSION) {
+      userSchema = getSchemaForEventMappedToDestForVDMv2(message);
+    } else {
+      userSchema = getSchemaForEventMappedToDest(message);
+    }
   }
   if (!Array.isArray(userSchema)) {
     userSchema = [userSchema];

diff --git a/src/v0/destinations/fb_custom_audience/transform.js b/src/v0/destinations/fb_custom_audience/transform.js
@@ -12,12 +12,13 @@ const {
 const {
   prepareDataField,
   getSchemaForEventMappedToDest,
+  getSchemaForEventMappedToDestForVDMv2,
   batchingWithPayloadSize,
   generateAppSecretProof,
   responseBuilderSimple,
   getDataSource,
 } = require('./util');
-const { schemaFields, USER_ADD, USER_DELETE } = require('./config');
+const { schemaFields, USER_ADD, USER_DELETE, VDM_V2_SCHEMA_VERSION } = require('./config');
 
 const { MappedToDestinationKey } = require('../../../constants');
 const { processRecordInputs } = require('./recordTransform');
@@ -157,8 +158,16 @@ const processEvent = (message, destination, connection) => {
   const respList = [];
   let toSendEvents = [];
   let { userSchema } = destination.Config;
-  const { isHashRequired, maxUserCount } = destination.Config;
-  const audienceId = get(connection, 'config.destination.audienceId');
+  const { maxUserCount } = destination.Config;
+  let audienceId;
+  let isHashRequired;
+  if (connection?.config?.destination?.schemaVersion === VDM_V2_SCHEMA_VERSION) {
+    audienceId = connection?.config?.destination?.audienceId;
+    isHashRequired = connection?.config?.destination?.isHashRequired;
+  } else {
+    audienceId = destination.Config?.audienceId;
+    isHashRequired = destination.Config?.isHashRequired;
+  }
   if (!message.type) {
     throw new InstrumentationError('Message Type is not present. Aborting message.');
   }
@@ -182,7 +191,11 @@ const processEvent = (message, destination, connection) => {
 
   // If mapped to destination, use the mapped fields instead of destination userschema
   if (mappedToDestination) {
-    userSchema = getSchemaForEventMappedToDest(message);
+    if (connection?.config?.destination?.schemaVersion === VDM_V2_SCHEMA_VERSION) {
+      userSchema = getSchemaForEventMappedToDestForVDMv2(message);
+    } else {
+      userSchema = getSchemaForEventMappedToDest(message);
+    }
   }
 
   // When one single schema field is added in the webapp, it does not appear to be an array

diff --git a/src/v0/destinations/fb_custom_audience/util.js b/src/v0/destinations/fb_custom_audience/util.js
@@ -1,6 +1,7 @@
 const lodash = require('lodash');
 const sha256 = require('sha256');
 const crypto = require('crypto');
+const get = require('get-value');
 const jsonSize = require('json-size');
 const { InstrumentationError, ConfigurationError } = require('@rudderstack/integrations-lib');
 const { TransformationError } = require('@rudderstack/integrations-lib');
@@ -48,6 +49,19 @@ const batchingWithPayloadSize = (payload) => {
 };
 
 const getSchemaForEventMappedToDest = (message) => {
+  const mappedSchema = get(message, 'context.destinationFields');
+  if (!mappedSchema) {
+    throw new InstrumentationError(
+      'context.destinationFields is required property for events mapped to destination ',
+    );
+  }
+  // context.destinationFields has 2 possible values. An Array of fields or Comma seperated string with field names
+  let userSchema = Array.isArray(mappedSchema) ? mappedSchema : mappedSchema.split(',');
+  userSchema = userSchema.map((field) => field.trim());
+  return userSchema;
+};
+
+const getSchemaForEventMappedToDestForVDMv2 = (message) => {
   const mappedSchema = message.fields;
   if (!mappedSchema) {
     throw new InstrumentationError(
@@ -259,6 +273,7 @@ const responseBuilderSimple = (payload, audienceId) => {
 module.exports = {
   prepareDataField,
   getSchemaForEventMappedToDest,
+  getSchemaForEventMappedToDestForVDMv2,
   batchingWithPayloadSize,
   ensureApplicableFormat,
   getUpdatedDataElement,