Module: Gitlab::Cache::Import::Caching

Defined in:
lib/gitlab/cache/import/caching.rb

Constant Summary collapse

TIMEOUT =

The default timeout of the cache keys.

24.hours.to_i
LONGER_TIMEOUT =
72.hours.to_i
SHORTER_TIMEOUT =
15.minutes.to_i
WRITE_IF_GREATER_SCRIPT =
<<-EOF.strip_heredoc.freeze
local key, value, ttl = KEYS[1], tonumber(ARGV[1]), ARGV[2]
local existing = tonumber(redis.call("get", key))

if existing == nil or value > existing then
  redis.call("set", key, value)
  redis.call("expire", key, ttl)
  return true
else
  return false
end
EOF

Class Method Summary collapse

Class Method Details

.cache_key_for(raw_key) ⇒ Object


226
227
228
# File 'lib/gitlab/cache/import/caching.rb', line 226

def self.cache_key_for(raw_key)
  "#{Redis::Cache::CACHE_NAMESPACE}:#{raw_key}"
end

.expire(raw_key, timeout) ⇒ Object

Sets the expiration time of a key.

raw_key - The key for which to change the timeout. timeout - The new timeout.


170
171
172
173
174
175
176
# File 'lib/gitlab/cache/import/caching.rb', line 170

def self.expire(raw_key, timeout)
  key = cache_key_for(raw_key)

  Redis::Cache.with do |redis|
    redis.expire(key, timeout)
  end
end

.hash_add(raw_key, field, value, timeout: TIMEOUT) ⇒ Object

Adds a value to a hash.

raw_key - The key of the hash to add to. field - The field to add to the hash. value - The field value to add to the hash. timeout - The new timeout of the key.


204
205
206
207
208
209
210
211
212
213
# File 'lib/gitlab/cache/import/caching.rb', line 204

def self.hash_add(raw_key, field, value, timeout: TIMEOUT)
  key = cache_key_for(raw_key)

  Redis::Cache.with do |redis|
    redis.multi do |m|
      m.hset(key, field, value)
      m.expire(key, timeout)
    end
  end
end

.increment(raw_key, timeout: TIMEOUT) ⇒ Object

Increment the integer value of a key by one. Sets the value to zero if missing before incrementing

raw_key - The cache key to increment. timeout - The time after which the cache key should expire.

Returns:

    • the incremented value


83
84
85
86
87
88
89
90
91
92
# File 'lib/gitlab/cache/import/caching.rb', line 83

def self.increment(raw_key, timeout: TIMEOUT)
  key = cache_key_for(raw_key)

  Redis::Cache.with do |redis|
    value = redis.incr(key)
    redis.expire(key, timeout)

    value
  end
end

.increment_by(raw_key, value, timeout: TIMEOUT) ⇒ Object

Increment the integer value of a key by the given value. Sets the value to zero if missing before incrementing

raw_key - The cache key to increment. value - The value to increment the key timeout - The time after which the cache key should expire.

Returns:

    • the incremented value


101
102
103
104
105
106
107
108
# File 'lib/gitlab/cache/import/caching.rb', line 101

def self.increment_by(raw_key, value, timeout: TIMEOUT)
  key = cache_key_for(raw_key)

  Redis::Cache.with do |redis|
    redis.incrby(key, value)
    redis.expire(key, timeout)
  end
end

.read(raw_key, timeout: TIMEOUT) ⇒ Object

Reads a cache key.

If the key exists and has a non-empty value its TTL is refreshed automatically.

raw_key - The cache key to read. timeout - The new timeout of the key if the key is to be refreshed.


34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# File 'lib/gitlab/cache/import/caching.rb', line 34

def self.read(raw_key, timeout: TIMEOUT)
  key = cache_key_for(raw_key)
  value = Redis::Cache.with { |redis| redis.get(key) }

  if value.present?
    # We refresh the expiration time so frequently used keys stick
    # around, removing the need for querying the database as much as
    # possible.
    #
    # A key may be empty when we looked up a GitHub user (for example) but
    # did not find a matching GitLab user. In that case we _don't_ want to
    # refresh the TTL so we automatically pick up the right data when said
    # user were to register themselves on the GitLab instance.
    Redis::Cache.with { |redis| redis.expire(key, timeout) }
  end

  value
