WIP: pass encoding to writers and readers

Author: Andrey Sidorov

lib/commands/client_handshake.js

@@ -3,6 +3,7 @@ var util = require('util');
 var Command = require('./command.js');
 var Packets = require('../packets/index.js');
 var ClientConstants = require('../constants/client.js');
+var CharsetToEncoding = require('../constants/charset_encodings.js');
 
 function ClientHandshake (clientFlags)
 {
@@ -85,6 +86,7 @@ ClientHandshake.prototype.handshakeInit = function (helloPacket, connection) {
       flagNames(this.handshake.capabilityFlags).join(', '));
   }
   connection.serverCapabilityFlags = this.handshake.capabilityFlags;
+  connection.serverEncoding = CharsetToEncoding[this.handshake.characterSet];
   connection.connectionId = this.handshake.connectionId;
   var serverSSLSupport = this.handshake.capabilityFlags & ClientConstants.SSL;
 

lib/commands/command.js

@@ -25,7 +25,7 @@ Command.prototype.execute = function (packet, connection) {
   }
 
   if (packet && packet.isError()) {
-    var err = packet.asError();
+    var err = packet.asError(connection.serverEncoding);
     if (this.onResult) {
       this.onResult(err);
     } else {

lib/commands/server_handshake.js

@@ -39,6 +39,10 @@ ServerHandshake.prototype.start = function (packet, connection) {
 ServerHandshake.prototype.readClientReply = function (packet, connection) {
   // check auth here
   var clientHelloReply = new Packets.HandshakeResponse.fromPacket(packet);
+
+  // TODO check we don't have something similar already
+  connection.clientHelloReply = clientHelloReply;
+
   if (this.args.authCallback) {
     try {
       this.args.authCallback({
@@ -73,6 +77,7 @@ ServerHandshake.prototype.readClientReply = function (packet, connection) {
 ServerHandshake.prototype.dispatchCommands = function (packet, connection) {
   // command from client to server
   var knownCommand = true;
+  var encoding = connection.clientHelloReply.encoding;
   var commandCode = packet.readInt8();
   switch (commandCode) {
   case CommandCode.QUIT:
@@ -85,7 +90,7 @@ ServerHandshake.prototype.dispatchCommands = function (packet, connection) {
 
   case CommandCode.INIT_DB:
     if (connection.listeners('init_db').length) {
-      var schemaName = packet.readString();
+      var schemaName = packet.readString(encoding);
       connection.emit('init_db', schemaName);
     } else {
       connection.writeOk();
@@ -94,7 +99,7 @@ ServerHandshake.prototype.dispatchCommands = function (packet, connection) {
 
   case CommandCode.QUERY:
     if (connection.listeners('query').length) {
-      var query = packet.readString();
+      var query = packet.readString(encoding);
       connection.emit('query', query);
     } else {
       connection.writeError({
@@ -107,7 +112,7 @@ ServerHandshake.prototype.dispatchCommands = function (packet, connection) {
   case CommandCode.FIELD_LIST:
     if (connection.listeners('field_list').length) {
       var table = packet.readNullTerminatedString();
-      var fields = packet.readString();
+      var fields = packet.readString(encoding);
       connection.emit('field_list', table, fields);
     } else {
       connection.writeError({

lib/connection.js

@@ -11,6 +11,7 @@ var Packet = require('./packets/packet.js');
 var Packets = require('./packets/index.js');
 var Commands = require('./commands/index.js');
 var ConnectionConfig = require('./connection_config.js');
+var CharsetToEncoding = require('./constants/charset_encodings.js');
 
 var _connectionId = 0;
 var noop = function () {};
@@ -691,14 +692,16 @@ Connection.prototype.writeOk = function (args) {
   if (!args) {
     args = {affectedRows: 0};
   }
-  this.writePacket(Packets.OK.toPacket(args));
+  this.writePacket(Packets.OK.toPacket(args, this.serverConfig.encoding));
 };
 
 Connection.prototype.writeError = function (args) {
-  this.writePacket(Packets.Error.toPacket(args));
+  this.writePacket(Packets.Error.toPacket(args, this.serverConfig.encoding));
 };
 
 Connection.prototype.serverHandshake = function serverHandshake (args) {
+  this.serverConfig = args;
+  this.serverConfig.encoding = CharsetToEncoding[this.serverConfig.characterSet];
   return this.addCommand(new Commands.ServerHandshake(args));
 };
 

lib/packets/column_definition.js

@@ -1,6 +1,7 @@
 var Buffer = require('safe-buffer').Buffer;
 var Packet = require('../packets/packet');
 var StringParser = require('../parsers/string');
+var CharsetToEncoding = require('../constants/charset_encodings.js');
 
 // creating JS string is relatively expensive (compared to
 // reading few bytes from buffer) because all string properties
@@ -101,13 +102,13 @@ ColumnDefinition.toPacket = function (column, sequenceId)
 {
   var length = 17; // = 4 padding + 1 + 12 for the rest
   fields.forEach(function (field) {
-    length += Packet.lengthCodedStringLength(column[field], this.characterSet);
+    length += Packet.lengthCodedStringLength(column[field], CharsetToEncoding[column.characterSet]);
   });
 
   var buffer = Buffer.allocUnsafe(length);
 
   function writeField (name) {
-    packet.writeLengthCodedString(column[name], this.characterSet);
+    packet.writeLengthCodedString(column[name], CharsetToEncoding[column.characterSet]);
   }
   var packet = new Packet(sequenceId, buffer, 0, length);
   packet.offset = 4;

lib/packets/handshake_response.js

@@ -26,6 +26,7 @@ function HandshakeResponse (handshake)
   }
   this.authToken = authToken;
   this.charsetNumber = handshake.charsetNumber;
+  this.encoding = CharsetToEncoding[handshake.charsetNumber];
   this.connectAttributes = handshake.connectAttributes;
 }
 
@@ -83,7 +84,7 @@ HandshakeResponse.prototype.serializeResponse = function (buffer) {
   packet.writeInt8(this.charsetNumber);
   packet.skip(23);
 
-  var encoding = CharsetToEncoding[this.charsetNumber];
+  var encoding = this.encoding;
   packet.writeNullTerminatedString(this.user, encoding);
 
   var authTokenLength, k;
@@ -130,7 +131,6 @@ HandshakeResponse.prototype.toPacket = function ()
   }
   // dry run: calculate resulting packet length
   var p = this.serializeResponse(Packet.MockBuffer());
-
   return this.serializeResponse(Buffer.allocUnsafe(p.offset));
 };
 

lib/packets/index.js

@@ -23,7 +23,7 @@ module.exports.Packet = Packet;
 module.exports.OK = function OK () {
 };
 
-module.exports.OK.toPacket = function (args) {
+module.exports.OK.toPacket = function (args, encoding) {
   args = args || {};
   var affectedRows = args.affectedRows || 0;
   var insertId = args.insertId || 0;
@@ -42,7 +42,7 @@ module.exports.OK.toPacket = function (args) {
   packet.writeLengthCodedNumber(insertId);
   packet.writeInt16(serverStatus);
   packet.writeInt16(warningCount);
-  packet.writeString(message);
+  packet.writeString(message, encoding);
   packet._name = 'OK';
   return packet;
 };
@@ -70,14 +70,15 @@ module.exports.EOF.toPacket = function (warnings, statusFlags) {
 module.exports.Error = function Error () {
 };
 
-module.exports.Error.toPacket = function (args) {
+module.exports.Error.toPacket = function (args, encoding) {
   var length = 13 + Buffer.byteLength(args.message, 'utf8');
   var packet = new Packet(0, Buffer.allocUnsafe(length), 0, length);
   packet.offset = 4;
   packet.writeInt8(0xff);
   packet.writeInt16(args.code);
-  packet.writeString('#_____');
-  packet.writeString(args.message);
+  // TODO: sql state parameter
+  packet.writeString('#_____', encoding);
+  packet.writeString(args.message, encoding);
   packet._name = 'Error';
   return packet;
 };

lib/packets/packet.js

@@ -371,12 +371,12 @@ Packet.prototype.readNullTerminatedString = function (encoding) {
 };
 
 // TODO reuse?
-Packet.prototype.readString = function (len) {
+Packet.prototype.readString = function (len, encoding) {
   if (typeof len == 'undefined') {
     len = this.end - this.offset;
   }
   this.offset += len;
-  return this.buffer.utf8Slice(this.offset - len, this.offset);
+  return StringParser.decode(this.buffer.slice(this.offset - len, this.offset), encoding);
 };
 
 // The whole reason parse* function below exist
@@ -424,7 +424,7 @@ Packet.prototype.parseInt = function (len, supportBigNumbers) {
   var numDigits = end - this.offset;
   if (supportBigNumbers) {
     if (numDigits >= 15) {
-      str = this.readString(end - this.offset);
+      str = this.readString(end - this.offset, 'binary');
       result = parseInt(str, 10);
       if (result.toString() == str) {
         return sign * result;
@@ -632,7 +632,7 @@ Packet.prototype.parseLengthCodedInt = function (supportBigNumbers) {
 };
 
 Packet.prototype.parseLengthCodedIntString = function () {
-  return this.readString(this.readLengthCodedNumber());
+  return this.readString(this.readLengthCodedNumber(), 'binary');
 };
 
 Packet.prototype.parseLengthCodedFloat = function () {
@@ -653,7 +653,7 @@ Packet.prototype.isError = function () {
   return this.peekByte() == 0xff;
 };
 
-Packet.prototype.asError = function () {
+Packet.prototype.asError = function (encoding) {
   this.reset();
 
   var fieldCount = this.readInt8();
@@ -662,7 +662,7 @@ Packet.prototype.asError = function () {
   if (this.buffer[this.offset] == 0x23) {
     sqlState = this.readBuffer(6).toString();
   }
-  var message = this.readString();
+  var message = this.readString(undefined, encoding);
   var err = new Error(message);
   err.code = ErrorCodeToName[errorCode];
   err.errno = errorCode;
@@ -726,7 +726,7 @@ Packet.prototype.writeNull = function () {
 // TODO: refactor following three?
 Packet.prototype.writeNullTerminatedString = function (s, encoding) {
   var buf = StringParser.encode(s, encoding);
-  buf.copy(this.buffer, this.offset);
+  this.buffer.length && buf.copy(this.buffer, this.offset);
   this.offset += buf.length;
   this.writeInt8(0);
 };
@@ -747,16 +747,15 @@ Packet.prototype.writeString = function (s, encoding) {
   // this.offset += bytes;
 
   var buf = StringParser.encode(s, encoding);
-  buf.copy(this.buffer, this.offset);
+  this.buffer.length && buf.copy(this.buffer, this.offset);
   this.offset += buf.length;
 };
 
 Packet.prototype.writeLengthCodedString = function (s, encoding) {
-  console.log('writeLengthCodedString ', s, encoding);
   var buf = StringParser.encode(s, encoding);
   this.writeLengthCodedNumber(buf.length);
-  buf.copy(this.buffer, this.offset);
-  this.offset += buf.lengh;
+  this.buffer.length && buf.copy(this.buffer, this.offset);
+  this.offset += buf.length;
 };
 
 Packet.prototype.writeLengthCodedBuffer = function (b) {

lib/packets/text_row.js

@@ -1,5 +1,6 @@
 var Buffer = require('safe-buffer').Buffer;
 var Packet = require('../packets/packet');
+var CharsetToEncoding = require('../constants/charset_encodings.js');
 
 function TextRow (columns)
 {
@@ -24,7 +25,7 @@ TextRow.toPacket = function (column) {
       ++length;
       return;
     }
-    length += Packet.lengthCodedStringLength(val.toString(10));
+    length += Packet.lengthCodedStringLength(val.toString(10), CharsetToEncoding[column.characterSet]);
   });
 
   buffer = Buffer.allocUnsafe(length + 4);
@@ -39,7 +40,7 @@ TextRow.toPacket = function (column) {
       packet.writeInt8(0);
       return;
     }
-    packet.writeLengthCodedString(val.toString(10));
+    packet.writeLengthCodedString(val.toString(10), CharsetToEncoding[column.characterSet]);
   });
   return packet;
 };

test/integration/test-auth-switch.js

@@ -68,6 +68,8 @@ TestAuthSwitchHandshake.prototype.dispatchCommands = function (packet, connectio
 };
 
 var server = mysql.createServer(function (conn) {
+  conn.serverConfig = {};
+  conn.serverConfig.encoding = 'cesu8';
   conn.addCommand(new TestAuthSwitchHandshake({
     pluginName: 'auth_test_plugin',
     pluginData: Buffer.from('f\{tU-{K@BhfHt/-4^Z,')