Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: refactor code and add validation for values #3971

Merged
merged 3 commits into from
Jan 20, 2025
Merged
Show file tree
Hide file tree
Changes from 2 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
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
],
"required": true,
"metadata": {
"type": "toNumber"
"type": "toNumber",
"regex": "^([1-9]\\d*(\\.\\d+)?|0\\.\\d+)$"
ItsSudip marked this conversation as resolved.
Show resolved Hide resolved
}
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ const {
getClickConversionPayloadAndEndpoint,
getConsentsDataFromIntegrationObj,
getCallConversionPayload,
updateConversion,
} = require('./utils');
const helper = require('./helper');

Expand Down Expand Up @@ -49,9 +48,6 @@ const getConversions = (message, metadata, { Config }, event, conversionType) =>
filteredCustomerId,
eventLevelConsentsData,
);
convertedPayload.payload.conversions[0] = updateConversion(
convertedPayload.payload.conversions[0],
);
payload = convertedPayload.payload;
endpoint = convertedPayload.endpoint;
} else if (conversionType === 'store') {
Expand Down
40 changes: 21 additions & 19 deletions src/v0/destinations/google_adwords_offline_conversions/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -346,6 +346,26 @@ const populateUserIdentifier = ({ email, phone, properties, payload, UserIdentif
}
return copiedPayload;
};

/**
* remove redundant ids
* @param {*} conversionCopy
*/
const updateConversion = (conversion) => {
ItsSudip marked this conversation as resolved.
Show resolved Hide resolved
const conversionCopy = cloneDeep(conversion);
if (conversionCopy.gclid) {
delete conversionCopy.wbraid;
delete conversionCopy.gbraid;
}
if (conversionCopy.wbraid && conversionCopy.gbraid) {
throw new InstrumentationError(`You can't use both wbraid and gbraid.`);
}
if (conversionCopy.wbraid || conversionCopy.gbraid) {
delete conversionCopy.userIdentifiers;
}
return conversionCopy;
};

const getClickConversionPayloadAndEndpoint = (
message,
Config,
Expand Down Expand Up @@ -423,6 +443,7 @@ const getClickConversionPayloadAndEndpoint = (
const consentObject = finaliseConsent(consentConfigMap, eventLevelConsent, Config);
// here conversions[0] is expected to be present there are some mandatory properties mapped in the mapping json.
set(payload, 'conversions[0].consent', consentObject);
payload.conversions[0] = updateConversion(payload.conversions[0]);
return { payload, endpoint };
};

Expand All @@ -431,25 +452,6 @@ const getConsentsDataFromIntegrationObj = (message) => {
return integrationObj?.consents || {};
};

/**
* remove redundant ids
* @param {*} conversionCopy
*/
const updateConversion = (conversion) => {
const conversionCopy = cloneDeep(conversion);
if (conversionCopy.gclid) {
delete conversionCopy.wbraid;
delete conversionCopy.gbraid;
}
if (conversionCopy.wbraid && conversionCopy.gbraid) {
throw new InstrumentationError(`You can't use both wbraid and gbraid.`);
}
if (conversionCopy.wbraid || conversionCopy.gbraid) {
delete conversionCopy.userIdentifiers;
}
return conversionCopy;
};

module.exports = {
validateDestinationConfig,
generateItemListFromProducts,
Expand Down
11 changes: 10 additions & 1 deletion src/v0/util/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -971,6 +971,7 @@ const handleMetadataForValue = (value, metadata, destKey, integrationsObj = null
validateTimestamp,
allowedKeyCheck,
toArray,
regex,
} = metadata;

// if value is null and defaultValue is supplied - use that
Expand Down Expand Up @@ -1044,7 +1045,14 @@ const handleMetadataForValue = (value, metadata, destKey, integrationsObj = null
}
return [formattedVal];
}

if (regex) {
const regexPattern = new RegExp(regex);
if (!regexPattern.test(formattedVal)) {
throw new InstrumentationError(
`The value '${formattedVal}' does not match the regex pattern, ${regex}`,
);
}
}
return formattedVal;
};

Expand Down Expand Up @@ -2489,4 +2497,5 @@ module.exports = {
removeEmptyKey,
isAxiosError,
convertToUuid,
handleMetadataForValue,
};
24 changes: 24 additions & 0 deletions src/v0/util/index.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -1049,3 +1049,27 @@ describe('convertToUuid', () => {
expect(result).toBe('672ca00c-37f4-5d71-b8c3-6ae0848080ec');
});
});

