allow tracking option config input

Author: djih

src/amplitude-client.js

@@ -166,12 +166,12 @@ var _parseConfig = function _parseConfig(options, config) {
 
   // validates config value is defined, is the correct type, and some additional value sanity checks
   var parseValidateAndLoad = function parseValidateAndLoad(key) {
-    if (!DEFAULT_OPTIONS.hasOwnProperty(key)) {
+    if (!options.hasOwnProperty(key)) {
       return;  // skip bogus config values
     }
 
     var inputValue = config[key];
-    var expectedType = type(DEFAULT_OPTIONS[key]);
+    var expectedType = type(options[key]);
     if (!utils.validateInput(inputValue, key + ' option', expectedType)) {
       return;
     }
@@ -180,14 +180,16 @@ var _parseConfig = function _parseConfig(options, config) {
     } else if ((expectedType === 'string' && !utils.isEmptyString(inputValue)) ||
         (expectedType === 'number' && inputValue > 0)) {
       options[key] = inputValue;
+    } else if (expectedType === 'object') {
+      _parseConfig(options[key], inputValue);
     }
-   };
+  };
 
-   for (var key in config) {
+  for (var key in config) {
     if (config.hasOwnProperty(key)) {
       parseValidateAndLoad(key);
     }
-   }
+  }
 };
 
 /**
@@ -921,7 +923,6 @@ AmplitudeClient.prototype._logEvent = function _logEvent(eventType, eventPropert
       sequence_number: sequenceNumber, // for ordering events and identifys
       groups: utils.truncate(utils.validateGroups(groups)),
       user_agent: this._userAgent
-      // country: null
     };
 
     if (eventType === Constants.IDENTIFY_EVENT) {

src/options.js

@@ -3,9 +3,15 @@ import language from './language';
 // default options
 export default {
   apiEndpoint: 'api.amplitude.com',
+  batchEvents: false,
   cookieExpiration: 365 * 10,
   cookieName: 'amplitude_id',
+  deviceIdFromUrlParam: false,
   domain: '',
+  eventUploadPeriodMillis: 30 * 1000, // 30s
+  eventUploadThreshold: 30,
+  forceHttps: true,
+  includeGclid: false,
   includeReferrer: false,
   includeUtm: false,
   language: language.language,
@@ -14,15 +20,21 @@ export default {
   platform: 'Web',
   savedMaxCount: 1000,
   saveEvents: true,
+  saveParamsReferrerOncePerSession: true,
   sessionTimeout: 30 * 60 * 1000,
+  trackingOptions: {
+    city: true,
+    device_model: true,
+    dma: true,
+    ip_address: true,
+    language: true,
+    os_name: true,
+    os_version: true,
+    platform: true,
+    region: true,
+    version_name: true
+  },
   unsentKey: 'amplitude_unsent',
   unsentIdentifyKey: 'amplitude_unsent_identify',
   uploadBatchSize: 100,
-  batchEvents: false,
-  eventUploadThreshold: 30,
-  eventUploadPeriodMillis: 30 * 1000, // 30s
-  forceHttps: true,
-  includeGclid: false,
-  saveParamsReferrerOncePerSession: true,
-  deviceIdFromUrlParam: false,
 };

test/amplitude-client.js

@@ -709,6 +709,32 @@ it ('should load saved events from localStorage new keys and send events', funct
       // check request
       assert.lengthOf(server.requests, 0);
     });
+
+    it('should merge tracking options during parseConfig', function() {
+      var trackingOptions = {
+        city: false,
+        ip_address: false,
+        language: false,
+        region: true,
+      };
+
+      var amplitude2 = new AmplitudeClient('new_app');
+      amplitude2.init(apiKey, null, {trackingOptions: trackingOptions});
+
+      // check config loaded correctly
+      assert.deepEqual(amplitude2.options.trackingOptions, {
+        city: false,
+        device_model: true,
+        dma: true,
+        ip_address: false,
+        language: false,
+        os_name: true,
+        os_version: true,
+        platform: true,
+        region: true,
+        version_name: true
+      });
+    });
   });
 
   describe('runQueuedFunctions', function() {