eight_ball 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7013714e1fab00bbf56af0703c7212800aa3d664ebf34f6f296353c9f5e2c42
-  data.tar.gz: d670e0a056df163ad933f1afa757fb80ba2640bd728349ec830103f40ef921a9
+  metadata.gz: f1ad76a62094723d7f3b5f7bc879100b75bd9170ff804201ebd8603188dd32db
+  data.tar.gz: 5c417107f3c8becefd977bde7ccffc46cba30bc814664ad7a6ad7d1bf8541e25
 SHA512:
-  metadata.gz: 2b86c9cd885352a5e60b6e1b699edfb476654eed89c21a1900f6220b45d2ce7bbd541062eab89599140de35c003770a8aacfe17f37180b56262321b4b1cb94f1
-  data.tar.gz: cd12202dda5daa1d284e501c9c4a3a5a214f5fd0dd6908aacc521e69e67713eb82494f62418141715b4cd8b953182a721dd705064baaf120a0a81319aee0a600
+  metadata.gz: f1921b19cd4786696d841ffd90a708dc9ac0d2f5ee6e61026fbf8727574d742dceae3c07d62ef50c92d3c585592b8a7f07574d3cd6c6c0a6a93c8c6734365056
+  data.tar.gz: c8724604fc631cd7573ffec63692471330bf712ce35345f19844e4d9af0fb4d98870103c2be354a38fcfc7344e1be105158ba772a164ea2428fa0de1033e19bc

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [3.5.0]
+
+- Fix `Feature#enabled?` so a direction's conditions are evaluated as the documented OR. `any_satisfied?` used `return` inside an `any?` block, which exits the method, so the first condition without a parameter became the whole verdict and later conditions were never consulted. A `never` ahead of a matching `list` evaluated to false in `enabledFor`, and a `never` ahead of a matching entry in `disabledFor` stopped that entry from disabling the feature.
+
+  Behaviour is unchanged for any direction holding a single condition, and for any direction whose parameterless condition is satisfied (an `always` still short-circuits the direction, so nothing after it is reached).
+
+  **Upgrade note.** The affected shape is a direction holding an UNSATISFIED parameterless condition (in practice a `never`) followed by a parameterized one. Those later conditions are now evaluated, which has two consequences. First, the verdict can change in either direction, and in both cases the later condition starts doing what it says: an `enabledFor` allow entry begins enabling (`false` to `true`), and a `disabledFor` deny entry begins disabling (`true` to `false`). Second, evaluation can now raise where it previously answered a boolean, because the later condition's parameter is required exactly as it would be if that condition stood alone: `ArgumentError, "Missing parameter ..."` when the bag lacks the key, and for a `range` whose bag value is the wrong type, `ArgumentError, "comparison of String with 1 failed"`. Treating an absent parameter as unsatisfied instead was rejected deliberately, because it would let a `disabledFor` entry silently stop disabling a feature when a caller omits the key. Audit any definition with more than one condition in a direction before upgrading.
+
+- Reject any parameterized condition (`list`, `range`, `percentage`) that has no `parameter`, or only whitespace. Such a condition evaluates against a subject value it has no way to look up, and previously raised `wrong number of arguments` on every evaluation for every caller. It is now treated as unbuildable, so the owning feature fails closed like any other invalid entry. `always` and `never` take no value and are unaffected.
+
+- Ignore `nil` entries in a Feature's condition lists instead of raising `NoMethodError` while evaluating. The marshaller already dropped them when writing, so reading now matches writing.
+
+- Derive `un_evaluable?` from the conditions rather than holding it only as state set after construction, so a Feature rebuilt from another's conditions stays failed closed instead of silently becoming enabled again.
+
 ## [3.4.0]
 
 - Add an opt-in `coerce` boolean to the `list` condition. When `true`, values and the tested input are compared as strings, so a list authored with integers matches a string caller (and vice versa). Defaults to exact-type matching, so existing definitions are unchanged; the flag is serialized only when enabled.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    eight_ball (3.4.0)
+    eight_ball (3.5.0)
       awrence (~> 1.1)
       logger (~> 1.7)
       plissken (~> 1.2)

data/README.md

@@ -55,8 +55,8 @@ features = marshaller.unmarshall json_input
 EightBall.provider = EightBall::Providers::Static.new features
 
 # Away you go
