determinator 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d7789a1dadc2dd7a112279b38edf04c2c6c1e908dc70f28667f030653207e10
-  data.tar.gz: 8b25552108ae67607d973e16354f4606ff709c72a6b88d426e6b55e5348383f7
+  metadata.gz: 64d1088dbb10e6ed41b2d1b03f381eb97ad45ffeeb44d44cbb4cd86c16f37eab
+  data.tar.gz: 051e42e160577f2d18bbe400ef65316a72e7208aa04fb7afdb56593ff675d347
 SHA512:
-  metadata.gz: e0cb8a958af21db56878a78072b649f9e53ca27b688868255fab271bb6cfc99e20737df479bb08d4cdee89050c096843cd57a28eaf45bfaefd6113abcb25427f
-  data.tar.gz: 16d0337dbaf25238c0f095498df13df9d4ba37b0aa7319c108d5bc05d11e2d582adeadceef7ce7b2e04839ed38c32ac85f7e23118a8a74ad18cac0bf9065e350
+  metadata.gz: ad601db1e2572791c02d691407d7f70e8a7c089b80d81308cb3249b69f2d74e62821b0a3019115abca8468dd20de845005f3a65ef0a03718e3d8ef2497deb373
+  data.tar.gz: db770901187876e66202799c2672cb991e0856d26ff87ace117e2d33637421d4b6103833bec91ec1708c6376421727a27be20a0f116acfd9e94c9ab21fc8e309

data/.gitignore

