Class: RedisClient::Cluster::Router

Inherits:
Object
  • Object
show all
Defined in:
lib/redis_client/cluster/router.rb

Constant Summary collapse

ZERO_CURSOR_FOR_SCAN = 
'0'
TSF = 
->(f, x) { f.nil? ? x : f.call(x) }.curry

Instance Method Summary collapse

Constructor Details

#initialize(config, concurrent_worker, pool: nil, **kwargs) ⇒ Router

Returns a new instance of Router.



20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/redis_client/cluster/router.rb', line 20

def initialize(config, concurrent_worker, pool: nil, **kwargs)
  @config = config.dup
  @original_config = config.dup if config.connect_with_original_config
  @connect_with_original_config = config.connect_with_original_config
  @concurrent_worker = concurrent_worker
  @pool = pool
  @client_kwargs = kwargs
  @node = ::RedisClient::Cluster::Node.new(concurrent_worker, config: config, pool: pool, **kwargs)
  update_cluster_info!
  @command = ::RedisClient::Cluster::Command.load(@node.replica_clients.shuffle, slow_command_timeout: config.slow_command_timeout)
  @command_builder = @config.command_builder
end

Instance Method Details

#assign_asking_node(err_msg) ⇒ Object 



216
217
218
219
 
# File 'lib/redis_client/cluster/router.rb', line 216

def assign_asking_node(err_msg)
  _, _, node_key = err_msg.split
  find_node(node_key)
end

#assign_node(command) ⇒ Object 



154
155
156
157
 
# File 'lib/redis_client/cluster/router.rb', line 154

def assign_node(command)
  node_key = find_node_key(command)
  find_node(node_key)
end

#assign_redirection_node(err_msg) ⇒ Object 



209
210
211
212
213
214
 
# File 'lib/redis_client/cluster/router.rb', line 209

def assign_redirection_node(err_msg)
  _, slot, node_key = err_msg.split
  slot = slot.to_i
  @node.update_slot(slot, node_key)
  find_node(node_key)
end

#close ⇒ Object 



225
226
227
 
# File 'lib/redis_client/cluster/router.rb', line 225

def close
  @node.each(&:close)
end

#command_exists?(name) ⇒ Boolean

Returns:

  • (Boolean) 


205
206
207
 
# File 'lib/redis_client/cluster/router.rb', line 205

def command_exists?(name)
  @command.exists?(name)
end

#find_node(node_key, retry_count: 3) ⇒ Object 



195
196
197
198
199
200
201
202
203
 
# File 'lib/redis_client/cluster/router.rb', line 195

def find_node(node_key, retry_count: 3)
  @node.find_by(node_key)
rescue ::RedisClient::Cluster::Node::ReloadNeeded
  raise ::RedisClient::Cluster::NodeMightBeDown if retry_count <= 0

  update_cluster_info!
  retry_count -= 1
  retry
end

#find_node_key(command, seed: nil) ⇒ Object 



173
174
175
176
 
# File 'lib/redis_client/cluster/router.rb', line 173

def find_node_key(command, seed: nil)
  key = @command.extract_first_key(command)
  find_node_key_by_key(key, seed: seed, primary: @command.should_send_to_primary?(command))
end

#find_node_key_by_key(key, seed: nil, primary: false) ⇒ Object 



159
160
161
162
163
164
165
166
 
# File 'lib/redis_client/cluster/router.rb', line 159

def find_node_key_by_key(key, seed: nil, primary: false)
  if key && !key.empty?
    slot = ::RedisClient::Cluster::KeySlotConverter.convert(key)
    primary ? @node.find_node_key_of_primary(slot) : @node.find_node_key_of_replica(slot)
  else
    primary ? @node.any_primary_node_key(seed: seed) : @node.any_replica_node_key(seed: seed)
  end
end

#find_primary_node_by_slot(slot) ⇒ Object 



168
169
170
171
 
# File 'lib/redis_client/cluster/router.rb', line 168

def find_primary_node_by_slot(slot)
  node_key = @node.find_node_key_of_primary(slot)
  find_node(node_key)
end

#find_primary_node_key(command) ⇒ Object 



178
179
180
181
182
183
 
# File 'lib/redis_client/cluster/router.rb', line 178

def find_primary_node_key(command)
  key = @command.extract_first_key(command)
  return nil unless key&.size&.> 0

  find_node_key_by_key(key, primary: true)
end

#find_slot(command) ⇒ Object 



185
186
187
 
# File 'lib/redis_client/cluster/router.rb', line 185

def find_slot(command)
  find_slot_by_key(@command.extract_first_key(command))
end

#find_slot_by_key(key) ⇒ Object 



189
190
191
192
193
 
# File 'lib/redis_client/cluster/router.rb', line 189

def find_slot_by_key(key)
  return if key.empty?

  ::RedisClient::Cluster::KeySlotConverter.convert(key)
end

#handle_redirection(node, retry_count:) ⇒ Object

rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity



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
 
# File 'lib/redis_client/cluster/router.rb', line 95

def handle_redirection(node, retry_count:) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
  yield node
rescue ::RedisClient::CircuitBreaker::OpenCircuitError
  raise
