1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
|
# frozen_string_literal: true
require "openssl"
require "uri"
class RedisClient
class Config
DEFAULT_TIMEOUT = 1.0
DEFAULT_HOST = "localhost"
DEFAULT_PORT = 6379
DEFAULT_USERNAME = "default"
DEFAULT_DB = 0
DEFAULT_IDLE_TIMEOUT = 30.0
module Common
attr_reader :db, :id, :ssl, :ssl_params, :command_builder, :inherit_socket,
:connect_timeout, :read_timeout, :write_timeout, :driver, :protocol,
:middlewares_stack, :custom, :circuit_breaker, :driver_info, :idle_timeout
alias_method :ssl?, :ssl
def initialize(
username: nil,
password: nil,
db: nil,
id: nil,
timeout: DEFAULT_TIMEOUT,
read_timeout: timeout,
write_timeout: timeout,
connect_timeout: timeout,
idle_timeout: DEFAULT_IDLE_TIMEOUT,
ssl: nil,
custom: {},
ssl_params: nil,
driver: nil,
protocol: 3,
client_implementation: RedisClient,
command_builder: CommandBuilder,
inherit_socket: false,
reconnect_attempts: false,
middlewares: false,
circuit_breaker: nil,
driver_info: nil
)
@username = username
@password = password && !password.respond_to?(:call) ? ->(_) { password } : password
@db = begin
Integer(db || DEFAULT_DB)
rescue ArgumentError
raise ArgumentError, "db: must be an Integer, got: #{db.inspect}"
end
@id = id
@ssl = ssl || false
@ssl_params = ssl_params
@connect_timeout = connect_timeout
@read_timeout = read_timeout
@write_timeout = write_timeout
@idle_timeout = idle_timeout
@driver = driver ? RedisClient.driver(driver) : RedisClient.default_driver
@custom = custom
@client_implementation = client_implementation
@protocol = protocol
unless protocol == 2 || protocol == 3
raise ArgumentError, "Unknown protocol version #{protocol.inspect}, expected 2 or 3"
end
@command_builder = command_builder
@inherit_socket = inherit_socket
reconnect_attempts = Array.new(reconnect_attempts, 0).freeze if reconnect_attempts.is_a?(Integer)
@reconnect_attempts = reconnect_attempts
circuit_breaker = CircuitBreaker.new(**circuit_breaker) if circuit_breaker.is_a?(Hash)
if @circuit_breaker = circuit_breaker
middlewares = [CircuitBreaker::Middleware] + (middlewares || [])
end
middlewares_stack = Middlewares
if middlewares && !middlewares.empty?
middlewares_stack = Class.new(Middlewares)
middlewares.each do |mod|
middlewares_stack.include(mod)
end
end
@middlewares_stack = middlewares_stack
@driver_info = driver_info
end
def connection_prelude
prelude = []
pass = password
if protocol == 3
prelude << if pass
["HELLO", "3", "AUTH", username, pass]
else
["HELLO", "3"]
end
elsif pass
prelude << if @username && !@username.empty?
["AUTH", @username, pass]
else
["AUTH", pass]
end
end
if @db && @db != 0
prelude << ["SELECT", @db.to_s]
end
# Add CLIENT SETINFO commands for lib-name and lib-ver
# These commands are supported in Redis 7.2+
if @driver_info
prelude << ["CLIENT", "SETINFO", "LIB-NAME", build_lib_name]
prelude << ["CLIENT", "SETINFO", "LIB-VER", RedisClient::VERSION]
end
# Deep freeze all the strings and commands
prelude.map! do |commands|
commands = commands.map { |str| str.frozen? ? str : str.dup.freeze }
commands.freeze
end
prelude.freeze
end
def password
@password&.call(username)
end
def username
@username || DEFAULT_USERNAME
end
# Build the library name for CLIENT SETINFO LIB-NAME.
#
# @param driver_info [String, Array<String>, nil] Upstream driver info
# @return [String] Library name with optional upstream driver info
# @raise [ArgumentError] if driver_info is not a String or Array
def build_lib_name
return "redis-client" if @driver_info.nil?
info = case @driver_info
when String then @driver_info
when Array then @driver_info.join(";")
else raise ArgumentError, "driver_info must be a String or Array of Strings"
end
return "redis-client" if info.empty?
"redis-client(#{info})"
end
def resolved?
true
end
def sentinel?
false
end
def new_pool(**kwargs)
kwargs[:timeout] ||= DEFAULT_TIMEOUT
Pooled.new(self, **kwargs)
end
def new_client(**kwargs)
@client_implementation.new(self, **kwargs)
end
def retriable?(attempt)
@reconnect_attempts && @reconnect_attempts[attempt]
end
def retry_connecting?(attempt, _error)
if @reconnect_attempts
if (pause = @reconnect_attempts[attempt])
if pause > 0
sleep(pause)
end
return true
end
end
false
end
def ssl_context
if ssl
@ssl_context ||= @driver.ssl_context(@ssl_params || {})
end
end
def server_url
if path
url = "unix://#{path}"
if db != 0
url = "#{url}?db=#{db}"
end
else
# add brackets to IPv6 address
redis_host = if host.count(":") >= 2
"[#{host}]"
else
host
end
url = "redis#{'s' if ssl?}://#{redis_host}:#{port}"
if db != 0
url = "#{url}/#{db}"
end
end
url
end
end
include Common
attr_reader :host, :port, :path, :server_key
def initialize(
url: nil,
host: nil,
port: nil,
path: nil,
username: nil,
password: nil,
db: nil,
**kwargs
)
if url
url_config = URLConfig.new(url)
kwargs = {
ssl: url_config.ssl?,
}.compact.merge(kwargs)
db ||= url_config.db
host ||= url_config.host
port ||= url_config.port
path ||= url_config.path
username ||= url_config.username
password ||= url_config.password
end
super(username: username, password: password, db: db, **kwargs)
if @path = path
@host = nil
@port = nil
else
@host = host || DEFAULT_HOST
@port = Integer(port || DEFAULT_PORT)
end
@server_key = [@path, @host, @port].freeze
end
end
end
|