verdict 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e98209c988365064ac1570a47b2dc5c0b0663f673ec62cb8d2640bdf38c9f3d
-  data.tar.gz: 1111714a3fbfffc8ee878c49db5dbaacc5e0c8d6c53f8425dfe69cfdcde96e38
+  metadata.gz: 7e99d3cb09e2dbfb3cafeb6f05171978721cd5a79fd4570f8b6bd6c6e4975e17
+  data.tar.gz: 4a885cb9d8a991046e3a22e428a35982bf7565b03aaa49fa0da0b9963e34bc56
 SHA512:
-  metadata.gz: 71b77a462635384229bcce809954d15fac8e75fe3d307172eb1f31a5950e92e36f0a51c686c0cdb22d89fafcb0c5d6e10ba9a51b708580ac28e7ab480698fde7
-  data.tar.gz: 48b4b96643a1235479061ceec0954700a7997105f37b03b51833dff7becd5f6db11582f177df81fcc79c56ed5a6b9b2ecd038a33c2e2233f74f69185cbe49a7a
+  metadata.gz: 89c2d20c1892c630942099ac0b0ea1d3db012a6aaa9031a7bbf8d834fad295adfaf4cc0194d09930608c4416bbeb8efba89852446e02b091c237d851d8266704
+  data.tar.gz: cdb0271d66903d1f39316c2665c68bf8deae733c105e3aecc8bb665adaef4981129bb0f7cce6baf001eb7f246af50e40d85115bf3105525a44b2111fb2c41fbc

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## v0.12.0
+
+* Allow options to be passed to `Experiment#cleanup` so they can be forwarded to storage.
+
+* Changed `Experiment#cleanup` to accept an argument of type `Verdict::Experiment`.       
+  Passing a `String`/`Symbol` argument is still supported, but will log a deprecation warning.
+
 ## v0.11.0
 
 * Automatic eager loading when inside a Rails app.

data/lib/verdict.rb

@@ -58,3 +58,4 @@ require "verdict/event_logger"
 
 Verdict.default_logger ||= Logger.new("/dev/null")
 Verdict.directory = nil
+Verdict.clear_repository_cache

data/lib/verdict/experiment.rb

@@ -2,7 +2,7 @@ class Verdict::Experiment
 
   include Verdict::Metadata
 
-  attr_reader :handle, :qualifiers, :storage, :event_logger
+  attr_reader :handle, :qualifiers, :event_logger
 
   def self.define(handle, *args, &block)
     experiment = self.new(handle, *args, &block)
@@ -11,6 +11,7 @@ class Verdict::Experiment
   end
 
   def initialize(handle, options = {}, &block)
+    @started_at = nil
     @handle = handle.to_s
 
     options = default_options.merge(options)
@@ -88,7 +89,7 @@ class Verdict::Experiment
 
   def started_at
     @started_at ||= @storage.retrieve_start_timestamp(self)
-  rescue Verdict::StorageError => e
+  rescue Verdict::StorageError
     nil
   end
 
@@ -162,8 +163,8 @@ class Verdict::Experiment
     assignment
   end
 
-  def cleanup
-    @storage.cleanup(handle.to_s)
+  def cleanup(options = {})
+    @storage.cleanup(self, options)
   end
 
   def remove_subject_assignment(subject)
@@ -193,15 +194,13 @@ class Verdict::Experiment
   end
 
   def as_json(options = {})
-    data = {
+    {
       handle: handle,
       has_qualifier: has_qualifier?,
-      groups: segmenter.groups.values.map { |g| g.as_json(options) },
+      groups: segmenter.groups.values.map { |group| group.as_json(options) },
       metadata: metadata,
       started_at: started_at.nil? ? nil : started_at.utc.strftime('%FT%TZ')
-    }
-
-    data.tap do |data|
+    }.tap do |data|
       data[:subject_type] = subject_type.to_s unless subject_type.nil?
     end
   end

