mysql2 1.5.1 → 1.5.2

package/Changelog.md

@@ -1,17 +1,27 @@
+1.5.2 (06/02/2018)
+ - perf: Store Compiled Packet Parsers in a global
+   cache                                               #722, #723
+ - Improve performance of removing connections from
+   pools                                               #720
+ - use source parameters types with execute, fix
+   crash when parameter is undefined                   #718, #705
+ - PromisePool to always use the specified promises
+   library                                             #697
+
 1.5.1 (19/11/2017)
- - Fix empty buffer incorrectly returned instead of 
+ - Fix empty buffer incorrectly returned instead of
    NULL value                                          #668, #671
- - promise wrapper: pass sqlMessage from original 
+ - promise wrapper: pass sqlMessage from original
    error                                               #682, #678
-   
+
 1.5.0 (13/11/2017)
  - Added sqlMessage to Error callback object           #665
  - Normalized sqlState to a string of 5 chars          #667
    as Mysql specifies it  
- - Remove destroyed promise pool connections from 
+ - Remove destroyed promise pool connections from
    pool                                                #674, #672
  - Expose escape & format methods on connection pool   #669, #663
- - Support fractional seconds variable precision for 
+ - Support fractional seconds variable precision for
    the temporal types                                  #660, #659
  - fix null values breaking typeCast behaviour         #652
 

package/index.js

@@ -2,6 +2,7 @@ var SqlString = require('sqlstring');
 
 var Connection = require('./lib/connection.js');
 var ConnectionConfig = require('./lib/connection_config.js');
