unleash 4.4.4 → 6.4.0

data/lib/unleash/streaming_client_executor.rb

@@ -0,0 +1,85 @@
+require 'unleash/streaming_event_processor'
+require 'unleash/util/event_source_wrapper'
+
+module Unleash
+  class StreamingClientExecutor
+    attr_accessor :name, :event_source, :event_processor, :running
+
+    def initialize(name, engine)
+      self.name = name || 'StreamingClientExecutor'
+      self.event_source = nil
+      self.event_processor = Unleash::StreamingEventProcessor.new(engine)
+      self.running = false
+    end
+
+    def run(&_block)
+      start
+    end
+
+    def start
+      return if self.running || Unleash.configuration.disable_client
+
+      Unleash.logger.debug "Streaming client #{self.name} starting connection to: #{Unleash.configuration.fetch_toggles_uri}"
+
+      self.event_source = create_event_source
+      setup_event_handlers
+
+      self.running = true
+      Unleash.logger.debug "Streaming client #{self.name} connection established"
+    end
+
+    def stop
+      return unless self.running
+
+      Unleash.logger.debug "Streaming client #{self.name} stopping connection"
+      self.running = false
+      self.event_source&.close
+      self.event_source = nil
+      Unleash.logger.debug "Streaming client #{self.name} connection closed"
+    end
+
+    alias exit stop
+
+    def running?
+      self.running
+    end
+
+    private
+
+    def create_event_source
+      sse_client = Unleash::Util::EventSourceWrapper.client
+      if sse_client.nil?
+        raise "Streaming mode is configured but EventSource client is not available. " \
+              "Please install the 'ld-eventsource' gem or switch to polling mode."
+      end
+
+      headers = (Unleash.configuration.http_headers || {}).dup
+
+      sse_client.new(
+        Unleash.configuration.fetch_toggles_uri.to_s,
+        headers: headers,
+        read_timeout: 60,
+        reconnect_time: 2,
+        connect_timeout: 10,
+        logger: Unleash.logger
+      )
+    end
+
+    def setup_event_handlers
+      self.event_source.on_event do |event|
+        handle_event(event)
+      end
+
+      self.event_source.on_error do |error|
+        Unleash.logger.warn "Streaming client #{self.name} error: #{error}"
+      end
+    end
+
+    def handle_event(event)
+      self.event_processor.process_event(event)
+    rescue StandardError => e
+      Unleash.logger.error "Streaming client #{self.name} threw exception #{e.class}: '#{e}'"
+      Unleash.logger.debug "stacktrace: #{e.backtrace}"
+    end
+  end
+end

data/lib/unleash/streaming_event_processor.rb

@@ -0,0 +1,53 @@
+require 'json'
+
+module Unleash
+  class StreamingEventProcessor
+    attr_accessor :toggle_engine, :mutex
+
+    def initialize(toggle_engine)
+      self.toggle_engine = toggle_engine
+      self.mutex = Mutex.new
+    end
+
+    def process_event(event)
+      case event.type.to_s
+      when 'unleash-connected'
+        Unleash.logger.debug "Streaming client connected"
+        handle_connected_event(event)
+      when 'unleash-updated'
+        Unleash.logger.debug "Received streaming update"
+        handle_updated_event(event)
+      else
+        Unleash.logger.debug "Received unknown event type: #{event.type}"
+      end
+    rescue StandardError => e
+      Unleash.logger.error "Error handling streaming event threw exception #{e.class}: '#{e}'"
+      Unleash.logger.debug "stacktrace: #{e.backtrace}"
+    end
+
+    def handle_delta_event(event_data)
+      self.mutex.synchronize do
+        self.toggle_engine.take_state(event_data)
+      end
+    end
+
+    private
+
+    def handle_connected_event(event)
+      Unleash.logger.debug "Processing initial hydration data"
+      handle_updated_event(event)
+    end
+
+    def handle_updated_event(event)
+      handle_delta_event(event.data)
+
+      # TODO: update backup file
+    rescue JSON::ParserError => e
+      Unleash.logger.error "Unable to parse JSON from streaming event data. Exception thrown #{e.class}: '#{e}'"
+      Unleash.logger.debug "stacktrace: #{e.backtrace}"
+    rescue StandardError => e
+      Unleash.logger.error "Error processing delta update threw exception #{e.class}: '#{e}'"
+      Unleash.logger.debug "stacktrace: #{e.backtrace}"
+    end
+  end
+end

