unleash 4.4.4 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f59bcc61a5b2adc71f82f31ee80d02e8957854b86b85147fa33ad1f8bd3ee3ab
-  data.tar.gz: 691a79a57aba051ab5111d71a038e6c8f2d21ee747ee39fdb6676108fc1ef777
+  metadata.gz: 5f7e5c9cc285cd8b5d030f115babe035a65540a63aea7f2c0500d845afe74af1
+  data.tar.gz: ec93948ce1eed18fc20ac93e8a9bb944ae6080a1740f58910d6689305d1cc72e
 SHA512:
-  metadata.gz: c6d4c9efc598b2eae5958c7c68c362832988d6ed8cc4f51d47e0ede588b37599c0d104d4a7c08060761564653bdb68d1c6a20dedafc7b6d3bbb22c489ac8c4ec
-  data.tar.gz: 003b0d345c5f1ccc22361ddce4213e40054ec57a7e3404ca8d99ce3b120fb072b506a75f1fe64053e7b57c67688ed0b6aa6532dd99f3f7bfaa729c520d2c290c
+  metadata.gz: cabaff808990418367c85b739b5994f3d0010ee61415b5d9e6dfcea9e3b808b3b9d9e6bd05d07a0fd9bacc9423d909e52393e1a42ea671a95acfa7e45b4c80f4
+  data.tar.gz: fdb3553cb10738d0db2be4a8f1bbd01181eb32abcb790420cbd6961c7f0df76841e7abfa88a29a829554d0baa3374db2f46fe87e068f380187bdbcc94d77fc03

data/.github/workflows/pull_request.yml

@@ -50,7 +50,7 @@ jobs:
       - name: Install dependencies
         run: bundle install
       - name: Download test cases
-        run: git clone --depth 5 --branch v4.2.2 https://github.com/Unleash/client-specification.git client-specification
+        run: git clone --depth 5 --branch v4.5.1 https://github.com/Unleash/client-specification.git client-specification
       - name: Run tests
         run: bundle exec rake
         env:

data/.rubocop.yml

@@ -13,6 +13,8 @@ Metrics/ClassLength:
   Max: 135
   CountAsOne:
     - 'method_call'
+  Exclude:
+    - 'lib/unleash/feature_toggle.rb'
 Layout/LineLength:
   Max: 140
 Metrics/MethodLength:

data/CHANGELOG.md

@@ -13,6 +13,19 @@ Note: These changes are not considered notable:
 
 ## [Unreleased]
 
