split 3.0.0 → 3.4.0

data/lib/split/combined_experiments_helper.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+module Split
+  module CombinedExperimentsHelper
+    def ab_combined_test(metric_descriptor, control = nil, *alternatives)
+      return nil unless experiment = find_combined_experiment(metric_descriptor)
+      raise(Split::InvalidExperimentsFormatError, "Unable to find experiment #{metric_descriptor} in configuration") if experiment[:combined_experiments].nil?
+
+      alternative = nil
+      weighted_alternatives = nil
+      experiment[:combined_experiments].each do |combined_experiment|
+        if alternative.nil?
+          if control
+            alternative = ab_test(combined_experiment, control, alternatives)
+          else
+            normalized_alternatives = Split::Configuration.new.normalize_alternatives(experiment[:alternatives])
+            alternative = ab_test(combined_experiment, normalized_alternatives[0], *normalized_alternatives[1])
+          end
+        else
+          weighted_alternatives ||= experiment[:alternatives].each_with_object({}) do |alt, memo|
+            alt = Alternative.new(alt, experiment[:name]).name
+            memo[alt] = (alt == alternative ? 1 : 0)
+          end
+
+          ab_test(combined_experiment, [weighted_alternatives])
+        end
+      end
+      alternative
+    end
+
+    def find_combined_experiment(metric_descriptor)
+      raise(Split::InvalidExperimentsFormatError, 'Invalid descriptor class (String or Symbol required)') unless metric_descriptor.class == String || metric_descriptor.class == Symbol
+      raise(Split::InvalidExperimentsFormatError, 'Enable configuration') unless Split.configuration.enabled
+      raise(Split::InvalidExperimentsFormatError, 'Enable `allow_multiple_experiments`') unless Split.configuration.allow_multiple_experiments
+      Split::configuration.experiments[metric_descriptor.to_sym]
+    end
+  end
+end

data/lib/split/configuration.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 module Split
   class Configuration
-    attr_accessor :bots
-    attr_accessor :robot_regex
     attr_accessor :ignore_ip_addresses
     attr_accessor :ignore_filter
     attr_accessor :db_failover
@@ -25,10 +23,15 @@ module Split
     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_reader :experiments
 
