Class: Gitlab::Experiment

Inherits:
Object
  • Object
show all
Includes:
Caching, Callbacks, Scientist::Experiment
Defined in:
lib/gitlab/experiment.rb,
lib/gitlab/experiment/dsl.rb,
lib/gitlab/experiment/rspec.rb,
lib/gitlab/experiment/engine.rb,
lib/gitlab/experiment/caching.rb,
lib/gitlab/experiment/context.rb,
lib/gitlab/experiment/cookies.rb,
lib/gitlab/experiment/variant.rb,
lib/gitlab/experiment/version.rb,
lib/gitlab/experiment/callbacks.rb,
lib/gitlab/experiment/configuration.rb

Defined Under Namespace

Modules: Caching, Callbacks, Cookies, Dsl, RSpecHelpers, RSpecMatchers Classes: Configuration, Context, Engine, Variant

Constant Summary collapse

VERSION = 
'0.4.9'

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Caching

#cache_key, #cache_variant

Constructor Details

#initialize(name = nil, variant_name = nil, **context) {|_self| ... } ⇒ Experiment

Returns a new instance of Experiment.

Yields:

  • (_self)

Yield Parameters:

Raises:

  • (ArgumentError) 


57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/gitlab/experiment.rb', line 57

def initialize(name = nil, variant_name = nil, **context)
  raise ArgumentError, 'name is required' if name.blank? && self.class.base?

  @name = self.class.experiment_name(name, suffix: false)
  @context = Context.new(self, **context)
  @variant_name = cache_variant(variant_name) { nil } if variant_name.present?

  compare { false }

  yield self if block_given?
end

Class Method Details

.base? ⇒ Boolean

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/gitlab/experiment.rb', line 44

def base?
  self == Gitlab::Experiment || name == Configuration.base_class
end

.configure {|Configuration| ... } ⇒ Object

Yields:



25
26
27
 
# File 'lib/gitlab/experiment.rb', line 25

def configure
  yield Configuration
end

.experiment_name(name = nil, suffix: true, suffix_word: 'experiment') ⇒ Object 



38
39
40
41
42
 
# File 'lib/gitlab/experiment.rb', line 38

def experiment_name(name = nil, suffix: true, suffix_word: 'experiment')
  name = (name.presence || self.name).to_s.underscore.sub(%r{(?<char>[_/]|)#{suffix_word}$}, '')
  name = "#{name}#{Regexp.last_match(:char) || '_'}#{suffix_word}"
  suffix ? name : name.sub(/_#{suffix_word}$/, '')
end

.run(name = nil, variant_name = nil, **context, &block) ⇒ Object

Raises:

  • (ArgumentError) 


29
30
31
32
33
34
35
36
 
# File 'lib/gitlab/experiment.rb', line 29

def run(name = nil, variant_name = nil, **context, &block)
  raise ArgumentError, 'name is required' if name.nil? && base?

  instance = constantize(name).new(name, variant_name, **context, &block)
  return instance unless block

  instance.context.frozen? ? instance.run : instance.tap(&:run)
end

Instance Method Details

#behaviors ⇒ Object 



128
129
130
131
132
133
134
135
 
# File 'lib/gitlab/experiment.rb', line 128

def behaviors
  @behaviors ||= public_methods.each_with_object(super) do |name, behaviors|
    next unless name.end_with?('_behavior')

    behavior_name = name.to_s.sub(/_behavior$/, '')
    behaviors[behavior_name] ||= -> { send(name) } # rubocop:disable GitlabSecurity/PublicSend
  end
end

#context(value = nil) ⇒ Object 



73
74
75
76
77
78
 
# File 'lib/gitlab/experiment.rb', line 73

def context(value = nil)
  return @context if value.blank?

  @context.value(value)
  @context
end

#enabled? ⇒ Boolean

Returns:

  • (Boolean) 


155
156
157
 
# File 'lib/gitlab/experiment.rb', line 155

def enabled?
  true
end

#excluded? ⇒ Boolean

Returns:

  • (Boolean) 


159
160
161
162
 
# File 'lib/gitlab/experiment.rb', line 159

def excluded?
  @excluded ||= !@context.trackable? || # adhere to DNT headers
    !run_callbacks(:exclusion_check) { :not_excluded } # didn't pass exclusion check
end

#flipper_id ⇒ Object 



151
152
153
 
# File 'lib/gitlab/experiment.rb', line 151

def flipper_id
  "Experiment;#{id}"
end

#id ⇒ Object Also known as: session_id 



146
147
148
 
# File 'lib/gitlab/experiment.rb', line 146

def id
  "#{name}:#{key_for(context.value)}"
end

#inspect ⇒ Object 



69
70
71
 
# File 'lib/gitlab/experiment.rb', line 69

def inspect
  "#<#{self.class.name || 'AnonymousClass'}:#{format('0x%016X', __id__)} @name=#{name} @signature=#{signature}>"
end

#key_for(hash) ⇒ Object 



168
169
170
 
# File 'lib/gitlab/experiment.rb', line 168

def key_for(hash)
  instance_exec(hash, &Configuration.context_hash_strategy)
end

#name ⇒ Object 



120
121
122
 
# File 'lib/gitlab/experiment.rb', line 120

def name
  [Configuration.name_prefix, @name].compact.join('_')
end

#publish(result) ⇒ Object 



110
111
112
 
# File 'lib/gitlab/experiment.rb', line 110

def publish(result)
  instance_exec(result, &Configuration.publishing_behavior)
end

#run(variant_name = nil) ⇒ Object 



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

def run(variant_name = nil)
  @result ||= begin
    variant_name = variant(variant_name).name
    run_callbacks(run_with_segmenting? ? :segmented_run : :unsegmented_run) do
      super(@variant_name ||= variant_name)
    end
  end
end

#should_track? ⇒ Boolean

Returns:

  • (Boolean) 


164
165
166
 
# File 'lib/gitlab/experiment.rb', line 164

def should_track?
  enabled? && !excluded?
end

#signature ⇒ Object 



142
143
144
 
# File 'lib/gitlab/experiment.rb', line 142

def signature
  { variant: variant.name, experiment: name }.merge(context.signature)
end

#track(action, **event_args) ⇒ Object 



114
115
116
117
118
 
# File 'lib/gitlab/experiment.rb', line 114

def track(action, **event_args)
  return unless should_track?

  instance_exec(action, event_args, &Configuration.tracking_behavior)
end

#try(name = nil, &block) ⇒ Object 



137
138
139
140
 
# File 'lib/gitlab/experiment.rb', line 137

def try(name = nil, &block)
  name = (name || 'candidate').to_s
  behaviors[name] = block
end

#variant(value = nil) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/gitlab/experiment.rb', line 80

def variant(value = nil)
  if value.blank? && @variant_name || @resolving_variant
    return Variant.new(name: (@variant_name || :unresolved).to_s)
  end

  @variant_name = value unless value.blank?

  if enabled?
    @variant_name ||= :control if excluded?

    @resolving_variant = true
    if (result = cache_variant(@variant_name) { resolve_variant_name }).present?
      @variant_name = result.to_sym
    end
  end

  Variant.new(name: (@variant_name || :control).to_s)
ensure
  @resolving_variant = false
end

#variant_names ⇒ Object 



124
125
126
 
# File 'lib/gitlab/experiment.rb', line 124

def variant_names
  @variant_names ||= behaviors.keys.map(&:to_sym) - [:control]
end