fix: algolia enhancement

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

@@ -5,7 +5,10 @@ bindings:
   - path: ../../../../v0/destinations/algolia/config
   - name: removeUndefinedAndNullValues
     path: ../../../../v0/util
+  - name: isDefinedAndNotNull
+    path: ../../../../v0/util
   - path: ../../bindings/jsontemplate
+  - path: '@rudderstack/integrations-lib'
 
 steps:
   - name: validateInput
@@ -24,6 +27,10 @@ steps:
       let eventTypeMap = $.eventTypeMapping(.destination.Config);
       let event = .message.event.trim().toLowerCase();
       let eventType = .message.properties.eventType ?? eventTypeMap[event];
+      let eventSubType = .message.properties.eventSubtype && eventType === 'conversion' ? 
+                .message.properties.eventSubtype in $.ALLOWED_EVENT_SUBTYPES ? 
+                  .message.properties.eventSubtype : null
+                : null;
       $.assert(eventType, "eventType is mandatory for track call");
       let payload = .message.().({
         index: .properties.index,
@@ -32,12 +39,33 @@ steps:
         filters: .properties.filters,
         objectIDs: .properties.objectIds,
         positions: .properties.positions,
+        value: $.isDefinedAndNotNull(.properties.currency) ? .properties.value : null,
+        currency: .properties.currency,
         userToken: {{{{$.getGenericPaths("userId", "||")}}}},
         eventName: event,
-        eventType: eventType
+        eventType: eventType,
+        eventSubtype: eventSubType
       });
       $.context.payload = $.genericpayloadValidator(payload);
 
+  - name: prepareObjectDataBlock
+    condition: $.context.payload.eventType === "conversion"
+    description: |
+      Populate list of objectData
+    template: |
+      const populateObjectData = function(singleProduct) {
+      singleProduct.({
+          "queryID" :  $.isDefinedAndNotNull(.queryID) ? String(.queryID) : null,
+          "price": $.isDefinedAndNotNull(.price) && $.isDefinedAndNotNull(^.message.properties.currency) ? String(.price) : null,
+          "quantity": $.isDefinedAndNotNull(.quantity)? Number(.quantity) : null,
+          "discount": $.isDefinedAndNotNull(.discount) ? String(.discount) : null
+      })
+      };
+      const products = .message.properties.products
+      products.map(function(singleProduct) {
+            $.removeUndefinedAndNullValues(populateObjectData(singleProduct)) 
+      })[]
+
   - name: populateProductsData
     condition: |
       .message.properties.products && 
@@ -55,11 +83,13 @@ steps:
             const products = .message.properties.products;
             const objectIDs = ~r products.objectId;
             $.context.payload.objectIDs = Array.isArray(objectIDs) ? objectIDs[:20]:$.context.payload.objectIDs;
+            $.context.payload.objectData = $.outputs.prepareObjectDataBlock
 
   - name: validateDestPayload
     template: |
       const filters = $.context.payload.filters;
       const objectIDs = $.context.payload.objectIDs;
+      const objectData = $.context.payload.objectData;
       $.assert(!(filters && objectIDs), "event can't have both objectIds and filters at the same time.");
       $.assert(filters.length || objectIDs.length, "Either filters or objectIds is required and must be non empty.");
 

src/v0/destinations/algolia/config.js

@@ -5,11 +5,13 @@ const CONFIG_CATEGORIES = {
   TRACK: { type: 'track', name: 'AlgoliaTrack' },
 };
 const EVENT_TYPES = ['click', 'view', 'conversion'];
+const ALLOWED_EVENT_SUBTYPES = ['addToCart', 'purchase'];
 const MAX_BATCH_SIZE = 1000;
 const MAPPING_CONFIG = getMappingConfig(CONFIG_CATEGORIES, __dirname);
 module.exports = {
   ENDPOINT,
   MAX_BATCH_SIZE,
   EVENT_TYPES,
   trackMapping: MAPPING_CONFIG[CONFIG_CATEGORIES.TRACK.name],
+  ALLOWED_EVENT_SUBTYPES,
 };

src/v0/destinations/algolia/data/AlgoliaTrack.json

@@ -34,5 +34,15 @@
     "destKey": "positions",
     "sourceKeys": "properties.positions",
     "required": false