+    attr_writer :bots
+    attr_writer :robot_regex
+
     def bots
       @bots ||= {
         # Indexers
@@ -48,7 +51,9 @@ module Split
         'spider' => 'generic web spider',
         'UnwindFetchor' => 'Gnip crawler',
         'WordPress' => 'WordPress spider',
+        'YandexAccessibilityBot' => 'Yandex accessibility spider',
         'YandexBot' => 'Yandex spider',
+        'YandexMobileBot' => 'Yandex mobile spider',
         'ZIBB' => 'ZIBB spider',
 
         # HTTP libraries
@@ -58,12 +63,14 @@ module Split
         'ColdFusion' => 'ColdFusion http library',
         'EventMachine HttpClient' => 'Ruby http library',
         'Go http package' => 'Go http library',
+        'Go-http-client' => 'Go http library',
         'Java' => 'Generic Java http library',
         'libwww-perl' => 'Perl client-server library loved by script kids',
         'lwp-trivial' => 'Another Perl library loved by script kids',
         'Python-urllib' => 'Python http library',
         'PycURL' => 'Python http library',
         'Test Certificate Info' => 'C http library?',
+        'Typhoeus' => 'Ruby http library',
         'Wget' => 'wget unix CLI http client',
 
         # URL expanders / previewers
@@ -71,12 +78,16 @@ module Split
         'bitlybot' => 'bit.ly bot',
         'bot@linkfluence.net' => 'Linkfluence bot',
         'facebookexternalhit' => 'facebook bot',
+        'Facebot' => 'Facebook crawler',
         'Feedfetcher-Google' => 'Google Feedfetcher',
         'https://developers.google.com/+/web/snippet' => 'Google+ Snippet Fetcher',
+        'LinkedInBot' => 'LinkedIn bot',
         'LongURL' => 'URL expander service',
         'NING' => 'NING - Yet Another Twitter Swarmer',
+        'Pinterest' => 'Pinterest Bot',
         'redditbot' => 'Reddit Bot',
         'ShortLinkTranslate' => 'Link shortener',
+        'Slackbot' => 'Slackbot link expander',
         'TweetmemeBot' => 'TweetMeMe Crawler',
         'Twitterbot' => 'Twitter URL expander',
         'UnwindFetch' => 'Gnip URL expander',
@@ -84,10 +95,12 @@ module Split
 
         # Uptime monitoring
         'check_http' => 'Nagios monitor',
+        'GoogleStackdriverMonitoring' => 'Google Cloud monitor',
         'NewRelicPinger' => 'NewRelic monitor',
         'Panopta' => 'Monitoring service',
         'Pingdom' => 'Pingdom monitoring',
         'SiteUptime' => 'Site monitoring services',
+        'UptimeRobot' => 'Monitoring service',
 
         # ???
         'DigitalPersona Fingerprint Software' => 'HP Fingerprint scanner',
@@ -212,7 +225,9 @@ module Split
       @algorithm = Split::Algorithms::WeightedSample
       @include_rails_helper = true
       @beta_probability_simulations = 10000
+      @winning_alternative_recalculation_interval = 60 * 60 * 24 # 1 day
       @redis = ENV.fetch(ENV.fetch('REDIS_PROVIDER', 'REDIS_URL'), 'redis://localhost:6379')
+      @dashboard_pagination_default_per_page = 10
     end
 
     def redis_url=(value)

data/lib/split/dashboard/helpers.rb

@@ -19,9 +19,9 @@ module Split
 
     def round(number, precision = 2)
       begin
-        BigDecimal.new(number.to_s)
+        BigDecimal(number.to_s)
       rescue ArgumentError
-        BigDecimal.new(0)
+        BigDecimal(0)
       end.round(precision).to_f
     end
 

data/lib/split/dashboard/pagination_helpers.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+require 'split/dashboard/paginator'
+
+module Split
+  module DashboardPaginationHelpers
+    def pagination_per
+      default_per_page = Split.configuration.dashboard_pagination_default_per_page
+      @pagination_per ||= (params[:per] || default_per_page).to_i
+    end
+
+    def page_number
+      @page_number ||= (params[:page] || 1).to_i
+    end
+
+    def paginated(collection)
+      Split::DashboardPaginator.new(collection, page_number, pagination_per).paginate
+    end
+
+    def pagination(collection)
+      html = []
+      html << first_page_tag if show_first_page_tag?
+      html << ellipsis_tag if show_first_ellipsis_tag?
+      html << prev_page_tag if show_prev_page_tag?
+      html << current_page_tag
+      html << next_page_tag if show_next_page_tag?(collection)
+      html << ellipsis_tag if show_last_ellipsis_tag?(collection)
+      html << last_page_tag(collection) if show_last_page_tag?(collection)
+      html.join
+    end
+
+    private
+
+    def show_first_page_tag?
+      page_number > 2
+    end
+
+    def first_page_tag
+      %Q(<a href="#{url.chop}?page=1&per=#{pagination_per}">1</a>)
+    end
+
+    def show_first_ellipsis_tag?
+      page_number >= 4
+    end
+
+    def ellipsis_tag
+      '<span>...</span>'
+    end
+
+    def show_prev_page_tag?
+      page_number > 1
+    end
+
+    def prev_page_tag
+      %Q(<a href="#{url.chop}?page=#{page_number - 1}&per=#{pagination_per}">#{page_number - 1}</a>)
+    end
+
+    def current_page_tag
+      "<span><b>#{page_number}</b></span>"
+    end
+
+    def show_next_page_tag?(collection)
+      (page_number * pagination_per) < collection.count
+    end
+
+    def next_page_tag
+      %Q(<a href="#{url.chop}?page=#{page_number + 1}&per=#{pagination_per}">#{page_number + 1}</a>)
+    end
+
+    def show_last_ellipsis_tag?(collection)
+      (total_pages(collection) - page_number) >= 3
+    end
+
+    def total_pages(collection)
+      collection.count / pagination_per + ((collection.count % pagination_per).zero? ? 0 : 1)
+    end
+
+    def show_last_page_tag?(collection)
+      page_number < (total_pages(collection) - 1)
+    end
+
+    def last_page_tag(collection)
+      total = total_pages(collection)
+      %Q(<a href="#{url.chop}?page=#{total}&per=#{pagination_per}">#{total}</a>)
+    end
+  end
+end

data/lib/split/dashboard/paginator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module Split
+  class DashboardPaginator
+    def initialize(collection, page_number, per)
+      @collection = collection
+      @page_number = page_number
+      @per = per
+    end
+
+    def paginate
+      to = @page_number * @per
+      from = to - @per
+      @collection[from...to]
+    end
+  end
+end

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

@@ -317,3 +317,12 @@ a.button.green:focus, button.green:focus, input[type="submit"].green:focus {
 }
 
 
+.pagination {
+  text-align: center;
+  font-size: 15px;
+}
+
+.pagination a, .paginaton span {
+  display: inline-block;
+  padding: 5px;
+}

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

@@ -6,7 +6,7 @@
   <input type="button" id="toggle-active" value="Hide active" />
   <input type="button" id="clear-filter" value="Clear filters" />
 
-  <% @experiments.each do |experiment| %>
+  <% paginated(@experiments).each do |experiment| %>
     <% if experiment.goals.empty? %>
       <%= erb :_experiment, :locals => {:goal => nil, :experiment => experiment} %>
     <% else %>
@@ -16,6 +16,10 @@
       <% end %>
     <% end %>
   <% end %>
+
+  <div class="pagination">
+    <%= pagination(@experiments) %>
+  </div>
 <% else %>
   <p class="intro">No experiments have started yet, you need to define them in your code and introduce them to your users.</p>
   <p class="intro">Check out the <a href='https://github.com/splitrb/split#readme'>Readme</a> for more help getting started.</p>

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

@@ -21,7 +21,7 @@
   </div>
 
   <div id="footer">
-    <p>Powered by <a href="http://github.com/splitrb/split">Split</a> v<%=Split::VERSION %></p>
+    <p>Powered by <a href="https://github.com/splitrb/split">Split</a> v<%=Split::VERSION %></p>
   </div>
 </body>
 </html>

data/lib/split/dashboard.rb

@@ -3,6 +3,7 @@ require 'sinatra/base'
 require 'split'
 require 'bigdecimal'
 require 'split/dashboard/helpers'
+require 'split/dashboard/pagination_helpers'
 
 module Split
   class Dashboard < Sinatra::Base
@@ -14,6 +15,7 @@ module Split
     set :method_override, true
 
     helpers Split::DashboardHelpers
+    helpers Split::DashboardPaginationHelpers
 
     get '/' do
       # Display experiments without a winner at the top of the dashboard
@@ -31,7 +33,10 @@ module Split
     end
 
     post '/force_alternative' do
-      Split::User.new(self)[params[:experiment]] = params[:alternative]
+      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
       redirect url('/')
     end
 

data/lib/split/engine.rb

@@ -3,8 +3,12 @@ module Split
   class Engine < ::Rails::Engine
     initializer "split" do |app|
       if Split.configuration.include_rails_helper
-        ActionController::Base.send :include, Split::Helper
-        ActionController::Base.helper Split::Helper
+        ActiveSupport.on_load(:action_controller) do
+          include Split::Helper
+          helper Split::Helper
+          include Split::CombinedExperimentsHelper
+          helper Split::CombinedExperimentsHelper
+        end
       end
     end
   end

data/lib/split/experiment.rb

@@ -2,13 +2,13 @@
 module Split
   class Experiment
     attr_accessor :name
-    attr_writer :algorithm
-    attr_accessor :resettable
     attr_accessor :goals
-    attr_accessor :alternatives
     attr_accessor :alternative_probabilities
     attr_accessor :metadata
 
+    attr_reader :alternatives
+    attr_reader :resettable
+
     DEFAULT_OPTIONS = {
       :resettable => true
     }
@@ -25,7 +25,7 @@ module Split
           alternatives: load_alternatives_from_configuration,
           goals: Split::GoalsCollection.new(@name).load_from_configuration,
           metadata: load_metadata_from_configuration,
-          resettable: exp_config[:resettable],
+          resettable: exp_config.fetch(:resettable, true),
           algorithm: exp_config[:algorithm]
         }
       else
@@ -62,7 +62,7 @@ module Split
           alts = load_alternatives_from_configuration
           options[:goals] = Split::GoalsCollection.new(@name).load_from_configuration
           options[:metadata] = load_metadata_from_configuration
-          options[:resettable] = exp_config[:resettable]
+          options[:resettable] = exp_config.fetch(:resettable, true)
           options[:algorithm] = exp_config[:algorithm]
         end
       end
@@ -81,12 +81,12 @@ module Split
 
       if new_record?
         start unless Split.configuration.start_manually
+        persist_experiment_configuration
       elsif experiment_configuration_has_changed?
         reset unless Split.configuration.reset_manually
+        persist_experiment_configuration
       end
 
-      persist_experiment_configuration if new_record? || experiment_configuration_has_changed?
-
       redis.hset(experiment_config_key, :resettable, resettable)
       redis.hset(experiment_config_key, :algorithm, algorithm.to_s)
       self
@@ -144,11 +144,13 @@ module Split
     end
 
     def has_winner?
-      !winner.nil?
+      return @has_winner if defined? @has_winner
+      @has_winner = !winner.nil?
     end
 
     def winner=(winner_name)
       redis.hset(:experiment_winner, name, winner_name.to_s)
+      @has_winner = true
     end
 
     def participant_count
@@ -161,6 +163,7 @@ module Split
 
     def reset_winner
       redis.hdel(:experiment_winner, name)
+      @has_winner = false
     end
 
     def start
@@ -262,10 +265,11 @@ module Split
     end
 
     def calc_winning_alternatives
-      # Super simple cache so that we only recalculate winning alternatives once per day
-      days_since_epoch = Time.now.utc.to_i / 86400
+      # Cache the winning alternatives so we recalculate them once per the specified interval.
+      intervals_since_epoch =
+        Time.now.utc.to_i / Split.configuration.winning_alternative_recalculation_interval
 
-      if self.calc_time != days_since_epoch
+      if self.calc_time != intervals_since_epoch
         if goals.empty?
           self.estimate_winning_alternative
         else
@@ -274,7 +278,7 @@ module Split
           end
         end
 
-        self.calc_time = days_since_epoch
+        self.calc_time = intervals_since_epoch
 
         self.save
       end
@@ -419,14 +423,22 @@ module Split
     end
 
     def load_alternatives_from_redis
-      case redis.type(@name)
-      when 'set' # convert legacy sets to lists
-        alts = redis.smembers(@name)
-        redis.del(@name)
-        alts.reverse.each {|a| redis.lpush(@name, a) }
-        redis.lrange(@name, 0, -1)
-      else
-        redis.lrange(@name, 0, -1)
+      alternatives = case redis.type(@name)
+                     when 'set' # convert legacy sets to lists
+                       alts = redis.smembers(@name)
+                       redis.del(@name)
+                       alts.reverse.each {|a| redis.lpush(@name, a) }
+                       redis.lrange(@name, 0, -1)
+                     else
+                       redis.lrange(@name, 0, -1)
+                     end
+      alternatives.map do |alt|
+        alt = begin
+                JSON.parse(alt)
+              rescue
+                alt
+              end
+        Split::Alternative.new(alt, @name)
       end
     end
 
@@ -442,7 +454,7 @@ module Split
 
     def persist_experiment_configuration
       redis_interface.add_to_set(:experiments, name)
-      redis_interface.persist_list(name, @alternatives.map(&:name))
+      redis_interface.persist_list(name, @alternatives.map{|alt| {alt.name => alt.weight}.to_json})
       goals_collection.save
       redis.set(metadata_key, @metadata.to_json) unless @metadata.nil?
     end
@@ -458,7 +470,7 @@ module Split
       existing_alternatives = load_alternatives_from_redis
       existing_goals = Split::GoalsCollection.new(@name).load_from_redis
       existing_metadata = load_metadata_from_redis
-      existing_alternatives != @alternatives.map(&:name) ||
+      existing_alternatives.map(&:to_s) != @alternatives.map(&:to_s) ||
         existing_goals != @goals ||
         existing_metadata != @metadata
     end

data/lib/split/goals_collection.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Split
   class GoalsCollection
 

data/lib/split/helper.rb

@@ -8,8 +8,9 @@ module Split
     def ab_test(metric_descriptor, control = nil, *alternatives)
       begin
         experiment = ExperimentCatalog.find_or_initialize(metric_descriptor, control, *alternatives)
-        alternative = if Split.configuration.enabled
+        alternative = if Split.configuration.enabled && !exclude_visitor?
           experiment.save
+          raise(Split::InvalidExperimentsFormatError) unless (Split.configuration.experiments || {}).fetch(experiment.name.to_sym, {})[:combined_experiments].nil?
           trial = Trial.new(:user => ab_user, :experiment => experiment,
               :override => override_alternative(experiment.name), :exclude => exclude_visitor?,
               :disabled => split_generically_disabled?)
@@ -43,6 +44,7 @@ module Split
     end
 
     def finish_experiment(experiment, options = {:reset => true})
+      return false if active_experiments[experiment.name].nil?
       return true if experiment.has_winner?
       should_reset = experiment.resettable? && options[:reset]
       if ab_user[experiment.finished_key] && !should_reset
@@ -78,7 +80,7 @@ module Split
 
     def ab_record_extra_info(metric_descriptor, key, value = 1)
       return if exclude_visitor? || Split.configuration.disabled?
-      metric_descriptor, goals = normalize_metric(metric_descriptor)
+      metric_descriptor, _ = normalize_metric(metric_descriptor)
       experiments = Metric.possible_experiments(metric_descriptor)
 
       if experiments.any?
@@ -96,6 +98,14 @@ module Split
       Split.configuration.db_failover_on_db_error.call(e)
     end
 
+    def ab_active_experiments()
+      ab_user.active_experiments
+    rescue => e
+      raise unless Split.configuration.db_failover
+      Split.configuration.db_failover_on_db_error.call(e)
+    end
+
+
     def override_present?(experiment_name)
       override_alternative(experiment_name)
     end
@@ -113,13 +123,17 @@ module Split
     end
 
     def exclude_visitor?
-      instance_eval(&Split.configuration.ignore_filter) || is_ignored_ip_address? || is_robot?
+      defined?(request) && (instance_exec(request, &Split.configuration.ignore_filter) || is_ignored_ip_address? || is_robot? || is_preview?)
     end
 
     def is_robot?
       defined?(request) && request.user_agent =~ Split.configuration.robot_regex
     end
 
+    def is_preview?
+      defined?(request) && defined?(request.headers) && request.headers['x-purpose'] == 'preview'
+    end
+
     def is_ignored_ip_address?
       return false if Split.configuration.ignore_ip_addresses.empty?
 

data/lib/split/persistence/cookie_adapter.rb

@@ -6,20 +6,22 @@ module Split
     class CookieAdapter
 
       def initialize(context)
-        @cookies = context.send(:cookies)
+        @context = context
+        @request, @response = context.request, context.response
+        @cookies = @request.cookies
         @expires = Time.now + cookie_length_config
       end
 
       def [](key)
-        hash[key]
+        hash[key.to_s]
       end
 
       def []=(key, value)
-        set_cookie(hash.merge(key => value))
+        set_cookie(hash.merge!(key.to_s => value))
       end
 
       def delete(key)
-        set_cookie(hash.tap { |h| h.delete(key) })
+        set_cookie(hash.tap { |h| h.delete(key.to_s) })
       end
 
       def keys
@@ -28,22 +30,55 @@ module Split
 
       private
 
-      def set_cookie(value)
-        @cookies[:split] = {
-          :value => JSON.generate(value),
-          :expires => @expires
-        }
+      def set_cookie(value = {})
+        cookie_key = :split.to_s
+        cookie_value = default_options.merge(value: JSON.generate(value))
+        if action_dispatch?
+          # The "send" is necessary when we call ab_test from the controller
+          # and thus @context is a rails controller, because then "cookies" is
+          # a private method.
+          @context.send(:cookies)[cookie_key] = cookie_value
+        else
+          set_cookie_via_rack(cookie_key, cookie_value)
+        end
+      end
+
+      def default_options
+        { expires: @expires, path: '/' }
+      end
+
+      def set_cookie_via_rack(key, value)
+        delete_cookie_header!(@response.header, key, value)
+        Rack::Utils.set_cookie_header!(@response.header, key, value)
+      end
+
+      # Use Rack::Utils#make_delete_cookie_header after Rack 2.0.0
+      def delete_cookie_header!(header, key, value)
+        cookie_header = header['Set-Cookie']
+        case cookie_header
+        when nil, ''
+          cookies = []
+        when String
+          cookies = cookie_header.split("\n")
+        when Array
+          cookies = cookie_header
+        end
+
+        cookies.reject! { |cookie| cookie =~ /\A#{Rack::Utils.escape(key)}=/ }
+        header['Set-Cookie'] = cookies.join("\n")
       end
 
       def hash
-        if @cookies[:split]
-          begin
-            JSON.parse(@cookies[:split])
-          rescue JSON::ParserError
+        @hash ||= begin
+          if cookies = @cookies[:split.to_s]
+            begin
+              JSON.parse(cookies)
+            rescue JSON::ParserError
+              {}
+            end
+          else
             {}
           end
-        else
-          {}
         end
       end
 
@@ -51,6 +86,9 @@ module Split
         Split.configuration.persistence_cookie_length
       end
 
+      def action_dispatch?
+        defined?(Rails) && @response.is_a?(ActionDispatch::Response)
+      end
     end
   end
 end