data/lib/unleash/toggle_fetcher.rb

@@ -2,15 +2,15 @@ require 'unleash/configuration'
 require 'unleash/bootstrap/handler'
 require 'net/http'
 require 'json'
+require 'yggdrasil_engine'
 
 module Unleash
   class ToggleFetcher
-    attr_accessor :toggle_cache, :toggle_lock, :toggle_resource, :etag, :retry_count, :segment_cache
+    attr_accessor :toggle_engine, :toggle_lock, :toggle_resource, :etag, :retry_count
 
-    def initialize
+    def initialize(engine)
+      self.toggle_engine = engine
       self.etag = nil
-      self.toggle_cache = nil
-      self.segment_cache = nil
       self.toggle_lock = Mutex.new
       self.toggle_resource = ConditionVariable.new
       self.retry_count = 0
@@ -32,39 +32,32 @@ module Unleash
       # once initialized, somewhere else you will want to start a loop with fetch()
     end
 
-    def toggles
-      self.toggle_lock.synchronize do
-        # wait for resource, only if it is null
-        self.toggle_resource.wait(self.toggle_lock) if self.toggle_cache.nil?
-        return self.toggle_cache
-      end
-    end
-
     # rename to refresh_from_server!  ??
     def fetch
       Unleash.logger.debug "fetch()"
       return if Unleash.configuration.disable_client
 
-      response = Unleash::Util::Http.get(Unleash.configuration.fetch_toggles_uri, etag)
+      headers = (Unleash.configuration.http_headers || {}).dup
+      headers.merge!({ 'UNLEASH-INTERVAL' => Unleash.configuration.refresh_interval.to_s })
+      response = Unleash::Util::Http.get(Unleash.configuration.fetch_toggles_uri, etag, headers)
 
       if response.code == '304'
         Unleash.logger.debug "No changes according to the unleash server, nothing to do."
         return
       elsif response.code != '200'
-        raise IOError, "Unleash server returned a non 200/304 HTTP result."
+        raise IOError, "Unleash server returned unexpected HTTP response code #{response.code}."\
+          " Only handle response codes 200 (indicates changes) or 304 (no changes)."
       end
 
       self.etag = response['ETag']
-      features = get_features(response.body)
 
       # always synchronize with the local cache when fetching:
-      synchronize_with_local_cache!(features)
+      update_engine_state!(response.body)
 
-      update_running_client!
-      save!
+      save! response.body
     end
 
-    def save!
+    def save!(toggle_data)
       Unleash.logger.debug "Will save toggles to disk now"
 
       backup_file = Unleash.configuration.backup_file
@@ -72,7 +65,7 @@ module Unleash
 
       self.toggle_lock.synchronize do
         File.open(backup_file_tmp, "w") do |file|
-          file.write(self.toggle_cache.to_json)
+          file.write(toggle_data)
         end
         File.rename(backup_file_tmp, backup_file)
       end
@@ -84,23 +77,15 @@ module Unleash
 
     private
 
-    def synchronize_with_local_cache!(features)
-      if self.toggle_cache != features
-        self.toggle_lock.synchronize do
-          self.toggle_cache = features
-        end
-
-        # notify all threads waiting for this resource to no longer wait
-        self.toggle_resource.broadcast
+    def update_engine_state!(toggle_data)
+      self.toggle_lock.synchronize do
+        self.toggle_engine.take_state(toggle_data)
       end
-    end
 
-    def update_running_client!
-      if Unleash.toggles != self.toggles["features"] || Unleash.segment_cache != self.toggles["segments"]
-        Unleash.logger.info "Updating toggles to main client, there has been a change in the server."
-        Unleash.toggles = self.toggles["features"]
-        Unleash.segment_cache = self.toggles["segments"]
-      end
+      # notify all threads waiting for this resource to no longer wait
+      self.toggle_resource.broadcast
+    rescue StandardError => e
+      Unleash.logger.error "Failed to hydrate state: #{e.backtrace}"
     end
 
     def read!
