determinator 2.4.4 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b5c2494d530c31a915321c8dbf47713e4ddaed50a0d5858a285e020a87bccf1
-  data.tar.gz: 4e9cad995c047a7c8d12aa7dc8228cddfc4a84891c2fc9283b4d41eb26b3bbdf
+  metadata.gz: b505247b6902fb3768389da7b5a20e625f95e5ccaec778ae7fb52e1808286b73
+  data.tar.gz: 659b93e86df258535f904bd90d91768767c5c1644cd578d3efe3f45a9c2aba6f
 SHA512:
-  metadata.gz: 0727e1e39289a3f89b0d6e20da1139130ca329cdd786af73b7190c3df3f3e958f31d2f92eb09593e00c2503fdb09adf499ac81006baac28094b377e59f7be452
-  data.tar.gz: ce5085f303357a3d3e70e082b99f6ef986ee1f5c0a27fee7c0b89d7e6196c6702955e2c70db1897f003316cfcbf3934d99a9379cfa1b11a9659321832141a091
+  metadata.gz: 753968e66ac00b3f0606eed33b5d1873ad23a89cce901b69e261f38263ff14f18b975a0f03e55146e8ea78dc397b1a48878f10c3b1fc6eadd4f278a78f2a7703
+  data.tar.gz: 46d183bc1e87d5031b43115bb63573503725f441a44603577274fef9817cd20722471bcba1b46d018beab4828bbcbf738c4de742aff0de26578178330edd2885

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 2.5.0
+
+Feature:
+- Add fixed determinations
+
 # 2.4.4
 
 Bug fix:

data/lib/determinator.rb

@@ -2,6 +2,7 @@ require 'determinator/version'
 require 'determinator/control'
 require 'determinator/feature'
 require 'determinator/target_group'
+require 'determinator/fixed_determination'
 require 'determinator/cache/fetch_wrapper'
 require 'determinator/serializers/json'
 require 'determinator/missing_response'

data/lib/determinator/control.rb

@@ -81,6 +81,14 @@ module Determinator
 
       return feature.override_value_for(id) if feature.overridden_for?(id)
 
+      fixed_determination = choose_fixed_determination(feature, properties)
+      # Given constraints have specified that this actor's determination should be fixed
+      if fixed_determination
+        return false unless fixed_determination.feature_on
+        return true unless feature.experiment?
+        return fixed_determination.variant
+      end
+
       target_group = choose_target_group(feature, properties)
       # Given constraints have excluded this actor from this experiment
       return false unless target_group
@@ -106,23 +114,34 @@ module Determinator
       false
     end
 
+    def choose_fixed_determination(feature, properties)
+      # Keys and values must be strings
+      normalised_properties = normalise_properties(properties)
+
+      feature.fixed_determinations.find { |fd|
+        matches_constraints(normalised_properties, fd.constraints)
+      }
+    end
+
     def choose_target_group(feature, properties)
       # Keys and values must be strings
-      normalised_properties = properties.each_with_object({}) do |(name, values), hash|
-        hash[name.to_s] = [*values].map(&:to_s)
-      end
+      normalised_properties = normalise_properties(properties)
 
       feature.target_groups.select { |tg|
         next false unless tg.rollout.between?(1, 65_536)
 
-        tg.constraints.reduce(true) do |fit, (scope, *required)|
-          present = [*normalised_properties[scope]]
-          fit && matches_requirements?(scope, required, present)
-        end
+        matches_constraints(normalised_properties, tg.constraints)
         # Must choose target group deterministically, if more than one match
       }.sort_by { |tg| tg.rollout }.last
     end
 
+    def matches_constraints(normalised_properties, constraints)
+      constraints.reduce(true) do |fit, (scope, *required)|
+        present = [*normalised_properties[scope]]
+        fit && matches_requirements?(scope, required, present)
+      end
+    end
+
     def matches_requirements?(scope, required, present)
       case scope
         when "app_version" then has_any_app_version?(required, present)
@@ -205,5 +224,13 @@ module Determinator
 
       raise ArgumentError, "A variant should have been found by this point, there is a bug in the code."
     end
+
+    private
+
+    def normalise_properties(properties)
+      properties.each_with_object({}) do |(name, values), hash|
+        hash[name.to_s] = [*values].map(&:to_s)
+      end
+    end
   end
 end

data/lib/determinator/feature.rb

@@ -3,13 +3,14 @@ module Determinator
   #
   # @attr_reader [nil,Hash<String,Integer>] variants The variants for this experiment, with the name of the variant as the key and the weight as the value. Will be nil for non-experiments.
   class Feature
-    attr_reader :name, :identifier, :bucket_type, :variants, :target_groups, :active, :winning_variant
+    attr_reader :name, :identifier, :bucket_type, :variants, :target_groups, :fixed_determinations, :active, :winning_variant
 
