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.

Sign up for GitHub

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: add support for custom properties for braze purchase events #2856

Merged
merged 3 commits into from
Dec 6, 2023
Merged

fix: add support for custom properties for braze purchase events #2856

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2d403c9
fix: add support for custom properties for braze purchase events
utsabc Nov 29, 2023
2868d3c
fix: add config optio to support custom props for purchase event
utsabc Dec 1, 2023
de171b4
feat: address review comments
utsabc Dec 6, 2023
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
141 changes: 141 additions & 0 deletions src/v0/destinations/braze/braze.util.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1219,4 +1219,145 @@ describe('getPurchaseObjs', () => {
);
}
});

test('products having extra properties', () => {
const output = getPurchaseObjs(
{
properties: {
products: [
{ product_id: '123', price: 10.99, quantity: 2, random_extra_property_a: 'abc' },
{ product_id: '456', price: 5.49, quantity: 1, random_extra_property_b: 'efg' },
{
product_id: '789',
price: 15.49,
quantity: 1,
random_extra_property_a: 'abc',
random_extra_property_b: 'efg',
random_extra_property_c: 'hij',
},
],
currency: 'USD',
},
timestamp: '2023-08-04T12:34:56Z',
anonymousId: 'abc',
},
{
sendPurchaseEventWithExtraProperties: true,
},
);
expect(output).toEqual([
{
product_id: '123',
price: 10.99,
currency: 'USD',
quantity: 2,
time: '2023-08-04T12:34:56Z',
properties: {
random_extra_property_a: 'abc',
},
_update_existing_only: false,
user_alias: {
alias_name: 'abc',
alias_label: 'rudder_id',
},
},
{
product_id: '456',
price: 5.49,
currency: 'USD',
quantity: 1,
time: '2023-08-04T12:34:56Z',
properties: {
random_extra_property_b: 'efg',
},
_update_existing_only: false,
user_alias: {
alias_name: 'abc',
alias_label: 'rudder_id',
},
},
{
product_id: '789',
price: 15.49,
currency: 'USD',
quantity: 1,
time: '2023-08-04T12:34:56Z',
properties: {
random_extra_property_a: 'abc',
random_extra_property_b: 'efg',
random_extra_property_c: 'hij',
},
_update_existing_only: false,
user_alias: {
alias_name: 'abc',
alias_label: 'rudder_id',
},
},
]);
});

test('products having extra properties with sendPurchaseEventWithExtraProperties as false', () => {
const output = getPurchaseObjs(
{
properties: {
products: [
{ product_id: '123', price: 10.99, quantity: 2, random_extra_property_a: 'abc' },
{ product_id: '456', price: 5.49, quantity: 1, random_extra_property_b: 'efg' },
{
product_id: '789',
price: 15.49,
quantity: 1,
random_extra_property_a: 'abc',
random_extra_property_b: 'efg',
random_extra_property_c: 'hij',
},
],
currency: 'USD',
},
timestamp: '2023-08-04T12:34:56Z',
anonymousId: 'abc',
},
{
sendPurchaseEventWithExtraProperties: false,
},
);
expect(output).toEqual([
{
product_id: '123',
price: 10.99,
currency: 'USD',
quantity: 2,
time: '2023-08-04T12:34:56Z',
_update_existing_only: false,
user_alias: {
alias_name: 'abc',
alias_label: 'rudder_id',
},
},
{
product_id: '456',
price: 5.49,
currency: 'USD',
quantity: 1,
time: '2023-08-04T12:34:56Z',
_update_existing_only: false,
user_alias: {
alias_name: 'abc',
alias_label: 'rudder_id',
},
},
{
product_id: '789',
price: 15.49,
currency: 'USD',
quantity: 1,
time: '2023-08-04T12:34:56Z',
_update_existing_only: false,
user_alias: {
alias_name: 'abc',
alias_label: 'rudder_id',
},
},
]);
});
});
4 changes: 3 additions & 1 deletion src/v0/destinations/braze/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ const BRAZE_NON_BILLABLE_ATTRIBUTES = [
'subscription_groups',
];

