gitlab-experiment 0.7.1 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83f13c3f8259c739163ada749acee80ecbfb48f1b94f66a4cd69e265c29df874
-  data.tar.gz: e70fca76e1af2f6234d888473a31cdf088bf44d0bb5dc13dbf84f40e781076bd
+  metadata.gz: 2ff3ecacc0f83a605ecaad79cef7368802307b9bc1c106eca1c74967ade3a00c
+  data.tar.gz: a72ceadbbcd689a290bdf7f85b9dababa7f7ae252bc3886a6fcd42170e561ee7
 SHA512:
-  metadata.gz: 9d0964f78bfea29586c176cf001a335df04618e62dfd1a76952d5d12d643de6970d8eeec063b1a28255fabfad8a3fd2b47df233cea6d071b46d98d7867b97185
-  data.tar.gz: 172778e34c61ffe02f3d11e5538beef44ddd0f8c5e2f6029a449904264eb1365f2f013aad25648e3c1ee0fd19a015aa69a6e62de9867f87c339f8c36e4d14776
+  metadata.gz: 6d7f1804cf3503fd0fcf5be75ca6c4d3bfebcdccd3baf5aa3937a7c080e8336c15491a3476a9a7aef30060d0a526f4f71c6803d0a8ae8c08b0192e1401e1070c
+  data.tar.gz: 4f739b5852733e789ab23ce0b96215d023e4483ef32ae055373bfe3083d212fb5f01aa8b45ee55bfbac0a8a734e5ec429eac175a49a0219256d6f8f62151027a

data/README.md

@@ -499,9 +499,7 @@ Anyway, now you can use your custom `Flipper` rollout strategy by instantiating
 
 ```ruby
 Gitlab::Experiment.configure do |config|
-  config.default_rollout = Gitlab::Experiment::Rollout::Flipper.new(
-    include_control: true # specify to include control, which we want to do
-  )
+  config.default_rollout = Gitlab::Experiment::Rollout::Flipper.new
 end
 ```
 
@@ -512,7 +510,6 @@ class PillColorExperiment < Gitlab::Experiment # OR ApplicationExperiment
   # ...registered behaviors
 
   default_rollout :flipper,