-    def initialize(name:, identifier:, bucket_type:, target_groups:, variants: {}, overrides: {}, active: false, winning_variant: nil)
+    def initialize(name:, identifier:, bucket_type:, target_groups:, fixed_determinations: [], variants: {}, overrides: {}, active: false, winning_variant: nil)
       @name = name.to_s
-      @identifier = (identifier || name).to_s
+      @identifier = identifier.to_s
       @variants = variants
       @target_groups = parse_target_groups(target_groups)
+      @fixed_determinations = parse_fixed_determinations(fixed_determinations)
       @winning_variant = parse_outcome(winning_variant, allow_exclusion: false)
       @active = active
       @bucket_type = bucket_type.to_sym
@@ -72,14 +73,43 @@ module Determinator
 
       TargetGroup.new(
         rollout: target_group['rollout'].to_i,
-        constraints: constraints.each_with_object({}) do |(key, value), hash|
-          hash[key.to_s] = [*value].map(&:to_s)
-        end
+        constraints: parse_constraints(constraints)
       )
 
     # Invalid target groups are ignored
     rescue
       nil
     end
+
+    def parse_fixed_determinations(fixed_determinations)
+      fixed_determinations.map(&method(:parse_fixed_determination)).compact
+    end
+
+    def parse_fixed_determination(fixed_determination)
+      return fixed_determination if fixed_determination.is_a? FixedDetermination
+
+      variant = fixed_determination['variant']
+      return nil if variant && !variants.keys.include?(variant)
+
+      # if a variant is present the fixed determination should always be on
+      return nil if variant && !fixed_determination['feature_on']
+
+      constraints = fixed_determination['constraints'].to_h
+
+      FixedDetermination.new(
+        feature_on: fixed_determination['feature_on'],
+        variant: variant,
+        constraints: parse_constraints(constraints)
+      )
+    # Invalid fixed determinations are ignored
+    rescue
+      nil
+    end
+
+    def parse_constraints(constraints)
+      constraints.each_with_object({}) do |(key, value), hash|
+        hash[key.to_s] = [*value].map(&:to_s)
+      end
+    end
   end
 end

data/lib/determinator/fixed_determination.rb

@@ -0,0 +1,20 @@
+module Determinator
+  class FixedDetermination
+    attr_reader :feature_on, :variant, :constraints
+
+    def initialize(feature_on:, variant:, constraints: {})
+      @feature_on = feature_on
+      @variant = variant
+      @constraints = constraints
+    end
+
+    def inspect
+      "<feature_on: #{feature_on}, variant: #{variant}, constraints: #{constraints}"
+    end
+
+    def ==(other)
+      return false unless other.is_a?(self.class)
+      other.feature_on == feature_on && other.variant == variant && other.constraints == constraints
+    end
+  end
+end

data/lib/determinator/serializers/json.rb

@@ -12,14 +12,15 @@ module Determinator
           obj = string_or_hash.is_a?(Hash) ? string_or_hash : ::JSON.parse(string_or_hash)
 
           Determinator::Feature.new(
-            name:            obj['name'],
-            identifier:      obj['identifier'],
-            bucket_type:     obj['bucket_type'],
-            active:          (obj['active'] === true),
-            target_groups:   obj['target_groups'],
-            variants:        obj['variants'].to_h,
-            overrides:       obj['overrides'].to_h,
-            winning_variant: obj['winning_variant'].to_s,
+            name:                 obj['name'],
+            identifier:           obj['identifier'],
+            bucket_type:          obj['bucket_type'],
+            active:               (obj['active'] === true),
+            target_groups:        obj['target_groups'],
+            fixed_determinations: obj['fixed_determinations'].to_a,
+            variants:             obj['variants'].to_h,
+            overrides:            obj['overrides'].to_h,
+            winning_variant:      obj['winning_variant'].to_s,
           )
         end
       end

data/lib/determinator/version.rb

@@ -1,3 +1,3 @@
 module Determinator
-  VERSION = '2.4.4'
+  VERSION = '2.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: determinator
 version: !ruby/object:Gem::Version
-  version: 2.4.4
+  version: 2.5.0
 platform: ruby
 authors:
 - JP Hastings-Spital
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-20 00:00:00.000000000 Z
+date: 2020-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -150,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - jp@deliveroo.co.uk
 executables: []
@@ -210,6 +210,7 @@ files:
 - lib/determinator/control.rb
 - lib/determinator/error_response.rb
 - lib/determinator/feature.rb
+- lib/determinator/fixed_determination.rb
 - lib/determinator/missing_response.rb
 - lib/determinator/retrieve/dynaconf.rb
 - lib/determinator/retrieve/file.rb
@@ -231,7 +232,7 @@ homepage: https://github.com/deliveroo/determinator
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -246,8 +247,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: Determine which experiments and features a specific actor should see.
 test_files: []