gitlab-experiment 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 865d51c081670824fc7ffb48d4bc764fd5370606d3aa63b2196421b5570506e7
-  data.tar.gz: a007f872a3d56ee81c9925117f603e4930d1b7d689078edb074a2ba5567833f2
+  metadata.gz: 65d5d515cf32a09ec81868e3688576ee7314ae1580a9dde67c5c733174b12604
+  data.tar.gz: 2b8008b7c47812b492355df4715d5aa53195a852e46a1dd1a5e1b427a2bb9560
 SHA512:
-  metadata.gz: 03d401a71b952b74519a21fa851a87ee9e104ccd19011af37ac41c36bec5fd63db3e68c62c05beb34ab296d354e00e15f013dd34a547c3b4c5c94474b89096cc
-  data.tar.gz: 2bb0260e40d4689446c1317273d85140fae9f56394821fda96c7bbc5d1acbe441f3e4024bf00ec05812f64f5588897137fc8061e790d871c5719742f6cedf516
+  metadata.gz: 3ecd4bad77738fbf1c624970c9206c21f72b1c6e4efe59ffba6145959d4e3e1221d0cda709c0d086a849af4063074bbd9e0fa04ddc623589cd623c4dabd50705
+  data.tar.gz: 774e0605346863a8f05a28cedf0bb9884412e0ff1b90fcb359cf02be469e46638dbdeb611e0d8298b6d2e6c21b46f4b772f12e9e092b253e68266fa66ce7ed8e

data/README.md

@@ -388,7 +388,7 @@ Each of these approaches could be desirable given the objectives of your experim
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies.
-Then, run `bundle exec rspec` to run the tests. You can also run `bundle exec pry` for an
+Then, run `bundle exec rake` to run the tests. You can also run `bundle exec pry` for an
 interactive prompt that will allow you to experiment.
 
 ## Contributing

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

@@ -25,17 +25,17 @@ Gitlab::Experiment.configure do |config|
   # Logic this project uses to resolve a variant for a given experiment.
   #
   # Should return a symbol or string that represents the variant that should
-  # be assigned.
+  # be assigned. Blank or nil values will be defaulted to the control.
   #
   # This block is executed within the scope of the experiment and so can access
   # experiment methods, like `name`, `context`, and `signature`.
   config.variant_resolver = lambda do |requested_variant|
     # Run the control, unless a variant was requested in code:
-    requested_variant || 'control'
+    requested_variant
 
     # Run the candidate, unless a variant was requested, with a fallback:
     #
-    # requested_variant || variant_names.first || 'control'
+    # requested_variant || variant_names.first || nil
   end
 
   # Tracking behavior can be implemented to link an event to an experiment.

data/lib/gitlab/experiment.rb

@@ -76,11 +76,22 @@ module Gitlab
     end
 
     def variant(value = nil)
+      if value.blank? && @variant_name || @resolving_variant
+        return Variant.new(name: (@variant_name || :unresolved).to_s)
+      end
+
       @variant_name = value unless value.blank?
       @variant_name ||= :control if excluded?
 
-      resolved = cache { resolve_variant_name }
-      Variant.new(name: (resolved.presence || :control).to_s)
+      @resolving_variant = true
+      resolved = :control
+      if (result = cache_variant(@variant_name) { resolve_variant_name }).present?
+        @variant_name = resolved = result.to_sym
+      end
+
+      Variant.new(name: resolved.to_s)
+    ensure
+      @resolving_variant = false
     end
 
     def exclude(&block)
@@ -150,12 +161,7 @@ module Gitlab
     protected
 
     def resolve_variant_name
-      return :unresolved if @resolving
-
-      @resolving = true
-      result = instance_exec(@variant_name, &Configuration.variant_resolver)
-      @resolving = false
-      result
+      instance_exec(@variant_name, &Configuration.variant_resolver)
     end
 
     def generate_result(variant_name)

data/lib/gitlab/experiment/caching.rb

@@ -3,20 +3,26 @@
 module Gitlab
   class Experiment
     module Caching
-      def cache(&block)
-        return yield unless (cache = Configuration.cache)
+      def cache_variant(specified = nil, &block)
+        cache = Configuration.cache
+        return (specified.presence || yield) unless cache
 
         key, migrations = cache_strategy
-        migrated_cache(cache, migrations || [], key) or cache.fetch(key, &block)
+        result = migrated_cache(cache, migrations || [], key) || cache.fetch(key, &block)
+        return result unless specified.present?
+
+        cache.write(cache_key, specified) if result != specified
+        specified
+      end
+
+      def cache_key(key = nil)
+        "#{name}:#{key || context.signature[:key]}"
       end
 
       private
 
       def cache_strategy
-        [
-          "#{name}:#{context.signature[:key]}",
-          context.signature[:migration_keys]&.map { |key| "#{name}:#{key}" }
-        ]
+        [cache_key, context.signature[:migration_keys]&.map { |key| cache_key(key) }]
       end
 
       def migrated_cache(cache, migrations, new_key)

data/lib/gitlab/experiment/configuration.rb

@@ -25,8 +25,9 @@ module Gitlab
       @cookie_domain = :all
 
       # Logic this project uses to resolve a variant for a given experiment.
+      # If no variant is determined, the control will be used.
       @variant_resolver = lambda do |requested_variant|
-        requested_variant || :control
+        requested_variant
       end
 
       # Tracking behavior can be implemented to link an event to an experiment.

data/lib/gitlab/experiment/cookies.rb

@@ -11,7 +11,7 @@ module Gitlab
         return hash if cookie_jar.nil?
 
         resolver = [hash, :actor, cookie_name, cookie_jar.signed[cookie_name]]
-        resolve_cookie(*resolver) or generate_cookie(*resolver)
+        resolve_cookie(*resolver) || generate_cookie(*resolver)
       end
 
       def cookie_jar

data/lib/gitlab/experiment/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   class Experiment
-    VERSION = '0.4.2'
+    VERSION = '0.4.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-experiment
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-19 00:00:00.000000000 Z
+date: 2020-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport