Adding custom property to Epsilon Action (#3217)

Author: joe-ayoub-segment

packages/destination-actions/src/destinations/epsilon/sendEvent/__tests__/__snapshots__/snapshot.test.ts.snap

@@ -21,6 +21,7 @@ Object {
       "dtmc_tms": 9,
       "idfa": "q05uljg*(jGG",
       "idfv": "q05uljg*(jGG",
+      "testType": "q05uljg*(jGG",
     },
     "version": "q05uljg*(jGG",
   },

packages/destination-actions/src/destinations/epsilon/sendEvent/__tests__/index.test.ts

@@ -385,4 +385,85 @@ describe('Epsilon.send', () => {
     expect(response.length).toBe(1)
     expect(response[0].status).toBe(200)
   })
+
+  it('Should include customProperties field data correctly', async () => {
+    const payload2 = {
+      ...payload,
+      event: 'Custom Event 1',
+      properties: {
+        ...payload.properties,
+        dtm_event: 'custom',
+        custom_properties: {
+          str: "string",
+          num: 203,
+          bool: true
+        }
+      }
+    }
+
+    const event = createTestEvent(payload2)
+
+    const requestBody = {
+      id: 'msg_123',
+      jsonrpc: '2.0',
+      method: 'syncEvent',
+      params: {
+        appId: 'com.test.app',
+        dtm_event: 'Custom Event 1',
+        version: '1.0.0',
+        eventData: {
+          str: "string",
+          num: 203,
+          bool: true,
+          dtmc_tms: 9,
+          dtm_cid: 'test_cid',
+          dtm_cmagic: 'test_cmagic',
+          dtm_fid: 'test_fid',
+          dtm_promo_id: 'test_promo_id',
+          idfa: 'advertising_id_1',
+          idfv: 'device_id_1',
+          dtm_user_agent: 'dtm_user_agent_1',
+          dtm_user_ip: '8.8.8.8',
+          dtm_email_hash: 'f660ab912ec121d1b1e928a0bb4bc61b15f5ad44d5efdc4e1c92a25e99b8e44a',
+          dtm_mobile_hash: '4cc4f148d2a6e6d5def6cf6e1205b5b4701f7ff63e298ce5104e0cd6b86b97aa',
+          dtm_user_id: 'user_id_1',
+          dtmc_department: 'Test Product Department',
+          dtmc_category: 'test_product_category_1',
+          dtmc_sub_category: 'test_product_sub_category_1',
+          dtmc_product_id: 'test_product_id_1',
+          dtmc_brand: 'test_product_brand_1',
+          dtmc_upc: 'test_upc_1',
+          dtmc_mpn: 'test_mpn_1',
+          dtmc_transaction_id: 'test_order_id_1',
+          dtm_conv_val: 100,
+          dtm_items: [
+            {
+              product_id: 'test_product_id_1',
+              item_amount: 100,
+              item_quantity: 1,
+              item_discount: 20
+            }
+          ],
+          dtm_conv_curr: 'USD',
+          dtmc_conv_type: 'test_order_type_1',
+          dtmc_conv_store_location: 'test_store_location_1'
+        }
+      }
+    }
+
+    nock(domain).post(path, requestBody).reply(200)
+
+    const response = await testDestination.testAction('sendEvent', {
+      event,
+      settings,
+      useDefaultMappings: true,
+      mapping: {
+        ...mapping, 
+        customProperties: {'@path': '$.properties.custom_properties'}
+      }
+    })
+
+    expect(response.length).toBe(1)
+    expect(response[0].status).toBe(200)
+  })
 })

packages/destination-actions/src/destinations/epsilon/sendEvent/fields.ts

@@ -414,6 +414,14 @@ export const deviceType: InputField = {
   default: { '@path': '$.context.device.type' }
 }
 
+export const customProperties: InputField = {
+  label: 'Custom Properties',
+  description: 'Add custom properties to the event.',
+  type: 'object',
+  defaultObjectUI: 'keyvalue',
+  required: false
+}
+
 export const standardFields = {
   id,
   appId,

packages/destination-actions/src/destinations/epsilon/sendEvent/generated-types.ts

@@ -17,6 +17,7 @@ import {
   dtm_conv_curr,
   dtmc_conv_type,
   dtmc_conv_store_location,
+  customProperties,
   customEventName
 } from './fields'
 import { URL } from './constants'
@@ -41,7 +42,8 @@ const action: ActionDefinition<Settings, Payload> = {
     dtm_conv_curr,
     dtmc_conv_type,
     dtmc_conv_store_location,
-    customEventName
+    customEventName,
+    customProperties
   },
   perform: (request, { payload, settings }) => {
     const {
@@ -66,6 +68,7 @@ const action: ActionDefinition<Settings, Payload> = {
       dtmc_conv_type,
       dtmc_conv_store_location,
       customEventName,
+      customProperties,
       identifiers: {
         deviceID,
         advertisingId,
@@ -80,6 +83,7 @@ const action: ActionDefinition<Settings, Payload> = {
     const { dtm_cid, dtm_cmagic } = settings
 
     let eventData: BaseEventData | NonTransactionEventData | TransactionEventData = {
+      ...customProperties, // Spread customProperties first so it can't override more important attributes
       dtmc_tms: 9,
       dtm_cid: dtm_cid.trim(),
       dtm_cmagic,
@@ -97,7 +101,7 @@ const action: ActionDefinition<Settings, Payload> = {
       dtm_mobile_hash: dtm_mobile_hash
         ? processHashing(dtm_mobile_hash, 'sha256', 'hex', (value: string) => value?.trim().toLowerCase())
         : undefined,
-      dtm_user_id
+      dtm_user_id,
     }
 
     switch (dtm_event) {