mysql2 3.23.5-canary.c86fe5a → 3.24.0

package/lib/packets/encode_parameter.js

@@ -2,6 +2,7 @@
 
 const Types = require('../constants/types');
 const Packet = require('../packets/packet');
+const StringParser = require('../parsers/string.js');
 const {
   TypedParameter,
   encodeTypedParameter,
@@ -33,9 +34,7 @@ function toParameter(value, encoding, timezone, jsonAsString, hint) {
   }
   let type = Types.VAR_STRING;
   let length;
-  let writer = function (value) {
-    return Packet.prototype.writeLengthCodedString.call(this, value, encoding);
-  };
+  let writer = Packet.prototype.writeLengthCodedBuffer;
   if (value !== null) {
     switch (typeof value) {
       case 'undefined':
@@ -86,9 +85,12 @@ function toParameter(value, encoding, timezone, jsonAsString, hint) {
   } else {
     value = '';
     type = Types.NULL;
+    length = 0;
+    writer = writeNothing;
   }
-  if (!length) {
-    length = Packet.lengthCodedStringLength(value, encoding);
+  if (length === undefined) {
+    value = StringParser.encode(value, encoding);
+    length = Packet.lengthCodedNumberLength(value.length) + value.length;
   }
   return {
     value,
@@ -100,4 +102,6 @@ function toParameter(value, encoding, timezone, jsonAsString, hint) {
   };
 }
 
+function writeNothing() {}
+
 module.exports = { toParameter, isJSON };

package/lib/packets/execute.js

@@ -5,6 +5,7 @@ const CommandCodes = require('../constants/commands');
 const ClientConstants = require('../constants/client');
 const Types = require('../constants/types');
 const Packet = require('../packets/packet');
+const StringParser = require('../parsers/string.js');
 const CharsetToEncoding = require('../constants/charset_encodings.js');
 const { toParameter } = require('./encode_parameter.js');
 
@@ -97,7 +98,7 @@ class Execute {
     return { stmtId, flags, iterationCount, values };
   }
 
-  _serializeToBuffer(buffer) {
+  toPacket() {
     const useQueryAttributes =
       this.clientFlags & ClientConstants.CLIENT_QUERY_ATTRIBUTES;
 
@@ -107,7 +108,53 @@ class Execute {
     const numAttrs = attrNames.length;
     const totalParams = numParams + numAttrs;
 
-    const packet = new Packet(0, buffer, 0, buffer.length);
+    // packet header, command, statement id, cursor flags, iteration count
+    let length = 14;
+    if (useQueryAttributes) {
+      length += Packet.lengthCodedNumberLength(totalParams);
+    }
+
+    let allParams = null;
+    let attrNameBuffers = null;
+    if (totalParams > 0) {
+      allParams = new Array(totalParams);
+      for (let i = 0; i < numParams; i++) {
+        allParams[i] = toParameter(
+          this.parameters[i],
+          this.encoding,
+          this.timezone,
+          this.jsonAsString,
+          this.parameterDefinitions[i]
+        );
+      }
+      for (let i = 0; i < numAttrs; i++) {
+        allParams[numParams + i] = toParameter(
+          this.attributes[attrNames[i]],
+          this.encoding,
+          this.timezone
+        );
+      }
+
+      // null bitmap, new-params-bound flag, type and unsigned byte per parameter
+      length += ((totalParams + 7) >> 3) + 1 + totalParams * 2;
+      if (useQueryAttributes) {
+        // one empty length-coded name per bind parameter
+        length += numParams;
+        attrNameBuffers = new Array(numAttrs);
+        for (let i = 0; i < numAttrs; i++) {
+          const name = StringParser.encode(attrNames[i], this.encoding);
+          attrNameBuffers[i] = name;
+          length += Packet.lengthCodedNumberLength(name.length) + name.length;
+        }
+      }
+      for (let i = 0; i < totalParams; i++) {
+        if (!allParams[i].isNull) {
+          length += allParams[i].length;
+        }
+      }
+    }
+
+    const packet = new Packet(0, Buffer.allocUnsafe(length), 0, length);
     packet.offset = 4;
     packet.writeInt8(CommandCodes.STMT_EXECUTE);
     packet.writeInt32(this.id);
@@ -124,29 +171,11 @@ class Execute {
     }
 
     if (totalParams > 0) {
-      const bindParams =
-        numParams > 0
-          ? this.parameters.map((v, i) =>
-              toParameter(
-                v,
-                this.encoding,
-                this.timezone,
-                this.jsonAsString,
-                this.parameterDefinitions[i]
-              )
-            )
-          : [];
-      const attrParams = attrNames.map((name) =>
-        toParameter(this.attributes[name], this.encoding, this.timezone)
-      );
-      const allParams = bindParams.concat(attrParams);
-
-      // null bitmap
       let bitmap = 0;
       let bitValue = 1;
-      allParams.forEach((parameter) => {
-        if (parameter.isNull) {
-          bitmap += bitValue;
+      for (let i = 0; i < totalParams; i++) {
+        if (allParams[i].isNull) {
+          bitmap |= bitValue;
         }
         bitValue *= 2;
         if (bitValue === 256) {
@@ -154,38 +183,41 @@ class Execute {
           bitmap = 0;
           bitValue = 1;
         }
-      });
+      }
       if (bitValue !== 1) {
         packet.writeInt8(bitmap);
       }
 
       packet.writeInt8(1); // new-params-bound-flag
 
-      // types (and names for attributes)
-      for (let i = 0; i < allParams.length; i++) {
-        packet.writeInt8(allParams[i].type);
-        packet.writeInt8(allParams[i].unsigned ? 0x80 : 0);
+      for (let i = 0; i < totalParams; i++) {
+        const parameter = allParams[i];
+        packet.writeInt8(parameter.type);
+        packet.writeInt8(parameter.unsigned ? 0x80 : 0);
         if (useQueryAttributes) {
-          const name = i < numParams ? '' : attrNames[i - numParams];
-          packet.writeLengthCodedString(name, this.encoding);
+          if (i < numParams) {
+            packet.writeInt8(0); // bind parameters have an empty name
+          } else {
+            packet.writeLengthCodedBuffer(attrNameBuffers[i - numParams]);
+          }
         }
       }
 
-      // values
-      allParams.forEach((parameter) => {
+      for (let i = 0; i < totalParams; i++) {
+        const parameter = allParams[i];
         if (!parameter.isNull) {
           parameter.writer.call(packet, parameter.value);
         }
-      });
+      }
     }
 
+    if (packet.offset !== length) {
+      throw new Error(
+        `Internal error: COM_STMT_EXECUTE serialized ${packet.offset - 4} bytes, expected ${length - 4}`
+      );
+    }
     return packet;
   }
-
-  toPacket() {
-    const p = this._serializeToBuffer(Packet.MockBuffer());
-    return this._serializeToBuffer(Buffer.allocUnsafe(p.offset));
-  }
 }
 
 module.exports = Execute;

package/lib/packets/packet.js

@@ -965,6 +965,14 @@ class Packet {
     this.offset += bytes;
   }
 
+  // must match writeTime's choice of encoding byte for byte
+  static timeLength({ days, hours, minutes, seconds, microseconds }) {
+    if (!days && !hours && !minutes && !seconds && !microseconds) {
+      return 1;
+    }
+    return microseconds ? 13 : 9;
+  }
+
   writeTime({ negative, days, hours, minutes, seconds, microseconds }) {
     if (!days && !hours && !minutes && !seconds && !microseconds) {
       this.writeInt8(0);

package/lib/packets/query.js

@@ -5,7 +5,6 @@ const CommandCode = require('../constants/commands.js');
 const StringParser = require('../parsers/string.js');
 const CharsetToEncoding = require('../constants/charset_encodings.js');
 const ClientConstants = require('../constants/client.js');
-const Types = require('../constants/types.js');
 const { toParameter } = require('./encode_parameter.js');
 
 class Query {
@@ -17,67 +16,6 @@ class Query {
     this.clientFlags = clientFlags || 0;
   }
 
-  serializeToBuffer(buffer) {
-    const useQueryAttributes =
-      this.clientFlags & ClientConstants.CLIENT_QUERY_ATTRIBUTES;
-    const sqlBuf = StringParser.encode(this.query, this.encoding);
-    const packet = new Packet(0, buffer, 0, buffer.length);
-    packet.offset = 4;
-    packet.writeInt8(CommandCode.QUERY);
-
-    if (useQueryAttributes) {
-      const attrs = this.attributes;
-      const names = attrs ? Object.keys(attrs) : [];
-      const paramCount = names.length;
-
-      packet.writeLengthCodedNumber(paramCount);
-      packet.writeLengthCodedNumber(1); // parameter_set_count, always 1
-
-      if (paramCount > 0) {
-        const parameters = names.map((name) =>
-          toParameter(attrs[name], this.encoding, 'local')
-        );
-
-        // null bitmap
-        let bitmap = 0;
-        let bitValue = 1;
-        parameters.forEach((parameter) => {
-          if (parameter.type === Types.NULL) {
-            bitmap += bitValue;
-          }
-          bitValue *= 2;
-          if (bitValue === 256) {
-            packet.writeInt8(bitmap);
-            bitmap = 0;
-            bitValue = 1;
-          }
-        });
-        if (bitValue !== 1) {
-          packet.writeInt8(bitmap);
-        }
-
-        packet.writeInt8(1); // new_params_bind_flag
-
-        // types and names
-        for (let i = 0; i < paramCount; i++) {
-          packet.writeInt8(parameters[i].type);
-          packet.writeInt8(0); // unsigned flag
-          packet.writeLengthCodedString(names[i], this.encoding);
-        }
-
-        // values
-        parameters.forEach((parameter) => {
-          if (parameter.type !== Types.NULL) {
-            parameter.writer.call(packet, parameter.value);
-          }
-        });
-      }
-    }
-
-    packet.writeBuffer(sqlBuf);
-    return packet;
-  }
-
   toPacket() {
     const useQueryAttributes =
       this.clientFlags & ClientConstants.CLIENT_QUERY_ATTRIBUTES;
@@ -119,9 +57,81 @@ class Query {
       return packet;
     }
 
-    // dry run to calculate required buffer length
-    const p = this.serializeToBuffer(Packet.MockBuffer());
-    return this.serializeToBuffer(Buffer.allocUnsafe(p.offset));
+    const names = Object.keys(this.attributes);
+    const parameters = new Array(attributeCount);
+    const nameBuffers = new Array(attributeCount);
+
+    // packet header, command, parameter count, parameter_set_count (always
+    // the single-byte form), null bitmap, new_params_bind_flag, type and
+    // unsigned byte per parameter
+    let length =
+      5 +
+      Packet.lengthCodedNumberLength(attributeCount) +
+      1 +
+      ((attributeCount + 7) >> 3) +
+      1 +
+      attributeCount * 2;
+    for (let i = 0; i < attributeCount; i++) {
+      parameters[i] = toParameter(
+        this.attributes[names[i]],
+        this.encoding,
+        'local'
+      );
+      const name = StringParser.encode(names[i], this.encoding);
+      nameBuffers[i] = name;
+      length += Packet.lengthCodedNumberLength(name.length) + name.length;
+      if (!parameters[i].isNull) {
+        length += parameters[i].length;
+      }
+    }
+    const sqlBuffer = StringParser.encode(this.query, this.encoding);
+    length += sqlBuffer.length;
+
+    const packet = new Packet(0, Buffer.allocUnsafe(length), 0, length);
+    packet.offset = 4;
+    packet.writeInt8(CommandCode.QUERY);
+    packet.writeLengthCodedNumber(attributeCount);
+    packet.writeLengthCodedNumber(1); // parameter_set_count, always 1
+
+    let bitmap = 0;
+    let bitValue = 1;
+    for (let i = 0; i < attributeCount; i++) {
+      if (parameters[i].isNull) {
+        bitmap |= bitValue;
+      }
+      bitValue *= 2;
+      if (bitValue === 256) {
+        packet.writeInt8(bitmap);
+        bitmap = 0;
+        bitValue = 1;
+      }
+    }
+    if (bitValue !== 1) {
+      packet.writeInt8(bitmap);
+    }
+
+    packet.writeInt8(1); // new_params_bind_flag
+
+    for (let i = 0; i < attributeCount; i++) {
+      packet.writeInt8(parameters[i].type);
+      packet.writeInt8(parameters[i].unsigned ? 0x80 : 0);
+      packet.writeLengthCodedBuffer(nameBuffers[i]);
+    }
+
+    for (let i = 0; i < attributeCount; i++) {
+      if (!parameters[i].isNull) {
+        parameters[i].writer.call(packet, parameters[i].value);
+      }
+    }
+
+    packet.writeBuffer(sqlBuffer);
+
+    if (packet.offset !== length) {
+      throw new Error(
+        `Internal error: COM_QUERY serialized ${packet.offset - 4} bytes, expected ${length - 4}`
+      );
+    }
+    return packet;
   }
 }
 

package/lib/packets/typed_parameter.js

@@ -2,6 +2,7 @@
 
 const Types = require('../constants/types.js');
 const Packet = require('./packet.js');
+const StringParser = require('../parsers/string.js');
 
 const INTEGER_BYTES = {
   [Types.TINY]: 1,
@@ -223,31 +224,30 @@ function toTimeParts(value) {
 }
 
 function timeEncoder() {
-  return (value) => ({
-    value: toTimeParts(value),
-    length: 13,
-    writer(v) {
-      this.writeTime(v);
-    },
-  });
+  return (value) => {
+    const parts = toTimeParts(value);
+    return {
+      value: parts,
+      length: Packet.timeLength(parts),
+      writer(v) {
+        this.writeTime(v);
+      },
+    };
+  };
 }
 
 function lengthCodedEncoder(encoding) {
   return (value) => {
-    if (Buffer.isBuffer(value)) {
-      return {
-        value,
-        length: Packet.lengthCodedNumberLength(value.length) + value.length,
-        writer: Packet.prototype.writeLengthCodedBuffer,
-      };
-    }
-    const str = typeof value === 'string' ? value : String(value);
+    const buffer = Buffer.isBuffer(value)
+      ? value
+      : StringParser.encode(
+          typeof value === 'string' ? value : String(value),
+          encoding
+        );
     return {
-      value: str,
-      length: Packet.lengthCodedStringLength(str, encoding),
-      writer(v) {
-        Packet.prototype.writeLengthCodedString.call(this, v, encoding);
-      },
+      value: buffer,
+      length: Packet.lengthCodedNumberLength(buffer.length) + buffer.length,
+      writer: Packet.prototype.writeLengthCodedBuffer,
     };
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mysql2",
-  "version": "3.23.5-canary.c86fe5a",
+  "version": "3.24.0",
   "description": "fast mysql driver. Implements core protocol, prepared statements, ssl and compression in native JS",
   "main": "index.js",
   "typings": "typings/mysql/index",