Merge remote-tracking branch 'origin/develop' into chore.labels-int-api

rudderlabs · Jun 19, 2024 · 40ed6b1 · 40ed6b1
2 parents 8c90cf7 + 1a01362
commit 40ed6b1
Show file tree

Hide file tree

Showing 18 changed files with 1,747 additions and 506 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -65,8 +65,8 @@
     "@ndhoule/extend": "^2.0.0",
     "@pyroscope/nodejs": "^0.2.9",
     "@rudderstack/integrations-lib": "^0.2.10",
-    "@rudderstack/json-template-engine": "^0.13.2",
-    "@rudderstack/workflow-engine": "^0.8.2",
+    "@rudderstack/json-template-engine": "^0.13.8",
+    "@rudderstack/workflow-engine": "^0.8.6",
     "@shopify/jest-koa-mocks": "^5.1.1",
     "ajv": "^8.12.0",
     "ajv-draft-04": "^1.0.0",

diff --git a/src/util/prometheus.js b/src/util/prometheus.js
@@ -612,6 +612,12 @@ class Prometheus {
         type: 'counter',
         labelNames: ['destination_id'],
       },
+      {
+        name: 'braze_alias_missconfigured_count',
+        help: 'braze_alias_missconfigured_count',
+        type: 'counter',
+        labelNames: ['destination_id'],
+      },
       {
         name: 'mixpanel_batch_engage_pack_size',
         help: 'mixpanel_batch_engage_pack_size',

diff --git a/src/v0/destinations/braze/braze.util.test.js b/src/v0/destinations/braze/braze.util.test.js
@@ -1,6 +1,6 @@
 const _ = require('lodash');
 const { handleHttpRequest } = require('../../../adapters/network');
-const { BrazeDedupUtility, addAppId, getPurchaseObjs } = require('./util');
+const { BrazeDedupUtility, addAppId, getPurchaseObjs, setAliasObject } = require('./util');
 const { processBatch } = require('./util');
 const {
   removeUndefinedAndNullValues,
@@ -1421,3 +1421,120 @@ describe('getPurchaseObjs', () => {
     ]);
   });
 });
+
+describe('setAliasObject function', () => {
+  // Test when integrationsObj has both alias_name and alias_label
+  test('should set user_alias from integrationsObj if alias_name and alias_label are defined', () => {
+    const payload = {};
+    const result = setAliasObject(payload, {
+      anonymousId: '12345',
+      integrations: {
+        BRAZE: {
+          alias: {
+            alias_name: 'user123',
+            alias_label: 'customer_id',
+          },
+        },
+      },
+    });
+
+    expect(result).toEqual({
+      user_alias: {
+        alias_name: 'user123',
+        alias_label: 'customer_id',
+      },
+    });
+  });
+
+  // Test when integrationsObj is missing alias_name or alias_label
+  test('should set user_alias with anonymousId as alias_name and "rudder_id" as alias_label if integrationsObj does not have alias_name or alias_label', () => {
+    const message = {
+      anonymousId: '12345',
+    };
+    const payload = {};
+    const result = setAliasObject(payload, message);
+
+    expect(result).toEqual({
+      user_alias: {
+        alias_name: '12345',
+        alias_label: 'rudder_id',
+      },
+    });
+  });
+
+  // Test when message has no anonymousId and integrationsObj is missing
+  test('should return payload unchanged if message has no anonymousId and integrationsObj is missing', () => {
+    const message = {};
+    const payload = {};
+    const result = setAliasObject(payload, message);
+
+    expect(result).toEqual(payload);
+  });
+
+  test('should set user_alias from integrationsObj if alias_name and alias_label are defined', () => {
+    const payload = {};
+    const result = setAliasObject(payload, {
+      anonymousId: '12345',
+      integrations: {
+        BRAZE: {
+          alias: {
+            alias_name: 'user123',
+            alias_label: 'customer_id',
+          },
+        },
+      },
+    });
+
+    expect(result).toEqual({
+      user_alias: {
+        alias_name: 'user123',
+        alias_label: 'customer_id',
+      },
+    });
+  });
+
+  test('should set user_alias from integrationsObj if alias_name and alias_label either is not defined', () => {
+    const payload = {};
+    const result = setAliasObject(payload, {
+      anonymousId: '12345',
+      integrations: {
+        BRAZE: {
+          alias: {
+            alias_name: null,
+            alias_label: 'customer_id',
+          },
+        },
+      },
+    });
+
+    expect(result).toEqual({
+      user_alias: {
+        alias_name: '12345',
+        alias_label: 'rudder_id',
+      },
+    });
+  });
+
+  test('should set user_alias from integrationsObj if alias_name and alias_label either is not defined', () => {
+    const payload = {};
+    const result = setAliasObject(payload, {
+      anonymousId: '12345',
+      userID: 'user123',
+      integrations: {
+        BRAZE: {
+          alias: {
+            alias_name: 'rudder_id-123',
+            alias_label: 'customer_id',
+          },
+        },
+      },
+    });
+
+    expect(result).toEqual({
+      user_alias: {
+        alias_name: 'rudder_id-123',
+        alias_label: 'customer_id',
+      },
+    });
+  });
+});
diff --git a/src/v0/destinations/braze/transform.js b/src/v0/destinations/braze/transform.js
@@ -12,8 +12,9 @@ const {
   setExternalIdOrAliasObject,
   getPurchaseObjs,
   setExternalId,
-  setAliasObjectWithAnonId,
+  setAliasObject,
   collectStatsForAliasFailure,
+  collectStatsForAliasMissConfigurations,
 } = require('./util');
 const tags = require('../../util/tags');
 const { EventType, MappedToDestinationKey } = require('../../../constants');
