verdict 0.15.2 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50c44fd8fcc0cf5605c9d21fd5eefcd4dddeffeb03c48e7ec046639d7154715b
-  data.tar.gz: d55759fff1145aa793f9ae42232518130ba93efcb5fb62a2f7cbfa24d0322a0f
+  metadata.gz: c8ad702f655cca4734df9f1019f7df665cbe04914468bdcb07ae2a5e9fcc27ca
+  data.tar.gz: f31057b426bb631a36d99bc9a6f1588078b0009909ad25c2f5daa2180a407d66
 SHA512:
-  metadata.gz: 8ed63a2aaf52ebffe454da41e3022e87df834b80130cb0ab14902466ea6d630ce9d046e1b202e32fc6491a2dc9974f4f825f50aaa14aa862103888f31d5c3df6
-  data.tar.gz: 12c379615c6593caf46749157ebca884d91fb17a97d81b7fc60c53cd3531785a0a0c078e79e4b387cd21676f26d55962e0a2ab1ba0caeacb5d99208c3f1e8f8d
+  metadata.gz: 1ac4f9f4cef8e978fc36ea7848cee6b4ab15cb895d57598388f4b42997f141189a51c511f4a4b877f254b8a0d32909a153aa00da8b7e42940dbaed6d7ec9e4ec
+  data.tar.gz: f03f49ca42347dc3bf54c0ab449df49df32e6b5fc175392e3259b4e238324de03406f64d38a17e8744f662ec9543319a41bebec0df12031f9f0ab03bb05253c2

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## v0.16.0
+* Allow configuring the `RedisStorage` with a [`ConnectionPool`](https://github.com/mperham/connection_pool) instead of a raw `Redis` connection.
+
 ## v0.15.2
 * Fix edge case where inheriting from `Verdict::Experiment` and overriding `subject_qualifies?` resulted in an error.
 

data/lib/verdict/storage/redis_storage.rb

@@ -6,33 +6,56 @@ module Verdict
       attr_accessor :redis, :key_prefix
 
       def initialize(redis = nil, options = {})
-        @redis = redis
+        if !redis.nil? && !redis.respond_to?(:with)
+          @redis = ConnectionPoolLike.new(redis)
+        else
+          @redis = redis
+        end
+
         @key_prefix = options[:key_prefix] || 'experiments/'
       end
 
       protected
 
+      class ConnectionPoolLike
+        def initialize(redis)
+          @redis = redis
+        end
+
+        def with
+          yield @redis
+        end
+      end
+
       def get(scope, key)
-        redis.hget(scope_key(scope), key)
+        redis.with do |conn|
+          conn.hget(scope_key(scope), key)
+        end
       rescue ::Redis::BaseError => e
         raise Verdict::StorageError, "Redis error: #{e.message}"
       end
 
       def set(scope, key, value)
-        redis.hset(scope_key(scope), key, value)
+        redis.with do |conn|
+          conn.hset(scope_key(scope), key, value)
+        end
       rescue ::Redis::BaseError => e
         raise Verdict::StorageError, "Redis error: #{e.message}"
       end
 
       def remove(scope, key)
-        redis.hdel(scope_key(scope), key)
+        redis.with do |conn|
+          conn.hdel(scope_key(scope), key)
+        end
       rescue ::Redis::BaseError => e
         raise Verdict::StorageError, "Redis error: #{e.message}"
       end
 
       def clear(scope, options)
         scrub(scope)
-        redis.del(scope_key(scope))
+        redis.with do |conn|
+          conn.del(scope_key(scope))
+        end
       rescue ::Redis::BaseError => e
         raise Verdict::StorageError, "Redis error: #{e.message}"
       end
@@ -44,10 +67,14 @@ module Verdict
       end
 
       def scrub(scope, cursor: 0)
-        cursor, results = redis.hscan(scope_key(scope), cursor, count: PAGE_SIZE)
+        cursor, results = redis.with do |conn|
+          conn.hscan(scope_key(scope), cursor, count: PAGE_SIZE)
+        end
+
         results.map(&:first).each do |key|
           remove(scope, key)
         end
+
         scrub(scope, cursor: cursor) unless cursor.to_i.zero?
       end
     end

data/lib/verdict/version.rb

@@ -1,3 +1,3 @@
 module Verdict
-  VERSION = "0.15.2"
+  VERSION = "0.16.0"
 end

data/test/storage/redis_storage_test.rb

@@ -1,97 +1,75 @@
 require 'test_helper'
 
-class RedisStorageTest < Minitest::Test
 
-  def setup
-    @redis = ::Redis.new(host: REDIS_HOST, port: REDIS_PORT)
-    @storage = storage = Verdict::Storage::RedisStorage.new(@redis)
-    @experiment = Verdict::Experiment.new(:redis_storage) do
-      qualify { |s| s == 'subject_1' }
-      groups { group :all, 100 }
-      storage storage, store_unqualified: true
-    end
-  end
-
-  def teardown
-    @redis.del('experiments/redis_storage')
-  end
+module SharedRedisStorageTests
+  attr_reader :redis, :experiment, :storage
 
   def test_store_and_retrieve_qualified_assignment
-    refute @redis.hexists(experiment_key, 'assignment_subject_1')
+    refute redis.hexists(experiment_key, 'assignment_subject_1')
 
-    new_assignment = @experiment.assign('subject_1')
+    new_assignment = experiment.assign('subject_1')
     assert new_assignment.qualified?
     refute new_assignment.returning?
 
-    assert @redis.hexists(experiment_key, 'assignment_subject_1')
+    assert redis.hexists(experiment_key, 'assignment_subject_1')
 
-    returning_assignment = @experiment.assign('subject_1')
+    returning_assignment = experiment.assign('subject_1')
     assert returning_assignment.returning?
     assert_equal new_assignment.experiment, returning_assignment.experiment
     assert_equal new_assignment.group, returning_assignment.group
   end
 
   def test_store_and_retrieve_unqualified_assignment
-    refute @redis.hexists(experiment_key, 'assignment_subject_2')
+    refute redis.hexists(experiment_key, 'assignment_subject_2')
 
-    new_assignment = @experiment.assign('subject_2')
+    new_assignment = experiment.assign('subject_2')
 
     refute new_assignment.returning?
     refute new_assignment.qualified?
-    assert @redis.hexists(experiment_key, 'assignment_subject_2')
+    assert redis.hexists(experiment_key, 'assignment_subject_2')
 
-    returning_assignment = @experiment.assign('subject_2')
+    returning_assignment = experiment.assign('subject_2')
     assert returning_assignment.returning?
     assert_equal new_assignment.experiment, returning_assignment.experiment
     assert_nil new_assignment.group
     assert_nil returning_assignment.group
   end
 
-  def test_assign_should_return_unqualified_when_redis_is_unavailable_for_reads
-    @redis.stubs(:hget).raises(::Redis::BaseError, "Redis is down")
-    assert !@experiment.assign('subject_1').qualified?
-  end
-
-  def test_assign_should_return_unqualified_when_redis_is_unavailable_for_writes
-    @redis.stubs(:hset).raises(::Redis::BaseError, "Redis is down")
-    assert !@experiment.assign('subject_1').qualified?
-  end
-
   def test_remove_subject_assignment
-    @experiment.assign('subject_3')
-    assert @redis.hexists(experiment_key, 'assignment_subject_3')
-    @experiment.remove_subject_assignment('subject_3')
-    refute @redis.hexists(experiment_key, 'assignment_subject_3')
+    experiment.assign('subject_3')
+    assert redis.hexists(experiment_key, 'assignment_subject_3')
+    experiment.remove_subject_assignment('subject_3')
+    refute redis.hexists(experiment_key, 'assignment_subject_3')
   end
 
   def test_started_at
-    refute @redis.hexists(experiment_key, "started_at")
-    a = @experiment.send(:ensure_experiment_has_started)
-    assert @redis.hexists(experiment_key, "started_at")
-    assert_equal a, @experiment.started_at
+    refute redis.hexists(experiment_key, "started_at")
+    a = experiment.send(:ensure_experiment_has_started)
+    assert redis.hexists(experiment_key, "started_at")
+    assert_equal a, experiment.started_at
   end
 
   def test_cleanup_with_scope_argument
     1000.times do |n|
-      @experiment.assign("something_#{n}")
+      experiment.assign("something_#{n}")
     end
 
-    assert_operator @redis, :exists, experiment_key
+    assert_operator redis, :exists, experiment_key
 
     Verdict.default_logger.expects(:warn).with(regexp_matches(/deprecated/))
-    @storage.cleanup(:redis_storage)
-    refute_operator @redis, :exists, experiment_key
+    storage.cleanup(:redis_storage)
+    refute_operator redis, :exists, experiment_key
   end
 
   def test_cleanup
     1000.times do |n|
-      @experiment.assign("something_#{n}")
+      experiment.assign("something_#{n}")
     end
 
-    assert_operator @redis, :exists, experiment_key
+    assert_operator redis, :exists, experiment_key
 
-    @storage.cleanup(@experiment)
-    refute_operator @redis, :exists, experiment_key
+    storage.cleanup(experiment)
+    refute_operator redis, :exists, experiment_key
   end
 
   private
@@ -100,3 +78,67 @@ class RedisStorageTest < Minitest::Test
     "experiments/redis_storage"
   end
 end
+
+class RedisStorageTest < Minitest::Test
+  include SharedRedisStorageTests
+
+  def setup
+    @redis = ::Redis.new(host: REDIS_HOST, port: REDIS_PORT)
+    @storage = storage = Verdict::Storage::RedisStorage.new(@redis)
+    @experiment = Verdict::Experiment.new(:redis_storage) do
+      qualify { |s| s == 'subject_1' }
+      groups { group :all, 100 }
+      storage storage, store_unqualified: true
+    end
+  end
+
+  def teardown
+    @redis.del('experiments/redis_storage')
+  end
+
+  def test_assign_should_return_unqualified_when_redis_is_unavailable_for_reads
+    redis.stubs(:hget).raises(::Redis::BaseError, "Redis is down")
+    assert !experiment.assign('subject_1').qualified?
+  end
+
+  def test_assign_should_return_unqualified_when_redis_is_unavailable_for_writes
+    redis.stubs(:hset).raises(::Redis::BaseError, "Redis is down")
+    assert !experiment.assign('subject_1').qualified?
+  end
+end
+
+class RedisStorageConnectionPoolTest < Minitest::Test
+  include SharedRedisStorageTests
+
+  def setup
+    @redis = ::Redis.new(host: REDIS_HOST, port: REDIS_PORT)
+    @redis_pool = ::ConnectionPool.new(size: 3) do
+      ::Redis.new(host: REDIS_HOST, port: REDIS_PORT)
+    end
+    @storage = storage = Verdict::Storage::RedisStorage.new(@redis_pool)
+    @experiment = Verdict::Experiment.new(:redis_storage) do
+      qualify { |s| s == 'subject_1' }
+      groups { group :all, 100 }
+      storage storage, store_unqualified: true
+    end
+  end
+
+  def teardown
+    @redis.del('experiments/redis_storage')
+  end
+
+  def test_assign_should_return_unqualified_when_redis_is_unavailable_for_writes
+    redis_mock = stub
+    redis_mock.stubs(:hget).returns(nil)
+    redis_mock.stubs(:hset).raises(::Redis::BaseError, "Redis is down")
+    @redis_pool.stubs(:with).yields(redis_mock)
+    assert !@experiment.assign('subject_1').qualified?
+  end
+
+  def test_remove_subject_assignment
+    @experiment.assign('subject_3')
+    assert @redis.hexists(experiment_key, 'assignment_subject_3')
+    @experiment.remove_subject_assignment('subject_3')
+    refute @redis.hexists(experiment_key, 'assignment_subject_3')
+  end
+end

data/test/test_helper.rb

@@ -13,6 +13,7 @@ require "mocha/setup"
 require "timecop"
 require "verdict"
 require "redis"
+require "connection_pool"
 
 REDIS_HOST = ENV['REDIS_HOST'].nil? ? '127.0.0.1' : ENV['REDIS_HOST']
 REDIS_PORT = (ENV['REDIS_PORT'].nil? ? '6379' : ENV['REDIS_PORT']).to_i

data/verdict.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency("timecop")
   gem.add_development_dependency("redis")
   gem.add_development_dependency("rails")
+  gem.add_development_dependency("connection_pool")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: verdict
 version: !ruby/object:Gem::Version
-  version: 0.15.2
+  version: 0.16.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2020-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Shopify Experiments classes
 email:
 - kevin.mcphillips@shopify.com