unleash 4.4.3 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 910ddad70479cae68918b7400b4ddc6d0c71f9448d8524072c318d6c353c4f52
-  data.tar.gz: 1d75ed31736627ea30c2bbc9be7903c9dfa19dc4691c07de885dd87a8eb94c85
+  metadata.gz: b823e18f3a0768928856433b11674d37ea62cc7f2b8b15786920488aba5c063c
+  data.tar.gz: 6c8ec27517214b441c711d2f0069c211492ce3185bf4f1741c7b07077a28b088
 SHA512:
-  metadata.gz: aec46ef764fcb138d34baa7c6832ff1865be4dac1f6f004ab928e8447ecde701ec82bf2069c69e62b2404706bf029c1743a3dc2322b5e7409135aba498cdf80e
-  data.tar.gz: d1a529a53cbd934c4aae24919352fc670b27b8cb0a9ccb2bde20deafa3eb3adf679e7c49ced246258547f68a400a10a1da214bc07a19e153ffb0af60fcea8961
+  metadata.gz: a324e1902ae4e3885a206531e25d6138db8e39fb50b946471d0dcce3aec1ce595c2743b79ad3519af7cb80e83a284428d16bb2f3385313f889938f2ded80feef
+  data.tar.gz: b89d72bb1b7a0fdd6ba65fe92ab1909ec5b02742d6e2d2447d047ed0d3325efe29e0e0f033ad4ff0ad12e80041a2a8697b64e366dd185077953be59073c8e801

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.3.1 https://github.com/Unleash/client-specification.git client-specification
       - name: Run tests
         run: bundle exec rake
         env:

data/CHANGELOG.md

