unleash 4.5.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b823e18f3a0768928856433b11674d37ea62cc7f2b8b15786920488aba5c063c
-  data.tar.gz: 6c8ec27517214b441c711d2f0069c211492ce3185bf4f1741c7b07077a28b088
+  metadata.gz: 46123d78efc7bf615f2ccf84d20087a6680b7999fed0e4b4e22014b044b7d455
+  data.tar.gz: 9992d9a6da906ab49b7ab5cfb9b8521c3f8bdd849ac76099153157debe3a989b
 SHA512:
-  metadata.gz: a324e1902ae4e3885a206531e25d6138db8e39fb50b946471d0dcce3aec1ce595c2743b79ad3519af7cb80e83a284428d16bb2f3385313f889938f2ded80feef
-  data.tar.gz: b89d72bb1b7a0fdd6ba65fe92ab1909ec5b02742d6e2d2447d047ed0d3325efe29e0e0f033ad4ff0ad12e80041a2a8697b64e366dd185077953be59073c8e801
+  metadata.gz: 49a49172df9366a14e26ae3d5486347fd9bf0cab8b154139bceb642a5f586ac2e01b617c4756c8e64a48a96d7f93605e686d98092ba86cd1db5bcb4e24142641
+  data.tar.gz: eb53f5f237afe96847ac14cc9af19a4d517c63e874cc829c957bf729e80cdf05f5d251393d918e36ccedc1e15ad0e8933923b5561674126c518a6322ea0956ad

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.3.1 https://github.com/Unleash/client-specification.git client-specification
+        run: git clone --depth 5 --branch v5.0.2 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,17 @@ Note: These changes are not considered notable:
 
 ## [Unreleased]
 
+## [5.0.0] - 2023-10-30
+### Added
+- change seed for variantutils to ensure fair distribution (#160)
+  - client specification is [here](https://github.com/Unleash/client-specification/tree/v5.0.2/specifications)
+  - A new seed is introduced to ensure a fair distribution for variants, addressing the issue of skewed variant distribution due to using the same hash string for both gradual rollout and variant allocation.
+
+## [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)

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.5.0'
+gem 'unleash', '~> 5.0.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.3.1 https://github.com/Unleash/client-specification.git client-specification`
+`git clone --depth 5 --branch v5.0.2 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`
@@ -555,3 +555,5 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/unleas
 Be sure to run both `bundle exec rspec` and `bundle exec rubocop` in your branch before creating a pull request.
 
 Please include tests with any pull requests, to avoid regressions.
+
+Check out our guide for more information on how to build and scale [feature flag systems](https://docs.getunleash.io/topics/feature-flags/feature-flag-best-practices)

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' => '5.0.2'
       }.merge!(generate_custom_http_headers)
     end
 

data/lib/unleash/constraint.rb

@@ -107,7 +107,7 @@ module Unleash
       context_value = context.get_by_name(self.context_name)
 
       v.map!(&:upcase) if self.case_insensitive
-      context_value.upcase! if self.case_insensitive
+      context_value = context_value.upcase if self.case_insensitive
 
       OPERATORS[self.operator].call(context_value, v)
     end

data/lib/unleash/feature_toggle.rb

@@ -7,7 +7,7 @@ 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)
 
@@ -16,6 +16,7 @@ module Unleash
 
       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)
@@ -41,11 +42,11 @@ module Unleash
 
       evaluation_result = evaluate(context)
 
-      group_id = evaluation_result[:strategy]&.params.to_h['groupId'] || self.name
+      group_id = evaluation_result.strategy&.params.to_h['groupId'] || self.name
 
       variant = resolve_variant(context, evaluation_result, group_id)
 
-      choice = evaluation_result[:enabled?] ? :yes : :no
+      choice = evaluation_result.enabled? ? :yes : :no
       Unleash.toggle_metrics.increment_variant(self.name, choice, variant.name) unless Unleash.configuration.disable_metrics
       variant
     end
@@ -57,9 +58,9 @@ module Unleash
     private
 
     def resolve_variant(context, evaluation_result, group_id)
