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/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 Classes: Configuration, Context, Engine, Variant

Constant Summary collapse

VERSION = 
'0.4.3'

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
68
69
 
# 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)
  @variant_name = variant_name
  @excluded = []
  @context = Context.new(self, context)

  exclude { !@context.trackable? }
  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_given?

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

Instance Method Details

#context(value = nil) ⇒ Object 



71
72
73
74
75
76
 
# File 'lib/gitlab/experiment.rb', line 71

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

  @context.value(value)
  @context
end

#enabled? ⇒ Boolean

Returns:

  • (Boolean) 


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

def enabled?
  true
end

#exclude(&block) ⇒ Object 



97
98
99
 
# File 'lib/gitlab/experiment.rb', line 97

def exclude(&block)
  @excluded << block
end

#excluded? ⇒ Boolean

Returns:

  • (Boolean) 


140
141
142
 
# File 'lib/gitlab/experiment.rb', line 140

def excluded?
  @excluded.any? { |exclude| exclude.call(self) }
end

#flipper_id ⇒ Object 



153
154
155
 
# File 'lib/gitlab/experiment.rb', line 153

def flipper_id
  "Experiment;#{id}"
end

#id ⇒ Object Also known as: session_id 



148
149
150
 
# File 'lib/gitlab/experiment.rb', line 148

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

#key_for(hash) ⇒ Object 



157
158
159
 
# File 'lib/gitlab/experiment.rb', line 157

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

#name ⇒ Object 



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

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

#publish(result) ⇒ Object 



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

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

#run(variant_name = nil) ⇒ Object 



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

def run(variant_name = nil)
  @result ||= begin
    variant_name = variant(variant_name).name
    run_callbacks(variant_assigned? ? :unsegmented_run : :segmented_run) do
      if respond_to?((behavior_name = "#{variant_name}_behavior"))
        behaviors[variant_name] ||= -> { send(behavior_name) } # rubocop:disable GitlabSecurity/PublicSend
      end

      super(@variant_name = variant_name)
    end
  end
end

#signature ⇒ Object 



132
133
134
 
# File 'lib/gitlab/experiment.rb', line 132

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

#track(action, **event_args) ⇒ Object 



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

def track(action, **event_args)
  return if excluded?

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

#variant(value = nil) ⇒ Object 



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

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?
  @variant_name ||= :control if excluded?

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

  Variant.new(name: resolved.to_s)
ensure
  @resolving_variant = false
end

#variant_assigned? ⇒ Boolean

Returns:

  • (Boolean) 


144
145
146
 
# File 'lib/gitlab/experiment.rb', line 144

def variant_assigned?
  !@variant_name.nil?
end

#variant_names ⇒ Object 



128
129
130
 
# File 'lib/gitlab/experiment.rb', line 128

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