Merge branch 'rc3.0.17'

Author: proteamer

Changelog.md

@@ -1,5 +1,11 @@
 # Echo JS SDK CHANGELOG:
 
+##v3.0.17 - February 27, 2014
+
+* **Canvas config loading machinery was updated** to avoid race conditions when a browser tries to retrieve config which was cached by a browser previously. We updated the logic to make sure that an execution order always remains the same.
+
+* **WebSockets connection reestablishment logic** was improved to be more fault tolerant to socket connection closing delays. Previously it caused a delay (up to a few minutes) to switchover to Polling method. Now if the socket is not closed within 10 seconds, we drop the connection and switch to Polling immediately to avoid any delays in live update items appearance.
+
 ##v3.0.16 - January 14, 2014
 
 * **StreamServer live updates connection logic was updated** and now if WebSockets are enabled, we try to establish a connection using WS first and fall back to Polling if our attempt failed or timed out (within 5 seconds). Previously both Polling and WebSockets were initialized in parallel and Polling got disabled when WS connection is established. This new connection logic is more efficient from both server-side and client-side standpoints.

NOTICE

@@ -3,7 +3,7 @@
    =========================================================================
 
    Echo Javascript SDK
-   Copyright 2012-2013, Echo
+   Copyright 2012-2014, Echo
 
    This product was initially developed at Echo (AboutEcho.com) with 
    contributions by the wider community.

Readme.md