-EightBall.enabled? "Feature1", { accountId: 4 } # true
-EightBall.enabled? "Feature1", { accountId: 2 } # false
+EightBall.enabled? "Feature1", { account_id: 4 } # true
+EightBall.enabled? "Feature1", { account_id: 2 } # false
 ```
 
 More examples [here](examples)
@@ -81,7 +81,7 @@ A Condition must either be `true` or `false`. It describes when a Feature is ena
 - [List](lib/eight_ball/conditions/list.rb): This condition is satisfied if the given value belongs to its list of accepted values.
 - [Never](lib/eight_ball/conditions/never.rb): This condition is never satisfied.
 - [Range](lib/eight_ball/conditions/range.rb): This condition is satisfied if the given value is within the specified range (inclusive).
-- [Percentage](lib/eight_ball/conditions/percentage.rb): This condition is satisfied for a deterministic, sticky subset of subjects sized to `percentage` percent. Bucketing is salted by the flag name so a subject is decorrelated across flags. Wire form: `{"type":"percentage","parameter":"account_id","percentage":<0..100>}`.
+- [Percentage](lib/eight_ball/conditions/percentage.rb): This condition is satisfied for a deterministic, sticky subset of subjects sized to `percentage` percent. Bucketing is salted by the flag name so a subject is decorrelated across flags. `parameter` is required. Wire form: `{"type":"percentage","percentage":<0..100>,"parameter":"account_id"}`.
 
 #### List value coercion
 

data/lib/eight_ball/conditions/percentage.rb

@@ -13,12 +13,13 @@ module EightBall::Conditions
     # @param [Hash] options
     # @option options [Integer] :percentage Integer 0..100. 0 is never
     #   satisfied; 100 is always satisfied.
-    # @option options [String] :parameter The name of the parameter this Condition
-    #   was created for (eg. "account_id").
+    # @option options [String] :parameter Required. The parameter to bucket on (eg. "account_id").
     def initialize(options = {})
       options ||= {}
 
       raise ArgumentError, 'Missing value for percentage' if options[:percentage].nil?
+      # Without a parameter every subject shares one salt, so the flag ships to 0 or 100 percent.
+      raise ArgumentError, 'Missing value for parameter' if options[:parameter].to_s.strip.empty?
 
       percentage = options[:percentage]
       percentage = percentage.to_i if percentage.is_a?(Float) && percentage.to_i == percentage

data/lib/eight_ball/feature.rb

@@ -20,10 +20,12 @@ module EightBall
     #   feature = EightBall::Feature.new 'feature1', EightBall::Conditions::Always
     def initialize(name, enabled_for = [], disabled_for = [], metadata: nil)
       @name = name
-      @enabled_for = inject_flag_name(Array(enabled_for))
-      @disabled_for = inject_flag_name(Array(disabled_for))
+      # A nil entry has no #parameter and would raise while evaluating.
+      @enabled_for = inject_flag_name(Array(enabled_for).compact)
+      @disabled_for = inject_flag_name(Array(disabled_for).compact)
       @metadata = metadata
-      @un_evaluable = false
+      # Derived, so a Feature rebuilt from these conditions stays un-evaluable.
+      @un_evaluable = (@enabled_for + @disabled_for).any? { |c| c.is_a?(EightBall::Conditions::Opaque) }
     end
 
     # "EightBall, is this Feature enabled?"
@@ -82,7 +84,8 @@ module EightBall
 
     def any_satisfied?(conditions, parameters)
       conditions.any? do |condition|
-        return condition.satisfied? if condition.parameter.nil?
+        # next, not return: a return exits the method and decides the whole direction.
+        next condition.satisfied? if condition.parameter.nil?
 
         value = parameters[condition.parameter.to_sym]
         raise ArgumentError, "Missing parameter #{condition.parameter}" if value.nil?

data/lib/eight_ball/marshallers/json.rb

@@ -130,10 +130,17 @@ module EightBall::Marshallers
 
       condition_class = EightBall::Conditions.by_name condition[:type]
       return EightBall::Conditions::Opaque.new(condition) if condition_class.nil?
+      # Nothing to match against without a parameter, so fail the flag closed.
+      return EightBall::Conditions::Opaque.new(condition) if requires_parameter?(condition_class) && condition[:parameter].to_s.strip.empty?
 
       condition_class.new condition
     rescue StandardError
       EightBall::Conditions::Opaque.new(condition)
     end
+
+    # A condition that evaluates against a subject value is one that needs a parameter.
+    def requires_parameter?(condition_class)
+      condition_class.instance_method(:satisfied?).arity.positive?
+    end
   end
 end

data/lib/eight_ball/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EightBall
-  VERSION = '3.4.0'
+  VERSION = '3.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eight_ball
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Rewind.io