Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 46 additions & 14 deletions src/v0/destinations/fb_custom_audience/recordTransform.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import {
ConfigurationError,
groupByInBatches,
forEachInBatches,
mapInBatches,
} from '@rudderstack/integrations-lib';
import type { Metadata } from '../../../types';
import type {
Expand All @@ -22,6 +21,8 @@ import {
checkSubsetOfArray,
returnArrayOfSubarrays,
getSuccessRespEvents,
getErrorRespEvents,
generateErrorObject,
isEventSentByVDMV2Flow,
isEventSentByVDMV1Flow,
isDefinedAndNotNullAndNotEmpty,
Expand Down Expand Up @@ -52,7 +53,7 @@ const processRecord = (
disableFormat: boolean | undefined,
workspaceId: string,
destinationId: string,
): { dataElement: unknown[]; metadata: Metadata } => {
): { metadata: Metadata } & ({ dataElement: unknown[] } | { error: string }) => {
const fields = record.message.fields!;
let dataElement: unknown[] = [];
let nullUserData = true;
Expand Down Expand Up @@ -85,9 +86,10 @@ const processRecord = (
});

if (nullUserData) {
throw new InstrumentationError(
`All user properties [${userSchema.join(', ')}] are invalid or null. At least one valid field is required.`,
);
return {
error: `All user properties [${userSchema.join(', ')}] are invalid or null. At least one valid field is required.`,
metadata: record.metadata,
};
}

return { dataElement, metadata: record.metadata };
Expand All @@ -112,21 +114,40 @@ const processRecordEventArray = async (
const { userSchema, isHashRequired, disableFormat, paramsPayload, prepareParams } = config;
const toSendEvents: unknown[] = [];
const metadata: Metadata[] = [];
const invalidEvents: unknown[] = [];

await forEachInBatches(recordChunksArray, async (recordArray) => {
const data = await mapInBatches(recordArray, async (input) => {
const { dataElement, metadata: recordMetadata } = processRecord(
const data: unknown[][] = [];
await forEachInBatches(recordArray, async (input) => {
const result = processRecord(
input,
userSchema,
isHashRequired,
disableFormat,
input.metadata.workspaceId,
destination.ID,
);
metadata.push(recordMetadata);
return dataElement;
if ('error' in result) {
const error = new InstrumentationError(result.error);
const errorObj = generateErrorObject(error);
invalidEvents.push(
getErrorRespEvents(
[result.metadata],
errorObj.status,
errorObj.message,
errorObj.statTags,
),
);
} else {
data.push(result.dataElement!);
metadata.push(result.metadata);
}
});

if (data.length === 0) {
return;
}

const prepareFinalPayload = lodash.cloneDeep(paramsPayload);
prepareFinalPayload.schema = userSchema;
prepareFinalPayload.data = data;
Expand All @@ -149,7 +170,12 @@ const processRecordEventArray = async (
});
});

return getSuccessRespEvents(toSendEvents, metadata, destination, true);
const successResponse =
toSendEvents.length > 0
? getSuccessRespEvents(toSendEvents, metadata, destination, true)
: null;

return { successResponse, invalidEvents };
};

/**
Expand Down Expand Up @@ -258,14 +284,20 @@ async function preparePayload(
const insertResponse = await processAction('insert', 'add');
const updateResponse = await processAction('update', 'add');

const errorResponse = getErrorResponse(groupedRecordsByAction);
const errorResponse = [
...getErrorResponse(groupedRecordsByAction),
...(deleteResponse?.invalidEvents || []),
...(insertResponse?.invalidEvents || []),
...(updateResponse?.invalidEvents || []),
];

const finalResponse = createFinalResponse(
deleteResponse,
insertResponse,
updateResponse,
deleteResponse?.successResponse,
insertResponse?.successResponse,
updateResponse?.successResponse,
errorResponse,
);

if (finalResponse.length === 0) {
throw new InstrumentationError(
'Missing valid parameters, unable to generate transformed payload',
Expand Down
170 changes: 123 additions & 47 deletions test/integrations/destinations/fb_custom_audience/router/data.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import {
rETLRecordV1RouterRequest,
rETLRecordV2RouterRequest,
rETLRecordV2AllNullRouterRequest,
rETLRecordV2RouterInvalidRequest,
rETLRecordV2RouterRequestWithValueBasedAudience,
rETLRecordV2RouterInvalidRequestWithValueBasedAudience,
Expand Down Expand Up @@ -884,59 +885,134 @@ export const data = [
body: {
output: [
{
batched: false,
error:
'All user properties [EMAIL, FI] are invalid or null. At least one valid field is required.',
metadata: [
batched: true,
batchedRequest: [
{
attemptNum: 1,
destinationId: 'default-destinationId',
dontBatch: false,
jobId: 1,
secret: {
accessToken: defaultAccessToken,
version: '1',
type: 'REST',
method: 'POST',
endpoint: 'https://graph.facebook.com/v23.0/23848494844100489/users',
endpointPath: 'users',
headers: {},
params: {
access_token: 'ABC',
payload: {
schema: ['EMAIL', 'FI'],
data: [
[
'b100c2ec0718fe6b4805b623aeec6710719d042ceea55f5c8135b010ec1c7b36',
'1e14a2f476f7611a8b22bc85d14237fdc88aac828737e739416c32c5bce3bd16',
],
[
'b100c2ec0718fe6b4805b623aeec6710719d042ceea55f5c8135b010ec1c7b36',
'1e14a2f476f7611a8b22bc85d14237fdc88aac828737e739416c32c5bce3bd16',
],
[
'b100c2ec0718fe6b4805b623aeec6710719d042ceea55f5c8135b010ec1c7b36',
'1e14a2f476f7611a8b22bc85d14237fdc88aac828737e739416c32c5bce3bd16',
],
],
},
},
sourceId: 'default-sourceId',
userId: 'default-userId',
workspaceId: 'default-workspaceId',
},
{
attemptNum: 1,
destinationId: 'default-destinationId',
dontBatch: false,
jobId: 2,
secret: {
accessToken: defaultAccessToken,
body: {
JSON: {},
JSON_ARRAY: {},
XML: {},
FORM: {},
},
sourceId: 'default-sourceId',
userId: 'default-userId',
workspaceId: 'default-workspaceId',
files: {},
},
{
attemptNum: 1,
destinationId: 'default-destinationId',
dontBatch: false,
jobId: 3,
secret: {
accessToken: defaultAccessToken,
},
sourceId: 'default-sourceId',
userId: 'default-userId',
workspaceId: 'default-workspaceId',
],
metadata: [generateMetadata(1), generateMetadata(2), generateMetadata(3)],
destination: {
Config: {
accessToken: 'ABC',
disableFormat: false,
isHashRequired: true,
isRaw: false,
skipVerify: false,
subType: 'NA',
type: 'NA',
},
{
attemptNum: 1,
destinationId: 'default-destinationId',
dontBatch: false,
jobId: 4,
secret: {
accessToken: defaultAccessToken,
},
sourceId: 'default-sourceId',
userId: 'default-userId',
workspaceId: 'default-workspaceId',
ID: '1mMy5cqbtfuaKZv1IhVQKnBdVwe',
Name: 'FB_CUSTOM_AUDIENCE',
Enabled: true,
WorkspaceID: '1TSN08muJTZwH8iCDmnnRt1pmLd',
DestinationDefinition: {
ID: '1aIXqM806xAVm92nx07YwKbRrO9',
Name: 'FB_CUSTOM_AUDIENCE',
DisplayName: 'FB_CUSTOM_AUDIENCE',
Config: {},
},
],
Transformations: [],
IsConnectionEnabled: true,
IsProcessorEnabled: true,
},
statusCode: 200,
},
{
batched: false,
error:
'All user properties [EMAIL, FI] are invalid or null. At least one valid field is required.',
metadata: [generateMetadata(4)],
statusCode: 400,
statTags: {
errorCategory: 'dataValidation',
errorType: 'instrumentation',
destType: 'FB_CUSTOM_AUDIENCE',
module: 'destination',
implementation: 'native',
feature: 'router',
destinationId: 'default-destinationId',
workspaceId: 'default-workspaceId',
},
},
],
},
},
},
},
{
name: 'fb_custom_audience',
description: 'rETL record V2 all events have null user data',
scenario: 'Framework',
successCriteria:
'all record events should return individual error responses when all user properties are null',
feature: 'router',
module: 'destination',
version: 'v0',
input: {
request: {
body: rETLRecordV2AllNullRouterRequest,
},
},
output: {
response: {
status: 200,
body: {
output: [
{
batched: false,
error:
'All user properties [EMAIL, FI] are invalid or null. At least one valid field is required.',
metadata: [generateMetadata(1)],
statusCode: 400,
statTags: {
errorCategory: 'dataValidation',
errorType: 'instrumentation',
destType: 'FB_CUSTOM_AUDIENCE',
module: 'destination',
implementation: 'native',
feature: 'router',
destinationId: 'default-destinationId',
workspaceId: 'default-workspaceId',
},
},
{
batched: false,
error:
'All user properties [EMAIL, FI] are invalid or null. At least one valid field is required.',
metadata: [generateMetadata(2)],
statusCode: 400,
statTags: {
errorCategory: 'dataValidation',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,58 @@ export const rETLRecordV2RouterRequest: RouterTransformationRequest = {
destType: 'fb_custom_audience',
};

export const rETLRecordV2AllNullRouterRequest: RouterTransformationRequest = {
input: [
{
destination: destinationV2,
connection: connection,
message: {
action: 'insert',
context: {
sources: {
job_run_id: 'cgiiurt8um7k7n5dq480',
task_run_id: 'cgiiurt8um7k7n5dq48g',
job_id: '2MUWghI7u85n91dd1qzGyswpZan',
version: '895/merge',
},
},
recordId: '1',
rudderId: '1',
identifiers: {
EMAIL: null,
FI: null,
},
type: 'record',
},
metadata: generateMetadata(1),
},
{
destination: destinationV2,
connection: connection,
message: {
action: 'insert',
context: {
sources: {
job_run_id: 'cgiiurt8um7k7n5dq480',
task_run_id: 'cgiiurt8um7k7n5dq48g',
job_id: '2MUWghI7u85n91dd1qzGyswpZan',
version: '895/merge',
},
},
recordId: '2',
rudderId: '2',
identifiers: {
EMAIL: null,
FI: null,
},
type: 'record',
},
metadata: generateMetadata(2),
},
],
destType: 'fb_custom_audience',
};

export const rETLRecordV2RouterInvalidRequest: RouterTransformationRequest = {
input: [
{
Expand Down
Loading