@@ -108,42 +93,28 @@ module Unleash
       backup_file = Unleash.configuration.backup_file
       return nil unless File.exist?(backup_file)
 
-      backup_as_hash = JSON.parse(File.read(backup_file))
-      synchronize_with_local_cache!(backup_as_hash)
-      update_running_client!
+      backup_data = File.read(backup_file)
+      update_engine_state!(backup_data)
     rescue IOError => e
+      # :nocov:
       Unleash.logger.error "Unable to read the backup_file: #{e}"
+      # :nocov:
     rescue JSON::ParserError => e
+      # :nocov:
       Unleash.logger.error "Unable to parse JSON from existing backup_file: #{e}"
+      # :nocov:
     rescue StandardError => e
+      # :nocov:
       Unleash.logger.error "Unable to extract valid data from backup_file. Exception thrown: #{e}"
+      # :nocov:
     end
 
     def bootstrap
       bootstrap_payload = Unleash::Bootstrap::Handler.new(Unleash.configuration.bootstrap_config).retrieve_toggles
-      synchronize_with_local_cache! get_features bootstrap_payload
-      update_running_client!
+      update_engine_state! bootstrap_payload
 
       # reset Unleash.configuration.bootstrap_data to free up memory, as we will never use it again
       Unleash.configuration.bootstrap_config = nil
     end
-
-    def build_segment_map(segments_array)
-      return {} if segments_array.nil?
-
-      segments_array.map{ |segment| [segment["id"], segment] }.to_h
-    end
-
-    # @param response_body [String]
-    def get_features(response_body)
-      response_hash = JSON.parse(response_body)
-
-      if response_hash['version'] >= 1
-        return { "features" => response_hash["features"], "segments" => build_segment_map(response_hash["segments"]) }
-      end
-
-      raise NotImplemented, "Version of features provided by unleash server" \
-        " is unsupported by this client."
-    end
   end
 end

data/lib/unleash/util/event_source_wrapper.rb

@@ -0,0 +1,17 @@
+module Unleash
+  module Util
+    module EventSourceWrapper
+      def self.client
+        return nil if RUBY_ENGINE == 'jruby'
+
+        begin
+          require 'ld-eventsource'
+          SSE::Client
+        rescue LoadError => e
+          Unleash.logger.error "Failed to load ld-eventsource: #{e.message}"
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/unleash/util/http.rb

@@ -12,10 +12,10 @@ module Unleash
         http.request(request)
       end
 
-      def self.post(uri, body)
+      def self.post(uri, body, headers_override = nil)
         http = http_connection(uri)
 
-        request = Net::HTTP::Post.new(uri.request_uri, http_headers)
+        request = Net::HTTP::Post.new(uri.request_uri, http_headers(nil, headers_override))
         request.body = body
 
         http.request(request)
@@ -24,6 +24,7 @@ module Unleash
       def self.http_connection(uri)
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = true if uri.scheme == 'https'
+        http.response_body_encoding = 'UTF-8' if http.respond_to?(:response_body_encoding=)
         http.open_timeout = Unleash.configuration.timeout # in seconds
         http.read_timeout = Unleash.configuration.timeout # in seconds
 

data/lib/unleash/variant.rb

@@ -1,6 +1,6 @@
 module Unleash
   class Variant
-    attr_accessor :name, :enabled, :payload
+    attr_accessor :name, :enabled, :payload, :feature_enabled
 
     def initialize(params = {})
       raise ArgumentError, "Variant initializer requires a hash." unless params.is_a?(Hash)
@@ -8,16 +8,24 @@ module Unleash
       self.name = params.values_at('name', :name).compact.first
       self.enabled = params.values_at('enabled', :enabled).compact.first || false
       self.payload = params.values_at('payload', :payload).compact.first
+      self.feature_enabled = params.values_at('feature_enabled', :feature_enabled).compact.first || false
 
       raise ArgumentError, "Variant requires a name." if self.name.nil?
     end
 
     def to_s