data/lib/verdict/storage/base_storage.rb

@@ -45,11 +45,21 @@ module Verdict
         set(experiment.handle.to_s, 'started_at', timestamp.utc.strftime('%FT%TZ'))
       end
 
-      def cleanup(_scope)
-        raise NotImplementedError
+      # Deletes all assignments (and any other stored data) for the given experiment
+      def cleanup(experiment_or_scope, options = {})
+        if experiment_or_scope.is_a?(Symbol) || experiment_or_scope.is_a?(String)
+          Verdict.default_logger.warn(
+            "Passing a scope string/symbol to #{self.class}#cleanup is deprecated, " \
+            'pass a Verdict::Experiment instance instead.'
+          )
+          clear(experiment_or_scope, options)
+        else
+          clear(experiment_or_scope.handle.to_s, options)
+        end
       end
 
       protected
+
       # Retrieves a key in a given scope from storage.
       # - The scope and key are both provided as string.
       # - Should return a string value if the key is found in the scope, nil otherwise.
@@ -58,7 +68,7 @@ module Verdict
         raise NotImplementedError
       end
 
-      # Retrieves a key in a given scope from storage.
+      # Sets the value of a key in a given scope from storage.
       # - The scope, key, and value are all provided as string.
       # - Should return true if the item was successfully stored.
       # - Should raise Verdict::StorageError if anything goes wrong.
@@ -66,13 +76,21 @@ module Verdict
         raise NotImplementedError
       end
 
-      # Retrieves a key in a given scope from storage.
+      # Removes a key in a given scope from storage.
       # - The scope and key are both provided as string.
       # - Should return true if the item was successfully removed from storage.
       # - Should raise Verdict::StorageError if anything goes wrong.
       def remove(scope, key)
         raise NotImplementedError
       end
+
+      # Removes all keys in a given scope from storage.
+      # - The scope is provided as string.
+      # - Should return true if all items were successfully removed from storage.
+      # - Should raise Verdict::StorageError if anything goes wrong.
+      def clear(scope, options)
+        raise NotImplementedError
+      end
     end
   end
 end

data/lib/verdict/storage/memory_storage.rb

@@ -7,6 +7,8 @@ module Verdict
         @storage = {}
       end
 
+      protected
+
       def get(scope, key)
         @storage[scope] ||= {}
         @storage[scope][key]

data/lib/verdict/storage/mock_storage.rb

@@ -1,14 +1,16 @@
 module Verdict
   module Storage
     class MockStorage < BaseStorage
-      def set(scope, key, value)
-        false
-      end
+      protected
 
       def get(scope, key)
         nil
       end
 
+      def set(scope, key, value)
+        false
+      end
+
       def remove(scope, key)
       end
     end

data/lib/verdict/storage/redis_storage.rb

@@ -10,6 +10,8 @@ module Verdict
         @key_prefix = options[:key_prefix] || 'experiments/'
       end
 
+      protected
+
       def get(scope, key)
         redis.hget(scope_key(scope), key)
       rescue ::Redis::BaseError => e
@@ -28,8 +30,8 @@ module Verdict
         raise Verdict::StorageError, "Redis error: #{e.message}"
       end
 
-      def cleanup(scope)
-        clear(scope)
+      def clear(scope, options)
+        scrub(scope)
         redis.del(scope_key(scope))
       rescue ::Redis::BaseError => e
         raise Verdict::StorageError, "Redis error: #{e.message}"
@@ -41,12 +43,12 @@ module Verdict
         "#{@key_prefix}#{scope}"
       end
 
-      def clear(scope, cursor: 0)
+      def scrub(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?
+        scrub(scope, cursor: cursor) unless cursor.to_i.zero?
       end
     end
   end

data/lib/verdict/version.rb

@@ -1,3 +1,3 @@
 module Verdict
-  VERSION = "0.11.0"
+  VERSION = "0.12.0"
 end

data/test/experiment_test.rb

@@ -424,7 +424,6 @@ class ExperimentTest < Minitest::Test
   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 }
