Merge pull request #256 from JS-AK/feat/mysql/core-update

Feat/mysql/core update

Author: JS-AK

.eslintrc.cjs

@@ -61,6 +61,14 @@ module.exports = {
 			},
 		],
 		"@typescript-eslint/semi": ["error", "always"],
+		"@typescript-eslint/space-before-function-paren": [
+			"warn",
+			{
+				anonymous: "never",
+				asyncArrow: "always",
+				named: "never",
+			},
+		],
 		"@typescript-eslint/type-annotation-spacing": "error",
 		"array-bracket-spacing": ["error", "never"],
 		"arrow-parens": ["error", "always"],
@@ -123,14 +131,6 @@ module.exports = {
 			functions: "always",
 			keywords: "always",
 		}],
-		"space-before-function-paren": [
-			"warn",
-			{
-				anonymous: "never",
-				asyncArrow: "always",
-				named: "never",
-			},
-		],
 		"space-in-parens": ["error", "never"],
 		"space-infix-ops": "error",
 	},

package-lock.json

@@ -43,8 +43,8 @@
   },
   "homepage": "https://github.com/JS-AK/db-manager#readme",
   "dependencies": {
-    "@js-ak/mysql-migration-system": "1.1.0",
-    "@js-ak/pg-migration-system": "1.4.0",
+    "@js-ak/mysql-migration-system": "1.2.0",
+    "@js-ak/pg-migration-system": "1.5.0",
     "@types/pg": "8.11.6",
     "mysql2": "3.10.1",
     "pg": "8.12.0"

package.json

@@ -4,31 +4,156 @@ import { MYSQL } from "../../index.js";
 
 const pools = new Map<string, mysql.Pool>();
 
+/**
+ * Creates a MySQL connection with the given configuration.
+ *
+ * @param config - The configuration options for the MySQL connection.
+ *
+ * @returns The MySQL connection.
+ */
 export const createConnection = async (config: mysql.ConnectionOptions): Promise<mysql.Connection> => {
 	return mysql.createConnection(config);
 };
-export const getStandardPool = (config: MYSQL.ModelTypes.TDBCreds, poolName = "00"): mysql.Pool => {
-	const { database, host, password, port, user } = config;
+
+/**
+ * Retrieves or creates a standard connection pool.
+ *
+ * @param config - The database credentials configuration object.
+ * @param [poolName="00"] - The name suffix for the pool, default is "00".
+ *
+ * @returns The retrieved or newly created standard connection pool.
+ */
+export const getStandardPool = (
+	config: MYSQL.ModelTypes.TDBCreds,
+	poolName: string = "00",
+): mysql.Pool => {
 	const poolNameResult = "st" + poolName;
-	const credsString = `${poolNameResult}#${user}:${password}@${host}:${port}/${database}`;
 
-	const poolCandidate = pools.get(credsString);
+	return getPool(config, poolNameResult);
+};
 
-	if (poolCandidate) {
-		return poolCandidate;
-	} else {
-		const pool = mysql.createPool(config);
+/**
+ * Retrieves or creates a transaction-specific connection pool.
+ *
+ * @param config - The database credentials configuration object.
+ * @param [poolName="00"] - The name suffix for the pool, default is "00".
+ *
+ * @returns The retrieved or newly created transaction connection pool.
+ */
+export const getTransactionPool = (
+	config: MYSQL.ModelTypes.TDBCreds,
+	poolName: string = "00",
+): mysql.Pool => {
+	const poolNameResult = "tr" + poolName;
 
-		pools.set(credsString, pool);
+	return getPool(config, poolNameResult);
+};
 
-		return pool;
+/**
+ * Removes and closes a standard connection pool.
+ *
+ * @param config - The database credentials configuration object.
+ * @param [poolName="00"] - The name suffix for the pool, default is "00".
+ *
+ * @returns A promise that resolves when the pool is closed.
+ */
+export const removeStandardPool = async (
+	config: MYSQL.ModelTypes.TDBCreds,
+	poolName: string = "00",
+): Promise<void> => {
+	const poolNameResult = "st" + poolName;
+
+	return removePool(config, poolNameResult);
+};
+
+/**
+ * Removes and closes a transaction-specific connection pool.
+ *
+ * @param config - The database credentials configuration object.
+ * @param [poolName="00"] - The name suffix for the pool, default is "00".
+ *
+ * @returns A promise that resolves when the pool is closed.
+ */
+export const removeTransactionPool = async (
+	config: MYSQL.ModelTypes.TDBCreds,
+	poolName: string = "00",
+): Promise<void> => {
+	const poolNameResult = "tr" + poolName;
+
+	return removePool(config, poolNameResult);
+};
+
+/**
+ * Gracefully shuts down all active connection pools.
+ *
+ * @returns A promise that resolves when all pools are closed.
+ */
+export const shutdown = async (): Promise<void> => {
+	const poolShutdowns: Promise<void>[] = [];
+
+	for (const [_credsString, pool] of pools) {
+		poolShutdowns.push(pool.end());
 	}
+
+	try {
+		await Promise.all(poolShutdowns);
+	} finally {
+		pools.clear();
+	}
+};
+
+/**
+ * Creates a connection credentials string.
+ * This string is used as a key in the pools map to identify different pools.
+ *
+ * @param poolName - The name prefix for the pool.
+ * @param creds - The credentials object.
+ * @param creds.user - The database user.
+ * @param creds.password - The database password.
+ * @param creds.host - The database host.
+ * @param creds.port - The database port.
+ * @param creds.database - The database name.
+ *
+ * @returns The constructed credentials string.
+ */
+const createCredsString = (
+	poolName: string,
+	creds: { user: string; password: string; host: string; port: number; database: string; },
+): string => {
+	return `${poolName}#${creds.user}:${creds.password}@${creds.host}:${creds.port}/${creds.database}`;
+};
+
+/**
+ * Masks sensitive information in a connection string.
+ *
+ * @param credsString - The connection credentials string.
+ *
+ * @returns The credentials string with sensitive information masked.
+ */
+const _maskSensitiveInfo = (credsString: string): string => {
+	return credsString.replace(/:.+@/, ":<hidden>@");
 };
 
-export const getTransactionPool = (config: MYSQL.ModelTypes.TDBCreds, poolName = "00"): mysql.Pool => {
+/**
+ * Retrieves or creates a named connection pool.
+ *
+ * @param config - The database credentials configuration object.
+ * @param poolName - The name suffix for the pool.
+ *
+ * @returns The retrieved or newly created standard connection pool.
+ */
+const getPool = (
+	config: MYSQL.ModelTypes.TDBCreds,
+	poolName: string,
+): mysql.Pool => {
 	const { database, host, password, port, user } = config;
-	const poolNameResult = "tr" + poolName;
-	const credsString = `${poolNameResult}#${user}:${password}@${host}:${port}/${database}`;
+	const credsString = createCredsString(poolName, {
+		database,
+		host,
+		password,
+		port,
+		user,
+	});
 
 	const poolCandidate = pools.get(credsString);
 
@@ -43,24 +168,26 @@ export const getTransactionPool = (config: MYSQL.ModelTypes.TDBCreds, poolName =
 	}
 };
 
-export const removeStandardPool = async (config: MYSQL.ModelTypes.TDBCreds, poolName = "00"): Promise<void> => {
-	const { database, host, password, port, user } = config;
-	const poolNameResult = "st" + poolName;
-	const credsString = `${poolNameResult}#${user}:${password}@${host}:${port}/${database}`;
-
-	const pool = pools.get(credsString);
-
-	if (pool) {
-		pools.delete(credsString);
-
-		await pool.end();
-	}
-};
-
-export const removeTransactionPool = async (config: MYSQL.ModelTypes.TDBCreds, poolName = "00"): Promise<void> => {
+/**
+ * Removes and closes a named connection pool.
+ *
+ * @param config - The database credentials configuration object.
+ * @param poolName - The name suffix for the pool.
+ *
+ * @returns A promise that resolves when the pool is closed.
+ */
+const removePool = async (
+	config: MYSQL.ModelTypes.TDBCreds,
+	poolName: string,
+): Promise<void> => {
 	const { database, host, password, port, user } = config;
-	const poolNameResult = "tr" + poolName;
-	const credsString = `${poolNameResult}#${user}:${password}@${host}:${port}/${database}`;
+	const credsString = createCredsString(poolName, {
+		database,
+		host,
+		password,
+		port,
+		user,
+	});
 
 	const pool = pools.get(credsString);