summaryrefslogtreecommitdiff
path: root/lib/gitlab/database/load_balancing/sidekiq_server_middleware.rb
blob: 9bd0adf8dbd640543eae2c2b3233a1c64c9e29b0 (plain)
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# frozen_string_literal: true

module Gitlab
  module Database
    module LoadBalancing
      class SidekiqServerMiddleware
        JobReplicaNotUpToDate = Class.new(StandardError)

        def call(worker, job, _queue)
          if requires_primary?(worker.class, job)
            Session.current.use_primary!
          end

          yield
        ensure
          clear
        end

        private

        def clear
          load_balancer.release_host
          Session.clear_session
        end

        def requires_primary?(worker_class, job)
          return true unless worker_class.include?(::ApplicationWorker)
          return true unless worker_class.utilizes_load_balancing_capabilities?
          return true unless worker_class.get_data_consistency_feature_flag_enabled?

          location = job['database_write_location'] || job['database_replica_location']

          return true unless location

          job_data_consistency = worker_class.get_data_consistency
          job[:data_consistency] = job_data_consistency.to_s

          if replica_caught_up?(location)
            job[:database_chosen] = 'replica'
            false
          elsif job_data_consistency == :delayed && not_yet_retried?(job)
            job[:database_chosen] = 'retry'
            raise JobReplicaNotUpToDate, "Sidekiq job #{worker_class} JID-#{job['jid']} couldn't use the replica."\
               "  Replica was not up to date."
          else
            job[:database_chosen] = 'primary'
            true
          end
        end

        def not_yet_retried?(job)
          # if `retry_count` is `nil` it indicates that this job was never retried
          # the `0` indicates that this is a first retry
          job['retry_count'].nil?
        end

        def load_balancer
          LoadBalancing.proxy.load_balancer
        end

        def replica_caught_up?(location)
          if Feature.enabled?(:sidekiq_load_balancing_rotate_up_to_date_replica)
            load_balancer.select_up_to_date_host(location)
          else
            load_balancer.host.caught_up?(location)
          end
        end
      end
    end
  end
end