split 4.0.2 → 4.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1c97063d4d1ccf4c2cd5dfd2e83b98b3f55a934b9dfa9b5862ede3ee5b8c58c
-  data.tar.gz: 28e30003a6d2059baf91482f5ac9a97b0b7d2e37c61a425710cbf1adf21a4a83
+  metadata.gz: 80d095f07432d336e773b30c3c5a873b554dd682f65ace33886d1a83697d447a
+  data.tar.gz: 9a504a3c9d4c67391528e1640c2c7eac3cfcafe91305cadb901e48541726f04c
 SHA512:
-  metadata.gz: 988f115f0f96870188221552cca45f6a7207f548500dbf2a5446abaa47ac7365571644a5a231443ca7616182b68c3139f8d62fdcf18d1593fca8898092a332e2
-  data.tar.gz: b6a668159d8b6fe9529bae5bc650f120b9de1bdf593bc89d0d949a2e07e8cfda7c96b4c12e5e4615696cf31b845215f95ce60b4abcb9ff3d7ef056669a4ae51d
+  metadata.gz: 68e5919618103f315fa9f4f0d18384392c02c01c680c13d50a77cfa0507bd19a1c01fb5c1db66619329c1ef38013c3ebe90e880f6af5c9bac9ba2d1a76b3963a
+  data.tar.gz: 1ae5fe0187e16b4bb3efc14a0e0ded4df98527fbc530dab4a89c544d133b1a7e8cd0adc6579f0f43ea3c84aa6899a2d123e97c5af105ce158e804a5ac8286728

data/.github/workflows/ci.yml

@@ -37,6 +37,8 @@ jobs:
           - gemfile: 7.0.gemfile
             ruby: '3.1'
 
+          - gemfile: 7.0.gemfile
+            ruby: '3.2'
 
     runs-on: ubuntu-latest
 