-      "<Variant: name=#{self.name},enabled=#{self.enabled},payload=#{self.payload}>"
+      # :nocov:
+      "<Variant: name=#{self.name},enabled=#{self.enabled},payload=#{self.payload},feature_enabled=#{self.feature_enabled}>"
+      # :nocov:
     end
 
     def ==(other)
-      self.name == other.name && self.enabled == other.enabled && self.payload == other.payload
+      self.name == other.name && self.enabled == other.enabled && self.payload == other.payload \
+        && self.feature_enabled == other.feature_enabled
+    end
+
+    def self.disabled_variant
+      Variant.new(name: 'disabled', enabled: false, feature_enabled: false)
     end
   end
 end

data/lib/unleash/version.rb

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

data/lib/unleash.rb

@@ -1,4 +1,5 @@
 require 'unleash/version'
+require 'unleash/spec_version'
 require 'unleash/configuration'
 require 'unleash/strategies'
 require 'unleash/context'
@@ -9,7 +10,7 @@ module Unleash
   TIME_RESOLUTION = 3
 
   class << self
-    attr_accessor :configuration, :toggle_fetcher, :toggles, :toggle_metrics, :reporter, :segment_cache, :logger
+    attr_accessor :configuration, :toggle_fetcher, :reporter, :logger, :engine
   end
 
   self.configuration = Unleash::Configuration.new

data/unleash-client.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.description   = "This is the ruby client for Unleash, a powerful feature toggle system
     that gives you a great overview over all feature toggles across all your applications and services."
 
