fix: allow null values to be passed in Braze for standard properties (#…

…2111) * allow null vslues to be passed for standard properties * fix: implementation and testcases * fix: home city value reference * chore: turn off error rule for dot notation syntax * refactor: restore object string notation * chore: run integration tests before commit * fix: redundant pass, console.log * fix: remove redundant mapping --------- Co-authored-by: saikumarrs <saibattinoju@rudderstack.com>
rudderlabs · May 5, 2023 · 10d037a · 10d037a
1 parent c4b0a69
commit 10d037a
Show file tree

Hide file tree

Showing 11 changed files with 265 additions and 50 deletions.
diff --git a/src/controllers/bulkUpload.ts b/src/controllers/bulkUpload.ts
@@ -2,20 +2,20 @@ import { client as errNotificationClient } from '../util/errorNotifier';
 import logger from '../logger';
 // TODO: To be refactored and redisgned
 
-const getDestFileUploadHandler = (version, dest) => require(`../${version}/destinations/${dest}/fileUpload`);
+const getDestFileUploadHandler = (version, dest) =>
+  require(`../${version}/destinations/${dest}/fileUpload`);
 const getPollStatusHandler = (version, dest) => require(`../${version}/destinations/${dest}/poll`);
-const getJobStatusHandler = (version, dest) => require(`../${version}/destinations/${dest}/fetchJobStatus`);
+const getJobStatusHandler = (version, dest) =>
+  require(`../${version}/destinations/${dest}/fetchJobStatus`);
 
-const getCommonMetadata = (ctx) => 
+const getCommonMetadata = (ctx) =>
   // TODO: Parse information such as
   // cluster, namespace, etc information
   // from the request
