fix: update proxy data type for response handler input (#3030)

package.json

@@ -113,7 +113,8 @@
     "ua-parser-js": "^1.0.37",
     "unset-value": "^2.0.1",
     "uuid": "^9.0.0",
-    "valid-url": "^1.0.9"
+    "valid-url": "^1.0.9",
+    "zod": "^3.22.4"
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^17.6.3",

src/adapters/networkhandler/genericNetworkHandler.js

@@ -17,13 +17,14 @@ const tags = require('../../v0/util/tags');
  * will act as fall-fack for such scenarios.
  *
  */
-const responseHandler = (destinationResponse, dest) => {
+const responseHandler = (responseParams) => {
+  const { destinationResponse, destType } = responseParams;
   const { status } = destinationResponse;
-  const message = `[Generic Response Handler] Request for destination: ${dest} Processed Successfully`;
+  const message = `[Generic Response Handler] Request for destination: ${destType} Processed Successfully`;
   // if the response from destination is not a success case build an explicit error
   if (!isHttpStatusSuccess(status)) {
     throw new NetworkError(
-      `[Generic Response Handler] Request failed for destination ${dest} with status: ${status}`,
+      `[Generic Response Handler] Request failed for destination ${destType} with status: ${status}`,
       status,
       {
         [tags.TAG_NAMES.ERROR_TYPE]: getDynamicErrorType(status),

src/controllers/delivery.ts

@@ -1,13 +1,14 @@
 /* eslint-disable prefer-destructuring */
 /* eslint-disable sonarjs/no-duplicate-string */
 import { Context } from 'koa';
+import { isDefinedAndNotNullAndNotEmpty } from '@rudderstack/integrations-lib';
 import { MiscService } from '../services/misc';
 import {
-  DeliveriesResponse,
-  DeliveryResponse,
+  DeliveryV1Response,
+  DeliveryV0Response,
   ProcessorTransformationOutput,
-  ProxyDeliveriesRequest,
-  ProxyDeliveryRequest,
+  ProxyV0Request,
+  ProxyV1Request,
 } from '../types/index';
 import { ServiceSelector } from '../helpers/serviceSelector';
 import { DeliveryTestService } from '../services/delivertTest/deliveryTest';
@@ -22,9 +23,9 @@ const NON_DETERMINABLE = 'Non-determinable';
 export class DeliveryController {
   public static async deliverToDestination(ctx: Context) {
     logger.debug('Native(Delivery):: Request to transformer::', JSON.stringify(ctx.request.body));
-    let deliveryResponse: DeliveryResponse;
+    let deliveryResponse: DeliveryV0Response;
     const requestMetadata = MiscService.getRequestMetadata(ctx);
-    const deliveryRequest = ctx.request.body as ProxyDeliveryRequest;
+    const deliveryRequest = ctx.request.body as ProxyV0Request;
     const { destination }: { destination: string } = ctx.params;
     const integrationService = ServiceSelector.getNativeDestinationService();
     try {
@@ -33,7 +34,7 @@ export class DeliveryController {
         destination,
         requestMetadata,
         'v0',
-      )) as DeliveryResponse;
+      )) as DeliveryV0Response;
     } catch (error: any) {
       const { metadata } = deliveryRequest;
       const metaTO = integrationService.getTags(
@@ -57,9 +58,9 @@ export class DeliveryController {
 
   public static async deliverToDestinationV1(ctx: Context) {
     logger.debug('Native(Delivery):: Request to transformer::', JSON.stringify(ctx.request.body));
-    let deliveryResponse: DeliveriesResponse;
+    let deliveryResponse: DeliveryV1Response;
     const requestMetadata = MiscService.getRequestMetadata(ctx);
-    const deliveryRequest = ctx.request.body as ProxyDeliveriesRequest;
+    const deliveryRequest = ctx.request.body as ProxyV1Request;
     const { destination }: { destination: string } = ctx.params;
     const integrationService = ServiceSelector.getNativeDestinationService();
     try {
@@ -68,7 +69,7 @@ export class DeliveryController {
         destination,
         requestMetadata,
         'v1',
-      )) as DeliveriesResponse;
+      )) as DeliveryV1Response;
     } catch (error: any) {
       const { metadata } = deliveryRequest;
       const metaTO = integrationService.getTags(
@@ -84,7 +85,11 @@ export class DeliveryController {
       );
     }
     ctx.body = { output: deliveryResponse };
-    ControllerUtility.deliveryPostProcess(ctx, deliveryResponse.status);
+    if (isDefinedAndNotNullAndNotEmpty(deliveryResponse.authErrorCategory)) {
+      ControllerUtility.deliveryPostProcess(ctx, deliveryResponse.status);
+    } else {
+      ControllerUtility.deliveryPostProcess(ctx);
+    }
 
     logger.debug('Native(Delivery):: Response from transformer::', JSON.stringify(ctx.body));
     return ctx;

src/interfaces/DestinationService.ts

@@ -1,5 +1,5 @@
 import {
-  DeliveryResponse,
+  DeliveryV0Response,
   MetaTransferObject,
   ProcessorTransformationRequest,
   ProcessorTransformationResponse,
@@ -8,7 +8,7 @@ import {
   UserDeletionRequest,
   UserDeletionResponse,
   ProxyRequest,
-  DeliveriesResponse,
+  DeliveryV1Response,
 } from '../types/index';
 
 export interface DestinationService {
@@ -49,7 +49,7 @@ export interface DestinationService {
     destinationType: string,
     requestMetadata: NonNullable<unknown>,
     version: string,
-  ): Promise<DeliveryResponse | DeliveriesResponse>;
+  ): Promise<DeliveryV0Response | DeliveryV1Response>;
 
   processUserDeletion(
     requests: UserDeletionRequest[],

src/services/comparator.ts

@@ -1,8 +1,8 @@
 /* eslint-disable class-methods-use-this */
 import { DestinationService } from '../interfaces/DestinationService';
 import {
-  DeliveriesResponse,
-  DeliveryResponse,
+  DeliveryV0Response,
+  DeliveryV1Response,
   Destination,
   ErrorDetailer,
   MetaTransferObject,
@@ -370,7 +370,7 @@ export class ComparatorService implements DestinationService {
     destinationType: string,
     requestMetadata: NonNullable<unknown>,
     version: string,
-  ): Promise<DeliveryResponse | DeliveriesResponse> {
+  ): Promise<DeliveryV0Response | DeliveryV1Response> {
     const primaryResplist = await this.primaryService.deliver(
       event,
       destinationType,

src/services/destination/cdkV1Integration.ts

@@ -4,7 +4,7 @@ import path from 'path';
 import { TransformationError } from '@rudderstack/integrations-lib';
 import { DestinationService } from '../../interfaces/DestinationService';
 import {
-  DeliveryResponse,
+  DeliveryV0Response,
   ErrorDetailer,
   MetaTransferObject,
   ProcessorTransformationRequest,
@@ -14,7 +14,7 @@ import {
   UserDeletionRequest,
   UserDeletionResponse,
   ProxyRequest,
-  DeliveriesResponse,
+  DeliveryV1Response,
 } from '../../types/index';
 import { DestinationPostTransformationService } from './postTransformation';
 import tags from '../../v0/util/tags';
@@ -121,7 +121,7 @@ export class CDKV1DestinationService implements DestinationService {
     _event: ProxyRequest,
     _destinationType: string,
     _requestMetadata: NonNullable<unknown>,
-  ): Promise<DeliveryResponse | DeliveriesResponse> {
+  ): Promise<DeliveryV0Response | DeliveryV1Response> {
     throw new TransformationError('CDV1 Does not Implement Delivery Routine');
   }
 

src/services/destination/cdkV2Integration.ts

@@ -5,7 +5,7 @@ import { TransformationError } from '@rudderstack/integrations-lib';
 import { processCdkV2Workflow } from '../../cdk/v2/handler';
 import { DestinationService } from '../../interfaces/DestinationService';
 import {
-  DeliveryResponse,
+  DeliveryV0Response,
   ErrorDetailer,
   MetaTransferObject,
   ProcessorTransformationRequest,
@@ -16,7 +16,7 @@ import {
   UserDeletionRequest,
   UserDeletionResponse,
   ProxyRequest,
-  DeliveriesResponse,
+  DeliveryV1Response,
 } from '../../types/index';
 import tags from '../../v0/util/tags';
 import { DestinationPostTransformationService } from './postTransformation';
@@ -170,7 +170,7 @@ export class CDKV2DestinationService implements DestinationService {
     _event: ProxyRequest,
     _destinationType: string,
     _requestMetadata: NonNullable<unknown>,
-  ): Promise<DeliveryResponse | DeliveriesResponse> {
+  ): Promise<DeliveryV0Response | DeliveryV1Response> {
     throw new TransformationError('CDKV2 Does not Implement Delivery Routine');
   }
 

src/services/destination/nativeIntegration.ts

@@ -5,7 +5,7 @@ import groupBy from 'lodash/groupBy';
 import cloneDeep from 'lodash/cloneDeep';
 import { DestinationService } from '../../interfaces/DestinationService';
 import {
-  DeliveryResponse,
+  DeliveryV0Response,
   ErrorDetailer,
   MetaTransferObject,
   ProcessorTransformationRequest,
@@ -16,9 +16,9 @@ import {
   UserDeletionRequest,
   UserDeletionResponse,
   ProxyRequest,
-  ProxyDeliveriesRequest,
-  ProxyDeliveryRequest,
-  DeliveriesResponse,
+  ProxyV0Request,
+  ProxyV1Request,
+  DeliveryV1Response,
   DeliveryJobState,
 } from '../../types/index';
 import { DestinationPostTransformationService } from './postTransformation';
@@ -181,7 +181,7 @@ export class NativeIntegrationDestinationService implements DestinationService {
     destinationType: string,
     _requestMetadata: NonNullable<unknown>,
     version: string,
-  ): Promise<DeliveryResponse | DeliveriesResponse> {
+  ): Promise<DeliveryV0Response | DeliveryV1Response> {
     try {
       const { networkHandler, handlerVersion } = networkHandlerFactory.getNetworkHandler(
         destinationType,
@@ -191,24 +191,22 @@ export class NativeIntegrationDestinationService implements DestinationService {
       const processedProxyResponse = networkHandler.processAxiosResponse(rawProxyResponse);
       let rudderJobMetadata =
         version.toLowerCase() === 'v1'
-          ? (deliveryRequest as ProxyDeliveriesRequest).metadata
-          : (deliveryRequest as ProxyDeliveryRequest).metadata;
+          ? (deliveryRequest as ProxyV1Request).metadata
+          : (deliveryRequest as ProxyV0Request).metadata;
 
       if (version.toLowerCase() === 'v1' && handlerVersion.toLowerCase() === 'v0') {
         rudderJobMetadata = rudderJobMetadata[0];
       }
-
-      let responseProxy = networkHandler.responseHandler(
-        {
-          ...processedProxyResponse,
-          rudderJobMetadata,
-        },
-        destinationType,
-      );
+      const responseParams = {
+        destinationResponse: processedProxyResponse,
+        rudderJobMetadata,
+        destType: destinationType,
+      };
+      let responseProxy = networkHandler.responseHandler(responseParams);
       // Adaption Logic for V0 to V1
       if (handlerVersion.toLowerCase() === 'v0' && version.toLowerCase() === 'v1') {
-        const v0Response = responseProxy as DeliveryResponse;
-        const jobStates = (deliveryRequest as ProxyDeliveriesRequest).metadata.map(
+        const v0Response = responseProxy as DeliveryV0Response;
+        const jobStates = (deliveryRequest as ProxyV1Request).metadata.map(
           (metadata) =>
             ({
               error: JSON.stringify(v0Response.destinationResponse?.response),
@@ -221,7 +219,7 @@ export class NativeIntegrationDestinationService implements DestinationService {
           status: v0Response.status,
           message: v0Response.message,
           authErrorCategory: v0Response.authErrorCategory,
-        } as DeliveriesResponse;
+        } as DeliveryV1Response;
       }
       return responseProxy;
     } catch (err: any) {
@@ -236,10 +234,10 @@ export class NativeIntegrationDestinationService implements DestinationService {
       );
 
       if (version.toLowerCase() === 'v1') {
-        metaTO.metadatas = (deliveryRequest as ProxyDeliveriesRequest).metadata;
+        metaTO.metadatas = (deliveryRequest as ProxyV1Request).metadata;
         return DestinationPostTransformationService.handlevV1DeliveriesFailureEvents(err, metaTO);
       }
-      metaTO.metadata = (deliveryRequest as ProxyDeliveryRequest).metadata;
+      metaTO.metadata = (deliveryRequest as ProxyV0Request).metadata;
       return DestinationPostTransformationService.handleDeliveryFailureEvents(err, metaTO);
     }
   }

src/services/destination/postTransformation.ts

@@ -8,10 +8,10 @@ import {
   ProcessorTransformationResponse,
   RouterTransformationResponse,
   ProcessorTransformationOutput,
-  DeliveryResponse,
+  DeliveryV0Response,
   MetaTransferObject,
   UserDeletionResponse,
-  DeliveriesResponse,
+  DeliveryV1Response,
   DeliveryJobState,
 } from '../../types/index';
 import { generateErrorObject } from '../../v0/util';
@@ -75,7 +75,13 @@ export class DestinationPostTransformationService {
   ): RouterTransformationResponse[] {
     const resultantPayloads: RouterTransformationResponse[] = cloneDeep(transformedPayloads);
     resultantPayloads.forEach((resultantPayload) => {
-      if (resultantPayload.batchedRequest && resultantPayload.batchedRequest.userId) {
+      if (Array.isArray(resultantPayload.batchedRequest)) {
+        resultantPayload.batchedRequest.forEach((batchedRequest) => {
+          if (batchedRequest.userId) {
+            batchedRequest.userId = `${batchedRequest.userId}`;
+          }
+        });
+      } else if (resultantPayload.batchedRequest && resultantPayload.batchedRequest.userId) {
         resultantPayload.batchedRequest.userId = `${resultantPayload.batchedRequest.userId}`;
       }
     });
@@ -145,7 +151,7 @@ export class DestinationPostTransformationService {
   public static handleDeliveryFailureEvents(
     error: any,
     metaTo: MetaTransferObject,
-  ): DeliveryResponse {
+  ): DeliveryV0Response {
     const errObj = generateErrorObject(error, metaTo.errorDetails, false);
     const resp = {
       status: errObj.status,
@@ -155,7 +161,7 @@ export class DestinationPostTransformationService {
       ...(errObj.authErrorCategory && {
         authErrorCategory: errObj.authErrorCategory,
       }),
-    } as DeliveryResponse;
+    } as DeliveryV0Response;
 
     ErrorReportingService.reportError(error, metaTo.errorContext, resp);
     return resp;
@@ -164,7 +170,7 @@ export class DestinationPostTransformationService {
   public static handlevV1DeliveriesFailureEvents(
     error: FixMe,
     metaTo: MetaTransferObject,
-  ): DeliveriesResponse {
+  ): DeliveryV1Response {
     const errObj = generateErrorObject(error, metaTo.errorDetails, false);
     const metadataArray = metaTo.metadatas;
     if (!Array.isArray(metadataArray)) {
@@ -186,10 +192,12 @@ export class DestinationPostTransformationService {
     const resp = {
       response: responses,
       statTags: errObj.statTags,
-      authErrorCategory: errObj.authErrorCategory,
       message: errObj.message.toString(),
       status: errObj.status,
-    } as DeliveriesResponse;
+      ...(errObj.authErrorCategory && {
+        authErrorCategory: errObj.authErrorCategory,
+      }),
+    } as DeliveryV1Response;
 
     ErrorReportingService.reportError(error, metaTo.errorContext, resp);
     return resp;