@pi-r/mariadb 0.2.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2023 An Pham
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,5 @@
+### @pi-r/mariadb
+
+### LICENSE
+
+MIT

package/client/index.js

@@ -0,0 +1,328 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DB_SOURCE_TYPE = exports.DB_SOURCE_CLIENT = exports.checkTimeout = exports.executeBatchQuery = exports.executeQuery = exports.setCredential = exports.setAuthentication = void 0;
+const util_1 = require("@e-mc/db/util");
+const types_1 = require("@e-mc/types");
+const Db = require("@e-mc/db");
+const DbPool = require('@e-mc/db/pool');
+class MariaDBPool extends DbPool {
+    getConnection() {
+        return this.client.getConnection();
+    }
+    close() {
+        return this.client.end();
+    }
+    isEmpty() {
+        const client = this.client;
+        return this.closed || client.activeConnections() === 0 && client.taskQueueSize() === 0;
+    }
+    get closed() {
+        return this.client.closed;
+    }
+}
+const POOL_STATE = {};
+function removePoolProperties(credential) {
+    if (!credential.uuidKey && ('ssl' in credential || 'connectionLimit' in credential || 'connectTimeout' in credential || 'idleTimeout' in credential || 'minimumIdle' in credential || 'resetAfterUse' in credential || 'noControlAfterUse' in credential)) {
+        return { ...credential, ssl: (0, types_1.isObject)(credential.ssl) ? true : undefined, connectionLimit: undefined, idleTimeout: undefined, connectTimeout: undefined, minimumIdle: undefined, resetAfterUse: undefined, noControlAfterUse: undefined };
+    }
+    return credential;
+}
+function removeUUIDKey(credential) {
+    if ('uuidKey' in credential) {
+        credential = { ...credential };
+        delete credential.uuidKey;
+        return credential;
+    }
+    return credential;
+}
+const getPoolKey = (credential) => (credential.host || '') + '_' + (credential.port || '3306') + (credential.user || '') + '_' + (credential.password || '') + '_' + (credential.database || '') + '_' + (credential.rowsAsArray ? '1' : '0');
+function setAuthentication(credential) {
+    const auth = (0, util_1.parseServerAuth)(credential);
+    credential.host || (credential.host = auth.hostname);
+    credential.user || (credential.user = auth.username);
+    if ((0, types_1.isPlainObject)(credential.ssl)) {
+        this.readTLSConfig(credential.ssl);
+    }
+}
+exports.setAuthentication = setAuthentication;
+function setCredential(item) {
+    let credential = this.getCredential(item);
+    if (credential) {
+        setAuthentication.call(this, credential);
+    }
+    else {
+        const uri = item.uri;
+        credential = {};
+        if (uri) {
+            const connection = (0, util_1.parseConnectionString)(uri);
+            if (connection) {
+                const { username, password, hostname, port, database } = connection;
+                credential.host = hostname;
+                if (port) {
+                    credential.port = +port;
+                }
+                credential.user = username;
+                credential.password = password;
+                credential.database = database;
+            }
+        }
+        item.credential = credential;
+    }
+    const errors = [];
+    if (!credential.host) {
+        errors.push('host');
+    }
+    if (!credential.user) {
+        errors.push('user');
+    }
+    if (errors.length) {
+        throw (0, types_1.errorMessage)("mariadb" /* STRINGS.MODULE_NAME */, 'Not defined - ' + errors.join(' | '));
+    }
+    const usePool = item.usePool;
+    if (usePool) {
+        let username, password, pool;
+        if (typeof usePool === 'string' && (username = credential.user)) {
+            [password, pool] = DbPool.validateKey(POOL_STATE, username, usePool);
+            if (pool) {
+                pool.add(item, password);
+                return;
+            }
+        }
+        const poolKey = getPoolKey(credential);
+        if (!(pool = POOL_STATE[poolKey]) || pool.closed) {
+            const { createPool } = require("mariadb" /* STRINGS.PACKAGE_NAME */);
+            const config = this.getPoolConfig("mariadb" /* STRINGS.MODULE_NAME */, password);
+            if (config) {
+                const { max, idle } = config;
+                if (max > 0) {
+                    credential.connectionLimit ?? (credential.connectionLimit = max);
+                }
+                if (idle >= 0) {
+                    credential.idleTimeout ?? (credential.idleTimeout = idle);
+                }
+            }
+            new MariaDBPool(createPool(removeUUIDKey(credential)), poolKey, username && password ? { username, password } : undefined).add(item).parent = POOL_STATE;
+        }
+        else {
+            pool.add(item);
+        }
+    }
+}
+exports.setCredential = setCredential;
+async function executeQuery(item, options) {
+    return (await executeBatchQuery.call(this, [item], options))[0] || [];
+}
+exports.executeQuery = executeQuery;
+async function executeBatchQuery(batch, options = '', outResult) {
+    const length = batch.length;
+    if (length === 0) {
+        return [];
+    }
+    const db = require("mariadb" /* STRINGS.PACKAGE_NAME */);
+    let parallel, connectOnce, errorQuery, sessionKey, outCacheMiss;
+    if ((0, types_1.isPlainObject)(options)) {
+        ({ parallel, connectOnce, errorQuery, sessionKey, outCacheMiss } = options);
+    }
+    else {
+        if (typeof options === 'string') {
+            sessionKey = options;
+        }
+        options = undefined;
+    }
+    if (length === 1) {
+        connectOnce = false;
+        parallel = false;
+    }
+    else if (parallel === undefined) {
+        parallel = !batch.some(item => item.parallel === false);
+    }
+    if (!parallel) {
+        outResult || (outResult = new Array(length));
+    }
+    const caching = this.hasCache("mariadb" /* STRINGS.MODULE_NAME */, sessionKey);
+    const tasks = new Array(length);
+    const clients = [];
+    const pools = [];
+    let mariaDBPool, mariaDBClient, mariaDBCredential, onceCredential = connectOnce ? batch[0].credential : undefined;
+    const getConnection = async (item, credential) => {
+        item.transactionState = 64 /* DB_TRANSACTION.AUTH */;
+        let client;
+        if (mariaDBPool) {
+            pools.push(client = await mariaDBPool.getConnection());
+            item.transactionState &= ~64 /* DB_TRANSACTION.AUTH */;
+            return client;
+        }
+        const pool = item.usePool && DbPool.findKey(POOL_STATE, item.usePool, getPoolKey(credential), ...connectOnce ? [item, batch[0]] : [item]);
+        if (pool) {
+            try {
+                pools.push(client = await pool.getConnection());
+                if (connectOnce) {
+                    mariaDBPool = pool;
+                }
+                pool.connected = true;
+            }
+            catch (err) {
+                let close;
+                switch (err instanceof Error && err.code) {
+                    case 'ER_ACCESS_DENIED_ERROR':
+                    case 'ER_DBACCESS_DENIED_ERROR':
+                    case 'ER_SPECIFIC_ACCESS_DENIED_ERROR':
+                    case 'ER_ACCESS_DENIED_NO_PASSWORD_ERROR':
+                        close = 1;
+                        break;
+                    default:
+                        close = pool.closeable;
+                        break;
+                }
+                if (close) {
+                    await pool.detach(true);
+                    if (close === 1) {
+                        throw err;
+                    }
+                }
+                pool.connected = false;
+            }
+        }
+        if (!client) {
+            clients.push(client = await db.createConnection(removeUUIDKey(mariaDBCredential || credential)));
+        }
+        if (connectOnce) {
+            if (!parallel) {
+                mariaDBClient = client;
+            }
+            mariaDBCredential = credential;
+        }
+        item.transactionState &= ~64 /* DB_TRANSACTION.AUTH */;
+        return client;
+    };
+    for (let i = 0; i < length; ++i) {
+        const item = batch[i];
+        const { source, query, params, ignoreCache } = item;
+        let credential = mariaDBCredential || onceCredential, error;
+        const streamRow = typeof item.streamRow === 'string' ? this.hasCoerce("mariadb" /* STRINGS.MODULE_NAME */, 'options', null, item.credential) && (0, types_1.asFunction)(item.streamRow) : item.streamRow;
+        if (!(0, types_1.isPlainObject)(credential = item.credential) && (error = (0, types_1.errorMessage)(source, "Invalid credentials" /* ERR_DB.CREDENTIALS */)) || !query && (error = (0, types_1.errorMessage)(source, "Missing database query" /* ERR_DB.QUERY */))) {
+            if (this.handleFail(error, item, { errorQuery })) {
+                if (!parallel) {
+                    tasks.length = 0;
+                    break;
+                }
+                tasks[i] = Promise.reject(error);
+            }
+            else if (parallel) {
+                tasks[i] = Promise.resolve([]);
+            }
+            else {
+                outResult[i] = [];
+            }
+            continue;
+        }
+        item.transactionState = 1 /* DB_TRANSACTION.ACTIVE */;
+        const renewCache = ignoreCache === 0;
+        const cacheValue = renewCache ? { sessionKey, renewCache } : sessionKey;
+        let queryString = '';
+        if ((caching && ignoreCache !== true || ignoreCache === false || ignoreCache === 1 || renewCache) && !streamRow) {
+            queryString = Db.asString(query, true) + '_' + Db.asString(params, true);
+            const result = this.getQueryResult(source, removePoolProperties(credential), queryString, cacheValue);
+            if (ignoreCache !== 1) {
+                if (result) {
+                    if (parallel) {
+                        tasks[i] = Promise.resolve(result);
+                    }
+                    else {
+                        outResult[i] = result;
+                    }
+                    this.add(item, 4 /* DB_TRANSACTION.COMMIT */ | 128 /* DB_TRANSACTION.CACHE */);
+                    continue;
+                }
+                if (!ignoreCache && outCacheMiss) {
+                    outCacheMiss.push(source);
+                }
+            }
+        }
+        if (onceCredential && parallel && !streamRow) {
+            try {
+                mariaDBClient = await getConnection(item, onceCredential);
+            }
+            catch {
+                connectOnce = false;
+                parallel = false;
+            }
+            onceCredential = undefined;
+        }
+        tasks[i] = new Promise(async (resolve, reject) => {
+            let commandType;
+            try {
+                const client = mariaDBClient || await getConnection(item, credential);
+                if (mariaDBClient && parallel) {
+                    mariaDBClient = undefined;
+                }
+                commandType = this.commandType.SELECT;
+                if (streamRow) {
+                    const rows = [];
+                    const processRow = typeof streamRow === 'function' && streamRow;
+                    try {
+                        for await (const row of client.queryStream(query, params)) {
+                            if (processRow) {
+                                const err = processRow(row);
+                                if (err === false) {
+                                    continue;
+                                }
+                                if (err instanceof Error) {
+                                    error = err;
+                                    continue;
+                                }
+                            }
+                            rows.push(row);
+                        }
+                    }
+                    catch (err) {
+                        error = err;
+                    }
+                    if (error && this.handleFail(error, item, { errorQuery, commandType })) {
+                        reject(error);
+                    }
+                    else {
+                        this.add(item, 4 /* DB_TRANSACTION.COMMIT */);
+                        resolve(!error ? this.setQueryResult(source, removePoolProperties(credential), queryString, rows, cacheValue) : rows);
+                    }
+                }
+                else {
+                    const rows = await client.query(query, params);
+                    this.add(item, 4 /* DB_TRANSACTION.COMMIT */);
+                    resolve(Array.isArray(rows) ? this.setQueryResult(source, removePoolProperties(credential), queryString, rows, cacheValue) : null);
+                }
+            }
+            catch (err) {
+                if (this.handleFail(err, item, { errorQuery, commandType })) {
+                    reject(err);
+                }
+                else {
+                    resolve([]);
+                }
+            }
+        });
+        if (!parallel) {
+            try {
+                outResult[i] = await tasks[i];
+            }
+            catch {
+                tasks.length = 0;
+                break;
+            }
+        }
+    }
+    return this.processRows(batch, tasks, {
+        disconnect: () => {
+            clients.forEach(item => item.end());
+            pools.forEach(item => item.release());
+        },
+        parallel
+    }, outResult);
+}
+exports.executeBatchQuery = executeBatchQuery;
+function checkTimeout(value, limit = 0) {
+    return DbPool.checkTimeout(POOL_STATE, value, limit);
+}
+exports.checkTimeout = checkTimeout;
+exports.DB_SOURCE_CLIENT = true;
+exports.DB_SOURCE_TYPE = types_1.DB_TYPE.SQL;

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@pi-r/mariadb",
+  "version": "0.2.0",
+  "description": "MariaDB client driver for E-mc.",
+  "main": "client/index.js",
+  "types": "client/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/anpham6/pi-r.git",
+    "directory": "src/db/mariadb"
+  },
+  "keywords": [
+    "squared",
+    "e-mc",
+    "squared-functions"
+  ],
+  "author": "An Pham <anpham6@gmail.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/anpham6/pi-r#readme",
+  "dependencies": {
+    "@e-mc/db": "^0.5.3",
+    "@e-mc/types": "^0.5.3",
+    "mariadb": "^3.1.2"
+  }
+}

package/types/index.d.ts

@@ -0,0 +1,15 @@
+import type { DbDataSource } from '@e-mc/types/lib/squared';
+
+import type { ExecuteAction, ServerAuth } from '@e-mc/types/lib/db';
+
+import type { SecureContextOptions } from 'tls';
+
+import type { PoolConfig, QueryConfig } from 'mariadb';
+
+export interface MariaDBDataSource<T = unknown> extends DbDataSource<string | QueryConfig, unknown, unknown, string | MariaDBCredential, string>, ExecuteAction<T> {
+    source: "mariadb";
+}
+
+export interface MariaDBCredential extends ServerAuth, Omit<PoolConfig, "ssl"> {
+    ssl?: boolean | string | SecureContextOptions & { rejectUnauthorized?: boolean };
+}