All List Tests

Author: joe-ayoub-segment

packages/destination-actions/src/destinations/hubspot/upsertObject/__tests__/lists.test.ts

@@ -597,65 +597,6 @@ describe('Hubspot.upsertObject', () => {
 
       expect(responses.length).toBe(4)
     })
-
-    it('should error if more than 1 list is included in the same batch', async () => {
-      // To simplify this test properties and sensitive_properties are excluded
-      const modifiedPayload = { 
-        ...payload, 
-        properties: {    
-          contact_list_2: true,
-          email: '[email protected]'
-        }
-      } as SegmentEvent
-
-      const modifiedPayload2 = { 
-        ...payload, 
-        properties: {    
-          contact_list_3: true,
-          email: '[email protected]'
-        }
-      } as SegmentEvent
-
-      nock(HUBSPOT_BASE_URL)
-        .get(`/crm/v3/lists/object-type-id/contact/name/contact_list_2`)
-        .reply(400, {
-          status: 'error',
-          message: 'List does not exist with name contact_list_2 and object type ID 0-2.'
-        })
-
-      nock(HUBSPOT_BASE_URL)
-        .post('/crm/v3/lists', {name: "contact_list_2", objectTypeId: "contact", processingType: "MANUAL"})
-        .reply(200, {
-          list: {
-            listId: "21",
-            objectTypeId: "0-2",
-            name: "contact_list_2"
-          }
-        })
-
-      nock(HUBSPOT_BASE_URL)
-        .put(`/crm/v3/lists/21/memberships/add-and-remove`, {
-          recordIdsToAdd: ['62102303560', '999999898989'],
-          recordIdsToRemove: []
-        })
-        .reply(200)
-
-      nock(HUBSPOT_BASE_URL)
-        .post('/crm/v3/objects/contact/batch/upsert',
-          {inputs:[{idProperty:"email",id:"[email protected]",properties:{email:"[email protected]"}}, {idProperty:"email",id:"[email protected]",properties:{email:"[email protected]"}}]})
-        .reply(200, modifiedUpsertObjectResp)
-
-      const responses = await testDestination.testBatchAction('upsertObject', {
-        events: [modifiedPayload, modifiedPayload2],
-        settings,
-        useDefaultMappings: true,
-        mapping,
-        features: { 'actions-hubspot-lists-association-support': true }
-      })
-
-      expect(responses.length).toBe(4)
-    })
-
   })
 
   describe('Not an Engage Audience', () => {
@@ -876,5 +817,71 @@ describe('Hubspot.upsertObject', () => {
       expect(responses.length).toBe(6)
     })
 
+    it('should error if more than 1 list is included in the same batch', async () => {
+      // To simplify this test properties and sensitive_properties are excluded
+      const modifiedPayload = { 
+        ...payload, 
+        context: {}, 
+        properties: { 
+          email: '[email protected]',
+          list_details: {
+            connected_to_engage_audience: false,
+            should_create_list: true,
+            list_name: 'contact_list_2',
+            list_action: true
+          }
+        }
+      } as SegmentEvent
+
+      const modifiedPayload2 = { 
+        ...payload, 
+        context: {}, 
+        properties: { 
+          email: '[email protected]',
+          list_details: {
+            connected_to_engage_audience: false,
+            should_create_list: true,
+            list_name: 'contact_list_3', // different list name
+            list_action: true
+          }
+        }
+      } as SegmentEvent
+
+      const modifiedPayload3 = { 
+        ...payload, 
+        context: {}, 
+        properties: { 
+          email: '[email protected]',
+          list_details: {
+            connected_to_engage_audience: false,
+            should_create_list: true,
+            list_name: '', // empty string list name
+            list_action: true
+          }
+        }
+      } as SegmentEvent
+      
+      const modifiedMapping: JSONObject = {
+        ...mapping,
+        list_details: {
+          connected_to_engage_audience: { '@path': '$.properties.list_details.connected_to_engage_audience' },
+          should_create_list: { '@path': '$.properties.list_details.should_create_list' },
+          list_name: { '@path': '$.properties.list_details.list_name' },
+          list_action: { '@path': '$.properties.list_details.list_action' }
+        }
+      }
+
+      try{
+        await testDestination.testBatchAction('upsertObject', {
+            events: [modifiedPayload, modifiedPayload2, modifiedPayload3],
+            settings,
+            useDefaultMappings: true,
+            mapping: modifiedMapping,
+            features: { 'actions-hubspot-lists-association-support': true }
+        })
+      } catch (err) {
+        expect((err as Error).message).toBe('When updating List membership, all payloads must reference the same list. Found multiple lists in the batch: contact_list_2, contact_list_3')
+      }
+    })
   })
 })

packages/destination-actions/src/destinations/hubspot/upsertObject/functions/hubspot-list-functions.ts

@@ -1,5 +1,5 @@
 import { Client } from '../client'
-import { CachableList, PayloadWithFromId, AddRemoveFromListReq, EngageAudiencePayload } from '../types'
+import { CachableList, PayloadWithFromId, AddRemoveFromListReq, EngageAudiencePayload, PayloadListType } from '../types'
 import { StatsContext, RetryableError, PayloadValidationError } from '@segment/actions-core'
 import { SubscriptionMetadata } from '@segment/actions-core/destination-kit'
 import { getListFromCache, saveListToCache } from '../functions/cache-functions'
