Address PR review: add types, populate body/sent, and wrap request in try/catch

- Collapse duplicate 200/207 status blocks into single OR condition
- Rename TrackApiResponse to CustomerIOBatchResponse and add as request generic
- Add return type to getResponseBody
- Thread original payloads and built batch through to populate body/sent in multi-status responses
- Wrap batch request in try/catch to handle full payload failures

Author: Dr.J

packages/destination-actions/src/destinations/customerio/__tests__/utils.test.ts

@@ -1,5 +1,11 @@
 import { MultiStatusResponse } from '@segment/actions-core'
-import { isIsoDate, parseTrackApiErrors, parseTrackApiMultiStatusResponse, resolveIdentifiers, sendBatch } from '../utils'
+import {
+  isIsoDate,
+  parseTrackApiErrors,
+  parseTrackApiMultiStatusResponse,
+  resolveIdentifiers,
+  sendBatch
+} from '../utils'
 
 describe('isIsoDate', () => {
   it('should return true for valid ISO date with fractional seconds from 1-9 digits', () => {
@@ -115,18 +121,15 @@ describe('sendBatch', () => {
     expect((response as MultiStatusResponse).length()).toBe(2)
     expect((response as MultiStatusResponse).getResponseAtIndex(0).value()).toEqual({
       status: 200,
-      body: {},
-      sent: {}
+      body: { person_id: 'user-1', name: 'First' },
+      sent: { type: 'person', action: 'event', identifiers: { id: 'user-1' }, name: 'First' }
     })
     expect((response as MultiStatusResponse).getResponseAtIndex(1).value()).toEqual({
       status: 400,
       errormessage: 'Attribute value too long',
       errortype: 'PAYLOAD_VALIDATION_FAILED',
-      body: {
-        batch_index: 1,
-        reason: 'invalid',
-        message: 'Attribute value too long'
-      }
+      body: { person_id: 'user-2', name: 'Second' },
+      sent: { type: 'person', action: 'event', identifiers: { id: 'user-2' }, name: 'Second' }
     })
   })
 
@@ -159,18 +162,25 @@ describe('sendBatch', () => {
       status: 400,
       errormessage: 'Name is required',
       errortype: 'PAYLOAD_VALIDATION_FAILED',
-      body: {
-        batch_index: 0,
-        reason: 'required',
-        field: 'name',
-        message: 'Name is required'
-      }
+      body: { person_id: 'user-1', name: 'First' },
+      sent: { type: 'person', action: 'event', identifiers: { id: 'user-1' }, name: 'First' }
     })
   })
 })
 
 describe('parseTrackApiErrors', () => {
   it('should fill success entries for items without errors', () => {
+    const options = [
+      { type: 'person', action: 'event', settings: {}, payload: { person_id: 'user-0' } },
+      { type: 'person', action: 'event', settings: {}, payload: { person_id: 'user-1' } },
+      { type: 'person', action: 'event', settings: {}, payload: { person_id: 'user-2' } }
+    ]
+    const batch = [
+      { type: 'person', action: 'event', identifiers: { id: 'user-0' } },
+      { type: 'person', action: 'event', identifiers: { id: 'user-1' } },
+      { type: 'person', action: 'event', identifiers: { id: 'user-2' } }
+    ]
+
     const response = parseTrackApiErrors(
       [
         {
@@ -180,29 +190,36 @@ describe('parseTrackApiErrors', () => {
           message: 'Name is required'
         }
       ],
-      3
+      options,
+      batch
     )
 
     expect(response.getAllResponses().map((result) => result.value())).toEqual([
-      { status: 200, body: {}, sent: {} },
+      {
+        status: 200,
+        body: { person_id: 'user-0' },
+        sent: { type: 'person', action: 'event', identifiers: { id: 'user-0' } }
+      },
       {
         status: 400,
         errormessage: 'Name is required',
         errortype: 'PAYLOAD_VALIDATION_FAILED',
-        body: {
-          batch_index: 1,
-          reason: 'required',
-          field: 'name',
-          message: 'Name is required'
-        }
+        body: { person_id: 'user-1' },
+        sent: { type: 'person', action: 'event', identifiers: { id: 'user-1' } }
       },
-      { status: 200, body: {}, sent: {} }
+      {
+        status: 200,
+        body: { person_id: 'user-2' },
+        sent: { type: 'person', action: 'event', identifiers: { id: 'user-2' } }
+      }
     ])
   })
 })
 
 describe('parseTrackApiMultiStatusResponse', () => {
   it('should return null for non-Track API response bodies', () => {
-    expect(parseTrackApiMultiStatusResponse({ ok: true }, 1)).toBeNull()
+    const options = [{ type: 'person', action: 'event', settings: {}, payload: { person_id: 'user-0' } }]
+    const batch = [{ type: 'person', action: 'event', identifiers: { id: 'user-0' } }]
+    expect(parseTrackApiMultiStatusResponse({ ok: true }, options, batch)).toBeNull()
   })
 })

packages/destination-actions/src/destinations/customerio/utils.ts

@@ -1,7 +1,7 @@
 import dayjs from '../../lib/dayjs'
 import isPlainObject from 'lodash/isPlainObject'
 import { fullFormats } from 'ajv-formats/dist/formats'
-import { ErrorCodes, MultiStatusResponse, type RequestClient } from '@segment/actions-core'
+import { ErrorCodes, MultiStatusResponse, RequestClient } from '@segment/actions-core'
 import { CUSTOMERIO_TRACK_API_VERSION } from './versioning-info'
 
 const isEmail = (value: string): boolean => {
@@ -208,30 +208,43 @@ export const sendBatch = async <Payload extends BasePayload>(
   const [{ settings }] = options
   const batch = options.map((opts) => buildPayload(opts))
 
-  const response = await request(`${trackApiEndpoint(settings)}/api/${CUSTOMERIO_TRACK_API_VERSION}/batch`, {
-    method: 'post',
-    json: {
-      batch
-    }
-  })
+  try {
+    const response = await request<CustomerIOBatchResponse>(
+      `${trackApiEndpoint(settings)}/api/${CUSTOMERIO_TRACK_API_VERSION}/batch`,
+      {
+        method: 'post',
+        json: {
+          batch
+        }
+      }
+    )
 
-  const responseBody = getResponseBody(response)
+    const responseBody = getResponseBody(response)
 
-  if (response?.status === 207 && responseBody) {
-    const parsedResults = parseTrackApiMultiStatusResponse(responseBody, batch.length)
-    if (parsedResults) {
-      return parsedResults
+    if ((response?.status === 200 || response?.status === 207) && responseBody) {
+      const parsedResults = parseTrackApiMultiStatusResponse(responseBody, options, batch)
+      if (parsedResults) {
+        return parsedResults
+      }
     }
-  }
 
-  if (response?.status === 200 && responseBody) {
-    const parsedResults = parseTrackApiMultiStatusResponse(responseBody, batch.length)
-    if (parsedResults) {
-      return parsedResults
+    return response
+  } catch (err) {
+    const error = err as { message?: string; response?: { status?: number } }
+    const status = error.response?.status ?? 500
+    const message = error.message ?? 'Unknown error'
+
+    const multiStatusResponse = new MultiStatusResponse()
+    for (let i = 0; i < options.length; i++) {
+      multiStatusResponse.setErrorResponseAtIndex(i, {
+        status,
+        errormessage: message,
+        body: options[i].payload,
+        sent: batch[i]
+      })
     }
+    return multiStatusResponse
   }
-
-  return response
 }
 
 interface TrackApiError {
@@ -241,7 +254,7 @@ interface TrackApiError {
   message?: string
 }
 
-interface TrackApiResponse {
+interface CustomerIOBatchResponse {
   errors?: TrackApiError[]
 }
 
@@ -266,7 +279,7 @@ function mapTrackApiReasonToErrorCode(reason: string | undefined) {
   }
 }
 
-function getResponseBody(response: RequestResponse): unknown {
+function getResponseBody(response: RequestResponse): CustomerIOBatchResponse | string | undefined {
   const body = response.data ?? response.content ?? response.body
 
   if (typeof body !== 'string') {
@@ -285,7 +298,11 @@ function getResponseBody(response: RequestResponse): unknown {
   }
 }
 
-export function parseTrackApiErrors(errors: TrackApiError[], totalItems: number): MultiStatusResponse {
+export function parseTrackApiErrors<Payload extends BasePayload>(
+  errors: TrackApiError[],
+  options: RequestPayload<Payload>[],
+  batch: Record<string, unknown>[]
+): MultiStatusResponse {
   const multiStatusResponse = new MultiStatusResponse()
   const errorMap = new Map<number, TrackApiError>()
 
@@ -295,14 +312,14 @@ export function parseTrackApiErrors(errors: TrackApiError[], totalItems: number)
     }
   }
 
-  for (let i = 0; i < totalItems; i++) {
+  for (let i = 0; i < options.length; i++) {
     const error = errorMap.get(i)
 
     if (!error) {
       multiStatusResponse.setSuccessResponseAtIndex(i, {
         status: 200,
-        body: {},
-        sent: {}
+        body: options[i].payload,
+        sent: batch[i]
       })
       continue
     }
@@ -311,27 +328,29 @@ export function parseTrackApiErrors(errors: TrackApiError[], totalItems: number)
       status: 400,
       errormessage: error.message || `${error.reason || 'ERROR'}: ${error.field || 'unknown field'}`,
       errortype: mapTrackApiReasonToErrorCode(error.reason),
-      body: error
+      body: options[i].payload,
+      sent: batch[i]
     })
   }
 
   return multiStatusResponse
 }
 
-export function parseTrackApiMultiStatusResponse(
-  responseBody: unknown,
-  totalItems: number
+export function parseTrackApiMultiStatusResponse<Payload extends BasePayload>(
+  responseBody: CustomerIOBatchResponse | string | undefined,
+  options: RequestPayload<Payload>[],
+  batch: Record<string, unknown>[]
 ): MultiStatusResponse | null {
   if (!isRecord(responseBody)) {
     return null
   }
 
-  const { errors } = responseBody as TrackApiResponse
+  const { errors } = responseBody as CustomerIOBatchResponse
   if (!Array.isArray(errors) || errors.length === 0) {
     return null
   }
 
-  return parseTrackApiErrors(errors, totalItems)
+  return parseTrackApiErrors(errors, options, batch)
 }
 
 export const sendSingle = <Payload extends BasePayload>(request: RequestClient, options: RequestPayload<Payload>) => {