@@ -7,4 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
-*.gem
+*.gem
+/.idea/

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# v2.3.0 (2019-09-06)
+
+Feature:
+- `RSpec::Determinator` can apply `app_version` constraints but no longer supports multiple `forced_determination` calls on the same feature. [See the PR for an in-depth write-up.](https://github.com/deliveroo/determinator/pull/63)
+
 # v2.2.1 (2019-07-29)
 
 Bug fix:

data/lib/determinator/control.rb

@@ -1,6 +1,7 @@
 require 'digest/md5'
 require 'determinator/actor_control'
 require 'semantic'
+require 'securerandom'
 
 module Determinator
   class Control

data/lib/determinator/retrieve/in_memory_retriever.rb

@@ -0,0 +1,27 @@
+module Determinator
+  module Retrieve
+
+    # An retriever that returns features that were previously stored
+    # in the retriever. Useful for testing.
+    class InMemoryRetriever
+      def initialize
+        @features = {}
+      end
+
+      # @param name [string,symbol] The name of the feature to retrieve
+      def retrieve(name)
+        @features[name.to_s]
+      end
+
+      # @param feature [Determinator::Feature] The feature to store
+      def store(feature)
+        @features[feature.name] = feature
+      end
+
+      def clear!
+        @features.clear
+      end
+    end
+
+  end
+end

data/lib/determinator/version.rb

@@ -1,3 +1,3 @@
 module Determinator
-  VERSION = '2.2.1'
+  VERSION = '2.3.0'
 end

data/lib/rspec/determinator.rb

@@ -1,13 +1,22 @@
 require 'determinator'
+require_relative '../determinator/retrieve/in_memory_retriever'
 
 module RSpec
   module Determinator
     def self.included(by)
       by.extend(DSL)
 
-      by.let(:fake_determinator) { FakeControl.new }
-      by.before do
-        allow(::Determinator).to receive(:instance).and_return(fake_determinator)
+      by.let(:fake_retriever) { ::Determinator::Retrieve::InMemoryRetriever.new }
+      by.let(:fake_determinator) { ::RSpec::Determinator::FakeDeterminator.new(fake_retriever) }
+      by.around do |example|
+        old_retriever = ::Determinator.instance.retrieval
+        begin
+          fake_retriever.clear!
+          ::Determinator.configure(retrieval: fake_retriever)
+          example.run
+        ensure
+          ::Determinator.configure(retrieval: old_retriever)
+        end
       end
     end
 
@@ -18,62 +27,59 @@ module RSpec
       # If `outcome` or `only_for` are Symbols then the example-scoped variable of that name will be referenced (ie. those
       # variables created by `let` declarations)
       #
-      # @params name [#to_s] The name of the Feature Flag or Experiment to mock
-      # @params outcome [Boolean,String,Symbol] The outcome which should be supplied. Will look up an example variable if a Symbol is given.
-      # @params :only_for [Hash,Symbol] The constraints that must be matched exactly in order for the determination to be applied.
-      def forced_determination(name, outcome, only_for: {})
+      # @param [String,Symbol] name The name of the Feature Flag or Experiment to mock
+      # @param [Boolean,String,Symbol] outcome The outcome which should be supplied. Will look up an example variable if a Symbol is given.
+      # @param [Hash,Symbol] :only_for The constraints that must be matched exactly in order for the determination to be applied.
+      def forced_determination(name, outcome, bucket_type: 'single', only_for: {})
         before do
           outcome = send(outcome) if outcome.is_a?(Symbol)
           only_for = send(only_for) if only_for.is_a?(Symbol)
 
-          fake_determinator.mock_result(
+          ::RSpec::Determinator::FakeDeterminator.new(fake_retriever).mock_result(
             name,
             outcome,
+            bucket_type: bucket_type,
             only_for: only_for
           )
         end
       end
-    end
-
-    class FakeControl
-      def initialize
-        @mocked_results = Hash.new { |h, k| h[k] = {} }
-      end
 
-      def for_actor(**args)
-        ::Determinator::ActorControl.new(self, **args)
-      end
-
-      def mock_result(name, result, only_for: {})
-        @mocked_results[name.to_s][normalize_properties(only_for)] = result
-      end
-
-      def fake_determinate(name, id: nil, guid: nil, properties: {})
-        properties[:id] = id if id
-        properties[:guid] = guid if guid
+    end
 
-        outcome_for_feature_given_properties(name.to_s, normalize_properties(properties))
+    class FakeDeterminator
+      def initialize(in_memory_retriever)
+        @retriever = in_memory_retriever
       end
-      alias_method :feature_flag_on?, :fake_determinate
-      alias_method :which_variant, :fake_determinate
-
-      private
 
-      def outcome_for_feature_given_properties(feature_name, requirements)
-        req_array = requirements.to_a
+      VALID_BUCKET_TYPES = %w{ id guid single }.freeze
 
-        keys_in_priority_order = @mocked_results[feature_name].keys.reverse
-        key = keys_in_priority_order.find do |given|
-          (given.to_a - req_array).empty?
+      def mock_result(name, outcome, bucket_type: 'single', only_for: {})
+        if !VALID_BUCKET_TYPES.include?(bucket_type)
+          raise ArgumentError.new("bad bucket type #{bucket_type}, expected one of: #{VALID_BUCKET_TYPES.join(' ')}")
         end
 
-        @mocked_results[feature_name][key] || false
-      end
+        active = !!outcome
+        variants = case outcome
+                   when true, false then
+                     []
+                   else
+                     { outcome => 1 }
+                   end
+        target_group = ::Determinator::TargetGroup.new(
+          rollout: 65_536,
+          constraints: only_for.map { |key, value| [key.to_s, Array(value).map(&:to_s)] }.to_h
+        )
 
-      def normalize_properties(properties)
-        properties.each_with_object({}) do |(key, value), hash|
-          hash[key.to_s] = [*value].map(&:to_s)
-        end
+        feature = ::Determinator::Feature.new(
+          name: name.to_s,
+          identifier: name.to_s,
+          bucket_type: bucket_type,
+          active: active,
+          variants: variants,
+          target_groups: [target_group]
+        )
+
+        @retriever.store(feature)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: determinator
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - JP Hastings-Spital
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-29 00:00:00.000000000 Z
+date: 2019-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -198,6 +198,7 @@ files:
 - lib/determinator/retrieve/dynaconf.rb
 - lib/determinator/retrieve/file.rb
 - lib/determinator/retrieve/http_retriever.rb
+- lib/determinator/retrieve/in_memory_retriever.rb
 - lib/determinator/retrieve/null_retriever.rb
 - lib/determinator/serializers/json.rb
 - lib/determinator/target_group.rb
@@ -222,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Determine which experiments and features a specific actor should see.