gitlab-experiment 0.4.8 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf6802aee233e6124ae21b95a164a92be868f5c5eda19e9560a813ac9f0ade0a
-  data.tar.gz: e8691d32ae73422e172176477c54966edc187ec72a43030070b3412e9f15d346
+  metadata.gz: 31e4979de3006211bcd1f63882215ae9213c3a22de25e7cca8546f3fce2ef649
+  data.tar.gz: cb865da8c87f019755194c98e073720f5f246b5a2c57e6d511c2a280d78ff996
 SHA512:
-  metadata.gz: 0a9eded639610b17e6b0cccbd17a232d187fd9bddc68047cfa14a01500e17f0f6ba78e93e7cd08d87a0cdce6e15e31198d00b0976bb72ff7de5115be15c50859
-  data.tar.gz: a6cdae13a053ab7c2e0ae8cdb6934db927a856263a8759499f072c9364be6f6ca6ac8bc5e279f4512e04fc930d2491fe09a72909a949ce57ff64c4971ab43a65
+  metadata.gz: 7906faeb21deaa6e0be322c94c0fd45ea200b5419ac5aacd2d2656b416ac08c21654e84f0ef3d2db5bb33c819dc73020267488a6f7f1ac045b66591ec04ae334
+  data.tar.gz: e0f9328d5c8f1eca74681e749e01cc6ccf513d619b3c4aa522c45d08a4692d370a96d97437975285fa26dcebad0a7e0a3a8356724b980902ba1b86c8fa82f0a1

data/README.md

@@ -3,7 +3,7 @@ GitLab Experiment
 
 <img alt="experiment" src="/uploads/60990b2dbf4c0406bbf8b7f998de2dea/experiment.png" align="right" width="40%">
 
