Module: Legion::Cache::Memcached

Extended by:
Memcached, Logging::Helper
Includes:
Pool
Included in:
Memcached
Defined in:
lib/legion/cache/memcached.rb

Instance Method Summary collapse

Methods included from Pool

#available, #close, #connected?, #pool_size, #restart, #size, #timeout

Instance Method Details

#client(server: nil, servers: nil, pool_size: nil, timeout: nil, username: nil, password: nil, logger: nil, **opts) ⇒ Object

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



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
 
# File 'lib/legion/cache/memcached.rb', line 15

def client(server: nil, servers: nil, pool_size: nil, timeout: nil, # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity,Metrics/ParameterLists
           username: nil, password: nil, logger: nil, **opts)
  return @client unless @client.nil?

  settings = defined?(Legion::Settings) ? Legion::Settings[:cache] : {}
  servers ||= settings[:servers] || []
  @component_logger = logger || log

  @pool_size = pool_size || settings[:pool_size] || 10
  @timeout = timeout || settings[:timeout] || 5

  resolved = Legion::Cache::Settings.resolve_servers(
    driver: 'memcached', server: server, servers: Array(servers)
  )

  Dalli.logger = log
  cache_opts = settings.merge(opts)
  cache_opts[:value_max_bytes] ||= 8 * 1024 * 1024
  cache_opts[:serializer] ||= Legion::JSON
  cache_opts[:username] = username unless username.nil?
  cache_opts[:password] = password unless password.nil?

  tls_ctx = memcached_tls_context(port: resolved.first.split(':').last.to_i)
  cache_opts[:ssl_context] = tls_ctx if tls_ctx

  checkout_timeout = opts[:pool_checkout_timeout] || settings[:pool_checkout_timeout] || @timeout
  @client = ConnectionPool.new(size: @pool_size, timeout: checkout_timeout) do
    Dalli::Client.new(resolved, cache_opts)
  end

  @connected = true
  log.info "Memcached connected to #{resolved.join(', ')}"
  @client
rescue StandardError => e
  handle_exception(e, level: :error, handled: false, operation: :memcached_client,
                      server: server, servers: Array(servers))
  @connected = false
  raise
end

#delete(key) ⇒ Object 



103
104
105
 
# File 'lib/legion/cache/memcached.rb', line 103

def delete(key, **)
  delete_sync(key)
end

#delete_sync(key) ⇒ Object 



107
108
109
110
111
112
113
114
 
# File 'lib/legion/cache/memcached.rb', line 107

def delete_sync(key)
  result = client.with { |conn| conn.delete(key) == true }
  log.debug { "[cache] DELETE #{key} success=#{result}" }
  result
rescue StandardError => e
  handle_exception(e, level: :error, handled: false, operation: :memcached_delete_sync, key: key)
  raise
end

#fetch(key, ttl: nil) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/legion/cache/memcached.rb', line 64

def fetch(key, ttl: nil, &)
  result = client.with do |conn|
    if block_given?
      conn.fetch(key, ttl, &)
    else
      conn.fetch(key, ttl)
    end
  end
  log.debug { "[cache] FETCH #{key} hit=#{!result.nil?}" }
  result
rescue StandardError => e
  handle_exception(e, level: :warn, handled: true, operation: :memcached_fetch, key: key, ttl: ttl)
  nil
end

#flush ⇒ Object 



116
117
118
119
120
121
122
123
 
# File 'lib/legion/cache/memcached.rb', line 116

def flush
  result = client.with { |conn| conn.flush.first }
  log.debug { '[cache] FLUSH completed' }
  result
rescue StandardError => e
  handle_exception(e, level: :warn, handled: true, operation: :memcached_flush)
  nil
end

#get(key) ⇒ Object 



55
56
57
58
59
60
61
62
 
# File 'lib/legion/cache/memcached.rb', line 55

def get(key)
  result = client.with { |conn| conn.get(key) }
  log.debug { "[cache] GET #{key} hit=#{!result.nil?}" }
  result
rescue StandardError => e
  handle_exception(e, level: :warn, handled: true, operation: :memcached_get, key: key)
  nil
end

#mget(*keys) ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/legion/cache/memcached.rb', line 125

def mget(*keys)
  keys = keys.flatten
  return {} if keys.empty?

  result = client.with { |conn| conn.get_multi(*keys) }
  log.debug { "[cache] MGET keys=#{keys.size} hits=#{result.size}" }
  result
rescue StandardError => e
  handle_exception(e, level: :warn, handled: true, operation: :memcached_mget, key_count: keys.size)
  {}
end

#mset(hash, ttl: nil) ⇒ Object 



137
138
139
 
# File 'lib/legion/cache/memcached.rb', line 137

def mset(hash, ttl: nil, **)
  mset_sync(hash, ttl: ttl)
end

#mset_sync(hash, ttl: nil) ⇒ Object

rubocop:disable Lint/UnusedMethodArgument



141
142
143
144
145
146
147
148
149
150
 
# File 'lib/legion/cache/memcached.rb', line 141

def mset_sync(hash, ttl: nil, **) # rubocop:disable Lint/UnusedMethodArgument
  return true if hash.empty?

  client.with { |conn| conn.set_multi(hash) }
  log.debug { "[cache] MSET keys=#{hash.size}" }
  true
rescue StandardError => e
  handle_exception(e, level: :error, handled: false, operation: :memcached_mset_sync, key_count: hash.size)
  raise
end

#set(key, value, ttl: nil) ⇒ Object 



89
90
91
 
# File 'lib/legion/cache/memcached.rb', line 89

def set(key, value, ttl: nil, **)
  set_sync(key, value, ttl: ttl, **)
end

#set_nx(key, value, ttl: nil) ⇒ Object 



79
80
81
82
83
84
85
86
87
 
# File 'lib/legion/cache/memcached.rb', line 79

def set_nx(key, value, ttl: nil)
  effective_ttl = ttl || default_ttl
  result = client.with { |conn| conn.add(key, value, effective_ttl) == true }
  log.debug { "[cache] SET_NX #{key} ttl=#{effective_ttl.inspect} result=#{result}" }
  result
rescue StandardError => e
  handle_exception(e, level: :error, handled: false, operation: :memcached_set_nx, key: key, ttl: effective_ttl)
  raise
end

#set_sync(key, value, ttl: nil) ⇒ Object 



93
94
95
96
97
98
99
100
101
 
# File 'lib/legion/cache/memcached.rb', line 93

def set_sync(key, value, ttl: nil, **)
  effective_ttl = ttl || default_ttl
  result = client.with { |conn| conn.set(key, value, effective_ttl).positive? }
  log.debug { "[cache] SET #{key} ttl=#{effective_ttl} success=#{result} value_class=#{value.class}" }
  result
rescue StandardError => e
  handle_exception(e, level: :error, handled: false, operation: :memcached_set_sync, key: key, ttl: effective_ttl)
  raise
end