-   ({
+  ({
     namespace: 'Unknown',
     cluster: 'Unknown',
-  })
-;
-
+  });
 export const fileUpload = async (ctx) => {
   logger.debug(
     'Native(Bulk-Upload): Request to transformer:: /fileUpload route',

diff --git a/src/middlewares/routeActivation.ts b/src/middlewares/routeActivation.ts
@@ -22,11 +22,10 @@ export default class RouteActivationMiddleware {
   private static executeActivationRule(ctx: Context, next: Next, shouldActivate: boolean) {
     if (shouldActivate) {
       return next();
-    } 
-      ctx.status = 404;
-      ctx.body = 'RouteActivationMiddleware route is disabled';
-      return ctx;
-
+    }
+    ctx.status = 404;
+    ctx.body = 'RouteActivationMiddleware route is disabled';
+    return ctx;
   }
 
   private static shouldActivateRoute(integration: string, filterList: string | undefined) {

diff --git a/src/services/destination/cdkV2Integration.ts b/src/services/destination/cdkV2Integration.ts
@@ -54,8 +54,13 @@ export default class CDKV2DestinationService implements IntegrationDestinationSe
     const respList: ProcessorTransformationResponse[][] = await Promise.all(
       events.map(async (event) => {
         try {
-          const transformedPayloads: ProcessorTransformationOutput | ProcessorTransformationOutput[] =
-            await processCdkV2Workflow(destinationType, event, tags.FEATURES.PROCESSOR);
+          const transformedPayloads:
+            | ProcessorTransformationOutput
+            | ProcessorTransformationOutput[] = await processCdkV2Workflow(
+            destinationType,
+            event,
+            tags.FEATURES.PROCESSOR,
+          );
           // We are not passing destination handler for CDK flows
           return DestinationPostTransformationService.handleProcessorTransformSucessEvents(
             event,

diff --git a/src/services/destination/nativeIntegration.ts b/src/services/destination/nativeIntegration.ts
@@ -54,8 +54,9 @@ export default class NativeIntegrationDestinationService implements IntegrationD
     const respList: ProcessorTransformationResponse[][] = await Promise.all(
       events.map(async (event) => {
         try {
-          const transformedPayloads: ProcessorTransformationOutput | ProcessorTransformationOutput[] =
-            await destHandler.process(event);
+          const transformedPayloads:
+            | ProcessorTransformationOutput
+            | ProcessorTransformationOutput[] = await destHandler.process(event);
           return DestinationPostTransformationService.handleProcessorTransformSucessEvents(
             event,
             transformedPayloads,

diff --git a/src/services/source/postTransformation.ts b/src/services/source/postTransformation.ts
@@ -25,10 +25,10 @@ export default class PostTransformationSourceService {
     // We will not return array for events not meant for gateway
     if (Object.prototype.hasOwnProperty.call(events, 'outputToSource')) {
       return events as SourceTransformationResponse;
-    } if (Array.isArray(events)) {
+    }
+    if (Array.isArray(events)) {
       return { output: { batch: events } } as SourceTransformationResponse;
-    } 
-      return { output: { batch: [events] } } as SourceTransformationResponse;
-
+    }
+    return { output: { batch: [events] } } as SourceTransformationResponse;
   }
 }
diff --git a/src/services/userTransform.ts b/src/services/userTransform.ts
@@ -116,11 +116,14 @@ export default class UserTransformService {
             status = error.statusCode;
           }
           transformedEvents.push(
-            ...eventsToProcess.map((e) => ({
-                statusCode: status,
-                metadata: e.metadata,
-                error: errorString,
-              } as ProcessorTransformationResponse)),
+            ...eventsToProcess.map(
+              (e) =>
+                ({
+                  statusCode: status,
+                  metadata: e.metadata,
+                  error: errorString,
+                } as ProcessorTransformationResponse),
+            ),
           );
           stats.counter('user_transform_errors', eventsToProcess.length, {
             transformationVersionId,

diff --git a/src/util/dynamicConfigParser.ts b/src/util/dynamicConfigParser.ts
@@ -70,7 +70,8 @@ export class DynamicConfigParser {
     events: ProcessorTransformationRequest[] | RouterTransformationRequestData[],
   ) {
     const eventRespArr = events.map(
-      (e: ProcessorTransformationRequest | RouterTransformationRequestData) => this.getDynamicConfig(e),
+      (e: ProcessorTransformationRequest | RouterTransformationRequestData) =>
+        this.getDynamicConfig(e),
     );
     return eventRespArr;
   }

diff --git a/src/v0/destinations/braze/transform.js b/src/v0/destinations/braze/transform.js
@@ -34,17 +34,17 @@ const { JSON_MIME_TYPE } = require('../../util/constant');
 
 function formatGender(gender) {
   // few possible cases of woman
-  if (['woman', 'female', 'w', 'f'].includes(gender.toLowerCase())) {
+  if (['woman', 'female', 'w', 'f'].includes(gender?.toLowerCase())) {
     return 'F';
   }
 
   // few possible cases of man
-  if (['man', 'male', 'm'].includes(gender.toLowerCase())) {
+  if (['man', 'male', 'm'].includes(gender?.toLowerCase())) {
     return 'M';
   }
 
   // few possible cases of other
-  if (['other', 'o'].includes(gender.toLowerCase())) {
+  if (['other', 'o'].includes(gender?.toLowerCase())) {
     return 'O';
   }
 
@@ -148,21 +148,6 @@ function getUserAttributesObject(message, mappingJson, destination) {
     return traits;
   }
 
-  // iterate over the destKeys and set the value if present
-  Object.keys(mappingJson).forEach((destKey) => {
-    let value = get(traits, mappingJson[destKey]);
-    if (value) {
-      // handle gender special case
-      if (destKey === 'gender') {
-        value = formatGender(value);
-      }
-      if (destKey === 'email') {
-        value = value.toLowerCase();
-      }
-      data[destKey] = value;
-    }
-  });
-
   // reserved keys : already mapped through mappingJson
   const reservedKeys = [
     'address',
@@ -175,7 +160,22 @@ function getUserAttributesObject(message, mappingJson, destination) {
     'phone',
   ];
 
+  // iterate over the destKeys and set the value if present
   if (traits) {
+    Object.keys(mappingJson).forEach((destKey) => {
+      let value = get(traits, mappingJson[destKey]);
+      if (value || (value === null && reservedKeys.includes(destKey))) {
+        // handle gender special case
+        if (destKey === 'gender') {
+          value = formatGender(value);
+        }
+        if (destKey === 'email') {
+          value = value.toLowerCase();
+        }
+        data[destKey] = value;
+      }
+    });
+
     // iterate over rest of the traits properties
     Object.keys(traits).forEach((traitKey) => {
       // if traitKey is not reserved add the value to final output

diff --git a/src/v0/destinations/braze/util.js b/src/v0/destinations/braze/util.js
@@ -131,7 +131,6 @@ const BrazeDedupUtility = {
         const externalIdentifiers = ids.filter((id) => id.external_id);
         const aliasIdentifiers = ids.filter((id) => id.alias_name !== undefined);
 
-        const startTime = Date.now();
         const { processedResponse: lookUpResponse } = await handleHttpRequest(
           'post',
           `${getEndpointFromConfig(destination)}/users/export/ids`,
@@ -146,11 +145,6 @@ const BrazeDedupUtility = {
             timeout: 10 * 1000,
           },
         );
-        const endTime = Date.now();
-        // TODO: Remove this log
-        console.log(
-          `Time taken to fetch user store: ${endTime - startTime} ms for ${ids.length} users`,
-        );
         stats.counter('braze_lookup_failure_count', 1, { http_status: lookUpResponse.status });
         const { users } = lookUpResponse.response;
 

diff --git a/test/__tests__/data/braze_input.json b/test/__tests__/data/braze_input.json
@@ -1164,5 +1164,139 @@
       "type": "track",
       "userId": "finalUserTestCA"
     }
+  },
+  {
+    "destination": {
+      "Config": {
+        "restApiKey": "9432f11f70f8ce386f5110c8c924b3ec4f825256",
+        "prefixProperties": true,
+        "useNativeSDK": false,
+        "dataCenter": "us-01"
+      },
+      "DestinationDefinition": {
+        "DisplayName": "Braze",
+        "ID": "1WhbSZ6uA3H5ChVifHpfL2H6sie",
+        "Name": "BRAZE"
+      },
+      "Enabled": true,
+      "ID": "1WhcOCGgj9asZu850HvugU2C3Aq",
+      "Name": "Braze",
+      "Transformations": []
+    },
+    "message": {
+      "channel": "web",
+      "context": {
+        "traits": {
+          "address": {
+            "city": "Mathura",
+            "country": "India"
+          },
+          "email": "anuj.kumar@gmail.com",
+          "phone": "9988123321",
+          "firstName": "anuj",
+          "lastName": "kumar",
+          "gender": "male",
+          "birthday": "01/01/1971",
+          "avatar": "https://i.kym-cdn.com/entries/icons/mobile/000/034/772/anuj-1.jpg",
+          "bio": "Tech and tension go together",
+          "language": "en-IN",
+          "job": "Director",
+          "company": "Plinth India"
+        },
+        "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
+        },
+        "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"
+      },
+      "integrations": {
+        "All": true
+      },
+      "request_ip": "[::1]:53709",
+      "type": "identify",
+      "userId": "ank101"
+    }
+  },
+  {
+    "destination": {
+      "Config": {
+        "restApiKey": "9432f11f70f8ce386f5110c8c924b3ec4f825256",
+        "prefixProperties": true,
+        "useNativeSDK": false,
+        "dataCenter": "us-01"
+      },
+      "DestinationDefinition": {
+        "DisplayName": "Braze",
+        "ID": "1WhbSZ6uA3H5ChVifHpfL2H6sie",
+        "Name": "BRAZE"
+      },
+      "Enabled": true,
+      "ID": "1WhcOCGgj9asZu850HvugU2C3Aq",
+      "Name": "Braze",
+      "Transformations": []
+    },
+    "message": {
+      "channel": "web",
+      "context": {
+        "traits": {
+          "address": {
+            "city": "Mathura",
+            "country": "India"
+          },
+          "email": "anuj.kumar@gmail.com",
+          "phone": "9988123321",
+          "firstName": "anuj",
+          "lastName": "kumar",
+          "gender": null,
+          "birthday": "01/01/1971",
+          "avatar": "https://i.kym-cdn.com/entries/icons/mobile/000/034/772/anuj-1.jpg",
+          "bio": "Tech and tension go together",
+          "language": "en-IN",
+          "job": "Director",
+          "company": null
+        },
+        "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
+        },
+        "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"
+      },
+      "integrations": {
+        "All": true
+      },
+      "request_ip": "[::1]:53709",
+      "type": "identify",
+      "userId": "ank101"
+    }
   }
 ]