+var parserCache = require("./lib/parsers/parser_cache");
 
 module.exports.createConnection = function(opts) {
   return new Connection({ config: new ConnectionConfig(opts) });
@@ -61,3 +62,11 @@ exports.__defineGetter__('Charsets', function() {
 exports.__defineGetter__('CharsetToEncoding', function() {
   return require('./lib/constants/charset_encodings.js');
 });
+
+exports.setMaxParserCache = function (max) {
+  parserCache.setMaxCache(max);
+};
+
+exports.clearParserCache = function () {
+  parserCache.clearCache();
+};

package/lib/commands/execute.js

@@ -6,7 +6,7 @@ var Packets = require('../packets/index.js');
 
 var objectAssign = require('object-assign');
 
-var compileParser = require('../compile_binary_parser.js');
+var getBinaryParser = require('../parsers/binary_parser.js');
 
 function Execute(options, callback) {
   Command.call(this);
@@ -33,13 +33,7 @@ function Execute(options, callback) {
 util.inherits(Execute, Command);
 
 Execute.prototype.buildParserFromFields = function(fields, connection) {
-  var parserKey = connection.keyFromFields(fields, this.options);
-  var parser = connection.binaryProtocolParsers[parserKey];
-  if (!parser) {
-    parser = compileParser(fields, this.options, connection.config);
-    connection.binaryProtocolParsers[parserKey] = parser;
-  }
-  return parser;
+  return getBinaryParser(fields, this.options, connection.config);
 };
 
 Execute.prototype.start = function(packet, connection) {
@@ -50,7 +44,17 @@ Execute.prototype.start = function(packet, connection) {
     this.parameters,
     connection.config.charsetNumber
   );
-  connection.writePacket(executePacket.toPacket(1));
+  //For reasons why this try-catch is here, please see 
+  // https://github.com/sidorares/node-mysql2/pull/689 
+  //For additional discussion, see 
+  // 1. https://github.com/sidorares/node-mysql2/issues/493
+  // 2. https://github.com/sidorares/node-mysql2/issues/187
+  // 3. https://github.com/sidorares/node-mysql2/issues/480
+  try {
+    connection.writePacket(executePacket.toPacket(1));
+  } catch (error) {
+    this.onResult(error)
+  }
   return Execute.prototype.resultsetHeader;
 };
 

package/lib/commands/query.js

@@ -7,7 +7,7 @@ var objectAssign = require('object-assign');
 
 var Command = require('./command.js');
 var Packets = require('../packets/index.js');
-var compileParser = require('../compile_text_parser.js');
+var getTextParser = require('../parsers/text_parser.js');
 var ServerStatus = require('../constants/server_status.js');
 var CharsetToEncoding = require('../constants/charset_encodings.js');
 
@@ -195,15 +195,10 @@ Query.prototype.readField = function(packet, connection) {
   }
 
   // last field received
-  if (this._receivedFieldsCount == this._fieldCount) {
+  if (this._receivedFieldsCount === this._fieldCount) {
     var fields = this._fields[this._resultIndex];
     this.emit('fields', fields);
-    var parserKey = connection.keyFromFields(fields, this.options);
-    this._rowParser = connection.textProtocolParsers[parserKey];
-    if (!this._rowParser) {
-      this._rowParser = compileParser(fields, this.options, connection.config);
-      connection.textProtocolParsers[parserKey] = this._rowParser;
-    }
+    this._rowParser = getTextParser(fields, this.options, connection.config);
     return Query.prototype.fieldsEOF;
   }
   return Query.prototype.readField;

package/lib/connection.js

@@ -58,19 +58,6 @@ function Connection(opts) {
     }
   });
 
-  // TODO: make it lru cache
-  // https://github.com/mercadolibre/node-simple-lru-cache
-  // or https://github.com/rsms/js-lru
-  // or https://github.com/monsur/jscache
-  // or https://github.com/isaacs/node-lru-cache
-  //
-  // key is field.name + ':' + field.columnType + ':' field.flags + '/'
-  this.textProtocolParsers = {};
-
-  // TODO: not sure if cache should be separate (same key as with textProtocolParsers)
-  // or part of prepared statements cache (key is sql query)
-  this.binaryProtocolParsers = {};
-
   this.serverCapabilityFlags = 0;
   this.authorized = false;
 
@@ -639,25 +626,6 @@ Connection.prototype.resume = function resume() {
   this.stream.resume();
 };
 
-Connection.prototype.keyFromFields = function keyFromFields(fields, options) {
-  var res =
-    typeof options.nestTables +
-    '/' +
-    options.nestTables +
-    '/' +
-    options.rowsAsArray +
-    options.supportBigNumbers +
-    '/' +
-    options.bigNumberStrings +
-    '/' +
-    typeof options.typeCast;
-  for (var i = 0; i < fields.length; ++i) {
-    res +=
-      '/' + fields[i].name + ':' + fields[i].columnType + ':' + fields[i].flags;
-  }
-  return res;
-};
-
 Connection.statementKey = function(options) {
   return (
     typeof options.nestTables +
@@ -715,6 +683,18 @@ Connection.prototype.execute = function execute(sql, values, cb) {
   }
   this._resolveNamedPlaceholders(options);
 
+  // check for values containing undefined
+  if (options.values) {
+    options.values.forEach(function(val) {
+      if (val === undefined) {
+        throw new TypeError('Bind parameters must not contain undefined. To pass SQL NULL specify JS null');
+      }
+      if (typeof val === 'function') {
+        throw new TypeError('Bind parameters must not contain function(s). To pass the body of a function as a string call .toString() first')
+      }
+    });
+  }
+
   var executeCommand = new Commands.Execute(options, cb);
   var prepareCommand = new Commands.Prepare(options, function(err, stmt) {
     if (err) {

package/lib/packets/execute.js

@@ -11,17 +11,70 @@ function Execute(id, parameters, charsetNumber) {
   this.encoding = CharsetToEncoding[charsetNumber];
 }
 
-var pad = '000000000000';
-function leftPad(num, value) {
-    var s = value.toString();
-    // if we don't need to pad
-    if (s.length >= num) {
-        return s;
+function isJSON(value) {
+  return Array.isArray(value) ||
+    value.constructor === Object ||
+    (typeof value.toJSON === 'function' && !Buffer.isBuffer(value));
+}
+
+/**
+ * Converts a value to an object describing type, String/Buffer representation and length
+ * @param {*} value
+ */
+function toParameter(value, encoding) {
+  var type = Types.VAR_STRING;
+  var length;
+  var writer = function (value) {
+    return Packet.prototype.writeLengthCodedString.call(this, value, encoding)
+  }
+  if (value !== null) {
+    switch (typeof value) {
+      case 'undefined':
+        throw new TypeError('Bind parameters must not contain undefined');
+
+      case 'number':
+        type = Types.DOUBLE;
+        length = 8;
+        writer = Packet.prototype.writeDouble;
+        break;
+
+      case 'boolean':
+        value = value | 0;
+        type = Types.TINY;
+        length = 1;
+        writer = Packet.prototype.writeInt8;
+        break;
+
+      case 'object':
+        if (Object.prototype.toString.call(value) == '[object Date]') {
+          type = Types.DATETIME;
+          length = 12;
+          writer = Packet.prototype.writeDate
+        } else if (isJSON(value)) {
+          value = JSON.stringify(value);
+          type = Types.JSON;
+        } else if (Buffer.isBuffer(value)) {
+          length = Packet.lengthCodedNumberLength(value.length) + value.length;
+          writer = Packet.prototype.writeLengthCodedBuffer
+        }
+        break;
+
+      default:
+        value = value.toString();
     }
-    return (pad + s).slice(-num);
+  } else {
+    value = ''
+    type = Types.NULL;
+  }
+  if (!length) {
+    length = Packet.lengthCodedStringLength(value, encoding);
+  }
+  return { value, type, length, writer };
 }
 
 Execute.prototype.toPacket = function() {
+  var self = this;
+
   // TODO: don't try to calculate packet length in advance, allocate some big buffer in advance (header + 256 bytes?)
   // and copy + reallocate if not enough
 
@@ -32,33 +85,17 @@ Execute.prototype.toPacket = function() {
   // 9 + 1 - flags
   // 10 + 4 - iteration-count (always 1)
   var length = 14;
+  var parameters;
   if (this.parameters && this.parameters.length > 0) {
     length += Math.floor((this.parameters.length + 7) / 8);
     length += 1; // new-params-bound-flag
     length += 2 * this.parameters.length; // type byte for each parameter if new-params-bound-flag is set
-    for (i = 0; i < this.parameters.length; i++) {
-      if (this.parameters[i] !== null) {
-        if (
-          Object.prototype.toString.call(this.parameters[i]) == '[object Date]'
-        ) {
-          var d = this.parameters[i];
-          // TODO: move to asMysqlDateTime()
-          this.parameters[i] =
-            [d.getFullYear(), d.getMonth() + 1, d.getDate()].join('-') +
-            ' ' +
-            [d.getHours(), d.getMinutes(), d.getSeconds()].join(':') +
-            '.' + leftPad(3, d.getMilliseconds())
-          ;
-        }
-        if (Buffer.isBuffer(this.parameters[i])) {
-          length += Packet.lengthCodedNumberLength(this.parameters[i].length);
-          length += this.parameters[i].length;
-        } else {
-          var str = this.parameters[i].toString();
-          length += Packet.lengthCodedStringLength(str, this.encoding);
-        }
-      }
-    }
+    parameters = this.parameters.map(function (value) {
+      return toParameter(value, self.encoding);
+    });
+    length += parameters.reduce(function (accumulator, parameter) {
+      return accumulator + parameter.length;
+    }, 0);
   }
 
   var buffer = Buffer.allocUnsafe(length);
@@ -68,11 +105,11 @@ Execute.prototype.toPacket = function() {
   packet.writeInt32(this.id);
   packet.writeInt8(CursorType.NO_CURSOR); // flags
   packet.writeInt32(1); // iteration-count, always 1
-  if (this.parameters && this.parameters.length > 0) {
+  if (parameters) {
     var bitmap = 0;
     var bitValue = 1;
-    for (i = 0; i < this.parameters.length; i++) {
-      if (this.parameters[i] === null) {
+    parameters.forEach(function (parameter) {
+      if (parameter.type === Types.NULL) {
         bitmap += bitValue;
       }
       bitValue *= 2;
@@ -81,7 +118,7 @@ Execute.prototype.toPacket = function() {
         bitmap = 0;
         bitValue = 1;
       }
-    }
+    });
     if (bitValue != 1) {
       packet.writeInt8(bitmap);
     }
@@ -91,27 +128,18 @@ Execute.prototype.toPacket = function() {
     // if not, previous execution types are used (TODO prooflink)
     packet.writeInt8(1); // new-params-bound-flag
 
-    // TODO: don't typecast always to sting, use parameters type
-    for (i = 0; i < this.parameters.length; i++) {
-      if (this.parameters[i] !== null) {
-        packet.writeInt16(Types.VAR_STRING);
-      } else {
-        packet.writeInt16(Types.NULL);
-      }
-    }
+    // Write parameter types
+    parameters.forEach(function (parameter) {
+      packet.writeInt8(parameter.type); // field type
+      packet.writeInt8(0); // parameter flag
+    });
 
-    for (i = 0; i < this.parameters.length; i++) {
-      if (this.parameters[i] !== null) {
-        if (Buffer.isBuffer(this.parameters[i])) {
-          packet.writeLengthCodedBuffer(this.parameters[i]);
-        } else {
-          packet.writeLengthCodedString(
-            this.parameters[i].toString(),
-            this.encoding
-          );
-        }
+    // Write parameter values
+    parameters.forEach(function (parameter) {
+    if (parameter.type !== Types.NULL) {
+        parameter.writer.call(packet, parameter.value)
       }
-    }
+    });
   }
   return packet;
 };

package/lib/packets/packet.js

@@ -760,6 +760,11 @@ Packet.prototype.writeInt8 = function(n) {
   this.offset++;
 };
 
+Packet.prototype.writeDouble = function(n) {
+  this.buffer.writeDoubleLE(n, this.offset);
+  this.offset += 8;
+}
+
 Packet.prototype.writeBuffer = function(b) {
   b.copy(this.buffer, this.offset);
   this.offset += b.length;
@@ -839,6 +844,18 @@ Packet.prototype.writeLengthCodedNumber = function(n) {
   return this.offset;
 };
 
+Packet.prototype.writeDate = function(d) {
+  this.buffer.writeUInt8(11, this.offset);
+  this.buffer.writeUInt16LE(d.getFullYear(), this.offset + 1);
+  this.buffer.writeUInt8(d.getMonth() + 1, this.offset + 3);
+  this.buffer.writeUInt8(d.getDate(), this.offset + 4);
+  this.buffer.writeUInt8(d.getHours(), this.offset + 5);
+  this.buffer.writeUInt8(d.getMinutes(), this.offset + 6);
+  this.buffer.writeUInt8(d.getSeconds(), this.offset + 7);
+  this.buffer.writeUInt32LE(d.getMilliseconds() * 1000, this.offset + 8);
+  this.offset += 12;
+}
+
 Packet.prototype.writeHeader = function(sequenceId) {
   var offset = this.offset;
   this.offset = 0;

package/lib/{compile_binary_parser.js → parsers/binary_parser.js}

@@ -1,10 +1,10 @@
-var FieldFlags = require('./constants/field_flags.js');
-var Charsets = require('./constants/charsets.js');
-var CharsetToEncoding = require('./constants/charset_encodings.js');
-var Types = require('./constants/types.js');
-var srcEscape = require('./helpers').srcEscape;
+var FieldFlags = require('../constants/field_flags.js');
+var Charsets = require('../constants/charsets.js');
+var CharsetToEncoding = require('../constants/charset_encodings.js');
+var Types = require('../constants/types.js');
+var srcEscape = require('../helpers').srcEscape;
 var genFunc = require('generate-function');
-
+var parserCache = require('./parser_cache.js');
 var typeNames = [];
 for (var t in Types) {
   typeNames[Types[t]] = t;
@@ -181,4 +181,8 @@ function readCodeFor(field, config, options, fieldNum) {
   }
 }
 
-module.exports = compile;
+function getBinaryParser(fields, options, config) {
+  return parserCache.getParser('binary', fields, options, config, compile);
+}
+
+module.exports = getBinaryParser;

package/lib/parsers/parser_cache.js

@@ -0,0 +1,53 @@
+var LRU = require('lru-cache');
+
+var parserCache = new LRU({
+  max: 15000
+});
+
+function keyFromFields(type, fields, options) {
+  var res =
+    type +
+    '/' +
+    typeof options.nestTables +
+    '/' +
+    options.nestTables +
+    '/' +
+    options.rowsAsArray +
+    options.supportBigNumbers +
+    '/' +
+    options.bigNumberStrings +
+    '/' +
+    typeof options.typeCast;
+  for (var i = 0; i < fields.length; ++i) {
+    res +=
+      '/' + fields[i].name + ':' + fields[i].columnType + ':' + fields[i].flags;
+  }
+  return res;
+}
+
+function getParser(type, fields, options, config, compiler) {
+  var key = keyFromFields(type, fields, options);
+  var parser = parserCache.get(key);
+
+  if (parser) {
+    return parser;
+  }
+
+  parser = compiler(fields, options, config);
+  parserCache.set(key, parser);
+  return parser;
+}
+
+function setMaxCache(max) {
+  parserCache.max = max;
+}
+
+function clearCache() {
+  parserCache.reset();
+}
+
+module.exports = {
+  getParser: getParser,
+  setMaxCache: setMaxCache,
+  clearCache: clearCache
+};

package/lib/{compile_text_parser.js → parsers/text_parser.js}

@@ -1,8 +1,9 @@
-var Types = require('./constants/types.js');
-var Charsets = require('./constants/charsets.js');
-var CharsetToEncoding = require('./constants/charset_encodings.js');
-var srcEscape = require('./helpers').srcEscape;
+var Types = require('../constants/types.js');
+var Charsets = require('../constants/charsets.js');
+var CharsetToEncoding = require('../constants/charset_encodings.js');
+var srcEscape = require('../helpers').srcEscape;
 var genFunc = require('generate-function');
+var parserCache = require('./parser_cache.js');
 
 var typeNames = [];
 for (var t in Types) {
@@ -189,4 +190,7 @@ function readCodeFor(type, charset, encodingExpr, config, options) {
   }
 }
 
-module.exports = compile;
+function getTextParser(fields, options, config) {
+  return parserCache.getParser('text', fields, options, config, compile);
+}
+module.exports = getTextParser;

package/lib/pool.js

@@ -217,17 +217,10 @@ Pool.prototype.escapeId = function escapeId(value) {
 
 function spliceConnection(queue, connection) {
   var len = queue.length;
-  if (len) {
-    if (queue.get(len - 1) === connection) {
-      queue.pop();
-    } else {
-      for (; --len; ) {
-        if (queue.get(0) === connection) {
-          queue.shift();
-          break;
-        }
-        queue.push(queue.shift());
-      }
+  for (var i = 0; i < len; i++) {
+    if (queue.get(i) === connection) {
+      queue.removeOne(i);
+      break;
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mysql2",
-  "version": "1.5.1",
+  "version": "1.5.2",
   "description": "fast mysql driver. Implements core protocol, prepared statements, ssl and compression in native JS",
   "main": "index.js",
   "directories": {
@@ -49,7 +49,7 @@
     "denque": "^1.1.1",
     "generate-function": "^2.0.0",
     "iconv-lite": "^0.4.18",
-    "long": "^3.2.0",
+    "long": "^4.0.0",
     "lru-cache": "^4.1.1",
     "named-placeholders": "1.1.1",
     "object-assign": "^4.1.1",
@@ -68,7 +68,7 @@
     "eslint-plugin-prettier": "^2.1.1",
     "husky": "^0.14.0",
     "is-async-supported": "^1.2.0",
-    "lint-staged": "^5.0.0",
+    "lint-staged": "^6.0.0",
     "portfinder": "^1.0.10",
     "prettier": "^1.3.1",
     "prettier-markdown": "^0.1.6",

package/promise.js

@@ -356,7 +356,7 @@ PromisePool.prototype.execute = function(sql, values) {
   var corePool = this.pool;
   const localErr = new Error();
 
-  return new Promise(function(resolve, reject) {
+  return new this.Promise(function(resolve, reject) {
     corePool.execute(sql, values, makeDoneCb(resolve, reject, localErr));
   });
 };
@@ -364,7 +364,7 @@ PromisePool.prototype.execute = function(sql, values) {
 PromisePool.prototype.end = function() {
   var corePool = this.pool;
   const localErr = new Error();
-  return new Promise(function(resolve, reject) {
+  return new this.Promise(function(resolve, reject) {
     corePool.end(function(err) {
       if (err) {
         localErr.message = err.message;