feat: moved userSchema to connection config in GARL vdmv2

src/v0/destinations/google_adwords_remarketing_lists/config.js

@@ -7,6 +7,7 @@ const CONFIG_CATEGORIES = {
   AUDIENCE_LIST: { type: 'audienceList', name: 'offlineDataJobs' },
   ADDRESSINFO: { type: 'addressInfo', name: 'addressInfo' },
 };
+const ADDRESS_INFO_ATTRIBUTES = ['firstName', 'lastName', 'country', 'postalCode'];
 const attributeMapping = {
   email: 'hashedEmail',
   phone: 'hashedPhoneNumber',
@@ -31,6 +32,7 @@ module.exports = {
   hashAttributes,
   offlineDataJobsMapping: MAPPING_CONFIG[CONFIG_CATEGORIES.AUDIENCE_LIST.name],
   addressInfoMapping: MAPPING_CONFIG[CONFIG_CATEGORIES.ADDRESSINFO.name],
+  ADDRESS_INFO_ATTRIBUTES,
   consentConfigMap,
   destType: 'google_adwords_remarketing_lists',
 };

src/v0/destinations/google_adwords_remarketing_lists/recordTransform.js

@@ -11,7 +11,11 @@ const {
   isEventSentByVDMV2Flow,
 } = require('../../util');
 const { populateConsentFromConfig } = require('../../util/googleUtils');
-const { populateIdentifiers, responseBuilder, getOperationAudienceId } = require('./util');
+const {
+  populateIdentifiersForRecordEvent,
+  responseBuilder,
+  getOperationAudienceId,
+} = require('./util');
 const { getErrorResponse, createFinalResponse } = require('../../util/recordUtils');
 const { offlineDataJobsMapping, consentConfigMap } = require('./config');
 
@@ -23,6 +27,7 @@ const processRecordEventArray = (
   developerToken,
   audienceId,
   typeOfList,
+  userSchema,
   isHashRequired,
   operationType,
 ) => {
@@ -36,10 +41,10 @@ const processRecordEventArray = (
     metadata.push(record.metadata);
   });
 
-  const userIdentifiersList = populateIdentifiers(
+  const userIdentifiersList = populateIdentifiersForRecordEvent(
     fieldsArray,
-    destination,
     typeOfList,
+    userSchema,
     isHashRequired,
   );
 
@@ -91,7 +96,7 @@ function preparepayload(events, config) {
   const { destination, message, metadata } = events[0];
   const accessToken = getAccessToken(metadata, 'access_token');
   const developerToken = getValueFromMessage(metadata, 'secret.developer_token');
-  const { audienceId, typeOfList, isHashRequired } = config;
+  const { audienceId, typeOfList, isHashRequired, userSchema } = config;
 
   const groupedRecordsByAction = lodash.groupBy(events, (record) =>
     record.message.action?.toLowerCase(),
@@ -110,6 +115,7 @@ function preparepayload(events, config) {
       developerToken,
       audienceId,
       typeOfList,
+      userSchema,
       isHashRequired,
       'remove',
     );
@@ -124,6 +130,7 @@ function preparepayload(events, config) {
       developerToken,
       audienceId,
       typeOfList,
+      userSchema,
       isHashRequired,
       'add',
     );
@@ -138,6 +145,7 @@ function preparepayload(events, config) {
       developerToken,
       audienceId,
       typeOfList,
+      userSchema,
       isHashRequired,
       'add',
     );
@@ -161,19 +169,26 @@ function preparepayload(events, config) {
 
 function processRecordInputsV0(groupedRecordInputs) {
   const { destination, message } = groupedRecordInputs[0];
-  const { audienceId, typeOfList, isHashRequired } = destination.Config;
+  const { audienceId, typeOfList, isHashRequired, userSchema } = destination.Config;
 
   return preparepayload(groupedRecordInputs, {
     audienceId: getOperationAudienceId(audienceId, message),
     typeOfList,
+    userSchema,
     isHashRequired,
   });
 }
 
 function processRecordInputsV1(groupedRecordInputs) {
-  const { connection } = groupedRecordInputs[0];
+  const { connection, message } = groupedRecordInputs[0];
   const { audienceId, typeOfList, isHashRequired } = connection.config.destination;
 
+  const identifiers = message?.identifiers;
+  let userSchema;
+  if (identifiers) {
+    userSchema = Object.keys(identifiers);
+  }
+
   const events = groupedRecordInputs.map((record) => ({
     ...record,
     message: {
@@ -185,6 +200,7 @@ function processRecordInputsV1(groupedRecordInputs) {
   return preparepayload(events, {
     audienceId,
     typeOfList,
+    userSchema,
     isHashRequired,
   });
 }

src/v0/destinations/google_adwords_remarketing_lists/transform.js

@@ -37,16 +37,16 @@ function extraKeysPresent(dictionary, keyList) {
 const createPayload = (message, destination) => {
   const { listData } = message.properties;
   const properties = ['add', 'remove'];
-  const { typeOfList, isHashRequired } = destination.Config;
+  const { typeOfList, userSchema, isHashRequired } = destination.Config;
 
   let outputPayloads = {};
   const typeOfOperation = Object.keys(listData);
   typeOfOperation.forEach((key) => {
     if (properties.includes(key)) {
       const userIdentifiersList = populateIdentifiers(
         listData[key],
-        destination,
         typeOfList,
+        userSchema,
         isHashRequired,
       );
       if (userIdentifiersList.length === 0) {

src/v0/destinations/google_adwords_remarketing_lists/util.js

@@ -18,6 +18,7 @@
   TYPEOFLIST,
   BASE_ENDPOINT,
   hashAttributes,
+  ADDRESS_INFO_ATTRIBUTES,
 } = require('./config');
 
 const hashEncrypt = (object) => {
@@ -68,14 +69,13 @@
  * Logics: Here we are creating an array with all the attributes provided in the add/remove array
  * inside listData.
  * @param {Array} attributeArray rudder event message properties listData add
- * @param {object} Config rudder event destination
  * @param {string} typeOfList
+ * @param {Array<string>} userSchema
  * @param {boolean} isHashRequired
  * @returns
  */
-const populateIdentifiers = (attributeArray, { Config }, typeOfList, isHashRequired) => {
+const populateIdentifiers = (attributeArray, typeOfList, userSchema, isHashRequired) => {
   const userIdentifier = [];
-  const { userSchema } = Config;
   let attribute;
   if (TYPEOFLIST[typeOfList]) {
     attribute = TYPEOFLIST[typeOfList];
@@ -115,6 +115,40 @@
   return userIdentifier;
 };
 
+const populateIdentifiersForRecordEvent = (
+  identifiersArray,
+  typeOfList,
+  userSchema,
+  isHashRequired,
+) => {
+  const userIdentifiers = [];
+
+  if (isDefinedAndNotNullAndNotEmpty(identifiersArray)) {
+    // traversing through every element in the add array
+    identifiersArray.forEach((identifiers) => {
+      if (isHashRequired) {
+        hashEncrypt(identifiers);
+      }
+      if (TYPEOFLIST[typeOfList] && identifiers[TYPEOFLIST[typeOfList]]) {
+        userIdentifiers.push({ [TYPEOFLIST[typeOfList]]: identifiers[TYPEOFLIST[typeOfList]] });
+      } else {
+        Object.entries(attributeMapping).forEach(([key, mappedKey]) => {
+          if (identifiers[key] && userSchema.includes(key))
+            userIdentifiers.push({ [mappedKey]: identifiers[key] });
+        });
+        const addressInfo = constructPayload(identifiers, addressInfoMapping);
+        if (
+          isDefinedAndNotNullAndNotEmpty(addressInfo) &&
+          (userSchema.includes('addressInfo') ||
+            userSchema.some((schema) => ADDRESS_INFO_ATTRIBUTES.includes(schema)))
+        )
+          userIdentifiers.push({ addressInfo });
+      }
+    });
+  }
+  return userIdentifiers;
+};
+
 const getOperationAudienceId = (audienceId, message) => {
   let operationAudienceId = audienceId;
   const mappedToDestination = get(message, MappedToDestinationKey);
@@ -132,4 +166,5 @@
   populateIdentifiers,
   responseBuilder,
   getOperationAudienceId,
+  populateIdentifiersForRecordEvent,
 };

src/v0/destinations/google_adwords_remarketing_lists/util.test.js

@@ -199,8 +199,8 @@ describe('GARL utils test', () => {
       const { typeOfList, isHashRequired } = baseDestination.Config;
       const identifier = populateIdentifiers(
         attributeArray,
-        baseDestination,
         typeOfList,
+        baseDestination.Config.userSchema,
         isHashRequired,
       );
       expect(identifier).toEqual(hashedArray);

test/integrations/destinations/google_adwords_remarketing_lists/router/data.ts

@@ -1,5 +1,5 @@
 import { rETLAudienceRouterRequest } from './audience';
-import { rETLRecordRouterRequest } from './record';
+import { rETLRecordRouterRequest, rETLRecordRouterRequestVDMv2 } from './record';
 import { API_VERSION } from '../../../../../src/v0/destinations/google_adwords_remarketing_lists/config';
 
 export const data = [
@@ -732,4 +732,120 @@
       },
     },
   },
+  {
+    name: 'google_adwords_remarketing_lists record event tests VDMv2',
+    description: 'Test 1',
+    feature: 'router',
+    module: 'destination',
+    version: 'v0',
+    input: {
+      request: {
+        body: rETLRecordRouterRequestVDMv2,
+        method: 'POST',
+      },
+    },
+    output: {
+      response: {
+        status: 200,
+        body: {
+          output: [
+            {
+              batchedRequest: [
+                {
+                  version: '1',
+                  type: 'REST',
+                  method: 'POST',
+                  endpoint: `https://googleads.googleapis.com/${API_VERSION}/customers/7693729833/offlineUserDataJobs`,
+                  headers: {
+                    Authorization: 'Bearer default-accessToken',
+                    'Content-Type': 'application/json',
+                  },
+                  params: {
+                    listId: '7090784486',
+                    customerId: '7693729833',
+                    consent: {
+                      adPersonalization: 'UNSPECIFIED',
+                      adUserData: 'UNSPECIFIED',
+                    },
+                  },
+                  body: {
+                    JSON: {
+                      operations: [
+                        {
+                          create: {
+                            userIdentifiers: [
+                              {
+                                hashedEmail:
+                                  'd3142c8f9c9129484daf28df80cc5c955791efed5e69afabb603bc8cb9ffd419',
+                              },
+                              {
+                                hashedPhoneNumber:
+                                  '8846dcb6ab2d73a0e67dbd569fa17cec2d9d391e5b05d1dd42919bc21ae82c45',
+                              },
+                              {
+                                addressInfo: {
+                                  hashedFirstName:
+                                    '9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08',
+                                  hashedLastName:
+                                    'dcf000c2386fb76d22cefc0d118a8511bb75999019cd373df52044bccd1bd251',
+                                  countryCode: 'US',
+                                  postalCode: '1245',
+                                },
+                              },
+                            ],
+                          },
+                        },
+                      ],
+                    },
+                    JSON_ARRAY: {},
+                    XML: {},
+                    FORM: {},
+                  },
+                  files: {},
+                },
+              ],
+              metadata: [
+                {
+                  attemptNum: 1,
+                  destinationId: 'default-destinationId',
+                  dontBatch: false,
+                  secret: {
+                    access_token: 'default-accessToken',
+                  },
+                  sourceId: 'default-sourceId',
+                  userId: 'default-userId',
+                  workspaceId: 'default-workspaceId',
+                  jobId: 1,
+                },
+              ],
+              batched: true,
+              statusCode: 200,
+              destination: {
+                Config: {
+                  rudderAccountId: '258Yea7usSKNpbkIaesL9oJ9iYw',
+                  audienceId: '7090784486',
+                  customerId: '7693729833',
+                  loginCustomerId: '',
+                  subAccount: false,
+                },
+                DestinationDefinition: {
+                  Config: {},
+                  DisplayName: 'GOOGLE_ADWORDS_REMARKETING_LISTS',
+                  ID: '1aIXqM806xAVm92nx07YwKbRrO9',
+                  Name: 'GOOGLE_ADWORDS_REMARKETING_LISTS',
+                },
+                Enabled: true,
+                ID: '1mMy5cqbtfuaKZv1IhVQKnBdVwe',
+                IsConnectionEnabled: true,
+                IsProcessorEnabled: true,
+                Name: 'GOOGLE_ADWORDS_REMARKETING_LISTS',
+                Transformations: [],
+                WorkspaceID: '1TSN08muJTZwH8iCDmnnRt1pmLd',
+              },
+            },
+          ],
+        },
+      },
+    },
+  },
 ];