-    include_control: true, # optionally specify to include control
     distribution: { control: 26, red: 37, blue: 37 } # optionally specify distribution
 end
 ```

data/lib/generators/gitlab/experiment/experiment_generator.rb

@@ -8,15 +8,9 @@ module Gitlab
       source_root File.expand_path('templates/', __dir__)
       check_class_collision suffix: 'Experiment'
 
-      argument     :variants,
-                   type: :array,
-                   default: %w[control candidate],
-                   banner: 'variant variant'
-
-      class_option :skip_comments,
-                   type: :boolean,
-                   default: false,
-                   desc: 'Omit helpful comments from generated files'
+      argument :variants, type: :array, default: %w[control candidate], banner: 'variant variant'
+
+      class_option :skip_comments, type: :boolean, default: false, desc: 'Omit helpful comments from generated files'
 
       def create_experiment
         template 'experiment.rb', File.join('app/experiments', class_path, "#{file_name}_experiment.rb")

data/lib/generators/gitlab/experiment/install/install_generator.rb

@@ -11,14 +11,9 @@ module Gitlab
         desc 'Installs the Gitlab::Experiment initializer and optional ApplicationExperiment into your application.'
 
         class_option :skip_initializer,
-                     type: :boolean,
-                     default: false,
-                     desc: 'Skip the initializer with default configuration'
-
-        class_option :skip_baseclass,
-                     type: :boolean,
-                     default: false,
-                     desc: 'Skip the ApplicationExperiment base class'
+          type: :boolean, default: false, desc: 'Skip the initializer with default configuration'
+
+        class_option :skip_baseclass, type: :boolean, default: false, desc: 'Skip the ApplicationExperiment base class'
 
         def create_initializer
           return if options[:skip_initializer]

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

@@ -43,15 +43,12 @@ Gitlab::Experiment.configure do |config|
   # Each experiment can specify its own rollout strategy:
   #
   # class ExampleExperiment < ApplicationExperiment
-  #   default_rollout :random,              # :percent, :round_robin,
-  #                   include_control: true # or MyCustomRollout
+  #   default_rollout :random # :percent, :round_robin, or MyCustomRollout
   # end
   #
   # Included rollout strategies:
   #   :percent (recommended), :round_robin, or :random
-  config.default_rollout = :percent, {
-    include_control: true # include control in possible assignments
-  )
+  config.default_rollout = :percent
 
   # Secret seed used in generating context keys.
   #

data/lib/gitlab/experiment/base_interface.rb

@@ -78,79 +78,33 @@ module Gitlab
 
       alias_method :to_param, :id
 
-      def variant_names
-        @_variant_names ||= behaviors.keys.map(&:to_sym) - [:control]
-      end
+      def process_redirect_url(url)
+        return unless Configuration.redirect_url_validator&.call(url)
 
-      def behaviors
-        @_behaviors ||= public_behaviors_with_deprecations(registered_behavior_callbacks)
+        track('visited', url: url)
+        url # return the url, which allows for mutation
       end
 
-      # @deprecated
-      def public_behaviors_with_deprecations(behaviors)
-        named_variants = %w[control candidate]
-        public_methods.each_with_object(behaviors) do |name, behaviors|
-          name = name.to_s # fixes compatibility for ruby 2.6.x
-          next unless name.end_with?('_behavior')
-
-          behavior_name = name.sub(/_behavior$/, '')
-          registration = named_variants.include?(behavior_name) ? behavior_name : "variant :#{behavior_name}"
-
-          Configuration.deprecated(<<~MESSAGE, version: '0.7.0', stack: 2)
-            using a public `#{name}` method is deprecated and will be removed from {{release}}, instead register variants using:
-
-            class #{self.class.name} < #{Configuration.base_class}
-              #{registration}
+      def key_for(source, seed = name)
+        return source if source.is_a?(String)
 
-              private
+        source = source.keys + source.values if source.is_a?(Hash)
 
-              def #{name}
-                #...
-              end
-            end
-          MESSAGE
-
-          behaviors[behavior_name] ||= -> { send(name) } # rubocop:disable GitlabSecurity/PublicSend
-        end
-      end
+        ingredients = Array(source).map { |v| identify(v) }
+        ingredients.unshift(seed).unshift(Configuration.context_key_secret)
 
-      # @deprecated
-      def session_id
-        Configuration.deprecated(:session_id, 'instead use `id` or use a custom rollout strategy', version: '0.7.0')
-        id
+        Digest::SHA2.new(Configuration.context_key_bit_length).hexdigest(ingredients.join('|')) # rubocop:disable Fips/OpenSSL
       end
 
       # @deprecated
-      def flipper_id
-        Configuration.deprecated(:flipper_id, 'instead use `id` or use a custom rollout strategy', version: '0.7.0')
-        "Experiment;#{id}"
-      end
-
-      # @deprecated
-      def use(&block)
-        Configuration.deprecated(:use, 'instead use `control`', version: '0.7.0')
-
-        control(&block)
-      end
-
-      # @deprecated
-      def try(name = nil, &block)
-        if name.present?
-          Configuration.deprecated(:try, "instead use `variant(:#{name})`", version: '0.7.0')
-          variant(name, &block)
-        else
-          Configuration.deprecated(:try, 'instead use `candidate`', version: '0.7.0')
-          candidate(&block)
-        end
-      end
-
-      protected
-
-      def cached_variant_resolver(provided_variant)
-        return :control if excluded?
+      def variant_names
+        Configuration.deprecated(
+          :variant_names,
+          'instead use `behavior.names`, which includes :control',
+          version: '0.8.0'
+        )
 
-        result = cache_variant(provided_variant) { resolve_variant_name }
-        result.to_sym if result.present?
+        behaviors.keys - [:control]
       end
     end
   end

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