-      variant_definitions = evaluation_result[:strategy]&.variant_definitions
+      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 unless evaluation_result.enabled?
       return Unleash::FeatureToggle.disabled_variant if sum_variant_defs_weights(variant_definitions) <= 0
 
       variant_from_override_match(context, variant_definitions) ||
@@ -72,12 +73,42 @@ module Unleash
 
     # only check if it is enabled, do not do metrics
     def am_enabled?(context)
-      evaluate(context)[:enabled?]
+      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 !self.enabled
+        if !parent_dependencies_satisfied?(context)
+          FeatureEvaluationResult.new(false, nil)
+        elsif !self.enabled
           FeatureEvaluationResult.new(false, nil)
         elsif self.strategies.empty?
           FeatureEvaluationResult.new(true, nil)
@@ -86,9 +117,8 @@ module Unleash
           FeatureEvaluationResult.new(!strategy.nil?, strategy)
         end
 
-      Unleash.logger.debug "Unleash::FeatureToggle (enabled:#{self.enabled} " \
-        "and Strategies combined with contraints returned #{evaluation_result})"
-
+      Unleash.logger.debug "Unleash::FeatureToggle (enabled:#{self.enabled}) " \
+        "and Strategies combined with constraints returned #{evaluation_result})"
       evaluation_result
     end
 
@@ -133,6 +163,7 @@ module Unleash
       variant_weight = Unleash::Strategy::Util.get_normalized_number(
         variant_salt(context, stickiness),
         group_id,
+        Unleash::Strategy::Util::VARIANT_NORMALIZER_SEED,
         sum_variant_defs_weights(variant_definitions)
       )
       prev_weights = 0

data/lib/unleash/strategy/flexible_rollout.rb

@@ -24,7 +24,7 @@ module Unleash
         end
 
         group_id = params.fetch('groupId', '')
-        normalized_number = Util.get_normalized_number(stickiness_id, group_id)
+        normalized_number = Util.get_normalized_number(stickiness_id, group_id, 0)
 
         return false if stickiness_id.nil?
 

data/lib/unleash/strategy/gradual_rollout_sessionid.rb

@@ -14,7 +14,7 @@ module Unleash
         return false if context.session_id.nil? || context.session_id.empty?
 
         percentage = Integer(params['percentage'] || 0)
-        (percentage.positive? && Util.get_normalized_number(context.session_id, params['groupId'] || "") <= percentage)
+        (percentage.positive? && Util.get_normalized_number(context.session_id, params['groupId'] || "", 0) <= percentage)
       end
     end
   end

data/lib/unleash/strategy/gradual_rollout_userid.rb

@@ -14,7 +14,7 @@ module Unleash
         return false if context.user_id.nil? || context.user_id.empty?
 
         percentage = Integer(params['percentage'] || 0)
-        (percentage.positive? && Util.get_normalized_number(context.user_id, params['groupId'] || "") <= percentage)
+        (percentage.positive? && Util.get_normalized_number(context.user_id, params['groupId'] || "", 0) <= percentage)
       end
     end
   end

data/lib/unleash/strategy/util.rb

@@ -6,10 +6,11 @@ module Unleash
       module_function
 
       NORMALIZER = 100
+      VARIANT_NORMALIZER_SEED = 86_028_157
 
       # convert the two strings () into a number between 1 and base (100 by default)
-      def get_normalized_number(identifier, group_id, base = NORMALIZER)
-        MurmurHash3::V32.str_hash("#{group_id}:#{identifier}") % base + 1
+      def get_normalized_number(identifier, group_id, seed, base = NORMALIZER)
+        MurmurHash3::V32.str_hash("#{group_id}:#{identifier}", seed) % base + 1
       end
     end
   end

data/lib/unleash/version.rb

@@ -1,3 +1,3 @@
 module Unleash
-  VERSION = "4.5.0".freeze
+  VERSION = "5.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unleash
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Renato Arruda
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-24 00:00:00.000000000 Z
+date: 2023-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: murmurhash3