gitlab-experiment 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6d54c567ebebd09762fb8bbd93940efb449f99d546a62776889caebedda6387
-  data.tar.gz: 87a37b577f0545885ce4c2d6db92f750781017c2235b4d89f0f5db977bec045c
+  metadata.gz: 83f13c3f8259c739163ada749acee80ecbfb48f1b94f66a4cd69e265c29df874
+  data.tar.gz: e70fca76e1af2f6234d888473a31cdf088bf44d0bb5dc13dbf84f40e781076bd
 SHA512:
-  metadata.gz: ed428cb380868eb7e94e9a5b4753c7c09dd73656fa66da4bb90fc728b2e2a460cb8d7f24170e783a63c6c28f86d61b00cb99ae9065a3c02999e7518ecc79e2e2
-  data.tar.gz: 001edc2f533b5a5c210ada04c73a335b51e0e377be05449f0ae86ba9da078655d54e860294dd8a66ea8564270345cbbd145dc789aae1eb7f76f074db1fd79be3
+  metadata.gz: 9d0964f78bfea29586c176cf001a335df04618e62dfd1a76952d5d12d643de6970d8eeec063b1a28255fabfad8a3fd2b47df233cea6d071b46d98d7867b97185
+  data.tar.gz: 172778e34c61ffe02f3d11e5538beef44ddd0f8c5e2f6029a449904264eb1365f2f013aad25648e3c1ee0fd19a015aa69a6e62de9867f87c339f8c36e4d14776

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

@@ -48,10 +48,8 @@ Gitlab::Experiment.configure do |config|
   # end
   #
   # Included rollout strategies:
-  #   Gitlab::Experiment::Rollout::Percent, (recommended)
-  #   Gitlab::Experiment::Rollout::RoundRobin, or
-  #   Gitlab::Experiment::Rollout::Random
-  config.default_rollout = Gitlab::Experiment::Rollout::Percent.new(
+  #   :percent (recommended), :round_robin, or :random
+  config.default_rollout = :percent, {
     include_control: true # include control in possible assignments
   )
 
@@ -132,7 +130,7 @@ Gitlab::Experiment.configure do |config|
   #   level1 initiated by file_name.rb:2
   #   level2 initiated by file_name.rb:3
   config.nested_behavior = lambda do |nested_experiment|
-    raise NestingError.new(experiment: self, nested_experiment: nested_experiment)
+    raise Gitlab::Experiment::NestingError.new(experiment: self, nested_experiment: nested_experiment)
   end
 
   # Called at the end of every experiment run, with the result.

data/lib/gitlab/experiment/cache.rb

@@ -66,10 +66,8 @@ module Gitlab
 
           store.write(cache_key, value)
           store.delete(old_key)
-          return value
-        end
-
-        store.fetch(cache_key, &block)
+          break value
+        end || store.fetch(cache_key, &block)
       end
     end
   end

data/lib/gitlab/experiment/callbacks.rb

@@ -82,7 +82,7 @@ module Gitlab
         end
 
         def build_run_callback(filters, **options)
-          set_callback(:run, *filters, **options)
+          set_callback(:run, *filters.compact, **options)
         end
 
         def build_callback(chain, *filters, **options)

data/lib/gitlab/experiment/configuration.rb

@@ -56,12 +56,8 @@ module Gitlab
       # end
       #
       # Included rollout strategies:
-      #   Gitlab::Experiment::Rollout::Percent, (recommended)
-      #   Gitlab::Experiment::Rollout::RoundRobin, or
-      #   Gitlab::Experiment::Rollout::Random
-      @default_rollout = Gitlab::Experiment::Rollout::Percent.new(
-        include_control: true # include control in possible assignments
-      )
+      #   :percent, (recommended), :round_robin, or :random
+      @default_rollout = Rollout.resolve(:percent, include_control: true)
 
       # Secret seed used in generating context keys.
       #
@@ -241,7 +237,24 @@ module Gitlab
           :publishing_behavior
         )
 