-Here at GitLab, we run experiments as A/B/n tests and review the data the experiment generates. From that data, we determine the best performing variant and promote it as the new default code path. Or revert back to the control if no variant outperformed it.
+Here at GitLab, we run experiments as A/B/n tests and review the data the experiment generates. From that data, we determine the best performing variant and promote it as the new default code path. Or revert back to the control if no variant outperformed it. You can read our [Experiment Guide](https://docs.gitlab.com/ee/development/experiment_guide/) docs if you're curious about how we use this gem internally.
 
 This library provides a clean and elegant DSL (domain specific language) to define, run, and track your GitLab experiment.
 
@@ -64,7 +64,7 @@ end
 
 You can define the experiment using simple control/candidate paths, or provide named variants.
 
-Handling multi-variant experiments is up to the configuration you provide around resolving variants. But in our example we may want to try with and without the confirmation. We can run any number of variations in our experiments this way.
+Handling [multivariate](https://en.wikipedia.org/wiki/Multivariate_statistics) experiments is up to the configuration you provide around resolving variants. But in our example we may want to try with and without the confirmation. We can run any number of variations in our experiments this way.
 
 ```ruby
 experiment(:notification_toggle, actor: user) do |e|
@@ -101,11 +101,11 @@ Here are some examples of what you can introduce once you have a custom experime
 ```ruby
 class NotificationToggleExperiment < ApplicationExperiment
   # Exclude any users that aren't me.
-  exclude :all_but_me
+  exclude :users_named_richard
 
-  # Segment any account less than 2 weeks old into the candidate, without
+  # Segment any account older than 2 weeks into the candidate, without
   # asking the variant resolver to decide which variant to provide.
-  segment :account_age, variant: :candidate
+  segment :old_account?, variant: :candidate
 
   # Define the default control behavior, which can be overridden at
   # experiment time.
@@ -121,12 +121,12 @@ class NotificationToggleExperiment < ApplicationExperiment
 
   private
 
-  def all_but_me
-    context.actor&.username == 'jejacks0n'
+  def users_named_richard
+    context.actor.first_name == 'Richard'
   end
 
-  def account_age
-    context.actor && context.actor.created_at < 2.weeks.ago
+  def old_account?
+    context.actor.created_at < 2.weeks.ago
   end
 end
 
@@ -149,37 +149,13 @@ experiment(:notification_toggle, actor: user) do |e|
 end
 ```
 
-<details>
-  <summary>You can also use the lower level class interface...</summary>
-
-### Using the `.run` approach
-
-This is useful if you haven't included the DSL and so don't have access to the `experiment` method, but still want to execute an experiment. This is ultimately what the `experiment` method calls through to, and the method signatures are the same.
-
-```ruby
-exp = Gitlab::Experiment.run(:notification_toggle, actor: user) do |e|
-  # Context may be passed in the block, but must be finalized before calling
-  # run or track.
-  e.context(project: project) # add the project to the context
-
-  # Define the control and candidate variant.
-  e.use { render_toggle } # control
-  e.try { render_button } # candidate
-end
-
-# Track an event on the experiment we've defined.
-exp.track(:clicked_button)
-```
-
-</details>
-
 <details>
   <summary>You can also specify the variant to use for segmentation...</summary>
 
-### Specifying variant
-
 Generally, defining segmentation rules is a better way to approach routing into specific variants, but it's possible to explicitly specify the variant when running an experiment. It's important to know what this might do to your data during rollout, so use this with careful consideration.
 
+Any time a specific variant is provided (including `:control`) it will be cached for that context, if caching is enabled. 
+
 ```ruby
 experiment(:notification_toggle, :no_interface, actor: user) do |e|
   e.use { render_toggle } # control
@@ -217,39 +193,54 @@ This library comes with the capability to segment contexts into a specific varia
 Segmentation can be achieved by using a custom experiment class and specifying the segmentation rules at a class level.
 
 ```ruby
-class NotificationToggleExperiment < ApplicationExperiment
-  segment(variant: :variant_one) { context.actor.username == 'jejacks0n' }
-  segment(variant: :variant_two) { context.actor.created_at < 2.weeks.ago }
+class ExampleExperiment < ApplicationExperiment
+  segment(variant: :variant_one) { context.actor.first_name == 'Richard' }
+  segment :old_account?, variant: :variant_two
+  
+  private
+
+  def old_account?
+    context.actor.created_at < 2.weeks.ago
+  end
 end
 ```
 
-In the previous examples, any user with the username `'jejacks0n'` would always receive the experience defined in "variant_one". As well, any account less than 2 weeks old would get the alternate experience defined in "variant_two".
+In the previous examples, any user named `'Richard'` would always receive the experience defined in "variant_one". As well, any account older than 2 weeks old would get the alternate experience defined in "variant_two".
 
 When an experiment is run, the segmentation rules are executed in the order they're defined. The first segmentation rule to produce a truthy result is the one which gets used to assign the variant. The remaining segmentation rules are skipped.
 
-This means that any user with the name `'jejacks0n'`, regardless of account age, will always be provided the experience as defined in "variant_one". 
+This means that any user named `'Richard'`, regardless of account age, will always be provided the experience as defined in "variant_one". If you wanted the opposite logic, you can flip the order.
 
 ### Exclusion rules
 
-Exclusion rules are similar to segmentation rules, but are intended to determine if a context should even be considered as something we should track events towards. Exclusion means we don't care about the events in relation to the given context. 
+Exclusion rules are similar to segmentation rules, but are intended to determine if a context should even be considered as something we should track events towards. Exclusion means we don't care about the events in relation to the given context.
 
 ```ruby
-class NotificationToggleExperiment < ApplicationExperiment
-  exclude { context.actor.username != 'jejacks0n' }
-  exclude { context.actor.created_at < 2.weeks.ago }
+class ExampleExperiment < ApplicationExperiment
+  exclude :old_account?, ->{ context.actor.first_name == 'Richard' }
+  
+  private
+
+  def old_account? 
+    context.actor.created_at < 2.weeks.ago
+  end
 end
 ```
 
-The previous examples will force all users with a username not matching `'jejacks0n'` and all newish users into the control. No events would be tracked for those.
+The previous examples will exclude all users named `'Richard'` as well as any account older than 2 weeks old. Not only will they be given the control behavior, but no events will be tracked in these cases as well. 
 
-You may need to check exclusion in custom tracking logic, by checking `excluded?` or wrapping your code in a callback block:
+You may need to check exclusion in custom tracking logic by calling `should_track?`:
 
 ```ruby
-run_callbacks(:exclusion_check) do
+def expensive_tracking_logic
+  return unless should_track?
+  
   track(:my_event, value: expensive_method_call)
 end
 ```
 
+Note: Exclusion rules aren't the best way to determine if an experiment is enabled. There's an `enabled?` method that can be overridden to have a high-level way of determining if an experiment should be running and tracking at all. This `enabled?` check should be as efficient as possible because it's the first early opt out path an experiment can implement.
+
 ### Return value
 
 By default the return value is a `Gitlab::Experiment` instance. In simple cases you may want only the results of the experiment though. You can call `run` within the block to get the return value of the assigned variant.
@@ -297,7 +288,7 @@ In providing the context migration data, we can resolve an experience and its ev
 
 ```ruby
 # Migrate just the `:version` portion of the previous context, `{ actor: project, version: 1 }`:
-experiment(:my_experiment, actor: project, version: 2, migrated_with: { version: 1 })
+experiment(:example, actor: project, version: 2, migrated_with: { version: 1 })
 ```
 
 You can add or remove context by providing a `migrated_from` option. This approach expects a full context replacement -- i.e. what it was before you added or removed the new context key.
@@ -306,7 +297,7 @@ If you wanted to introduce a `version` to your context, provide the full previou
 
 ```ruby
 # Migrate the full context from `{ actor: project }` to `{ actor: project, version: 1 }`:
-experiment(:my_experiment, actor: project, version: 1, migrated_from: { actor: project })
+experiment(:example, actor: project, version: 1, migrated_from: { actor: project })
 ```
 
 This can impact an experience if you:
@@ -327,23 +318,54 @@ To read and write cookies, we provide the `request` from within the controller a
 You'll need to provide the `request` as an option to the experiment if it's outside of the controller and views.
 
 ```ruby
-experiment(:my_experiment, actor: user, request: request)
+experiment(:example, actor: user, request: request)
 ```
 
 The cookie isn't set if the `actor` key isn't present at all in the context. Meaning that when no `actor` key is provided, the cookie will not be set.
 
 ```ruby
 # actor is not present, so no cookie is set
-experiment(:my_experiment, project: project)
+experiment(:example, project: project)
 
 # actor is present and is nil, so the cookie is set and used
-experiment(:my_experiment, actor: nil, project: project)
+experiment(:example, actor: nil, project: project)
 
 # actor is present and set to a value, so no cookie is set
-experiment(:my_experiment, actor: user, project: project)
+experiment(:example, actor: user, project: project)
 ```
 
-For edge cases, you can pass the cookie through by assigning it yourself -- e.g. `actor: request.cookie_jar.signed['my_experiment_actor']`. The cookie name is the full experiment name (including any configured prefix) with `_actor` appended -- e.g. `gitlab_notification_toggle_actor` for the `:notification_toggle` experiment key with a configured prefix of `gitlab`.
+For edge cases, you can pass the cookie through by assigning it yourself -- e.g. `actor: request.cookie_jar.signed['example_actor']`. The cookie name is the full experiment name (including any configured prefix) with `_actor` appended -- e.g. `gitlab_notification_toggle_actor` for the `:notification_toggle` experiment key with a configured prefix of `gitlab`.
+
+## How it works
+
+The way the gem works is best described using the following decision tree illustration. When an experiment is run, the following logic is executed to resolve what experience should be provided, given how the experiment is defined, and the context provided.
+ 
+```mermaid
+graph TD
+    GP[General Pool/Population] --> Enabled?
+    Enabled? -->|Yes| Cached?[Cached? / Pre-segmented?]
+    Enabled? -->|No| Excluded[Control / No Tracking]
+    Cached? -->|No| Excluded?
+    Cached? -->|Yes| Cached[Cached Value]
+    Excluded? -->|Yes / Cached| Excluded
+    Excluded? -->|No| Segmented?
+    Segmented? -->|Yes / Cached| VariantA
+    Segmented? -->|No| Included?[Experiment Group?]
+    Included? -->|Yes| Rollout
+    Included? -->|No| Control
+    Rollout -->|Cached| VariantA
+    Rollout -->|Cached| VariantB
+    Rollout -->|Cached| VariantC
+
+classDef included fill:#380d75,color:#ffffff,stroke:none
+classDef excluded fill:#fca121,stroke:none
+classDef cached fill:#2e2e2e,color:#ffffff,stroke:none
+classDef default fill:#fff,stroke:#6e49cb
+
+class VariantA,VariantB,VariantC included
+class Control,Excluded excluded
+class Cached cached
+```
 
 ## Configuration
 
@@ -401,6 +423,99 @@ Gitlab::Experiment.configure do |config|
 end
 ```
 
+## Testing (rspec support)
+
+This gem comes with some rspec helpers and custom matchers. These are in flux at the time of writing.
+
+First, require the rspec support file:
+
+```ruby
+require 'gitlab/experiment/rspec'
+```
+
+This mixes in some of the basics, but the matchers and other aspects need to be included. This happens automatically for files in `spec/experiments`, but for other files and specs you want to include it in, you can specify the `:experiment` type:
+
+```ruby
+it "tests", :experiment do
+end
+```
+
+### Stub helpers
+
+You can stub experiments using `stub_experiments`. Pass it a hash using experiment names as the keys and the variants you want each to resolve to as the values:
+
+```ruby
+# Ensures the experiments named `:example` & `:example2` are both
+# "enabled" and that each will resolve to the given variant
+# (`:my_variant` & `:control` respectively).
+stub_experiments(example: :my_variant, example2: :control)
+
+experiment(:example) do |e|
+  e.enabled? # => true
+  e.variant.name # => 'my_variant'
+end
+
+experiment(:example2) do |e|
+  e.enabled? # => true
+  e.variant.name # => 'control'
+end
+```
+
+### Exclusion and segmentation matchers
+
+You can also easily test the exclusion and segmentation matchers.
+
+```ruby
+class ExampleExperiment < ApplicationExperiment
+  exclude { context.actor.first_name == 'Richard' }
+  segment(variant: :candidate) { context.actor.username == 'jejacks0n' }
+end
+
+excluded = double(username: 'rdiggitty', first_name: 'Richard')
+segmented = double(username: 'jejacks0n', first_name: 'Jeremy')
+
+# exclude matcher
+expect(experiment(:example)).to exclude(actor: excluded)
+expect(experiment(:example)).not_to exclude(actor: segmented)
+
+# segment matcher
+expect(experiment(:example)).to segment(actor: segmented).into(:candidate)
+expect(experiment(:example)).not_to segment(actor: excluded)
+```
+
+### Tracking matcher
+
+Tracking events is a major aspect of experimentation, and because of this we try to provide a flexible way to ensure your tracking calls are covered.
+
+You can do this on the instance level or at an "any instance" level. At an instance level this is pretty straight forward:
+
+```ruby
+subject = experiment(:example)
+
+expect(subject).to track(:my_event)
+
+subject.track(:my_event)
+```
+
+You can use the `on_any_instance` chain method to specify that it could happen on any instance of the experiment. This can be useful if you're calling `experiment(:example).track` downstream:
+
+```ruby
+expect(experiment(:example)).to track(:my_event).on_any_instance
+
+experiment(:example).track(:my_event)
+```
+
+And here's a full example of the methods that can be chained onto the `track` matcher:
+
+```ruby
+expect(experiment(:example)).to track(:my_event, value: 1, property: '_property_')
+  .on_any_instance
+  .with_context(foo: :bar)
+  .for(:variant_name)
+
+experiment(:example, :variant_name, foo: :bar).track(:my_event, value: 1, property: '_property_')
+```
+
 ## Tracking, anonymity and GDPR
 
 We generally try not to track things like user identifying values in our experimentation. What we can and do track is the "experiment experience" (a.k.a. the context key).
@@ -426,7 +541,7 @@ https://gitlab.com/gitlab-org/gitlab-experiment. This project is intended to be
 safe, welcoming space for collaboration, and contributors are expected to adhere
 to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-## Release Process
+## Release process
 
 Please refer to the [Release Process](docs/release_process.md).
 
@@ -435,7 +550,7 @@ Please refer to the [Release Process](docs/release_process.md).
 The gem is available as open source under the terms of the
 [MIT License](http://opensource.org/licenses/MIT).
 
-## Code of Conduct
+## Code of conduct
 
 Everyone interacting in the `Gitlab::Experiment` project’s codebases, issue trackers,
 chat rooms and mailing lists is expected to follow the

data/lib/generators/gitlab/experiment/install/templates/initializer.rb.tt

@@ -22,20 +22,23 @@ Gitlab::Experiment.configure do |config|
   # `['www.gitlab.com', '.gitlab.com']`.
   config.cookie_domain = :all
 
-  # Logic this project uses to resolve a variant for a given experiment.
+  # The default rollout strategy that works for single and multi-variants.
   #
-  # Should return a symbol or string that represents the variant that should
-  # be assigned. Blank or nil values will be defaulted to the control.
+  # You can provide your own rollout strategies and override them per
+  # experiment.
+  #
+  # Examples include:
+  #   Rollout::First, Rollout::Random, Rollout::RoundRobin
+  config.default_rollout = Gitlab::Experiment::Rollout::First
+
+  # Logic this project uses to determine inclusion in a given experiment.
+  #
+  # Expected to return a boolean value.
   #
   # This block is executed within the scope of the experiment and so can access
   # experiment methods, like `name`, `context`, and `signature`.
-  config.variant_resolver = lambda do |requested_variant|
-    # Run the control, unless a variant was requested in code:
-    requested_variant
-
-    # Run the candidate, unless a variant was requested, with a fallback:
-    #
-    # requested_variant || variant_names.first || nil
+  config.inclusion_resolver = lambda do |requested_variant|
+    false
   end
 
   # Tracking behavior can be implemented to link an event to an experiment.

data/lib/gitlab/experiment.rb

@@ -2,11 +2,16 @@
 
 require 'scientist'
 require 'active_support/callbacks'
+require 'active_support/cache'
+require 'active_support/concern'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/module/delegation'
 
-require 'gitlab/experiment/caching'
+require 'gitlab/experiment/base_interface'
+require 'gitlab/experiment/cache'
 require 'gitlab/experiment/callbacks'
+require 'gitlab/experiment/rollout'
 require 'gitlab/experiment/configuration'
 require 'gitlab/experiment/cookies'
 require 'gitlab/experiment/context'
@@ -17,57 +22,29 @@ require 'gitlab/experiment/engine' if defined?(Rails::Engine)
 
 module Gitlab
   class Experiment
-    include Scientist::Experiment
-    include Caching
+    include BaseInterface
+    include Cache
     include Callbacks
 
     class << self
-      def configure
-        yield Configuration
-      end
-
-      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
-
-      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
+      def default_rollout(rollout = nil)
+        return @rollout ||= Configuration.default_rollout if rollout.blank?
 
-      def base?
-        self == Gitlab::Experiment || name == Configuration.base_class
-      end
-
-      private
-
-      def constantize(name = nil)
-        return self if name.nil?
-
-        experiment_name(name).classify.safe_constantize || Configuration.base_class.constantize
+        @rollout = Rollout.resolve(rollout)
       end
     end
 
-    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 }
+    def name
+      [Configuration.name_prefix, @name].compact.join('_')
+    end
 
-      yield self if block_given?
+    def use(&block)
+      try(:control, &block)
     end
 
-    def inspect
-      "#<#{self.class.name || 'AnonymousClass'}:#{format('0x%016X', __id__)} @name=#{name} @signature=#{signature}>"
+    def try(name = nil, &block)
+      name = (name || :candidate).to_s
+      behaviors[name] = block
     end
 
     def context(value = nil)
@@ -78,11 +55,8 @@ module Gitlab
     end
 
     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 = cache_variant(value) if value.present?
+      return Variant.new(name: (@variant_name || :unresolved).to_s) if @variant_name || @resolving_variant
 
       if enabled?
         @variant_name ||= :control if excluded?
@@ -93,18 +67,22 @@ module Gitlab
         end
       end
 
-      Variant.new(name: (@variant_name || :control).to_s)
+      run_callbacks(segmentation_callback_chain) do
+        @variant_name ||= :control
+        Variant.new(name: @variant_name.to_s)
+      end
     ensure
       @resolving_variant = false
     end
 
+    def rollout(rollout = nil)
+      return @rollout ||= self.class.default_rollout if rollout.blank?
+
+      @rollout = Rollout.resolve(rollout)
+    end
+
     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
+      @result ||= super(variant(variant_name).name)
     end
 
     def publish(result)
@@ -117,75 +95,43 @@ module Gitlab
       instance_exec(action, event_args, &Configuration.tracking_behavior)
     end
 
-    def name
-      [Configuration.name_prefix, @name].compact.join('_')
-    end
-
-    def variant_names
-      @variant_names ||= behaviors.keys.map(&:to_sym) - [:control]
-    end
-
-    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
-
-    def try(name = nil, &block)
-      name = (name || 'candidate').to_s
-      behaviors[name] = block
-    end
-
-    def signature
-      { variant: variant.name, experiment: name }.merge(context.signature)
-    end
-
-    def id
-      "#{name}:#{key_for(context.value)}"
-    end
-    alias_method :session_id, :id
-
-    def flipper_id
-      "Experiment;#{id}"
-    end
-
     def enabled?
       true
     end
 
     def excluded?
-      @excluded ||= !@context.trackable? || # adhere to DNT headers
+      return @excluded if defined?(@excluded)
+
+      @excluded = !@context.trackable? || # adhere to DNT headers
         !run_callbacks(:exclusion_check) { :not_excluded } # didn't pass exclusion check
     end
 
+    def experiment_group?
+      instance_exec(@variant_name, &Configuration.inclusion_resolver)
+    end
+
     def should_track?
       enabled? && !excluded?
     end
 
+    def signature
+      { variant: variant.name, experiment: name }.merge(context.signature)
+    end
+
     def key_for(hash)
       instance_exec(hash, &Configuration.context_hash_strategy)
     end
 
     protected
 
-    def run_with_segmenting?
-      !variant_assigned? && enabled? && !excluded?
-    end
+    def segmentation_callback_chain
+      return :segmentation_check if !variant_assigned? && enabled? && !excluded?
 
-    def variant_assigned?
-      !@variant_name.nil?
+      :unsegmented
     end
 
     def resolve_variant_name
-      instance_exec(@variant_name, &Configuration.variant_resolver)
-    end
-
-    def generate_result(variant_name)
-      observation = Scientist::Observation.new(variant_name, self, &behaviors[variant_name])
-      Scientist::Result.new(self, [observation], observation)
+      rollout.new(self).execute if experiment_group?
     end
   end
 end

data/lib/gitlab/experiment/base_interface.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Gitlab
+  class Experiment
+    module BaseInterface
+      extend ActiveSupport::Concern
+
+      # don't `include` here so we don't override the default scientist class
+      Scientist::Experiment.send(:append_features, self) # rubocop:disable GitlabSecurity/PublicSend
+
+      class_methods do
+        include Scientist::Experiment::RaiseOnMismatch
+
+        def configure
+          yield Configuration
+        end
+
+        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
+
+        def base?
+          self == Gitlab::Experiment || name == Configuration.base_class
+        end
+
+        def constantize(name = nil)
+          return self if name.nil?
+
+          experiment_name(name).classify.safe_constantize || Configuration.base_class.constantize
+        end
+      end
+
+      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
+
+      def inspect
+        "#<#{self.class.name || 'AnonymousClass'}:#{format('0x%016X', __id__)} @name=#{name} @context=#{context.value}>"
+      end
+
+      def id
+        "#{name}:#{key_for(context.value)}"
+      end
+      alias_method :session_id, :id
+
+      def flipper_id
+        "Experiment;#{id}"
+      end
+
+      def variant_names
+        @variant_names ||= behaviors.keys.map(&:to_sym) - [:control]
+      end
+
+      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
+
+      protected
+
+      def variant_assigned?
+        !@variant_name.nil?
+      end
+
+      def generate_result(variant_name)
+        observation = Scientist::Observation.new(variant_name, self, &behaviors[variant_name])
+        Scientist::Result.new(self, [observation], observation)
+      end
+    end
+  end
+end

data/lib/gitlab/experiment/cache.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'active_support/cache'
+
+module Gitlab
+  class Experiment
+    module Cache
+      autoload :RedisHashStore, 'gitlab/experiment/cache/redis_hash_store.rb'
+
+      class Interface
+        attr_reader :store, :key
+
+        def initialize(experiment, store)
+          @experiment = experiment
+          @store = store
+          @key = experiment.cache_key
+        end
+
+        def read
+          store.read(key)
+        end
+
+        def write(value = nil)
+          store.write(key, value || @experiment.variant.name)
+        end
+
+        def delete
+          store.delete(key)
+        end
+
+        def attr_get(name)
+          store.read(@experiment.cache_key(name, suffix: :attrs))
+        end
+
+        def attr_set(name, value)
+          store.write(@experiment.cache_key(name, suffix: :attrs), value)
+        end
+
+        def attr_inc(name, amount = 1)
+          store.increment(@experiment.cache_key(name, suffix: :attrs), amount)
+        end
+      end
+
+      def cache
+        @cache ||= Interface.new(self, Configuration.cache)
+      end
+
+      def cache_variant(specified = nil, &block)
+        return (specified.presence || yield) unless cache.store
+
+        result = migrated_cache_fetch(cache.store, &block)
+        return result unless specified.present?
+
+        cache.write(specified) if result != specified
+        specified
+      end
+
+      def cache_key(key = nil, suffix: nil)
+        "#{[name, suffix].compact.join('_')}:#{key || context.signature[:key]}"
+      end
+
+      private
+
+      def migrated_cache_fetch(store, &block)
+        migrations = context.signature[:migration_keys]&.map { |key| cache_key(key) } || []
+        migrations.find do |old_key|
+          next unless (value = store.read(old_key))
+
+          store.write(cache_key, value)
+          store.delete(old_key)
+          return value
+        end
+
+        store.fetch(cache_key, &block)
+      end
+    end
+  end
+end

data/lib/gitlab/experiment/cache/redis_hash_store.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'active_support/notifications'
+
+# This cache strategy is an implementation on top of the redis hash data type,
+# that also adheres to the ActiveSupport::Cache::Store interface. It's a good
+# example of how to build a custom caching strategy for Gitlab::Experiment, and
+# is intended to be a long lived cache -- until the experiment is cleaned up.
+#
+# The data structure:
+#   key: experiment.name
+#   fields: context key => variant name
+#
+# Gitlab::Experiment::Configuration.cache = Gitlab::Experiment::Cache::RedisHashStore.new(
+#   pool: -> { Gitlab::Redis::SharedState.with { |redis| yield redis } }
+# )
+module Gitlab
+  class Experiment
+    module Cache
+      class RedisHashStore < ActiveSupport::Cache::Store
+        # Clears the entire cache for a given experiment. Be careful with this
+        # since it would reset all resolved variants for the entire experiment.
+        def clear(key:)
+          key = hkey(key)[0] # extract only the first part of the key
+          pool do |redis|
+            case redis.type(key)
+            when 'hash', 'none'
+              redis.del(key) # delete the primary experiment key
+              redis.del("#{key}_attrs") # delete the experiment attributes key
+            else raise ArgumentError, 'invalid call to clear a non-hash cache key'
+            end
+          end
+        end
+
+        def increment(key, amount = 1)
+          pool { |redis| redis.hincrby(*hkey(key), amount) }
+        end
+
+        private
+
+        def pool(&block)
+          raise ArgumentError, 'missing block' unless block.present?
+
+          @options[:pool].call(&block)
+        end
+
+        def hkey(key)
+          key.to_s.split(':') # this assumes the default strategy in gitlab-experiment
+        end
+
+        def read_entry(key, **options)
+          value = pool { |redis| redis.hget(*hkey(key)) }
+          value.nil? ? nil : ActiveSupport::Cache::Entry.new(value)
+        end
+
+        def write_entry(key, entry, **options)
+          return false if entry.value.blank? # don't cache any empty values
+
+          pool { |redis| redis.hset(*hkey(key), entry.value) }
+        end
+
+        def delete_entry(key, **options)
+          pool { |redis| redis.hdel(*hkey(key)) }
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/experiment/callbacks.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'active_support/callbacks'
+
 module Gitlab
   class Experiment
     module Callbacks
@@ -7,8 +9,8 @@ module Gitlab
       include ActiveSupport::Callbacks
 
       included do
-        define_callbacks(:unsegmented_run)
-        define_callbacks(:segmented_run)
+        define_callbacks(:unsegmented)
+        define_callbacks(:segmentation_check)
         define_callbacks(:exclusion_check, skip_after_callbacks_if_terminated: true)
       end
 
@@ -34,7 +36,7 @@ module Gitlab
 
           raise ArgumentError, 'no filters provided' if filters.empty?
 
-          set_callback(:segmented_run, :before, *filters, options)
+          set_callback(:segmentation_check, :before, *filters, options)
         end
       end
     end

data/lib/gitlab/experiment/configuration.rb

@@ -4,6 +4,8 @@ require 'singleton'
 require 'logger'
 require 'digest'
 
+require 'active_support/deprecation'
+
 module Gitlab
   class Experiment
     class Configuration
@@ -24,10 +26,13 @@ module Gitlab
       # The domain to use on cookies.
       @cookie_domain = :all
 
-      # Logic this project uses to resolve a variant for a given experiment.
-      # If no variant is determined, the control will be used.
-      @variant_resolver = lambda do |requested_variant|
-        requested_variant
+      # The default rollout strategy that works for single and multi-variants.
+      @default_rollout = Rollout::First
+
+      # Logic this project uses to determine inclusion in a given experiment.
+      # Expected to return a boolean value.
+      @inclusion_resolver = lambda do |requested_variant|
+        false
       end
 
       # Tracking behavior can be implemented to link an event to an experiment.
@@ -47,13 +52,27 @@ module Gitlab
       end
 
       class << self
+        # TODO: Added deprecation in release 0.5.0
+        def variant_resolver
+          ActiveSupport::Deprecation.warn('variant_resolver is deprecated, instead use `inclusion_resolver` with a' \
+            'block that returns a boolean.')
+          @inclusion_resolver
+        end
+
+        def variant_resolver=(block)
+          ActiveSupport::Deprecation.warn('variant_resolver is deprecated, instead use `inclusion_resolver` with a' \
+            'block that returns a boolean.')
+          @inclusion_resolver = block
+        end
+
         attr_accessor(
           :name_prefix,
           :logger,
           :base_class,
           :cache,
           :cookie_domain,
-          :variant_resolver,
+          :default_rollout,
+          :inclusion_resolver,
           :tracking_behavior,
           :publishing_behavior,
           :context_hash_strategy

data/lib/gitlab/experiment/context.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'gitlab/experiment/cookies'
+
 module Gitlab
   class Experiment
     class Context

data/lib/gitlab/experiment/dsl.rb

@@ -4,8 +4,17 @@ module Gitlab
   class Experiment
     module Dsl
       def experiment(name, variant_name = nil, **context, &block)
+        raise ArgumentError, 'name is required' if name.nil?
+
         context[:request] ||= request if respond_to?(:request)
-        Experiment.run(name, variant_name, **context, &block)
+
+        base = Configuration.base_class.constantize
+        klass = base.constantize(name) || base
+
+        instance = klass.new(name, variant_name, **context, &block)
+        return instance unless block
+
+        instance.context.frozen? ? instance.run : instance.tap(&:run)
       end
     end
   end

data/lib/gitlab/experiment/engine.rb

@@ -4,13 +4,18 @@ module Gitlab
   class Experiment
     class Engine < ::Rails::Engine
       def self.include_dsl
-        ActionController::Base.include(Dsl)
-        ActionController::Base.helper_method(:experiment)
-      end
+        if defined?(ActionController)
+          ActionController::Base.include(Dsl)
+          ActionController::Base.helper_method(:experiment)
+        end
+
+        return unless defined?(ActionMailer)
 
-      config.after_initialize do
-        include_dsl if defined?(ActionController)
+        ActionMailer::Base.include(Dsl)
+        ActionMailer::Base.helper_method(:experiment)
       end
+
+      config.after_initialize { include_dsl }
     end
   end
 end

data/lib/gitlab/experiment/rollout.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Gitlab
+  class Experiment
+    module Rollout
+      autoload :First, 'gitlab/experiment/rollout/first.rb' # default strategy
+      autoload :Random, 'gitlab/experiment/rollout/random.rb'
+      autoload :RoundRobin, 'gitlab/experiment/rollout/round_robin.rb'
+
+      def self.resolve(klass)
+        return "#{name}::#{klass.to_s.classify}".constantize if klass.is_a?(Symbol) || klass.is_a?(String)
+
+        klass
+      end
+
+      class Base
+        attr_reader :experiment
+
+        delegate :variant_names, :cache, to: :experiment
+
+        def initialize(experiment)
+          @experiment = experiment
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/experiment/rollout/first.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Gitlab
+  class Experiment
+    module Rollout
+      class First < Base
+        # This rollout strategy just picks the first variant name. It's the
+        # default resolver as it assumes a single variant. You should consider
+        # using a more advanced rollout if you have multiple variants.
+        def execute
+          variant_names.first
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/experiment/rollout/random.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Gitlab
+  class Experiment
+    module Rollout
+      class Random < Base
+        # Pick a random variant if we're in the experiment group. It doesn't
+        # take into account small sample sizes but is useful and performant.
+        def execute
+          variant_names.sample
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/experiment/rollout/round_robin.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Gitlab
+  class Experiment
+    module Rollout
+      class RoundRobin < Base
+        KEY_NAME = :last_round_robin_variant
+
+        # Requires a cache to be configured.
+        #
+        # Keeps track of the number of assignments into the experiment group,
+        # and uses this to rotate "round robin" style through the variants
+        # that are defined.
+        #
+        # Relatively performant, but requires a cache, and is dependent on the
+        # performance of that cache store.
+        def execute
+          variant_names[(cache.attr_inc(KEY_NAME) - 1) % variant_names.size]
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/experiment/rspec.rb

@@ -6,14 +6,19 @@ module Gitlab
       def stub_experiments(experiments)
         experiments.each do |name, variant|
           variant = :control if variant == false
-          raise ArgumentError, 'variant must be a symbol or false' unless variant.is_a?(Symbol)
 
-          klass = Gitlab::Experiment.send(:constantize, name) # rubocop:disable GitlabSecurity/PublicSend
+          base = Configuration.base_class.constantize
+          klass = base.constantize(name) || base
 
           # We have to use this high level any_instance behavior as there's
           # not an alternative that allows multiple wrappings of `new`.
           allow_any_instance_of(klass).to receive(:enabled?).and_return(true)
-          allow_any_instance_of(klass).to receive(:resolve_variant_name).and_return(variant.to_s)
+
+          if variant == true # passing true allows the rollout to do its job
+            allow_any_instance_of(klass).to receive(:experiment_group?).and_return(true)
+          else
+            allow_any_instance_of(klass).to receive(:resolve_variant_name).and_return(variant.to_s)
+          end
         end
       end
 
@@ -86,7 +91,7 @@ module Gitlab
           experiment.context(context)
 
           experiment.instance_variable_set(ivar, nil)
-          experiment.run_callbacks(:segmented_run)
+          experiment.run_callbacks(:segmentation_check)
 
           @actual = experiment.instance_variable_get(ivar)
           @expected ? @actual.to_s == @expected.to_s : @actual.present?
@@ -116,11 +121,11 @@ module Gitlab
 
       matcher :track do |event, *event_args|
         match do |experiment|
-          expect_tracking_on(experiment, event, *event_args)
+          expect_tracking_on(experiment, false, event, *event_args)
         end
 
         match_when_negated do |experiment|
-          expect_tracking_on(experiment, event, *event_args, negated: true)
+          expect_tracking_on(experiment, true, event, *event_args)
         end
 
         chain :for do |expected_variant|
@@ -132,7 +137,7 @@ module Gitlab
         chain(:with_context) { |expected_context| @expected_context = expected_context }
         chain(:on_any_instance) { @on_self = false }
 
-        def expect_tracking_on(experiment, event, *event_args, negated: false)
+        def expect_tracking_on(experiment, negated, event, *event_args)
           @experiment = experiment
           @on_self = true if require_experiment(experiment, 'track', classes: !@on_self) && @on_self.nil?
           wrapped_experiment(experiment, shallow: @on_self, failure: failure_message(:no_new, event)) do |instance|
@@ -147,14 +152,16 @@ module Gitlab
           end
         end
 
-        def receive_tracking_call_for(event, *event_args)
-          receive(:track).with(*[event, *event_args]) do # rubocop:disable CodeReuse/ActiveRecord
+        def receive_tracking_call_for(expected_event, *expected_event_args)
+          receive(:track).with(*[expected_event, *expected_event_args]).and_wrap_original do |track, event, *event_args|
+            track.call(event, *event_args) # call the original
+
             if @expected_variant
-              expect(@experiment.variant.name).to eq(@expected_variant), failure_message(:variant, event)
+              expect(@experiment.variant.name).to eq(@expected_variant), failure_message(:variant, expected_event)
             end
 
             if @expected_context
-              expect(@experiment.context.value).to include(@expected_context), failure_message(:context, event)
+              expect(@experiment.context.value).to include(@expected_context), failure_message(:context, expected_event)
             end
           end
         end

data/lib/gitlab/experiment/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   class Experiment
-    VERSION = '0.4.8'
+    VERSION = '0.5.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-experiment
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.5.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-25 00:00:00.000000000 Z
+date: 2021-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -65,13 +65,19 @@ files:
 - lib/generators/test_unit/experiment/experiment_generator.rb
 - lib/generators/test_unit/experiment/templates/experiment_test.rb.tt
 - lib/gitlab/experiment.rb
-- lib/gitlab/experiment/caching.rb
+- lib/gitlab/experiment/base_interface.rb
+- lib/gitlab/experiment/cache.rb
+- lib/gitlab/experiment/cache/redis_hash_store.rb
 - lib/gitlab/experiment/callbacks.rb
 - lib/gitlab/experiment/configuration.rb
 - lib/gitlab/experiment/context.rb
 - lib/gitlab/experiment/cookies.rb
 - lib/gitlab/experiment/dsl.rb
 - lib/gitlab/experiment/engine.rb
+- lib/gitlab/experiment/rollout.rb
+- lib/gitlab/experiment/rollout/first.rb
+- lib/gitlab/experiment/rollout/random.rb
+- lib/gitlab/experiment/rollout/round_robin.rb
 - lib/gitlab/experiment/rspec.rb
 - lib/gitlab/experiment/variant.rb
 - lib/gitlab/experiment/version.rb

data/lib/gitlab/experiment/caching.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Gitlab
-  class Experiment
-    module Caching
-      def cache_variant(specified = nil, &block)
-        cache = Configuration.cache
-        return (specified.presence || yield) unless cache
-
-        key, migrations = cache_strategy
-        result = migrated_cache(cache, migrations || [], key) || cache.fetch(key, &block)
-        return result unless specified.present?
-
-        cache.write(cache_key, specified) if result != specified
-        specified
-      end
-
-      def cache_key(key = nil)
-        "#{name}:#{key || context.signature[:key]}"
-      end
-
-      private
-
-      def cache_strategy
-        [cache_key, context.signature[:migration_keys]&.map { |key| cache_key(key) }]
-      end
-
-      def migrated_cache(cache, migrations, new_key)
-        migrations.find do |old_key|
-          next unless (value = cache.read(old_key))
-
-          cache.write(new_key, value)
-          cache.delete(old_key)
-          break value
-        end
-      end
-    end
-  end
-end