Module: RedisClient::Config::Common

Included in:
RedisClient::Config, SentinelConfig
Defined in:
lib/redis_client/config.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#circuit_breaker ⇒ Object (readonly)

Returns the value of attribute circuit_breaker.



15
16
17
 
# File 'lib/redis_client/config.rb', line 15

def circuit_breaker
  @circuit_breaker
end

#command_builder ⇒ Object (readonly)

Returns the value of attribute command_builder.



15
16
17
 
# File 'lib/redis_client/config.rb', line 15

def command_builder
  @command_builder
end

#connect_timeout ⇒ Object (readonly)

Returns the value of attribute connect_timeout.



15
16
17
 
# File 'lib/redis_client/config.rb', line 15

def connect_timeout
  @connect_timeout
end

#custom ⇒ Object (readonly)

Returns the value of attribute custom.



15
16
17
 
# File 'lib/redis_client/config.rb', line 15

def custom
  @custom
end

#db ⇒ Object (readonly)

Returns the value of attribute db.



15
16
17
 
# File 'lib/redis_client/config.rb', line 15

def db
  @db
end

#driver ⇒ Object (readonly)

Returns the value of attribute driver.



15
16
17
 
# File 'lib/redis_client/config.rb', line 15

def driver
  @driver
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



15
16
17
 
# File 'lib/redis_client/config.rb', line 15

def id
  @id
end

#inherit_socket ⇒ Object (readonly)

Returns the value of attribute inherit_socket.



15
16
17
 
# File 'lib/redis_client/config.rb', line 15

def inherit_socket
  @inherit_socket
end

#middlewares_stack ⇒ Object (readonly)

Returns the value of attribute middlewares_stack.



15
16
17
 
# File 'lib/redis_client/config.rb', line 15

def middlewares_stack
  @middlewares_stack
end

#protocol ⇒ Object (readonly)

Returns the value of attribute protocol.



15
16
17
 
# File 'lib/redis_client/config.rb', line 15

def protocol
  @protocol
end

#read_timeout ⇒ Object (readonly)

Returns the value of attribute read_timeout.



15
16
17
 
# File 'lib/redis_client/config.rb', line 15

def read_timeout
  @read_timeout
end

#ssl ⇒ Object (readonly) Also known as: ssl?

Returns the value of attribute ssl.



15
16
17
 
# File 'lib/redis_client/config.rb', line 15

def ssl
  @ssl
end

#ssl_params ⇒ Object (readonly)

Returns the value of attribute ssl_params.



15
16
17
 
# File 'lib/redis_client/config.rb', line 15

def ssl_params
  @ssl_params
end

#write_timeout ⇒ Object (readonly)

Returns the value of attribute write_timeout.



15
16
17
 
# File 'lib/redis_client/config.rb', line 15

def write_timeout
  @write_timeout
end

Instance Method Details

#connection_prelude ⇒ Object 



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
 
# File 'lib/redis_client/config.rb', line 89

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

  # 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

#initialize(username: nil, password: nil, db: nil, id: nil, timeout: DEFAULT_TIMEOUT, read_timeout: timeout, write_timeout: timeout, connect_timeout: 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) ⇒ Object 



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
 
# File 'lib/redis_client/config.rb', line 21

def initialize(
  username: nil,
  password: nil,
  db: nil,
  id: nil,
  timeout: DEFAULT_TIMEOUT,
  read_timeout: timeout,
  write_timeout: timeout,
  connect_timeout: 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
)
  @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

  @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
end

#new_client(**kwargs) ⇒ Object 



139
140
141
 
# File 'lib/redis_client/config.rb', line 139

def new_client(**kwargs)
  @client_implementation.new(self, **kwargs)
end

#new_pool(**kwargs) ⇒ Object 



134
135
136
137
 
# File 'lib/redis_client/config.rb', line 134

def new_pool(**kwargs)
  kwargs[:timeout] ||= DEFAULT_TIMEOUT
  Pooled.new(self, **kwargs)
end

#password ⇒ Object 



118
119
120
 
# File 'lib/redis_client/config.rb', line 118

def password
  @password&.call(username)
end

#resolved? ⇒ Boolean

Returns:

  • (Boolean) 


126
127
128
 
# File 'lib/redis_client/config.rb', line 126

def resolved?
  true
end

#retriable?(attempt) ⇒ Boolean

Returns:

  • (Boolean) 


143
144
145
 
# File 'lib/redis_client/config.rb', line 143

def retriable?(attempt)
  @reconnect_attempts && @reconnect_attempts[attempt]
end

#retry_connecting?(attempt, _error) ⇒ Boolean

Returns:

  • (Boolean) 


147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/redis_client/config.rb', line 147

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

#sentinel? ⇒ Boolean

Returns:

  • (Boolean) 


130
131
132
 
# File 'lib/redis_client/config.rb', line 130

def sentinel?
  false
end

#server_url ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/redis_client/config.rb', line 165

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

#ssl_context ⇒ Object 



159
160
161
162
163
 
# File 'lib/redis_client/config.rb', line 159

def ssl_context
  if ssl
    @ssl_context ||= @driver.ssl_context(@ssl_params || {})
  end
end

#username ⇒ Object 



122
123
124
 
# File 'lib/redis_client/config.rb', line 122

def username
  @username || DEFAULT_USERNAME
end