gitlab-experiment 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed3c0028563936ce8a3fbdfd1de9d64e499102c4ec71a21946b63c56cc2bebd5
-  data.tar.gz: 43389ef9b7b2a4b3e60b82b5ffefbe3635739cb9fafec21dd5e9d59586f942c2
+  metadata.gz: 9651e4cc4941d879e7c006f5865ff71989babd942bfcc09a86eb5be89f17e38c
+  data.tar.gz: d23055b9c808ae680c05762d60a569306069578a8555f87daf816a717cef0c28
 SHA512:
-  metadata.gz: 30d0988d199f34eb60e3d56d8e7aec3a00222a5de482410c0294e15ce37a2a9dccbb2fb35b372c90b4425879938bec0d7e5b0ffadf5d842ee31abb0ea673aaeb
-  data.tar.gz: 3665443e1d937b77e12debaf3195423b3fad171b651573e58a328dfb5c1f618eb9a282eedcfde68376ae0e7207837b74ae60e4fda616c046caa329b4cc681e68
+  metadata.gz: af40d50563c3938f089d415ebece34be76a79f8b1c13f7f5a4d6c62f035a7fe07147a4ab9ad475f00372d94be7b5c35f6c54ee2f866c3b0875748774cb04f1bb
+  data.tar.gz: fd4b8c69bc49351a7050d5ab6665c42855cf1d26b18e4a4e1983fbbeba2a8487b1523b6d1f824f0862d0fd16d425565eaf4ce179120a2e55bbbbeef53ae03a2f

data/README.md

@@ -47,7 +47,7 @@ We'll name our experiment `notification_toggle`. This name is prefixed based on
 
 When you implement an experiment you'll need to provide a name, and a context. The name can show up in tracking calls, and potentially other aspects. The context determines the variant assigned, and should be consistent between calls. We'll discuss migrating context in later examples.
 
-A context "key" represents the unique id of a context. It allows us to give the same experience between different calls to the experiment and can be used in caching.
+A context "key" represents the unique id of a context. It allows us to give the same experience between different calls to the experiment and can be used in caching. This is how an experiment remains "sticky" to a given context.
 
 Now in our experiment we're going to render one of two views: the control will be our current view, and the candidate will be the new toggle button with a confirmation flow.
 
