mysql2 3.21.2-canary.884bec56 → 3.22.0

package/lib/base/connection.js

@@ -928,6 +928,10 @@ class BaseConnection extends EventEmitter {
     return this.addCommand(new Commands.Ping(cb));
   }
 
+  reset(cb) {
+    return this.addCommand(new Commands.ResetConnection(cb));
+  }
+
   _registerSlave(opts, cb) {
     return this.addCommand(new Commands.RegisterSlave(opts, cb));
   }

package/lib/base/pool.js

@@ -127,7 +127,37 @@ class BasePool extends EventEmitter {
         cb = this._connectionQueue.shift();
         process.nextTick(this.getConnection.bind(this, cb));
       }
-    } else if (this._connectionQueue.length) {
+      return;
+    }
+
+    // Reset connection state if configured
+    if (this.config.resetOnRelease && connection.reset) {
+      connection.reset((err) => {
+        if (err) {
+          // If reset fails, remove connection from pool
+          connection._pool = null;
+          spliceConnection(this._allConnections, connection);
+          connection.destroy();
+
+          // Try to create a new connection for waiting callbacks
+          if (this._connectionQueue.length) {
+            cb = this._connectionQueue.shift();
+            process.nextTick(this.getConnection.bind(this, cb));
+          }
+          return;
+        }
+
+        // Reset successful, continue with normal release flow
+        this._handleSuccessfulRelease(connection);
+      });
+    } else {
+      this._handleSuccessfulRelease(connection);
+    }
+  }
+
+  _handleSuccessfulRelease(connection) {
+    let cb;
+    if (this._connectionQueue.length) {
       cb = this._connectionQueue.shift();
       process.nextTick(() => {
         connection._released = false;

package/lib/commands/index.js

@@ -10,6 +10,7 @@ const Ping = require('./ping.js');
 const RegisterSlave = require('./register_slave.js');
 const BinlogDump = require('./binlog_dump.js');
 const ChangeUser = require('./change_user.js');
+const ResetConnection = require('./reset_connection.js');
 const Quit = require('./quit.js');
 
 module.exports = {
@@ -23,5 +24,6 @@ module.exports = {
   RegisterSlave,
   BinlogDump,
   ChangeUser,
+  ResetConnection,
   Quit,
 };

package/lib/commands/reset_connection.js

@@ -0,0 +1,29 @@
+'use strict';
+
+const Command = require('./command');
+const Packets = require('../packets/index.js');
+
+class ResetConnection extends Command {
+  constructor(callback) {
+    super();
+    this.onResult = callback;
+  }
+
+  start(packet, connection) {
+    const req = new Packets.ResetConnection();
+    connection.writePacket(req.toPacket());
+    return ResetConnection.prototype.resetConnectionResponse;
+  }
+
+  resetConnectionResponse(packet, connection) {
+    if (connection._statements) {
+      connection._statements.clear();
+    }
+    if (this.onResult) {
+      process.nextTick(this.onResult.bind(this, null));
+    }
+    return null;
+  }
+}
+
+module.exports = ResetConnection;

package/lib/constants/commands.js

@@ -32,5 +32,6 @@ module.exports = {
   STMT_FETCH: 0x1c,
   DAEMON: 0x1d, // deprecated
   BINLOG_DUMP_GTID: 0x1e,
+  RESET_CONNECTION: 0x1f, // introduced in 5.7.3
   UNKNOWN: 0xff, // bad!
 };

package/lib/packets/index.js

@@ -27,6 +27,7 @@ const PrepareStatement = require('./prepare_statement');
 const PreparedStatementHeader = require('./prepared_statement_header');
 const Query = require('./query');
 const RegisterSlave = require('./register_slave');
+const ResetConnection = require('./reset_connection');
 const ResultSetHeader = require('./resultset_header');
 const SSLRequest = require('./ssl_request');
 const TextRow = require('./text_row');
@@ -48,6 +49,7 @@ const ctorMap = {
   PreparedStatementHeader,
   Query,
   RegisterSlave,
+  ResetConnection,
   ResultSetHeader,
   SSLRequest,
   TextRow,

package/lib/packets/reset_connection.js

@@ -0,0 +1,17 @@
+'use strict';
+
+const Packet = require('../packets/packet');
+const CommandCodes = require('../constants/commands');
+
+class ResetConnection {
+  constructor() {}
+
+  toPacket() {
+    const packet = new Packet(0, Buffer.alloc(5), 0, 5);
+    packet.offset = 4;
+    packet.writeInt8(CommandCodes.RESET_CONNECTION);
+    return packet;
+  }
+}
+
+module.exports = ResetConnection;

package/lib/pool_config.js

@@ -24,6 +24,10 @@ class PoolConfig {
     this.queueLimit = isNaN(options.queueLimit)
       ? 0
       : Number(options.queueLimit);
+    this.resetOnRelease =
+      options.resetOnRelease === undefined
+        ? false
+        : Boolean(options.resetOnRelease);
   }
 }
 

package/lib/promise/connection.js

@@ -26,14 +26,13 @@ class PromiseConnection extends EventEmitter {
 
   query(query, params) {
     const c = this.connection;
-    const localErr = new Error();
     if (typeof params === 'function') {
       throw new Error(
         'Callback function is not available with promise clients.'
       );
     }
     return new this.Promise((resolve, reject) => {
-      const done = makeDoneCb(resolve, reject, localErr);
+      const done = makeDoneCb(resolve, reject);
       if (params !== undefined) {
         c.query(query, params, done);
       } else {
@@ -44,14 +43,13 @@ class PromiseConnection extends EventEmitter {
 
   execute(query, params) {
     const c = this.connection;
-    const localErr = new Error();
     if (typeof params === 'function') {
       throw new Error(
         'Callback function is not available with promise clients.'
       );
     }
     return new this.Promise((resolve, reject) => {
-      const done = makeDoneCb(resolve, reject, localErr);
+      const done = makeDoneCb(resolve, reject);
       if (params !== undefined) {
         c.execute(query, params, done);
       } else {
@@ -74,37 +72,34 @@ class PromiseConnection extends EventEmitter {
 
   beginTransaction() {
     const c = this.connection;
-    const localErr = new Error();
     return new this.Promise((resolve, reject) => {
-      const done = makeDoneCb(resolve, reject, localErr);
+      const done = makeDoneCb(resolve, reject);
       c.beginTransaction(done);
     });
   }
 
   commit() {
     const c = this.connection;
-    const localErr = new Error();
     return new this.Promise((resolve, reject) => {
-      const done = makeDoneCb(resolve, reject, localErr);
+      const done = makeDoneCb(resolve, reject);
       c.commit(done);
     });
   }
 
   rollback() {
     const c = this.connection;
-    const localErr = new Error();
     return new this.Promise((resolve, reject) => {
-      const done = makeDoneCb(resolve, reject, localErr);
+      const done = makeDoneCb(resolve, reject);
       c.rollback(done);
     });
   }
 
   ping() {
     const c = this.connection;
-    const localErr = new Error();
     return new this.Promise((resolve, reject) => {
       c.ping((err) => {
         if (err) {
+          const localErr = new Error();
           localErr.message = err.message;
           localErr.code = err.code;
           localErr.errno = err.errno;
@@ -118,12 +113,31 @@ class PromiseConnection extends EventEmitter {
     });
   }
 
+  reset() {
+    const c = this.connection;
+    return new this.Promise((resolve, reject) => {
+      c.reset((err) => {
+        if (err) {
+          const localErr = new Error();
+          localErr.message = err.message;
+          localErr.code = err.code;
+          localErr.errno = err.errno;
+          localErr.sqlState = err.sqlState;
+          localErr.sqlMessage = err.sqlMessage;
+          reject(localErr);
+        } else {
+          resolve();
+        }
+      });
+    });
+  }
+
   connect() {
     const c = this.connection;
-    const localErr = new Error();
     return new this.Promise((resolve, reject) => {
       c.connect((err, param) => {
         if (err) {
+          const localErr = new Error();
           localErr.message = err.message;
           localErr.code = err.code;
           localErr.errno = err.errno;
@@ -140,10 +154,10 @@ class PromiseConnection extends EventEmitter {
   prepare(options) {
     const c = this.connection;
     const promiseImpl = this.Promise;
-    const localErr = new Error();
     return new this.Promise((resolve, reject) => {
       c.prepare(options, (err, statement) => {
         if (err) {
+          const localErr = new Error();
           localErr.message = err.message;
           localErr.code = err.code;
           localErr.errno = err.errno;
@@ -163,10 +177,10 @@ class PromiseConnection extends EventEmitter {
 
   changeUser(options) {
     const c = this.connection;
-    const localErr = new Error();
     return new this.Promise((resolve, reject) => {
       c.changeUser(options, (err) => {
         if (err) {
+          const localErr = new Error();
           localErr.message = err.message;
           localErr.code = err.code;
           localErr.errno = err.errno;

package/lib/promise/make_done_cb.js

@@ -1,8 +1,9 @@
 'use strict';
 
-function makeDoneCb(resolve, reject, localErr) {
+function makeDoneCb(resolve, reject) {
   return function (err, rows, fields) {
     if (err) {
+      const localErr = new Error();
       localErr.message = err.message;
       localErr.code = err.code;
       localErr.errno = err.errno;

package/lib/promise/pool.js

@@ -33,14 +33,13 @@ class PromisePool extends EventEmitter {
 
   query(sql, args) {
     const corePool = this.pool;
-    const localErr = new Error();
     if (typeof args === 'function') {
       throw new Error(
         'Callback function is not available with promise clients.'
       );
     }
     return new this.Promise((resolve, reject) => {
-      const done = makeDoneCb(resolve, reject, localErr);
+      const done = makeDoneCb(resolve, reject);
       if (args !== undefined) {
         corePool.query(sql, args, done);
       } else {
@@ -51,14 +50,13 @@ class PromisePool extends EventEmitter {
 
   execute(sql, args) {
     const corePool = this.pool;
-    const localErr = new Error();
     if (typeof args === 'function') {
       throw new Error(
         'Callback function is not available with promise clients.'
       );
     }
     return new this.Promise((resolve, reject) => {
-      const done = makeDoneCb(resolve, reject, localErr);
+      const done = makeDoneCb(resolve, reject);
       if (args) {
         corePool.execute(sql, args, done);
       } else {
@@ -69,10 +67,10 @@ class PromisePool extends EventEmitter {
 
   end() {
     const corePool = this.pool;
-    const localErr = new Error();
     return new this.Promise((resolve, reject) => {
       corePool.end((err) => {
         if (err) {
+          const localErr = new Error();
           localErr.message = err.message;
           localErr.code = err.code;
           localErr.errno = err.errno;

package/lib/promise/pool_cluster.js

@@ -24,28 +24,26 @@ class PromisePoolNamespace {
 
   query(sql, values) {
     const corePoolNamespace = this.poolNamespace;
-    const localErr = new Error();
     if (typeof values === 'function') {
       throw new Error(
         'Callback function is not available with promise clients.'
       );
     }
     return new this.Promise((resolve, reject) => {
-      const done = makeDoneCb(resolve, reject, localErr);
+      const done = makeDoneCb(resolve, reject);
       corePoolNamespace.query(sql, values, done);
     });
   }
 
   execute(sql, values) {
     const corePoolNamespace = this.poolNamespace;
-    const localErr = new Error();
     if (typeof values === 'function') {
       throw new Error(
         'Callback function is not available with promise clients.'
       );
     }
     return new this.Promise((resolve, reject) => {
-      const done = makeDoneCb(resolve, reject, localErr);
+      const done = makeDoneCb(resolve, reject);
       corePoolNamespace.execute(sql, values, done);
     });
   }

package/lib/promise/prepared_statement_info.js

@@ -10,9 +10,8 @@ class PromisePreparedStatementInfo {
 
   execute(parameters) {
     const s = this.statement;
-    const localErr = new Error();
     return new this.Promise((resolve, reject) => {
-      const done = makeDoneCb(resolve, reject, localErr);
+      const done = makeDoneCb(resolve, reject);
       if (parameters) {
         s.execute(parameters, done);
       } else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mysql2",
-  "version": "3.21.2-canary.884bec56",
+  "version": "3.22.0",
   "description": "fast mysql driver. Implements core protocol, prepared statements, ssl and compression in native JS",
   "main": "index.js",
   "typings": "typings/mysql/index",
@@ -68,7 +68,7 @@
   "devDependencies": {
     "@eslint/eslintrc": "^3.3.3",
     "@eslint/js": "^9.39.2",
-    "@eslint/markdown": "^7.5.1",
+    "@eslint/markdown": "^8.0.1",
     "@ianvs/prettier-plugin-sort-imports": "^4.7.1",
     "@pokujs/multi-suite": "^1.0.0",
     "@rollup/plugin-commonjs": "^29.0.2",

package/promise.d.ts

@@ -51,6 +51,8 @@ export declare class Connection extends QueryableAndExecutableBase {
 
   ping(): Promise<void>;
 
+  reset(): Promise<void>;
+
   beginTransaction(): Promise<void>;
 
   commit(): Promise<void>;

package/promise.js

@@ -16,7 +16,6 @@ const PromisePoolNamespace = require('./lib/promise/pool_cluster');
 
 function createConnectionPromise(opts) {
   const coreConnection = createConnection(opts);
-  const createConnectionErr = new Error();
   const thePromise = opts.Promise || Promise;
   if (!thePromise) {
     throw new Error(
@@ -30,6 +29,7 @@ function createConnectionPromise(opts) {
       resolve(new PromiseConnection(coreConnection, thePromise));
     });
     coreConnection.once('error', (err) => {
+      const createConnectionErr = new Error();
       createConnectionErr.message = err.message;
       createConnectionErr.code = err.code;
       createConnectionErr.errno = err.errno;
@@ -83,28 +83,26 @@ class PromisePoolCluster extends EventEmitter {
 
   query(sql, args) {
     const corePoolCluster = this.poolCluster;
-    const localErr = new Error();
     if (typeof args === 'function') {
       throw new Error(
         'Callback function is not available with promise clients.'
       );
     }
     return new this.Promise((resolve, reject) => {
-      const done = makeDoneCb(resolve, reject, localErr);
+      const done = makeDoneCb(resolve, reject);
       corePoolCluster.query(sql, args, done);
     });
   }
 
   execute(sql, args) {
     const corePoolCluster = this.poolCluster;
-    const localErr = new Error();
     if (typeof args === 'function') {
       throw new Error(
         'Callback function is not available with promise clients.'
       );
     }
     return new this.Promise((resolve, reject) => {
-      const done = makeDoneCb(resolve, reject, localErr);
+      const done = makeDoneCb(resolve, reject);
       corePoolCluster.execute(sql, args, done);
     });
   }
@@ -118,10 +116,10 @@ class PromisePoolCluster extends EventEmitter {
 
   end() {
     const corePoolCluster = this.poolCluster;
-    const localErr = new Error();
     return new this.Promise((resolve, reject) => {
       corePoolCluster.end((err) => {
         if (err) {
+          const localErr = new Error();
           localErr.message = err.message;
           localErr.code = err.code;
           localErr.errno = err.errno;

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

@@ -438,6 +438,8 @@ declare class Connection extends QueryableBase(ExecutableBase(EventEmitter)) {
 
   ping(callback?: (err: QueryError | null) => any): void;
 
+  reset(callback?: (err: QueryError | null) => any): void;
+
   writeOk(args?: OkPacketParams): void;
 
   writeError(args?: ErrorPacketParams): void;

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

@@ -37,6 +37,13 @@ export interface PoolOptions extends ConnectionOptions {
    * is no limit to the number of queued connection requests. (Default: 0)
    */
   queueLimit?: number;
+
+  /**
+   * Whether to reset the connection state (user variables, temporary tables, transactions, etc.) when
+   * releasing the connection back to the pool. This ensures each connection starts clean for the next user.
+   * Requires MySQL 5.7.3+. (Default: false)
+   */
+  resetOnRelease?: boolean;
 }
 
 declare class Pool extends QueryableBase(ExecutableBase(EventEmitter)) {