-  spec.homepage      = "https://github.com/unleash/unleash-client-ruby"
+  spec.homepage      = "https://github.com/unleash/unleash-ruby-sdk"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -21,9 +21,13 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'bin'
   spec.executables   = spec.files.grep(%r{^bin/unleash}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = ">= 2.5"
+  spec.required_ruby_version = ">= 2.7"
 
-  spec.add_dependency "murmurhash3", "~> 0.1.7"
+  spec.add_dependency "ld-eventsource", "2.2.4" unless RUBY_ENGINE == 'jruby'
+  spec.add_dependency "yggdrasil-engine", "~> 1.0.4"
+
+  spec.add_dependency "base64", "~> 0.3.0"
+  spec.add_dependency "logger", "~> 1.6"
 
   spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "rake", "~> 12.3"
@@ -33,7 +37,7 @@ Gem::Specification.new do |spec|
 
   # rubocop:disable Gemspec/RubyVersionGlobalsUsage, Style/IfUnlessModifier
   if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('3.0')
-    spec.add_development_dependency "rubocop", "~> 1.51.0"
+    spec.add_development_dependency "rubocop", "~> 1.75"
   end
   # rubocop:enable Gemspec/RubyVersionGlobalsUsage, Style/IfUnlessModifier
 

data/v6_MIGRATION_GUIDE.md

@@ -0,0 +1,21 @@
+# Migrating to Unleash-Client-Ruby 6.0.0
+
+This guide highlights the key changes you should be aware of when upgrading to v6.0.0 of the Unleash client.
+
+## Custom strategy changes
+
+In version 6+, custom strategies cannot override the built-in strategies. Specifically, strategies `applicationHostname`, `default`, `flexibleRollout`, `gradualRolloutRandom`, `gradualRolloutSessionId`, `gradualRolloutUserId`, `remoteAddress` or `userWithId` throw an error on startup. Previously, creating a custom strategy would only generate a warning in the logs.
+
+The deprecated `register_custom_strategies` method has been removed. You can continue to [register custom strategies](./README.md#custom-strategies) using configuration.
+
+## Direct access to strategy objects
+
+**Note:** If you're not using the method `known_strategies` this section doesn't affect you
+
+The objects for base strategies are no longer directly accessible via the SDK. The `known_strategies` method only returns custom strategies registered by the user. To check if a custom strategy will override either a built-in or custom strategy, use the `includes?` method (returns false if the name is available).
+
+It is strongly discouraged to access or modify any properties of the built-in strategies other than the name. In version 6+, this is a hard requirement.
+
+## ARM requirements
+
+Version 6.0.0 introduces a new dependency on a native binary. Currently, only ARM binaries for macOS are distributed. If you require ARM support for Linux or Windows, please open a GitHub issue.

metadata

@@ -1,29 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: unleash
 version: !ruby/object:Gem::Version
-  version: 4.4.4
+  version: 6.4.0
 platform: ruby
 authors:
 - Renato Arruda
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-05 00:00:00.000000000 Z
+date: 2025-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: murmurhash3
+  name: ld-eventsource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.4
+- !ruby/object:Gem::Dependency
+  name: yggdrasil-engine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.51.0
+        version: '1.75'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.51.0
+        version: '1.75'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -160,11 +202,13 @@ files:
 - bin/console
 - bin/setup
 - bin/unleash-client
+- echo_client_spec_version.rb
 - examples/bootstrap.rb
 - examples/default-toggles.json
+- examples/extending_unleash_with_opentelemetry.rb
 - examples/simple.rb
+- examples/streaming.rb
 - lib/unleash.rb
-- lib/unleash/activation_strategy.rb
 - lib/unleash/bootstrap/configuration.rb
 - lib/unleash/bootstrap/handler.rb
 - lib/unleash/bootstrap/provider/base.rb
@@ -172,31 +216,21 @@ files:
 - lib/unleash/bootstrap/provider/from_url.rb
 - lib/unleash/client.rb
 - lib/unleash/configuration.rb
-- lib/unleash/constraint.rb
 - lib/unleash/context.rb
-- lib/unleash/feature_toggle.rb
-- lib/unleash/metrics.rb
 - lib/unleash/metrics_reporter.rb
 - lib/unleash/scheduled_executor.rb
+- lib/unleash/spec_version.rb
 - lib/unleash/strategies.rb
-- lib/unleash/strategy/application_hostname.rb
-- lib/unleash/strategy/base.rb
-- lib/unleash/strategy/default.rb
-- lib/unleash/strategy/flexible_rollout.rb
-- lib/unleash/strategy/gradual_rollout_random.rb
-- lib/unleash/strategy/gradual_rollout_sessionid.rb
-- lib/unleash/strategy/gradual_rollout_userid.rb
-- lib/unleash/strategy/remote_address.rb
-- lib/unleash/strategy/user_with_id.rb
-- lib/unleash/strategy/util.rb
+- lib/unleash/streaming_client_executor.rb
+- lib/unleash/streaming_event_processor.rb
 - lib/unleash/toggle_fetcher.rb
+- lib/unleash/util/event_source_wrapper.rb
 - lib/unleash/util/http.rb
 - lib/unleash/variant.rb
-- lib/unleash/variant_definition.rb
-- lib/unleash/variant_override.rb
 - lib/unleash/version.rb
 - unleash-client.gemspec
-homepage: https://github.com/unleash/unleash-client-ruby
+- v6_MIGRATION_GUIDE.md
+homepage: https://github.com/unleash/unleash-ruby-sdk
 licenses:
 - Apache-2.0
 metadata: {}
@@ -208,14 +242,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.15
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Unleash feature toggle client.

data/lib/unleash/activation_strategy.rb

@@ -1,31 +0,0 @@
-module Unleash
-  class ActivationStrategy
-    attr_accessor :name, :params, :constraints, :disabled
-
-    def initialize(name, params, constraints = [])
-      self.name = name
-      self.disabled = false
-
-      if params.is_a?(Hash)
-        self.params = params
-      elsif params.nil?
-        self.params = {}
-      else
-        Unleash.logger.warn "Invalid params provided for ActivationStrategy (params:#{params})"
-        self.params = {}
-      end
-
-      if constraints.is_a?(Array) && constraints.each{ |c| c.is_a?(Constraint) }
-        self.constraints = constraints
-      else
-        Unleash.logger.warn "Invalid constraints provided for ActivationStrategy (contraints: #{constraints})"
-        self.disabled = true
-        self.constraints = []
-      end
-    end
-
-    def matches_context?(context)
-      self.constraints.any?{ |c| c.matches_context? context }
-    end
-  end
-end