sequelize-pg-utilities/src/configure.js

An opinionated set of database utilities that manage creating and connecting to a Postgres database

/*
 *  This is excluded from code coverage reporting due to a bug in instanbul
 *  whereby it will not ignore the if on line 49 unless I add a ; to the preceeding line.
 *
 *  TODO: revisit this when the bug is fixed.
 */

const env = require('./env')
const urlParser = require('./urlParser')
const appendOptionalPoolOptions = require('./appendOptionalPoolOptions')
const { CONFIG_OPTIONS, PROGRAMATIC_OPTIONS } = require('./constants')
const onlyDefined = require('./onlyDefined')

/**
 * Generate a Sequelize configuration object using a mix of environment variables,
 * a supplied config file, and other optional parameters.
 *
 * @param config — The content of the `config/config.json` file. Required, no default.
 * @param defaultDbName — If the database name is not set an environment variable, and if the config file does not define a database name, then use this as the database name. Optional, no default.
 * @param logger — You can pass in a logger function here for Sequelize to use. Optional, default is `false`, meaning don't log anything.
 * @param options — You can pass in additional options here. Optional.
 * @return { name, user, password, options }
 */
const configure = (
  { [env]: config },
  defaultDbName,
  logger = false,
  { pool: { validate } = {}, retry: { match, max } = {}, ...additionalOptions } = {}
) => {
  const parsedUrl = urlParser(process.env.DATABASE_URL)

  const name = parsedUrl.database || process.env.DB_NAME || config.database || defaultDbName

  const user = parsedUrl.username || process.env.DB_USER || config.username || null
  const password = parsedUrl.password || process.env.DB_PASS || config.password || null

  const poolOptions = config.pool
    ? {
        max: process.env.DB_POOL_MAX || config.pool.max || 5,
        min: process.env.DB_POOL_MIN || config.pool.min || 1,
        idle: process.env.DB_POOL_IDLE || config.pool.idle || 10000
      }
    : {
        max: process.env.DB_POOL_MAX || 5,
        min: process.env.DB_POOL_MIN || 1,
        idle: process.env.DB_POOL_IDLE || 10000
      }

  const appendPoolOptions = appendOptionalPoolOptions(config, { validate })

  const options = {
    host: parsedUrl.host || process.env.DB_HOST || config.host || 'localhost',
    port: parsedUrl.port || process.env.DB_PORT || config.port || 5432,
    dialect: parsedUrl.dialect || process.env.DB_TYPE || config.dialect || 'postgres',
    logging: logger, // this can be a logging function or false.
    pool: appendPoolOptions(poolOptions)
  }
  // only allow whitelisted additional config.
  CONFIG_OPTIONS.forEach(key => {
    options[key] = config[key]
  })

  if (config.ssl) {
    options.dialectOptions = { ssl: config.ssl }
    options.ssl = true
  }
  if (match) options.retry = { ...(options.retry || {}), match }
  if (max) options.retry = { ...(options.retry || {}), max }

  // only allow whitelisted additional options.
  PROGRAMATIC_OPTIONS.forEach(key => {
    options[key] = additionalOptions[key]
  })

  return onlyDefined({ name, user, password, options })
}

module.exports = configure