[STRATCONN-5489] - Add batch_keys to Klaviyo actions

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

@@ -31,6 +31,20 @@ Object {
 }
 `;
 
+exports[`Testing snapshot for actions-klaviyo destination: addProfileToList action - batch keys 1`] = `
+Object {
+  "default": Array [
+    "list_id",
+  ],
+  "description": "The keys to use for batching the events.",
+  "label": "Batch Keys",
+  "multiple": true,
+  "required": false,
+  "type": "string",
+  "unsafe_hidden": true,
+}
+`;
+
 exports[`Testing snapshot for actions-klaviyo destination: orderCompleted action - all fields 1`] = `
 Object {
   "data": Object {
@@ -68,8 +82,36 @@ Object {
 
 exports[`Testing snapshot for actions-klaviyo destination: removeProfile action - all fields 1`] = `""`;
 
+exports[`Testing snapshot for actions-klaviyo destination: removeProfile action - batch keys 1`] = `
+Object {
+  "default": Array [
+    "list_id",
+  ],
+  "description": "The keys to use for batching the events.",
+  "label": "Batch Keys",
+  "multiple": true,
+  "required": false,
+  "type": "string",
+  "unsafe_hidden": true,
+}
+`;
+
 exports[`Testing snapshot for actions-klaviyo destination: removeProfileFromList action - all fields 1`] = `""`;
 
+exports[`Testing snapshot for actions-klaviyo destination: removeProfileFromList action - batch keys 1`] = `
+Object {
+  "default": Array [
+    "list_id",
+  ],
+  "description": "The keys to use for batching the events.",
+  "label": "Batch Keys",
+  "multiple": true,
+  "required": false,
+  "type": "string",
+  "unsafe_hidden": true,
+}
+`;
+
 exports[`Testing snapshot for actions-klaviyo destination: subscribeProfile action - all fields 1`] = `
 Object {
   "data": Object {
@@ -114,6 +156,21 @@ Object {
 }
 `;
 
+exports[`Testing snapshot for actions-klaviyo destination: subscribeProfile action - batch keys 1`] = `
+Object {
+  "default": Array [
+    "list_id",
+    "custom_source",
+  ],
+  "description": "The keys to use for batching the events.",
+  "label": "Batch Keys",
+  "multiple": true,
+  "required": false,
+  "type": "string",
+  "unsafe_hidden": true,
+}
+`;
+
 exports[`Testing snapshot for actions-klaviyo destination: trackEvent action - all fields 1`] = `
 Object {
   "data": Object {
@@ -193,6 +250,20 @@ Object {
 }
 `;
 
+exports[`Testing snapshot for actions-klaviyo destination: unsubscribeProfile action - batch keys 1`] = `
+Object {
+  "default": Array [
+    "list_id",
+  ],
+  "description": "The keys to use for batching the events.",
+  "label": "Batch Keys",
+  "multiple": true,
+  "required": false,
+  "type": "string",
+  "unsafe_hidden": true,
+}
+`;
+
 exports[`Testing snapshot for actions-klaviyo destination: upsertProfile action - all fields 1`] = `
 Object {
   "data": Object {
@@ -223,3 +294,18 @@ Object {
   },
 }
 `;
+
+exports[`Testing snapshot for actions-klaviyo destination: upsertProfile action - batch keys 1`] = `
+Object {
+  "default": Array [
+    "list_id",
+    "override_list_id",
+  ],
+  "description": "The keys to use for batching the events.",
+  "label": "Batch Keys",
+  "multiple": true,
+  "required": false,
+  "type": "string",
+  "unsafe_hidden": true,
+}
+`;

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

@@ -45,5 +45,12 @@ describe(`Testing snapshot for ${destinationSlug} destination:`, () => {
         expect(rawBody).toMatchSnapshot()
       }
     })
+
+    const action = destination.actions[actionSlug]
+    if (action.fields.batch_keys) {
+      it(`${actionSlug} action - batch keys`, async () => {
+        expect(action.fields.batch_keys).toMatchSnapshot()
+      })
+    }
   }
 })

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

