db-crud-wrapper 1.0.1

package/lib/mysql.js

@@ -0,0 +1,532 @@
+'use strict';
+
+import sql from 'mysql2/promise';
+import log from './log.js'
+
+// Regex
+const _match_LIMIT_n = /\bLIMIT\b +\d+/ig
+const _match_TOP_n = /\bTOP\b +\d+/ig
+const _match_TOP = /\bTOP\b/ig
+
+const pools = {};
+
+// Common
+function isExpression(str) {
+  if (typeof str !== 'string') return false;
+  const trimmed = str.trim();
+  return (trimmed.startsWith('[') && trimmed.endsWith(']')) ||
+         (trimmed.startsWith('`') && trimmed.endsWith('`'));
+}
+
+function removeExpressionDelimiters(str) {
+  if (typeof str !== 'string') return str;
+  const trimmed = str.trim();
+  if ((trimmed.startsWith('[') && trimmed.endsWith(']')) ||
+      (trimmed.startsWith('`') && trimmed.endsWith('`'))) {
+    return trimmed.slice(1, -1);
+  }
+  return str;
+}
+
+function stringifyValue(fieldName, value, tSchema) {
+
+    // null or undefined
+    if (value == undefined)
+        return 'null';
+
+    // if values is an expression than remove delimiters 
+    if (isExpression(value)) {
+        return removeExpressionDelimiters(value);
+    }
+
+    // detect field type
+    let _fieldType = undefined;
+    if (tSchema.table.fields && tSchema.table.fields[fieldName] && tSchema.table.fields[fieldName].type) {
+        _fieldType = tSchema.table.fields[fieldName].type;
+    }
+
+    // if datetime
+    if (_fieldType == 'datetime') {
+        // my-sql not accepts 'Z' at end of ISO string
+        if (value instanceof Date)
+            return `\'${value.toISOString().slice(0, -1)}\'`;
+        if (typeof value == 'string') {
+            const valueDate = new Date(Date.parse(value));
+            return `\'${valueDate.toISOString().slice(0, -1)}\'`;
+        }
+        return value;
+    }
+
+    // if boolean
+    if (_fieldType == 'boolean' && typeof value == 'boolean')
+        return `\'${value}\'`;
+
+    // if string or uuid
+    if (_fieldType == 'string' || _fieldType == 'uuid') {
+        return sql.escape(`${value}`);
+    }
+
+    // field not in schema
+    if (_fieldType == undefined) {
+        if (value instanceof Date)
+            return `\'${value.toISOString().slice(0, -1)}\'`;
+        if (typeof value == 'boolean')
+            return `\'${value}\'`;
+        if (typeof value == 'string')
+            return sql.escape(`${value}`);
+    }
+
+    return value;
+}
+
+
+
+// Create config object for pool
+export function prepareConnection(tSchema) {
+    return {
+        id: `${tSchema.server.realName}-${tSchema.database.realName}-${tSchema.server.user}`,
+        host: ((tSchema.server.instance && tSchema.server.instance != 'DEFAULT') ? (tSchema.server.realName + '\\' + tSchema.server.instance) : tSchema.server.realName) ?? 'localhost',
+        port: tSchema.server.port,
+        user: tSchema.server.user,
+        password: tSchema.server.password,
+        database: tSchema.database.realName,
+        ssl: {
+            rejectUnauthorized: false
+        },
+        multipleStatements: true,
+        connectionLimit: tSchema.server.connectionLimit,
+        enableKeepAlive: true,
+        keepAliveInitialDelay: 30000,
+        timezone: 'Z' // Forza l'uso dell'UTC (Zulu time)        
+    };
+};
+
+// Close connection
+export async function closeConnection(connection) {
+    let pool = pools[connection.id];
+    if (pool) {
+        pool.releaseConnection();
+        await connection.end();
+        pools[connection.id] = undefined;  // remove pool from pools
+    }
+}
+
+// Close all connections
+export async function closeAllConnections() {
+    for (let poolId in pools) {
+        if (!pools.hasOwnProperty(poolId)) continue;
+        let pool = pools[poolId];
+        if (pool) {
+            await pool.end();
+            pool = undefined;  // remove pool from pools
+        }
+    }
+}
+
+// Test connection
+export async function testConnection(connection) {
+    let _pool;
+    try {
+        // const _connection = await sql.createConnection(connection);
+        // await _connection.end();
+        _pool = new sql.createPool(connection);  // Create new pool
+        await _pool.query('SELECT 1');
+        return true;
+    }
+    catch (error) {
+        throw (error);
+    }
+    finally {
+        if (_pool) await _pool.end();
+    }
+}
+
+// Query
+export async function query(connection, dbOpes, rawResult = false) {
+
+    // Prepare pool
+    let pool = pools[connection.id];  // Try to get an existing pool
+    if (!pool) {
+        pool = new sql.createPool(connection);  // Create new pool
+        pools[connection.id] = pool;  // add new pool to pools
+    }
+
+    // Prepare sql statement
+    let sqlString = '';
+    const paramsObject = {};
+    let appLog = true;
+    
+    if (Array.isArray(dbOpes)) {
+        dbOpes.forEach((dbOpe, index) => {
+            sqlString += ToSql(dbOpe, paramsObject);  // if exists, input params will be added to paramsObject
+            if (dbOpe?.hasOwnProperty('appLog') && dbOpe.appLog === false) appLog = false;
+        });
+    }
+    else {
+        sqlString += ToSql(dbOpes, paramsObject);  // if exists, input params will be added to paramsObject
+        if (dbOpes?.hasOwnProperty('appLog') && dbOpes.appLog === false) appLog = false;
+    }
+
+    sqlString = normalizeSpecialName(sqlString);
+
+    // convert @param to ? and build params array
+    const _translated = translateParamsToMysql(sqlString, paramsObject); 
+    sqlString = _translated.sqlString;
+    const sqlParams = _translated.paramsArray;
+
+    // Log
+    if (appLog) {
+        log(JSON.stringify(dbOpes), 60);
+        log(sqlString, 50);
+    }
+
+    // Run query
+    let sqlresult = undefined;
+    //let sqlconn = undefined;
+    try {
+        //    sqlconn = await pool.getConnection();
+        //    sqlresult = await sqlconn.query(sqlString);
+        sqlresult = await pool.query(sqlString, sqlParams);
+    }
+    catch (err) { throw (err); } // using original error
+    // finally { if (sqlconn) sqlconn.release(); }
+
+    // normalize return object
+    const _return = normalizeQueryResults(sqlresult);
+
+    // Log
+    if (appLog) {
+        if (Array.isArray(dbOpes)) // multiple query 
+            log(`Batch return ${Number.isInteger(_return) ? _return : Array.isArray(_return) ? _return.length : _return ? 1 : 0} result(s).`, 50)
+        else // single query
+            log(`Query result: ${Number.isInteger(_return) ? _return : Array.isArray(_return) ? _return.length : _return ? 1 : 0} row(s).`, 50)
+    }
+
+    // return
+    return rawResult ? sqlresult : _return;
+}
+
+// Normalize special name to replace square brackets with backticks, considering quoted strings
+function normalizeSpecialName(sql) {
+    let result = "";
+    let inSingleQuote = false;
+    let inDoubleQuote = false;
+
+    for (let i = 0; i < sql.length; i++) {
+        const char = sql[i];
+
+        // Gestione delle virgolette singole '
+        if (char === "'" && !inDoubleQuote) {
+            inSingleQuote = !inSingleQuote;
+        }
+        // Gestione delle virgolette doppie "
+        else if (char === '"' && !inSingleQuote) {
+            inDoubleQuote = !inDoubleQuote;
+        }
+
+        // Se non siamo all'interno di una stringa, sostituiamo le quadre
+        if (!inSingleQuote && !inDoubleQuote) {
+            if (char === '[' || char === ']') {
+                result += '`';
+                continue;
+            }
+        }
+
+        result += char;
+    }
+
+    return result;
+}
+
+// Compose fully qualified table name
+function fullyQualifiedTableName(tSchema) {
+    return (tSchema.database.realName + '.' + tSchema.table.realName);
+}
+
+function containLIMIT(s) {
+    const _return = s?.match(_match_LIMIT_n);
+    if (_return) return _return[0];
+    else return undefined;
+};
+
+function containTOP(s) {
+    const _return = s?.match(_match_TOP_n);
+    if (_return) return _return[0];
+    else return undefined;
+};
+
+function replaceTOPToLIMIT(s) {
+    const _replace = containTOP(s);
+    if (_replace) { return s.replace(_match_TOP_n, _replace.replace(_match_TOP, 'LIMIT')); }
+    else return s;
+}
+
+/**
+ * Normalizza l'output di mysql2 ignorando i campi (fields).
+ * @param {Array} rawResponse - L'intero array restituito dalla query()
+ * @return {Array|number|Array<number>} - Restituisce i risultati normalizzati:
+ *   - Per query SELECT singole: un array di record.
+ *   - Per query di modifica singole (INSERT, UPDATE, DELETE): il numero di righe interessate.
+ *   - Per batch di query (MULTIPLE STATEMENTS): un array dove ogni elemento è
+ *     o un array di record (per SELECT) o un intero (per modifiche).
+ */
+function normalizeQueryResults(rawResponse) {
+    // 1. Prendiamo solo il primo elemento (i dati/risultati)
+    // mysql2 restituisce sempre [risultati, campi].
+    const results = rawResponse[0];
+
+    // Helper per processare ogni singola unità di risultato
+    const normalizeItem = (item) => {
+        // Se è un array, è una SELECT -> restituisco l'array di record
+        if (Array.isArray(item)) return item;
+        // Se è un oggetto (ResultSetHeader), restituisco l'intero affectedRows
+        if (item && typeof item === 'object') return item.affectedRows ?? 0;
+        return 0;
+    };
+
+    // 2. Controllo se siamo in modalità MULTIPLE STATEMENTS (Batch or stored procedure)
+    // Se è un batch, results è un array dove il primo elemento è a sua volta 
+    // un array (SELECT) o un oggetto (ResultSetHeader).
+    const isBatch = Array.isArray(results) && 
+                    results.length > 0 && 
+                    (Array.isArray(results[0]) || results[0]?.constructor?.name === 'ResultSetHeader');
+
+    if (isBatch) {
+        // Mappiamo ogni query del batch trasformandola in [Array o Intero]
+        return results.map(normalizeItem);
+    }
+
+    // 3. Caso Query Singola
+    return normalizeItem(results);
+}
+
+// Parse oprations object to sql string
+function ToSql(dbOpe, paramsObject) {
+    if (dbOpe.get) return getToSql(dbOpe, paramsObject);
+    if (dbOpe.post) return postToSql(dbOpe, paramsObject);
+    if (dbOpe.patch) return patchToSql(dbOpe, paramsObject);
+    if (dbOpe.put) return putToSql(dbOpe, paramsObject);
+    if (dbOpe.delete) return deleteToSql(dbOpe, paramsObject);
+    if (dbOpe.command) return commandToSql(dbOpe, paramsObject);
+    if (dbOpe.begin) return beginToSql(dbOpe, paramsObject);
+    if (dbOpe.commit) return commitToSql(dbOpe, paramsObject);
+    if (dbOpe.passthrough) return passthroughToSql(dbOpe, paramsObject);
+    throw new Error('Sintax error, missing property get/post/patch/put/delete/...');
+}
+
+// Parse operation object to sql string without any trasformation.
+function passthroughToSql(dbOpe, paramsObject) {
+    let result = "";
+
+    if (dbOpe.passthrough.command) {
+        result += dbOpe.passthrough.command;
+    }
+    else { throw new Error('command is missing.'); }
+
+    if (dbOpe.passthrough.params) {
+        Object.assign(paramsObject, dbOpe.passthrough.params);
+    }
+
+    return result;
+}
+
+// Parse get operation object to sql string
+function getToSql(dbOpe, paramsObject) {
+    let _first = true;
+
+    let result = 'select'
+
+    // omit 'limit' or 'top'
+    if (dbOpe.get.options && dbOpe.get.options.length > 0) {
+        if (Array.isArray(dbOpe.get.options)) {
+            for (const s of dbOpe.get.options) { if (!containLIMIT(s) && !containTOP(s)) result += ' ' + s; }
+        }
+        else if (!containLIMIT(dbOpe.get.options) && !containTOP(dbOpe.get.options)) result += ' ' + dbOpe.get.options;
+    }
+
+    if (dbOpe.get.fields && dbOpe.get.fields.length > 0) {
+        if (Array.isArray(dbOpe.get.fields)) result += ' ' + dbOpe.get.fields.join(',')
+        else result += ' ' + dbOpe.get.fields;
+    }
+    else { throw new Error('fields is missing.'); }
+
+    result += ' from ' + fullyQualifiedTableName(dbOpe.get.schema);
+
+    if (dbOpe.get.filters && dbOpe.get.filters.length > 0) {
+        if (Array.isArray(dbOpe.get.filters)) result += ' where ' + dbOpe.get.filters.join(' ');
+        else result += ' where ' + dbOpe.get.filters;
+    }
+
+    if (dbOpe.get.groupBy && dbOpe.get.groupBy.length > 0) {
+        if (Array.isArray(dbOpe.get.groupBy)) result += ' group by ' + dbOpe.get.groupBy.join(', ');
+        else result += ' group by ' + dbOpe.get.groupBy;
+    }
+
+    if (dbOpe.get.groupFilters && dbOpe.get.groupFilters.length > 0) {
+        if (Array.isArray(dbOpe.get.groupFilters)) result += ' having ' + dbOpe.get.groupFilters.join(' ');
+        else result += ' having ' + dbOpe.get.groupFilters;
+    }
+
+    if (dbOpe.get.orderBy && dbOpe.get.orderBy.length > 0) {
+        if (Array.isArray(dbOpe.get.orderBy)) result += ' order by ' + dbOpe.get.orderBy.join(', ');
+        else result += ' order by ' + dbOpe.get.orderBy;
+    }
+
+    // search if 'limit' or 'top'
+    if (dbOpe.get.options && dbOpe.get.options.length > 0) {
+        if (Array.isArray(dbOpe.get.options)) {
+            for (const s of dbOpe.get.options) { if (containLIMIT(s) || containTOP(s)) result += ' ' + replaceTOPToLIMIT(s); }
+        }
+        else if (containLIMIT(dbOpe.get.options) || containTOP(dbOpe.get.options)) result += ' ' + replaceTOPToLIMIT(dbOpe.get.options);
+    }
+
+    if (dbOpe.get.params) {
+        Object.assign(paramsObject, dbOpe.get.params);
+    }
+    
+    return result += ';' ;
+}
+
+// Parse post operation object to sql string
+function postToSql(dbOpe, paramsObject) {
+    let result = 'insert into ' + fullyQualifiedTableName(dbOpe.post.schema);
+
+    if ((dbOpe.post.values) && (Object.keys(dbOpe.post.values).length > 0)) {
+        let result_f = ' ('; 
+        let result_v = ' values (';
+        let _first = true;
+        for (const [key, value] of Object.entries(dbOpe.post.values)) {
+            if (!_first) { 
+                result_f += ', ';
+                result_v += ', ';
+            } else { 
+                _first = false 
+            }
+            if (key || value) { 
+                result_f += key; 
+                result_v += stringifyValue(key, value, dbOpe.post.schema); 
+            }
+        }
+        result_f += ')'; result_v += ')';
+        result += result_f + result_v;
+    }
+    else { throw new Error('values is missing.'); }
+
+    if (dbOpe.post.params) {
+        Object.assign(paramsObject, dbOpe.post.params);
+    }
+
+    return result += ';' ;
+}
+
+// Parse patch operation object to sql string
+function patchToSql(dbOpe, paramsObject) {
+    let result = 'update ' + fullyQualifiedTableName(dbOpe.patch.schema);
+
+    if (dbOpe.patch.values) { result += ' set ' + Object.entries(dbOpe.patch.values).map(e => { return e[0] + '=' + stringifyValue(e[0], e[1], dbOpe.patch.schema) }).join(', '); }
+    else { throw new Error('values is missing.'); }
+
+    if (dbOpe.patch.filters && dbOpe.patch.filters.length > 0) {
+        if (Array.isArray(dbOpe.patch.filters)) result += ' where ' + dbOpe.patch.filters.join(' ');
+        else result += ' where ' + dbOpe.patch.filters;
+    }
+
+    if (dbOpe.patch.params) {
+        Object.assign(paramsObject, dbOpe.patch.params);
+    }
+
+    return result += ';' ;
+}
+
+// Parse put operation object to sql string
+function putToSql(dbOpe, paramsObject) {
+    let result = 'update ' + fullyQualifiedTableName(dbOpe.put.schema);
+
+    if (dbOpe.put.values) { result += ' set ' + Object.entries(dbOpe.put.values).map(e => { return e[0] + '=' + stringifyValue(e[0], e[1], dbOpe.put.schema) }).join(', '); }
+    else { throw new Error('values is missing.'); }
+
+    if (dbOpe.put.filters && dbOpe.put.filters.length > 0) {
+        if (Array.isArray(dbOpe.put.filters)) result += ' where ' + dbOpe.put.filters.join(' ');
+        else result += ' where ' + dbOpe.put.filters;
+    }
+
+    if (dbOpe.put.params) {
+        Object.assign(paramsObject, dbOpe.put.params);
+    }
+
+    return result += ';' ;
+}
+
+// Parse delete operation object to sql string and consolidate params to paramsObject
+function deleteToSql(dbOpe, paramsObject) {
+    let result = 'delete from ' + fullyQualifiedTableName(dbOpe.delete.schema);
+
+    if (dbOpe.delete.filters && dbOpe.delete.filters.length > 0) {
+        if (Array.isArray(dbOpe.delete.filters)) result += ' where ' + dbOpe.delete.filters.join(' ');
+        else result += ' where ' + dbOpe.delete.filters;
+    }
+
+    if (dbOpe.delete.params) {
+        Object.assign(paramsObject, dbOpe.delete.params);
+    }
+
+    return result += ';' ;
+}
+
+// Parse command operation object to sql string
+function commandToSql(dbOpe, paramsObject) {
+    let result = "CALL ";
+
+    if (dbOpe.command.schema.procedure) {
+        result += dbOpe.command.schema.procedure.command;
+        if (dbOpe.command.arguments) { 
+            // if argument is string but not param, will be wrap into ''
+            result += ('(' +  [].concat(dbOpe.command.arguments).map(item => { 
+                return (typeof item === 'string' && !item.trimStart().startsWith("@")) ? `'${item}'` : item
+            }).join(', ') + ')'); 
+        }
+    }
+    else { throw new Error('missing procedure/function name.'); }
+
+    if (dbOpe.command.params) {
+        Object.assign(paramsObject, dbOpe.command.params);
+    }
+
+    return result += ';' ;
+}
+
+// Parse begin operation object to sql string
+function beginToSql(dbOpe, paramsObject) {
+    return "START TRANSACTION; ";
+}
+
+// Parse commit operation object to sql string
+function commitToSql(dbOpe, paramsObject) {
+    return " COMMIT;";
+}
+
+/**
+ * Converte una query da formato MSSQL (@param) a MySQL (?) 
+ * @param {string} sqlString - La stringa SQL con segnaposti in formato MSSQL
+ * @param {Object} params - Oggetto con i valori { nome: 'valore' }
+ * @returns {Object} { sqlString: string, params: Array }
+ */
+function translateParamsToMysql(sqlString, params) {
+    const _params = [];
+
+    // Regex per trovare i segnaposti che iniziano con @ seguiti da caratteri alfanumerici
+    // Usa un lookahead negativo per evitare di catturare @ nelle email se necessario
+    const regex = /@([a-zA-Z0-9_]+)/g;
+
+    const _sqlString = sqlString.replace(regex, (match, name) => {
+        if (Object.prototype.hasOwnProperty.call(params, name)) {
+            _params.push(params[name]);
+            return '?';
+        }
+        // Se non è nell'oggetto params, è probabilmente una variabile MySQL 
+        // o parte di una stringa, quindi la lasciamo intatta
+        return match; 
+    });
+
+    return { sqlString: _sqlString, paramsArray: _params };
+}