unleash 4.6.0 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f7e5c9cc285cd8b5d030f115babe035a65540a63aea7f2c0500d845afe74af1
-  data.tar.gz: ec93948ce1eed18fc20ac93e8a9bb944ae6080a1740f58910d6689305d1cc72e
+  metadata.gz: e5eec84ff0d0a4890c3cc4f4605bc67762c5d4e434a0068e8a95cc5dbad830c3
+  data.tar.gz: 622ca11c209b7c214bc9e4c0114f0f2ec536c678d7faf536d8d657142c7201fc
 SHA512:
-  metadata.gz: cabaff808990418367c85b739b5994f3d0010ee61415b5d9e6dfcea9e3b808b3b9d9e6bd05d07a0fd9bacc9423d909e52393e1a42ea671a95acfa7e45b4c80f4
-  data.tar.gz: fdb3553cb10738d0db2be4a8f1bbd01181eb32abcb790420cbd6961c7f0df76841e7abfa88a29a829554d0baa3374db2f46fe87e068f380187bdbcc94d77fc03
+  metadata.gz: 5ac3bd355cf79dc61be37bd9a2df183e89e95b5221914382ef767063eb831a528e48eb558556877c3f208abbb648acf9af029eb27b5c629d18f53823d77b03a0
+  data.tar.gz: 2f5f1af33f7e9b60016a8e3c8f6434fff6f8ddb4e0d3cd5cafa1cb03550536cd6d95caa964b2945485509a6286387a6395173fe782d178b42ea1dd67bc9c20ad

data/.github/workflows/pull_request.yml

@@ -31,6 +31,7 @@ jobs:
           - jruby-9.4
           - jruby-9.3
           - jruby-9.2
+          - 3.3
           - 3.2
           - 3.1
           - '3.0'
@@ -41,7 +42,7 @@ jobs:
     needs:
       - lint
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Ruby ${{ matrix.ruby-version }}
         uses: ruby/setup-ruby@v1
         with:
@@ -50,7 +51,7 @@ jobs:
       - name: Install dependencies
         run: bundle install
       - name: Download test cases
-        run: git clone --depth 5 --branch v4.5.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

@@ -127,6 +127,8 @@ Layout/BeginEndAlignment:
   Enabled: true
 Layout/EmptyLinesAroundAttributeAccessor:
   Enabled: true
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
 Layout/SpaceAroundMethodCallOperator:
   Enabled: true
 Layout/MultilineMethodCallIndentation:

data/CHANGELOG.md

@@ -13,6 +13,21 @@ Note: These changes are not considered notable:
 
 ## [Unreleased]
 
+## [5.0.1] - 2024-03-27
+### Changed
+- make user-agent headers more descriptive (#168)
+
+### Fixed
+- make client more resilient to non-conforming responses from `unleash-edge` (#162)
+  - while the unleash server provides always valid responses, (at least some versions of) unleash-edge can provide an unexpected JSON response (null instead of empty array).
+  - fixed the handling of the response, so we do not throw exceptions in this situation.
+
+## [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)

data/README.md

@@ -10,6 +10,7 @@ Leverage the [Unleash Server](https://github.com/Unleash/unleash) for powerful f
 
 ## Supported Ruby Interpreters
 
+  * MRI 3.3
   * MRI 3.2
   * MRI 3.1
   * MRI 3.0
@@ -25,7 +26,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.6.0'
+gem 'unleash', '~> 5.0.0'
 ```
 
 And then execute:
@@ -528,7 +529,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.5.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.
 
@@ -555,3 +556,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/examples/extending_unleash_with_opentelemetry.rb

@@ -0,0 +1,63 @@
+# example on how to extend the unleash client with opentelemetry by monkey patching it.
+# to be added before initializing the client.
+# in rails it could be added, for example, at:
+# config/initializers/unleash.rb
+
+require 'opentelemetry-api'
+require 'unleash'
+
+module UnleashExtensions
+  module OpenTelemetry
+    TRACER = ::OpenTelemetry.tracer_provider.tracer('Unleash-Client', Unleash::VERSION)
+
+    module Client
+      def initialize(*opts)
+        UnleashExtensions::OpenTelemetry::TRACER.in_span("#{self.class.name}##{__method__}") do |_span|
+          super(*opts)
+        end
+      end
+
+      def is_enabled?(feature, *args)
+        UnleashExtensions::OpenTelemetry::TRACER.in_span("#{self.class.name}##{__method__}") do |span|
+          result = super(feature, *args)
+
+          # OpenTelemetry::SemanticConventions::Trace::FEATURE_FLAG_* is not in the `opentelemetry-semantic_conventions` gem yet
+          span.add_attributes({
+            'feature_flag.provider_name' => 'Unleash',
+            'feature_flag.key' => feature,
+            'feature_flag.variant' => result
+          })
+
+          result
+        end
+      end
+    end
+  end
+
+  module MetricsReporter
+    def post
+      UnleashExtensions::OpenTelemetry::TRACER.in_span("#{self.class.name}##{__method__}") do |_span|
+        super
+      end
+    end
+  end
+
+  module ToggleFetcher
+    def fetch
+      UnleashExtensions::OpenTelemetry::TRACER.in_span("#{self.class.name}##{__method__}") do |_span|
+        super
+      end
+    end
+
+    def save!
+      UnleashExtensions::OpenTelemetry::TRACER.in_span("#{self.class.name}##{__method__}") do |_span|
+        super
+      end
+    end
+  end
+end
+
+# MonkeyPatch here:
+::Unleash::Client.prepend UnleashExtensions::OpenTelemetry::Client
+::Unleash::MetricsReporter.prepend UnleashExtensions::OpenTelemetry::MetricsReporter
+::Unleash::ToggleFetcher.prepend UnleashExtensions::OpenTelemetry::ToggleFetcher

data/lib/unleash/configuration.rb

@@ -51,9 +51,10 @@ module Unleash
 
     def http_headers
       {
+        'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",
         'UNLEASH-INSTANCEID' => self.instance_id,
         'UNLEASH-APPNAME' => self.app_name,
-        'Unleash-Client-Spec' => '4.5.1'
+        '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

@@ -163,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
@@ -188,7 +189,7 @@ module Unleash
     end
 
     def initialize_strategies(params, segment_map)
-      params.fetch('strategies', [])
+      (params.fetch('strategies', []) || [])
         .select{ |s| s.has_key?('name') && Unleash.strategies.includes?(s['name']) }
         .map do |s|
           ActivationStrategy.new(
@@ -201,7 +202,7 @@ module Unleash
     end
 
     def resolve_variants(strategy)
-      strategy.fetch("variants", [])
+      (strategy.fetch("variants", []) || [])
         .select{ |variant| variant.is_a?(Hash) && variant.has_key?("name") }
         .map do |variant|
           VariantDefinition.new(

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.6.0".freeze
+  VERSION = "5.0.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unleash
 version: !ruby/object:Gem::Version
-  version: 4.6.0
+  version: 5.0.1
 platform: ruby
 authors:
 - Renato Arruda
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-16 00:00:00.000000000 Z
+date: 2024-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: murmurhash3
@@ -162,6 +162,7 @@ files:
 - bin/unleash-client
 - examples/bootstrap.rb
 - examples/default-toggles.json
+- examples/extending_unleash_with_opentelemetry.rb
 - examples/simple.rb
 - lib/unleash.rb
 - lib/unleash/activation_strategy.rb
@@ -200,7 +201,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
@@ -215,8 +216,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.15
-signing_key:
+rubygems_version: 3.3.3
+signing_key: 
 specification_version: 4
 summary: Unleash feature toggle client.
 test_files: []