describe('', () => {
it('should return original value when regex pattern is invalid', () => {
const value = 'test value';
const metadata = {
regex: `\\b(?!1000\\b)\\d{4,}\\b`,
};
try {
const result = utilities.handleMetadataForValue(value, metadata);
} catch (e) {
expect(e.message).toBe(
`The value 'test value' does not match the regex pattern, \\b(?!1000\\b)\\d{4,}\\b`,
);
}
});
it('should return true when the regex matches', () => {
const value = 1003;
const metadata = {
regex: `\\b(?!1000\\b)\\d{4,}\\b`,
};
const res = utilities.handleMetadataForValue(value, metadata);
expect(res).toBe(1003);
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -5929,4 +5929,112 @@ export const data = [
},
mockFns: timestampMock,
},
{
name: 'google_adwords_offline_conversions',
description: 'Test 29 : store conversion which has value less than 0, should throw error',
feature: 'processor',
module: 'destination',
version: 'v0',
input: {
request: {
body: [
{
message: {
channel: 'web',
context: {
traits: {},
},
event: 'Product Clicked',
type: 'track',
messageId: '5e10d13a-bf9a-44bf-b884-43a9e591ea71',
anonymousId: '00000000000000000000000000',
userId: '12345',
properties: {
item_id: 'item id',
merchant_id: 'merchant id',
currency: 'INR',
revenue: '0',
store_code: 'store code',
gclid: 'gclid',
conversionDateTime: '2019-10-14T11:15:18.299Z',
product_id: '123445',
quantity: 123,
},
integrations: {
google_adwords_offline_conversion: {
consent: {
adUserdata: 'UNSPECIFIED',
adPersonalization: 'GRANTED',
},
},
},
name: 'ApplicationLoaded',
sentAt: '2019-10-14T11:15:53.296Z',
},
metadata: {
secret: {
access_token: 'abcd1234',
refresh_token: 'efgh5678',
developer_token: 'ijkl91011',
},
},
destination: {
Config: {
isCustomerAllowed: false,
customerId: '111-222-3333',
subAccount: true,
loginCustomerId: 'login-customer-id',
userDataConsent: 'GRANTED',
personalizationConsent: 'DENIED',
eventsToOfflineConversionsTypeMapping: [
{
from: 'Product Clicked',
to: 'store',
},
],
eventsToConversionsNamesMapping: [
{
from: 'Product Clicked',
to: 'Sign-up - click',
},
],
hashUserIdentifier: true,
defaultUserIdentifier: 'phone',
validateOnly: false,
rudderAccountId: '2EOknn1JNH7WK1MfNkgr4t3u4fGYKkRK',
},
},
},
],
},
},
output: {
response: {
status: 200,
body: [
{
error:
"The value '0' does not match the regex pattern, ^([1-9]\\d*(\\.\\d+)?|0\\.\\d+)$",
metadata: {
secret: {
access_token: 'abcd1234',
developer_token: 'ijkl91011',
refresh_token: 'efgh5678',
},
},
statTags: {
destType: 'GOOGLE_ADWORDS_OFFLINE_CONVERSIONS',
errorCategory: 'dataValidation',
errorType: 'instrumentation',
feature: 'processor',
implementation: 'native',
module: 'destination',
},
statusCode: 400,
},
],
},
},
mockFns: timestampMock,
},
];
Loading