@@ -0,0 +1,116 @@
+
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+Note: These changes are not considered notable:
+- build
+- documentation
+- dependencies
+
+## [Unreleased]
+
+## [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)
+  - The flexible rollout strategy should evaluate default and random stickiness even if context is not provided.
+
+## [4.4.3] - 2023-06-14
+### Added
+- Add Context#to_h method (#136)
+
+### Fixed
+- Bootstrapped variants now work when client is disabled (#138)
+- Variant metrics are now sent correctly to Unleash. Fixed a typo in the payload name. (#145)
+
+### Changed
+- Automatically disable metrics/MetricsReporter when client is disabled (#139) (#140)
+
+## [4.4.2] - 2023-01-05
+### Added
+- Add Client#disabled? method (#130)
+
+## [4.4.1] - 2022-12-07
+### Fixed
+- exception no longer bubbles up in constraints when context is nil (#127)
+- variants metrics did count toggles correctly  (#126)
+- prevent race condition when manipulating metrics data  (#122)
+- allow passing user_id as integer (#119)
+
+## [4.4.0] - 2022-09-19
+### Added
+- Allow custom strategies (#96)
+- Global segments (#114)
+
+### Fixed
+- Initializing client configuration from constructor (#117)
+- Support int context in set comparison (#115)
+
+## [4.3.0] - 2023-07-14
+### Added
+- dynamic http headers via Proc or Lambda (#107)
+
+### Fixed
+- Fixed ToggleFetcher#save! to close opened files on failure. (#97)
+
+### Changed
+- Refactored ToggleFetcher#read! (#106)
+
+## [4.2.1] - 2022-03-29
+### Fixed
+- correct logic for default values on feature toggles so toggle value respected when toggle exists and default is true (#93)
+
+## [4.2.0] - 2022-03-18
+### Added
+- Advanced constraints operators (#92)
+
+### Changed
+- Default to the client never giving up trying to reach the server even after repeated failures (#91)
+
+## [4.1.0] - 2022-02-11
+### Added
+- feat: Implement custom bootstrapping on startup (#88)
+- feat: add support for cidr in `RemoteAddress` strategy (#77)
+
+### Changed
+- default values for `metrics_interval` to `60s` and `retry_limit` to `5` (#78)
+
+## [4.0.0] - 2021-12-16
+### Added
+- Support for projects query (requires unleash 4.x) (#38)
+- Allow passing blocks to is_enabled? to determine default_result (#33)
+- Implement custom stickiness (#69)
+- Allow using custom_http_headers from the CLI utility (#75)
+
+### Fixed
+- Allow context to correctly resolve camelCase property values (#74)
+- Avoid unlikely situation of config changing under the read operation due to backup path file being incorrectly set (#63)
+
+### Changed
+- change how we handle the server api url (avoid double slashes in urls used for API calls.)
+- default values: refresh_interval => 10, metrics_interval=> 30 (#59)
+- changed metrics reporting behavior (#66)
+- only send metrics if there is data to send. (#58)
+- in Client#get_variant() allow context and fallback_variant as nil (#51)
+
+[unreleased]: https://git1hub.com/unleash/unleash-client-ruby/compare/v4.4.3...HEAD
+[4.4.3]: https://github.com/unleash/unleash-client-ruby/compare/v4.4.2...v4.4.3
+[4.4.2]: https://github.com/unleash/unleash-client-ruby/compare/v4.4.1...v4.4.2
+[4.4.1]: https://github.com/unleash/unleash-client-ruby/compare/v4.4.0...v4.4.1
+[4.4.0]: https://github.com/unleash/unleash-client-ruby/compare/v4.3.0...v4.4.0
+[4.3.0]: https://github.com/unleash/unleash-client-ruby/compare/v4.2.1...v4.3.0
+[4.2.1]: https://github.com/unleash/unleash-client-ruby/compare/v4.2.0...v4.2.1
+[4.2.0]: https://github.com/unleash/unleash-client-ruby/compare/v4.1.0...v4.2.0
+[4.1.0]: https://github.com/unleash/unleash-client-ruby/compare/v4.0.0...v4.1.0
+[4.0.0]: https://github.com/unleash/unleash-client-ruby/compare/v3.2.5...v4.0.0

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.0'
+gem 'unleash', '~> 4.5.0'
 ```
 
 And then execute:
@@ -528,16 +528,30 @@ 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.3.1 https://github.com/Unleash/client-specification.git client-specification`
 
 After doing this, `rake spec` will also run the client specification tests.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
-To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Releasing
+
+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)
+- 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`
+  - This will create a git tag for the version on the current commit,
+  - push git commits and tags to origin and
+  - push the `.gem` file to [rubygems.org](https://rubygems.org)
 
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/unleash/unleash-client-ruby.
 
+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.

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/feature_toggle.rb

@@ -9,6 +9,8 @@ module Unleash
   class FeatureToggle
     attr_accessor :name, :enabled, :strategies, :variant_definitions
 
+    FeatureEvaluationResult = Struct.new(:enabled?, :strategy)
+
     def initialize(params = {}, segment_map = {})
       params = {} if params.nil?
 
@@ -37,10 +39,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
+
+      variant = resolve_variant(context, evaluation_result, group_id)
 
-      choice = toggle_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
@@ -51,33 +56,40 @@ 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 evaluate(context)
+      evaluation_result =
+        if !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})"
+        "and Strategies combined with contraints returned #{evaluation_result})"
 
-      result
+      evaluation_result
     end
 
     def strategy_enabled?(strategy, context)
@@ -92,8 +104,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 +122,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 +164,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/strategy/flexible_rollout.rb

@@ -10,9 +10,10 @@ module Unleash
       # need: params['percentage']
       def is_enabled?(params = {}, context = nil)
         return false unless params.is_a?(Hash)
-        return false unless context.instance_of?(Unleash::Context)
 
         stickiness = params.fetch('stickiness', 'default')
+        return false if context_invalid?(stickiness, context)
+
         stickiness_id = resolve_stickiness(stickiness, context)
 
         begin
@@ -32,6 +33,12 @@ module Unleash
 
       private
 
+      def context_invalid?(stickiness, context)
+        return false if ['random', 'default'].include?(stickiness)
+
+        !context.instance_of?(Unleash::Context)
+      end
+
       def random
         Random.rand(0..100)
       end
@@ -41,7 +48,9 @@ module Unleash
         when 'random'
           random
         when 'default'
-          context.user_id || context.session_id || random
+          return random unless context.instance_of?(Unleash::Context)
+
+          context&.user_id || context&.session_id || random
         else
           begin
             context.get_by_name(stickiness)

data/lib/unleash/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unleash
 version: !ruby/object:Gem::Version
-  version: 4.4.3
+  version: 4.5.0
 platform: ruby
 authors:
 - Renato Arruda
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-14 00:00:00.000000000 Z
+date: 2023-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: murmurhash3
@@ -152,6 +152,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -199,7 +200,7 @@ homepage: https://github.com/unleash/unleash-client-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -214,8 +215,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 3.3.15
+signing_key:
 specification_version: 4
 summary: Unleash feature toggle client.
 test_files: []