Module: Gitlab::Cache::RequestCache

Included in:
Commit, UserAccess, UserAccessSnippet, Issuables::LabelFilter, Project
Defined in:
lib/gitlab/cache/request_cache.rb

Overview

See docs.gitlab.com/ee/development/utilities.html#requestcache

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#request_cache_key_block ⇒ Object

Returns the value of attribute request_cache_key_block.



15
16
17
 
# File 'lib/gitlab/cache/request_cache.rb', line 15

def request_cache_key_block
  @request_cache_key_block
end

Class Method Details

.extended(klass) ⇒ Object 



7
8
9
10
11
12
13
 
# File 'lib/gitlab/cache/request_cache.rb', line 7

def self.extended(klass)
  return if klass < self

  extension = Module.new
  klass.const_set(:RequestCacheExtension, extension)
  klass.prepend(extension)
end

Instance Method Details

#request_cache(method_name, &method_key_block) ⇒ Object 



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
 
# File 'lib/gitlab/cache/request_cache.rb', line 25

def request_cache(method_name, &method_key_block)
  const_get(:RequestCacheExtension, false).module_eval do
    cache_key_method_name = "#{method_name}_cache_key"

    define_method(method_name) do |*args|
      store =
        if Gitlab::SafeRequestStore.active?
          Gitlab::SafeRequestStore.store
        else
          ivar_name = # ! and ? cannot be used as ivar name
            "@cache_#{method_name.to_s.tr('!?', "\u2605\u2606")}"

          instance_variable_get(ivar_name) ||
            instance_variable_set(ivar_name, {})
        end

      key = __send__(cache_key_method_name, args) # rubocop:disable GitlabSecurity/PublicSend

      store.fetch(key) { store[key] = super(*args) }
    end

    define_method(cache_key_method_name) do |args|
      klass = self.class

      instance_key = instance_exec(&klass.request_cache_key) if
        klass.request_cache_key

      method_key = instance_exec(&method_key_block) if method_key_block

      [klass.name, method_name, *instance_key, *method_key, *args]
        .join(':')
    end

    private cache_key_method_name # rubocop: disable Style/AccessModifierDeclarations
  end
end

#request_cache_key(&block) ⇒ Object 



17
18
19
20
21
22
23
 
# File 'lib/gitlab/cache/request_cache.rb', line 17

def request_cache_key(&block)
  if block
    self.request_cache_key_block = block
  else
    request_cache_key_block
  end
end