@@ -51,7 +53,7 @@ jobs:
           --health-retries 5
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: ruby/setup-ruby@v1
         with:

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+# 4.0.4 (March 3rd, 2024)
+
+Bugfixes:
+- Better integration for EncapsulatedHelper when needing params/request info (@henrique-ft, #721 and #723)
+
+Misc:
+- Make specs compatible with newer Rack versions (@andrehjr,  #722)
+
+# 4.0.3 (November 15th, 2023)
+
+Bugfixes:
+- Do not throw error if alternativas have data that can lead to negative numbers for probability calculation (@andrehjr, #703)
+- Do not persist invalid extra_info on ab_record_extra_info. (@trostli @andrehjr, #717)
+- CROSSSLOT keys issue fix when using redis cluster (@naveen-chidhambaram, #710)
+- Convert value to string before saving it in RedisAdapter (@Jealrock, #714)
+- Fix deprecation warning with Redis 4.8.0 (@martingregoire, #701)
+
+Misc:
+- Add matrix as a default dependency (@andrehjr, #705)
+- Add Ruby 3.2 to Github Actions (@andrehjr, #702)
+- Update documentation regarding finding users outside a web session (@andrehjr, #716)
+- Update actions/checkout to v4 (@andrehjr, #718)
+
 # 4.0.2 (December 2nd, 2022)
 
 Bugfixes:

data/Gemfile

@@ -5,5 +5,4 @@ source "https://rubygems.org"
 gemspec
 
 gem "rubocop", require: false
-gem "matrix"
 gem "codeclimate-test-reporter"

data/README.md

@@ -807,10 +807,16 @@ conduct experiments that are not tied to a web session.
 ```ruby
 # create a new experiment
 experiment = Split::ExperimentCatalog.find_or_create('color', 'red', 'blue')
+
+# find the user
+user = Split::User.find(user_id, :redis)
+
 # create a new trial
-trial = Split::Trial.new(:experiment => experiment)
+trial = Split::Trial.new(user: user, experiment: experiment)
+
 # run trial
 trial.choose!
+
 # get the result, returns either red or blue
 trial.alternative.name
 

data/gemfiles/7.0.gemfile

@@ -3,6 +3,5 @@ source "https://rubygems.org"
 gem "rubocop", require: false
 gem "codeclimate-test-reporter"
 gem "rails", "~> 7.0"
-gem "matrix"
 
 gemspec path: "../"

data/lib/split/algorithms.rb

@@ -1,14 +1,6 @@
 # frozen_string_literal: true
 
-begin
-  require "matrix"
-rescue LoadError => error
-  if error.message.match?(/matrix/)
-    $stderr.puts "You don't have matrix installed in your application. Please add it to your Gemfile and run bundle install"
-    raise
-  end
-end
-
+require "matrix"
 require "rubystats"
 
 module Split

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

@@ -16,7 +16,8 @@
   summary_texts = {}
   extra_columns.each do |column|
     extra_infos = experiment.alternatives.map(&:extra_info).select{|extra_info| extra_info && extra_info[column] }
-    if extra_infos[0][column].kind_of?(Numeric)
+
+    if extra_infos.length > 0 && extra_infos.all? { |extra_info| extra_info[column].kind_of?(Numeric) }
       summary_texts[column] = extra_infos.inject(0){|sum, extra_info| sum += extra_info[column]}
     else
       summary_texts[column] = "N/A"

data/lib/split/encapsulated_helper.rb

@@ -23,6 +23,14 @@ module Split
         @context = context
       end
 
+      def params
+        request.params if request && request.respond_to?(:params)
+      end
+
+      def request
+        @context.request if @context.respond_to?(:request)
+      end
+
       def ab_user
         @ab_user ||= Split::User.new(@context)
       end

data/lib/split/experiment.rb

@@ -270,7 +270,16 @@ module Split
       set_alternatives_and_options(options)
     end
 
+    def can_calculate_winning_alternatives?
+      self.alternatives.all? do |alternative|
+        alternative.participant_count >= 0 &&
+        (alternative.participant_count >= alternative.completed_count)
+      end
+    end
+
     def calc_winning_alternatives
+      return unless can_calculate_winning_alternatives?
+
       # 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

data/lib/split/helper.rb

@@ -86,7 +86,7 @@ module Split
     end
 
     def ab_record_extra_info(metric_descriptor, key, value = 1)
-      return if exclude_visitor? || Split.configuration.disabled?
+      return if exclude_visitor? || Split.configuration.disabled? || value.nil?
       metric_descriptor, _ = normalize_metric(metric_descriptor)
       experiments = Metric.possible_experiments(metric_descriptor)
 
@@ -121,11 +121,11 @@ module Split
     end
 
     def override_alternative_by_params(experiment_name)
-      defined?(params) && params[OVERRIDE_PARAM_NAME] && params[OVERRIDE_PARAM_NAME][experiment_name]
+      params_present? && params[OVERRIDE_PARAM_NAME] && params[OVERRIDE_PARAM_NAME][experiment_name]
     end
 
     def override_alternative_by_cookies(experiment_name)
-      return unless defined?(request)
+      return unless request_present?
 
       if request.cookies && request.cookies.key?("split_override")
         experiments = JSON.parse(request.cookies["split_override"]) rescue {}
@@ -134,7 +134,7 @@ module Split
     end
 
     def split_generically_disabled?
-      defined?(params) && params["SPLIT_DISABLE"]
+      params_present? && params["SPLIT_DISABLE"]
     end
 
     def ab_user
@@ -142,26 +142,34 @@ module Split
     end
 
     def exclude_visitor?
-      defined?(request) && (instance_exec(request, &Split.configuration.ignore_filter) || is_ignored_ip_address? || is_robot? || is_preview?)
+      request_present? && (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
+      request_present? && request.user_agent =~ Split.configuration.robot_regex
     end
 
     def is_preview?
-      defined?(request) && defined?(request.headers) && request.headers["x-purpose"] == "preview"
+      request_present? && defined?(request.headers) && request.headers["x-purpose"] == "preview"
     end
 
     def is_ignored_ip_address?
       return false if Split.configuration.ignore_ip_addresses.empty?
 
       Split.configuration.ignore_ip_addresses.each do |ip|
-        return true if defined?(request) && (request.ip == ip || (ip.class == Regexp && request.ip =~ ip))
+        return true if request_present? && (request.ip == ip || (ip.class == Regexp && request.ip =~ ip))
       end
       false
     end
 
+    def params_present?
+      defined?(params) && params
+    end
+
+    def request_present?
+      defined?(request) && request
+    end
+
     def active_experiments
       ab_user.active_experiments
     end

data/lib/split/persistence/redis_adapter.rb

@@ -27,7 +27,7 @@ module Split
       end
 
       def []=(field, value)
-        Split.redis.hset(redis_key, field, value)
+        Split.redis.hset(redis_key, field, value.to_s)
         expire_seconds = self.class.config[:expire_seconds]
         Split.redis.expire(redis_key, expire_seconds) if expire_seconds
       end

data/lib/split/redis_interface.rb

@@ -11,6 +11,7 @@ module Split
       if list_values.length > 0
         redis.multi do |multi|
           tmp_list = "#{list_name}_tmp"
+          tmp_list += redis_namespace_used? ? "{#{Split.redis.namespace}:#{list_name}}" : "{#{list_name}}"
           multi.rpush(tmp_list, list_values)
           multi.rename(tmp_list, list_name)
         end
@@ -20,10 +21,16 @@ module Split
     end
 
     def add_to_set(set_name, value)
+      return redis.sadd?(set_name, value) if redis.respond_to?(:sadd?)
+
       redis.sadd(set_name, value)
     end
 
     private
       attr_accessor :redis
+
+      def redis_namespace_used?
+        Redis.const_defined?("Namespace") && Split.redis.is_a?(Redis::Namespace)
+      end
   end
 end

data/lib/split/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Split
-  VERSION = "4.0.2"
+  VERSION = "4.0.4"
 end

data/spec/dashboard_spec.rb

@@ -279,4 +279,16 @@ describe Split::Dashboard do
 
     expect(last_response.body).to include("<small>Unknown</small>")
   end
+
+  it "should be explode with experiments with invalid data" do
+    red_link.participant_count = 1
+    red_link.set_completed_count(10)
+
+    blue_link.participant_count = 3
+    blue_link.set_completed_count(2)
+
+    get "/"
+
+    expect(last_response).to be_ok
+  end
 end

data/spec/encapsulated_helper_spec.rb

@@ -3,11 +3,7 @@
 require "spec_helper"
 
 describe Split::EncapsulatedHelper do
-  include Split::EncapsulatedHelper
-
-  def params
-    raise NoMethodError, "This method is not really defined"
-  end
+  let(:context_shim) { Split::EncapsulatedHelper::ContextShim.new(double(request: request)) }
 
   describe "ab_test" do
     before do
@@ -15,20 +11,15 @@ describe Split::EncapsulatedHelper do
       .and_return(mock_user)
     end
 
-    it "should not raise an error when params raises an error" do
-      expect { params }.to raise_error(NoMethodError)
-      expect { ab_test("link_color", "blue", "red") }.not_to raise_error
-    end
-
     it "calls the block with selected alternative" do
-      expect { |block| ab_test("link_color", "red", "red", &block) }.to yield_with_args("red", {})
+      expect { |block| context_shim.ab_test("link_color", "red", "red", &block) }.to yield_with_args("red", {})
     end
 
     context "inside a view" do
       it "works inside ERB" do
         require "erb"
         template = ERB.new(<<-ERB.split(/\s+/s).map(&:strip).join(" "), nil, "%")
-          foo <% ab_test(:foo, '1', '2') do |alt, meta| %>
+          foo <% context_shim.ab_test(:foo, '1', '2') do |alt, meta| %>
             static <%= alt %>
           <% end %>
         ERB
@@ -43,8 +34,43 @@ describe Split::EncapsulatedHelper do
         include Split::EncapsulatedHelper
         public :session
       }.new
+
       expect(ctx).to receive(:session) { {} }
       expect { ctx.ab_test("link_color", "blue", "red") }.not_to raise_error
     end
+
+    context "when request is defined in context of ContextShim" do
+      context "when overriding by params" do
+        it do
+          ctx = Class.new {
+            public :session
+            def request
+              build_request(params: {
+                "ab_test" => { "link_color" => "blue" }
+              })
+            end
+          }.new
+
+          context_shim = Split::EncapsulatedHelper::ContextShim.new(ctx)
+          expect(context_shim.ab_test("link_color", "blue", "red")).to be("blue")
+        end
+      end
+
+      context "when overriding by cookies" do
+        it do
+          ctx = Class.new {
+            public :session
+            def request
+              build_request(cookies: {
+                "split_override" => '{ "link_color": "red" }'
+              })
+            end
+          }.new
+
+          context_shim = Split::EncapsulatedHelper::ContextShim.new(ctx)
+          expect(context_shim.ab_test("link_color", "blue", "red")).to be("red")
+        end
+      end
+    end
   end
 end

data/spec/experiment_spec.rb

@@ -576,6 +576,17 @@ describe Split::Experiment do
       expect(p_goal1).not_to be_within(0.04).of(p_goal2)
     end
 
+    it "should not calculate when data is not valid for beta distribution" do
+      experiment = Split::ExperimentCatalog.find_or_create("scientists", "einstein", "bohr")
+
+      experiment.alternatives.each do |alternative|
+        alternative.participant_count = 9
+        alternative.set_completed_count(10)
+      end
+
+      expect { experiment.calc_winning_alternatives }.to_not raise_error
+    end
+
     it "should return nil and not re-calculate probabilities if they have already been calculated today" do
       experiment = Split::ExperimentCatalog.find_or_create({ "link_color3" => ["purchase", "refund"] }, "blue", "red", "green")
       expect(experiment.calc_winning_alternatives).not_to be nil

data/spec/helper_spec.rb

@@ -558,6 +558,42 @@ describe Split::Helper do
     end
   end
 
+
+  describe "ab_record_extra_info" do
+    context "for an experiment that the user participates in" do
+      before(:each) do
+        @experiment_name = "link_color"
+        @alternatives = ["blue", "red"]
+        @experiment = Split::ExperimentCatalog.find_or_create(@experiment_name, *@alternatives)
+        @alternative_name = ab_test(@experiment_name, *@alternatives)
+      end
+
+      it "records extra data for a given experiment" do
+        alternative = Split::Alternative.new(@alternative_name, "link_color")
+
+        ab_record_extra_info(@experiment_name, "some_data", 10)
+
+        expect(alternative.extra_info).to eql({ "some_data" => 10 })
+      end
+
+      it "records extra data for a given experiment" do
+        alternative = Split::Alternative.new(@alternative_name, "link_color")
+
+        ab_record_extra_info(@experiment_name, "some_data")
+
+        expect(alternative.extra_info).to eql({ "some_data" => 1 })
+      end
+
+      it "records extra data for a given experiment" do
+        alternative = Split::Alternative.new(@alternative_name, "link_color")
+
+        ab_record_extra_info(@experiment_name, "some_data", nil)
+
+        expect(alternative.extra_info).to eql({})
+      end
+    end
+  end
+
   describe "conversions" do
     it "should return a conversion rate for an alternative" do
       alternative_name = ab_test("link_color", "blue", "red")

data/spec/persistence/cookie_adapter_spec.rb

@@ -67,14 +67,14 @@ describe Split::Persistence::CookieAdapter do
     it "puts multiple experiments in a single cookie" do
       subject["foo"] = "FOO"
       subject["bar"] = "BAR"
-      expect(context.response.headers["Set-Cookie"]).to match(/\Asplit=%7B%22foo%22%3A%22FOO%22%2C%22bar%22%3A%22BAR%22%7D; path=\/; expires=[a-zA-Z]{3}, \d{2} [a-zA-Z]{3} \d{4} \d{2}:\d{2}:\d{2} [A-Z]{3}\Z/)
+      expect(Array(context.response.headers["Set-Cookie"])).to include(/\Asplit=%7B%22foo%22%3A%22FOO%22%2C%22bar%22%3A%22BAR%22%7D; path=\/; expires=[a-zA-Z]{3}, \d{2} [a-zA-Z]{3} \d{4} \d{2}:\d{2}:\d{2} [A-Z]{3}\Z/)
     end
 
     it "ensure other added cookies are not overriden" do
       context.response.set_cookie "dummy", "wow"
       subject["foo"] = "FOO"
-      expect(context.response.headers["Set-Cookie"]).to include("dummy=wow")
-      expect(context.response.headers["Set-Cookie"]).to include("split=")
+      expect(Array(context.response.headers["Set-Cookie"])).to include(/dummy=wow/)
+      expect(Array(context.response.headers["Set-Cookie"])).to include(/split=/)
     end
   end
 

data/spec/persistence/redis_adapter_spec.rb

@@ -73,9 +73,9 @@ describe Split::Persistence::RedisAdapter do
     before { Split::Persistence::RedisAdapter.with_config(lookup_by: "lookup") }
 
     describe "#[] and #[]=" do
-      it "should set and return the value for given key" do
-        subject["my_key"] = "my_value"
-        expect(subject["my_key"]).to eq("my_value")
+      it "should convert to string, set and return the value for given key" do
+        subject["my_key"] = true
+        expect(subject["my_key"]).to eq("true")
       end
     end
 

data/spec/redis_interface_spec.rb

@@ -40,5 +40,15 @@ describe Split::RedisInterface do
       add_to_set
       expect(Split.redis.sismember(set_name, "something")).to be true
     end
+
+    context "when a Redis version is used that supports the 'sadd?' method" do
+      before { expect(Split.redis).to receive(:respond_to?).with(:sadd?).and_return(true) }
+
+      it "will use this method instead of 'sadd'" do
+        expect(Split.redis).to receive(:sadd?).with(set_name, "something")
+        expect(Split.redis).not_to receive(:sadd).with(set_name, "something")
+        add_to_set
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -11,6 +11,7 @@ SimpleCov.start
 require "split"
 require "ostruct"
 require "yaml"
+require "pry"
 
 Dir["./spec/support/*.rb"].each { |f| require f }
 
@@ -43,11 +44,20 @@ def params
   @params ||= {}
 end
 
-def request(ua = "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_6; de-de) AppleWebKit/533.20.25 (KHTML, like Gecko) Version/5.0.4 Safari/533.20.27")
-  @request ||= begin
-    r = OpenStruct.new
-    r.user_agent = ua
-    r.ip = "192.168.1.1"
-    r
-  end
+def request
+  @request ||= build_request
+end
+
+def build_request(
+  ua: "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_6; de-de) AppleWebKit/533.20.25 (KHTML, like Gecko) Version/5.0.4 Safari/533.20.27",
+  ip: "192.168.1.1",
+  params: {},
+  cookies: {}
+)
+  r = OpenStruct.new
+  r.user_agent = ua
+  r.ip = ip
+  r.params = params
+  r.cookies = cookies
+  r
 end

data/split.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
   s.add_dependency "redis",           ">= 4.2"
   s.add_dependency "sinatra",         ">= 1.2.6"
   s.add_dependency "rubystats",       ">= 0.3.0"
+  s.add_dependency "matrix"
 
   s.add_development_dependency "bundler",     ">= 1.17"
   s.add_development_dependency "simplecov",   "~> 0.15"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: split
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.0.4
 platform: ruby
 authors:
 - Andrew Nesbitt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-02 00:00:00.000000000 Z
+date: 2024-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: matrix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -275,7 +289,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Rack based split testing framework