@@ -27,6 +28,7 @@ const {
   simpleProcessRouterDestSync,
   simpleProcessRouterDest,
   isNewStatusCodesAccepted,
+  getDestinationExternalID,
 } = require('../../util');
 const {
   ConfigCategory,
@@ -82,7 +84,7 @@ function buildResponse(message, destination, properties, endpoint) {
 
 function getIdentifyPayload(message) {
   let payload = {};
-  payload = setAliasObjectWithAnonId(payload, message);
+  payload = setAliasObject(payload, message);
   payload = setExternalId(payload, message);
   return { aliases_to_identify: [payload], merge_behavior: 'merge' };
 }
@@ -202,12 +204,6 @@ function getUserAttributesObject(message, mappingJson, destination) {
  * @param {*} destination
  */
 async function processIdentify(message, destination) {
-  // override userId with externalId in context(if present) and event is mapped to destination
-  const mappedToDestination = get(message, MappedToDestinationKey);
-  if (mappedToDestination) {
-    adduserIdFromExternalId(message);
-  }
-
   const identifyPayload = getIdentifyPayload(message);
   const identifyEndpoint = getIdentifyEndpoint(getEndpointFromConfig(destination));
   const { processedResponse: brazeIdentifyResp } = await handleHttpRequest(
@@ -511,10 +507,19 @@ async function process(event, processParams = { userStore: new Map() }, reqMetad
         processParams,
       );
       break;
-    case EventType.IDENTIFY:
+    case EventType.IDENTIFY: {
       category = ConfigCategory.IDENTIFY;
-      if (message.anonymousId) {
+      // override userId with externalId in context(if present) and event is mapped to destination
+      const mappedToDestination = get(message, MappedToDestinationKey);
+      if (mappedToDestination) {
+        adduserIdFromExternalId(message);
+      }
+      const brazeExternalID =
+        getDestinationExternalID(message, 'brazeExternalId') || message.userId;
+      if (message.anonymousId && brazeExternalID) {
         await processIdentify(message, destination);
+      } else {
+        collectStatsForAliasMissConfigurations(destination.ID);
       }
       response = processTrackWithUserAttributes(
         message,
@@ -524,6 +529,7 @@ async function process(event, processParams = { userStore: new Map() }, reqMetad
         reqMetadata,
       );
       break;
+    }
     case EventType.GROUP:
       response = processGroup(message, destination);
       break;

diff --git a/src/v0/destinations/braze/util.js b/src/v0/destinations/braze/util.js
@@ -519,8 +519,18 @@ function setExternalId(payload, message) {
   return payload;
 }
 
-function setAliasObjectWithAnonId(payload, message) {
-  if (message.anonymousId) {
+function setAliasObject(payload, message) {
+  const integrationsObj = getIntegrationsObj(message, 'BRAZE');
+  if (
+    isDefinedAndNotNull(integrationsObj?.alias?.alias_name) &&
+    isDefinedAndNotNull(integrationsObj?.alias?.alias_label)
+  ) {
+    const { alias_name, alias_label } = integrationsObj.alias;
+    payload.user_alias = {
+      alias_name,
+      alias_label,
+    };
+  } else if (message.anonymousId) {
     payload.user_alias = {
       alias_name: message.anonymousId,
       alias_label: 'rudder_id',
@@ -537,7 +547,7 @@ function setExternalIdOrAliasObject(payload, message) {
 
   // eslint-disable-next-line no-underscore-dangle
   payload._update_existing_only = false;
-  return setAliasObjectWithAnonId(payload, message);
+  return setAliasObject(payload, message);
 }
 
 function addMandatoryPurchaseProperties(productId, price, currencyCode, quantity, timestamp) {
@@ -687,16 +697,13 @@ const collectStatsForAliasFailure = (brazeResponse, destinationId) => {
   const { aliases_processed: aliasesProcessed, errors } = brazeResponse;
   if (aliasesProcessed === 0) {
     stats.increment('braze_alias_failure_count', { destination_id: destinationId });
-
-    if (Array.isArray(errors)) {
-      logger.info('Braze Alias Failure Errors:', {
-        destinationId,
-        errors,
-      });
-    }
   }
 };
 
+const collectStatsForAliasMissConfigurations = (destinationId) => {
+  stats.increment('braze_alias_missconfigured_count', { destination_id: destinationId });
+};
+
 module.exports = {
   BrazeDedupUtility,
   CustomAttributeOperationUtil,
@@ -707,7 +714,8 @@ module.exports = {
   getPurchaseObjs,
   setExternalIdOrAliasObject,
   setExternalId,
-  setAliasObjectWithAnonId,
+  setAliasObject,
   addMandatoryPurchaseProperties,
   collectStatsForAliasFailure,
+  collectStatsForAliasMissConfigurations,
 };