mysql2 3.5.0 → 3.5.2

package/README.md

@@ -53,6 +53,14 @@ MySQL2 is free from native bindings and can be installed on Linux, Mac OS or Win
 npm install --save mysql2
 ```
 
+If you are using TypeScript, you will need to install `@types/node`.
+
+```bash
+npm install --save-dev @types/node
+```
+
+> For TypeScript documentation and examples, see [here](./documentation/en/TypeScript-Examples.md).
+
 ## First Query
 ```js
 // get the client

package/lib/connection.js

@@ -355,62 +355,43 @@ class Connection extends EventEmitter {
     });
     const rejectUnauthorized = this.config.ssl.rejectUnauthorized;
     const verifyIdentity = this.config.ssl.verifyIdentity;
-    const host = this.config.host;
+    const servername = this.config.host;
 
     let secureEstablished = false;
-    const secureSocket = new Tls.TLSSocket(this.stream, {
-      rejectUnauthorized: rejectUnauthorized,
-      requestCert: true,
-      secureContext: secureContext,
-      isServer: false
+    this.stream.removeAllListeners('data');
+    const secureSocket = Tls.connect({
+      rejectUnauthorized,
+      requestCert: rejectUnauthorized,
+      secureContext,
+      isServer: false,
+      socket: this.stream,
+      servername
+    }, () => {
+      secureEstablished = true;
+      if (rejectUnauthorized) {
+        if (typeof servername === 'string' && verifyIdentity) {
+          const cert = secureSocket.getPeerCertificate(true);
+          const serverIdentityCheckError = Tls.checkServerIdentity(servername, cert);
+          if (serverIdentityCheckError) {
+            onSecure(serverIdentityCheckError);
+            return;
+          }
+        }
+      }
+      onSecure();
     });
-    if (typeof host === 'string') {
-      secureSocket.setServername(host);
-    }
     // error handler for secure socket
-    secureSocket.on('_tlsError', err => {
+    secureSocket.on('error', err => {
       if (secureEstablished) {
         this._handleNetworkError(err);
       } else {
         onSecure(err);
       }
     });
-    secureSocket.on('secure', () => {
-      secureEstablished = true;
-      let callbackValue = null;
-      if (rejectUnauthorized) {
-        callbackValue = secureSocket.ssl.verifyError()
-        if (!callbackValue && typeof host === 'string' && verifyIdentity) {
-          const cert = secureSocket.ssl.getPeerCertificate(true);
-          callbackValue = Tls.checkServerIdentity(host, cert)
-        }
-      }
-      onSecure(callbackValue);
-    });
     secureSocket.on('data', data => {
       this.packetParser.execute(data);
     });
-    this.write = buffer => {
-      secureSocket.write(buffer);
-    };
-    // start TLS communications
-    secureSocket._start();
-  }
-
-  pipe() {
-    if (this.stream instanceof Net.Stream) {
-      this.stream.ondata = (data, start, end) => {
-        this.packetParser.execute(data, start, end);
-      };
-    } else {
-      this.stream.on('data', data => {
-        this.packetParser.execute(
-          data.parent,
-          data.offset,
-          data.offset + data.length
-        );
-      });
-    }
+    this.write = buffer => secureSocket.write(buffer);
   }
 
   protocolError(message, code) {
@@ -948,48 +929,4 @@ class Connection extends EventEmitter {
   }
 }
 
-if (Tls.TLSSocket) {
-  // not supported
-} else {
-  Connection.prototype.startTLS = function _startTLS(onSecure) {
-    if (this.config.debug) {
-      // eslint-disable-next-line no-console
-      console.log('Upgrading connection to TLS');
-    }
-    const crypto = require('crypto');
-    const config = this.config;
-    const stream = this.stream;
-    const rejectUnauthorized = this.config.ssl.rejectUnauthorized;
-    const credentials = crypto.createCredentials({
-      key: config.ssl.key,
-      cert: config.ssl.cert,
-      passphrase: config.ssl.passphrase,
-      ca: config.ssl.ca,
-      ciphers: config.ssl.ciphers
-    });
-    const securePair = Tls.createSecurePair(
-      credentials,
-      false,
-      true,
-      rejectUnauthorized
-    );
-
-    if (stream.ondata) {
-      stream.ondata = null;
-    }
-    stream.removeAllListeners('data');
-    stream.pipe(securePair.encrypted);
-    securePair.encrypted.pipe(stream);
-    securePair.cleartext.on('data', data => {
-      this.packetParser.execute(data);
-    });
-    this.write = function(buffer) {
-      securePair.cleartext.write(buffer);
-    };
-    securePair.on('secure', () => {
-      onSecure(rejectUnauthorized ? securePair.ssl.verifyError() : null);
-    });
-  };
-}
-
 module.exports = Connection;

package/lib/packets/resultset_header.js

@@ -94,6 +94,8 @@ class ResultSetHeader {
     const m = this.info.match(/\schanged:\s*(\d+)/i);
     if (m !== null) {
       this.changedRows = parseInt(m[1], 10);
+    } else {
+      this.changedRows = 0;
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mysql2",
-  "version": "3.5.0",
+  "version": "3.5.2",
   "description": "fast mysql driver. Implements core protocol, prepared statements, ssl and compression in native JS",
   "main": "index.js",
   "directories": {
@@ -81,7 +81,7 @@
     "husky": "^8.0.2",
     "lint-staged": "^13.0.3",
     "portfinder": "^1.0.28",
-    "prettier": "^2.4.1",
+    "prettier": "^3.0.0",
     "progress": "^2.0.3",
     "typescript": "^5.0.2",
     "urun": "0.0.8",

package/promise.d.ts

@@ -117,7 +117,7 @@ export interface PoolCluster extends EventEmitter {
 
   on(event: string, listener: (args: any[]) => void): this;
   on(event: 'remove', listener: (nodeId: number) => void): this;
-  on(event: 'connection', listener: (connection: PoolConnection) => void): this;
+  on(event: 'warn', listener: (err: Error) => void): this;
 }
 
 export function createConnection(connectionUri: string): Promise<Connection>;

package/promise.js

@@ -448,7 +448,7 @@ class PromisePoolCluster extends EventEmitter {
     super();
     this.poolCluster = poolCluster;
     this.Promise = thePromise || Promise;
-    inheritEvents(poolCluster, this, ['acquire', 'connection', 'enqueue', 'release']);
+    inheritEvents(poolCluster, this, ['warn', 'remove']);
   }
 
   getConnection() {

package/typings/mysql/lib/PoolCluster.d.ts

@@ -80,7 +80,7 @@ declare class PoolCluster extends EventEmitter {
 
   on(event: string, listener: (args: any[]) => void): this;
   on(event: 'remove', listener: (nodeId: number) => void): this;
-  on(event: 'connection', listener: (connection: PoolConnection) => void): this;
+  on(event: 'warn', listener: (err: Error) => void): this;
 }
 
 export { PoolCluster };

package/typings/mysql/lib/protocol/packets/OkPacket.d.ts

@@ -1,9 +1,17 @@
+/**
+ * @deprecated
+ * `OkPacket` is deprecated and might be removed in the future major release. Please use `ResultSetHeader` instead.
+ */
 declare interface OkPacket {
   constructor: {
     name: 'OkPacket';
   };
   fieldCount: number;
   affectedRows: number;
+  /**
+   * @deprecated
+   * `changedRows` is deprecated and might be removed in the future major release. Please use `affectedRows` property instead.
+   */
   changedRows: number;
   insertId: number;
   serverStatus: number;

package/typings/mysql/lib/protocol/packets/ProcedurePacket.d.ts

@@ -3,16 +3,11 @@ import { ResultSetHeader } from './ResultSetHeader.js';
 import { RowDataPacket } from './RowDataPacket.js';
 
 declare type ProcedureCallPacket<
-  T = RowDataPacket[] | RowDataPacket[][] | ResultSetHeader
+  T = [RowDataPacket[], ResultSetHeader] | ResultSetHeader,
 > = T extends RowDataPacket[]
-  ? [...T, ResultSetHeader]
-  : T extends RowDataPacket[][]
-  ? [...T, ResultSetHeader]
-  : T extends ResultSetHeader | OkPacket | OkPacket[]
+  ? [T, ResultSetHeader]
+  : T extends ResultSetHeader | OkPacket
   ? ResultSetHeader
-  :
-      | [...RowDataPacket[], ResultSetHeader]
-      | [...RowDataPacket[][], ResultSetHeader]
-      | ResultSetHeader;
+  : [RowDataPacket[], ResultSetHeader] | ResultSetHeader;
 
 export { ProcedureCallPacket };

package/typings/mysql/lib/protocol/packets/ResultSetHeader.d.ts

@@ -8,7 +8,11 @@ declare interface ResultSetHeader {
   insertId: number;
   serverStatus: number;
   warningStatus: number;
-  changedRows?: number;
+  /**
+   * @deprecated
+   * `changedRows` is deprecated and might be removed in the future major release. Please use `affectedRows` property instead.
+   */
+  changedRows: number;
 }
 
 export { ResultSetHeader };

package/typings/mysql/lib/protocol/sequences/ExecutableBase.d.ts

@@ -20,6 +20,7 @@ export declare function ExecutableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -34,6 +35,7 @@ export declare function ExecutableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -49,6 +51,7 @@ export declare function ExecutableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -63,6 +66,7 @@ export declare function ExecutableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]

package/typings/mysql/lib/protocol/sequences/QueryableBase.d.ts

@@ -20,6 +20,7 @@ export declare function QueryableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -34,6 +35,7 @@ export declare function QueryableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -49,6 +51,7 @@ export declare function QueryableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -63,6 +66,7 @@ export declare function QueryableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]

package/typings/mysql/lib/protocol/sequences/promise/ExecutableBase.d.ts

@@ -15,6 +15,7 @@ export declare function ExecutableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -26,6 +27,7 @@ export declare function ExecutableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -38,6 +40,7 @@ export declare function ExecutableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -49,6 +52,7 @@ export declare function ExecutableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]

package/typings/mysql/lib/protocol/sequences/promise/QueryableBase.d.ts

@@ -15,6 +15,7 @@ export declare function QueryableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -26,6 +27,7 @@ export declare function QueryableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -38,6 +40,7 @@ export declare function QueryableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -49,6 +52,7 @@ export declare function QueryableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]