verbose and debug mode for proxy server; custom client IDs; session lockdown; misc

Author: cadorn

README.md

@@ -55,6 +55,8 @@ Launch debug proxy server:
 
     node ./example/server --port 9080 --php lib-phpdebug.localhost --idekey secret-key
 
+Use `-v` to log major events to console and `-d` to log debug messages to console.
+
 Test
 ----
 

example/client/js/main.js

@@ -195,5 +195,7 @@ function initDefaultClient(XDEBUG)
     {
     });
 
-    client.connect();   
+    client.connect({
+    	id: "client-browser"
+    });   
 }

example/server.js

@@ -72,6 +72,8 @@ var proxyServer = null,
 
 // See: https://github.com/chriso/cli/blob/master/examples/static.js
 CLI.parse({
+    verbose:  ["v", 'Log major events to console', 'boolean', false],
+    debug:  ["d", 'Log debug messages to console', 'boolean', false],
     port:  [false, 'Listen on this port', 'number', PROXY_PORT],
     php: [false, 'Hostname for `../php/`', 'string', PHP_VHOST],
 	test: [false, 'Test mode. Must be pinged to stay alive!'],
@@ -142,13 +144,22 @@ function startServer(options)
     var io = SOCKET_IO.listen(app);
 
     io.set("log level", 0);
+    if (options.verbose)
+        io.set("log level", 2);
+    if (options.debug)
+        io.set("log level", 3);
 
     // Initialize and hook in the debug proxy server so it can
     // communicate via `socket.io`.
 
-    proxyServer = new XDEBUG_PROXY.Server();
+    proxyServer = new XDEBUG_PROXY.Server({
+    	verbose: options.verbose,
+    	debug: options.debug
+    });
 
     proxyServer.listen(new XDEBUG.Client({
+    	verbose: options.verbose,
+    	debug: options.debug,
         API: {
             NET: NET,
             XML2JS: XML2JS
@@ -167,7 +178,19 @@ function startServer(options)
     proxyServer.hook({
         socketIO: io
     });
+    
+    proxyServer.on("session", function(session)
+    {
+    	if (session.name === "session-locked")
+    	{
+    		// Lock down the session to the client so no other client can listen in.
+    		// See the `../test/session.js` *lockedSession* test.
+    		
+    		session.lockToClient("client-server-session-locked");
+    	}
+    });
 
+    
     // Hook in browser test system
     io.of("/test").on("connection", function(socket)
     {

lib/dbgp.js

@@ -87,6 +87,7 @@ define(function(require, exports, module)
         }
         if (!/\u0000$/.test(chunk)) {
         	this.buffer = chunk;
+        	// TODO: Parse as much of the buffer as we can right away
 			return;
         }
 

lib/proxy.js

@@ -35,6 +35,8 @@ var Server = exports.Server = function(options)
     var self = this;
 
     this.options = options;
+    this.debug = this.options.debug || false;
+    this.verbose = this.options.verbose || false;
     this.listeners = {};
     this.clients = {};
     this.sessions = {};
@@ -67,18 +69,25 @@ Server.prototype.hook = function(options)
     {
         socket.on("connect-client", function(data, fn)
         {
-            self.clients[socket.id] = socket;
+            if (self.verbose)
+            	console.log("Got `connect-client` for socket ID '" + socket.id + "' and client ID '" + data.id + "'");
+        	data.socket = socket;
+            self.clients[socket.id] = data;
             fn();
         });
 
         socket.on("disconnect-client", function(data, fn)
         {
+            if (self.verbose)
+            	console.log("Got `disconnect-client` for socket ID '" + socket.id + "' and client ID '" + self.clients[socket.id].id + "'");
             delete self.clients[socket.id];
             fn();
         });
 
         socket.on("disconnect", function(data)
         {
+            if (self.verbose)
+            	console.log("Got `disconnect` for socket ID '" + socket.id + "' and client ID '" + self.clients[socket.id].id + "'");
             delete self.clients[socket.id];
         });
 
@@ -96,10 +105,19 @@ Server.prototype.listen = function(client)
 {
     var self = this;
 
-    function sendToClients(name, args)
+    function sendToClients(name, args, session)
     {
-        for (var id in self.clients) {
-            self.clients[id].emit(name, args);
+        for (var id in self.clients)
+        {
+        	if (!session.lockedClientId || self.clients[id].id === session.lockedClientId)
+        	{
+                self.clients[id].socket.emit(name, args);
+        	}
+        	else
+        	{
+        		if (self.debug)
+        			console.log("Skip sending data for session '" + session.name + "' to client '" + self.clients[id].id + "' as session is locked to client '" + session.lockedClientId + "'.");
+        	}
         }
     }
 
@@ -117,10 +135,15 @@ Server.prototype.listen = function(client)
             sendToClients("event", {
                 type: name,
                 session: session.id,
+                sessionName: session.name,
                 args: args
-            });
+            }, session);
         });
+        
+        self.emit("session", session);
     });
 
-    client.connect();
+    client.connect({
+    	"id": "xdebug-" + client.options.xdebugPort
+    });
 }

lib/xdebug.js

@@ -118,11 +118,13 @@ define(function(require, exports, module)
 
         this.API = options.API;
         this.options = options;
+        this.debug = this.options.debug || false;
+        this.verbose = this.options.verbose || false;
         this.listeners = {};
         this.sessions = {};
         this.connected = false;
-
         // NOTE: The client ID is unique to the environment only, not globally!
+        //       A custom ID may be set via `connect()`.
         this.id = "client-" + (++clientCounter);
     };
 
@@ -148,13 +150,18 @@ define(function(require, exports, module)
         }
     }
 
-    Client.prototype.connect = function()
+    Client.prototype.connect = function(options)
     {
+    	options = options || {};
+    	
         var self = this;
 
         if (this.connected)
             throw new Error("Client already connected!");
 
+    	if (options.id)
+    		self.id = options.id;
+        
         if (typeof this.options.xdebugPort !== "undefined")
         {
             this.engineServer = null;
@@ -183,11 +190,17 @@ define(function(require, exports, module)
                     self.sessions[session.id] = session;
 
                     self.emit("session", session);
+                    
+                    if (self.verbose)
+                    	console.log("Got `ready` for session '" + session.name + "' and client '" + self.id + "'.");
                 });
 
                 session.on("end", function()
                 {
                     delete self.sessions[session.id];
+                    
+                    if (self.verbose)
+                    	console.log("Got `end` for session '" + session.name + "' and client '" + self.id + "'.");
                 });
 
                 session.listen(socket);
@@ -214,7 +227,9 @@ define(function(require, exports, module)
 
                 clients[self.id] = true;
 
-                self.proxySocket.emit("connect-client", {}, function()
+                self.proxySocket.emit("connect-client", {
+                	id: self.id
+                }, function()
                 {
                     self.connected = true;
 
@@ -319,12 +334,15 @@ define(function(require, exports, module)
         options = options || {};
         this.API = options.API;
         this.options = options;
+        this.debug = this.options.debug || false;
+        this.verbose = this.options.verbose || false;
         this.listeners = {};
         this.status = "init";   // init, ready, aborted, ended
         this.socketIO = null;
         this.socket = null;
         this.commandCounter = 0;
         this.commandCallbacks = {};
+        this.lockedClientId = false;
 
         this.on("ready", function()
         {
@@ -363,6 +381,14 @@ define(function(require, exports, module)
         }
     }
 
+    Session.prototype.lockToClient = function(clientId)
+    {
+    	this.lockedClientId = clientId;
+    	
+    	if (this.verbose)
+    		console.log("Locked session '" + this.name + "' to client '" + this.lockedClientId + "'.");
+    }
+    
     Session.prototype.listen = function(socket)
     {
         var self = this;
@@ -384,7 +410,10 @@ define(function(require, exports, module)
 
         parser.on("packet", function(packet)
         {
-            if (self.status === "ready")
+        	if (self.debug)
+        		console.log("Got packet", packet);
+
+        	if (self.status === "ready")
             {
                 // 6.5 debugger engine errors
                 // @see http://www.xdebug.org/docs-dbgp.php#id32
@@ -433,7 +462,8 @@ define(function(require, exports, module)
                 }
                 else
                 {
-console.log(packet);
+                	console.log("ERROR: Got unknown packet type from xdebug!", packet);
+                	throw new Error("Got unknown packet type from xdebug!");
                 }
 
                 if (typeof packet["@"].status !== "undefined")
@@ -465,8 +495,8 @@ console.log(packet);
 	                }
 	                else
 	                {
-	                	
-console.log('status', packet);
+	                	console.log("ERROR: Got unknown status from xdebug!", packet);
+	                	throw new Error("Got unknown status from xdebug!");
 	                }
                 }
             }
@@ -540,6 +570,8 @@ console.log('status', packet);
                     self.id += "-" + packet["@"].thread;
                 if (packet["@"].idekey)
                     self.id += "-" + packet["@"].idekey;
+                
+                self.name = packet["@"].session;
 
                 self.emit("init", {raw: packet});
 

test/breakpoints.js

@@ -165,7 +165,9 @@ var Test =
         	next();
         });
 
-        client.connect();
+        client.connect({
+        	id: "client-server-breakpoints"
+        });
     },
 
     "test browserBreakpoints": function(next)

test/browser/breakpoints.js

@@ -158,7 +158,9 @@ define(function(require, exports, module)
         	callback(true);
         });
 
-        client.connect();
+        client.connect({
+        	id: "client-browser-breakpoints"
+        });
     }
 
 });

test/browser/connection.js

@@ -44,7 +44,9 @@ define(function(require, exports, module)
             callback(true);
         });
 
-        client.connect();
+        client.connect({
+        	id: "client-browser-connection"
+        });
     }
 
 });

test/browser/session.js

@@ -63,7 +63,9 @@ define(function(require, exports, module)
             callback(true);
         });
 
-        client.connect();
+        client.connect({
+        	id: "client-browser-session"
+        });
     }
 
 });