summaryrefslogtreecommitdiff
path: root/lib/gitlab/ci/yaml_processor/feature_flags.rb
blob: f03db9d0e6bb363303cf6cdc54cee35247d9a30b (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
# frozen_string_literal: true

module Gitlab
  module Ci
    class YamlProcessor
      module FeatureFlags
        ACTOR_KEY = 'ci_yaml_processor_feature_flag_actor'
        NO_ACTOR_VALUE = :no_actor

        NoActorError = Class.new(StandardError)
        NO_ACTOR_MESSAGE = "Actor not set. Ensure to call `enabled?` inside `with_actor` block"

        class << self
          # Cache a feature flag actor as thread local variable so
          # we can have it available later with #enabled?
          def with_actor(actor)
            previous = Thread.current[ACTOR_KEY]

            # When actor is `nil` the method `Thread.current[]=` does not
            # create the ACTOR_KEY. Instead, we want to still save an explicit
            # value to know that we are within the `with_actor` block.
            Thread.current[ACTOR_KEY] = actor || NO_ACTOR_VALUE

            yield
          ensure
            Thread.current[ACTOR_KEY] = previous
          end

          # Use this to check if a feature flag is enabled
          def enabled?(feature_flag)
            ::Feature.enabled?(feature_flag, current_actor)
          end

          private

          def current_actor
            value = Thread.current[ACTOR_KEY] || (raise NoActorError, NO_ACTOR_MESSAGE)
            return if value == NO_ACTOR_VALUE

            value
          rescue NoActorError => e
            Gitlab::ErrorTracking.track_and_raise_for_dev_exception(e)

            nil
          end
        end
      end
    end
  end
end