@@ -48,18 +48,18 @@ module Gitlab
           key.to_s.split(':') # this assumes the default strategy in gitlab-experiment
         end
 
-        def read_entry(key, **options)
+        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)
+        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)
+        def delete_entry(key, **_options)
           pool { |redis| redis.hdel(*hkey(key)) }
         end
       end

data/lib/gitlab/experiment/cache.rb

@@ -49,7 +49,7 @@ module Gitlab
         result = migrated_cache_fetch(cache.store, &block)
         return result unless specified.present?
 
-        cache.write(specified) if result != specified
+        cache.write(specified) if result.to_s != specified.to_s
         specified
       end
 
@@ -62,7 +62,9 @@ module Gitlab
       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))
+          value = store.read(old_key)
+
+          next unless value
 
           store.write(cache_key, value)
           store.delete(old_key)

data/lib/gitlab/experiment/callbacks.rb

@@ -47,14 +47,14 @@ module Gitlab
         private
 
         def build_behavior_callback(filters, variant, **options, &block)
-          if registered_behavior_callbacks[variant.to_s]
+          if registered_behavior_callbacks[variant]
             raise ExistingBehaviorError, "a behavior for the `#{variant}` variant has already been registered"
           end
 
           callback_behavior = "#{variant}_behavior".to_sym
 
           # Register a the behavior so we can define the block later.
-          registered_behavior_callbacks[variant.to_s] = callback_behavior
+          registered_behavior_callbacks[variant] = callback_behavior
 
           # Add our block or default behavior method.
           filters.push(block) if block.present?

data/lib/gitlab/experiment/configuration.rb

@@ -39,6 +39,11 @@ module Gitlab
       #   nil, :all, or ['www.gitlab.com', '.gitlab.com']
       @cookie_domain = :all
 
+      # The cookie name for an experiment.
+      @cookie_name = lambda do |experiment|
+        "#{experiment.name}_id"
+      end
+
       # The default rollout strategy.
       #
       # The recommended default rollout strategy when not using caching would
@@ -51,13 +56,12 @@ module Gitlab
       # Each experiment can specify its own rollout strategy:
       #
       # class ExampleExperiment < ApplicationExperiment
-      #   default_rollout :random,              # :percent, :round_robin,
-      #                   include_control: true # or MyCustomRollout
+      #   default_rollout :random # :percent, :round_robin, or MyCustomRollout
       # end
       #
       # Included rollout strategies:
       #   :percent, (recommended), :round_robin, or :random
-      @default_rollout = Rollout.resolve(:percent, include_control: true)
+      @default_rollout = Rollout.resolve(:percent)
 
       # Secret seed used in generating context keys.
       #
@@ -165,61 +169,6 @@ module Gitlab
       end
 
       class << self
