verdict 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef6e75a9737694176e2d31ed58fe999222189c2f86a30099fd34a2892756b570
-  data.tar.gz: 5010e420ef5cc2bfd79223ba1ef91526fe429d8040272cc2eaa0cf072a05246e
+  metadata.gz: 23482b6ebd56ecd7bdb03d318c4a507e8d9ca6b3a70ace6c63a52349855f1666
+  data.tar.gz: fe4b75a65e3daca4c40cfead80d1c9ff266e40faa4af99b912c8f5116b7f5cae
 SHA512:
-  metadata.gz: a4389fc051d535c43bd81198023ab8dc38c26eca9805f751f235b3dc08fddcb9d123c70c513751b118c24470303448577047802f86b23f81e18a926218231b8c
-  data.tar.gz: 1b478420092e7fd734e14d11f28a7bfcca6c019a56d8eb4d193b331993a7596e770a25ca0f63e82a648292ca331feffcc18523bbe3799d1db077a98bc1ddbc6d
+  metadata.gz: a403a445b44731fccaddb181fcda9acbd2b138adad07fadde5d8c3b0f97fd97c02a3873256672b1dc2d6756b7471b6575345b9e525efee27c8c25c7d89d3bf3c
+  data.tar.gz: 3d52f3c2517c91a132c327ba57a695f008f611b82ff17d6bee86cd23628102c4b6d9f70ad62768929eb986d46ce566c215c6f676e4c0883029c24d422ad32c7d

data/CHANGELOG.md

@@ -1,5 +1,11 @@
+## v0.10.0
+
+* Add `Experiment#cleanup` to remove stored redis hashes.
+* Fix typo in `Experiment#fetch_subject` error message.
+
 ## v0.9.0
 **This version has breaking changes**
+
 * Eagerly load experiment definitions when booting Rails, so that multi-threaded applications do not face a race-condition when populating experiments.
 * Fixes deprecated `assert_equal` tests that return nil.
 

data/lib/verdict/experiment.rb

@@ -162,6 +162,10 @@ class Verdict::Experiment
     assignment
   end
 
+  def cleanup
+    @storage.cleanup(handle.to_s)
+  end
+
   def remove_subject_assignment(subject)
     @storage.remove_assignment(self, subject)
   end
@@ -207,7 +211,7 @@ class Verdict::Experiment
   end
 
   def fetch_subject(subject_identifier)
-    raise NotImplementedError, "Fetching subjects based in identifier is not implemented for experiment @{handle.inspect}."
+    raise NotImplementedError, "Fetching subjects based on identifier is not implemented for experiment #{@handle.inspect}."
   end
 
   def disqualify_empty_identifier?

data/lib/verdict/storage/base_storage.rb

@@ -45,6 +45,10 @@ module Verdict
         set(experiment.handle.to_s, 'started_at', timestamp.utc.strftime('%FT%TZ'))
       end
 
+      def cleanup(_scope)
+        raise NotImplementedError
+      end
+
       protected
       # Retrieves a key in a given scope from storage.
       # - The scope and key are both provided as string.

data/lib/verdict/storage/redis_storage.rb

@@ -1,6 +1,8 @@
 module Verdict
   module Storage
     class RedisStorage < BaseStorage
+      PAGE_SIZE = 50
+
       attr_accessor :redis, :key_prefix
 
       def initialize(redis = nil, options = {})
@@ -9,28 +11,43 @@ module Verdict
       end
 
       def get(scope, key)
-        redis.hget("#{@key_prefix}#{scope}", key)
+        redis.hget(scope_key(scope), key)
       rescue ::Redis::BaseError => e
         raise Verdict::StorageError, "Redis error: #{e.message}"
       end
 
       def set(scope, key, value)
-        redis.hset("#{@key_prefix}#{scope}", key, value)
+        redis.hset(scope_key(scope), key, value)
       rescue ::Redis::BaseError => e
         raise Verdict::StorageError, "Redis error: #{e.message}"
       end
 
       def remove(scope, key)
-        redis.hdel("#{@key_prefix}#{scope}", key)
+        redis.hdel(scope_key(scope), key)
+      rescue ::Redis::BaseError => e
+        raise Verdict::StorageError, "Redis error: #{e.message}"
+      end
+
+      def cleanup(scope)
+        clear(scope)
+        redis.del(scope_key(scope))
       rescue ::Redis::BaseError => e
         raise Verdict::StorageError, "Redis error: #{e.message}"
       end
 
       private
 
-      def generate_scope_key(scope)
+      def scope_key(scope)
         "#{@key_prefix}#{scope}"
       end
+
+      def clear(scope, cursor: 0)
+        cursor, results = redis.hscan(scope_key(scope), cursor, count: PAGE_SIZE)
+        results.map(&:first).each do |key|
+          remove(scope, key)
+        end
+        clear(scope, cursor: cursor) unless cursor.to_i.zero?
+      end
     end
   end
 end

data/lib/verdict/version.rb

@@ -1,3 +1,3 @@
 module Verdict
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

data/test/experiment_test.rb

@@ -422,4 +422,32 @@ class ExperimentTest < Minitest::Test
 
     assert_kind_of Verdict::Storage::MockStorage, e.storage
   end
+
+  def test_cleanup
+    redis = ::Redis.new(host: REDIS_HOST, port: REDIS_PORT)
+    storage = Verdict::Storage::RedisStorage.new(redis)
+    experiment = Verdict::Experiment.new(:cleanup_test) do
+      groups { group :all, 100 }
+      storage storage, store_unqualified: true
+    end
+
+    experiment.assign("something")
+    assert_operator redis, :exists, "experiments/cleanup_test"
+
+    experiment.cleanup
+    refute_operator redis, :exists, "experiments/cleanup_test"
+  ensure
+    redis.del("experiments/cleanup_test")
+  end
+
+  def test_cleanup_without_redis
+    experiment = Verdict::Experiment.new(:cleanup_test) do
+      groups { group :all, 100 }
+    end
+
+    assert_raises(NotImplementedError) do
+      experiment.assign("something")
+      experiment.cleanup
+    end
+  end
 end

data/test/storage/redis_storage_test.rb

@@ -16,10 +16,6 @@ class RedisStorageTest < Minitest::Test
     @redis.del('experiments/redis_storage')
   end
 
-  def experiment_key
-    'experiments/redis_storage'
-  end
-
   def test_store_and_retrieve_qualified_assignment
     refute @redis.hexists(experiment_key, 'assignment_subject_1')
 
@@ -74,4 +70,21 @@ class RedisStorageTest < Minitest::Test
     assert @redis.hexists(experiment_key, "started_at")
     assert_equal a, @experiment.started_at
   end
+
+  def test_cleanup
+    1000.times do |n|
+      @experiment.assign("something_#{n}")
+    end
+
+    assert_operator @redis, :exists, experiment_key
+
+    @storage.cleanup(:redis_storage)
+    refute_operator @redis, :exists, experiment_key
+  end
+
+  private
+
+  def experiment_key
+    "experiments/redis_storage"
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: verdict
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-05 00:00:00.000000000 Z
+date: 2019-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -172,8 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A library to centrally define experiments for your application, and collect