validate properties for events loaded from localstorage

Author: djih

amplitude.js

@@ -373,6 +373,13 @@ AmplitudeClient.prototype.init = function(apiKey, opt_userId, opt_config, callba
     if (this.options.saveEvents) {
       this._unsentEvents = this._loadSavedUnsentEvents(this.options.unsentKey) || this._unsentEvents;
       this._unsentIdentifys = this._loadSavedUnsentEvents(this.options.unsentIdentifyKey) || this._unsentIdentifys;
+
+      // validate event properties for unsent events
+      for (var i = 0; i < this._unsentEvents.length; i++) {
+        var eventProperties = this._unsentEvents[0].event_properties;
+        this._unsentEvents[0].event_properties = utils.validateProperties(eventProperties);
+      }
+
       this._sendEventsIfReady();
     }
 
@@ -2394,10 +2401,8 @@ var validateProperties = function(properties) {
     if (value === null) {
       continue;
     }
-
     copy[key] = value;
   }
-
   return copy;
 };
 

amplitude.min.js

@@ -124,6 +124,13 @@ AmplitudeClient.prototype.init = function(apiKey, opt_userId, opt_config, callba
     if (this.options.saveEvents) {
       this._unsentEvents = this._loadSavedUnsentEvents(this.options.unsentKey) || this._unsentEvents;
       this._unsentIdentifys = this._loadSavedUnsentEvents(this.options.unsentIdentifyKey) || this._unsentIdentifys;
+
+      // validate event properties for unsent events
+      for (var i = 0; i < this._unsentEvents.length; i++) {
+        var eventProperties = this._unsentEvents[0].event_properties;
+        this._unsentEvents[0].event_properties = utils.validateProperties(eventProperties);
+      }
+
       this._sendEventsIfReady();
     }
 

src/amplitude-client.js

@@ -38,10 +38,8 @@ var validateProperties = function(properties) {
     if (value === null) {
       continue;
     }
-
     copy[key] = value;
   }
-
   return copy;
 };
 

src/utils.js

@@ -5,6 +5,7 @@ describe('AmplitudeClient', function() {
   var CookieStorage = require('../src/cookiestorage.js');
   var Base64 = require('../src/base64.js');
   var cookie = require('../src/cookie.js');
+  var utils = require('../src/utils.js');
   var querystring = require('querystring');
   var JSON = require('json');
   var Identify = require('../src/identify.js');
@@ -381,6 +382,21 @@ describe('AmplitudeClient', function() {
       assert.equal(localStorage.getItem('amplitude_unsent_identify_new_app'), existingIdentify);
     });
 
+    it('should validate event properties when loading saved events from localStorage', function() {
+      var existingEvent = '[{"device_id":"test_device_id","user_id":"test_user_id","timestamp":1453769146589,' +
+        '"event_id":49,"session_id":1453763315544,"event_type":"clicked","version_name":"Web","platform":"Web"' +
+        ',"os_name":"Chrome","os_version":"47","device_model":"Mac","language":"en-US","api_properties":{},' +
+        '"event_properties":"{}","user_properties":{},"uuid":"3c508faa-a5c9-45fa-9da7-9f4f3b992fb0","library"' +
+        ':{"name":"amplitude-js","version":"2.9.0"},"sequence_number":130}]';
+      localStorage.setItem('amplitude_unsent', existingEvent);
+
+      var amplitude2 = new AmplitudeClient('$default_Instance');
+      amplitude2.init(apiKey, null, {batchEvents: true});
+
+      // check event loaded into memory
+      assert.deepEqual(amplitude2._unsentEvents[0].event_properties, {});
+    });
+
     it ('should load saved events from localStorage new keys and send events', function() {
       var existingEvent = '[{"device_id":"test_device_id","user_id":"test_user_id","timestamp":1453769146589,' +
         '"event_id":49,"session_id":1453763315544,"event_type":"clicked","version_name":"Web","platform":"Web"' +
@@ -1494,6 +1510,55 @@ describe('AmplitudeClient', function() {
         'sequenceNumber': 3
       });
     });
+
+    it('should validate event properties', function() {
+      var e = new Error('oops');
+      clock.tick(1);
+      amplitude.init(apiKey, null, {batchEvents: true, eventUploadThreshold: 5});
+      clock.tick(1);
+      amplitude.logEvent('String event properties', '{}');
+      clock.tick(1);
+      amplitude.logEvent('Bool event properties', true);
+      clock.tick(1);
+      amplitude.logEvent('Number event properties', 15);
+      clock.tick(1);
+      amplitude.logEvent('Array event properties', [1, 2, 3]);
+      clock.tick(1);
+      amplitude.logEvent('Object event properties', {
+        10: 'false', // coerce key
+        'bool': true,
+        'null': null, // should be ignored
+        'function': utils.log, // should be ignored
+        'regex': /afdg/, // should be ignored
+        'error': e, // coerce value
+        'string': 'test',
+        'array': [0, 1, 2, '3'],
+        'nested_array': ['a', {'key': 'value'}, ['b']],
+        'object': {'key':'value', 15: e},
+        'nested_object': {'k':'v', 'l':[0,1], 'o':{'k2':'v2', 'l2': ['e2', {'k3': 'v3'}]}}
+      });
+      clock.tick(1);
+
+      assert.lengthOf(amplitude._unsentEvents, 5);
+      assert.lengthOf(server.requests, 1);
+      var events = JSON.parse(querystring.parse(server.requests[0].requestBody).e);
+      assert.lengthOf(events, 5);
+
+      assert.deepEqual(events[0].event_properties, {});
+      assert.deepEqual(events[1].event_properties, {});
+      assert.deepEqual(events[2].event_properties, {});
+      assert.deepEqual(events[3].event_properties, {});
+      assert.deepEqual(events[4].event_properties, {
+        '10': 'false',
+        'bool': true,
+        'error': 'Error: oops',
+        'string': 'test',
+        'array': [0, 1, 2, '3'],
+        'nested_array': ['a'],
+        'object': {'key':'value', '15':'Error: oops'},
+        'nested_object': {'k':'v', 'l':[0,1], 'o':{'k2':'v2', 'l2': ['e2']}}
+      });
+    });
   });
 
   describe('optOut', function() {