debug support; use client from engine.io package

Author: cadorn

README.md

@@ -37,6 +37,15 @@ Testing:
 
     npm test
 
+Debugging:
+
+    Plugin Config ~ {
+        debug: true
+    }
+    
+    (function() { require(["smith.io"], function (TRANSPORT) { TRANSPORT.setDebug(true); localStorage.debug = "*"; }); })()
+    (function() { require(["smith.io"], function (TRANSPORT) { TRANSPORT.setDebug(false); localStorage.debug = ""; }); })()
+
 
 License
 =======

package.json

@@ -16,8 +16,7 @@
     "dependencies": {
         "smith": "~0.1.9",
         "msgpack-js-browser": "~0.1.3",
-        "engine.io": "https://github.com/c9/engine.io/tarball/9042f79ee80d70d52ce82cf53815099312fdf5d0",
-        "engine.io-client": "https://github.com/c9/engine.io-client/tarball/a395f08d83676828f58b27badba72368299c009d"
+        "engine.io": "https://github.com/c9/engine.io/tarball/7e953da83edfad6f2c11307a1f846232c8093bae"
     },
     "scripts": {
         "test": "node test/all.js"

server-plugin/plugin.js

@@ -144,13 +144,13 @@ module.exports = function startup(options, imports, register) {
     if (options.registerClientRoutes !== false) {
 
         imports.static.addStatics([{
-            path: PATH.dirname(require.resolve("engine.io-client/dist/engine.io.js")),
+            path: PATH.dirname(require.resolve("engine.io/node_modules/engine.io-client/dist/engine.io.js")),
             mount: "/engine.io",
             rjs: [
                 {
                     "name": "engine.io",
                     "location": "engine.io",
-                    "main": "engine.io.js"
+                    "main": "engine.io" + ((options.debug)?"-dev":"") + ".js"
                 }
             ]
         }]);

server-plugin/www/client.js

@@ -6,6 +6,8 @@ define(function(require, exports, module) {
 	var SMITH = require("smith");
 	var EVENTS = require("smith/events-amd");
 
+	var transports = [];
+	var debugHandler = null;
 
 	function inherits(Child, Parent) {
 	    Child.prototype = Object.create(Parent.prototype, { constructor: { value: Child }});
@@ -28,7 +30,15 @@ define(function(require, exports, module) {
 	}
 
 	inherits(Transport, EVENTS.EventEmitter);
-    
+
+	Transport.prototype.getUri = function() {
+		return "http" + ((this.options.secure)?"s":"") + "://" + 
+			   this.options.host + 
+			   ((this.options.port)?":"+this.options.port:"") +
+			   this.options.path +
+			   this.options.resource;
+	}
+
 	Transport.prototype.connect = function(options, callback) {
 		var _self = this;
 
@@ -46,6 +56,10 @@ define(function(require, exports, module) {
 				}
 			});
 
+			_self.socket.on("heartbeat", function () {
+				_self.emit("heartbeat");
+			});
+
 			_self.socket.on("open", function () {
 
 				connecting = false;
@@ -108,6 +122,9 @@ define(function(require, exports, module) {
 						}
 
 						setTimeout(function() {
+
+							_self.emit("reconnect", options.reconnectAttempt);
+
 							_self.connect({
 								reconnectAttempt: options.reconnectAttempt,
 								fireConnect: (options.reconnectAttempt >= 6) ? true : false
@@ -143,8 +160,78 @@ define(function(require, exports, module) {
 
 	exports.connect = function(options, callback) {
 		var transport = new Transport(options, callback);
+		transports.push(transport);
+		if (debugHandler) {
+			debugHandler.hookTransport(transport);
+		}
 		transport.connect({}, callback);
 		return transport;
 	}
 
+	exports.setDebug = function(debug) {
+		if (debugHandler !== null) {
+			if (debug) return;
+			return debugHandler.stop();
+		} else if (!debug) return;
+		debugHandler = {
+			transports: [],
+			handlers: [],
+			start: function() {
+				transports.forEach(debugHandler.hookTransport);
+			},
+			stop: function() {
+				transports.forEach(debugHandler.unhookTransport);
+				debugHandler = null;
+			},
+			hookTransport: function(transport) {
+				var index = debugHandler.transports.indexOf(transport);
+				if (index !== -1) return;
+
+				console.log("[smith.io:" + transport.getUri() + "] Hook debugger");
+
+				var listeners = {};
+
+				transport.on("connect", listeners["connect"] = function() {
+					console.log("[smith.io:" + transport.getUri() + "] Connect");
+				});
+				transport.on("reconnect", listeners["reconnect"] = function(attempt) {
+					console.log("[smith.io:" + transport.getUri() + "] Reconnect: " + attempt);
+				});
+				transport.on("disconnect", listeners["disconnect"] = function(reason) {
+					console.log("[smith.io:" + transport.getUri() + "] Disconnect: " + reason);
+				});
+				transport.on("heartbeat", listeners["heartbeat"] = function(message) {
+					console.log("[smith.io:" + transport.getUri() + "] Heartbeat");
+				});
+				transport.on("message", listeners["message"] = function(message) {
+					console.log("[smith.io:" + transport.getUri() + "] Message", message);
+				});
+				transport.on("away", listeners["away"] = function() {
+					console.log("[smith.io:" + transport.getUri() + "] Away");
+				});
+				transport.on("back", listeners["back"] = function() {
+					console.log("[smith.io:" + transport.getUri() + "] Back");
+				});
+
+				debugHandler.transports.push(transport);
+				debugHandler.handlers.push({
+					unhook: function() {
+						console.log("[smith.io:" + transport.getUri() + "] Unhook debugger");
+						for (var type in listeners) {
+							transport.removeListener(type, listeners[type]);
+						}
+					}
+				});
+			},
+			unhookTransport: function(transport) {
+				var index = debugHandler.transports.indexOf(transport);
+				if (index === -1) return;
+				debugHandler.transports.splice(index, 1);
+				debugHandler.handlers[index].unhook();
+				debugHandler.handlers.splice(index, 1);
+			}
+		};
+		debugHandler.start();
+	}
+
 });

test/all.js

@@ -99,7 +99,7 @@ function main(callback) {
 				testPackage(path, function(err) {
 					if (err) return callback(err);
 
-					path = PATH.join(__dirname, "../node_modules/engine.io-client");
+					path = PATH.join(__dirname, "../node_modules/engine.io/node_modules/engine.io-client");
 
 					ensureDependenciesInstalled(path, "devDependencies", function(err) {
 						if (err) return callback(err);