end

.read_integer(raw_key, timeout: TIMEOUT) ⇒ Object

Reads an integer from the cache, or returns nil if no value was found.

See Caching.read for more information.


56
57
58
59
60
# File 'lib/gitlab/cache/import/caching.rb', line 56

def self.read_integer(raw_key, timeout: TIMEOUT)
  value = read(raw_key, timeout: timeout)

  value.to_i if value.present?
end

.set_add(raw_key, value, timeout: TIMEOUT) ⇒ Object

Adds a value to a set.

raw_key - The key of the set to add the value to. value - The value to add to the set. timeout - The new timeout of the key.


115
116
117
118
119
120
121
122
123
124
# File 'lib/gitlab/cache/import/caching.rb', line 115

def self.set_add(raw_key, value, timeout: TIMEOUT)
  key = cache_key_for(raw_key)

  Redis::Cache.with do |redis|
    redis.multi do |m|
      m.sadd(key, value)
      m.expire(key, timeout)
    end
  end
end

.set_includes?(raw_key, value) ⇒ Boolean

Returns true if the given value is present in the set.

raw_key - The key of the set to check. value - The value to check for.

Returns:

  • (Boolean)

130
131
132
133
134
135
136
# File 'lib/gitlab/cache/import/caching.rb', line 130

def self.set_includes?(raw_key, value)
  key = cache_key_for(raw_key)

  Redis::Cache.with do |redis|
    redis.sismember(key, value)
  end
end

.values_from_hash(raw_key) ⇒ Object

Returns the values of the given hash.

raw_key - The key of the set to check.


218
219
220
221
222
223
224
# File 'lib/gitlab/cache/import/caching.rb', line 218

def self.values_from_hash(raw_key)
  key = cache_key_for(raw_key)

  Redis::Cache.with do |redis|
    redis.hgetall(key)
  end
end

.values_from_set(raw_key) ⇒ Object

Returns the values of the given set.

raw_key - The key of the set to check.


141
142
143
144
145
146
147
# File 'lib/gitlab/cache/import/caching.rb', line 141

def self.values_from_set(raw_key)
  key = cache_key_for(raw_key)

  Redis::Cache.with do |redis|
    redis.smembers(key)
  end
end

.write(raw_key, value, timeout: TIMEOUT) ⇒ Object

Sets a cache key to the given value.

raw_key - The cache key to write. value - The value to set. timeout - The time after which the cache key should expire.


67
68
69
70
71
72
73
74
75
# File 'lib/gitlab/cache/import/caching.rb', line 67

def self.write(raw_key, value, timeout: TIMEOUT)
  key = cache_key_for(raw_key)

  Redis::Cache.with do |redis|
    redis.set(key, value, ex: timeout)
  end

  value
end

.write_if_greater(raw_key, value, timeout: TIMEOUT) ⇒ Object

Sets a key to the given integer but only if the existing value is smaller than the given value.

This method uses a Lua script to ensure the read and write are atomic.

raw_key - The key to set. value - The new value for the key. timeout - The key timeout in seconds.

Returns true when the key was overwritten, false otherwise.


188
189
190
191
192
193
194
195
196
# File 'lib/gitlab/cache/import/caching.rb', line 188

def self.write_if_greater(raw_key, value, timeout: TIMEOUT)
  key = cache_key_for(raw_key)
  val = Redis::Cache.with do |redis|
    redis
      .eval(WRITE_IF_GREATER_SCRIPT, keys: [key], argv: [value, timeout])
  end

  val ? true : false
end

.write_multiple(mapping, key_prefix: nil, timeout: TIMEOUT) ⇒ Object

Sets multiple keys to given values.

mapping - A Hash mapping the cache keys to their values. key_prefix - prefix inserted before each key timeout - The time after which the cache key should expire.


154
155
156
157
158
159
160
161
162
163
164
# File 'lib/gitlab/cache/import/caching.rb', line 154

def self.write_multiple(mapping, key_prefix: nil, timeout: TIMEOUT)
  Redis::Cache.with do |redis|
    redis.pipelined do |multi|
      mapping.each do |raw_key, value|
        key = cache_key_for("#{key_prefix}#{raw_key}")

        multi.set(key, value, ex: timeout)
      end
    end
  end
end