Connection#ping: support no cb, return responseTime, add test

common/lib/client/connection.js

@@ -35,6 +35,7 @@ var Connection = (function() {
 
 	Connection.prototype.ping = function(callback) {
 		Logger.logAction(Logger.LOG_MINOR, 'Connection.ping()', '');
+		callback = callback || function() {};
 		this.connectionManager.ping(null, callback);
 	};
 

common/lib/transport/connectionmanager.js

@@ -957,12 +957,16 @@ var ConnectionManager = (function() {
 				callback(new ErrorInfo('Timedout waiting for heartbeat response', 50000, 500));
 			};
 
+			var pingStart = Date.now();
+
 			var onHeartbeat = function () {
 				clearTimeout(timer);
-				callback(null);
+				var responseTime = Date.now() - pingStart;
+				callback(null, responseTime);
 			};
 
 			var timer = setTimeout(onTimeout, Defaults.sendTimeout);
+
 			transport.once('heartbeat', onHeartbeat);
 			transport.ping();
 			return;
@@ -978,11 +982,11 @@ var ConnectionManager = (function() {
 		 * but ensure that we retry if the transport is superseded before we complete */
 		var completed = false, self = this;
 
-		var onPingComplete = function(err) {
+		var onPingComplete = function(err, responseTime) {
 			self.off('transport.active', onTransportActive);
 			if(!completed) {
 				completed = true;
-				callback(err);
+				callback(err, responseTime);
 			}
 		};
 

spec/realtime/connection.test.js

@@ -0,0 +1,63 @@
+"use strict";
+
+define(['ably', 'shared_helper'], function(Ably, helper) {
+	var exports = {},
+		closeAndFinish = helper.closeAndFinish,
+		monitorConnection = helper.monitorConnection;
+
+	exports.setupConnection = function(test) {
+		test.expect(1);
+		helper.setupApp(function(err) {
+			if(err) {
+				test.ok(false, helper.displayError(err));
+			} else {
+				test.ok(true, 'app set up');
+			}
+			test.done();
+		});
+	};
+
+	exports.connectionPing = function(test) {
+		test.expect(1);
+		var realtime;
+		try {
+			realtime = helper.AblyRealtime();
+			realtime.connection.on('connected', function() {
+				realtime.connection.ping();
+				test.ok(true, 'check that ping without did not raise exception');
+				closeAndFinish(test, realtime);
+			});
+			monitorConnection(test, realtime);
+		} catch(e) {
+			test.ok(false, 'test failed with exception: ' + e.stack);
+			closeAndFinish(test, realtime);
+		}
+	};
+
+	exports.connectionPingWithCallback = function(test) {
+		test.expect(2);
+		var realtime;
+		try {
+			realtime = helper.AblyRealtime();
+			realtime.connection.on('connected', function() {
+				realtime.connection.ping(function(err, responseTime){
+					if(err) {
+						test.ok(false, helper.displayError(err));
+						closeAndFinish(test, realtime);
+						return;
+					}
+					test.equal(typeof responseTime, "number", 'check that a responseTime returned');
+					test.ok(responseTime > 0, 'check that responseTime was +ve');
+					closeAndFinish(test, realtime);
+				});
+			});
+			monitorConnection(test, realtime);
+		} catch(e) {
+			test.ok(false, 'test failed with exception: ' + e.stack);
+			closeAndFinish(test, realtime);
+		}
+	};
+
+
+	return module.exports = helper.withTimeout(exports);
+});