[MS Bing Ads Audiences] Fix multistatus bug (#3295)

* Fix multistatus

* Add unit tests to improve coverage

Author: harsh-joshi99

packages/destination-actions/src/destinations/ms-bing-ads-audiences/__tests__/utils.test.ts

@@ -4,7 +4,8 @@ import {
   preparePayload,
   sendDataToMicrosoftBingAds,
   handleHttpError,
-  handleMultistatusResponse
+  handleMultistatusResponse,
+  categorizePayloadByAction
 } from '../utils'
 import { BASE_URL } from '../constants'
 import { MultiStatusResponse, HTTPError, RequestClient, IntegrationError } from '@segment/actions-core'
@@ -47,6 +48,56 @@ describe('preparePayload', () => {
   })
 })
 
+describe('categorizePayloadByAction', () => {
+  it('handles duplicate identifiers correctly', () => {
+    const payload: Payload[] = [
+      {
+        audience_id: 'a1',
+        identifier_type: 'Email',
+        email: '[email protected]',
+        enable_batching: true,
+        batch_size: 1000,
+        traits_or_props: { a1: true },
+        audience_key: 'a1',
+        computation_class: 'Default'
+      },
+      {
+        audience_id: 'a1',
+        identifier_type: 'Email',
+        email: '[email protected]', // Same email as first payload
+        enable_batching: true,
+        batch_size: 1000,
+        traits_or_props: { a1: true },
+        audience_key: 'a1',
+        computation_class: 'Default'
+      },
+      {
+        audience_id: 'a1',
+        identifier_type: 'Email',
+        email: '[email protected]',
+        enable_batching: true,
+        batch_size: 1000,
+        traits_or_props: {},
+        audience_key: 'a1',
+        computation_class: 'Default'
+      }
+    ]
+
+    const addMap: Map<string, number[]> = new Map()
+    const removeMap: Map<string, number[]> = new Map()
+
+    categorizePayloadByAction(payload, addMap, removeMap)
+
+    const hashedEmail = hashEmail('[email protected]')
+    const hashedOtherEmail = hashEmail('[email protected]')
+
+    expect(addMap.get(hashedEmail)).toEqual([0, 1])
+
+    // Check that the remove map contains the index for the other email
+    expect(removeMap.get(hashedOtherEmail)).toEqual([2])
+  })
+})
+
 describe('sendDataToMicrosoftBingAds', () => {
   it('sends data to Microsoft Bing Ads', async () => {
     nock(BASE_URL).post('/CustomerListUserData/Apply', { foo: 'bar' }).reply(200, { ok: true })
@@ -64,7 +115,7 @@ describe('sendDataToMicrosoftBingAds', () => {
 describe('handleHttpError', () => {
   it('sets error responses for all items', async () => {
     const msResponse = createMockMsResponse()
-    const listItemsMap = new Map<string, number>([['abc', 0]])
+    const listItemsMap = new Map<string, number[]>([['abc', [0]]])
     const payload: Payload[] = [
       {
         audience_id: 'a1',
@@ -97,10 +148,56 @@ describe('handleHttpError', () => {
 })
 
 describe('handleMultistatusResponse', () => {
+  it('uses default Code (400) when error.Code is missing', () => {
+    const msResponse = createMockMsResponse()
+    const items = ['item1']
+    const listItemsMap = new Map<string, number[]>([['item1', [0]]])
+    const payload: Payload[] = [
+      {
+        audience_id: 'a1',
+        identifier_type: 'Email',
+        email: '[email protected]',
+        enable_batching: true,
+        batch_size: 1000,
+        traits_or_props: {},
+        audience_key: 'a1',
+        computation_class: 'Default'
+      }
+    ]
+
+    const response = {
+      data: {
+        PartialErrors: [
+          {
+            FieldPath: null,
+            ErrorCode: 'InvalidInput',
+            Message: 'The input is invalid',
+            Code: undefined, // Missing Code
+            Details: null,
+            Index: 0,
+            Type: 'Error',
+            ForwardCompatibilityMap: null
+          }
+        ]
+      }
+    }
+
+    handleMultistatusResponse(msResponse, response as unknown as ModifiedResponse, items, listItemsMap, payload, true)
+
+    // Should use default 400 status code
+    expect(msResponse.setErrorResponseAtIndex).toHaveBeenCalledWith(
+      0,
+      expect.objectContaining({
+        status: 400, // Default value
+        errormessage: 'InvalidInput: The input is invalid'
+      })
+    )
+  })
+
   it('throws IntegrationError when not in batch mode and there are partial errors', () => {
     const msResponse = createMockMsResponse()
     const items = ['item1']
-    const listItemsMap = new Map<string, number>([['item1', 0]])
+    const listItemsMap = new Map<string, number[]>([['item1', [0]]])
     const payload: Payload[] = [
       {
         audience_id: 'a1',
@@ -146,10 +243,10 @@ describe('handleMultistatusResponse', () => {
   it('processes partial errors in batch mode', () => {
     const msResponse = createMockMsResponse()
     const items = ['item1', 'item2', 'item3']
-    const listItemsMap = new Map<string, number>([
-      ['item1', 0],
-      ['item2', 1],
-      ['item3', 2]
+    const listItemsMap = new Map<string, number[]>([
+      ['item1', [0]],
+      ['item2', [1]],
+      ['item3', [2]]
     ])
     const payload: Payload[] = [
       {
@@ -230,9 +327,9 @@ describe('handleMultistatusResponse', () => {
   it('marks all items as successful when there are no partial errors', () => {
     const msResponse = createMockMsResponse()
     const items = ['item1', 'item2']
-    const listItemsMap = new Map<string, number>([
-      ['item1', 0],
-      ['item2', 1]
+    const listItemsMap = new Map<string, number[]>([
+      ['item1', [0]],
+      ['item2', [1]]
     ])
     const payload: Payload[] = [
       {
@@ -279,7 +376,7 @@ describe('handleMultistatusResponse', () => {
   it('handles partial errors with invalid indices', () => {
     const msResponse = createMockMsResponse()
     const items = ['item1']
-    const listItemsMap = new Map<string, number>([['item1', 0]])
+    const listItemsMap = new Map<string, number[]>([['item1', [0]]])
     const payload: Payload[] = [
       {
         audience_id: 'a1',
@@ -320,4 +417,205 @@ describe('handleMultistatusResponse', () => {
       })
     )
   })
+
+  it('uses default Message ("No error message provided") when Message is missing in partial errors', () => {
+    const msResponse = createMockMsResponse()
+    const items = ['item1']
+    const listItemsMap = new Map<string, number[]>([['item1', [0]]])
+    const payload: Payload[] = [
+      {
+        audience_id: 'a1',
+        identifier_type: 'Email',
+        email: '[email protected]',
+        enable_batching: true,
+        batch_size: 1000,
+        traits_or_props: {},
+        audience_key: 'a1',
+        computation_class: 'Default'
+      }
+    ]
+
+    const response = {
+      data: {
+        PartialErrors: [
+          {
+            FieldPath: null,
+            ErrorCode: 'InvalidInput',
+            // Message is missing
+            Code: 403,
+            Details: null,
+            Index: 0,
+            Type: 'Error',
+            ForwardCompatibilityMap: null
+          }
+        ]
+      }
+    }
+
+    handleMultistatusResponse(msResponse, response as unknown as ModifiedResponse, items, listItemsMap, payload, true)
+
+    // Check that the default Message "No error message provided" is used
+    expect(msResponse.setErrorResponseAtIndex).toHaveBeenCalledWith(
+      0,
+      expect.objectContaining({
+        status: 403,
+        errormessage: 'InvalidInput: No error message provided'
+      })
+    )
+  })
+
+  it('uses default ErrorCode ("UnknownError") when ErrorCode is missing in partial errors', () => {
+    const msResponse = createMockMsResponse()
+    const items = ['item1']
+    const listItemsMap = new Map<string, number[]>([['item1', [0]]])
+    const payload: Payload[] = [
+      {
+        audience_id: 'a1',
+        identifier_type: 'Email',
+        email: '[email protected]',
+        enable_batching: true,
+        batch_size: 1000,
+        traits_or_props: {},
+        audience_key: 'a1',
+        computation_class: 'Default'
+      }
+    ]
+
+    const response = {
+      data: {
+        PartialErrors: [
+          {
+            FieldPath: null,
+            // ErrorCode is missing
+            Message: 'The input is invalid',
+            Code: 403,
+            Details: null,
+            Index: 0,
+            Type: 'Error',
+            ForwardCompatibilityMap: null
+          }
+        ]
+      }
+    }
+
+    handleMultistatusResponse(msResponse, response as unknown as ModifiedResponse, items, listItemsMap, payload, true)
+
+    // Check that the default ErrorCode "UnknownError" is used
+    expect(msResponse.setErrorResponseAtIndex).toHaveBeenCalledWith(
+      0,
+      expect.objectContaining({
+        status: 403,
+        errormessage: 'UnknownError: The input is invalid'
+      })
+    )
+  })
+
+  it('uses default status code (400) when Code is missing in partial errors', () => {
+    const msResponse = createMockMsResponse()
+    const items = ['item1']
+    const listItemsMap = new Map<string, number[]>([['item1', [0]]])
+    const payload: Payload[] = [
+      {
+        audience_id: 'a1',
+        identifier_type: 'Email',
+        email: '[email protected]',
+        enable_batching: true,
+        batch_size: 1000,
+        traits_or_props: {},
+        audience_key: 'a1',
+        computation_class: 'Default'
+      }
+    ]
+
+    const response = {
+      data: {
+        PartialErrors: [
+          {
+            FieldPath: null,
+            ErrorCode: 'InvalidInput',
+            Message: 'The input is invalid',
+            // Code is missing
+            Details: null,
+            Index: 0,
+            Type: 'Error',
+            ForwardCompatibilityMap: null
+          }
+        ]
+      }
+    }
+
+    handleMultistatusResponse(msResponse, response as unknown as ModifiedResponse, items, listItemsMap, payload, true)
+
+    // Check that the default status code 400 is used
+    expect(msResponse.setErrorResponseAtIndex).toHaveBeenCalledWith(
+      0,
+      expect.objectContaining({
+        status: 400, // Default value
+        errormessage: 'InvalidInput: The input is invalid'
+      })
+    )
+  })
+
+  it('handles duplicate identifiers correctly in partial errors', () => {
+    const msResponse = createMockMsResponse()
+    const items = ['dupItem']
+    const listItemsMap = new Map<string, number[]>([['dupItem', [0, 1]]]) // dupItem maps to two payload indices
+    const payload: Payload[] = [
+      {
+        audience_id: 'a1',
+        identifier_type: 'Email',
+        email: '[email protected]',
+        enable_batching: true,
+        batch_size: 1000,
+        traits_or_props: {},
+        audience_key: 'a1',
+        computation_class: 'Default'
+      },
+      {
+        audience_id: 'a1',
+        identifier_type: 'Email',
+        email: '[email protected]',
+        enable_batching: true,
+        batch_size: 1000,
+        traits_or_props: {},
+        audience_key: 'a1',
+        computation_class: 'Default'
+      }
+    ]
+
+    const response = {
+      data: {
+        PartialErrors: [
+          {
+            FieldPath: null,
+            ErrorCode: 'InvalidInput',
+            Message: 'The input is invalid',
+            Code: 400,
+            Details: null,
+            Index: 0,
+            Type: 'Error',
+            ForwardCompatibilityMap: null
+          }
+        ]
+      }
+    }
+
+    handleMultistatusResponse(msResponse, response as any as ModifiedResponse, items, listItemsMap, payload, true)
+
+    // Check that the error item was handled correctly
+    expect(msResponse.setErrorResponseAtIndex).toHaveBeenCalledWith(
+      0,
+      expect.objectContaining({
+        status: 400,
+        errormessage: 'InvalidInput: The input is invalid'
+      })
+    )
+    expect(msResponse.setErrorResponseAtIndex).toHaveBeenCalledWith(
+      1,
+      expect.objectContaining({
+        status: 400,
+        errormessage: 'InvalidInput: The input is invalid'
+      })
+    )
+  })
 })