@@ -37,7 +37,16 @@ const action: ActionDefinition<Settings, Payload> = {
     organization: { ...organization },
     location: { ...location },
     properties: { ...properties },
-    country_code: { ...country_code }
+    country_code: { ...country_code },
+    batch_keys: {
+      label: 'Batch Keys',
+      description: 'The keys to use for batching the events.',
+      type: 'string',
+      unsafe_hidden: true,
+      required: false,
+      multiple: true,
+      default: ['list_id']
+    }
   },
   perform: async (request, { payload }) => {
     const {
@@ -48,6 +57,7 @@ const action: ActionDefinition<Settings, Payload> = {
       enable_batching,
       batch_size,
       country_code,
+      batch_keys,
       ...additionalAttributes
     } = payload
     const phone_number = processPhoneNumber(initialPhoneNumber, country_code)
@@ -57,8 +67,8 @@ const action: ActionDefinition<Settings, Payload> = {
     const profileId = await createProfile(request, email, external_id, phone_number, additionalAttributes)
     return await addProfileToList(request, profileId, list_id)
   },
-  performBatch: async (request, { payload }) => {
-    return sendBatchedProfileImportJobRequest(request, payload)
+  performBatch: async (request, { payload, statsContext }) => {
+    return sendBatchedProfileImportJobRequest(request, payload, statsContext)
   }
 }
 

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

@@ -7,7 +7,8 @@ import {
   JSONLikeObject,
   HTTPError,
   MultiStatusResponse,
-  ErrorCodes
+  ErrorCodes,
+  StatsContext
 } from '@segment/actions-core'
 import { API_URL, REVISION_DATE } from './config'
 import { Settings } from './generated-types'
@@ -141,7 +142,7 @@ export const createImportJobPayload = (profiles: Payload[], listId?: string): {
     attributes: {
       profiles: {
         data: profiles.map(
-          ({ list_id, enable_batching, batch_size, override_list_id, country_code, ...attributes }) => ({
+          ({ list_id, enable_batching, batch_size, override_list_id, country_code, batch_keys, ...attributes }) => ({
             type: 'profile',
             attributes
           })
@@ -519,7 +520,11 @@ async function updateMultiStatusWithKlaviyoErrors(
   })
 }
 
-export async function removeBulkProfilesFromList(request: RequestClient, payloads: RemoveProfilePayload[]) {
+export async function removeBulkProfilesFromList(
+  request: RequestClient,
+  payloads: RemoveProfilePayload[],
+  statsContext?: StatsContext
+) {
   const multiStatusResponse = new MultiStatusResponse()
 
   const { filteredPayloads, validPayloadIndicesBitmap } = validateAndPrepareRemoveBulkProfilePayloads(
@@ -535,6 +540,13 @@ export async function removeBulkProfilesFromList(request: RequestClient, payload
   const externalIds = extractField(filteredPayloads, 'external_id')
   const phoneNumbers = extractField(filteredPayloads, 'phone_number')
 
+  if (statsContext) {
+    const { tags, statsClient } = statsContext
+    const set = new Set()
+    filteredPayloads.forEach((x) => set.add(x.list_id))
+    statsClient?.histogram('actions-klaviyo.remove_profile_from_list.unique_list_id', set.size, tags)
+  }
+
   const listId = filteredPayloads[0]?.list_id as string
 
   try {
@@ -640,7 +652,7 @@ function validateAndConstructProfilePayload(payload: AddProfileToListPayload): {
     delete payload.country_code
   }
 
-  const { list_id, enable_batching, batch_size, country_code, ...attributes } = payload
+  const { list_id, enable_batching, batch_size, country_code, batch_keys, ...attributes } = payload
 
   response.validPayload = { type: 'profile', attributes: attributes as JSONLikeObject }
   return response
@@ -666,7 +678,11 @@ function validateAndPrepareBatchedProfileImportPayloads(
   return { filteredPayloads, validPayloadIndicesBitmap }
 }
 
-export async function sendBatchedProfileImportJobRequest(request: RequestClient, payloads: AddProfileToListPayload[]) {
+export async function sendBatchedProfileImportJobRequest(
+  request: RequestClient,
+  payloads: AddProfileToListPayload[],
+  statsContext?: StatsContext
+) {
   const multiStatusResponse = new MultiStatusResponse()
   const { filteredPayloads, validPayloadIndicesBitmap } = validateAndPrepareBatchedProfileImportPayloads(
     payloads,
@@ -676,6 +692,13 @@ export async function sendBatchedProfileImportJobRequest(request: RequestClient,
   if (!filteredPayloads.length) {
     return multiStatusResponse
   }
+
+  if (statsContext) {
+    const { tags, statsClient } = statsContext
+    const set = new Set()
+    filteredPayloads.forEach((x) => set.add(x.list_id))
+    statsClient?.histogram('actions-klaviyo.add_profile_to_list.unique_list_id', set.size, tags)
+  }
   const importJobPayload = constructBulkProfileImportPayload(
     filteredPayloads as unknown as KlaviyoProfile[],
     payloads[0]?.list_id

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

@@ -45,6 +45,15 @@ const action: ActionDefinition<Settings, Payload> = {
     },
     country_code: {
       ...country_code
+    },
+    batch_keys: {
+      label: 'Batch Keys',
+      description: 'The keys to use for batching the events.',
+      type: 'string',
+      unsafe_hidden: true,
+      required: false,
+      multiple: true,
+      default: ['list_id']
     }
   },
   dynamicFields: {
@@ -66,8 +75,8 @@ const action: ActionDefinition<Settings, Payload> = {
     )
     return await removeProfileFromList(request, profileIds, list_id)
   },
-  performBatch: async (request, { payload }) => {
-    return await removeBulkProfilesFromList(request, payload)
+  performBatch: async (request, { payload, statsContext }) => {
+    return await removeBulkProfilesFromList(request, payload, statsContext)
   }
 }
 

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

@@ -16,7 +16,16 @@ const action: ActionDefinition<Settings, Payload> = {
     phone_number: { ...phone_number },
     enable_batching: { ...enable_batching },
     country_code: { ...country_code },
-    batch_size: { ...batch_size, default: 1000 }
+    batch_size: { ...batch_size, default: 1000 },
+    batch_keys: {
+      label: 'Batch Keys',
+      description: 'The keys to use for batching the events.',
+      type: 'string',
+      unsafe_hidden: true,
+      required: false,
+      multiple: true,
+      default: ['list_id']
+    }
   },
   perform: async (request, { payload }) => {
     const { email, list_id, external_id, phone_number: initialPhoneNumber, country_code } = payload
@@ -32,8 +41,8 @@ const action: ActionDefinition<Settings, Payload> = {
     )
     return await removeProfileFromList(request, profileIds, list_id)
   },
-  performBatch: async (request, { payload }) => {
-    return await removeBulkProfilesFromList(request, payload)
+  performBatch: async (request, { payload, statsContext }) => {
+    return await removeBulkProfilesFromList(request, payload, statsContext)
   }
 }