@@ -8,35 +8,58 @@ import { Payload } from '../generated-types'
 import { ENGAGE_AUDIENCE_COMPUTATION_CLASSES } from '../constants'
 
 export function getListName(payload: Payload): string | undefined {
-  if(isEngageAudiencePayload(payload)) {
-    const { computation_key } = payload as EngageAudiencePayload
-    return (payload?.list_details?.list_name || computation_key) as string | undefined
-  } else {
-    return payload?.list_details?.list_name
+  const listPayloadType = getListPayloadType(payload)
+  switch(listPayloadType) {
+    case 'is_not_audience_payload':
+      return undefined
+    case 'is_non_engage_audience_payload': {
+      const listName = payload?.list_details?.list_name?.trim() || undefined
+      return listName
+    }
+    case 'is_engage_audience_payload': {
+      const { computation_key } = payload as EngageAudiencePayload
+      return (payload?.list_details?.list_name || computation_key) as string | undefined
+    }
   }
 }
 
-export function isEngageAudiencePayload(payload: Payload): boolean {
+export function getListPayloadType(payload: Payload): PayloadListType {
   const {
-    list_details: { connected_to_engage_audience } = {},
+    list_details: { connected_to_engage_audience, list_action, list_name, should_create_list } = {},
     traits_or_props, 
     computation_class = '',
     computation_key = ''
   } = payload
 
-  return connected_to_engage_audience === true 
+  if (connected_to_engage_audience === true 
     && computation_key!== '' 
     && ENGAGE_AUDIENCE_COMPUTATION_CLASSES.includes(computation_class)
     && typeof traits_or_props === 'object' 
-    && typeof traits_or_props[computation_key] === 'boolean'
+    && typeof traits_or_props[computation_key] === 'boolean') {
+    return 'is_engage_audience_payload'
+  } else if (connected_to_engage_audience === false
+    && typeof list_action === 'boolean'
+    && typeof list_name === 'string' 
+    && list_name.trim().length > 0
+    && typeof should_create_list === 'boolean'
+  ) {
+    return 'is_non_engage_audience_payload'
+  }
+  return 'is_not_audience_payload'
 }
 
 function getListAction(payload: PayloadWithFromId): boolean | undefined{
-  if(isEngageAudiencePayload(payload)) {
-    const action = (payload as EngageAudiencePayload)?.traits_or_props[payload.computation_key as string] as boolean
-    return typeof action === 'boolean' ? action : undefined 
-  } else {
-    return payload?.list_details?.list_action
+  const listPayloadType = getListPayloadType(payload)
+
+  switch(listPayloadType) {
+    case 'is_not_audience_payload':
+      return undefined
+    case 'is_non_engage_audience_payload':
+      return payload?.list_details?.list_action
+    case 'is_engage_audience_payload': {
+      const action = (payload as EngageAudiencePayload)?.traits_or_props[payload.computation_key as string] as boolean
+      return typeof action === 'boolean' ? action : undefined 
+    }
   }
 }
 

packages/destination-actions/src/destinations/hubspot/upsertObject/functions/validation-functions.ts

@@ -1,7 +1,7 @@
 import { PayloadValidationError, StatsContext } from '@segment/actions-core'
 import { Payload } from '../generated-types'
 import { Association } from '../types'
-import { isEngageAudiencePayload } from '../functions/hubspot-list-functions'
+import { getListPayloadType, getListName } from '../functions/hubspot-list-functions'
 
 export function validate(payloads: Payload[], flag?: boolean): Payload[] {
   const length = payloads.length
@@ -22,15 +22,24 @@ export function validate(payloads: Payload[], flag?: boolean): Payload[] {
   }
 
   if(flag === true){
-    // check that all payloads are either engage audience or not
-    const allEngageAudience = cleaned.every(isEngageAudiencePayload)
-    const noneEngageAudience = cleaned.every((p) => !isEngageAudiencePayload(p))
+    const hasEngageAudience = cleaned.some((p) => getListPayloadType(p) === 'is_engage_audience_payload') 
+    const hasNonEngageAudience = cleaned.some((p) => getListPayloadType(p) === 'is_non_engage_audience_payload') 
 
-    if(!(allEngageAudience || noneEngageAudience)){
+    if(hasEngageAudience && hasNonEngageAudience){
       throw new PayloadValidationError(
         'Engage and non Engage payloads cannot be mixed in the same batch.'
       )
     }
+
+    const listNames = Array.from(
+      new Set(cleaned.map((p) => getListName(p)).filter(Boolean))
+    )
+
+    if(listNames.length > 1){
+      throw new PayloadValidationError(
+        `When updating List membership, all payloads must reference the same list. Found multiple lists in the batch: ${listNames.slice(0, 3).join(', ')}`
+      )
+    }
   }
 
   cleaned.forEach((payload) => {
@@ -57,6 +66,7 @@ export function validate(payloads: Payload[], flag?: boolean): Payload[] {
       return fieldsToCheck.every((field) => field !== null && field !== '')
     })
   })
+  
   return cleaned
 }
 

packages/destination-actions/src/destinations/hubspot/upsertObject/index.ts

@@ -76,7 +76,6 @@ const send = async (
   let shouldCreateList: boolean | undefined = false
 
   const client = new Client(request, objectType)
-
   const validPayloads = validate(payloads, flag)
 
   if(flag){

packages/destination-actions/src/destinations/hubspot/upsertObject/types.ts

@@ -285,4 +285,6 @@ export type EngageAudiencePayload = Payload & {
     [k : string]: unknown
   }
   computation_key: string
-}
+}
+
+export type PayloadListType = 'is_engage_audience_payload' | 'is_non_engage_audience_payload' | 'is_not_audience_payload'