[Stratconn 3718] Add Remove Profile (#1994)

* Add remove profile action

* Fix Mappings

* Fix Mappings

* Fix Test, Code cleanup

packages/destination-actions/src/destinations/klaviyo/index.ts

@@ -13,6 +13,7 @@ import removeProfileFromList from './removeProfileFromList'
 import trackEvent from './trackEvent'
 import orderCompleted from './orderCompleted'
 import { buildHeaders } from './functions'
+import removeProfile from './removeProfile'
 
 const destination: AudienceDestinationDefinition<Settings> = {
   name: 'Klaviyo (Actions)',
@@ -125,7 +126,8 @@ const destination: AudienceDestinationDefinition<Settings> = {
     addProfileToList,
     removeProfileFromList,
     trackEvent,
-    orderCompleted
+    orderCompleted,
+    removeProfile
   }
 }
 

packages/destination-actions/src/destinations/klaviyo/removeProfile/__tests__/index.test.ts

@@ -0,0 +1,347 @@
+import nock from 'nock'
+import { createTestEvent, createTestIntegration } from '@segment/actions-core'
+import Definition from '../../index'
+import { API_URL } from '../../config'
+import { AggregateAjvError } from '@segment/ajv-human-errors'
+import * as Functions from '../../functions'
+
+jest.mock('../../functions', () => ({
+  ...jest.requireActual('../../functions'),
+  getProfiles: jest.fn(),
+  removeProfileFromList: jest.fn(() => Promise.resolve({ success: true }))
+}))
+
+const testDestination = createTestIntegration(Definition)
+
+const apiKey = 'fake-api-key'
+
+export const settings = {
+  api_key: apiKey
+}
+const listId = 'XYZABC'
+
+const requestBody = {
+  data: [
+    {
+      type: 'profile',
+      id: 'XYZABC'
+    },
+    {
+      type: 'profile',
+      id: 'XYZABD'
+    }
+  ]
+}
+
+describe('Remove Profile', () => {
+  it('should throw error if no external_id/email is provided', async () => {
+    const event = createTestEvent({
+      type: 'track',
+      properties: {}
+    })
+
+    await expect(testDestination.testAction('removeProfile', { event, settings })).rejects.toThrowError(
+      AggregateAjvError
+    )
+  })
+
+  it('should remove profile from list if successful with email address only', async () => {
+    const mapping = { list_id: listId, email: 'test@example.com' }
+    const requestBody = {
+      data: [
+        {
+          type: 'profile',
+          id: 'XYZABC'
+        }
+      ]
+    }
+
+    const email = 'test@example.com'
+    nock(`${API_URL}/profiles`)
+      .get(`/?filter=equals(email,"${email}")`)
+      .reply(200, {
+        data: [{ id: 'XYZABC' }]
+      })
+
+    nock(`${API_URL}/lists/${listId}`)
+      .delete('/relationships/profiles/', requestBody)
+      .reply(200, {
+        data: [
+          {
+            id: 'XYZABC'
+          }
+        ]
+      })
+
+    const event = createTestEvent({
+      type: 'track',
+      userId: '123',
+      context: {
+        personas: {
+          external_audience_id: listId
+        },
+        traits: {
+          email: 'test@example.com'
+        }
+      }
+    })
+
+    await expect(
+      testDestination.testAction('removeProfile', { event, settings, mapping, useDefaultMappings: true })
+    ).resolves.not.toThrowError()
+  })
+
+  it('should remove profile from list if successful with External Id only', async () => {
+    const requestBody = {
+      data: [
+        {
+          type: 'profile',
+          id: 'XYZABC'
+        }
+      ]
+    }
+
+    const external_id = 'testing_123'
+    nock(`${API_URL}/profiles`)
+      .get(`/?filter=equals(external_id,"${external_id}")`)
+      .reply(200, {
+        data: [{ id: 'XYZABC' }]
+      })
+
+    nock(`${API_URL}/lists/${listId}`)
+      .delete('/relationships/profiles/', requestBody)
+      .reply(200, {
+        data: [
+          {
+            id: 'XYZABC'
+          }
+        ]
+      })
+
+    const event = createTestEvent({
+      type: 'track',
+      userId: '123',
+      context: {
+        personas: {
+          external_audience_id: listId
+        }
+      },
+      properties: {
+        external_id: 'testing_123'
+      }
+    })
+    const mapping = {
+      list_id: listId,
+      external_id: 'testing_123'
+    }
+
+    await expect(testDestination.testAction('removeProfile', { event, mapping, settings })).resolves.not.toThrowError()
+  })
+})
+
+describe('Remove Profile Batch', () => {
+  beforeEach(() => {
+    nock.cleanAll()
+    jest.resetAllMocks()
+  })
+  afterEach(() => {
+    jest.resetAllMocks()
+  })
+
+  it('should remove multiple profiles with valid emails', async () => {
+    const events = [
+      createTestEvent({
+        properties: {
+          email: 'user1@example.com'
+        }
+      }),
+      createTestEvent({
+        properties: {
+          email: 'user2@example.com'
+        }
+      })
+    ]
+    const mapping = {
+      list_id: listId,
+      email: {
+        '@path': '$.properties.email'
+      }
+    }
+
+    nock(`${API_URL}`)
+      .get('/profiles/')
+      .query({
+        filter: 'any(email,["user1@example.com","user2@example.com"])'
+      })
+      .reply(200, {
+        data: [{ id: 'XYZABC' }, { id: 'XYZABD' }]
+      })
+
+    nock(`${API_URL}/lists/${listId}`).delete('/relationships/profiles/', requestBody).reply(200)
+
+    await expect(
+      testDestination.testBatchAction('removeProfile', {
+        settings,
+        events,
+        mapping
+      })
+    ).resolves.not.toThrowError()
+  })
+
+  it('should remove multiple profiles with valid external IDs', async () => {
+    const events = [
+      createTestEvent({
+        properties: {
+          external_id: 'externalId1'
+        }
+      }),
+      createTestEvent({
+        properties: {
+          external_id: 'externalId2'
+        }
+      })
+    ]
+
+    const mapping = {
+      list_id: listId,
+      external_id: {
+        '@path': '$.properties.external_id'
+      }
+    }
+
+    nock(`${API_URL}`)
+      .get('/profiles/')
+      .query({
+        filter: 'any(external_id,["externalId1","externalId2"])'
+      })
+      .reply(200, {
+        data: [{ id: 'XYZABC' }, { id: 'XYZABD' }]
+      })
+
+    nock(`${API_URL}/lists/${listId}`).delete('/relationships/profiles/', requestBody).reply(200)
+
+    await expect(
+      testDestination.testBatchAction('removeProfile', {
+        settings,
+        events,
+        mapping
+      })
+    ).resolves.not.toThrowError()
+  })
+
+  it('should remove profiles with valid emails and external IDs', async () => {
+    const events = [
+      createTestEvent({
+        properties: {
+          email: 'user1@example.com'
+        }
+      }),
+      createTestEvent({
+        properties: {
+          external_id: 'externalId2'
+        }
+      })
+    ]
+
+    const mapping = {
+      list_id: listId,
+      external_id: {
+        '@path': '$.properties.external_id'
+      },
+      email: {
+        '@path': '$.properties.email'
+      }
+    }
+
+    nock(`${API_URL}`)
+      .get('/profiles/')
+      .query({
+        filter: 'any(email,["user1@example.com"])'
+      })
+      .reply(200, {
+        data: [{ id: 'XYZABD' }]
+      })
+
+    nock(`${API_URL}`)
+      .get('/profiles/')
+      .query({
+        filter: 'any(external_id,["externalId2"])'
+      })
+      .reply(200, {
+        data: [{ id: 'XYZABC' }]
+      })
+
+    nock(`${API_URL}/lists/${listId}`).delete('/relationships/profiles/', requestBody).reply(200)
+
+    await expect(
+      testDestination.testBatchAction('removeProfile', {
+        settings,
+        events,
+        mapping
+      })
+    ).resolves.not.toThrowError()
+  })
+
+  it('should filter out profiles without email or external ID', async () => {
+    const events = [
+      createTestEvent({
+        properties: {
+          fake: 'property'
+        }
+      }),
+      createTestEvent({
+        properties: {
+          email: 'valid@example.com'
+        }
+      })
+    ]
+
+    const mapping = {
+      list_id: listId,
+      external_id: {
+        '@path': '$.properties.external_id'
+      },
+      email: {
+        '@path': '$.properties.email'
+      }
+    }
+
+    const requestBody = {
+      data: [
+        {
+          type: 'profile',
+          id: 'XYZABC'
+        }
+      ]
+    }
+
+    nock(`${API_URL}`)
+      .get('/profiles/')
+      .query({
+        filter: 'any(email,["valid@example.com"])'
+      })
+      .reply(200, {
+        data: [{ id: 'XYZABC' }]
+      })
+
+    nock(`${API_URL}/lists/${listId}`).delete('/relationships/profiles/', requestBody).reply(200)
+
+    await expect(
+      testDestination.testBatchAction('removeProfile', {
+        settings,
+        events,
+        mapping
+      })
+    ).resolves.not.toThrowError()
+  })
+
+  it('should handle an empty payload', async () => {
+    await testDestination.testBatchAction('removeProfile', {
+      settings,
+      events: []
+    })
+
+    expect(Functions.getProfiles).not.toHaveBeenCalled()
+    expect(Functions.removeProfileFromList).not.toHaveBeenCalled()
+  })
+})