const BRAZE_PURCHASE_STANDARD_PROPERTIES = ['product_id', 'sku', 'price', 'quantity', 'currency'];
module.exports = {
ConfigCategory,
mappingConfig,
Expand All @@ -64,12 +65,13 @@ module.exports = {
getSubscriptionGroupEndPoint,
getAliasMergeEndPoint,
BRAZE_PARTNER_NAME,
BRAZE_PURCHASE_STANDARD_PROPERTIES,
TRACK_BRAZE_MAX_REQ_COUNT,
IDENTIFY_BRAZE_MAX_REQ_COUNT,
DESTINATION,
CustomAttributeOperationTypes,
DEL_MAX_BATCH_SIZE,
BRAZE_NON_BILLABLE_ATTRIBUTES,
ALIAS_BRAZE_MAX_REQ_COUNT,
SUBSCRIPTION_BRAZE_MAX_REQ_COUNT
SUBSCRIPTION_BRAZE_MAX_REQ_COUNT,
};
2 changes: 1 addition & 1 deletion src/v0/destinations/braze/transform.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ function processTrackEvent(messageType, message, destination, mappingJson, proce
typeof eventName === 'string' &&
eventName.toLowerCase() === 'order completed'
) {
const purchaseObjs = getPurchaseObjs(message);
const purchaseObjs = getPurchaseObjs(message, destination.Config);

// del used properties
delete properties.products;
Expand Down
7 changes: 6 additions & 1 deletion src/v0/destinations/braze/util.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ const {
SUBSCRIPTION_BRAZE_MAX_REQ_COUNT,
ALIAS_BRAZE_MAX_REQ_COUNT,
TRACK_BRAZE_MAX_REQ_COUNT,
BRAZE_PURCHASE_STANDARD_PROPERTIES,
} = require('./config');
const { JSON_MIME_TYPE, HTTP_STATUS_CODES } = require('../../util/constant');
const { isObject } = require('../../util');
Expand Down Expand Up @@ -539,7 +540,7 @@ function addMandatoryPurchaseProperties(productId, price, currencyCode, quantity
};
}

function getPurchaseObjs(message) {
function getPurchaseObjs(message, config) {
// ref:https://www.braze.com/docs/api/objects_filters/purchase_object/
const validateForPurchaseEvent = (message) => {
const { properties } = message;
Expand Down Expand Up @@ -634,6 +635,10 @@ function getPurchaseObjs(message) {
parseInt(quantity, 10),
timestamp,
);
const extraProperties = _.omit(product, BRAZE_PURCHASE_STANDARD_PROPERTIES);
if (Object.keys(extraProperties).length > 0 && config.sendPurchaseEventWithExtraProperties) {
purchaseObj = { ...purchaseObj, properties: extraProperties };
}
purchaseObj = setExternalIdOrAliasObject(purchaseObj, message);
purchaseObjs.push(purchaseObj);
});
Expand Down
96 changes: 96 additions & 0 deletions test/__tests__/data/braze_input.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1814,5 +1814,101 @@
"type": "track",
"userId": "mickeyMouse"
}
},
{
"destination": {
"Config": {
"restApiKey": "dummyApiKey",
"prefixProperties": true,
"useNativeSDK": false,
"sendPurchaseEventWithExtraProperties": true
},
"DestinationDefinition": {
"DisplayName": "Braze",
"ID": "1WhbSZ6uA3H5ChVifHpfL2H6sie",
"Name": "BRAZE"
},
"Enabled": true,
"ID": "1WhcOCGgj9asZu850HvugU2C3Aq",
"Name": "Braze",
"Transformations": []
},
"message": {
"anonymousId": "e6ab2c5e-2cda-44a9-a962-e2f67df78bca",
"channel": "web",
"context": {
"app": {
"build": "1.0.0",
"name": "RudderLabs JavaScript SDK",
"namespace": "com.rudderlabs.javascript",
"version": "1.0.5"
},
"ip": "0.0.0.0",
"library": {
"name": "RudderLabs JavaScript SDK",
"version": "1.0.5"
},
"locale": "en-GB",
"os": {
"name": "",
"version": ""
},
"screen": {
"density": 2
},
"traits": {
"city": "Disney",
"country": "USA",
"email": "[email protected]",
"firstname": "Mickey"
},
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.117 Safari/537.36"
},
"event": "Order Completed",
"integrations": {
"All": true
},
"messageId": "aa5f5e44-8756-40ad-ad1e-b0d3b9fa710a",
"originalTimestamp": "2020-01-24T06:29:02.367Z",
"properties": {
"affiliation": "Google Store",
"checkout_id": "fksdjfsdjfisjf9sdfjsd9f",
"coupon": "hasbros",
"currency": "USD",
"discount": 2.5,
"order_id": "50314b8e9bcf000000000000",
"products": [
{
"category": "Games",
"image_url": "https:///www.example.com/product/path.jpg",
"name": "Monopoly: 3rd Edition",
"price": 0,
"product_id": "507f1f77bcf86cd799439023",
"quantity": 1,
"sku": "45790-32",
"url": "https://www.example.com/product/path"
},
{
"category": "Games",
"name": "Uno Card Game",
"price": 0,
"product_id": "505bd76785ebb509fc183724",
"quantity": 2,
"sku": "46493-32"
}
],
"revenue": 25,
"shipping": 3,
"subtotal": 22.5,
"tax": 2,
"total": 27.5
},
"receivedAt": "2020-01-24T11:59:02.403+05:30",
"request_ip": "[::1]:53712",
"sentAt": "2020-01-24T06:29:02.368Z",
"timestamp": "2020-01-24T11:59:02.402+05:30",
"type": "track",
"userId": ""
}
}
]
71 changes: 71 additions & 0 deletions test/__tests__/data/braze_output.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -963,5 +963,76 @@
},
"files": {},
"userId": "mickeyMouse"
},
{
"body": {
"FORM": {},
"JSON": {
"attributes": [
{
"_update_existing_only": false,
"city": "Disney",
"country": "USA",
"email": "[email protected]",
"firstname": "Mickey",
"user_alias": {
"alias_label": "rudder_id",
"alias_name": "e6ab2c5e-2cda-44a9-a962-e2f67df78bca"
}
}
],
"partner": "RudderStack",
"purchases": [
{
"_update_existing_only": false,
"currency": "USD",
"price": 0,
"product_id": "507f1f77bcf86cd799439023",
"properties": {
"category": "Games",
"image_url": "https:///www.example.com/product/path.jpg",
"name": "Monopoly: 3rd Edition",
"url": "https://www.example.com/product/path"
},
"quantity": 1,
"time": "2020-01-24T11:59:02.402+05:30",
"user_alias": {
"alias_label": "rudder_id",
"alias_name": "e6ab2c5e-2cda-44a9-a962-e2f67df78bca"
}
},
{
"_update_existing_only": false,
"currency": "USD",
"price": 0,
"product_id": "505bd76785ebb509fc183724",
"properties": {
"category": "Games",
"name": "Uno Card Game"
},
"quantity": 2,
"time": "2020-01-24T11:59:02.402+05:30",
"user_alias": {
"alias_label": "rudder_id",
"alias_name": "e6ab2c5e-2cda-44a9-a962-e2f67df78bca"
}
}
]
},
"JSON_ARRAY": {},
"XML": {}
},
"endpoint": "https://rest.fra-01.braze.eu/users/track",
"files": {},
"headers": {
"Accept": "application/json",
"Authorization": "Bearer dummyApiKey",
"Content-Type": "application/json"
},
"method": "POST",
"params": {},
"type": "REST",
"userId": "e6ab2c5e-2cda-44a9-a962-e2f67df78bca",
"version": "1"
}
]
Loading