rescue ::RedisClient::CommandError => e
  raise unless ErrorIdentification.client_owns_error?(e, node)

  if e.message.start_with?('MOVED')
    node = assign_redirection_node(e.message)
    retry_count -= 1
    retry if retry_count >= 0
  elsif e.message.start_with?('ASK')
    node = assign_asking_node(e.message)
    retry_count -= 1
    if retry_count >= 0
      node.call('ASKING')
      retry
    end
  elsif e.message.start_with?('CLUSTERDOWN Hash slot not served')
    update_cluster_info!
    retry_count -= 1
    retry if retry_count >= 0
  end
  raise
rescue ::RedisClient::ConnectionError => e
  raise unless ErrorIdentification.client_owns_error?(e, node)

  update_cluster_info!

  raise if retry_count <= 0

  retry_count -= 1
  retry
end

#node_keys ⇒ Object 



221
222
223
 
# File 'lib/redis_client/cluster/router.rb', line 221

def node_keys
  @node.node_keys
end

#scan(*command, seed: nil, **kwargs) ⇒ Object

rubocop:disable Metrics/AbcSize



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/redis_client/cluster/router.rb', line 130

def scan(*command, seed: nil, **kwargs) # rubocop:disable Metrics/AbcSize
  command = @command_builder.generate(command, kwargs)

  command[1] = ZERO_CURSOR_FOR_SCAN if command.size == 1
  input_cursor = Integer(command[1])

  client_index = input_cursor % 256
  raw_cursor = input_cursor >> 8

  clients = @node.clients_for_scanning(seed: seed)

  client = clients[client_index]
  return [ZERO_CURSOR_FOR_SCAN, []] unless client

  command[1] = raw_cursor.to_s

  result_cursor, result_keys = client.call_v(command)
  result_cursor = Integer(result_cursor)

  client_index += 1 if result_cursor == 0

  [((result_cursor << 8) + client_index).to_s, result_keys]
end

#send_command(method, command, *args, &block) ⇒ Object

rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity



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
 
# File 'lib/redis_client/cluster/router.rb', line 33

def send_command(method, command, *args, &block) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
  cmd = ::RedisClient::Cluster::NormalizedCmdName.instance.get_by_command(command)
  case cmd
  when 'ping'     then @node.send_ping(method, command, args).first.then(&TSF.call(block))
  when 'wait'     then send_wait_command(method, command, args, &block)
  when 'keys'     then @node.call_replicas(method, command, args).flatten.sort_by(&:to_s).then(&TSF.call(block))
  when 'dbsize'   then @node.call_replicas(method, command, args).select { |e| e.is_a?(Integer) }.sum.then(&TSF.call(block))
  when 'scan'     then scan(command, seed: 1)
  when 'lastsave' then @node.call_all(method, command, args).sort_by(&:to_i).then(&TSF.call(block))
  when 'role'     then @node.call_all(method, command, args, &block)
  when 'config'   then send_config_command(method, command, args, &block)
  when 'client'   then send_client_command(method, command, args, &block)
  when 'cluster'  then send_cluster_command(method, command, args, &block)
  when 'memory'   then send_memory_command(method, command, args, &block)
  when 'script'   then send_script_command(method, command, args, &block)
  when 'pubsub'   then send_pubsub_command(method, command, args, &block)
  when 'watch'    then send_watch_command(command, &block)
  when 'acl', 'auth', 'bgrewriteaof', 'bgsave', 'quit', 'save'
    @node.call_all(method, command, args).first.then(&TSF.call(block))
  when 'flushall', 'flushdb'
    @node.call_primaries(method, command, args).first.then(&TSF.call(block))
  when 'readonly', 'readwrite', 'shutdown'
    raise ::RedisClient::Cluster::OrchestrationCommandNotSupported, cmd
  when 'discard', 'exec', 'multi', 'unwatch'
    raise ::RedisClient::Cluster::AmbiguousNodeError, cmd
  else
    node = assign_node(command)
    try_send(node, method, command, args, &block)
  end
rescue ::RedisClient::CircuitBreaker::OpenCircuitError
  raise
rescue ::RedisClient::Cluster::Node::ReloadNeeded
  update_cluster_info!
  raise ::RedisClient::Cluster::NodeMightBeDown
rescue ::RedisClient::Cluster::ErrorCollection => e
  raise if e.errors.any?(::RedisClient::CircuitBreaker::OpenCircuitError)

  update_cluster_info! if e.errors.values.any? do |err|
    @node.owns_error?(err) && err.message.start_with?('CLUSTERDOWN Hash slot not served')
  end

  raise
end

#try_delegate(node, method, *args, retry_count: 3, **kwargs, &block) ⇒ Object 



89
90
91
92
93
 
# File 'lib/redis_client/cluster/router.rb', line 89

def try_delegate(node, method, *args, retry_count: 3, **kwargs, &block)
  handle_redirection(node, retry_count: retry_count) do |on_node|
    on_node.public_send(method, *args, **kwargs, &block)
  end
end

#try_send(node, method, command, args, retry_count: 3, &block) ⇒ Object

See Also:



78
79
80
81
82
83
84
85
86
87
 
# File 'lib/redis_client/cluster/router.rb', line 78

def try_send(node, method, command, args, retry_count: 3, &block)
  handle_redirection(node, retry_count: retry_count) do |on_node|
    if args.empty?
      # prevent memory allocation for variable-length args
      on_node.public_send(method, command, &block)
    else
      on_node.public_send(method, *args, command, &block)
    end
  end
end