[Sendgrid Lists] - update to sendgrid lists destination (#2648)

* udpate to sendgrid lists destination

* fixing tests

* another test

Author: joe-ayoub-segment

packages/destination-actions/src/destinations/sendgrid-audiences/syncAudience/__tests__/index.test.ts

@@ -2,7 +2,7 @@ import nock from 'nock'
 import { createTestEvent, createTestIntegration, SegmentEvent, PayloadValidationError } from '@segment/actions-core'
 import Definition from '../../index'
 import { Settings } from '../../generated-types'
-import { validatePhone } from '../utils'
+import { validatePhone, toDateFormat } from '../utils'
 
 let testDestination = createTestIntegration(Definition)
 
@@ -58,10 +58,12 @@ const mapping = {
   external_audience_id: { '@path': '$.context.personas.external_audience_id' },
   segment_audience_key: { '@path': '$.context.personas.computation_key' },
   traits_or_props: { '@path': '$.traits' },
-  email: { '@path': '$.traits.email' },
-  anonymous_id: { '@path': '$.anonymousId' },
-  external_id: { '@path': '$.traits.external_id' },
-  phone_number_id: { '@path': '$.traits.phone' },
+  identifiers: {
+    email: { '@path': '$.traits.email' },
+    anonymous_id: { '@path': '$.anonymousId' },
+    external_id: { '@path': '$.traits.external_id' },
+    phone_number_id: { '@path': '$.traits.phone' }
+  },
   user_attributes: {
     first_name: { '@path': '$.traits.first_name' },
     last_name: { '@path': '$.traits.last_name' },
@@ -72,11 +74,14 @@ const mapping = {
     country: { '@path': '$.traits.country' },
     postal_code: { '@path': '$.traits.postal_code' }
   },
-  custom_fields: { '@path': '$.traits.custom_fields' },
+  custom_text_fields: { '@path': '$.traits.custom_text_fields' },
+  custom_number_fields: { '@path': '$.traits.custom_number_fields' },
+  custom_date_fields: { '@path': '$.traits.custom_date_fields' },
   enable_batching: true,
   batch_size: 200
 }
-const addExpectedPayload = {
+
+const upsertAddExpectedPayload = {
   list_ids: ['sg_audience_id_12345'],
   contacts: [
     {
@@ -98,7 +103,7 @@ describe('SendgridAudiences.syncAudience', () => {
   it('should upsert a single Contact and add it to a Sendgrid list correctly', async () => {
     const event = createTestEvent(addPayload)
 
-    nock('https://api.sendgrid.com').put('/v3/marketing/contacts', addExpectedPayload).reply(200, {})
+    nock('https://api.sendgrid.com').put('/v3/marketing/contacts', upsertAddExpectedPayload).reply(200, {})
     const responses = await testDestination.testAction('syncAudience', {
       event,
       settings,
@@ -122,18 +127,22 @@ describe('SendgridAudiences.syncAudience', () => {
         state: 'CA',
         country: 'US',
         postal_code: "N88EU",
-        custom_fields: {
+        custom_text_fields: {
           custom_field_1: 'custom_field_1_value',
-          custom_field_2: 2345,
-          custom_field_3: '2024-01-01T00:00:00.000Z',
           custom_field_4: false, // should be removed 
           custom_field_5: null // should be removed
+        },
+        custom_number_fields: {
+          custom_field_2: 2345
+        },
+        custom_date_fields: {
+          custom_field_3: '2024-01-01T00:00:00.000Z',
         }
       } 
     })
 
     const addExpectedPayloadWithAttributes = {
-      ...addExpectedPayload,
+      ...upsertAddExpectedPayload,
       contacts: [
         {
           email: '[email protected]',
@@ -151,7 +160,7 @@ describe('SendgridAudiences.syncAudience', () => {
           custom_fields: {
             custom_field_1: 'custom_field_1_value',
             custom_field_2: 2345,
-            custom_field_3: '2024-01-01T00:00:00.000Z'
+            custom_field_3: "01/01/2024"
           }
         }
       ]
@@ -179,7 +188,7 @@ describe('SendgridAudiences.syncAudience', () => {
     addPayloadEmailOnly.anonymousId = undefined
 
     const addExpectedPayloadEmailOnly = {
-      ...addExpectedPayload,
+      ...upsertAddExpectedPayload,
       contacts: [
         {
           email: '[email protected]'
@@ -203,7 +212,7 @@ describe('SendgridAudiences.syncAudience', () => {
   it('should upsert multiple Contacts and add them to a Sendgrid list correctly', async () => {
     const events = [createTestEvent(addPayload), createTestEvent(addPayload2)]
 
-    const addBatchExpectedPayload = {
+    const upsertAddBatchExpectedPayload = {
       list_ids: ['sg_audience_id_12345'],
       contacts: [
         {
@@ -221,7 +230,7 @@ describe('SendgridAudiences.syncAudience', () => {
       ]
     }
 
-    nock('https://api.sendgrid.com').put('/v3/marketing/contacts', addBatchExpectedPayload).reply(200, {})
+    nock('https://api.sendgrid.com').put('/v3/marketing/contacts', upsertAddBatchExpectedPayload).reply(200, {})
     const responses = await testDestination.testBatchAction('syncAudience', {
       events,
       settings,
@@ -235,6 +244,18 @@ describe('SendgridAudiences.syncAudience', () => {
   it('should remove a single Contact from a Sendgrid list correctly', async () => {
     const event = createTestEvent(removePayload)
 
+    const upsertNoAddExpectedPayload = {
+      list_ids: [],
+      contacts: [
+        {
+          email: '[email protected]',
+          external_id: 'some_external_id',
+          phone_number_id: '+353123456789',
+          anonymous_id: 'some_anonymous_id'
+        }
+      ]
+    }
+
     const deletePath = `/v3/marketing/lists/sg_audience_id_12345/contacts?contact_ids=contact_1_id`
 
     const searchQuery =
@@ -244,6 +265,8 @@ describe('SendgridAudiences.syncAudience', () => {
       result: [{ id: 'contact_1_id' }]
     }
 
+    nock('https://api.sendgrid.com').put('/v3/marketing/contacts', upsertNoAddExpectedPayload).reply(200, {})
+
     nock('https://api.sendgrid.com').post('/v3/marketing/contacts/search', searchQuery).reply(200, searchResponse)
 
     nock('https://api.sendgrid.com').delete(deletePath).reply(200, {})
@@ -255,14 +278,33 @@ describe('SendgridAudiences.syncAudience', () => {
       mapping
     })
 
-    expect(responses.length).toBe(2)
+    expect(responses.length).toBe(3)
     expect(responses[0].status).toBe(200)
     expect(responses[1].status).toBe(200)
+    expect(responses[2].status).toBe(200)
   })
 
   it('should remove multiple Contacts from a Sendgrid list correctly', async () => {
     const events = [createTestEvent(removePayload), createTestEvent(removePayload2)]
 
+    const upsertNoAddBatchExpectedPayload = {
+      list_ids: [],
+      contacts: [
+        {
+          email: '[email protected]',
+          external_id: 'some_external_id',
+          phone_number_id: '+353123456789',
+          anonymous_id: 'some_anonymous_id'
+        },
+        {
+          email: '[email protected]',
+          external_id: 'some_external_id2',
+          phone_number_id: '+353123456789',
+          anonymous_id: 'some_anonymous_id2'
+        }
+      ]
+    }
+
     const deletePath = `/v3/marketing/lists/sg_audience_id_12345/contacts?contact_ids=contact_1_id,contact_2_id`
 
     const searchQuery =
@@ -272,6 +314,8 @@ describe('SendgridAudiences.syncAudience', () => {
       result: [{ id: 'contact_1_id' }, { id: 'contact_2_id' }]
     }
 
+    nock('https://api.sendgrid.com').put('/v3/marketing/contacts', upsertNoAddBatchExpectedPayload).reply(200, {})
+
     nock('https://api.sendgrid.com').post('/v3/marketing/contacts/search', searchQuery).reply(200, searchResponse)
 
     nock('https://api.sendgrid.com').delete(deletePath).reply(200, {})
@@ -283,9 +327,10 @@ describe('SendgridAudiences.syncAudience', () => {
       mapping
     })
 
-    expect(responses.length).toBe(2)
+    expect(responses.length).toBe(3)
     expect(responses[0].status).toBe(200)
     expect(responses[1].status).toBe(200)
+    expect(responses[2].status).toBe(200)
   })
 
   it('should add and remove multiple Contacts from a Sendgrid list correctly', async () => {
@@ -305,7 +350,7 @@ describe('SendgridAudiences.syncAudience', () => {
       result: [{ id: 'contact_1_id' }, { id: 'contact_2_id' }]
     }
 
-    const addBatchExpectedPayload = {
+    const upsertAddBatchExpectedPayload = {
       list_ids: ['sg_audience_id_12345'],
       contacts: [
         {
@@ -323,7 +368,27 @@ describe('SendgridAudiences.syncAudience', () => {
       ]
     }
 
-    nock('https://api.sendgrid.com').put('/v3/marketing/contacts', addBatchExpectedPayload).reply(200, {})
+    const upsertNoAddBatchExpectedPayload = {
+      list_ids: [],
+      contacts: [
+        {
+          email: '[email protected]',
+          external_id: 'some_external_id',
+          phone_number_id: '+353123456789',
+          anonymous_id: 'some_anonymous_id'
+        },
+        {
+          email: '[email protected]',
+          external_id: 'some_external_id2',
+          phone_number_id: '+353123456789',
+          anonymous_id: 'some_anonymous_id2'
+        }
+      ]
+    }
+
+    nock('https://api.sendgrid.com').put('/v3/marketing/contacts', upsertAddBatchExpectedPayload).reply(200, {})
+
+    nock('https://api.sendgrid.com').put('/v3/marketing/contacts', upsertNoAddBatchExpectedPayload).reply(200, {})
 
     nock('https://api.sendgrid.com').post('/v3/marketing/contacts/search', searchQuery).reply(200, searchResponse)
 
@@ -336,10 +401,11 @@ describe('SendgridAudiences.syncAudience', () => {
       mapping
     })
 
-    expect(responses.length).toBe(3)
+    expect(responses.length).toBe(4)
     expect(responses[0].status).toBe(200)
     expect(responses[1].status).toBe(200)
     expect(responses[2].status).toBe(200)
+    expect(responses[3].status).toBe(200)
   })
 
   it('should retry upserting to add Contacts after Sendgrid initially rejects some emails', async () => {
@@ -351,7 +417,7 @@ describe('SendgridAudiences.syncAudience', () => {
 
     const events = [createTestEvent(addPayload), createTestEvent(badPayload)]
 
-    const addBatchExpectedPayload = {
+    const upsertAddBatchExpectedPayload = {
       list_ids: ['sg_audience_id_12345'],
       contacts: [
         {
@@ -388,7 +454,7 @@ describe('SendgridAudiences.syncAudience', () => {
       ]
     }
 
-    nock('https://api.sendgrid.com').put('/v3/marketing/contacts', addBatchExpectedPayload).reply(400, responseError)
+    nock('https://api.sendgrid.com').put('/v3/marketing/contacts', upsertAddBatchExpectedPayload).reply(400, responseError)
     nock('https://api.sendgrid.com').put('/v3/marketing/contacts', addBatchExpectedPayload2).reply(200, {})
 
     const responses = await testDestination.testBatchAction('syncAudience', {
@@ -419,7 +485,7 @@ describe('SendgridAudiences.syncAudience', () => {
         mapping
       })
     ).rejects.toThrowError(
-      new PayloadValidationError(`At least one of email, anonymous_id, external_id or phone_number_id is required`)
+      new PayloadValidationError(`No valid payloads found`)
     )
   })
 
@@ -456,6 +522,18 @@ describe('SendgridAudiences.syncAudience', () => {
       anonymousId: `some_anonymous_id_${i + 1}`
     }))
 
+    const upsertNoAddBatchExpectedPayload = {
+      list_ids: [],
+      contacts: Array.from({ length: 30 }, (_, i) => (
+        {
+          email: `test${i + 1}@gmail.com`,
+          external_id: `some_external_id_${i + 1}`,
+          phone_number_id: `+35312345678${i + 1}`,
+          anonymous_id: `some_anonymous_id_${i + 1}`
+        }
+      ))
+    }
+
     const events = payloads.map(createTestEvent)
 
     const searchQuery =
@@ -471,6 +549,8 @@ describe('SendgridAudiences.syncAudience', () => {
 
     const deletePath = `/v3/marketing/lists/sg_audience_id_12345/contacts?contact_ids=contact_1_id,contact_2_id,contact_3_id,contact_4_id,contact_5_id,contact_6_id,contact_7_id,contact_8_id,contact_9_id,contact_10_id,contact_11_id,contact_12_id,contact_13_id,contact_14_id,contact_15_id,contact_16_id,contact_17_id,contact_18_id,contact_19_id,contact_20_id,contact_21_id,contact_22_id,contact_23_id,contact_24_id,contact_25_id,contact_26_id,contact_27_id,contact_28_id,contact_29_id,contact_30_id`
 
+    nock('https://api.sendgrid.com').put('/v3/marketing/contacts', upsertNoAddBatchExpectedPayload).reply(200, {})
+
     nock('https://api.sendgrid.com').post('/v3/marketing/contacts/search', searchQuery).reply(200, searchResponse)
     nock('https://api.sendgrid.com').post('/v3/marketing/contacts/search', searchQuery2).reply(200, searchResponse2)
     nock('https://api.sendgrid.com').post('/v3/marketing/contacts/search', searchQuery3).reply(200, searchResponse3)
@@ -484,11 +564,12 @@ describe('SendgridAudiences.syncAudience', () => {
       mapping
     })
 
-    expect(responses.length).toBe(4)
+    expect(responses.length).toBe(5)
     expect(responses[0].status).toBe(200)
     expect(responses[1].status).toBe(200)
     expect(responses[2].status).toBe(200)
     expect(responses[3].status).toBe(200)
+    expect(responses[4].status).toBe(200)
   })
 
   it('should do multiple search and a multiple remove requests for large batch with many identifiers and more than 100 contacts', async () => {
@@ -503,6 +584,15 @@ describe('SendgridAudiences.syncAudience', () => {
       anonymousId: null
     }))
 
+    const upsertNoAddBatchExpectedPayload = {
+      list_ids: [],
+      contacts: Array.from({ length: 120 }, (_, i) => (
+        {
+          email: `test${i + 1}@gmail.com`
+        }
+      ))
+    }
+
     const events = payloads.map(createTestEvent)
 
     const searchQuery =
@@ -525,6 +615,8 @@ describe('SendgridAudiences.syncAudience', () => {
       (_, i) => `contact_${i + 101}_id`
     ).join(',')}`
 
+    nock('https://api.sendgrid.com').put('/v3/marketing/contacts', upsertNoAddBatchExpectedPayload).reply(200, {})
+
     nock('https://api.sendgrid.com').post('/v3/marketing/contacts/search', searchQuery).reply(200, searchResponse)
     nock('https://api.sendgrid.com').post('/v3/marketing/contacts/search', searchQuery2).reply(200, searchResponse2)
     nock('https://api.sendgrid.com').post('/v3/marketing/contacts/search', searchQuery3).reply(200, searchResponse3)
@@ -539,12 +631,13 @@ describe('SendgridAudiences.syncAudience', () => {
       mapping
     })
 
-    expect(responses.length).toBe(5)
+    expect(responses.length).toBe(6)
     expect(responses[0].status).toBe(200)
     expect(responses[1].status).toBe(200)
     expect(responses[2].status).toBe(200)
     expect(responses[3].status).toBe(200)
     expect(responses[4].status).toBe(200)
+    expect(responses[5].status).toBe(200)
   })
 
   it('phone number should be E.164', async () => {
@@ -556,4 +649,25 @@ describe('SendgridAudiences.syncAudience', () => {
     expect(validatePhone(badPhone)).toBe(false)
     expect(validatePhone(badPhone2)).toBe(false)
   })
+
+  it('dates are formatted correctly to Sendgrid', async () => {
+    const goodDate = "01-01-2024"
+    const goodDate2 = "01-24-2024"
+    const goodDate3 = '2024-01-01T00:00:00.000Z'
+    const goodDate4 = "01/24/2024" // default for ambiguous dates is US ISO 8601 format MM/DD/YYYY
+    const badDate = "13-01-2024"
+    const badDate2 = "24/01/2024"
+    const badDate3 = '+3531234567890678'
+
+    expect(toDateFormat(goodDate)).toBe("01/01/2024")
+    expect(toDateFormat(goodDate2)).toBe("01/24/2024")
+    expect(toDateFormat(goodDate3)).toBe("01/01/2024")
+    expect(toDateFormat(goodDate4)).toBe("01/24/2024")
+    expect(toDateFormat(badDate)).toBe(undefined)
+    expect(toDateFormat(badDate2)).toBe(undefined)
+    expect(toDateFormat(badDate3)).toBe(undefined)
+  })
+
+
+  
 })