lib/gitlab/safe_request_loader.rb


1
2
3
4
5
6
7
8
9
10
11
12
13
14
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
54
55

# frozen_string_literal: true

module Gitlab
  class SafeRequestLoader
    def self.execute(args, &block)
      new(**args).execute(&block)
    end

    def initialize(resource_key:, resource_ids:, default_value: nil)
      @resource_key = resource_key
      @resource_ids = resource_ids.uniq
      @default_value = default_value
      @resource_data = {}
    end

    def execute(&block)
      raise ArgumentError, 'Block is mandatory' unless block_given?

      load_resource_data
      remove_loaded_resource_ids

      update_resource_data(&block)

      resource_data
    end

    private

    attr_reader :resource_key, :resource_ids, :default_value, :resource_data, :missing_resource_ids

    def load_resource_data
      @resource_data = Gitlab::SafeRequestStore.fetch(resource_key) { resource_data }
    end

    def remove_loaded_resource_ids
      # Look up only the IDs we need
      @missing_resource_ids = resource_ids - resource_data.keys
    end

    def update_resource_data(&block)
      return if missing_resource_ids.blank?

      reloaded_resource_data = yield(missing_resource_ids)

      @resource_data.merge!(reloaded_resource_data)

      mark_absent_values
    end

    def mark_absent_values
      absent = (missing_resource_ids - resource_data.keys).to_h { [_1, default_value] }
      @resource_data.merge!(absent)
    end
  end
end