+  },
+  {
+    "destKey": "value",
+    "sourceKeys": "properties.value",
+    "required": false
+  },
+  {
+    "destKey": "currency",
+    "sourceKeys": "properties.currency",
+    "required": false
   }
 ]

src/v0/destinations/algolia/transform.js

@@ -16,7 +16,7 @@ const {
   handleRtTfSingleEventError,
 } = require('../../util/index');
 
-const { ENDPOINT, MAX_BATCH_SIZE, trackMapping } = require('./config');
+const { ENDPOINT, MAX_BATCH_SIZE, trackMapping, ALLOWED_EVENT_SUBTYPES } = require('./config');
 
 const {
   genericpayloadValidator,
@@ -38,6 +38,12 @@ const trackResponseBuilder = (message, { Config }) => {
   const eventMapping = eventTypeMapping(Config);
   payload.eventName = event;
   payload.eventType = getValueFromMessage(message, 'properties.eventType') || eventMapping[event];
+  if (
+    payload.eventType === 'conversion' &&
+    ALLOWED_EVENT_SUBTYPES.includes(getValueFromMessage(message, 'properties.eventSubtype'))
+  ) {
+    payload.eventSubtype = getValueFromMessage(message, 'properties.eventSubtype');
+  }
 
   if (!payload.eventType) {
     throw new InstrumentationError('eventType is mandatory for track call');
@@ -47,9 +53,13 @@ const trackResponseBuilder = (message, { Config }) => {
   if (event === 'product list viewed' || event === 'order completed') {
     const products = getValueFromMessage(message, 'properties.products');
     if (products) {
-      const { objectList, positionList } = createObjectArray(products, payload.eventType);
+      const { objectList, positionList, objectData } = createObjectArray(
+        products,
+        payload.eventType,
+      );
       const objLen = objectList.length;
       const posLen = positionList.length;
+      const objDataLen = objectData.length;
       if (objLen > 0) {
         payload.objectIDs = objectList;
         payload.objectIDs.splice(20);
@@ -58,10 +68,20 @@ const trackResponseBuilder = (message, { Config }) => {
         payload.positions = positionList;
         payload.positions.splice(20);
       }
+
+      if (objDataLen > 0) {
+        payload.objectData = objectData;
+      }
       // making size of object list and position list equal
       if (posLen > 0 && objLen > 0 && posLen !== objLen) {
         throw new InstrumentationError('length of objectId and position should be equal');
       }
+
+      if (objDataLen > 0 && objLen > 0 && objDataLen !== objLen) {
+        throw new InstrumentationError(
+          'length of objectId and properties.products array should be equal',
+        );
+      }
     }
   }
   // for all events either filter or objectID should be there

src/v0/destinations/algolia/util.js

@@ -1,4 +1,8 @@
-const { InstrumentationError } = require('@rudderstack/integrations-lib');
+const {
+  InstrumentationError,
+  isDefined,
+  removeUndefinedAndNullValues,
+} = require('@rudderstack/integrations-lib');
 const logger = require('../../../logger');
 const { EVENT_TYPES } = require('./config');
 
@@ -66,6 +70,8 @@ const genericpayloadValidator = (payload) => {
 const createObjectArray = (objects, eventType) => {
   const objectList = [];
   const positionList = [];
+  // eslint-disable-next-line sonarjs/no-unused-collection
+  const objectData = [];
   if (objects.length > 0) {
     objects.forEach((object, index) => {
       if (object.objectId) {
@@ -80,13 +86,22 @@ const createObjectArray = (objects, eventType) => {
           }
         } else {
           objectList.push(object.objectId);
+          if (eventType === 'conversion') {
+            const singleObjData = {
+              queryID: isDefined(object.queryID) ? `${object.queryID}` : null,
+              price: isDefined(object.price) ? `${object.price}` : null,
+              quantity: object.quantity,
+              discount: isDefined(object.discount) ? `${object.discount}` : null,
+            };
+            objectData.push(removeUndefinedAndNullValues(singleObjData));
+          }
         }
       } else {
         logger.error(`object at index ${index} dropped. objectId is required.`);
       }
     });
   }
-  return { objectList, positionList };
+  return { objectList, positionList, objectData };
 };
 
 const clickPayloadValidator = (payload) => {