n8n/packages/nodes-base/nodes/MySql/v2/transport/index.ts

import { createServer, type AddressInfo } from 'node:net';
import mysql2 from 'mysql2/promise';
import type {
	ICredentialTestFunctions,
	IDataObject,
	IExecuteFunctions,
	ILoadOptionsFunctions,
} from 'n8n-workflow';

import { formatPrivateKey } from '@utils/utilities';
import type { Mysql2Pool, MysqlNodeCredentials } from '../helpers/interfaces';
import { LOCALHOST } from '@utils/constants';

export async function createPool(
	this: IExecuteFunctions | ICredentialTestFunctions | ILoadOptionsFunctions,
	credentials: MysqlNodeCredentials,
	options?: IDataObject,
): Promise<Mysql2Pool> {
	const connectionOptions: mysql2.ConnectionOptions = {
		host: credentials.host,
		port: credentials.port,
		database: credentials.database,
		user: credentials.user,
		password: credentials.password,
		multipleStatements: true,
		supportBigNumbers: true,
		decimalNumbers: false,
	};

	if (credentials.ssl) {
		connectionOptions.ssl = {};

		if (credentials.caCertificate) {
			connectionOptions.ssl.ca = formatPrivateKey(credentials.caCertificate);
		}

		if (credentials.clientCertificate || credentials.clientPrivateKey) {
			connectionOptions.ssl.cert = formatPrivateKey(credentials.clientCertificate);
			connectionOptions.ssl.key = formatPrivateKey(credentials.clientPrivateKey);
		}
	}

	if (options?.nodeVersion && (options.nodeVersion as number) >= 2.1) {
		connectionOptions.dateStrings = true;
	}

	if (options?.connectionLimit) {
		connectionOptions.connectionLimit = options.connectionLimit as number;
	}

	if (options?.connectTimeout) {
		connectionOptions.connectTimeout = options.connectTimeout as number;
	}

	if (options?.largeNumbersOutput === 'text') {
		connectionOptions.bigNumberStrings = true;
	}

	if (options?.decimalNumbers === true) {
		connectionOptions.decimalNumbers = true;
	}

	if (!credentials.sshTunnel) {
		return mysql2.createPool(connectionOptions);
	} else {
		if (credentials.sshAuthenticateWith === 'privateKey' && credentials.privateKey) {
			credentials.privateKey = formatPrivateKey(credentials.privateKey as string);
		}
		const sshClient = await this.helpers.getSSHClient(credentials);

		// Find a free TCP port
		const localPort = await new Promise<number>((resolve) => {
			const tempServer = createServer();
			tempServer.listen(0, LOCALHOST, () => {
				resolve((tempServer.address() as AddressInfo).port);
				tempServer.close();
			});
		});

		const stream = await new Promise((resolve, reject) => {
			sshClient.forwardOut(
				LOCALHOST,
				localPort,
				credentials.host,
				credentials.port,
				(err, clientChannel) => {
					if (err) return reject(err);
					resolve(clientChannel);
				},
			);
		});

		return mysql2.createPool({
			...connectionOptions,
			stream,
		});
	}
}