update from master

djih · djih · commit 2fdf120c5685 · 2015-09-21T20:03:09.000-07:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,12 @@
 ## Unreleased
 
 * Add support for user properties operations (set, setOnce, add, unset).
+
+## 2.4.1 (September 21, 2015)
+
 * Add support for passing callback function to init.
 * Fix bug to check that Window localStorage is available for use.
+* Fix bug to prevent scheduling multiple event uploads.
 
 ## 2.4.0 (September 4, 2015)
 
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ Amplitude-Javascript
 
         <script type="text/javascript">
           (function(e,t){var r=e.amplitude||{};var n=t.createElement("script");n.type="text/javascript";
-          n.async=true;n.src="https://d24n15hnbwhuhn.cloudfront.net/libs/amplitude-2.4.0-min.gz.js";
+          n.async=true;n.src="https://d24n15hnbwhuhn.cloudfront.net/libs/amplitude-2.4.1-min.gz.js";
           var s=t.getElementsByTagName("script")[0];s.parentNode.insertBefore(n,s);r._q=[];function a(e){
           r[e]=function(){r._q.push([e].concat(Array.prototype.slice.call(arguments,0)))}}var i=["init","logEvent","logRevenue","setUserId","setUserProperties","setOptOut","setVersionName","setDomain","setDeviceId","setGlobalUserProperties"];
           for(var o=0;o<i.length;o++){a(i[o])}e.amplitude=r})(window,document);
diff --git a/amplitude-snippet.min.js b/amplitude-snippet.min.js
@@ -1,5 +1,5 @@
 (function(e,t){var r=e.amplitude||{};var n=t.createElement("script");n.type="text/javascript";
-n.async=true;n.src="https://d24n15hnbwhuhn.cloudfront.net/libs/amplitude-2.4.0-min.gz.js";
+n.async=true;n.src="https://d24n15hnbwhuhn.cloudfront.net/libs/amplitude-2.4.1-min.gz.js";
 var s=t.getElementsByTagName("script")[0];s.parentNode.insertBefore(n,s);r._q=[];function a(e){
 r[e]=function(){r._q.push([e].concat(Array.prototype.slice.call(arguments,0)))}}var i=["init","logEvent","logRevenue","setUserId","setUserProperties","setOptOut","setVersionName","setDomain","setDeviceId","setGlobalUserProperties"];
 for(var o=0;o<i.length;o++){a(i[o])}e.amplitude=r})(window,document);
diff --git a/amplitude.js b/amplitude.js
@@ -174,6 +174,7 @@ Amplitude.prototype._sending = false;
 Amplitude.prototype._lastEventTime = null;
 Amplitude.prototype._sessionId = null;
 Amplitude.prototype._newSession = false;
+Amplitude.prototype._updateScheduled = false;
 
 Amplitude.prototype.Identify = Identify;
 
@@ -315,7 +316,16 @@ Amplitude.prototype._sendEventsIfReady = function(callback) {
     return true;
   }
 
-  setTimeout(this.sendEvents.bind(this), this.options.eventUploadPeriodMillis);
+  if (!this._updateScheduled) {
+    this._updateScheduled = true;
+    setTimeout(
+      function() {
+        this._updateScheduled = false;
+        this.sendEvents();
+      }.bind(this), this.options.eventUploadPeriodMillis
+    );
+  }
+
   return false;
 };
 