-        # @deprecated
-        def context_hash_strategy=(block)
-          deprecated(
-            :context_hash_strategy,
-            'instead use `context_key_secret` and `context_key_bit_length`',
-            version: '0.7.0'
-          )
-
-          @__context_hash_strategy = block
-        end
-
-        # @deprecated
-        def variant_resolver
-          deprecated(
-            :variant_resolver,
-            'instead use `inclusion_resolver` with a block that returns a boolean',
-            version: '0.6.5'
-          )
-
-          @__inclusion_resolver
-        end
-
-        # @deprecated
-        def variant_resolver=(block)
-          deprecated(
-            :variant_resolver,
-            'instead use `inclusion_resolver` with a block that returns a boolean',
-            version: '0.6.5'
-          )
-
-          @__inclusion_resolver = block
-        end
-
-        # @deprecated
-        def inclusion_resolver=(block)
-          deprecated(
-            :inclusion_resolver,
-            'instead put this logic into custom rollout strategies',
-            version: '0.7.0'
-          )
-
-          @__inclusion_resolver = block
-        end
-
-        # @deprecated
-        def inclusion_resolver
-          deprecated(
-            :inclusion_resolver,
-            'instead put this logic into custom rollout strategies',
-            version: '0.7.0'
-          )
-
-          @__inclusion_resolver
-        end
-
         attr_accessor(
           :name_prefix,
           :logger,
@@ -227,6 +176,7 @@ module Gitlab
           :strict_registration,
           :cache,
           :cookie_domain,
+          :cookie_name,
           :context_key_secret,
           :context_key_bit_length,
           :mount_at,
@@ -240,17 +190,7 @@ module Gitlab
         # Attribute method overrides.
 
         def default_rollout=(args) # rubocop:disable Lint/DuplicateMethods
-          rollout, options = Array(args)
-          if rollout.is_a?(Rollout::Base)
-            options = rollout.options
-            rollout = rollout.class
-
-            deprecated(<<~MESSAGE, version: '0.7.0')
-              using a rollout instance with `default_rollout` is deprecated and will be removed from {{release}} (instead use `default_rollout = #{rollout.name}, #{options.inspect}`)
-            MESSAGE
-          end
-
-          @default_rollout = Rollout.resolve(rollout, options || {})
+          @default_rollout = Rollout.resolve(*args)
         end
 
         # Internal warning helpers.

data/lib/gitlab/experiment/context.rb

@@ -7,6 +7,8 @@ module Gitlab
 
       DNT_REGEXP = /^(true|t|yes|y|1|on)$/i.freeze
 
+      attr_reader :request
+
       def initialize(experiment, **initial_value)
         @experiment = experiment
         @value = {}
@@ -63,7 +65,7 @@ module Gitlab
         add_unmerged_migration(value.delete(:migrated_from))
         add_merged_migration(value.delete(:migrated_with))
 
-        migrate_cookie(value, "#{@experiment.name}_id")
+        migrate_cookie(value, @experiment.instance_exec(@experiment, &Configuration.cookie_name))
       end
 
       def add_unmerged_migration(value = {})

data/lib/gitlab/experiment/engine.rb

@@ -21,6 +21,7 @@ module Gitlab
       private
 
       def include_dsl
+        Dsl.include_in(ActionController::API, with_helper: false) if defined?(ActionController)
         Dsl.include_in(ActionController::Base, with_helper: true) if defined?(ActionController)
         Dsl.include_in(ActionMailer::Base, with_helper: true) if defined?(ActionMailer)
       end

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

@@ -34,10 +34,10 @@ module Gitlab
         def validate!
           case distribution_rules
           when nil then nil
-          when Array, Hash
-            if distribution_rules.length != behavior_names.length
-              raise InvalidRolloutRules, "the distribution rules don't match the number of variants defined"
-            end
+          when Array
+            validate_distribution_rules(distribution_rules)
+          when Hash
+            validate_distribution_rules(distribution_rules.values)
           else
             raise InvalidRolloutRules, 'unknown distribution options type'
           end
@@ -66,6 +66,16 @@ module Gitlab
         def distribution_rules
           options[:distribution]
         end
+
+        def validate_distribution_rules(distributions)
+          if distributions.length != behavior_names.length
+            raise InvalidRolloutRules, "the distribution rules don't match the number of behaviors defined"
+          end
+
+          return if distributions.sum == 100
+
+          raise InvalidRolloutRules, 'the distribution percentages should add up to 100'
+        end
       end
     end
   end

data/lib/gitlab/experiment/rollout.rb

@@ -8,6 +8,7 @@ module Gitlab
       autoload :RoundRobin, 'gitlab/experiment/rollout/round_robin.rb'
 
       def self.resolve(klass, options = {})
+        options ||= {}
         case klass
         when String
           Strategy.new(klass.classify.constantize, options)
@@ -21,44 +22,29 @@ module Gitlab
       end
 
       class Base
-        DEFAULT_OPTIONS = {
-          include_control: false
-        }.freeze
-
         attr_reader :experiment, :options
 
-        delegate :variant_names, :cache, :id, to: :experiment
-
-        def initialize(options = {})
-          @options = DEFAULT_OPTIONS.merge(options)
-        end
+        delegate :cache, :id, to: :experiment
 
-        def for(experiment)
+        def initialize(experiment, options = {})
           raise ArgumentError, 'you must provide an experiment instance' unless experiment.class <= Gitlab::Experiment
 
           @experiment = experiment
-
-          self
+          @options = options
         end
 
         def enabled?
-          require_experiment(__method__)
-
           true
         end
 
         def resolve
-          require_experiment(__method__)
-
-          return nil if @experiment.respond_to?(:experiment_group?) && !@experiment.experiment_group?
-
           validate! # allow the rollout strategy to validate itself
 
           assignment = execute_assignment
-          assignment == :control ? nil : assignment # avoid caching control
+          assignment == :control ? nil : assignment # avoid caching control by returning nil
         end
 
-        protected
+        private
 
         def validate!
           # base is always valid
@@ -68,22 +54,14 @@ module Gitlab
           behavior_names.first
         end
 
-        private
-
-        def require_experiment(method_name)
-          return if @experiment.present?
-
-          raise ArgumentError, "you need to call `for` with an experiment instance before chaining `#{method_name}`"
-        end
-
         def behavior_names
-          options[:include_control] ? [:control] + variant_names : variant_names
+          experiment.behaviors.keys
         end
       end
 
       Strategy = Struct.new(:klass, :options) do
         def for(experiment)
-          klass.new(options).for(experiment)
+          klass.new(experiment, options)
         end
       end
     end

data/lib/gitlab/experiment/rspec.rb

@@ -14,13 +14,13 @@ module Gitlab
       def self.track_gitlab_experiment_receiver(method, receiver)
         # Leverage the `>=` method on Gitlab::Experiment to determine if the receiver is an experiment, not the other
         # way round -- `receiver.<=` could be mocked and we want to be extra careful.
-        (@__gitlab_experiment_receivers[method.to_s] ||= []) << receiver if Gitlab::Experiment >= receiver
+        (@__gitlab_experiment_receivers[method] ||= []) << receiver if Gitlab::Experiment >= receiver
       rescue StandardError # again, let's just be extra careful
         false
       end
 
       def self.bind_gitlab_experiment_receiver(method)
-        method.unbind.bind(@__gitlab_experiment_receivers[method.to_s].pop)
+        method.unbind.bind(@__gitlab_experiment_receivers[method].pop)
       end
 
       module MethodDouble
@@ -28,6 +28,7 @@ module Gitlab
           RSpecMocks.track_gitlab_experiment_receiver(original_method, receiver)
           super
         end
+        ruby2_keywords :proxy_method_invoked if respond_to?(:ruby2_keywords, true)
       end
     end
 
@@ -37,9 +38,6 @@ module Gitlab
           wrapped_experiment(experiment, remock: true) do |instance, wrapped|
             # Stub internal methods that will make it behave as we've instructed.
             allow(instance).to receive(:enabled?) { wrapped.variant_name != false }
-            if instance.respond_to?(:experiment_group?, true)
-              allow(instance).to receive(:experiment_group?) { !(wrapped.variant_name == false) }
-            end
 
             # Stub the variant resolution logic to handle true/false, and named variants.
             allow(instance).to receive(:resolve_variant_name).and_wrap_original { |method|
@@ -72,8 +70,8 @@ module Gitlab
       def wrapped_experiment_chain_for(klass)
         @__wrapped_experiment_chains ||= {}
         @__wrapped_experiment_chains[klass.name || klass.object_id] ||= begin
-          allow(klass).to receive(:new).and_wrap_original do |method, *args, &original_block|
-            RSpecMocks.bind_gitlab_experiment_receiver(method).call(*args).tap do |instance|
+          allow(klass).to receive(:new).and_wrap_original do |method, *args, **kwargs, &original_block|
+            RSpecMocks.bind_gitlab_experiment_receiver(method).call(*args, **kwargs).tap do |instance|
               wrapped = @__wrapped_experiments[instance.instance_variable_get(:@_name)]
               wrapped&.blocks&.each { |b| b.call(instance, wrapped) }
 
@@ -128,7 +126,7 @@ module Gitlab
         match do |experiment|
           @experiment = require_experiment(experiment, 'register_behavior')
 
-          block = @experiment.behaviors[behavior_name.to_s]
+          block = @experiment.behaviors[behavior_name]
           @return_expected = false unless block
 
           if @return_expected
@@ -193,13 +191,13 @@ module Gitlab
           @experiment.run_callbacks(:segmentation)
 
           @actual_variant = @experiment.instance_variable_get(:@_assigned_variant_name)
-          @expected_variant ? @actual_variant.to_s == @expected_variant.to_s : @actual_variant.present?
+          @expected_variant ? @actual_variant == @expected_variant : @actual_variant.present?
         end
 
         chain :into do |expected|
           raise ArgumentError, 'variant name must be provided' if expected.blank?
 
-          @expected_variant = expected.to_s
+          @expected_variant = expected
         end
 
         failure_message do
@@ -239,7 +237,7 @@ module Gitlab
         chain(:for) do |expected|
           raise ArgumentError, 'variant name must be provided' if expected.blank?
 
-          @expected_variant = expected.to_s
+          @expected_variant = expected
         end
 
         chain(:with_context) do |expected|
@@ -303,17 +301,16 @@ RSpec.configure do |config|
   config.include Gitlab::Experiment::RSpecHelpers
   config.include Gitlab::Experiment::Dsl
 
-  clear_cache = proc do
-    RequestStore.clear!
+  config.before(:each) do |example|
+    if example.metadata[:experiment] == true || example.metadata[:type] == :experiment
+      RequestStore.clear!
 
-    if defined?(Gitlab::Experiment::TestBehaviors::TrackedStructure)
-      Gitlab::Experiment::TestBehaviors::TrackedStructure.reset!
+      if defined?(Gitlab::Experiment::TestBehaviors::TrackedStructure)
+        Gitlab::Experiment::TestBehaviors::TrackedStructure.reset!
+      end
     end
   end
 
-  config.before(:each, :experiment, &clear_cache)
-  config.before(:each, type: :experiment, &clear_cache)
-
   config.include Gitlab::Experiment::RSpecMatchers, :experiment
   config.include Gitlab::Experiment::RSpecMatchers, type: :experiment
 

data/lib/gitlab/experiment/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   class Experiment
-    VERSION = '0.7.1'
+    VERSION = '0.9.1'
   end
 end

data/lib/gitlab/experiment.rb

@@ -3,6 +3,7 @@
 require 'request_store'
 require 'active_support'
 require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/string/inflections'
 
 require 'gitlab/experiment/errors'
@@ -87,34 +88,15 @@ module Gitlab
       variant(:control, &block)
     end
 
-    def candidate(name = nil, &block)
-      if name.present?
-        Configuration.deprecated(<<~MESSAGE, version: '0.7.0')
-          passing name to `candidate` is deprecated and will be removed from {{release}} (instead use `variant(#{name.inspect})`)
-        MESSAGE
-      end
-
-      variant(name || :candidate, &block)
+    def candidate(&block)
+      variant(:candidate, &block)
     end
 
-    def variant(name = nil, &block)
-      if block.present? # we know we're defining a variant block
-        raise ArgumentError, 'missing variant name' if name.blank?
-
-        return behaviors[name.to_s] = block
-      end
-
-      if name.present?
-        Configuration.deprecated(<<~MESSAGE, version: '0.7.0')
-          setting the variant using `variant` is deprecated and will be removed from {{release}} (instead use `assigned(#{name.inspect})`)
-        MESSAGE
-      else
-        Configuration.deprecated(<<~MESSAGE, version: '0.7.0')
-          getting the assigned variant using `variant` is deprecated and will be removed from {{release}} (instead use `assigned`)
-        MESSAGE
-      end
+    def variant(name, &block)
+      raise ArgumentError, 'name required' if name.blank?
+      raise ArgumentError, 'block required' unless block.present?
 
-      assigned(name)
+      behaviors[name] = block
     end
 
     def context(value = nil)
@@ -126,9 +108,7 @@ module Gitlab
 
     def assigned(value = nil)
       @_assigned_variant_name = cache_variant(value) if value.present?
-      if @_assigned_variant_name || @_resolving_variant
-        return Variant.new(name: (@_assigned_variant_name || :unresolved).to_s)
-      end
+      return Variant.new(name: @_assigned_variant_name || :unresolved) if @_assigned_variant_name || @_resolving_variant
 
       if enabled?
         @_resolving_variant = true
@@ -137,7 +117,7 @@ module Gitlab
 
       run_callbacks(segmentation_callback_chain) do
         @_assigned_variant_name ||= :control
-        Variant.new(name: @_assigned_variant_name.to_s)
+        Variant.new(name: @_assigned_variant_name)
       end
     ensure
       @_resolving_variant = false
@@ -171,13 +151,6 @@ module Gitlab
       instance_exec(action, tracking_context(event_args).try(:compact) || {}, &Configuration.tracking_behavior)
     end
 
-    def process_redirect_url(url)
-      return unless Configuration.redirect_url_validator&.call(url)
-
-      track('visited', url: url)
-      url # return the url, which allows for mutation
-    end
-
     def enabled?
       rollout.enabled?
     end
@@ -193,23 +166,11 @@ module Gitlab
     end
 
     def signature
-      { variant: assigned.name, experiment: name }.merge(context.signature)
+      { variant: assigned.name.to_s, experiment: name }.merge(context.signature)
     end
 
-    def key_for(source, seed = name)
-      # TODO: Remove - deprecated in release 0.7.0
-      if (block = Configuration.instance_variable_get(:@__context_hash_strategy))
-        return instance_exec(source, seed, &block)
-      end
-
-      return source if source.is_a?(String)
-
-      source = source.keys + source.values if source.is_a?(Hash)
-
-      ingredients = Array(source).map { |v| identify(v) }
-      ingredients.unshift(seed).unshift(Configuration.context_key_secret)
-
-      Digest::SHA2.new(Configuration.context_key_bit_length).hexdigest(ingredients.join('|'))
+    def behaviors
+      @_behaviors ||= registered_behavior_callbacks
     end
 
     protected
@@ -218,23 +179,15 @@ module Gitlab
       (object.respond_to?(:to_global_id) ? object.to_global_id : object).to_s
     end
 
+    def cached_variant_resolver(provided_variant)
+      return :control if excluded?
+
+      result = cache_variant(provided_variant) { resolve_variant_name }
+      result.to_sym if result.present?
+    end
+
     def resolve_variant_name
-      if respond_to?(:experiment_group?, true)
-        # TODO: Remove - deprecated in release 0.7.0
-        Configuration.deprecated(:experiment_group?, <<~MESSAGE, version: '0.7.0')
-          instead put this logic into custom rollout strategies
-        MESSAGE
-
-        rollout.resolve if experiment_group?
-      elsif (block = Configuration.instance_variable_get(:@__inclusion_resolver))
-        # TODO: Remove - deprecated in release 0.7.0
-        rollout.resolve if instance_exec(@_assigned_variant_name, &block)
-      elsif (block = Configuration.instance_variable_get(:@__variant_resolver))
-        # TODO: Remove - deprecated in release 0.6.5
-        instance_exec(@_assigned_variant_name, &block)
-      else
-        rollout.resolve # this is the end result of all deprecations
-      end
+      rollout.resolve
     end
 
     def tracking_context(event_args)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-experiment
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.9.1
 platform: ruby
 authors:
 - GitLab
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 
+date:
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,7 +38,161 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: gitlab-dangerfiles
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: gitlab-styles
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+- !ruby/object:Gem::Dependency
+  name: lefthook
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.7
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.20.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.20.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.22.0
+- !ruby/object:Gem::Dependency
+  name: flipper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.26.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.26.2
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+- !ruby/object:Gem::Dependency
+  name: rspec-parameterized-table_syntax
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description:
 email:
 - gitlab_rubygems@gitlab.com
 executables: []
@@ -47,59 +201,58 @@ extra_rdoc_files: []
 files:
 - lib/generators/gitlab
 - lib/generators/gitlab/experiment
+- lib/generators/gitlab/experiment/USAGE
+- lib/generators/gitlab/experiment/experiment_generator.rb
 - lib/generators/gitlab/experiment/install
 - lib/generators/gitlab/experiment/install/install_generator.rb
 - lib/generators/gitlab/experiment/install/templates
+- lib/generators/gitlab/experiment/install/templates/POST_INSTALL
 - lib/generators/gitlab/experiment/install/templates/application_experiment.rb.tt
 - lib/generators/gitlab/experiment/install/templates/initializer.rb.tt
-- lib/generators/gitlab/experiment/install/templates/POST_INSTALL
-- lib/generators/gitlab/experiment/USAGE
-- lib/generators/gitlab/experiment/experiment_generator.rb
 - lib/generators/gitlab/experiment/templates
 - lib/generators/gitlab/experiment/templates/experiment.rb.tt
-- lib/generators/test_unit
-- lib/generators/test_unit/experiment
-- lib/generators/test_unit/experiment/experiment_generator.rb
-- lib/generators/test_unit/experiment/templates
-- lib/generators/test_unit/experiment/templates/experiment_test.rb.tt
 - lib/generators/rspec
 - lib/generators/rspec/experiment
 - lib/generators/rspec/experiment/experiment_generator.rb
 - lib/generators/rspec/experiment/templates
 - lib/generators/rspec/experiment/templates/experiment_spec.rb.tt
-- lib/gitlab/experiment.rb
+- lib/generators/test_unit
+- lib/generators/test_unit/experiment
+- lib/generators/test_unit/experiment/experiment_generator.rb
+- lib/generators/test_unit/experiment/templates
+- lib/generators/test_unit/experiment/templates/experiment_test.rb.tt
 - lib/gitlab/experiment
-- lib/gitlab/experiment/variant.rb
-- lib/gitlab/experiment/middleware.rb
-- lib/gitlab/experiment/test_behaviors
-- lib/gitlab/experiment/test_behaviors/trackable.rb
+- lib/gitlab/experiment/base_interface.rb
 - lib/gitlab/experiment/cache
 - lib/gitlab/experiment/cache/redis_hash_store.rb
-- lib/gitlab/experiment/errors.rb
+- lib/gitlab/experiment/cache.rb
 - lib/gitlab/experiment/callbacks.rb
-- lib/gitlab/experiment/rollout.rb
-- lib/gitlab/experiment/base_interface.rb
-- lib/gitlab/experiment/nestable.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.rb
+- lib/gitlab/experiment/errors.rb
+- lib/gitlab/experiment/middleware.rb
+- lib/gitlab/experiment/nestable.rb
 - lib/gitlab/experiment/rollout
+- lib/gitlab/experiment/rollout/percent.rb
 - lib/gitlab/experiment/rollout/random.rb
 - lib/gitlab/experiment/rollout/round_robin.rb
-- lib/gitlab/experiment/rollout/percent.rb
-- lib/gitlab/experiment/rollout/concerns
-- lib/gitlab/experiment/cache.rb
+- lib/gitlab/experiment/rollout.rb
+- lib/gitlab/experiment/rspec.rb
+- lib/gitlab/experiment/test_behaviors
+- lib/gitlab/experiment/test_behaviors/trackable.rb
+- lib/gitlab/experiment/variant.rb
 - lib/gitlab/experiment/version.rb
-- lib/gitlab/experiment/cookies.rb
-- lib/gitlab/experiment/configuration.rb
-- lib/gitlab/experiment/dsl.rb
+- lib/gitlab/experiment.rb
 - LICENSE.txt
 - README.md
 homepage: https://gitlab.com/gitlab-org/ruby/gems/gitlab-experiment
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -114,8 +267,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: GitLab experimentation library.
 test_files: []