@@ -440,6 +439,16 @@ class ExperimentTest < Minitest::Test
     redis.del("experiments/cleanup_test")
   end
 
+  def test_cleanup_options
+    experiment = Verdict::Experiment.new(:cleanup_test) do
+      groups { group :all, 100 }
+    end
+
+    experiment.storage.expects(:clear).with(experiment.handle, some: :thing)
+    experiment.assign("something")
+    experiment.cleanup(some: :thing)
+  end
+
   def test_cleanup_without_redis
     experiment = Verdict::Experiment.new(:cleanup_test) do
       groups { group :all, 100 }
@@ -450,4 +459,10 @@ class ExperimentTest < Minitest::Test
       experiment.cleanup
     end
   end
+
+  private
+
+  def redis
+    @redis ||= ::Redis.new(host: REDIS_HOST, port: REDIS_PORT)
+  end
 end

data/test/experiments_repository_test.rb

@@ -28,5 +28,6 @@ class ExperimentTest < Minitest::Test
     json = JSON.parse(Verdict.repository.to_json)
     assert_equal ['test_1', 'test_2'], json.keys
     assert_equal json['test_1'], JSON.parse(e1.to_json)
+    assert_equal json['test_2'], JSON.parse(e2.to_json)
   end
 end

data/test/fake_app.rb

@@ -1,4 +1,4 @@
-require 'rails'
+require "rails"
 require "active_model/railtie"
 require "action_controller/railtie"
 require "action_view/railtie"

data/test/storage/memory_storage_test.rb

@@ -35,9 +35,9 @@ class MemoryStorageTest < Minitest::Test
   end
 
   def test_started_at
-    assert @storage.get(@experiment.handle.to_s, 'started_at').nil?
+    assert @storage.send(:get, @experiment.handle.to_s, 'started_at').nil?
     @experiment.send(:ensure_experiment_has_started)
-    refute @storage.get(@experiment.handle.to_s, 'started_at').nil?
+    refute @storage.send(:get, @experiment.handle.to_s, 'started_at').nil?
     assert_instance_of Time, @experiment.started_at
   end
 end

data/test/storage/redis_storage_test.rb

@@ -71,17 +71,29 @@ class RedisStorageTest < Minitest::Test
     assert_equal a, @experiment.started_at
   end
 
-  def test_cleanup
+  def test_cleanup_with_scope_argument
     1000.times do |n|
       @experiment.assign("something_#{n}")
     end
 
     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
   end
 
+  def test_cleanup
+    1000.times do |n|
+      @experiment.assign("something_#{n}")
+    end
+
+    assert_operator @redis, :exists, experiment_key
+
+    @storage.cleanup(@experiment)
+    refute_operator @redis, :exists, experiment_key
+  end
+
   private
 
   def experiment_key

data/test/verdict_rails_test.rb

@@ -5,9 +5,16 @@ class VerdictRailsTest < Minitest::Test
   def setup
     Verdict.clear_repository_cache
     new_rails_app = Dummy::Application.new
+    new_rails_app.config.eager_load = false
     new_rails_app.initialize!
   end
 
+  def teardown
+    Verdict.default_logger = Logger.new("/dev/null")
+    Verdict.directory = nil
+    Verdict.clear_repository_cache
+  end
+
   def test_verdict_railtie_should_find_directory_path
     assert_equal Verdict.directory, Rails.root.join('app', 'experiments')
   end
@@ -16,4 +23,4 @@ class VerdictRailsTest < Minitest::Test
     expected_experiment = Verdict.instance_variable_get('@repository')
     assert expected_experiment.include?("test_rails_app_experiment")
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: verdict
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-03 00:00:00.000000000 Z
+date: 2019-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest