Merge pull request #57 from amplitude/add_callback_identify_setuserproperties

add callback support for identify calls

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,14 +238,19 @@ 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.
 
-### Log Event Callbacks and Redirects ###
-You can pass a callback function to logEvent, 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);
 ```
 
-The status and response 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
+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
 var callback_function = function(status, response) {

amplitude.js

@@ -599,8 +599,11 @@ Amplitude.prototype.clearUserProperties = function(){
   this.identify(identify);
 };
 
-Amplitude.prototype.identify = function(identify) {
+Amplitude.prototype.identify = function(identify, callback) {
   if (!this._apiKeySet('identify()')) {
+    if (callback && type(callback) === 'function') {
+      callback(0, 'No request sent');
+    }
     return;
   }
 
@@ -617,7 +620,9 @@ Amplitude.prototype.identify = function(identify) {
   }
 
   if (identify instanceof Identify && Object.keys(identify.userPropertiesOperations).length > 0) {
-    this._logEvent(IDENTIFY_EVENT, null, null, identify.userPropertiesOperations);
+    this._logEvent(IDENTIFY_EVENT, null, null, identify.userPropertiesOperations, callback);
+  } else if (callback && type(callback) === 'function') {
+    callback(0, 'No request sent');
   }
 };
 
@@ -751,6 +756,9 @@ Amplitude.prototype._limitEventsQueued = function(queue) {
 
 Amplitude.prototype.logEvent = function(eventType, eventProperties, callback) {
   if (!this._apiKeySet('logEvent()')) {
+    if (callback && type(callback) === 'function') {
+      callback(0, 'No request sent');
+    }
     return -1;
   }
   return this._logEvent(eventType, eventProperties, null, null, callback);
@@ -804,6 +812,9 @@ Amplitude.prototype.removeEvents = function (maxEventId, maxIdentifyId) {
 
 Amplitude.prototype.sendEvents = function(callback) {
   if (!this._apiKeySet('sendEvents()')) {
+    if (callback && type(callback) === 'function') {
+      callback(0, 'No request sent');
+    }
     return;
   }
 

amplitude.min.js

@@ -493,8 +493,11 @@ Amplitude.prototype.clearUserProperties = function(){
   this.identify(identify);
 };
 
-Amplitude.prototype.identify = function(identify) {
+Amplitude.prototype.identify = function(identify, callback) {
   if (!this._apiKeySet('identify()')) {
+    if (callback && type(callback) === 'function') {
+      callback(0, 'No request sent');
+    }
     return;
   }
 
@@ -511,7 +514,9 @@ Amplitude.prototype.identify = function(identify) {
   }
 
   if (identify instanceof Identify && Object.keys(identify.userPropertiesOperations).length > 0) {
-    this._logEvent(IDENTIFY_EVENT, null, null, identify.userPropertiesOperations);
+    this._logEvent(IDENTIFY_EVENT, null, null, identify.userPropertiesOperations, callback);
+  } else if (callback && type(callback) === 'function') {
+    callback(0, 'No request sent');
   }
 };
 
@@ -645,6 +650,9 @@ Amplitude.prototype._limitEventsQueued = function(queue) {
 
 Amplitude.prototype.logEvent = function(eventType, eventProperties, callback) {
   if (!this._apiKeySet('logEvent()')) {
+    if (callback && type(callback) === 'function') {
+      callback(0, 'No request sent');
+    }
     return -1;
   }
   return this._logEvent(eventType, eventProperties, null, null, callback);
@@ -698,6 +706,9 @@ Amplitude.prototype.removeEvents = function (maxEventId, maxIdentifyId) {
 
 Amplitude.prototype.sendEvents = function(callback) {
   if (!this._apiKeySet('sendEvents()')) {
+    if (callback && type(callback) === 'function') {
+      callback(0, 'No request sent');
+    }
     return;
   }
 

src/amplitude.js

@@ -670,6 +670,67 @@ describe('Amplitude', function() {
         '$set': {'key4': 'value5'}
       });
     });
+
+    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;
+      }
+      var identify = new amplitude.Identify().set('key', 'value');
+      amplitude.identify(identify, 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;
+      }
+      var identify = new amplitude.Identify().set('key', 'value');
+      new Amplitude().identify(identify, 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 an invalid identify object', function() {
+      var counter = 0;
+      var value = -1;
+      var message = '';
+      var callback = function (status, response) {
+        counter++;
+        value = status;
+        message = response;
+      }
+      amplitude.identify(null, callback);
+
+      // verify callback fired
+      assert.equal(counter, 1);
+      assert.equal(value, 0);
+      assert.equal(message, 'No request sent');
+    });
   });
 
   describe('logEvent', 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() {