Release 3.0.0

* remove any arrays or objects

Author: Han

HISTORY.md

@@ -1,4 +1,9 @@
 
+3.0.0 / 2017-08-21
+==================
+
+  * Drop support for stringifying/flattened arrays or objects as requested by Intercom
+
 2.2.3 / 2017-02-16
 ==================
 

karma.conf.ci.js

@@ -33,17 +33,6 @@ var customLaunchers = {
     browserName: 'safari',
     version: '9.0'
   },
-  // FIXME(ndhoule): Bad IE7/8 support in testing packages make these fail
-  // sl_ie_7: {
-  //   base: 'SauceLabs',
-  //   browserName: 'internet explorer',
-  //   version: '7'
-  // },
-  // sl_ie_8: {
-  //   base: 'SauceLabs',
-  //   browserName: 'internet explorer',
-  //   version: '8'
-  // },
   sl_ie_9: {
     base: 'SauceLabs',
     browserName: 'internet explorer',

lib/index.js

@@ -10,9 +10,6 @@ var del = require('obj-case').del;
 var integration = require('@segment/analytics.js-integration');
 var is = require('is');
 var extend = require('@ndhoule/extend');
-var foldl = require('@ndhoule/foldl');
-var flatten = require('flat');
-var JSON = require('json3');
 var clone = require('@ndhoule/clone');
 var each = require('@ndhoule/each');
 var pick = require('@ndhoule/pick');
@@ -25,8 +22,6 @@ var Intercom = module.exports = integration('Intercom')
   .global('Intercom')
   .option('activator', '#IntercomDefaultWidget')
   .option('appId', '')
-  .option('blacklisted', {})
-  .option('defaultMethod', 'flatten')
   .option('richLinkProperties', [])
   .tag('<script src="https://widget.intercom.io/widget/{{ appId }}">');
 
@@ -153,12 +148,12 @@ Intercom.prototype.group = function(group) {
   var id = group.groupId();
   if (id) props.id = id;
   var integrationSettings = group.options(this.name);
-  
+
   // format nested custom traits
   props = formatNestedCustomTraits(props, settings);
 
   var traits = extend({ company: props }, hideDefaultLauncher(integrationSettings));
-  
+
   api('update', traits);
 };
 
@@ -240,10 +235,8 @@ function formatDate(date) {
  * @return {Object} ret
  * @api private
  */
- 
+
 function formatNestedCustomTraits(obj, settings) {
-  var blacklisted = settings.blacklisted || {};
-  var defaultMethod = settings.defaultMethod || 'flatten';
   var richLinkProperties = settings.richLinkProperties;
   var basicIntercomTraits = [
     'companies',
@@ -277,42 +270,14 @@ function formatNestedCustomTraits(obj, settings) {
   // create object without custom traits to merge with formatted custom traits in the end
   var standardTraits = pick(semanticTraits, obj);
 
-  // handle custom nested traits according to the settings
-  var formattedTraits = foldl(function(attrs, value, key) {
-    var trait = blacklisted[key];
- 
-    if (trait === 'stringify') {
-      attrs.stringify[key] = value;
-    } else if (trait === 'flatten') {
-      attrs.flatten[key] = value;
-    } else if (trait === 'drop') {
-      return attrs;
-    } else if (typeof value === 'object') {
-      if (defaultMethod === 'stringify') attrs.stringify[key] = value;
-      if (defaultMethod === 'flatten') attrs.flatten[key] = value;
-      if (defaultMethod === 'drop') return attrs;
-    } else {
-      attrs.nonNestedTraits[key] = value;
-    }
-    return attrs;
-  }, { flatten: {}, stringify: {}, nonNestedTraits: {} }, customTraits);
-
-// stringify specified traits
-  var stringifiedTraits = foldl(function(ret, value, key) {
-    ret[key] = JSON.stringify(value);
-    return ret;
-  }, {}, formattedTraits.stringify);
-
-  // flatten specified traits
-  var flattenedTraits = foldl(function(ret, value, key) {
-    var pair = {};
-    pair[key] = value;
-    ret = extend(flatten(pair), ret);
-    return ret;
-  }, {}, formattedTraits.flatten);
+  // drop any arrays or objects
+  var supportedTraits = {};
+  each(function(value, key) {
+    if (!is.object(value) && !is.array(value)) supportedTraits[key] = value;
+  }, customTraits);
 
   // combine all the traits
-  return extend(standardTraits, stringifiedTraits, flattenedTraits, formattedTraits.nonNestedTraits);
+  return extend(supportedTraits, standardTraits);
 }
 
 /**

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@segment/analytics.js-integration-intercom",
   "description": "The Intercom analytics.js integration.",
-  "version": "2.2.3",
+  "version": "3.0.0",
   "keywords": [
     "analytics.js",
     "analytics.js-integration",

test/index.test.js

@@ -41,8 +41,6 @@ describe('Intercom', function() {
       .global('Intercom')
       .option('activator', '#IntercomDefaultWidget')
       .option('appId', '')
-      .option('blacklisted', {})
-      .option('defaultMethod', 'flatten')
       .option('richLinkProperties', [])
       .tag('<script src="https://widget.intercom.io/widget/{{ appId }}">'));
   });
@@ -173,7 +171,7 @@ describe('Intercom', function() {
         });
       });
 
-      it('should selectively stringify, flatten, or drop traits', function() {
+      it('should drop arrays or objects in traits', function() {
         analytics.identify('id', {
           dropMe: { foo: 'bar', ahoy: { okay: 'hello' } },
           stringifyMe: [{ a: 'b' }],
@@ -182,82 +180,6 @@ describe('Intercom', function() {
         analytics.called(window.Intercom, 'boot', {
           app_id: options.appId,
           user_id: 'id',
-          stringifyMe: '[{\"a\":\"b\"}]',
-          'flattenMe.pizza': 'cheese',
-          'flattenMe.spongebob.patrick': 'star',
-          id: 'id'
-        });
-      });
-
-      it('should let you set flatten as a default method for handling nested objects', function() {
-        intercom.options.defaultMethod = 'flatten';
-
-        analytics.identify('id', {
-          dropMe: { foo: 'bar', ahoy: { okay: 'hello' } },
-          stringifyMe: [{ a: 'b' }],
-          flattenMe: { pizza: 'cheese', spongebob: { patrick: 'star' } },
-          array: ['food', { nom: 'avocados' } ],
-          song: 'Starboy',
-          artist: { singer: 'the weekend', beats: 'daft punk' }
-        });
-        analytics.called(window.Intercom, 'boot', {
-          app_id: options.appId,
-          user_id: 'id',
-          stringifyMe: '[{\"a\":\"b\"}]',
-          'flattenMe.pizza': 'cheese',
-          'flattenMe.spongebob.patrick': 'star',
-          song: 'Starboy',
-          'artist.singer': 'the weekend',
-          'artist.beats': 'daft punk',
-          'array.0': 'food',
-          'array.1.nom': 'avocados',
-          id: 'id'
-        });
-      });
-
-      it('should let you set stringify as a default method for handling nested objects', function() {
-        intercom.options.defaultMethod = 'stringify';
-
-        analytics.identify('id', {
-          dropMe: { foo: 'bar', ahoy: { okay: 'hello' } },
-          stringifyMe: [{ a: 'b' }],
-          flattenMe: { pizza: 'cheese', spongebob: { patrick: 'star' } },
-          array: ['food', { nom: 'avocados' } ],
-          song: 'Starboy',
-          artist: { singer: 'the weekend', beats: 'daft punk' }
-        });
-        analytics.called(window.Intercom, 'boot', {
-          app_id: options.appId,
-          user_id: 'id',
-          stringifyMe: '[{\"a\":\"b\"}]',
-          'flattenMe.pizza': 'cheese',
-          'flattenMe.spongebob.patrick': 'star',
-          song: 'Starboy',
-          array: '[\"food\",{\"nom\":\"avocados\"}]',
-          artist: '{\"singer\":\"the weekend\",\"beats\":\"daft punk\"}',
-          id: 'id'
-        });
-      });
-
-
-      it('should let you set drop as a default method for handling nested objects', function() {
-        intercom.options.defaultMethod = 'drop';
-
-        analytics.identify('id', {
-          dropMe: { foo: 'bar', ahoy: { okay: 'hello' } },
-          stringifyMe: [{ a: 'b' }],
-          flattenMe: { pizza: 'cheese', spongebob: { patrick: 'star' } },
-          array: ['food', { nom: 'avocados' } ],
-          song: 'Starboy',
-          artist: { singer: 'the weekend', beats: 'daft punk' }
-        });
-        analytics.called(window.Intercom, 'boot', {
-          app_id: options.appId,
-          user_id: 'id',
-          stringifyMe: '[{\"a\":\"b\"}]',
-          'flattenMe.pizza': 'cheese',
-          'flattenMe.spongebob.patrick': 'star',
-          song: 'Starboy',
           id: 'id'
         });
       });
@@ -457,22 +379,19 @@ describe('Intercom', function() {
         analytics.called(window.Intercom, 'update', {
           company: {
             album: 'Starboy',
-            id: 'id' 
+            id: 'id'
           }
         });
       });
 
-      it('should selectively stringify, flatten, or drop traits', function() {
+      it('should drop arrays or objects in traits', function() {
         analytics.group('id', {
           dropMe: { foo: 'bar', ahoy: { okay: 'hello' } },
           stringifyMe: [{ a: 'b' }],
           flattenMe: { pizza: 'cheese', spongebob: { patrick: 'star' } }
         });
-        analytics.called(window.Intercom, 'update', { 
+        analytics.called(window.Intercom, 'update', {
           company: {
-            stringifyMe: '[{\"a\":\"b\"}]',
-            'flattenMe.pizza': 'cheese',
-            'flattenMe.spongebob.patrick': 'star',
             id: 'id'
           }
         });
@@ -501,23 +420,22 @@ describe('Intercom', function() {
         });
       });
 
-      it('should selectively stringify, flatten, or drop traits', function() {
+      it('should drop arrays or objects in properties', function() {
         analytics.track('event', {
           dropMe: { foo: 'bar', ahoy: { okay: 'hello' } },
           stringifyMe: [{ a: 'b' }],
-          flattenMe: { pizza: 'cheese', spongebob: { patrick: 'star' } }
+          flattenMe: { pizza: 'cheese', spongebob: { patrick: 'star' } },
+          suh: 'dude'
         });
-        analytics.called(window.Intercom, 'trackEvent', 'event', { 
-          stringifyMe: '[{\"a\":\"b\"}]',
-          'flattenMe.pizza': 'cheese',
-          'flattenMe.spongebob.patrick': 'star'
+        analytics.called(window.Intercom, 'trackEvent', 'event', {
+          suh: 'dude'
         });
       });
 
       it('should send Rich Link as nested object', function() {
         intercom.options.richLinkProperties = ['article', 'orderNumber'];
 
-        analytics.track('event', { 
+        analytics.track('event', {
           article: {
             url: 'www.suh.com',
             value: 'suh dude'
@@ -539,18 +457,18 @@ describe('Intercom', function() {
 
       it('page: should set hide_default_launcher if integration setting exists for it', function() {
         var integrationSettings = {
-          Intercom: { hideDefaultLauncher: true } 
+          Intercom: { hideDefaultLauncher: true }
         };
         analytics.page({}, integrationSettings);
         analytics.called(window.Intercom, 'boot', {
           app_id: options.appId,
           hide_default_launcher: true
         });
-      }); 
+      });
 
       it('identify: should set hide_default_launcher if integration setting exists for it', function() {
         var integrationSettings = {
-          Intercom: { hideDefaultLauncher: true } 
+          Intercom: { hideDefaultLauncher: true }
         };
         analytics.identify('id', {}, integrationSettings);
         analytics.called(window.Intercom, 'boot', {
@@ -559,18 +477,18 @@ describe('Intercom', function() {
           id: 'id',
           hide_default_launcher: true
         });
-      }); 
+      });
 
       it('group: should set hide_default_launcher if integration setting exists for it', function() {
         var integrationSettings = {
-          Intercom: { hideDefaultLauncher: true } 
+          Intercom: { hideDefaultLauncher: true }
         };
         analytics.group('id', {}, integrationSettings);
         analytics.called(window.Intercom, 'update', {
           company: { id: 'id' },
           hide_default_launcher: true
         });
-      }); 
+      });
     });
   });
 });