gitlab-experiment 0.4.6 → 0.4.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51c0f257bd0cea5fa7b970e764ac5cce9f24c5a844673f05579d1c902a46fc39
-  data.tar.gz: ddd93dc46cdde532f20edd5209651d511105157ee9dd13d58c5a60cb229cd3ca
+  metadata.gz: 207b046a8c0b1c98ad958442716be6a8232c431bfcc702a42817d8eb1aa3f465
+  data.tar.gz: c654346312abfd1684af031fe1784cb1db61ac583c0c52c3ef50b08d0337182b
 SHA512:
-  metadata.gz: 243606b6b55ebe069296c564ad801a6b25075a85d2b2ca38eb47e836b75b655fa9472fbcf0a0cb01c83093b97d529f8b2aec04389d79119064b5021c975b0042
-  data.tar.gz: 1900d8b44458d2cf1e2086cc48d5e3ccc19160926c1dc9b827b7a93d042edf7354e1eeb35cae12e0c33f133aef39f605dbd5446edf987c1d99a38264d3b97d72
+  metadata.gz: 3f3b9d02b8a268e99bb9cda60e7c1a76d55962f9d04754209558deebd58624c5407bf883a6405c3d248b13f3a246a96a9d4a370bfca052e512f125a57aa89e8f
+  data.tar.gz: b43611c028598b362972079b6b785dd62e7c4b35dffa2abc6bd9822a6a2b488385101a5aea975b0d6c429638a8e8661ff6e8aca9e0a0e184c9510a6e5c591d48

data/README.md

@@ -15,7 +15,7 @@ When we discuss the behavior of this gem, we'll use terms like experiment, conte
 - `candidate` defines that there's one experimental code path.
 - `variant(s)` is used when more than one experimental code path exists.
 
-Candidate and variant are the same concept, but simplify how we speak about experimental paths.<br clear="all">
+Candidate and variant are the same concept, but simplify how we speak about experimental paths -- this concept is also widely referred to as the "experiment group".<br clear="all">
 
 [[_TOC_]]
 
@@ -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
 
