feat: for reddit adding currency and value for addToCart, viewConent …

…event as well (#3239)

* feat: adding currency and value for addToCart, viewConent event as well

* fix: addressed review comments

* fix: util test cases update

src/cdk/v2/destinations/reddit/procWorkflow.yaml

@@ -12,6 +12,7 @@ bindings:
     path: ../../../../v0/util/index
   - name: OAuthSecretError
     path: '@rudderstack/integrations-lib'
+  - path: ./utils
 
 steps:
   - name: validateInput
@@ -56,14 +57,14 @@ steps:
           const event_type = (eventNames.length === 0 || eventNames[0]==="") ? ({"tracking_type": "Custom", "custom_event_name": event}): ({tracking_type: eventNames[0]});
 
       - name: customFields
-        condition: $.outputs.prepareTrackPayload.eventType.tracking_type === "Purchase"
+        condition: $.outputs.prepareTrackPayload.eventType.tracking_type in ['Purchase', 'AddToCart', 'ViewContent']
         reference: 'https://ads-api.reddit.com/docs/v2/#tag/Conversions/paths/~1api~1v2.0~1conversions~1events~1%7Baccount_id%7D/post'
         template: |
-          const revenue_in_cents = .message.properties.revenue ? Math.round(Number(.message.properties.revenue)*100)
+          const revenue_in_cents = $.populateRevenueField($.outputs.prepareTrackPayload.eventType.tracking_type,^.message.properties)
           const customFields = .message.().({
             "currency": .properties.currency,
             "value_decimal": revenue_in_cents ? revenue_in_cents / 100,
-            "item_count": (Array.isArray(.properties.products) && .properties.products.length) || (.properties.itemCount && Number(.properties.itemCount)),
+            "item_count": $.outputs.prepareTrackPayload.eventType.tracking_type === 'Purchase' ? (Array.isArray(.properties.products) && .properties.products.length) || (.properties.itemCount && Number(.properties.itemCount)) : null,
             "value": revenue_in_cents,
             "conversion_id": .properties.conversionId || .messageId,
           });

src/cdk/v2/destinations/reddit/utils.js

@@ -28,6 +28,59 @@ const batchEvents = (successfulEvents) => {
   const batchedEvents = batchEventChunks(eventChunks);
   return batchedEvents;
 };
+
+const calculateDefaultRevenue = (properties) => {
+  // Check if working with products array
+  if (properties?.products && properties.products.length > 0) {
+    // Check if all product prices are undefined
+    if (properties.products.every((product) => product.price === undefined)) {
+      return null; // Return null if all product prices are undefined
+    }
+    // Proceed with calculation if not all prices are undefined
+    return properties.products.reduce(
+      (acc, product) => acc + (product.price || 0) * (product.quantity || 1),
+      0,
+    );
+  }
+  // For single product scenario, check if price is undefined
+  if (properties.price === undefined) {
+    return null; // Return null if price is undefined
+  }
+  // Proceed with calculation if price is defined
+  return properties.price * (properties.quantity ?? 1);
+};
+
+const populateRevenueField = (eventType, properties) => {
+  let revenueInCents;
+  switch (eventType) {
+    case 'Purchase':
+      revenueInCents =
+        properties.revenue && !Number.isNaN(properties.revenue)
+          ? Math.round(Number(properties?.revenue) * 100)
+          : null;
+      break;
+    case 'AddToCart':
+      revenueInCents =
+        properties.price && !Number.isNaN(properties.price)
+          ? Math.round(Number(properties?.price) * Number(properties?.quantity || 1) * 100)
+          : null;
+      break;
+    default:
+      // for viewContent
+      // eslint-disable-next-line no-case-declarations
+      const revenue = calculateDefaultRevenue(properties);
+      revenueInCents = revenue ? revenue * 100 : null;
+      break;
+  }
+
+  if (lodash.isNaN(revenueInCents)) {
+    return null;
+  }
+  // Return the value as it is if it's not NaN
+  return revenueInCents;
+};
 module.exports = {
   batchEvents,
+  populateRevenueField,
+  calculateDefaultRevenue,
 };

src/cdk/v2/destinations/reddit/utils.test.js

@@ -0,0 +1,121 @@
+const { calculateDefaultRevenue, populateRevenueField } = require('./utils');
+
+describe('calculateDefaultRevenue', () => {
+  // Calculates revenue for a single product with defined price and quantity
+  it('should calculate revenue for a single product with defined price and quantity', () => {
+    const properties = {
+      price: 10,
+      quantity: 2,
+    };
+
+    const result = calculateDefaultRevenue(properties);
+
+    expect(result).toBe(20);
+  });
+
+  // Returns null for properties parameter being undefined
+  it('should return null for price parameter being undefined', () => {
+    const properties = { products: [{ quantity: 1 }] };
+
+    const result = calculateDefaultRevenue(properties);
+
+    expect(result).toBeNull();
+  });
+
+  // Calculates revenue for a single product with defined price and default quantity
+  it('should calculate revenue for a single product with defined price and default quantity', () => {
+    const properties = {
+      price: 10,
+    };
+
+    const result = calculateDefaultRevenue(properties);
+
+    expect(result).toBe(10);
+  });
+
+  // Calculates revenue for multiple products with defined prices and quantities
+  it('should calculate revenue for multiple products with defined prices and quantities', () => {
+    const properties = {
+      products: [{ price: 10, quantity: 2 }, { quantity: 3 }],
+    };
+
+    const result = calculateDefaultRevenue(properties);
+
+    expect(result).toBe(20);
+  });
+
+  // Calculates revenue for multiple products with defined prices and default quantities
+  it('should calculate revenue for multiple products with defined prices and default quantities', () => {
+    const properties = {
+      products: [{ price: 10 }, { price: 5 }],
+    };
+
+    const result = calculateDefaultRevenue(properties);
+
+    expect(result).toBe(15);
+  });
+});
+
+describe('populateRevenueField', () => {
+  // Returns revenue in cents for Purchase event type with valid revenue property
+  it('should return revenue in cents when Purchase event type has valid revenue property', () => {
+    const eventType = 'Purchase';
+    const properties = {
+      revenue: '10.50',
+    };
+    const expected = 1050;
+
+    const result = populateRevenueField(eventType, properties);
+
+    expect(result).toBe(expected);
+  });
+
+  // Returns null for Purchase event type with revenue property as non-numeric string
+  it('should return null when Purchase event type has revenue property as non-numeric string', () => {
+    const eventType = 'Purchase';
+    const properties = {
+      revenue: 'invalid',
+    };
+    const expected = null;
+
+    const result = populateRevenueField(eventType, properties);
+
+    expect(result).toBe(expected);
+  });
+
+  // Returns revenue in cents for AddToCart event type with valid price and quantity properties
+  it('should return revenue in cents when AddToCart event type has valid price and quantity properties', () => {
+    const eventType = 'AddToCart';
+    const properties = {
+      price: '10.50',
+      quantity: 2,
+    };
+    const expected = 2100;
+
+    const result = populateRevenueField(eventType, properties);
+
+    expect(result).toBe(expected);
+  });
+
+  // Returns revenue in cents for ViewContent event type with valid properties
+  it('should return revenue in cents when ViewContent event type has valid properties', () => {
+    const eventType = 'ViewContent';
+    const properties = {
+      products: [
+        {
+          price: '10.50',
+          quantity: 2,
+        },
+        {
+          price: '5.25',
+          quantity: 3,
+        },
+      ],
+    };
+    const expected = 3675;
+
+    const result = populateRevenueField(eventType, properties);
+
+    expect(result).toBe(expected);
+  });
+});

test/integrations/destinations/reddit/processor/data.ts

@@ -443,6 +443,8 @@ export const data = [
                       },
                       event_metadata: {
                         item_count: 0,
+                        value: 2600,
+                        value_decimal: 26,
                         products: [
                           {
                             id: '017c6f5d5cf86a4b22432066',
@@ -581,6 +583,8 @@ export const data = [
                       },
                       event_metadata: {
                         item_count: 5,
+                        value: 24995,
+                        value_decimal: 249.95,
                         products: [
                           {
                             id: '622c6f5d5cf86a4c77358033',
@@ -847,6 +851,8 @@ export const data = [
                       },
                       event_metadata: {
                         item_count: 5,
+                        value: 24995,
+                        value_decimal: 249.95,
                         products: [
                           {
                             id: '622c6f5d5cf86a4c77358033',

test/integrations/destinations/reddit/router/data.ts

@@ -90,6 +90,8 @@ export const data = [
                 properties: {
                   list_id: 'list1',
                   category: "What's New",
+                  value: 2600,
+                  value_decimal: 26,
                   products: [
                     {
                       product_id: '017c6f5d5cf86a4b22432066',
@@ -230,6 +232,8 @@ export const data = [
                         },
                         event_metadata: {
                           item_count: 0,
+                          value: 2600,
+                          value_decimal: 26,
                           products: [
                             {
                               id: '017c6f5d5cf86a4b22432066',
@@ -259,6 +263,8 @@ export const data = [
                         },
                         event_metadata: {
                           item_count: 5,
+                          value: 24995,
+                          value_decimal: 249.95,
                           products: [
                             {
                               id: '622c6f5d5cf86a4c77358033',
@@ -349,6 +355,8 @@ export const data = [
                 properties: {
                   list_id: 'list1',
                   category: "What's New",
+                  value: 2600,
+                  value_decimal: 26,
                   products: [
                     {
                       product_id: '017c6f5d5cf86a4b22432066',