@@ -3264,7 +3274,7 @@ module.exports = uuid;
 
 }, {}],
 12: [function(require, module, exports) {
-module.exports = '2.4.0';
+module.exports = '2.4.1';
 
 }, {}],
 13: [function(require, module, exports) {
diff --git a/amplitude.min.js b/amplitude.min.js
diff --git a/component.json b/component.json
@@ -3,7 +3,7 @@
   "main": "src/index.js",
   "repo": "amplitude/amplitude-javascript",
   "description": "Javascript library for Amplitude Analytics",
-  "version": "2.4.0",
+  "version": "2.4.1",
   "keywords": [
     "analytics",
     "amplitude"
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "amplitude-js",
   "author": "Amplitude <support@amplitude.com>",
-  "version": "2.4.0",
+  "version": "2.4.1",
   "license": "MIT",
   "description": "Javascript library for Amplitude Analytics",
   "keywords": [
diff --git a/src/amplitude-snippet.js b/src/amplitude-snippet.js
@@ -3,7 +3,7 @@
   var as = document.createElement('script');
   as.type = 'text/javascript';
   as.async = true;
-  as.src = 'https://d24n15hnbwhuhn.cloudfront.net/libs/amplitude-2.4.0-min.gz.js';
+  as.src = 'https://d24n15hnbwhuhn.cloudfront.net/libs/amplitude-2.4.1-min.gz.js';
   var s = document.getElementsByTagName('script')[0];
   s.parentNode.insertBefore(as, s);
   amplitude._q = [];
diff --git a/src/amplitude.js b/src/amplitude.js
@@ -62,6 +62,7 @@ Amplitude.prototype._sending = false;
 Amplitude.prototype._lastEventTime = null;
 Amplitude.prototype._sessionId = null;
 Amplitude.prototype._newSession = false;
+Amplitude.prototype._updateScheduled = false;
 
 Amplitude.prototype.Identify = Identify;
 
@@ -203,7 +204,16 @@ Amplitude.prototype._sendEventsIfReady = function(callback) {
     return true;
   }
 
-  setTimeout(this.sendEvents.bind(this), this.options.eventUploadPeriodMillis);
+  if (!this._updateScheduled) {
+    this._updateScheduled = true;
+    setTimeout(
+      function() {
+        this._updateScheduled = false;
+        this.sendEvents();
+      }.bind(this), this.options.eventUploadPeriodMillis
+    );
+  }
+
   return false;
 };
 
diff --git a/src/version.js b/src/version.js
@@ -1 +1 @@
-module.exports = '2.4.0';
+module.exports = '2.4.1';
diff --git a/test/amplitude.js b/test/amplitude.js
@@ -445,7 +445,41 @@ describe('Amplitude', function() {
       assert.lengthOf(amplitude._unsentEvents, 0);
       clock.tick(eventUploadPeriodMillis);
       assert.lengthOf(server.requests, 1);
-    })
+    });
+
+    it('should not schedule more than one upload', function() {
+      var eventUploadPeriodMillis = 5*1000; // 5s
+      amplitude.init(apiKey, null, {
+        batchEvents: true,
+        eventUploadThreshold: 30,
+        eventUploadPeriodMillis: eventUploadPeriodMillis
+      });
+
+      // log 2 events, 1 millisecond apart, second event should not schedule upload
+      amplitude.logEvent('Event1');
+      clock.tick(1);
+      amplitude.logEvent('Event2');
+      assert.lengthOf(amplitude._unsentEvents, 2);
+      assert.lengthOf(server.requests, 0);
+
+      // advance to upload period millis, and should have 1 server request
+      // from the first scheduled upload
+      clock.tick(eventUploadPeriodMillis-1);
+      assert.lengthOf(server.requests, 1);
+      server.respondWith('success');
+      server.respond();
+
+      // log 3rd event, advance 1 more millisecond, verify no 2nd server request
+      amplitude.logEvent('Event3');
+      clock.tick(1);
+      assert.lengthOf(server.requests, 1);
+
+      // the 3rd event, however, should have scheduled another upload after 5s
+      clock.tick(eventUploadPeriodMillis-2);
+      assert.lengthOf(server.requests, 1);
+      clock.tick(1);
+      assert.lengthOf(server.requests, 2);
+    });
 
     it('should back off on 413 status', function() {
       amplitude.init(apiKey, null, {uploadBatchSize: 10});

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "amplitude-js",`
`3`	`3`	`"author": "Amplitude <support@amplitude.com>",`
`4`		`- "version": "2.4.0",`
	`4`	`+ "version": "2.4.1",`
`5`	`5`	`"license": "MIT",`
`6`	`6`	`"description": "Javascript library for Amplitude Analytics",`
`7`	`7`	`"keywords": [`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-module.exports = '2.4.0';`
	`1`	`+module.exports = '2.4.1';`