Include connection ID in debug output

Author: dougwilson

Changes.md

@@ -6,6 +6,7 @@ you spot any mistakes.
 
 ## HEAD
 
+* Include connection ID in debug output
 * Update `bignumber.js` to 4.1.0
 * Update `readable-stream` to 2.3.4
 

lib/protocol/Protocol.js

@@ -437,11 +437,16 @@ Protocol.prototype.destroy = function() {
 };
 
 Protocol.prototype._debugPacket = function(incoming, packet) {
-  var headline = (incoming)
+  var connection = this._connection;
+  var headline   = incoming
     ? '<-- '
     : '--> ';
 
-  headline = headline + packet.constructor.name;
+  if (connection && connection.threadId !== null) {
+    headline += '(' + connection.threadId + ') ';
+  }
+
+  headline += packet.constructor.name;
 
   // check for debug packet restriction
   if (Array.isArray(this._config.debug) && this._config.debug.indexOf(packet.constructor.name) === -1) {

test/unit/connection/test-debug-exclude.js

@@ -5,6 +5,7 @@ var connection = common.createConnection({
   port  : common.fakeServerPort
 });
 
+var tid    = 0;
 var server = common.createFakeServer();
 
 server.listen(common.fakeServerPort, function (err) {
@@ -22,12 +23,16 @@ server.listen(common.fakeServerPort, function (err) {
     assert.ifError(err);
     assert.equal(messages.length, 3);
     assert.deepEqual(messages, [
-      '<-- OkPacket',
-      '--> ComPingPacket',
-      '<-- OkPacket'
+      '<-- (1) OkPacket',
+      '--> (1) ComPingPacket',
+      '<-- (1) OkPacket'
     ]);
 
     connection.destroy();
     server.destroy();
   });
 });
+
+server.on('connection', function (conn) {
+  conn.handshake({ threadId: ++tid });
+});

test/unit/connection/test-debug-parser-error.js

@@ -2,6 +2,7 @@ var assert     = require('assert');
 var common     = require('../../common');
 var connection = common.createConnection({debug: true, port: common.fakeServerPort});
 
+var tid    = 0;
 var server = common.createFakeServer();
 
 server.listen(common.fakeServerPort, function (err) {
@@ -21,10 +22,10 @@ server.listen(common.fakeServerPort, function (err) {
     assert.deepEqual(messages, [
       '<-- HandshakeInitializationPacket',
       '--> ClientAuthenticationPacket',
-      '<-- OkPacket',
-      '--> ComQueryPacket',
-      '<-- ResultSetHeaderPacket',
-      '<-- FieldPacket'
+      '<-- (1) OkPacket',
+      '--> (1) ComQueryPacket',
+      '<-- (1) ResultSetHeaderPacket',
+      '<-- (1) FieldPacket'
     ]);
 
     connection.destroy();
@@ -33,7 +34,7 @@ server.listen(common.fakeServerPort, function (err) {
 });
 
 server.on('connection', function(conn) {
-  conn.handshake();
+  conn.handshake({ threadId: ++tid });
   conn.on('query', function(packet) {
     switch (packet.sql) {
       case 'SELECT value FROM stuff':

test/unit/connection/test-debug.js

@@ -2,6 +2,7 @@ var assert     = require('assert');
 var common     = require('../../common');
 var connection = common.createConnection({debug: true, port: common.fakeServerPort});
 
+var tid    = 0;
 var server = common.createFakeServer();
 
 server.listen(common.fakeServerPort, function (err) {
@@ -21,12 +22,16 @@ server.listen(common.fakeServerPort, function (err) {
     assert.deepEqual(messages, [
       '<-- HandshakeInitializationPacket',
       '--> ClientAuthenticationPacket',
-      '<-- OkPacket',
-      '--> ComPingPacket',
-      '<-- OkPacket'
+      '<-- (1) OkPacket',
+      '--> (1) ComPingPacket',
+      '<-- (1) OkPacket'
     ]);
 
     connection.destroy();
     server.destroy();
   });
 });
+
+server.on('connection', function (conn) {
+  conn.handshake({ threadId: ++tid });
+});

test/unit/pool/test-debug.js

@@ -0,0 +1,65 @@
+var assert = require('assert');
+var common = require('../../common');
+var pool   = common.createPool({debug: true, port: common.fakeServerPort});
+
+var tid    = 0;
+var server = common.createFakeServer();
+
+server.listen(common.fakeServerPort, function (err) {
+  assert.ifError(err);
+
+  var messages = [];
+
+  console.log = function (str) {
+    if (typeof str === 'string' && str.length !== 0) {
+      messages.push(str);
+    }
+  };
+
+  pool.getConnection(function (err, conn1) {
+    assert.ifError(err);
+    conn1.query('SELECT 1', function (err) {
+      assert.ifError(err);
+      pool.getConnection(function (err, conn2) {
+        assert.ifError(err);
+        conn2.query('SELECT 1', function (err) {
+          assert.ifError(err);
+          conn1.release();
+          conn2.release();
+          pool.end(function (err) {
+            assert.ifError(err);
+            assert.equal(messages.length, 20);
+            assert.deepEqual(messages, [
+              '<-- HandshakeInitializationPacket',
+              '--> ClientAuthenticationPacket',
+              '<-- (1) OkPacket',
+              '--> (1) ComQueryPacket',
+              '<-- (1) ResultSetHeaderPacket',
+              '<-- (1) FieldPacket',
+              '<-- (1) EofPacket',
+              '<-- (1) RowDataPacket',
+              '<-- (1) EofPacket',
+              '<-- HandshakeInitializationPacket',
+              '--> ClientAuthenticationPacket',
+              '<-- (2) OkPacket',
+              '--> (2) ComQueryPacket',
+              '<-- (2) ResultSetHeaderPacket',
+              '<-- (2) FieldPacket',
+              '<-- (2) EofPacket',
+              '<-- (2) RowDataPacket',
+              '<-- (2) EofPacket',
+              '--> (1) ComQuitPacket',
+              '--> (2) ComQuitPacket'
+            ]);
+
+            server.destroy();
+          });
+        });
+      });
+    });
+  });
+});
+
+server.on('connection', function (conn) {
+  conn.handshake({ threadId: ++tid });
+});