-        # Internal helpers warnings.
+        # 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 || {})
+        end
+
+        # Internal warning helpers.
+
         def deprecated(*args, version:, stack: 0)
           deprecator = deprecator(version)
           args << args.pop.to_s.gsub('{{release}}', "#{deprecator.gem_name} #{deprecator.deprecation_horizon}")

data/lib/gitlab/experiment/nestable.rb

@@ -25,15 +25,25 @@ module Gitlab
       class Stack
         include Singleton
 
-        @stack = []
+        delegate :pop, :length, :size, :[], to: :stack
 
         class << self
-          delegate :pop, :length, :size, :[], to: :@stack
+          delegate :pop, :push, :length, :size, :[], to: :instance
+        end
+
+        def initialize
+          @thread_key = "#{self.class};#{object_id}".to_sym
+        end
+
+        def push(instance)
+          stack.last&.nest_experiment(instance)
+          stack.push(instance)
+        end
+
+        private
 
-          def push(instance)
-            @stack.last&.nest_experiment(instance)
-            @stack.push(instance)
-          end
+        def stack
+          Thread.current[@thread_key] ||= []
         end
       end
     end

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "zlib"
+
 # The percent rollout strategy is the most comprehensive included with Gitlab::Experiment. It allows specifying the
 # percentages per variant using an array, a hash, or will default to even distribution when no rules are provided.
 #
@@ -41,7 +43,7 @@ module Gitlab
           end
         end
 
-        def execute_assigment
+        def execute_assignment
           crc = normalized_id
           total = 0
 

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

@@ -27,7 +27,7 @@ module Gitlab
       class Random < Base
         protected
 
-        def execute_assigment
+        def execute_assignment
           behavior_names.sample # pick a random variant
         end
       end

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

@@ -31,7 +31,7 @@ module Gitlab
 
         protected
 
-        def execute_assigment
+        def execute_assignment
           behavior_names[(cache.attr_inc(KEY_NAME) - 1) % behavior_names.size]
         end
       end

data/lib/gitlab/experiment/rollout.rb

@@ -7,10 +7,17 @@ module Gitlab
       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
+      def self.resolve(klass, options = {})
+        case klass
+        when String
+          Strategy.new(klass.classify.constantize, options)
+        when Symbol
+          Strategy.new("#{name}::#{klass.to_s.classify}".constantize, options)
+        when Class
+          Strategy.new(klass, options)
+        else
+          raise ArgumentError, "unable to resolve rollout from #{klass.inspect}"
+        end
       end
 
       class Base
@@ -47,7 +54,7 @@ module Gitlab
 
           validate! # allow the rollout strategy to validate itself
 
-          assignment = execute_assigment
+          assignment = execute_assignment
           assignment == :control ? nil : assignment # avoid caching control
         end
 
@@ -57,7 +64,7 @@ module Gitlab
           # base is always valid
         end
 
-        def execute_assigment
+        def execute_assignment
           behavior_names.first
         end
 
@@ -73,6 +80,12 @@ module Gitlab
           options[:include_control] ? [:control] + variant_names : variant_names
         end
       end
+
+      Strategy = Struct.new(:klass, :options) do
+        def for(experiment)
+          klass.new(options).for(experiment)
+        end
+      end
     end
   end
 end

data/lib/gitlab/experiment/rspec.rb

@@ -303,7 +303,7 @@ RSpec.configure do |config|
   config.include Gitlab::Experiment::RSpecHelpers
   config.include Gitlab::Experiment::Dsl
 
-  config.before(:each, :experiment) do
+  clear_cache = proc do
     RequestStore.clear!
 
     if defined?(Gitlab::Experiment::TestBehaviors::TrackedStructure)
@@ -311,9 +311,14 @@ RSpec.configure do |config|
     end
   end
 
+  config.before(:each, :experiment, &clear_cache)
+  config.before(:each, type: :experiment, &clear_cache)
+
   config.include Gitlab::Experiment::RSpecMatchers, :experiment
