adding server identifiable names

rudderlabs · May 14, 2020 · 3dbe7ea · 3dbe7ea
1 parent 694d3bc
commit 3dbe7ea
Show file tree

Hide file tree

Showing 7 changed files with 129 additions and 6 deletions.
diff --git a/analytics.js b/analytics.js
@@ -4,7 +4,8 @@ import {
   handleError,
   getDefaultPageProperties,
   findAllEnabledDestinations,
-  tranformToRudderNames
+  tranformToRudderNames,
+  transformToServerNames
 } from "./utils/utils";
 import {
   CONFIG_URL,
@@ -620,6 +621,9 @@ class Analytics {
         this.toBeProcessedByIntegrationArray.push([type, rudderElement]);
       }
 
+      // convert integrations object to server identified names, kind of hack now!
+      transformToServerNames(rudderElement.message.integrations)
+
       // self analytics process, send to rudder
       enqueue.call(this, rudderElement, type);
 

diff --git a/dist/browser.js b/dist/browser.js
@@ -157,6 +157,7 @@ var rudderanalytics = (function (exports) {
     }
   };
 
+  // for sdk side native integration identification
   var commonNames = {
     "All": "All",
     "Google Analytics": "GA",
@@ -196,6 +197,25 @@ var rudderanalytics = (function (exports) {
     "VWO": "VWO"
   };
 
+  var clientToServerNames = {
+    "All": "All",
+    "GA": "Google Analytics",
+    "GOOGLEADS": "Google Ads",
+    "BRAZE": "Braze",
+    "Chartbeat": "Chartbeat",
+    "COMSCORE": "Comscore",
+    "CUSTOMERIO": "Customer IO",
+    "FB_PIXEL": "Facebook Pixel",
+    "GOOGLETAGMANAGER": "Google Tag Manager",
+    "HOTJAR": "Hotjar",
+    "HS": "HubSpot",
+    "INTERCOM": "Intercom",
+    "KEEN": "Keen",
+    "KISSMETRICS": "Kiss Metrics",
+    "LOTAME": "Lotame",
+    "VWO": "VWO"
+  };
+
   /**
    *
    * Utility method for excluding null and empty values in JSON
@@ -384,14 +404,31 @@ var rudderanalytics = (function (exports) {
         }
 
         if (key != "All") {
-          // delete user supplied keys except All and if except those where oldkeys are same as transformed keys
+          // delete user supplied keys except All and if except those where oldkeys are not present or oldkeys are same as transformed keys 
           if (commonNames[key] != undefined && commonNames[key] != key) {
             delete integrationObject[key];
           }
         }
       }
     });
   }
+
+  function transformToServerNames(integrationObject) {
+    Object.keys(integrationObject).forEach(function (key) {
+      if (integrationObject.hasOwnProperty(key)) {
+        if (clientToServerNames[key]) {
+          integrationObject[clientToServerNames[key]] = integrationObject[key];
+        }
+
+        if (key != "All") {
+          // delete user supplied keys except All and if except those where oldkeys are not present or oldkeys are same as transformed keys 
+          if (clientToServerNames[key] != undefined && clientToServerNames[key] != key) {
+            delete integrationObject[key];
+          }
+        }
+      }
+    });
+  }
   /**
    * 
    * @param {*} sdkSuppliedIntegrations 
@@ -10973,8 +11010,10 @@ var rudderanalytics = (function (exports) {
             logger.debug("pushing in replay queue"); //new event processing after analytics initialized  but integrations not fetched from BE
 
             this.toBeProcessedByIntegrationArray.push([type, rudderElement]);
-          } // self analytics process, send to rudder
+          } // convert integrations object to server identified names, kind of hack now!
+
 
+          transformToServerNames(rudderElement.message.integrations); // self analytics process, send to rudder
 
           enqueue.call(this, rudderElement, type);
           logger.debug(type + " is called ");

diff --git a/dist/rudder-analytics.min.js b/dist/rudder-analytics.min.js
diff --git a/integrations/client_server_name.js b/integrations/client_server_name.js
@@ -0,0 +1,21 @@
+// from client native integration name to server identified display name
+let clientToServerNames = {
+    "All": "All",
+    "GA": "Google Analytics",
+    "GOOGLEADS": "Google Ads",
+    "BRAZE": "Braze",
+    "Chartbeat": "Chartbeat",
+    "COMSCORE": "Comscore", 
+    "CUSTOMERIO": "Customer IO",
+    "FB_PIXEL": "Facebook Pixel",
+    "GOOGLETAGMANAGER": "Google Tag Manager",
+    "HOTJAR": "Hotjar",
+    "HS": "HubSpot",
+    "INTERCOM": "Intercom",
+    "KEEN": "Keen", 
+    "KISSMETRICS": "Kiss Metrics",
+    "LOTAME": "Lotame",
+    "VWO": "VWO"
+}
+
+export {clientToServerNames}
diff --git a/integrations/integration_cname.js b/integrations/integration_cname.js
@@ -1,3 +1,4 @@
+// for sdk side native integration identification
 let commonNames = {
  "All": "All",
  "Google Analytics": "GA",

diff --git a/tests/html/browser.js b/tests/html/browser.js
@@ -157,6 +157,7 @@ var rudderanalytics = (function (exports) {
     }
   };
 
+  // for sdk side native integration identification
   var commonNames = {
     "All": "All",
     "Google Analytics": "GA",
@@ -196,6 +197,25 @@ var rudderanalytics = (function (exports) {
     "VWO": "VWO"
   };
 
+  var clientToServerNames = {
+    "All": "All",
+    "GA": "Google Analytics",
+    "GOOGLEADS": "Google Ads",
+    "BRAZE": "Braze",
+    "Chartbeat": "Chartbeat",
+    "COMSCORE": "Comscore",
+    "CUSTOMERIO": "Customer IO",
+    "FB_PIXEL": "Facebook Pixel",
+    "GOOGLETAGMANAGER": "Google Tag Manager",
+    "HOTJAR": "Hotjar",
+    "HS": "HubSpot",
+    "INTERCOM": "Intercom",
+    "KEEN": "Keen",
+    "KISSMETRICS": "Kiss Metrics",
+    "LOTAME": "Lotame",
+    "VWO": "VWO"
+  };
+
   /**
    *
    * Utility method for excluding null and empty values in JSON
@@ -384,14 +404,31 @@ var rudderanalytics = (function (exports) {
         }
 
         if (key != "All") {
-          // delete user supplied keys except All and if except those where oldkeys are same as transformed keys
+          // delete user supplied keys except All and if except those where oldkeys are not present or oldkeys are same as transformed keys 
           if (commonNames[key] != undefined && commonNames[key] != key) {
             delete integrationObject[key];
           }
         }
       }
     });
   }
+
+  function transformToServerNames(integrationObject) {
+    Object.keys(integrationObject).forEach(function (key) {
+      if (integrationObject.hasOwnProperty(key)) {
+        if (clientToServerNames[key]) {
+          integrationObject[clientToServerNames[key]] = integrationObject[key];
+        }
+
+        if (key != "All") {
+          // delete user supplied keys except All and if except those where oldkeys are not present or oldkeys are same as transformed keys 
+          if (clientToServerNames[key] != undefined && clientToServerNames[key] != key) {
+            delete integrationObject[key];
+          }
+        }
+      }
+    });
+  }
   /**
    * 
    * @param {*} sdkSuppliedIntegrations 
@@ -10973,8 +11010,10 @@ var rudderanalytics = (function (exports) {
             logger.debug("pushing in replay queue"); //new event processing after analytics initialized  but integrations not fetched from BE
 
             this.toBeProcessedByIntegrationArray.push([type, rudderElement]);
-          } // self analytics process, send to rudder
+          } // convert integrations object to server identified names, kind of hack now!
+
 
+          transformToServerNames(rudderElement.message.integrations); // self analytics process, send to rudder
 
           enqueue.call(this, rudderElement, type);
           logger.debug(type + " is called ");

diff --git a/utils/utils.js b/utils/utils.js
@@ -1,6 +1,7 @@
 //import * as XMLHttpRequestNode from "Xmlhttprequest";
 import logger from "./logUtil";
 import {commonNames} from "../integrations/integration_cname"
+import {clientToServerNames} from "../integrations/client_server_name"
 
 let XMLHttpRequestNode;
 if (!process.browser) {
@@ -235,6 +236,23 @@ function tranformToRudderNames(integrationObject) {
   })
 }
 
+function transformToServerNames(integrationObject) {
+  Object.keys(integrationObject).forEach(key => {
+    if(integrationObject.hasOwnProperty(key)) {
+      if(clientToServerNames[key]) {
+        integrationObject[clientToServerNames[key]] = integrationObject[key]
+      }
+      if(key != "All") {
+        // delete user supplied keys except All and if except those where oldkeys are not present or oldkeys are same as transformed keys 
+        if(clientToServerNames[key] != undefined && clientToServerNames[key] != key) {
+          delete integrationObject[key]
+        }
+      }
+
+    }
+  })
+}
+
 /**
  * 
  * @param {*} sdkSuppliedIntegrations 
@@ -310,5 +328,6 @@ export {
   getDefaultPageProperties,
   findAllEnabledDestinations,
   tranformToRudderNames,
+  transformToServerNames,
   handleError
 };