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 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
|
# frozen_string_literal: true
require 'redis_client'
require 'redis_client/config'
require 'redis_client/cluster/errors'
require 'redis_client/cluster/node/primary_only'
require 'redis_client/cluster/node/random_replica'
require 'redis_client/cluster/node/random_replica_or_primary'
require 'redis_client/cluster/node/latency_replica'
class RedisClient
class Cluster
class Node
include Enumerable
# It affects to strike a balance between load and stability in initialization or changed states.
MAX_STARTUP_SAMPLE = Integer(ENV.fetch('REDIS_CLIENT_MAX_STARTUP_SAMPLE', 3))
# less memory consumption, but slow
USE_CHAR_ARRAY_SLOT = Integer(ENV.fetch('REDIS_CLIENT_USE_CHAR_ARRAY_SLOT', 1)) == 1
SLOT_SIZE = 16_384
MIN_SLOT = 0
MAX_SLOT = SLOT_SIZE - 1
DEAD_FLAGS = %w[fail? fail handshake noaddr noflags].freeze
ROLE_FLAGS = %w[master slave].freeze
EMPTY_ARRAY = [].freeze
EMPTY_HASH = {}.freeze
ReloadNeeded = Class.new(::RedisClient::Error)
Info = Struct.new(
'RedisClusterNode',
:id, :node_key, :role, :primary_id, :ping_sent,
:pong_recv, :config_epoch, :link_state, :slots,
keyword_init: true
) do
def primary?
role == 'master'
end
def replica?
role == 'slave'
end
end
class CharArray
BASE = ''
PADDING = '0'
def initialize(size, elements)
@elements = elements
@string = String.new(BASE, encoding: Encoding::BINARY, capacity: size)
size.times { @string << PADDING }
end
def [](index)
raise IndexError if index < 0
return if index >= @string.bytesize
@elements[@string.getbyte(index)]
end
def []=(index, element)
raise IndexError if index < 0
return if index >= @string.bytesize
pos = @elements.find_index(element) # O(N)
if pos.nil?
raise(RangeError, 'full of elements') if @elements.size >= 256
pos = @elements.size
@elements << element
end
@string.setbyte(index, pos)
end
end
class Config < ::RedisClient::Config
def initialize(scale_read: false, **kwargs)
@scale_read = scale_read
super(**kwargs)
end
private
def build_connection_prelude
prelude = super.dup
prelude << ['READONLY'] if @scale_read
prelude.freeze
end
end
def initialize(concurrent_worker, config:, pool: nil, **kwargs)
@concurrent_worker = concurrent_worker
@slots = build_slot_node_mappings(EMPTY_ARRAY)
@replications = build_replication_mappings(EMPTY_ARRAY)
klass = make_topology_class(config.use_replica?, config.replica_affinity)
@topology = klass.new(pool, @concurrent_worker, **kwargs)
@config = config
@mutex = Mutex.new
@last_reloaded_at = nil
end
def inspect
"#<#{self.class.name} #{node_keys.join(', ')}>"
end
def each(&block)
@topology.clients.each_value(&block)
end
def sample
@topology.clients.values.sample
end
def node_keys
@topology.clients.keys.sort
end
def find_by(node_key)
raise ReloadNeeded if node_key.nil? || !@topology.clients.key?(node_key)
@topology.clients.fetch(node_key)
end
def call_all(method, command, args, &block)
call_multiple_nodes!(@topology.clients, method, command, args, &block)
end
def call_primaries(method, command, args, &block)
call_multiple_nodes!(@topology.primary_clients, method, command, args, &block)
end
def call_replicas(method, command, args, &block)
call_multiple_nodes!(@topology.replica_clients, method, command, args, &block)
end
def send_ping(method, command, args, &block)
result_values, errors = call_multiple_nodes(@topology.clients, method, command, args, &block)
return result_values if errors.nil? || errors.empty?
raise ReloadNeeded if errors.values.any?(::RedisClient::ConnectionError)
raise ::RedisClient::Cluster::ErrorCollection, errors
end
def clients_for_scanning(seed: nil)
@topology.clients_for_scanning(seed: seed).values.sort_by { |c| "#{c.config.host}-#{c.config.port}" }
end
def clients
@topology.clients.values
end
def primary_clients
@topology.primary_clients.values
end
def replica_clients
@topology.replica_clients.values
end
def find_node_key_of_primary(slot)
return if slot.nil?
slot = Integer(slot)
return if slot < MIN_SLOT || slot > MAX_SLOT
@slots[slot]
end
def find_node_key_of_replica(slot, seed: nil)
primary_node_key = find_node_key_of_primary(slot)
@topology.find_node_key_of_replica(primary_node_key, seed: seed)
end
def any_primary_node_key(seed: nil)
@topology.any_primary_node_key(seed: seed)
end
def any_replica_node_key(seed: nil)
@topology.any_replica_node_key(seed: seed)
end
def update_slot(slot, node_key)
return if @mutex.locked?
@mutex.synchronize do
@slots[slot] = node_key
rescue RangeError
@slots = Array.new(SLOT_SIZE) { |i| @slots[i] }
@slots[slot] = node_key
end
end
def reload!
with_reload_lock do
with_startup_clients(MAX_STARTUP_SAMPLE) do |startup_clients|
@node_info = refetch_node_info_list(startup_clients)
@node_configs = @node_info.to_h do |node_info|
[node_info.node_key, @config.client_config_for_node(node_info.node_key)]
end
@slots = build_slot_node_mappings(@node_info)
@replications = build_replication_mappings(@node_info)
@topology.process_topology_update!(@replications, @node_configs)
end
end
end
private
def make_topology_class(with_replica, replica_affinity)
if with_replica && replica_affinity == :random
::RedisClient::Cluster::Node::RandomReplica
elsif with_replica && replica_affinity == :random_with_primary
::RedisClient::Cluster::Node::RandomReplicaOrPrimary
elsif with_replica && replica_affinity == :latency
::RedisClient::Cluster::Node::LatencyReplica
else
::RedisClient::Cluster::Node::PrimaryOnly
end
end
def build_slot_node_mappings(node_info_list)
slots = make_array_for_slot_node_mappings(node_info_list)
node_info_list.each do |info|
next if info.slots.nil? || info.slots.empty?
info.slots.each { |start, last| (start..last).each { |i| slots[i] = info.node_key } }
end
slots
end
def make_array_for_slot_node_mappings(node_info_list)
return Array.new(SLOT_SIZE) if !USE_CHAR_ARRAY_SLOT || node_info_list.count(&:primary?) > 256
primary_node_keys = node_info_list.select(&:primary?).map(&:node_key)
::RedisClient::Cluster::Node::CharArray.new(SLOT_SIZE, primary_node_keys)
end
def build_replication_mappings(node_info_list) # rubocop:disable Metrics/AbcSize
dict = node_info_list.to_h { |info| [info.id, info] }
node_info_list.each_with_object(Hash.new { |h, k| h[k] = [] }) do |info, acc|
primary_info = dict[info.primary_id]
acc[primary_info.node_key] << info.node_key unless primary_info.nil?
acc[info.node_key] if info.primary? # for the primary which have no replicas
end
end
def call_multiple_nodes(clients, method, command, args, &block)
results, errors = try_map(clients) do |_, client|
client.public_send(method, *args, command, &block)
end
[results&.values, errors]
end
def call_multiple_nodes!(clients, method, command, args, &block)
result_values, errors = call_multiple_nodes(clients, method, command, args, &block)
return result_values if errors.nil? || errors.empty?
raise ::RedisClient::Cluster::ErrorCollection, errors
end
def try_map(clients, &block) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
return [{}, {}] if clients.empty?
work_group = @concurrent_worker.new_group(size: clients.size)
clients.each do |node_key, client|
work_group.push(node_key, node_key, client, block) do |nk, cli, blk|
blk.call(nk, cli)
rescue StandardError => e
e
end
end
results = errors = nil
work_group.each do |node_key, v|
case v
when StandardError
errors ||= {}
errors[node_key] = v
else
results ||= {}
results[node_key] = v
end
end
work_group.close
[results, errors]
end
def refetch_node_info_list(startup_clients) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
startup_size = startup_clients.size
work_group = @concurrent_worker.new_group(size: startup_size)
startup_clients.each_with_index do |raw_client, i|
work_group.push(i, raw_client) do |client|
regular_timeout = client.read_timeout
client.read_timeout = @config.slow_command_timeout > 0.0 ? @config.slow_command_timeout : regular_timeout
reply = client.call('CLUSTER', 'NODES')
client.read_timeout = regular_timeout
parse_cluster_node_reply(reply)
rescue StandardError => e
e
ensure
client&.close
end
end
node_info_list = errors = nil
work_group.each do |i, v|
case v
when StandardError
errors ||= Array.new(startup_size)
errors[i] = v
else
node_info_list ||= Array.new(startup_size)
node_info_list[i] = v
end
end
work_group.close
raise ::RedisClient::Cluster::InitialSetupError, errors if node_info_list.nil?
grouped = node_info_list.compact.group_by do |info_list|
info_list.sort_by!(&:id)
info_list.each_with_object(String.new(capacity: 128 * info_list.size)) do |e, a|
a << e.id << e.node_key << e.role << e.primary_id << e.config_epoch
end
end
grouped.max_by { |_, v| v.size }[1].first
end
def parse_cluster_node_reply(reply) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
reply.each_line("\n", chomp: true).filter_map do |line|
fields = line.split
flags = fields[2].split(',')
next unless fields[7] == 'connected' && (flags & DEAD_FLAGS).empty?
slots = if fields[8].nil?
EMPTY_ARRAY
else
fields[8..].reject { |str| str.start_with?('[') }
.map { |str| str.split('-').map { |s| Integer(s) } }
.map { |a| a.size == 1 ? a << a.first : a }
.map(&:sort)
end
::RedisClient::Cluster::Node::Info.new(
id: fields[0],
node_key: parse_node_key(fields[1]),
role: (flags & ROLE_FLAGS).first,
primary_id: fields[3],
ping_sent: fields[4],
pong_recv: fields[5],
config_epoch: fields[6],
link_state: fields[7],
slots: slots
)
end
end
# As redirection node_key is dependent on `cluster-preferred-endpoint-type` config,
# node_key should use hostname if present in CLUSTER NODES output.
#
# See https://redis.io/commands/cluster-nodes/ for details on the output format.
# node_address matches fhe format: <ip:port@cport[,hostname[,auxiliary_field=value]*]>
def parse_node_key(node_address)
ip_chunk, hostname, _auxiliaries = node_address.split(',')
ip_port_string = ip_chunk.split('@').first
return ip_port_string if hostname.nil? || hostname.empty?
port = ip_port_string.split(':')[1]
"#{hostname}:#{port}"
end
def with_startup_clients(count) # rubocop:disable Metrics/AbcSize
if @config.connect_with_original_config
# If connect_with_original_config is set, that means we need to build actual client objects
# and close them, so that we e.g. re-resolve a DNS entry with the cluster nodes in it.
begin
# Memoize the startup clients, so we maintain RedisClient's internal circuit breaker configuration
# if it's set.
@startup_clients ||= @config.startup_nodes.values.sample(count).map do |node_config|
::RedisClient::Cluster::Node::Config.new(**node_config).new_client
end
yield @startup_clients
ensure
# Close the startup clients when we're done, so we don't maintain pointless open connections to
# the cluster though
@startup_clients&.each(&:close)
end
else
# (re-)connect using nodes we already know about.
# If this is the first time we're connecting to the cluster, we need to seed the topology with the
# startup clients though.
@topology.process_topology_update!({}, @config.startup_nodes) if @topology.clients.empty?
yield @topology.clients.values.sample(count)
end
end
def with_reload_lock
# What should happen with concurrent calls #reload? This is a realistic possibility if the cluster goes into
# a CLUSTERDOWN state, and we're using a pooled backend. Every thread will independently discover this, and
# call reload!.
# For now, if a reload is in progress, wait for that to complete, and consider that the same as us having
# performed the reload.
# Probably in the future we should add a circuit breaker to #reload itself, and stop trying if the cluster is
# obviously not working.
wait_start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
@mutex.synchronize do
return if @last_reloaded_at && @last_reloaded_at > wait_start
r = yield
@last_reloaded_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
r
end
end
end
end
end
|