-  config.define_derived_metadata(file_path: Regexp.new('/spec/experiments/')) do |metadata|
-    metadata[:type] = :experiment
+  config.include Gitlab::Experiment::RSpecMatchers, type: :experiment
+
+  config.define_derived_metadata(file_path: Regexp.new('spec/experiments/')) do |metadata|
+    metadata[:type] ||= :experiment
   end
 
   # We need to monkeypatch rspec-mocks because there's an issue around stubbing class methods that impacts us here.

data/lib/gitlab/experiment/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   class Experiment
-    VERSION = '0.7.0'
+    VERSION = '0.7.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/string/inflections'
 
 require 'gitlab/experiment/errors'
 require 'gitlab/experiment/base_interface'
@@ -68,7 +69,7 @@ module Gitlab
       def default_rollout(rollout = nil, options = {})
         return @_rollout ||= Configuration.default_rollout if rollout.blank?
 
-        @_rollout = Rollout.resolve(rollout).new(options)
+        @_rollout = Rollout.resolve(rollout, options)
       end
 
       # Class level accessor methods.
@@ -145,7 +146,7 @@ module Gitlab
     def rollout(rollout = nil, options = {})
       return @_rollout ||= self.class.default_rollout(nil, options).for(self) if rollout.blank?
 
-      @_rollout = Rollout.resolve(rollout).new(options).for(self)
+      @_rollout = Rollout.resolve(rollout, options).for(self)
     end
 
     def exclude!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-experiment
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - GitLab
@@ -45,53 +45,54 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/generators/test_unit
-- lib/generators/test_unit/experiment
-- lib/generators/test_unit/experiment/templates
-- lib/generators/test_unit/experiment/templates/experiment_test.rb.tt
-- lib/generators/test_unit/experiment/experiment_generator.rb
-- lib/generators/rspec
-- lib/generators/rspec/experiment
-- lib/generators/rspec/experiment/templates
-- lib/generators/rspec/experiment/templates/experiment_spec.rb.tt
-- lib/generators/rspec/experiment/experiment_generator.rb
 - lib/generators/gitlab
 - lib/generators/gitlab/experiment
-- lib/generators/gitlab/experiment/USAGE
-- lib/generators/gitlab/experiment/templates
-- lib/generators/gitlab/experiment/templates/experiment.rb.tt
 - 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/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/install/install_generator.rb
+- 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/gitlab/experiment
-- lib/gitlab/experiment/dsl.rb
-- lib/gitlab/experiment/rspec.rb
-- lib/gitlab/experiment/context.rb
-- lib/gitlab/experiment/nestable.rb
-- lib/gitlab/experiment/configuration.rb
-- lib/gitlab/experiment/rollout.rb
+- 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/cache
 - lib/gitlab/experiment/cache/redis_hash_store.rb
-- lib/gitlab/experiment/engine.rb
-- lib/gitlab/experiment/base_interface.rb
-- lib/gitlab/experiment/middleware.rb
-- lib/gitlab/experiment/version.rb
-- lib/gitlab/experiment/cookies.rb
 - lib/gitlab/experiment/errors.rb
-- lib/gitlab/experiment/cache.rb
-- lib/gitlab/experiment/variant.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/context.rb
+- lib/gitlab/experiment/engine.rb
+- lib/gitlab/experiment/rspec.rb
 - lib/gitlab/experiment/rollout
 - lib/gitlab/experiment/rollout/random.rb
-- lib/gitlab/experiment/rollout/percent.rb
 - lib/gitlab/experiment/rollout/round_robin.rb
-- lib/gitlab/experiment/callbacks.rb
-- lib/gitlab/experiment/test_behaviors
-- lib/gitlab/experiment/test_behaviors/trackable.rb
-- lib/gitlab/experiment.rb
+- lib/gitlab/experiment/rollout/percent.rb
+- lib/gitlab/experiment/rollout/concerns
+- lib/gitlab/experiment/cache.rb
+- lib/gitlab/experiment/version.rb
+- lib/gitlab/experiment/cookies.rb
+- lib/gitlab/experiment/configuration.rb
+- lib/gitlab/experiment/dsl.rb
 - LICENSE.txt
 - README.md
 homepage: https://gitlab.com/gitlab-org/ruby/gems/gitlab-experiment