Using a proxy

It would be nice to have proxy support for Sequelize. Using Sequelize on a host with rotating IP addresses makes it near impossible to whitelist connections to an external database. I understand that this would depend on the connection package (node-mysql, pg). These packages do offer support for this feature, but there is no way to initialize Sequelize using those stream options. For example, with the pg package:

const pg = require('pg');
const SocksConnection = require('socksjs');

const pgServer = {
  host: 'YOUR-HOST',
  port: 5432
};

const proxyConnection = new SocksConnection(pgServer, {
  user: process.env.PROXY_USER,
  pass: process.env.PROXY_PASS,
  host: process.env.PROXY_HOST,
  port: process.env.PROXY_PORT,
});

const connectionConfig = {
  user: 'YOUR-DB-USERNAME',
  password: 'YOUR-DB-PASSWORD',
  database: 'YOUR-DATABASE',
  stream: proxyConnection,
  ssl: true // Optional, depending on db config
};

const client = new pg.Client(connectionConfig);

// client.connect() { ... }

Since we can’t pass a custom pg instance into Sequelize, how would we go about making this work?

[mgoria]

stream option needs to be a function returning a new Socks connection, something like:

const createNewProxyStream = (proxyUrl) => {
 const proxyUrlObj = new URL(proxyUrl)

  const remoteOptions = {
    host: DB_HOST,
    port: DB_PORT,
  }

  const sockOptions = {
    host: proxyUrlObj.hostname,
    port: 1080,
    user: proxyUrlObj.username,
    pass: proxyUrlObj.password,
  }

  return new SocksConnection(remoteOptions, sockOptions)
}

const config = {
  host: DB_HOST,
  dialect: 'mysql',
  dialectOptions: {
    // IMPORTANT: the stream needs to be created all the time since new pooled connection needs new stream
    stream: (options) => {
      console.log('[sequelize-connection] - creating new proxy stream.')
      return createNewProxyStream()
    },
  },
}

const sequelize = new Sequelize(DB_NAME, DB_USER, DB_PASS, config);

[papb]

Related: #9780