gitlab-experiment 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c4e4a4b19b67700aab0629cd615617c4452d8b4b145ef8ff85d12443994362b
-  data.tar.gz: 802c31143890f2431a80ed3dcb247cbf46247ce276053e8e27a4d190822650df
+  metadata.gz: 9d7bc7a1946d06b5188ccfe761342209779f75cf635d894bb8743519ff2830dc
+  data.tar.gz: 7a5c347f8b58e5caa2fe814ce013dbf1ca71f6e017148528a0ff2ca74bd562de
 SHA512:
-  metadata.gz: 86f86cd9dd01006be9668a2ceb4d60351e943487576d236e12b40eb9405e4255fdbbffb0c5811b17a4f1c8d2784b011eb20bc783e622f4f4f05fc6fb166f0df3
-  data.tar.gz: bca224adeaade21b59077effd1faa0d6ca95607fe02f6c7735b8c9b79b7d5a08f76675549ddbc874ce63adbe39895d7b3f6f1fb71e908ae22a76c817a1d0f88d
+  metadata.gz: '01927d9db97ad4b087d445db642aa39615faa68322e2bd0e0b82ae99441478bae3f1939b94956218121fe52d01f432836ba272d0b1ff052537c80f0d0ff107b3'
+  data.tar.gz: f53702ea5bb97fe6c73427850534b9e156744336a37029dce2b96926b70b7a5c4959708ac626f6ac0435125ad4ffe62f2ba9fd528f756af811c6ff66abc47846

data/lib/gitlab/experiment.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'scientist'
+require 'request_store'
 require 'active_support/callbacks'
 require 'active_support/cache'
 require 'active_support/concern'
@@ -27,10 +28,10 @@ module Gitlab
     include Callbacks
 
     class << self
-      def default_rollout(rollout = nil)
+      def default_rollout(rollout = nil, options = {})
         return @rollout ||= Configuration.default_rollout if rollout.blank?
 
-        @rollout = Rollout.resolve(rollout)
+        @rollout = Rollout.resolve(rollout).new(options)
       end
 
       def exclude(*filter_list, **options, &block)
@@ -44,6 +45,10 @@ module Gitlab
           target.variant(variant) if target.instance_variable_get(:@variant_name).nil? && callback.call(target, nil)
         end
       end
+
+      def published_experiments
+        RequestStore.store[:published_gitlab_experiments] || {}
+      end
     end
 
     def name
@@ -85,10 +90,10 @@ module Gitlab
       @resolving_variant = false
     end
 
-    def rollout(rollout = nil)
-      return @rollout ||= self.class.default_rollout if rollout.blank?
+    def rollout(rollout = nil, options = {})
+      return @rollout ||= self.class.default_rollout(nil, options) if rollout.blank?
 
-      @rollout = Rollout.resolve(rollout)
+      @rollout = Rollout.resolve(rollout).new(options)
     end
 
     def exclude!
@@ -101,6 +106,8 @@ module Gitlab
 
     def publish(result)
       instance_exec(result, &Configuration.publishing_behavior)
+
+      (RequestStore.store[:published_gitlab_experiments] ||= {})[name] = signature.merge(excluded: excluded?)
     end
 
     def track(action, **event_args)
@@ -131,8 +138,8 @@ module Gitlab
       { variant: variant.name, experiment: name }.merge(context.signature)
     end
 
-    def key_for(hash)
-      instance_exec(hash, &Configuration.context_hash_strategy)
+    def key_for(source, seed = name)
+      instance_exec(source, seed, &Configuration.context_hash_strategy)
     end
 
     protected
@@ -144,7 +151,7 @@ module Gitlab
     end
 
     def resolve_variant_name
-      rollout.new(self).execute if experiment_group?
+      rollout.rollout_for(self) if experiment_group?
     end
   end
 end

data/lib/gitlab/experiment/configuration.rb

@@ -26,8 +26,10 @@ module Gitlab
       # The domain to use on cookies.
       @cookie_domain = :all
 
-      # The default rollout strategy that works for single and multi-variants.
-      @default_rollout = Rollout::First
+      # The default rollout strategy only works for single variant experiments.
+      # It's expected that you use a more advanced rollout for multiple variant
+      # experiments.
+      @default_rollout = Rollout::Base.new
 
       # Logic this project uses to determine inclusion in a given experiment.
       # Expected to return a boolean value.
@@ -45,10 +47,11 @@ module Gitlab
         track(:assignment)
       end
 
-      # Algorithm that consistently generates a hash key for a given hash map.
-      @context_hash_strategy = lambda do |hash_map|
-        values = hash_map.values.map { |v| (v.respond_to?(:to_global_id) ? v.to_global_id : v).to_s }
-        Digest::MD5.hexdigest(([name] + hash_map.keys + values).join('|'))
+      # Algorithm that consistently generates a hash key for a given source.
+      @context_hash_strategy = lambda do |source, seed|
+        source = source.keys + source.values if source.is_a?(Hash)
+        data = Array(source).map { |v| (v.respond_to?(:to_global_id) ? v.to_global_id : v).to_s }
+        Digest::MD5.hexdigest(data.unshift(seed).join('|'))
       end
 
       class << self

data/lib/gitlab/experiment/rollout.rb

@@ -3,7 +3,6 @@
 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'
 
@@ -18,8 +17,17 @@ module Gitlab
 
         delegate :variant_names, :cache, to: :experiment
 
-        def initialize(experiment)
+        def initialize(options = {})
+          @options = options
+        end
+
+        def rollout_for(experiment)
           @experiment = experiment
+          execute
+        end
+
+        def execute
+          variant_names.first
         end
       end
     end

data/lib/gitlab/experiment/rspec.rb

@@ -232,6 +232,10 @@ RSpec.configure do |config|
   config.include Gitlab::Experiment::RSpecHelpers
   config.include Gitlab::Experiment::Dsl
 
+  config.before(:each, :experiment) do
+    RequestStore.clear!
+  end
+
   config.include Gitlab::Experiment::RSpecMatchers, :experiment
   config.define_derived_metadata(file_path: Regexp.new('/spec/experiments/')) do |metadata|
     metadata[:type] = :experiment

data/lib/gitlab/experiment/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   class Experiment
-    VERSION = '0.5.3'
+    VERSION = '0.5.4'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-experiment
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-06 00:00:00.000000000 Z
+date: 2021-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: scientist
   requirement: !ruby/object:Gem::Requirement
@@ -75,7 +89,6 @@ files:
 - 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
@@ -100,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: GitLab experiment library built on top of scientist.

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

@@ -1,16 +0,0 @@
-# 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