rollback callback for logRevenue, setUserProperties, clearUserProperties

Author: djih

CHANGELOG.md

@@ -1,5 +1,7 @@
 ## Unreleased
 
+* Add support for passing callback function to identify.
+
 ### 2.9.1 (March 6, 2016)
 
 * Fix bug where saveReferrer throws exception if sessionStorage is disabled.

README.md

@@ -238,13 +238,18 @@ amplitude.setDeviceId('CUSTOM_DEVICE_ID');
 
 **Note: this is not recommended unless you really know what you are doing** (like if you have your own system for tracking user devices). Make sure the deviceId you set is sufficiently unique (we recommend something like a UUID - see `src/uuid.js` for an example of how to generate) to prevent conflicts with other devices in our system.
 
-### Callbacks for LogEvent, LogRevenue, Identify, SetUserProperties, ClearUserProperties, and How to Redirect ###
-You can pass a callback function to logEvent, identify, setUserProperties, and clearUserProperties, which will get called after receiving a response from the server:
+### Callbacks for LogEvent, Identify, and Redirect ###
+You can pass a callback function to logEvent and identify, which will get called after receiving a response from the server:
 
 ```javascript
 amplitude.logEvent("EVENT_IDENTIFIER_HERE", null, callback_function);
 ```
 
+```javascript
+var identify = new amplitude.Identify().set('key', 'value');
+amplitude.identify(identify, callback_function);
+```
+
 The status and response body from the server are passed to the callback function, which you might find useful. An example of a callback function which redirects the browser to another site after a response:
 
 ```javascript

amplitude.js

@@ -574,11 +574,8 @@ Amplitude.prototype.setDeviceId = function(deviceId) {
   }
 };
 
-Amplitude.prototype.setUserProperties = function(userProperties, callback) {
+Amplitude.prototype.setUserProperties = function(userProperties) {
   if (!this._apiKeySet('setUserProperties()')) {
-    if (callback && type(callback) === 'function') {
-      callback(0, 'No request sent');
-    }
     return;
   }
   // convert userProperties into an identify call
@@ -588,21 +585,18 @@ Amplitude.prototype.setUserProperties = function(userProperties, callback) {
       identify.set(property, userProperties[property]);
     }
   }
-  this.identify(identify, callback);
+  this.identify(identify);
 };
 
 // Clearing user properties is irreversible!
-Amplitude.prototype.clearUserProperties = function(callback){
+Amplitude.prototype.clearUserProperties = function(){
   if (!this._apiKeySet('clearUserProperties()')) {
-    if (callback && type(callback) === 'function') {
-      callback(0, 'No request sent');
-    }
     return;
   }
 
   var identify = new Identify();
   identify.clearAll();
-  this.identify(identify, callback);
+  this.identify(identify);
 };
 
 Amplitude.prototype.identify = function(identify, callback) {
@@ -775,13 +769,10 @@ var _isNumber = function(n) {
   return !isNaN(parseFloat(n)) && isFinite(n);
 };
 
-Amplitude.prototype.logRevenue = function(price, quantity, product, callback) {
+Amplitude.prototype.logRevenue = function(price, quantity, product) {
   // Test that the parameters are of the right type.
   if (!this._apiKeySet('logRevenue()') || !_isNumber(price) || quantity !== undefined && !_isNumber(quantity)) {
     // utils.log('Price and quantity arguments to logRevenue must be numbers');
-    if (callback && type(callback) === 'function') {
-      callback(0, 'No request sent');
-    }
     return -1;
   }
 
@@ -790,7 +781,7 @@ Amplitude.prototype.logRevenue = function(price, quantity, product, callback) {
     special: 'revenue_amount',
     quantity: quantity || 1,
     price: price
-  }, null, callback);
+  });
 };
 
 /**

amplitude.min.js

@@ -468,11 +468,8 @@ Amplitude.prototype.setDeviceId = function(deviceId) {
   }
 };
 
-Amplitude.prototype.setUserProperties = function(userProperties, callback) {
+Amplitude.prototype.setUserProperties = function(userProperties) {
   if (!this._apiKeySet('setUserProperties()')) {
-    if (callback && type(callback) === 'function') {
-      callback(0, 'No request sent');
-    }
     return;
   }
   // convert userProperties into an identify call
@@ -482,21 +479,18 @@ Amplitude.prototype.setUserProperties = function(userProperties, callback) {
       identify.set(property, userProperties[property]);
     }
   }
-  this.identify(identify, callback);
+  this.identify(identify);
 };
 
 // Clearing user properties is irreversible!
-Amplitude.prototype.clearUserProperties = function(callback){
+Amplitude.prototype.clearUserProperties = function(){
   if (!this._apiKeySet('clearUserProperties()')) {
-    if (callback && type(callback) === 'function') {
-      callback(0, 'No request sent');
-    }
     return;
   }
 
   var identify = new Identify();
   identify.clearAll();
-  this.identify(identify, callback);
+  this.identify(identify);
 };
 
 Amplitude.prototype.identify = function(identify, callback) {
@@ -669,13 +663,10 @@ var _isNumber = function(n) {
   return !isNaN(parseFloat(n)) && isFinite(n);
 };
 
-Amplitude.prototype.logRevenue = function(price, quantity, product, callback) {
+Amplitude.prototype.logRevenue = function(price, quantity, product) {
   // Test that the parameters are of the right type.
   if (!this._apiKeySet('logRevenue()') || !_isNumber(price) || quantity !== undefined && !_isNumber(quantity)) {
     // utils.log('Price and quantity arguments to logRevenue must be numbers');
-    if (callback && type(callback) === 'function') {
-      callback(0, 'No request sent');
-    }
     return -1;
   }
 
@@ -684,7 +675,7 @@ Amplitude.prototype.logRevenue = function(price, quantity, product, callback) {
     special: 'revenue_amount',
     quantity: quantity || 1,
     price: price
-  }, null, callback);
+  });
 };
 
 /**

src/amplitude.js

@@ -503,48 +503,6 @@ describe('Amplitude', function() {
       };
       assert.deepEqual(events[0].user_properties, expected);
     });
-
-    it('should run the callback after making the identify call', function() {
-      var counter = 0;
-      var value = -1;
-      var message = '';
-      var callback = function (status, response) {
-        counter++;
-        value = status;
-        message = response;
-      }
-      amplitude.setUserProperties({'key': 'value'}, callback);
-
-      // before server responds, callback should not fire
-      assert.lengthOf(server.requests, 1);
-      assert.equal(counter, 0);
-      assert.equal(value, -1);
-      assert.equal(message, '');
-
-      // after server response, fire callback
-      server.respondWith('success');
-      server.respond();
-      assert.equal(counter, 1);
-      assert.equal(value, 200);
-      assert.equal(message, 'success');
-    });
-
-    it('should run the callback even if client not initialized with apiKey', function() {
-      var counter = 0;
-      var value = -1;
-      var message = '';
-      var callback = function (status, response) {
-        counter++;
-        value = status;
-        message = response;
-      }
-      new Amplitude().setUserProperties({'key': 'value'}, callback);
-
-      // verify callback fired
-      assert.equal(counter, 1);
-      assert.equal(value, 0);
-      assert.equal(message, 'No request sent');
-    });
   });
 
   describe('clearUserProperties', function() {
@@ -574,48 +532,6 @@ describe('Amplitude', function() {
       };
       assert.deepEqual(events[0].user_properties, expected);
     });
-
-    it('should run the callback after making the identify call', function() {
-      var counter = 0;
-      var value = -1;
-      var message = '';
-      var callback = function (status, response) {
-        counter++;
-        value = status;
-        message = response;
-      }
-      amplitude.clearUserProperties(callback);
-
-      // before server responds, callback should not fire
-      assert.lengthOf(server.requests, 1);
-      assert.equal(counter, 0);
-      assert.equal(value, -1);
-      assert.equal(message, '');
-
-      // after server response, fire callback
-      server.respondWith('success');
-      server.respond();
-      assert.equal(counter, 1);
-      assert.equal(value, 200);
-      assert.equal(message, 'success');
-    });
-
-    it('should run the callback even if client not initialized with apiKey', function() {
-      var counter = 0;
-      var value = -1;
-      var message = '';
-      var callback = function (status, response) {
-        counter++;
-        value = status;
-        message = response;
-      }
-      new Amplitude().clearUserProperties(callback);
-
-      // verify callback fired
-      assert.equal(counter, 1);
-      assert.equal(value, 0);
-      assert.equal(message, 'No request sent');
-    });
   });
 
   describe('setDeviceId', function() {
@@ -2010,69 +1926,6 @@ describe('Amplitude', function() {
         productId: 'chicken.dinner'
       });
     });
-
-    it('should run the callback logging the revenue event', function() {
-      var counter = 0;
-      var value = -1;
-      var message = '';
-      var callback = function (status, response) {
-        counter++;
-        value = status;
-        message = response;
-      }
-      amplitude.logRevenue(9.99, 1, 'product', callback);
-
-      // before server responds, callback should not fire
-      assert.lengthOf(server.requests, 1);
-      assert.equal(counter, 0);
-      assert.equal(value, -1);
-      assert.equal(message, '');
-
-      // after server response, fire callback
-      server.respondWith('success');
-      server.respond();
-      assert.equal(counter, 1);
-      assert.equal(value, 200);
-      assert.equal(message, 'success');
-    });
-
-    it('should run the callback even if client not initialized with apiKey', function() {
-      var counter = 0;
-      var value = -1;
-      var message = '';
-      var callback = function (status, response) {
-        counter++;
-        value = status;
-        message = response;
-      }
-      new Amplitude().logRevenue(9.99, 1, 'product', callback);
-
-      // verify callback fired
-      assert.equal(counter, 1);
-      assert.equal(value, 0);
-      assert.equal(message, 'No request sent');
-    });
-
-    it('should run the callback even with invalid revenue arguments', function() {
-      var counter = 0;
-      var value = -1;
-      var message = '';
-      var callback = function (status, response) {
-        counter++;
-        value = status;
-        message = response;
-      }
-
-      amplitude.logRevenue('three', 1, 'product', callback);
-      assert.equal(counter, 1);
-      assert.equal(value, 0);
-      assert.equal(message, 'No request sent');
-
-      amplitude.logRevenue(9.99, true, 'product', callback);
-      assert.equal(counter, 2);
-      assert.equal(value, 0);
-      assert.equal(message, 'No request sent');
-    });
   });
 
   describe('sessionId', function() {

test/amplitude.js

@@ -59,12 +59,15 @@
     };
     var setPhotoCount = function() {
         var photoCount = parseInt(prompt('Input photo count to set', '2'), 10);
-        amplitude.identify(new amplitude.Identify().set('photoCount', photoCount));
+        amplitude.identify(new amplitude.Identify().set('photoCount', photoCount), function() {alert('setPhotoCount!');});
     };
     var setOncePhotoCount = function() {
         var photoCount = parseInt(prompt('Input photo count to setOnce', '2'), 10);
         amplitude.identify(new amplitude.Identify().setOnce('photoCount', photoCount));
     };
+    var logRevenue = function() {
+        amplitude.logRevenue(9.99, 1, 'productA');
+    }
 </script>
 <script>
     amplitude.init('a2dbce0e18dfe5f8e74493843ff5c053', null, {includeReferrer: true}, function() {