gitlab-experiment 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31e4979de3006211bcd1f63882215ae9213c3a22de25e7cca8546f3fce2ef649
-  data.tar.gz: cb865da8c87f019755194c98e073720f5f246b5a2c57e6d511c2a280d78ff996
+  metadata.gz: 13f170ab47c88f393041b3f4b8b69c168d8a159fcfcdf2fe7458ceca75a9b9db
+  data.tar.gz: 5bc7fe4a5c8a493ce14413c109ac4424bdd61d8b0c3513530963e52586bfaf5f
 SHA512:
-  metadata.gz: 7906faeb21deaa6e0be322c94c0fd45ea200b5419ac5aacd2d2656b416ac08c21654e84f0ef3d2db5bb33c819dc73020267488a6f7f1ac045b66591ec04ae334
-  data.tar.gz: e0f9328d5c8f1eca74681e749e01cc6ccf513d619b3c4aa522c45d08a4692d370a96d97437975285fa26dcebad0a7e0a3a8356724b980902ba1b86c8fa82f0a1
+  metadata.gz: bc52008aea6015b274fb7200c83b14145b355be637f1d286a8c9590df40c5d5e2c1d6da9e6f41f7f1970c576dfb13af69f43610e162eebff642d3945455e1b24
+  data.tar.gz: 9f16a5b7bdd2ae9ea9b624946d5055878c67d67e3f755900bccdac153c330fab77ed98d1d88b0f1a869e3bbd1b1f347366252db98207513e789c387c6fd509d0

data/lib/gitlab/experiment.rb

@@ -32,20 +32,34 @@ module Gitlab
 
         @rollout = Rollout.resolve(rollout)
       end
+
+      def exclude(*filter_list, **options, &block)
+        build_callback(:exclusion_check, filter_list.unshift(block), **options) do |target, callback|
+          throw(:abort) if target.instance_variable_get(:@excluded) || callback.call(target, nil) == true
+        end
+      end
+
+      def segment(*filter_list, variant:, **options, &block)
+        build_callback(:segmentation_check, filter_list.unshift(block), **options) do |target, callback|
+          target.variant(variant) if target.instance_variable_get(:@variant_name).nil? && callback.call(target, nil)
+        end
+      end
     end
 
     def name
       [Configuration.name_prefix, @name].compact.join('_')
     end
 
-    def use(&block)
-      try(:control, &block)
+    def control(&block)
+      candidate(:control, &block)
     end
+    alias_method :use, :control
 
-    def try(name = nil, &block)
+    def candidate(name = nil, &block)
       name = (name || :candidate).to_s
       behaviors[name] = block
     end
+    alias_method :try, :candidate
 
     def context(value = nil)
       return @context if value.blank?
@@ -59,12 +73,10 @@ module Gitlab
       return Variant.new(name: (@variant_name || :unresolved).to_s) if @variant_name || @resolving_variant
 
       if enabled?
-        @variant_name ||= :control if excluded?
-
         @resolving_variant = true
-        if (result = cache_variant(@variant_name) { resolve_variant_name }).present?
-          @variant_name = result.to_sym
-        end
+        @variant_name ||= :control if excluded?
+        result = cache_variant(@variant_name) { resolve_variant_name }
+        @variant_name = result.to_sym if result.present?
       end
 
       run_callbacks(segmentation_callback_chain) do
@@ -81,6 +93,10 @@ module Gitlab
       @rollout = Rollout.resolve(rollout)
     end
 
+    def exclude!
+      @excluded = true
+    end
+
     def run(variant_name = nil)
       @result ||= super(variant(variant_name).name)
     end
@@ -102,8 +118,7 @@ module Gitlab
     def excluded?
       return @excluded if defined?(@excluded)
 
-      @excluded = !@context.trackable? || # adhere to DNT headers
-        !run_callbacks(:exclusion_check) { :not_excluded } # didn't pass exclusion check
+      @excluded = !run_callbacks(:exclusion_check) { :not_excluded }
     end
 
     def experiment_group?
@@ -111,7 +126,7 @@ module Gitlab
     end
 
     def should_track?
-      enabled? && !excluded?
+      enabled? && @context.trackable? && !excluded?
     end
 
     def signature
@@ -125,7 +140,7 @@ module Gitlab
     protected
 
     def segmentation_callback_chain
-      return :segmentation_check if !variant_assigned? && enabled? && !excluded?
+      return :segmentation_check if @variant_name.nil? && enabled? && !excluded?
 
       :unsegmented
     end

data/lib/gitlab/experiment/base_interface.rb

@@ -4,13 +4,9 @@ module Gitlab
   class Experiment
     module BaseInterface
       extend ActiveSupport::Concern
-
-      # don't `include` here so we don't override the default scientist class
-      Scientist::Experiment.send(:append_features, self) # rubocop:disable GitlabSecurity/PublicSend
+      include Scientist::Experiment
 
       class_methods do
-        include Scientist::Experiment::RaiseOnMismatch
-
         def configure
           yield Configuration
         end
@@ -72,8 +68,8 @@ module Gitlab
 
       protected
 
-      def variant_assigned?
-        !@variant_name.nil?
+      def raise_on_mismatches?
+        false
       end
 
       def generate_result(variant_name)

data/lib/gitlab/experiment/callbacks.rb

@@ -15,28 +15,17 @@ module Gitlab
       end
 
       class_methods do
-        def exclude(*filter_list, **options, &block)
-          filters = filter_list.unshift(block).compact.map do |filter|
-            result_lambda = ActiveSupport::Callbacks::CallTemplate.build(filter, self).make_lambda
-            lambda do |target|
-              throw(:abort) if target.instance_variable_get(:'@excluded') || result_lambda.call(target, nil) == true
-            end
-          end
-
-          raise ArgumentError, 'no filters provided' if filters.empty?
-
-          set_callback(:exclusion_check, :before, *filters, options)
-        end
+        private
 
-        def segment(*filter_list, variant:, **options, &block)
-          filters = filter_list.unshift(block).compact.map do |filter|
+        def build_callback(chain, filters, **options)
+          filters = filters.compact.map do |filter|
             result_lambda = ActiveSupport::Callbacks::CallTemplate.build(filter, self).make_lambda
-            ->(target) { target.variant(variant) if !target.variant_assigned? && result_lambda.call(target, nil) }
+            ->(target) { yield(target, result_lambda) }
           end
 
           raise ArgumentError, 'no filters provided' if filters.empty?
 
-          set_callback(:segmentation_check, :before, *filters, options)
+          set_callback(chain, *filters, **options)
         end
       end
     end

data/lib/gitlab/experiment/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-experiment
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-11 00:00:00.000000000 Z
+date: 2021-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,20 +30,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.6.0
 description: 
 email:
 - gitlab_rubygems@gitlab.com