@@ -36,7 +36,7 @@ Release notes are posted to our [Developer Forum](https://groups.google.com/foru
 We welcome your contributions. Please submit all pull requests to the master branch and the Echo team will help coordinate.
 
 # License
-Copyright 2013 Echo
+Copyright 2014 Echo
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:
 

config/jsduck/config.json

@@ -1,6 +1,6 @@
 {
 	"--title": "Echo JS SDK Documentation Center",
-	"--footer": "<a class=\"policy\" target=\"_blank\" href=\"http://aboutecho.com/Privacy\">Privacy Policy</a> | © 2013 Echo. All rights reserved.",
+	"--footer": "<a class=\"policy\" target=\"_blank\" href=\"http://aboutecho.com/Privacy\">Privacy Policy</a> | © 2014 Echo. All rights reserved.",
 	"--": ["../../build"],
 	"--output": "../../web/docs",
 	"--tags": "../../tools/jsduck/custom-tags.rb",

package.json

@@ -2,7 +2,7 @@
   "name": "js-sdk",
   "title": "Echo JS SDK",
   "description": "Javascript SDK for Echo applications",
-  "version": "3.0.16",
+  "version": "3.0.17",
   "homepage": "http://echoappsteam.github.io/js-sdk/",
   "author": {
     "name": "Echo",

src/api.js

@@ -60,11 +60,16 @@ Echo.API.Transports.WebSockets = utils.inherit(Echo.API.Transport, function(conf
 	config = $.extend(true, {
 		"settings": {
 			"maxConnectRetries": 3,
-			"serverPingInterval": 30, // client-server ping-pong interval
+			"serverPingInterval": 30, // client-server ping-pong interval (in seconds)
+			"closeSocketTimeout": 10, // time (in seconds) we can give WS to close connection
 			"protocols": ["liveupdate.ws.echoenabled.com"]
 		}
 	}, config || {});
-	this.timers = {};
+	this.timers = {
+		"ping": null,
+		"pong": null,
+		"close": null
+	};
 	this.subscriptionIds = {};
 	this.unique = Echo.Utils.getUniqueString();
 	Echo.API.Transports.WebSockets.parent.constructor.call(this, config);
@@ -129,14 +134,24 @@ Echo.API.Transports.WebSockets.prototype.unsubscribe = function unsubscribe(arg)
 Echo.API.Transports.WebSockets.prototype.abort = function(force) {
 	var self = this;
 	var socket = Echo.API.Transports.WebSockets.socketByURI[this.config.get("uri")];
-	$.map(["onData", "onOpen", "onError"], $.proxy(this.unsubscribe, this));
 	if (socket) {
 		delete socket.subscribers[this.unique];
-		// close socket connection if the last subscriber left
-		if ($.isEmptyObject(socket.subscribers) || force) {
-			if (this.connected()) {
-				this.transportObject.close();
+		this._clearTimers();
+		this.subscribe("onClose", {
+			"once": true,
+			"handler": function() {
+				self.unsubscribe();
 			}
+		});
+		// close socket connection if the last subscriber left
+		if (($.isEmptyObject(socket.subscribers) || force) && this.connected()) {
+			// if closing a coonection to WS takes more time than
+			// setting "closeSocketTimeout" is - we force switchover to Polling
+			this.timers.close = setTimeout(
+				$.proxy(this._onCloseHandler, this),
+				this.config.get("settings.closeSocketTimeout") * 1000
+			);
+			this.transportObject.close();
 		}
 	}
 };
@@ -173,6 +188,9 @@ Echo.API.Transports.WebSockets.prototype._getTransportObject = function() {
 		self.subscribe(topic, {
 			"handler": function(_, data) {
 				self.config.get(topic)(data);
+				if (topic === "onClose") {
+					clearTimeout(self.timers.close);
+				}
 			},
 			// when we receive data - send it to the appropriate
 			// subscribers only (do not send it to all subscribers)
@@ -214,8 +232,7 @@ Echo.API.Transports.WebSockets.prototype._prepareTransportObject = function() {
 		self._publish("onData", data, data && data.subscription);
 	};
 	socket.onclose = function() {
-		self._publish("onClose");
-		self._clear();
+		self._onCloseHandler();
 	};
 	socket.onerror = function(error) {
 		self._publish("onError", self._wrapErrorResponse(error));
@@ -233,18 +250,13 @@ Echo.API.Transports.WebSockets.prototype._clearTimers = function() {
 	this.timers = {};
 };
 
+Echo.API.Transports.WebSockets.prototype._onCloseHandler = function() {
+	this._publish("onClose");
+	this._clear();
+};
+
 Echo.API.Transports.WebSockets.prototype._clear = function() {
-	var self = this;
-	var socket = Echo.API.Transports.WebSockets.socketByURI[this.config.get("uri")];
 	var context = this.config.get("uri").replace(/\//g, "-");
-	this._clearTimers();
-	this.unsubscribe();
-	$.map(["onData", "onOpen", "onClose", "onError"], function(name) {
-		Echo.Events.unsubscribe({
-			"topic": "Echo.API.Transports.WebSockets." + name,
-			"context": context
-		});
-	});
 	delete Echo.API.Transports.WebSockets.socketByURI[this.config.get("uri")];
 };
 
@@ -290,15 +302,10 @@ Echo.API.Transports.WebSockets.prototype._tryReconnect = function() {
 	// exit when the connection attempt is scheduled (to prevent
 	// multiple connections) or if no connection attempts left
 	if (this.attemptsRemaining === 0) {
-		this._reconnect();
+		this.abort(true);
 	}
 };
 
-Echo.API.Transports.WebSockets.prototype._reconnect = function() {
-	this.abort(true);
-	this._connect();
-};
-
 Echo.API.Transports.WebSockets.available = function() {
 	return !!(window.WebSocket || window.MozWebSocket);
 };

src/canvas.js

@@ -419,34 +419,40 @@ canvas.methods._fetchConfig = function(callback) {
 		})
 	});
 
-	$.ajax({
-		"url": URL,
-		"crossDomain": true,
-		"dataType": "script",
-		"cache": mode !== "dev",
-		"timeout": Echo.Loader.config.errorTimeout,
-		"success": function() {
-			var config = getConfig();
-			if (!config || !config.apps || !config.apps.length) {
-				var message = self.labels.get("error_no_" + (config ? "apps" : "config"));
+	// We rely on asynchronous behavior of the $.ajax method call
+	// to implement store/fetch mechanics. But it can occasionally
+	// be synchronous while fetching cached response. In order to
+	// avoid this issue, we always make $.ajax call asynchronously.
+	setTimeout(function() {
+		$.ajax({
+			"url": URL,
+			"crossDomain": true,
+			"dataType": "script",
+			"cache": mode !== "dev",
+			"timeout": Echo.Loader.config.errorTimeout,
+			"success": function() {
+				var config = getConfig();
+				if (!config || !config.apps || !config.apps.length) {
+					var message = self.labels.get("error_no_" + (config ? "apps" : "config"));
+					self._error({
+						"args": {"config": config, "target": target},
+						"code": "invalid_canvas_config",
+						"message": message
+					});
+					return;
+				}
+				self.set("data", config); // store Canvas data into the instance
+				callback.call(self);
+			},
+			"error": function() {
 				self._error({
-					"args": {"config": config, "target": target},
-					"code": "invalid_canvas_config",
-					"message": message
+					"args": arguments,
+					"code": "unable_to_retrieve_app_config",
+					"renderError": true
 				});
-				return;
 			}
-			self.set("data", config); // store Canvas data into the instance
-			callback.call(self);
-		},
-		"error": function() {
-			self._error({
-				"args": arguments,
-				"code": "unable_to_retrieve_app_config",
-				"renderError": true
-			});
-		}
-	});
+		});
+	}, 0);
 };
 
 Echo.Control.create(canvas);

src/streamserver/api.js

@@ -178,10 +178,13 @@ Echo.StreamServer.API.Request = Echo.Utils.inherit(Echo.API.Request, function(co
  * Method to stop live updates requests.
  */
 Echo.StreamServer.API.Request.prototype.abort = function() {
+	var self = this;
 	Echo.StreamServer.API.Request.parent.abort.call(this);
 	if (this.liveUpdates) {
+		this.liveUpdates.on("close", function() {
+			delete self.liveUpdates;
+		});
 		this.liveUpdates.stop();
-		delete this.liveUpdates;
 	}
 };
 
@@ -320,13 +323,14 @@ Echo.StreamServer.API.Request.prototype._getLiveUpdatesConfig = function(name) {
 			"resubscribe.resetPeriod": "liveUpdates.websockets.resetPeriod",
 			"resubscribe.maxResetsPerPeriod": "liveUpdates.websockets.maxResetsPerPeriod",
 			"request.settings.maxConnectRetries": "liveUpdates.websockets.maxConnectRetries",
-			"request.settings.serverPingInterval": "liveUpdates.websockets.serverPingInterval"
+			"request.settings.serverPingInterval": "liveUpdates.websockets.serverPingInterval",
+			"request.settings.closeSocketTimeout": "liveUpdates.websockets.closeSocketTimeout"
 		}
 	};
 
 	var mapped = Echo.Utils.foldl({}, map[name], function(from, acc, to) {
 		var value = function fetch(key) {
-			var parts, val = self.config.get(key);
+			var val = self.config.get(key);
 			if (typeof val === "undefined" && key) {
 				return fetch(key.split(".").slice(1).join("."));
 			}
@@ -352,13 +356,13 @@ Echo.StreamServer.API.Request.prototype._liveUpdatesWatcher = function(polling,
 	var fallbackTimeout, waitingForConnectionTimeout;
 	ws.on("close", function() {
 		var timeout, fallback = config.fallback;
-		if (self.liveUpdates.closeReason !== "abort") {
+		clearTimeout(waitingForConnectionTimeout);
+		if (self.liveUpdates && self.liveUpdates.closeReason !== "abort") {
 			timeout = Echo.Utils.random(
 				fallback.timeout - fallback.divergence,
 				fallback.timeout + fallback.divergence
 			) * 1000;
 			fallbackTimeout = setTimeout(function() {
-				clearTimeout(waitingForConnectionTimeout);
 				switchTo(polling)();
 			}, timeout);
 		}
@@ -370,7 +374,7 @@ Echo.StreamServer.API.Request.prototype._liveUpdatesWatcher = function(polling,
 		switchTo(polling)();
 	}, config.waitingForConnection * 1000);
 	if (ws.connected()) {
-		clearTimeout(waitingForConnectionTimeout)
+		clearTimeout(waitingForConnectionTimeout);
 		return;
 	}
 	ws.on("open", function() {
@@ -709,7 +713,7 @@ Echo.StreamServer.API.WebSockets = Echo.Utils.inherit(Echo.StreamServer.API.Poll
 	});
 	this.queue = [];
 	this.subscribed = false;
-	this.subscriptionIds = [];
+	this.closeReason = "unknown";
 	this.subscriptionResets = {
 		"count": 0,
 		"time": (new Date()).getTime()
@@ -786,7 +790,6 @@ Echo.StreamServer.API.WebSockets.prototype.on = function(event, fn, params) {
 			"handler": fn
 		}
 	);
-	this.subscriptionIds.push(id);
 	return id;
 };
 
@@ -798,13 +801,12 @@ Echo.StreamServer.API.WebSockets.prototype.connected = function() {
 
 Echo.StreamServer.API.WebSockets.prototype.stop = function() {
 	var self = this;
-	this._clearSubscriptions();
+	this.closeReason = "abort";
 	if (this.connected()) {
 		this.queue.push(function() {
 			if (self.subscribed) {
 				self.requestObject.request({"event": "unsubscribe/request"});
 			}
-			self.closeReason = "abort";
 			self.requestObject.abort();
 		});
 		this._runQueue();
@@ -852,7 +854,6 @@ Echo.StreamServer.API.WebSockets.prototype._reconnect = function() {
 	};
 	this.closeReason = "reconnect";
 	this.requestObject.abort();
-	this._clearSubscriptions();
 	if (this.requestObject.transport.closing()) {
 		var id = this.on("close", function() {
 			closeHandler();
@@ -905,11 +906,6 @@ Echo.StreamServer.API.WebSockets.prototype._resubscribeAllowed = function() {
 	}
 };
 
-Echo.StreamServer.API.WebSockets.prototype._clearSubscriptions = function() {
-	$.map(this.subscriptionIds, $.proxy(this.requestObject.transport.unsubscribe, this.requestObject.transport));
-	this.subscriptionIds = [];
-};
-
 Echo.StreamServer.API.WebSockets.prototype._runQueue = function() {
 	while (this.queue.length) {
 		this.queue.shift().call(this);

src/streamserver/controls/facepile.js

@@ -166,7 +166,7 @@ pile.config = {
 	 * @cfg {Boolean} [liveUpdates.enabled=true]
 	 * Parameter to enable/disable live updates.
 	 *
-	 * @cfg {String} [liveUpdates.transport="polling"]
+	 * @cfg {String} [liveUpdates.transport="websockets"]
 	 * Preferred live updates receiveing machinery transport.
 	 * The following transports are supported:
 	 *
@@ -199,7 +199,7 @@ pile.config = {
 	 * to keep the connection alive.
 	 */
 	"liveUpdates": {
-		"transport": "polling", // or "websockets"
+		"transport": "websockets", // or "polling"
 		"enabled": true,
 		"polling": {
 			"timeout": 10

src/streamserver/controls/stream.js

@@ -251,7 +251,7 @@ stream.config = {
 	 * @cfg {Boolean} [liveUpdates.enabled=true]
 	 * Parameter to enable/disable live updates.
 	 *
-	 * @cfg {String} [liveUpdates.transport="polling"]
+	 * @cfg {String} [liveUpdates.transport="websockets"]
 	 * Preferred live updates receiveing machinery transport.
 	 * The following transports are supported:
 	 *
@@ -284,7 +284,7 @@ stream.config = {
 	 * to keep the connection alive.
 	 */
 	"liveUpdates": {
-		"transport": "polling", // or "websockets"
+		"transport": "websockets", // or "polling"
 		"enabled": true,
 		"polling": {
 			"timeout": 10

tests/unit/loader.js

@@ -759,6 +759,9 @@ Echo.Tests.asyncTest("canvases initialization", function() {
 			$.map(["stream", "submit"], function(app) {
 				var def = Echo.jQuery.Deferred();
 				Echo.Loader.override(id + extra, app, {
+					"liveUpdates": {
+						"enabled": false
+					},
 					"ready": function() {
 						def.resolve();
 					}