Include packets that failed parsing under debug

Author: dougwilson

Changes.md

@@ -16,6 +16,7 @@ you spot any mistakes.
 * Fix `packet.default` to actually be a string
 * Fix `PARSER_*` errors to be catchable
 * Fix `PROTOCOL_PACKETS_OUT_OF_ORDER` error to be catchable #844
+* Include packets that failed parsing under `debug`
 * Return `Query` object from `pool.query` like `conn.query` #830
 * Use `EventEmitter.listenerCount` when possible for faster counting
 

lib/protocol/Protocol.js

@@ -237,10 +237,10 @@ Protocol.prototype._parsePacket = function() {
     return;
   }
 
-  packet.parse(this._parser);
-
   if (this._config.debug) {
-    this._debugPacket(true, packet);
+    this._parsePacketDebug(packet);
+  } else {
+    packet.parse(this._parser);
   }
 
   if (Packet === Packets.HandshakeInitializationPacket) {
@@ -251,6 +251,14 @@ Protocol.prototype._parsePacket = function() {
   sequence[Packet.name](packet);
 };
 
+Protocol.prototype._parsePacketDebug = function _parsePacketDebug(packet) {
+  try {
+    packet.parse(this._parser);
+  } finally {
+    this._debugPacket(true, packet);
+  }
+};
+
 Protocol.prototype._emitPacket = function(packet) {
   var packetWriter = new PacketWriter();
   packet.write(packetWriter);

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

@@ -0,0 +1,56 @@
+var assert       = require('assert');
+var common       = require('../../common');
+var connection   = common.createConnection({debug: true, port: common.fakeServerPort});
+var Packets      = require(common.lib + '/protocol/packets');
+var PacketWriter = require(common.lib + '/protocol/PacketWriter');
+
+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);
+    }
+  };
+
+  connection.query('SELECT value FROM stuff', function (err) {
+    assert.ok(err, 'got error');
+    assert.equal(messages.length, 6);
+    assert.deepEqual(messages, [
+      '<-- HandshakeInitializationPacket',
+      '--> ClientAuthenticationPacket',
+      '<-- OkPacket',
+      '--> ComQueryPacket',
+      '<-- ResultSetHeaderPacket',
+      '<-- FieldPacket'
+    ]);
+
+    connection.destroy();
+    server.destroy();
+  });
+});
+
+server.on('connection', function(conn) {
+  conn.handshake();
+  conn.on('query', function(packet) {
+    switch (packet.sql) {
+      case 'SELECT value FROM stuff':
+        this._sendPacket(new Packets.ResultSetHeaderPacket({
+          fieldCount: 1
+        }));
+
+        var writer = new PacketWriter();
+        writer.writeLengthCodedString('def');
+        this._socket.write(writer.toBuffer(this._parser));
+        this._parser.resetPacketNumber();
+        break;
+      default:
+        this._handlePacketQuery(packet);
+        break;
+    }
+  });
+});

test/unit/connection/test-debug.js

@@ -0,0 +1,32 @@
+var assert     = require('assert');
+var common     = require('../../common');
+var connection = common.createConnection({debug: true, port: common.fakeServerPort});
+
+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);
+    }
+  };
+
+  connection.ping(function (err) {
+    assert.ifError(err);
+    assert.equal(messages.length, 5);
+    assert.deepEqual(messages, [
+      '<-- HandshakeInitializationPacket',
+      '--> ClientAuthenticationPacket',
+      '<-- OkPacket',
+      '--> ComPingPacket',
+      '<-- OkPacket'
+    ]);
+
+    connection.destroy();
+    server.destroy();
+  });
+});