@@ -74,6 +74,12 @@ experiment(:notification_toggle, actor: user) do |e|
 end
 ```
 
+You can specify what the experiment should be "sticky" to by providing a `:sticky_to` option. By default this will be the entire context provided, but this can be overridden manually if needed.
+
+```ruby
+experiment(:notification_toggle, actor: user, project: project, sticky_to: project) #...
+```
+
 Understanding how an experiment can change behavior is important in evaluating its performance.
 
 To this end, we track events that are important by calling the same experiment elsewhere in code. By using the same context, you'll have consistent behavior and the ability to track events to it.

data/lib/gitlab/experiment/callbacks.rb

@@ -9,6 +9,7 @@ module Gitlab
       include ActiveSupport::Callbacks
 
       included do
+        define_callbacks(:run)
         define_callbacks(:unsegmented)
         define_callbacks(:segmentation_check)
         define_callbacks(:exclusion_check, skip_after_callbacks_if_terminated: true)

data/lib/gitlab/experiment/context.rb

@@ -27,6 +27,7 @@ module Gitlab
 
         value = value.dup # dup so we don't mutate
         reinitialize(value.delete(:request))
+        key(value.delete(:sticky_to))
 
         @value.merge!(process_migrations(value))
       end
@@ -34,7 +35,7 @@ module Gitlab
       def key(key = nil)
         return @key || @experiment.key_for(value) if key.nil?
 
-        @key = key
+        @key = @experiment.key_for(key)
       end
 
       def trackable?

data/lib/gitlab/experiment/errors.rb

@@ -4,5 +4,6 @@ module Gitlab
   class Experiment
     Error = Class.new(StandardError)
     InvalidRolloutRules = Class.new(Error)
+    NestingError = Class.new(Error)
   end
 end

data/lib/gitlab/experiment/nestable.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Gitlab
+  class Experiment
+    module Nestable
+      extend ActiveSupport::Concern
+
+      included do
+        set_callback :run, :around, :manage_nested_stack
+      end
+
+      def nest_experiment(other)
+        raise NestingError, "unable to nest the #{other.name} experiment within the #{name} experiment"
+      end
+
+      private
+
+      def manage_nested_stack
+        Stack.push(self)
+        yield
+      ensure
+        Stack.pop
+      end
+
+      class Stack
+        include Singleton
+
+        @stack = []
+
+        class << self
+          delegate :pop, :length, :size, :[], to: :@stack
+
+          def push(instance)
+            @stack.last&.nest_experiment(instance)
+            @stack.push(instance)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/experiment/rspec.rb

@@ -2,6 +2,10 @@
 
 module Gitlab
   class Experiment
+    module TestBehaviors
+      autoload :Trackable, 'gitlab/experiment/test_behaviors/trackable.rb'
+    end
+
     module RSpecHelpers
       def stub_experiments(experiments, times = nil)
         experiments.each { |experiment| wrapped_experiment(experiment, times) }
@@ -234,6 +238,10 @@ RSpec.configure do |config|
 
   config.before(:each, :experiment) do
     RequestStore.clear!
+
+    if defined?(Gitlab::Experiment::TestBehaviors::TrackedStructure)
+      Gitlab::Experiment::TestBehaviors::TrackedStructure.reset!
+    end
   end
 
   config.include Gitlab::Experiment::RSpecMatchers, :experiment

data/lib/gitlab/experiment/test_behaviors/trackable.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Gitlab
+  class Experiment
+    module TestBehaviors
+      module Trackable
+        private
+
+        def manage_nested_stack
+          TrackedStructure.push(self)
+          super
+        ensure
+          TrackedStructure.pop
+        end
+      end
+
+      class TrackedStructure
+        include Singleton
+
+        # dependency tracking
+        @flat = {}
+        @stack = []
+
+        # structure tracking
+        @tree = { name: nil, count: 0, children: {} }
+        @node = @tree
+
+        class << self
+          def reset!
+            # dependency tracking
+            @flat = {}
+            @stack = []
+
+            # structure tracking
+            @tree = { name: nil, count: 0, children: {} }
+            @node = @tree
+          end
+
+          def hierarchy
+            @tree[:children]
+          end
+
+          def dependencies
+            @flat
+          end
+
+          def push(instance)
+            # dependency tracking
+            @flat[instance.name] = ((@flat[instance.name] || []) + @stack.map(&:name)).uniq
+            @stack.push(instance)
+
+            # structure tracking
+            @last = @node
+            @node = @node[:children][instance.name] ||= { name: instance.name, count: 0, children: {} }
+            @node[:count] += 1
+          end
+
+          def pop
+            # dependency tracking
+            @stack.pop
+
+            # structure tracking
+            @node = @last
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/experiment/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   class Experiment
-    VERSION = '0.6.4'
+    VERSION = '0.6.5'
   end
 end

data/lib/gitlab/experiment.rb

@@ -19,6 +19,7 @@ require 'gitlab/experiment/cookies'
 require 'gitlab/experiment/context'
 require 'gitlab/experiment/dsl'
 require 'gitlab/experiment/middleware'
+require 'gitlab/experiment/nestable'
 require 'gitlab/experiment/variant'
 require 'gitlab/experiment/version'
 require 'gitlab/experiment/engine' if defined?(Rails::Engine)
@@ -28,6 +29,7 @@ module Gitlab
     include BaseInterface
     include Cache
     include Callbacks
+    include Nestable
 
     class << self
       def default_rollout(rollout = nil, options = {})
@@ -103,7 +105,9 @@ module Gitlab
     end
 
     def run(variant_name = nil)
-      @result ||= super(variant(variant_name).name)
+      return @result if context.frozen?
+
+      @result = run_callbacks(:run) { super(variant(variant_name).name) }
     rescue Scientist::BehaviorMissing => e
       raise Error, e
     end
@@ -155,6 +159,8 @@ module Gitlab
         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) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-experiment
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
 platform: ruby
 authors:
 - GitLab
@@ -91,12 +91,15 @@ files:
 - 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/cache
 - lib/gitlab/experiment/cache/redis_hash_store.rb
 - lib/gitlab/experiment/errors.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
@@ -130,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: GitLab experiment library built on top of scientist.