@pi-r/mysql 0.11.3 → 0.12.1

package/client/index.js

@@ -1,16 +1,11 @@
 "use strict";
-exports.DB_SOURCE_TYPE = exports.DB_SOURCE_CLIENT = void 0;
-exports.setAuthentication = setAuthentication;
-exports.setCredential = setCredential;
-exports.executeQuery = executeQuery;
-exports.executeBatchQuery = executeBatchQuery;
-exports.checkTimeout = checkTimeout;
-const main = require("mysql2");
-const mysql = require("mysql2/promise");
-const Db = require("@e-mc/db");
-const types_1 = require("@e-mc/types");
-const util_1 = require("@e-mc/db/util");
-const DbPool = require("@pi-r/mysql/client/pool");
+
+const main = require('mysql2');
+const mysql = require('mysql2/promise');
+const Db = require('@e-mc/db');
+const { DB_TYPE, asFunction, errorMessage, isArray, isError, isErrorCode, isPlainObject, isString } = require('@e-mc/types');
+const { parseConnectionString, parseServerAuth } = require('@e-mc/db/util');
+const DbPool = require('@pi-r/mysql/client/pool');
 const POOL_STATE = {};
 function isResultSetHeader(value) {
     const result = Array.isArray(value) ? value[0] : value;
@@ -24,11 +19,11 @@ function isResultSetHeader(value) {
     return false;
 }
 function setAuthentication(credential) {
-    const auth = (0, util_1.parseServerAuth)(credential);
+    const auth = parseServerAuth(credential);
     credential.host ||= auth.hostname;
     credential.user ||= auth.username;
     credential.port ||= 3306;
-    if ((0, types_1.isPlainObject)(credential.ssl)) {
+    if (isPlainObject(credential.ssl)) {
         this.readTLSConfig(credential.ssl);
     }
 }
@@ -43,15 +38,16 @@ function setCredential(item) {
     }
     let host;
     if (!credential.uri) {
+        host = credential.host;
         const errors = [];
-        if (!(host = credential.host) && !credential.socketPath) {
+        if (!host && !credential.socketPath) {
             errors.push('host');
         }
         if (!credential.user) {
             errors.push('user');
         }
         if (errors.length > 0) {
-            throw (0, types_1.errorMessage)("mysql", "Invalid credentials", errors.join(', '));
+            throw errorMessage("mysql", "Invalid credentials", errors.join(', '));
         }
     }
     else {
@@ -64,7 +60,7 @@ function setCredential(item) {
     if (host?.endsWith('.rds.amazonaws.com')) {
         try {
             const ssl = credential.ssl ||= {};
-            if ((0, types_1.isPlainObject)(ssl) && !ssl.ca) {
+            if (isPlainObject(ssl) && !ssl.ca) {
                 const bundle = require('aws-ssl-profiles');
                 ssl.ca = bundle.ca;
             }
@@ -81,8 +77,8 @@ function setCredential(item) {
         return;
     }
     let username, password, pool;
-    if ((0, types_1.isString)(usePool)) {
-        username = credential.user || credential.uri && (0, util_1.parseConnectionString)(credential.uri)?.username;
+    if (isString(usePool)) {
+        username = credential.user || credential.uri && parseConnectionString(credential.uri)?.username;
         if (username) {
             [password, pool] = DbPool.validateKey(POOL_STATE, username, usePool);
             if (pool) {
@@ -133,7 +129,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
         return [];
     }
     let parallel, connectOnce, errorQuery, sessionKey, outCacheMiss;
-    if ((0, types_1.isPlainObject)(options)) {
+    if (isPlainObject(options)) {
         ({ parallel, connectOnce, errorQuery, sessionKey, outCacheMiss } = options);
     }
     else {
@@ -153,6 +149,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
         outResult ||= new Array(length);
     }
     const caching = this.hasCache("mysql", sessionKey);
+    const sortKeys = this.settingsOf("mysql", 'cache', 'sort_keys') === true;
     const tasks = new Array(length);
     const clients = [];
     const pools = [];
@@ -176,15 +173,12 @@ async function executeBatchQuery(batch, options = '', outResult) {
             }
             catch (err) {
                 let close;
-                if ((0, types_1.isErrorCode)(err, 'ER_ACCESS_DENIED_ERROR', 'ER_DBACCESS_DENIED_ERROR', 'ER_SPECIFIC_ACCESS_DENIED_ERROR', 'ER_ACCESS_DENIED_NO_PASSWORD_ERROR')) {
-                    close = 1;
-                }
-                else {
+                if (!isErrorCode(err, 'ER_ACCESS_DENIED_ERROR', 'ER_DBACCESS_DENIED_ERROR', 'ER_SPECIFIC_ACCESS_DENIED_ERROR', 'ER_ACCESS_DENIED_NO_PASSWORD_ERROR')) {
                     close = pool.closeable;
                 }
-                if (close) {
+                if (close !== false) {
                     await pool.detach(true);
-                    if (close === 1) {
+                    if (!close) {
                         throw err;
                     }
                 }
@@ -209,7 +203,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
     for (let i = 0, mysql2Client, mysql2Credential, statement; i < length; ++i) {
         const item = batch[i];
         const { source, params, ignoreCache } = item;
-        const streamRow = typeof item.streamRow === 'string' ? this.hasCoerce("mysql", 'options', mysql2Credential || item.credential) && (0, types_1.asFunction)(item.streamRow) : item.streamRow;
+        const streamRow = typeof item.streamRow === 'string' ? this.hasCoerce("mysql", 'options', mysql2Credential || item.credential) && asFunction(item.streamRow) : item.streamRow;
         let query = item.query, prepared = false;
         if (typeof item.preparedStatement === 'boolean') {
             if (item.preparedStatement) {
@@ -240,7 +234,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
         else if (credential = mysqlCredential || onceCredential) {
             error = null;
         }
-        if (error !== null && !(0, types_1.isPlainObject)(credential = item.credential) && (error = (0, types_1.errorMessage)(source, "Invalid credentials")) || !query && (error = (0, types_1.errorMessage)(source, "Missing database query"))) {
+        if (error !== null && !isPlainObject(credential = item.credential) && (error = errorMessage(source, "Invalid credentials")) || !query && (error = errorMessage(source, "Missing database query"))) {
             if (this.handleFail(error, item, { errorQuery })) {
                 if (!parallel) {
                     tasks.length = 0;
@@ -258,11 +252,12 @@ async function executeBatchQuery(batch, options = '', outResult) {
         }
         item.transactionState = 1;
         const cacheValue = ignoreCache === undefined ? sessionKey : Array.isArray(ignoreCache) ? { sessionKey, exclusiveOf: ignoreCache } : { sessionKey, renewCache: ignoreCache === 0 };
-        let queryString = '';
+        let queryString = '', cacheCredential;
         if (caching && ignoreCache !== true && !prepared && !streamRow) {
             queryString = Db.asString(query, true) + '_' + Db.asString(params, true);
+            cacheCredential = DbPool.sanitize(credential, sortKeys);
             if (ignoreCache !== 1) {
-                const result = this.getQueryResult(source, DbPool.sanitize(credential), queryString, cacheValue);
+                const result = this.getQueryResult(source, cacheCredential, queryString, cacheValue);
                 if (result) {
                     if (parallel) {
                         tasks[i] = Promise.resolve(result);
@@ -310,7 +305,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
                             if (err === false) {
                                 return;
                             }
-                            if (err instanceof Error) {
+                            if (isError(err)) {
                                 error = err;
                                 return;
                             }
@@ -324,7 +319,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
                         }
                         else {
                             this.add(item, 4);
-                            resolve(!error ? this.setQueryResult(source, DbPool.sanitize(credential), queryString, rows, cacheValue) : rows.length > 0 ? rows : null);
+                            resolve(!error ? this.setQueryResult(source, cacheCredential, queryString, rows, cacheValue) : rows.length > 0 ? rows : null);
                         }
                     });
                 }
@@ -336,13 +331,13 @@ async function executeBatchQuery(batch, options = '', outResult) {
                     commandType = this.commandType.SELECT;
                     const [rows] = await (prepared && connectOnce && !parallel ? client.execute(query, params) : client.query(query, params));
                     this.add(item, 4);
-                    if ((0, types_1.isArray)(rows)) {
+                    if (isArray(rows)) {
                         const [row1, row2] = rows;
                         if (rows.length === 2 && Array.isArray(row1) && !Array.isArray(row2) && isResultSetHeader(row2)) {
                             resolve(row1);
                         }
                         else {
-                            resolve(!isResultSetHeader(row1) ? this.setQueryResult(source, DbPool.sanitize(credential), queryString, rows, cacheValue) : null);
+                            resolve(!isResultSetHeader(row1) ? this.setQueryResult(source, cacheCredential, queryString, rows, cacheValue) : null);
                         }
                     }
                     else {
@@ -388,5 +383,13 @@ async function executeBatchQuery(batch, options = '', outResult) {
 async function checkTimeout(value, limit = 0) {
     return DbPool.checkTimeout(POOL_STATE, value, limit);
 }
-exports.DB_SOURCE_CLIENT = true;
-exports.DB_SOURCE_TYPE = types_1.DB_TYPE.SQL;
+const DB_SOURCE_CLIENT = true;
+const DB_SOURCE_TYPE = DB_TYPE.SQL;
+
+exports.DB_SOURCE_CLIENT = DB_SOURCE_CLIENT;
+exports.DB_SOURCE_TYPE = DB_SOURCE_TYPE;
+exports.checkTimeout = checkTimeout;
+exports.executeBatchQuery = executeBatchQuery;
+exports.executeQuery = executeQuery;
+exports.setAuthentication = setAuthentication;
+exports.setCredential = setCredential;

package/client/pool.js

@@ -1,10 +1,11 @@
 "use strict";
-const types_1 = require("@e-mc/types");
-const util_1 = require("@e-mc/db/util");
+
+const { isArray, isObject, isString } = require('@e-mc/types');
+const { checkEmpty } = require('@e-mc/db/util');
 const DbPool = require('@e-mc/db/pool');
 const POOL_ACTIVE = new WeakSet();
 class MySQLPool extends DbPool {
-    static CACHE_UNUSED = ['connectTimeout', 'queueLimit', 'waitForConnections', 'connectionLimit', 'maxIdle', 'idleTimeout', 'enableKeepAlive', 'keepAliveInitialDelay', 'Promise', 'gracefulEnd'];
+    static CACHE_UNUSED = ['connectTimeout', 'queueLimit', 'resetOnRelease', 'waitForConnections', 'connectionLimit', 'maxIdle', 'idleTimeout', 'enableKeepAlive', 'keepAliveInitialDelay', 'Promise', 'gracefulEnd'];
     static CACHE_IGNORE = ['authPlugins', 'authSwitchHandler', 'stream', 'infileStreamFactory'];
     static asString(credential) {
         if ((credential.host || credential.socketPath) && credential.user) {
@@ -12,7 +13,7 @@ class MySQLPool extends DbPool {
         }
         return super.asString(credential);
     }
-    static sanitize(credential) {
+    static sanitize(credential, sort) {
         if (!this.canCache(credential)) {
             return;
         }
@@ -20,19 +21,19 @@ class MySQLPool extends DbPool {
             return credential;
         }
         const ssl = credential.ssl;
-        let result = super.sanitize(credential);
-        if ((0, types_1.isObject)(ssl)) {
+        let result = super.sanitize(credential, sort);
+        if (isObject(ssl)) {
             if (result === credential) {
                 result = { ...credential };
             }
             const cert = ssl.cert;
-            if ((0, types_1.isString)(cert)) {
+            if (isString(cert)) {
                 result.ssl = cert;
             }
             else if (Buffer.isBuffer(cert)) {
                 result.ssl = cert.toString('utf8');
             }
-            else if ((0, types_1.isArray)(cert)) {
+            else if (isArray(cert)) {
                 result.ssl = cert.reduce((a, b) => a + (Buffer.isBuffer(b) ? b.toString('utf8') : b), '');
             }
             else {
@@ -52,10 +53,11 @@ class MySQLPool extends DbPool {
     }
     isEmpty() {
         const pool = this.client.pool;
-        return this.closed || (0, util_1.checkEmpty)(pool._allConnections) && (0, util_1.checkEmpty)(pool._connectionQueue);
+        return this.closed || checkEmpty(pool._allConnections) && checkEmpty(pool._connectionQueue);
     }
     get closed() {
         return !!this.client.pool._closed;
     }
 }
+
 module.exports = MySQLPool;

package/package.json

@@ -1,12 +1,9 @@
 {
   "name": "@pi-r/mysql",
-  "version": "0.11.3",
+  "version": "0.12.1",
   "description": "MySQL client driver for E-mc.",
   "main": "client/index.js",
   "types": "client/index.d.ts",
-  "publishConfig": {
-    "access": "public"
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/anpham6/pi-r.git",
@@ -20,8 +17,8 @@
   "license": "MIT",
   "homepage": "https://github.com/anpham6/pi-r#readme",
   "dependencies": {
-    "@e-mc/db": "^0.13.10",
-    "@e-mc/types": "^0.13.10",
-    "mysql2": "^3.22.2"
+    "@e-mc/db": "^0.14.1",
+    "@e-mc/types": "^0.14.1",
+    "mysql2": "^3.22.3"
   }
 }

package/types/index.d.ts

@@ -3,9 +3,9 @@ import type { DbDataSource } from '@e-mc/types/lib/squared';
 import type { IdentifierAction } from '@e-mc/types/lib/core';
 import type { ExecuteAction, ServerAuth } from '@e-mc/types/lib/db';
 
-import type { PoolOptions, QueryOptions } from 'mysql2/promise';
+import type { ExecuteValues, PoolOptions, QueryOptions, QueryValues } from 'mysql2/promise';
 
-export interface MySQLDataSource<T = unknown> extends DbDataSource<string | QueryOptions, unknown, unknown, MySQLCredential, string>, ExecuteAction<T> {
+export interface MySQLDataSource<T = ExecuteValues | QueryValues> extends DbDataSource<string | QueryOptions, unknown, unknown, MySQLCredential, string>, ExecuteAction<T> {
     source: "mysql";
     preparedStatement?: boolean;
 }