[STRATCONN-4294] | Add MultiStatusResponse to AddProfileToList of Kla…

…viyo. (#2526)

* Worked on adding multistatusResponse to AddProfileToList

* Unit test case

* Worked on adding Email  pre validation and handle klaviyo API error response

* documentation js

* email validation

* updateMultiStatusWithSuccessData after klaviyo API response

* updated errorreporter for failure

* updated with main

* updated with main

---------

Co-authored-by: Gaurav Kochar <[email protected]>

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

@@ -4,7 +4,7 @@ exports[`Testing snapshot for actions-klaviyo destination: addProfileToList acti
 Object {
   "data": Object {
     "attributes": Object {
-      "email": "[email protected]",
+      "email": "[email protected]",
       "external_id": "E3nNk",
       "first_name": "E3nNk",
       "image": "E3nNk",

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

@@ -257,4 +257,294 @@ describe('MultiStatus', () => {
       })
     })
   })
+  describe('addProfileToList', () => {
+    beforeEach(() => {
+      nock.cleanAll()
+      jest.resetAllMocks()
+    })
+    afterEach(() => {
+      jest.resetAllMocks()
+    })
+    const mapping = {
+      email: {
+        '@path': '$.properties.email'
+      },
+      phone_number: {
+        '@path': '$.properties.phone_number'
+      },
+      first_name: {
+        '@path': '$.properties.firstName'
+      },
+      last_name: {
+        '@path': '$.properties.lastName'
+      },
+      list_id: {
+        '@path': '$.properties.list_id'
+      },
+      properties: {
+        '@path': '$.properties'
+      },
+      country_code: {
+        '@path': '$.properties.country_code'
+      },
+      external_id: {
+        '@path': '$.properties.external_id'
+      }
+    }
+    const responseData = {
+      data: {
+        type: 'profile-bulk-import-job',
+        id: 'ZXo4dlZ1X21haW50ZW5hbmNlLnRNMm5PYy4xNzMxOTQxODcyLmhibkMzZw',
+        attributes: {
+          status: 'queued',
+          created_at: '2024-11-18T14:57:52.454354+00:00',
+          total_count: 1,
+          completed_count: 0,
+          failed_count: 0,
+          completed_at: null,
+          expires_at: '2024-11-25T14:57:52.454354+00:00',
+          started_at: null
+        },
+        relationships: {
+          lists: {
+            data: [
+              {
+                type: 'list',
+                id: 'WNyUbB'
+              }
+            ]
+          }
+        }
+      }
+    }
+
+    it("should successfully handle those payload where phone_number is invalid and couldn't be converted to E164 format", async () => {
+      nock(API_URL).post('/profile-bulk-import-jobs/').reply(202, responseData)
+
+      const events: SegmentEvent[] = [
+        // Event with invalid phone_number
+        createTestEvent({
+          type: 'track',
+          timestamp,
+          properties: {
+            country_code: 'IN',
+            phone_number: '701271',
+            email: '[email protected]',
+            list_id: 'WNyUbB'
+          }
+        }),
+        // Valid Event
+        createTestEvent({
+          type: 'track',
+          timestamp,
+          properties: {
+            email: '[email protected]',
+            list_id: 'WNyUbB'
+          }
+        })
+      ]
+
+      const response = await testDestination.executeBatch('addProfileToList', {
+        events,
+        settings,
+        mapping
+      })
+
+      // The First event fails as pre-request validation fails for having invalid phone_number and could not be converted to E164 format
+      expect(response[0]).toMatchObject({
+        status: 400,
+        errortype: 'PAYLOAD_VALIDATION_FAILED',
+        errormessage: 'Phone number could not be converted to E.164 format.',
+        errorreporter: 'INTEGRATIONS'
+      })
+
+      // The Second event doesn't fail as there is no error reported by Klaviyo API
+      expect(response[1]).toMatchObject({
+        status: 200,
+        body: JSON.stringify(responseData)
+      })
+    })
+
+    it('should successfully handle a batch of events with complete success response from Klaviyo API', async () => {
+      nock(API_URL).post('/profile-bulk-import-jobs/').reply(200, responseData)
+
+      const events: SegmentEvent[] = [
+        // Valid Event
+        createTestEvent({
+          type: 'track',
+          timestamp,
+          properties: {
+            email: '[email protected]',
+            list_id: 'WNyUbB'
+          }
+        }),
+        // Event without any user identifier
+        createTestEvent({
+          type: 'track',
+          properties: {
+            list_id: 'WNyUbB'
+          }
+        }),
+        //Event with invalid Email
+        createTestEvent({
+          type: 'track',
+          timestamp,
+          properties: {
+            email: '[email protected]',
+            list_id: 'WNyUbB'
+          }
+        })
+      ]
+
+      const response = await testDestination.executeBatch('addProfileToList', {
+        events,
+        settings,
+        mapping
+      })
+
+      // The first event doesn't fail as there is no error reported by Klaviyo API
+      expect(response[0]).toMatchObject({
+        status: 200,
+        body: JSON.stringify(responseData)
+      })
+
+      // The second event fails as pre-request validation fails for not having any user identifier
+      expect(response[1]).toMatchObject({
+        status: 400,
+        errortype: 'PAYLOAD_VALIDATION_FAILED',
+        errormessage: 'One of External ID, Phone Number or Email is required.',
+        errorreporter: 'INTEGRATIONS'
+      })
+
+      // The third event fails as pre-request validation fails for having invalid email
+      expect(response[2]).toMatchObject({
+        status: 400,
+        errortype: 'PAYLOAD_VALIDATION_FAILED',
+        errormessage: 'Email must be a valid email address string but it was not.',
+        errorreporter: 'INTEGRATIONS'
+      })
+    })
+
+    it('should successfully handle a batch of events with failure response from Klaviyo API', async () => {
+      // Mocking a 400 response from Klaviyo API
+      const mockResponse = {
+        errors: [
+          {
+            id: '752f7ece-af20-44e0-aa3a-b13290d98e72',
+            status: 400,
+            code: 'invalid',
+            title: 'Invalid input.',
+            detail: 'Invalid input',
+            source: {
+              pointer: '/data/attributes/profiles/data/0/attributes/email'
+            },
+            links: {},
+            meta: {}
+          }
+        ]
+      }
+      nock(API_URL).post('/profile-bulk-import-jobs/').reply(400, mockResponse)
+
+      const events: SegmentEvent[] = [
+        // Invalid Event
+        createTestEvent({
+          type: 'track',
+          timestamp,
+          properties: {
+            email: '[email protected]',
+            list_id: '123'
+          }
+        }),
+        // Valid Event
+        createTestEvent({
+          type: 'track',
+          timestamp,
+          properties: {
+            external_id: 'Xi1234',
+            list_id: '123'
+          }
+        })
+      ]
+
+      const response = await testDestination.executeBatch('addProfileToList', {
+        events,
+        settings,
+        mapping
+      })
+
+      expect(response[0]).toMatchObject({
+        status: 400,
+        errormessage: 'Bad Request',
+        sent: {
+          email: '[email protected]',
+          list_id: '123',
+          properties: {
+            email: '[email protected]',
+            list_id: '123'
+          }
+        },
+        body: '{"errors":[{"id":"752f7ece-af20-44e0-aa3a-b13290d98e72","status":400,"code":"invalid","title":"Invalid input.","detail":"Invalid input","source":{"pointer":"/data/attributes/profiles/data/0/attributes/email"},"links":{},"meta":{}}]}',
+        errortype: 'BAD_REQUEST',
+        errorreporter: 'DESTINATION'
+      })
+
+      expect(response[1]).toMatchObject({
+        status: 400,
+        errormessage: 'Bad Request',
+        sent: {
+          list_id: '123',
+          properties: {
+            external_id: 'Xi1234',
+            list_id: '123'
+          },
+          external_id: 'Xi1234'
+        },
+        body: '{"errors":[{"id":"752f7ece-af20-44e0-aa3a-b13290d98e72","status":400,"code":"invalid","title":"Invalid input.","detail":"Invalid input","source":{"pointer":"/data/attributes/profiles/data/0/attributes/email"},"links":{},"meta":{}}]}',
+        errortype: 'BAD_REQUEST',
+        errorreporter: 'DESTINATION'
+      })
+    })
+
+    it('should successfully handle a batch when all payload is invalid', async () => {
+      const events: SegmentEvent[] = [
+        // Event with invalid phone_number
+        createTestEvent({
+          type: 'track',
+          properties: {
+            country_code: 'IN',
+            phone_number: '701271',
+            email: '[email protected]',
+            list_id: '123'
+          }
+        }),
+        // Event without any user identifier
+        createTestEvent({
+          type: 'track',
+          properties: { list_id: '123' }
+        })
+      ]
+
+      const response = await testDestination.executeBatch('addProfileToList', {
+        events,
+        settings,
+        mapping
+      })
+
+      // The First event fails as pre-request validation fails for having invalid phone_number and could not be converted to E164 format
+      expect(response[0]).toMatchObject({
+        status: 400,
+        errortype: 'PAYLOAD_VALIDATION_FAILED',
+        errormessage: 'Phone number could not be converted to E.164 format.',
+        errorreporter: 'INTEGRATIONS'
+      })
+
+      // The second event fails as pre-request validation fails for not having any user identifier
+      expect(response[1]).toMatchObject({
+        status: 400,
+        errortype: 'PAYLOAD_VALIDATION_FAILED',
+        errormessage: 'One of External ID, Phone Number or Email is required.',
+        errorreporter: 'INTEGRATIONS'
+      })
+    })
+  })
 })