mysql2-ssh/mysql.js

Execute mysql commands over an ssh tunnel.

/**
 * @author David Spreekmeester <david@grrr.nl>
 * Modified by Peter Schilleman <peter@eenengelswoord.nl>
 * to provide support for async/await
 */

const mysql = require('mysql2/promise')
const Client = require('ssh2').Client;

var tunnel = module.exports = {

    /**
     * @var ssh2.Connection _conn The SSH connection
     */
    _conn: null,

    /**
     * @var mysql2.Connection _conn The MySQL connection
     */
    _sql: null,

    /**
     * @param obj sshConfig SSH Configuration as defined by ssh2 package
     * @param obj dbConfig MySQL Configuration as defined by mysql(2) package
     * @return Promise <mysql2 connection>
     */
    connect: function (sshConfig, dbConfig) {
        dbConfig = tunnel._addDefaults(dbConfig)
        return new Promise(function (resolve, reject) {
            tunnel._conn = new Client();
            tunnel._conn.on('error', reject);
            tunnel._conn.on('ready', function () {
                tunnel._conn.forwardOut(
                    '127.0.0.1',
                    12345,
                    dbConfig.host,
                    dbConfig.port,
                    function (err, stream) {
                        if (err) {
                            tunnel.close()
                            var msg = err.reason == 'CONNECT_FAILED'
                                ? 'Connection failed.'
                                : err
                            return reject(msg)
                        }

                        // override db host, since we're operating from within the SSH tunnel
                        dbConfig.host = '127.0.0.1'
                        dbConfig.stream = stream
                        tunnel._sql = mysql.createConnection(dbConfig)
                        resolve(tunnel._sql)
                    }
                )
            }).connect(sshConfig)
        })
    },

    close: function () {
        if (tunnel._sql && 'end' in tunnel._sql) {
            tunnel._sql.end(function (err) { })
        }

        if (tunnel._conn && 'end' in tunnel._conn) {
            tunnel._conn.end()
        }
    },

    _addDefaults(dbConfig) {
        if (dbConfig && !('port' in dbConfig)) {
            dbConfig.port = 3306
        }

        if (dbConfig && !('host' in dbConfig)) {
            dbConfig.host = 'localhost'
        }

        return dbConfig
    }
}