@@ -217,39 +217,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 +312,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 +321,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 +342,23 @@ 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`.
 
 ## Configuration
 
@@ -401,6 +416,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).

data/lib/gitlab/experiment.rb

@@ -2,10 +2,11 @@
 
 require 'scientist'
 require 'active_support/callbacks'
+require 'active_support/cache'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/string/inflections'
 
-require 'gitlab/experiment/caching'
+require 'gitlab/experiment/cache'
 require 'gitlab/experiment/callbacks'
 require 'gitlab/experiment/configuration'
 require 'gitlab/experiment/cookies'
@@ -18,7 +19,7 @@ require 'gitlab/experiment/engine' if defined?(Rails::Engine)
 module Gitlab
   class Experiment
     include Scientist::Experiment
-    include Caching
+    include Cache
     include Callbacks
 
     class << self
@@ -66,6 +67,10 @@ module Gitlab
       yield self if block_given?
     end
 
+    def inspect
+      "#<#{self.class.name || 'AnonymousClass'}:#{format('0x%016X', __id__)} @name=#{name} @context=#{context.value}>"
+    end
+
     def context(value = nil)
       return @context if value.blank?
 
@@ -74,11 +79,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?
+      return Variant.new(name: (@variant_name || :unresolved).to_s) if @variant_name || @resolving_variant
 
       if enabled?
         @variant_name ||= :control if excluded?
@@ -89,18 +91,16 @@ 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 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)
@@ -148,18 +148,14 @@ module Gitlab
       "Experiment;#{id}"
     end
 
-    def key_for(hash)
-      instance_exec(hash, &Configuration.context_hash_strategy)
-    end
-
-    protected
-
     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
 
@@ -167,8 +163,16 @@ module Gitlab
       enabled? && !excluded?
     end
 
-    def run_with_segmenting?
-      !variant_assigned? && enabled? && !excluded?
+    def key_for(hash)
+      instance_exec(hash, &Configuration.context_hash_strategy)
+    end
+
+    protected
+
+    def segmentation_callback_chain
+      return :segmentation_check if !variant_assigned? && enabled? && !excluded?
+
+      :unsegmented
     end
 
     def variant_assigned?

data/lib/gitlab/experiment/cache.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+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

@@ -7,8 +7,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 +34,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/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/rspec.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+module Gitlab
+  class Experiment
+    module RSpecHelpers
+      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
+
+          # 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)
+        end
+      end
+
+      def wrapped_experiment(experiment, shallow: false, failure: nil, &block)
+        if shallow
+          yield experiment if block.present?
+          return experiment
+        end
+
+        receive_wrapped_new = receive(:new).and_wrap_original do |new, *new_args, &new_block|
+          instance = new.call(*new_args)
+          instance.tap(&block) if block.present?
+          instance.tap(&new_block) if new_block.present?
+          instance
+        end
+
+        klass = experiment.class == Class ? experiment : experiment.class
+        if failure
+          expect(klass).to receive_wrapped_new, failure
+        else
+          allow(klass).to receive_wrapped_new
+        end
+      end
+    end
+
+    module RSpecMatchers
+      extend RSpec::Matchers::DSL
+
+      def require_experiment(experiment, matcher_name, classes: false)
+        klass = experiment.class == Class ? experiment : experiment.class
+        unless klass <= Gitlab::Experiment
+          raise(
+            ArgumentError,
+            "#{matcher_name} matcher is limited to experiment instances#{classes ? ' and classes' : ''}"
+          )
+        end
+
+        if experiment == klass && !classes
+          raise ArgumentError, "#{matcher_name} matcher requires an instance of an experiment"
+        end
+
+        experiment != klass
+      end
+
+      matcher :exclude do |context|
+        ivar = :'@excluded'
+
+        match do |experiment|
+          require_experiment(experiment, 'exclude')
+          experiment.context(context)
+
+          experiment.instance_variable_set(ivar, nil)
+          !experiment.run_callbacks(:exclusion_check) { :not_excluded }
+        end
+
+        failure_message do
+          %(expected #{context} to be excluded)
+        end
+
+        failure_message_when_negated do
+          %(expected #{context} not to be excluded)
+        end
+      end
+
+      matcher :segment do |context|
+        ivar = :'@variant_name'
+
+        match do |experiment|
+          require_experiment(experiment, 'segment')
+          experiment.context(context)
+
+          experiment.instance_variable_set(ivar, nil)
+          experiment.run_callbacks(:segmentation_check)
+
+          @actual = experiment.instance_variable_get(ivar)
+          @expected ? @actual.to_s == @expected.to_s : @actual.present?
+        end
+
+        chain :into do |expected|
+          raise ArgumentError, 'variant name must be provided' if expected.blank?
+
+          @expected = expected.to_s
+        end
+
+        failure_message do
+          %(expected #{context} to be segmented#{message_details})
+        end
+
+        failure_message_when_negated do
+          %(expected #{context} not to be segmented#{message_details})
+        end
+
+        def message_details
+          message = ''
+          message += %( into variant\n    expected variant: #{@expected}) if @expected
+          message += %(\n      actual variant: #{@actual}) if @actual
+          message
+        end
+      end
+
+      matcher :track do |event, *event_args|
+        match do |experiment|
+          expect_tracking_on(experiment, false, event, *event_args)
+        end
+
+        match_when_negated do |experiment|
+          expect_tracking_on(experiment, true, event, *event_args)
+        end
+
+        chain :for do |expected_variant|
+          raise ArgumentError, 'variant name must be provided' if expected.blank?
+
+          @expected_variant = expected_variant.to_s
+        end
+
+        chain(:with_context) { |expected_context| @expected_context = expected_context }
+        chain(:on_any_instance) { @on_self = 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|
+            @experiment = instance
+            allow(@experiment).to receive(:track)
+
+            if negated
+              expect(@experiment).not_to receive_tracking_call_for(event, *event_args)
+            else
+              expect(@experiment).to receive_tracking_call_for(event, *event_args)
+            end
+          end
+        end
+
+        def receive_tracking_call_for(event, *event_args)
+          receive(:track).with(*[event, *event_args]) do # rubocop:disable CodeReuse/ActiveRecord
+            if @expected_variant
+              expect(@experiment.variant.name).to eq(@expected_variant), failure_message(:variant, event)
+            end
+
+            if @expected_context
+              expect(@experiment.context.value).to include(@expected_context), failure_message(:context, event)
+            end
+          end
+        end
+
+        def failure_message(failure_type, event)
+          case failure_type
+          when :variant
+            <<~MESSAGE.strip
+              expected #{@experiment.inspect} to have tracked #{event.inspect} for variant
+                  expected variant: #{@expected_variant}
+                    actual variant: #{@experiment.variant.name}
+            MESSAGE
+          when :context
+            <<~MESSAGE.strip
+              expected #{@experiment.inspect} to have tracked #{event.inspect} with context
+                  expected context: #{@expected_context}
+                    actual context: #{@experiment.context.value}
+            MESSAGE
+          when :no_new
+            %(expected #{@experiment.inspect} to have tracked #{event.inspect}, but no new instances were created)
+          end
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Gitlab::Experiment::RSpecHelpers
+  config.include Gitlab::Experiment::Dsl
+
+  config.include Gitlab::Experiment::RSpecMatchers, :experiment
+  config.define_derived_metadata(file_path: Regexp.new('/spec/experiments/')) do |metadata|
+    metadata[:type] = :experiment
+  end
+end

data/lib/gitlab/experiment/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   class Experiment
-    VERSION = '0.4.6'
+    VERSION = '0.4.11'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-experiment
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.11
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-21 00:00:00.000000000 Z
+date: 2021-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -65,14 +65,15 @@ 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/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/rspec_matchers.rb
+- lib/gitlab/experiment/rspec.rb
 - lib/gitlab/experiment/variant.rb
 - lib/gitlab/experiment/version.rb
 homepage: https://gitlab.com/gitlab-org/gitlab-experiment

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

data/lib/gitlab/experiment/rspec_matchers.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-module Gitlab
-  class Experiment
-    module RspecMatchers
-      extend RSpec::Matchers::DSL
-
-      matcher :exclude do |context|
-        ivar = :'@excluded'
-
-        match do |experiment|
-          experiment.context(context)
-
-          experiment.instance_variable_set(ivar, nil)
-          !experiment.run_callbacks(:exclusion_check) { :not_excluded }
-        end
-
-        failure_message do
-          %(expected #{context} to be excluded)
-        end
-
-        failure_message_when_negated do
-          %(expected #{context} not to be excluded)
-        end
-      end
-
-      matcher :segment do |context|
-        ivar = :'@variant_name'
-
-        match do |experiment|
-          experiment.context(context)
-
-          experiment.instance_variable_set(ivar, nil)
-          experiment.run_callbacks(:segmented_run)
-
-          @actual = experiment.instance_variable_get(ivar)
-          @expected ? @actual.to_s == @expected.to_s : @actual.present?
-        end
-
-        chain :into do |expected|
-          raise ArgumentError, 'variant name must be provided' if expected.blank?
-
-          @expected = expected.to_s
-        end
-
-        failure_message do
-          %(expected #{context} to be segmented#{message_details})
-        end
-
-        failure_message_when_negated do
-          %(expected #{context} not to be segmented#{message_details})
-        end
-
-        def message_details
-          message = ''
-          message += %(\n    into: #{@expected}) if @expected
-          message += %(\n  actual: #{@actual}) if @actual
-          message
-        end
-      end
-
-      matcher :track do |event, *event_args|
-        match do |experiment|
-          wrapped(experiment) { |instance| expect(instance).to receive_with(event, *event_args) }
-        end
-
-        match_when_negated do |experiment|
-          wrapped(experiment) { |instance| expect(instance).not_to receive_with(event, *event_args) }
-        end
-
-        def wrapped(experiment, &block)
-          allow(experiment.class).to receive(:new).and_wrap_original do |new, *new_args|
-            new.call(*new_args).tap(&block)
-          end
-        end
-
-        def receive_with(*args)
-          receive(:track).with(*args) # rubocop:disable CodeReuse/ActiveRecord
-        end
-      end
-    end
-  end
-end
-
-RSpec.configure do |config|
-  config.define_derived_metadata(file_path: Regexp.new('/spec/experiments/')) do |metadata|
-    metadata[:type] = :experiment
-  end
-
-  config.include Gitlab::Experiment::RspecMatchers, :experiment
-end