# frozen_string_literal: true
require "active_record/database_configurations/database_config"
require "active_record/database_configurations/hash_config"
require "active_record/database_configurations/url_config"
require "active_record/database_configurations/connection_url_resolver"
module ActiveRecord
# ActiveRecord::DatabaseConfigurations returns an array of DatabaseConfig
# objects (either a HashConfig or UrlConfig) that are constructed from the
# application's database configuration hash or URL string.
class DatabaseConfigurations
class InvalidConfigurationError < StandardError; end
attr_reader :configurations
delegate :any?, to: :configurations
def initialize(configurations = {})
@configurations = build_configs(configurations)
end
# Collects the configs for the environment and optionally the specification
# name passed in. To include replica configurations pass include_hidden: true.
#
# If a name is provided a single DatabaseConfig object will be
# returned, otherwise an array of DatabaseConfig objects will be
# returned that corresponds with the environment and type requested.
#
# ==== Options
#
# * env_name: The environment name. Defaults to +nil+ which will collect
# configs for all environments.
# * name: The db config name (i.e. primary, animals, etc.). Defaults
# to +nil+. If no +env_name+ is specified the config for the default env and the
# passed +name+ will be returned.
# * include_replicas: Deprecated. Determines whether to include replicas in
# the returned list. Most of the time we're only iterating over the write
# connection (i.e. migrations don't need to run for the write and read connection).
# Defaults to +false+.
# * include_hidden: db_config.configuration_hash.stringify_keys)
end
end
deprecate to_h: "You can use `ActiveRecord::Base.configurations.configs_for(env_name: 'env', name: 'primary').configuration_hash` to get the configuration hashes."
# Checks if the application's configurations are empty.
#
# Aliased to blank?
def empty?
configurations.empty?
end
alias :blank? :empty?
# Returns fully resolved connection, accepts hash, string or symbol.
# Always returns a DatabaseConfiguration::DatabaseConfig
#
# == Examples
#
# Symbol representing current environment.
#
# DatabaseConfigurations.new("production" => {}).resolve(:production)
# # => DatabaseConfigurations::HashConfig.new(env_name: "production", config: {})
#
# One layer deep hash of connection values.
#
# DatabaseConfigurations.new({}).resolve("adapter" => "sqlite3")
# # => DatabaseConfigurations::HashConfig.new(config: {"adapter" => "sqlite3"})
#
# Connection URL.
#
# DatabaseConfigurations.new({}).resolve("postgresql://localhost/foo")
# # => DatabaseConfigurations::UrlConfig.new(config: {"adapter" => "postgresql", "host" => "localhost", "database" => "foo"})
def resolve(config) # :nodoc:
return config if DatabaseConfigurations::DatabaseConfig === config
case config
when Symbol
resolve_symbol_connection(config)
when Hash, String
build_db_config_from_raw_config(default_env, "primary", config)
else
raise TypeError, "Invalid type for configuration. Expected Symbol, String, or Hash. Got #{config.inspect}"
end
end
private
def default_env
ActiveRecord::ConnectionHandling::DEFAULT_ENV.call.to_s
end
def env_with_configs(env = nil)
if env
configurations.select { |db_config| db_config.env_name == env }
else
configurations
end
end
def build_configs(configs)
return configs.configurations if configs.is_a?(DatabaseConfigurations)
return configs if configs.is_a?(Array)
db_configs = configs.flat_map do |env_name, config|
if config.is_a?(Hash) && config.values.all?(Hash)
walk_configs(env_name.to_s, config)
else
build_db_config_from_raw_config(env_name.to_s, "primary", config)
end
end
unless db_configs.find(&:for_current_env?)
db_configs << environment_url_config(default_env, "primary", {})
end
merge_db_environment_variables(default_env, db_configs.compact)
end
def walk_configs(env_name, config)
config.map do |name, sub_config|
build_db_config_from_raw_config(env_name, name.to_s, sub_config)
end
end
def resolve_symbol_connection(name)
if db_config = find_db_config(name)
db_config
else
raise AdapterNotSpecified, <<~MSG
The `#{name}` database is not configured for the `#{default_env}` environment.
Available database configurations are:
#{build_configuration_sentence}
MSG
end
end
def build_configuration_sentence
configs = configs_for(include_hidden: true)
configs.group_by(&:env_name).map do |env, config|
names = config.map(&:name)
if names.size > 1
"#{env}: #{names.join(", ")}"
else
env
end
end.join("\n")
end
def build_db_config_from_raw_config(env_name, name, config)
case config
when String
build_db_config_from_string(env_name, name, config)
when Hash
build_db_config_from_hash(env_name, name, config.symbolize_keys)
else
raise InvalidConfigurationError, "'{ #{env_name} => #{config} }' is not a valid configuration. Expected '#{config}' to be a URL string or a Hash."
end
end
def build_db_config_from_string(env_name, name, config)
url = config
uri = URI.parse(url)
if uri.scheme
UrlConfig.new(env_name, name, url)
else
raise InvalidConfigurationError, "'{ #{env_name} => #{config} }' is not a valid configuration. Expected '#{config}' to be a URL string or a Hash."
end
end
def build_db_config_from_hash(env_name, name, config)
if config.has_key?(:url)
url = config[:url]
config_without_url = config.dup
config_without_url.delete :url
UrlConfig.new(env_name, name, url, config_without_url)
else
HashConfig.new(env_name, name, config)
end
end
def merge_db_environment_variables(current_env, configs)
configs.map do |config|
next config if config.is_a?(UrlConfig) || config.env_name != current_env
url_config = environment_url_config(current_env, config.name, config.configuration_hash)
url_config || config
end
end
def environment_url_config(env, name, config)
url = environment_value_for(name)
return unless url
UrlConfig.new(env, name, url, config)
end
def environment_value_for(name)
name_env_key = "#{name.upcase}_DATABASE_URL"
url = ENV[name_env_key]
url ||= ENV["DATABASE_URL"] if name == "primary"
url
end
end
end