mirror of
https://github.com/mperham/sidekiq.git
synced 2022-11-09 13:52:34 -05:00
9d09539eba
Fixes an edge case where a stringified `namespace` key is ignored. A `namespace` key may be a string if the Sidekiq Redis config is loaded from a yml file. Also minor, syntactical improvements to error messaging. Existing tests pass. Added a new test to address this edge-case.
99 lines
3 KiB
Ruby
99 lines
3 KiB
Ruby
# frozen_string_literal: true
|
|
require 'connection_pool'
|
|
require 'redis'
|
|
require 'uri'
|
|
|
|
module Sidekiq
|
|
class RedisConnection
|
|
class << self
|
|
|
|
def create(options={})
|
|
options = options.symbolize_keys
|
|
|
|
options[:url] ||= determine_redis_provider
|
|
|
|
size = options[:size] || (Sidekiq.server? ? (Sidekiq.options[:concurrency] + 5) : 5)
|
|
|
|
verify_sizing(size, Sidekiq.options[:concurrency]) if Sidekiq.server?
|
|
|
|
pool_timeout = options[:pool_timeout] || 1
|
|
log_info(options)
|
|
|
|
ConnectionPool.new(:timeout => pool_timeout, :size => size) do
|
|
build_client(options)
|
|
end
|
|
end
|
|
|
|
private
|
|
|
|
# Sidekiq needs a lot of concurrent Redis connections.
|
|
#
|
|
# We need a connection for each Processor.
|
|
# We need a connection for Pro's real-time change listener
|
|
# We need a connection to various features to call Redis every few seconds:
|
|
# - the process heartbeat.
|
|
# - enterprise's leader election
|
|
# - enterprise's cron support
|
|
def verify_sizing(size, concurrency)
|
|
raise ArgumentError, "Your Redis connection pool is too small for Sidekiq to work. Your pool has #{size} connections but really needs to have at least #{concurrency + 2}" if size <= concurrency
|
|
end
|
|
|
|
def build_client(options)
|
|
namespace = options[:namespace]
|
|
|
|
client = Redis.new client_opts(options)
|
|
if namespace
|
|
begin
|
|
require 'redis/namespace'
|
|
Redis::Namespace.new(namespace, :redis => client)
|
|
rescue LoadError
|
|
Sidekiq.logger.error("Your Redis configuration uses the namespace '#{namespace}' but the redis-namespace gem is not included in the Gemfile." \
|
|
"Add the gem to your Gemfile to continue using a namespace. Otherwise, remove the namespace parameter.")
|
|
exit(-127)
|
|
end
|
|
else
|
|
client
|
|
end
|
|
end
|
|
|
|
def client_opts(options)
|
|
opts = options.dup
|
|
if opts[:namespace]
|
|
opts.delete(:namespace)
|
|
end
|
|
|
|
if opts[:network_timeout]
|
|
opts[:timeout] = opts[:network_timeout]
|
|
opts.delete(:network_timeout)
|
|
end
|
|
|
|
opts[:driver] = opts[:driver] || 'ruby'
|
|
|
|
opts
|
|
end
|
|
|
|
def log_info(options)
|
|
# Don't log Redis AUTH password
|
|
redacted = "REDACTED"
|
|
scrubbed_options = options.dup
|
|
if scrubbed_options[:url] && (uri = URI.parse(scrubbed_options[:url])) && uri.password
|
|
uri.password = redacted
|
|
scrubbed_options[:url] = uri.to_s
|
|
end
|
|
if scrubbed_options[:password]
|
|
scrubbed_options[:password] = redacted
|
|
end
|
|
if Sidekiq.server?
|
|
Sidekiq.logger.info("Booting Sidekiq #{Sidekiq::VERSION} with redis options #{scrubbed_options}")
|
|
else
|
|
Sidekiq.logger.debug("#{Sidekiq::NAME} client with redis options #{scrubbed_options}")
|
|
end
|
|
end
|
|
|
|
def determine_redis_provider
|
|
ENV[ENV['REDIS_PROVIDER'] || 'REDIS_URL']
|
|
end
|
|
|
|
end
|
|
end
|
|
end
|