split 3.4.0 → 4.0.1

data/CHANGELOG.md

@@ -1,3 +1,44 @@
+## 4.0.1 (December 30th, 2021)
+
+Bugfixes:
+- ab_test must return metadata on error or if split is disabled/excluded user (@andrehjr, #622)
+- Fix versioned experiments when used with allow_multiple_experiments=control (@andrehjr, #613)
+- Only block Pinterest bot (@huoxito, #606)
+- Respect experiment defaults when loading experiments in initializer. (@mattwd7, #599)
+- Removes metadata key when it updated to nil (@andrehjr, #633)
+- Force experiment does not count for metrics (@andrehjr, #637)
+- Fix cleanup_old_versions! misbehaviour (@serggl, #661)
+
+Features:
+- Make goals accessible via on_trial_complete callbacks (@robin-phung, #625)
+- Replace usage of SimpleRandom with RubyStats(Used for Beta Distribution RNG) (@andrehjr, #616)
+- Introduce enable/disable experiment cohorting (@robin-phung, #615)
+- Add on_experiment_winner_choose callback (@GenaMinenkov, #574)
+- Add Split::Cache to reduce load on Redis (@rdh, #648)
+- Caching based optimization in the experiment#save path (@amangup, #652)
+- Adds config option for cookie domain (@joedelia, #664)
+
+Misc:
+- Drop support for Ruby < 2.5 (@andrehjr, #627)
+- Drop support for Rails < 5 (@andrehjr, #607)
+- Bump minimum required redis to 4.2 (@andrehjr, #628)
+- Removed repeated loading from config (@robin-phung, #619)
+- Simplify RedisInterface usage when persisting Experiment alternatives (@andrehjr, #632)
+- Remove redis_url impl. Deprecated on version 2.2 (@andrehjr, #631)
+- Remove thread_safe config as redis-rb is thread_safe by default (@andrehjr, #630)
+- Fix typo of in `Split::Trial` class variable (TomasBarry, #644)
+- Single HSET to update values, instead of multiple ones (@andrehjr, #640)
+- Use Redis#hmset to keep compatibility with Redis < 4.0 (@andrehjr, #659)
+- Remove 'set' parsing for alternatives. Sets were used as storage and deprecated on 0.x (@andrehjr, #639)
+- Adding documentation related to what is stored on cookies. (@andrehjr, #634)
+- Keep railtie defined under the Split gem namespace (@avit, #666)
+- Update RSpec helper to support block syntax (@clowder, #665)
+
+## 3.4.1 (November 12th, 2019)
+
+Bugfixes:
+- Reference ActionController directly when including split helpers, to avoid breaking Rails API Controllers (@andrehjr, #602)
+
 ## 3.4.0 (November 9th, 2019)
 
 Features:

data/Gemfile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec

data/README.md

@@ -1,7 +1,7 @@
 # [Split](https://libraries.io/rubygems/split)
 
 [![Gem Version](https://badge.fury.io/rb/split.svg)](http://badge.fury.io/rb/split)
-[![Build Status](https://secure.travis-ci.org/splitrb/split.svg?branch=master)](https://travis-ci.org/splitrb/split)
+![Build status](https://github.com/splitrb/split/actions/workflows/ci.yml/badge.svg?branch=main)
 [![Code Climate](https://codeclimate.com/github/splitrb/split/badges/gpa.svg)](https://codeclimate.com/github/splitrb/split)
 [![Test Coverage](https://codeclimate.com/github/splitrb/split/badges/coverage.svg)](https://codeclimate.com/github/splitrb/split/coverage)
 [![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
@@ -175,8 +175,10 @@ module SplitHelper
   #   use_ab_test(signup_form: "single_page", pricing: "show_enterprise_prices")
   #
   def use_ab_test(alternatives_by_experiment)
-    allow_any_instance_of(Split::Helper).to receive(:ab_test) do |_receiver, experiment|
-      alternatives_by_experiment.fetch(experiment) { |key| raise "Unknown experiment '#{key}'" }
+    allow_any_instance_of(Split::Helper).to receive(:ab_test) do |_receiver, experiment, &block|
+      variant = alternatives_by_experiment.fetch(experiment) { |key| raise "Unknown experiment '#{key}'" }
+      block.call(variant) unless block.nil?
+      variant
     end
   end
 end
@@ -263,7 +265,7 @@ Split.configure do |config|
 end
 ```
 
-By default, cookies will expire in 1 year. To change that, set the `persistence_cookie_length` in the configuration (unit of time in seconds).
+When using the cookie persistence, Split stores data into an anonymous tracking cookie named 'split', which expires in 1 year. To change that, set the `persistence_cookie_length` in the configuration (unit of time in seconds).
 
 ```ruby
 Split.configure do |config|
@@ -272,6 +274,8 @@ Split.configure do |config|
 end
 ```
 
+The data stored consists of the experiment name and the variants the user is in. Example: { "experiment_name" => "variant_a" }
+
 __Note:__ Using cookies depends on `ActionDispatch::Cookies` or any identical API
 
 #### Redis
@@ -386,6 +390,8 @@ Split.configure do |config|
   # before experiment reset or deleted
   config.on_before_experiment_reset  = -> (example) { # Do something on reset }
   config.on_before_experiment_delete = -> (experiment) { # Do something else on delete }
+  # after experiment winner had been set
+  config.on_experiment_winner_choose = -> (experiment) { # Do something on winner choose }
 end
 ```
 
@@ -644,7 +650,7 @@ The API to define goals for an experiment is this:
 ab_test({link_color: ["purchase", "refund"]}, "red", "blue")
 ```
 
-or you can you can define them in a configuration file:
+or you can define them in a configuration file:
 
 ```ruby
 Split.configure do |config|
@@ -752,6 +758,20 @@ split_config = YAML.load_file(Rails.root.join('config', 'split.yml'))
 Split.redis = split_config[Rails.env]
 ```
 
+### Redis Caching (v4.0+)
+
+In some high-volume usage scenarios, Redis load can be incurred by repeated 
+fetches for fairly static data.  Enabling caching will reduce this load.
+
+ ```ruby
+Split.configuration.cache = true
+````
+
+This currently caches:
+  - `Split::ExperimentCatalog.find`
+  - `Split::Experiment.start_time`
+  - `Split::Experiment.winner`
+
 ## Namespaces
 
 If you're running multiple, separate instances of Split you may want
@@ -768,7 +788,7 @@ library. To configure Split to use `Redis::Namespace`, do the following:
   ```
 
 2. Configure `Split.redis` to use a `Redis::Namespace` instance (possible in an
-   intializer):
+   initializer):
 
   ```ruby
   redis = Redis.new(url: ENV['REDIS_URL']) # or whatever config you want

data/Rakefile

@@ -1,5 +1,6 @@
 #!/usr/bin/env rake
 # frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'appraisal'

data/gemfiles/{4.2.gemfile → 6.1.gemfile}

@@ -4,6 +4,6 @@ source "https://rubygems.org"
 
 gem "appraisal"
 gem "codeclimate-test-reporter"
-gem "rails", "~> 4.2"
+gem "rails", "~> 6.1"
 
 gemspec path: "../"

data/gemfiles/7.0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "codeclimate-test-reporter"
+gem "rails", "~> 7.0"
+
+gemspec path: "../"

data/lib/split/algorithms/block_randomization.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Selects alternative with minimum count of participants
 # If all counts are even (i.e. all are minimum), samples from all possible alternatives
 

data/lib/split/algorithms/weighted_sample.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Split
   module Algorithms
     module WeightedSample
@@ -8,7 +9,7 @@ module Split
         total = weights.inject(:+)
         point = rand * total
 
-        experiment.alternatives.zip(weights).each do |n,w|
+        experiment.alternatives.zip(weights).each do |n, w|
           return n if w >= point
           point -= w
         end

data/lib/split/algorithms/whiplash.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+
 # A multi-armed bandit implementation inspired by
 # @aaronsw and victorykit/whiplash
-require 'simple-random'
+require 'rubystats'
 
 module Split
   module Algorithms
@@ -16,7 +17,7 @@ module Split
         def arm_guess(participants, completions)
           a = [participants, 0].max
           b = [participants-completions, 0].max
-          s = SimpleRandom.new; s.set_seed; s.beta(a+fairness_constant, b+fairness_constant)
+          Rubystats::BetaDistribution.new(a+fairness_constant, b+fairness_constant).rng
         end
 
         def best_guess(alternatives)

data/lib/split/alternative.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Split
   class Alternative
     attr_accessor :name

data/lib/split/cache.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Split
+  class Cache
+
+    def self.clear
+      @cache = nil
+    end
+
+    def self.fetch(namespace, key)
+      return yield unless Split.configuration.cache
+
+      @cache ||= {}
+      @cache[namespace] ||= {}
+
+      value = @cache[namespace][key]
+      return value if value
+
+      @cache[namespace][key] = yield
+    end
+
+    def self.clear_key(key)
+      @cache&.keys&.each do |namespace|
+        @cache[namespace]&.delete(key)
+      end
+    end
+  end
+end

data/lib/split/combined_experiments_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Split
   module CombinedExperimentsHelper
     def ab_combined_test(metric_descriptor, control = nil, *alternatives)

data/lib/split/configuration.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Split
   class Configuration
     attr_accessor :ignore_ip_addresses
@@ -10,6 +11,7 @@ module Split
     attr_accessor :enabled
     attr_accessor :persistence
     attr_accessor :persistence_cookie_length
+    attr_accessor :persistence_cookie_domain
     attr_accessor :algorithm
     attr_accessor :store_override
     attr_accessor :start_manually
@@ -20,12 +22,14 @@ module Split
     attr_accessor :on_experiment_reset
     attr_accessor :on_experiment_delete
     attr_accessor :on_before_experiment_reset
+    attr_accessor :on_experiment_winner_choose
     attr_accessor :on_before_experiment_delete
     attr_accessor :include_rails_helper
     attr_accessor :beta_probability_simulations
     attr_accessor :winning_alternative_recalculation_interval
     attr_accessor :redis
     attr_accessor :dashboard_pagination_default_per_page
+    attr_accessor :cache
 
     attr_reader :experiments
 
@@ -84,7 +88,7 @@ module Split
         'LinkedInBot' => 'LinkedIn bot',
         'LongURL' => 'URL expander service',
         'NING' => 'NING - Yet Another Twitter Swarmer',
-        'Pinterest' => 'Pinterest Bot',
+        'Pinterestbot' => 'Pinterest Bot',
         'redditbot' => 'Reddit Bot',
         'ShortLinkTranslate' => 'Link shortener',
         'Slackbot' => 'Slackbot link expander',
@@ -173,7 +177,7 @@ module Split
     end
 
     def normalize_alternatives(alternatives)
-      given_probability, num_with_probability = alternatives.inject([0,0]) do |a,v|
+      given_probability, num_with_probability = alternatives.inject([0, 0]) do |a, v|
         p, n = a
         if percent = value_for(v, :percent)
           [p + percent, n + 1]
@@ -216,12 +220,14 @@ module Split
       @on_experiment_delete = proc{|experiment|}
       @on_before_experiment_reset = proc{|experiment|}
       @on_before_experiment_delete = proc{|experiment|}
+      @on_experiment_winner_choose = proc{|experiment|}
       @db_failover_allow_parameter_override = false
       @allow_multiple_experiments = false
       @enabled = true
       @experiments = {}
       @persistence = Split::Persistence::SessionAdapter
       @persistence_cookie_length = 31536000 # One year from now
+      @persistence_cookie_domain = nil
       @algorithm = Split::Algorithms::WeightedSample
       @include_rails_helper = true
       @beta_probability_simulations = 10000
@@ -230,16 +236,6 @@ module Split
       @dashboard_pagination_default_per_page = 10
     end
 
-    def redis_url=(value)
-      warn '[DEPRECATED] `redis_url=` is deprecated in favor of `redis=`'
-      self.redis = value
-    end
-
-    def redis_url
-      warn '[DEPRECATED] `redis_url` is deprecated in favor of `redis`'
-      self.redis
-    end
-
     private
 
     def value_for(hash, key)

data/lib/split/dashboard/helpers.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Split
   module DashboardHelpers
     def h(text)

data/lib/split/dashboard/pagination_helpers.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'split/dashboard/paginator'
 
 module Split

data/lib/split/dashboard/paginator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Split
   class DashboardPaginator
     def initialize(collection, page_number, per)

data/lib/split/dashboard/public/dashboard.js

@@ -22,3 +22,13 @@ function confirmReopen() {
   var agree = confirm("This will reopen the experiment. Are you sure?");
   return agree ? true : false;
 }
+
+function confirmEnableCohorting(){
+  var agree = confirm("This will enable the cohorting of the experiment. Are you sure?");
+  return agree ? true : false;
+}
+
+function confirmDisableCohorting(){
+  var agree = confirm("This will disable the cohorting of the experiment. Note: Existing participants will continue to receive their alternative and may continue to convert. Are you sure?");
+  return agree ? true : false;
+}

data/lib/split/dashboard/public/style.css

@@ -326,3 +326,8 @@ a.button.green:focus, button.green:focus, input[type="submit"].green:focus {
   display: inline-block;
   padding: 5px;
 }
+
+.divider {
+  display: inline-block;
+  margin-left: 10px;
+}

data/lib/split/dashboard/views/_controls.erb

@@ -2,7 +2,20 @@
   <form action="<%= url "/reopen?experiment=#{experiment.name}" %>" method='post' onclick="return confirmReopen()">
     <input type="submit" value="Reopen Experiment">
   </form>
+<% else %>
+  <% if experiment.cohorting_disabled? %>
+    <form action="<%= url "/update_cohorting?experiment=#{experiment.name}" %>" method='post' onclick="return confirmEnableCohorting()">
+      <input type="hidden" name="cohorting_action" value="enable">
+      <input type="submit" value="Enable Cohorting" class="green">
+    </form>
+  <% else %>
+    <form action="<%= url "/update_cohorting?experiment=#{experiment.name}" %>" method='post' onclick="return confirmDisableCohorting()">
+      <input type="hidden" name="cohorting_action" value="disable">
+      <input type="submit" value="Disable Cohorting" class="red">
+    </form>
+  <% end %>
 <% end %>
+<span class="divider">|</span>
 <% if experiment.start_time %>
   <form action="<%= url "/reset?experiment=#{experiment.name}" %>" method='post' onclick="return confirmReset()">
     <input type="submit" value="Reset Data">

data/lib/split/dashboard.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'sinatra/base'
 require 'split'
 require 'bigdecimal'
@@ -35,8 +36,11 @@ module Split
     post '/force_alternative' do
       experiment = Split::ExperimentCatalog.find(params[:experiment])
       alternative = Split::Alternative.new(params[:alternative], experiment.name)
-      alternative.increment_participation
-      Split::User.new(self)[experiment.key] = alternative.name
+
+      cookies = JSON.parse(request.cookies['split_override']) rescue {}
+      cookies[experiment.name] = alternative.name
+      response.set_cookie('split_override', { value: cookies.to_json, path: '/' })
+
       redirect url('/')
     end
 
@@ -65,6 +69,17 @@ module Split
       redirect url('/')
     end
 
+    post '/update_cohorting' do
+      @experiment = Split::ExperimentCatalog.find(params[:experiment])
+      case params[:cohorting_action].downcase
+      when "enable"
+        @experiment.enable_cohorting
+      when "disable"
+        @experiment.disable_cohorting
+      end
+      redirect url('/')
+    end
+
     delete '/experiment' do
       @experiment = Split::ExperimentCatalog.find(params[:experiment])
       @experiment.delete

data/lib/split/encapsulated_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "split/helper"
 
 # Split's helper exposes all kinds of methods we don't want to
@@ -28,8 +29,8 @@ module Split
       end
     end
 
-    def ab_test(*arguments,&block)
-      split_context_shim.ab_test(*arguments,&block)
+    def ab_test(*arguments, &block)
+      split_context_shim.ab_test(*arguments, &block)
     end
 
     private

data/lib/split/engine.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
+
 module Split
   class Engine < ::Rails::Engine
     initializer "split" do |app|
       if Split.configuration.include_rails_helper
         ActiveSupport.on_load(:action_controller) do
-          include Split::Helper
-          helper Split::Helper
-          include Split::CombinedExperimentsHelper
-          helper Split::CombinedExperimentsHelper
+          ::ActionController::Base.send :include, Split::Helper
+          ::ActionController::Base.helper Split::Helper
+          ::ActionController::Base.send :include, Split::CombinedExperimentsHelper
+          ::ActionController::Base.helper Split::CombinedExperimentsHelper
         end
       end
     end

data/lib/split/exceptions.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Split
   class InvalidPersistenceAdapterError < StandardError; end
   class ExperimentNotFound < StandardError; end