+## [4.6.0] - 2023-10-16
+### Added
+- dependant toggles (#155)
+  - client specification is [here](https://github.com/Unleash/client-specification/pull/63)
+
+## [4.5.0] - 2023-07-05
+### Added
+- variants in strategies (#148)
+  - issue described here (#147)
+
+### Fixed
+- groupId override for variants
+
 ## [4.4.4] - 2023-07-05
 ### Fixed
 - flexible rollout strategy without context (#146)

data/README.md

@@ -25,7 +25,7 @@ Leverage the [Unleash Server](https://github.com/Unleash/unleash) for powerful f
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'unleash', '~> 4.4.4'
+gem 'unleash', '~> 4.6.0'
 ```
 
 And then execute:
@@ -528,7 +528,7 @@ You can also run `bin/console` for an interactive prompt that will allow you to
 This SDK is also built against the Unleash Client Specification tests.
 To run the Ruby SDK against this test suite, you'll need to have a copy on your machine, you can clone the repository directly using:
 
-`git clone --depth 5 --branch v4.2.2 https://github.com/Unleash/client-specification.git client-specification`
+`git clone --depth 5 --branch v4.5.1 https://github.com/Unleash/client-specification.git client-specification`
 
 After doing this, `rake spec` will also run the client specification tests.
 
@@ -539,7 +539,7 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 Choose a new version number following [Semantic Versioning](https://semver.org/spec/v2.0.0.html) semantics and then:
 
 - update the version number in [./lib/unleash/version.rb](./lib/unleash/version.rb),
-- if a major or minor version bump, update the [Installation section](#Installation) in [README.md](README.md)
+- if a major or minor version bump, update the [Installation section](#installation) in [README.md](README.md)
 - update [CHANGELOG.md](CHANGELOG.md) following the format on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 - commit with message `chore: bump version to x.y.z`
 - then run `bundle exec rake release`

data/lib/unleash/activation_strategy.rb

@@ -1,8 +1,8 @@
 module Unleash
   class ActivationStrategy
-    attr_accessor :name, :params, :constraints, :disabled
+    attr_accessor :name, :params, :constraints, :disabled, :variant_definitions
 
-    def initialize(name, params, constraints = [])
+    def initialize(name, params, constraints = [], variant_definitions = [])
       self.name = name
       self.disabled = false
 
@@ -15,17 +15,30 @@ module Unleash
         self.params = {}
       end
 
-      if constraints.is_a?(Array) && constraints.each{ |c| c.is_a?(Constraint) }
+      if constraints.is_a?(Array) && constraints.all?{ |c| c.is_a?(Constraint) }
         self.constraints = constraints
       else
-        Unleash.logger.warn "Invalid constraints provided for ActivationStrategy (contraints: #{constraints})"
+        Unleash.logger.warn "Invalid constraints provided for ActivationStrategy (constraints: #{constraints})"
         self.disabled = true
         self.constraints = []
       end
+
+      self.variant_definitions = valid_variant_definitions(variant_definitions)
     end
 
     def matches_context?(context)
       self.constraints.any?{ |c| c.matches_context? context }
     end
+
+    private
+
+    def valid_variant_definitions(variant_definitions)
+      if variant_definitions.is_a?(Array) && variant_definitions.all?{ |variant_definition| variant_definition.is_a?(VariantDefinition) }
+        variant_definitions
+      else
+        Unleash.logger.warn "Invalid variant_definitions provided for ActivationStrategy (variant_definitions: #{variant_definitions})"
+        []
+      end
+    end
   end
 end

data/lib/unleash/client.rb

@@ -41,7 +41,6 @@ module Unleash
                       end
 
       toggle_as_hash = Unleash&.toggles&.select{ |toggle| toggle['name'] == feature }&.first
-
       if toggle_as_hash.nil?
         Unleash.logger.debug "Unleash::Client.is_enabled? feature: #{feature} not found"
         return default_value

data/lib/unleash/configuration.rb

@@ -53,7 +53,7 @@ module Unleash
       {
         'UNLEASH-INSTANCEID' => self.instance_id,
         'UNLEASH-APPNAME' => self.app_name,
-        'Unleash-Client-Spec' => '4.2.2'
+        'Unleash-Client-Spec' => '4.5.1'
       }.merge!(generate_custom_http_headers)
     end
 

data/lib/unleash/feature_toggle.rb

@@ -7,13 +7,16 @@ require 'securerandom'
 
 module Unleash
   class FeatureToggle
-    attr_accessor :name, :enabled, :strategies, :variant_definitions
+    attr_accessor :name, :enabled, :dependencies, :strategies, :variant_definitions
+
+    FeatureEvaluationResult = Struct.new(:enabled?, :strategy)
 
     def initialize(params = {}, segment_map = {})
       params = {} if params.nil?
 
       self.name       = params.fetch('name', nil)
       self.enabled    = params.fetch('enabled', false)
+      self.dependencies = params.fetch('dependencies', [])
 
       self.strategies = initialize_strategies(params, segment_map)
       self.variant_definitions = initialize_variant_definitions(params)
@@ -37,10 +40,13 @@ module Unleash
 
       context = ensure_valid_context(context)
 
-      toggle_enabled = am_enabled?(context)
-      variant = resolve_variant(context, toggle_enabled)
+      evaluation_result = evaluate(context)
+
+      group_id = evaluation_result.strategy&.params.to_h['groupId'] || self.name
 
-      choice = toggle_enabled ? :yes : :no
+      variant = resolve_variant(context, evaluation_result, group_id)
+
+      choice = evaluation_result.enabled? ? :yes : :no
       Unleash.toggle_metrics.increment_variant(self.name, choice, variant.name) unless Unleash.configuration.disable_metrics
       variant
     end
@@ -51,33 +57,69 @@ module Unleash
 
     private
 
-    def resolve_variant(context, toggle_enabled)
-      return Unleash::FeatureToggle.disabled_variant unless toggle_enabled
-      return Unleash::FeatureToggle.disabled_variant if sum_variant_defs_weights <= 0
+    def resolve_variant(context, evaluation_result, group_id)
+      variant_definitions = evaluation_result.strategy&.variant_definitions
+      variant_definitions = self.variant_definitions if variant_definitions.nil? || variant_definitions.empty?
+      return Unleash::FeatureToggle.disabled_variant unless evaluation_result.enabled?
+      return Unleash::FeatureToggle.disabled_variant if sum_variant_defs_weights(variant_definitions) <= 0
 
-      variant_from_override_match(context) || variant_from_weights(context, resolve_stickiness)
+      variant_from_override_match(context, variant_definitions) ||
+        variant_from_weights(context, resolve_stickiness(variant_definitions), variant_definitions, group_id)
     end
 
-    def resolve_stickiness
-      self.variant_definitions&.map(&:stickiness)&.compact&.first || "default"
+    def resolve_stickiness(variant_definitions)
+      variant_definitions&.map(&:stickiness)&.compact&.first || "default"
     end
 
     # only check if it is enabled, do not do metrics
     def am_enabled?(context)
-      result =
-        if self.enabled
-          self.strategies.empty? ||
-            self.strategies.any? do |s|
-              strategy_enabled?(s, context) && strategy_constraint_matches?(s, context)
-            end
+      evaluate(context).enabled?
+    end
+
+    def parent_dependencies_satisfied?(context)
+      dependencies.empty? || dependencies.all?{ |parent| evaluate_parent(parent, context) }
+    end
+
+    def evaluate_parent(parent, context)
+      parent_toggle = get_parent(parent["feature"])
+      return false if parent_toggle.nil? || !parent_toggle.dependencies.empty?
+
+      evaluation_result = parent_toggle.is_enabled?(context)
+      return !evaluation_result if parent["enabled"] == false
+
+      return false unless evaluation_result
+
+      return evaluation_result if parent["variants"].nil? || parent["variants"].empty?
+
+      parent["variants"].include?(parent_toggle.get_variant(context).name)
+    end
+
+    def get_parent(feature)
+      toggle_as_hash = Unleash&.toggles&.find{ |toggle| toggle['name'] == feature }
+      if toggle_as_hash.nil?
+        Unleash.logger.debug "Unleash::Client.is_enabled? feature: #{feature} not found"
+        return nil
+      end
+
+      Unleash::FeatureToggle.new(toggle_as_hash, Unleash&.segment_cache)
+    end
+
+    def evaluate(context)
+      evaluation_result =
+        if !parent_dependencies_satisfied?(context)
+          FeatureEvaluationResult.new(false, nil)
+        elsif !self.enabled
+          FeatureEvaluationResult.new(false, nil)
+        elsif self.strategies.empty?
+          FeatureEvaluationResult.new(true, nil)
         else
-          false
+          strategy = self.strategies.find{ |s| strategy_enabled?(s, context) && strategy_constraint_matches?(s, context) }
+          FeatureEvaluationResult.new(!strategy.nil?, strategy)
         end
 
-      Unleash.logger.debug "Unleash::FeatureToggle (enabled:#{self.enabled} " \
-        "and Strategies combined with contraints returned #{result})"
-
-      result
+      Unleash.logger.debug "Unleash::FeatureToggle (enabled:#{self.enabled}) " \
+        "and Strategies combined with constraints returned #{evaluation_result})"
+      evaluation_result
     end
 
     def strategy_enabled?(strategy, context)
@@ -92,8 +134,8 @@ module Unleash
       strategy.constraints.empty? || strategy.constraints.all?{ |c| c.matches_context?(context) }
     end
 
-    def sum_variant_defs_weights
-      self.variant_definitions.map(&:weight).reduce(0, :+)
+    def sum_variant_defs_weights(variant_definitions)
+      variant_definitions.map(&:weight).reduce(0, :+)
     end
 
     def variant_salt(context, stickiness = "default")
@@ -110,18 +152,22 @@ module Unleash
       SecureRandom.random_number
     end
 
-    def variant_from_override_match(context)
-      variant = self.variant_definitions.find{ |vd| vd.override_matches_context?(context) }
-      return nil if variant.nil?
+    def variant_from_override_match(context, variant_definitions)
+      variant_definition = variant_definitions.find{ |vd| vd.override_matches_context?(context) }
+      return nil if variant_definition.nil?
 
-      Unleash::Variant.new(name: variant.name, enabled: true, payload: variant.payload)
+      Unleash::Variant.new(name: variant_definition.name, enabled: true, payload: variant_definition.payload)
     end
 
-    def variant_from_weights(context, stickiness)
-      variant_weight = Unleash::Strategy::Util.get_normalized_number(variant_salt(context, stickiness), self.name, sum_variant_defs_weights)
+    def variant_from_weights(context, stickiness, variant_definitions, group_id)
+      variant_weight = Unleash::Strategy::Util.get_normalized_number(
+        variant_salt(context, stickiness),
+        group_id,
+        sum_variant_defs_weights(variant_definitions)
+      )
       prev_weights = 0
 
-      variant_definition = self.variant_definitions
+      variant_definition = variant_definitions
         .find do |v|
           res = (prev_weights + v.weight >= variant_weight)
           prev_weights += v.weight
@@ -148,11 +194,26 @@ module Unleash
           ActivationStrategy.new(
             s['name'],
             s['parameters'],
-            resolve_constraints(s, segment_map)
+            resolve_constraints(s, segment_map),
+            resolve_variants(s)
           )
         end || []
     end
 
+    def resolve_variants(strategy)
+      strategy.fetch("variants", [])
+        .select{ |variant| variant.is_a?(Hash) && variant.has_key?("name") }
+        .map do |variant|
+          VariantDefinition.new(
+            variant.fetch("name", ""),
+            variant.fetch("weight", 0),
+            variant.fetch("payload", nil),
+            variant.fetch("stickiness", nil),
+            variant.fetch("overrides", [])
+          )
+        end
+    end
+
     def resolve_constraints(strategy, segment_map)
       segment_constraints = (strategy["segments"] || []).map do |segment_id|
         segment_map[segment_id]&.fetch("constraints")

data/lib/unleash/version.rb

@@ -1,3 +1,3 @@
 module Unleash
-  VERSION = "4.4.4".freeze
+  VERSION = "4.6.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unleash
 version: !ruby/object:Gem::Version
-  version: 4.4.4
+  version: 4.6.0
 platform: ruby
 authors:
 - Renato Arruda
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-05 00:00:00.000000000 Z
+date: 2023-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: murmurhash3