unleash 5.1.0 → 6.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de31279816b192452208e5e6d84af40a0ccee9fc7a7d99d517e48af20f9da21b
-  data.tar.gz: 16405b9809031a5684a9ace670bdcb9606fe74eb7a162c89212131dac5064fe2
+  metadata.gz: 518b79d43627fa6a3de4b59eb7e6f445ebb09a7f8e96f963765ada55c827ac5b
+  data.tar.gz: c1c284bee319185697a6eb16d0b10d62c141372b708baa34ad4de682795db1cc
 SHA512:
-  metadata.gz: 1e9f734bb3814598f3bfe600f3338c049a974168150cacdb26a90db6a768ff060a89ed647e12e57bb978b74fbc99054f702560b924da57e7322a94365de75a49
-  data.tar.gz: '0274169ed17a2357e080af55265fbe80632fb3acd041e303cd321f844ce0372102a7e8b88c3ab71ba01efcfccb8dbd9eafab37b001b7b66c038a81fb6748b048'
+  metadata.gz: c17939c596ca7523d6d6abec6f36041555fcfbed36bfadcb105a7d6704822a85c3e673f53db23cedcdf560181591b69ec8b8f4bc009a29e6f4cbf39a943b0dda
+  data.tar.gz: d61f27c3cf5e726bbcc85401512a3009b9ccfbaa289b12ebf930af30fe6606c340eed26b57aba84425cafcc792120bcf003e36512d56168ca7d2cac75eff9d90

data/CHANGELOG.md

@@ -13,6 +13,16 @@ Note: These changes are not considered notable:
 
 ## [Unreleased]
 
+## [6.0.0.pre] - 2024-09-25
+#### Changed
+- No longer possible to override built in strategies with custom strategies (#152)
+- No longer possible to access built in strategy's objects, these are now native code (#152)
+- Core of the SDK swapped for Yggdrasil engine (#152)
+
+## [5.1.1] - 2024-09-23
+### Fixed
+- increased accuracy of rollout distribution (#200)
+
 ## [5.1.0] - 2024-09-18
 ### Added
 - feature_enabled in variants (#197)

data/README.md

@@ -48,7 +48,7 @@ Ruby client for the [Unleash](https://github.com/Unleash/unleash) feature manage
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'unleash', '~> 5.1.0'
+gem 'unleash', '~> 5.1.1'
 ```
 
 And then execute:
@@ -426,7 +426,7 @@ Note: `if_enabled` (and `if_disabled`) only support `default_value`, but not `fa
 
 #### Variations
 
-If no variant is found in the server, use the fallback variant.
+If no flag is found in the server, use the fallback variant.
 
 ```ruby
 fallback_variant = Unleash::Variant.new(name: 'default', enabled: true, payload: {"color" => "blue"})

data/lib/unleash/client.rb

@@ -2,7 +2,7 @@ require 'unleash/configuration'
 require 'unleash/toggle_fetcher'
 require 'unleash/metrics_reporter'
 require 'unleash/scheduled_executor'
-require 'unleash/feature_toggle'
+require 'unleash/variant'
 require 'unleash/util/http'
 require 'logger'
 require 'time'
@@ -11,14 +11,17 @@ module Unleash
   class Client
     attr_accessor :fetcher_scheduled_executor, :metrics_scheduled_executor
 
+    # rubocop:disable Metrics/AbcSize
     def initialize(*opts)
       Unleash.configuration = Unleash::Configuration.new(*opts) unless opts.empty?
       Unleash.configuration.validate!
 
       Unleash.logger = Unleash.configuration.logger.clone
       Unleash.logger.level = Unleash.configuration.log_level
+      Unleash.engine = YggdrasilEngine.new
+      Unleash.engine.register_custom_strategies(Unleash.configuration.strategies.custom_strategies)
 
-      Unleash.toggle_fetcher = Unleash::ToggleFetcher.new
+      Unleash.toggle_fetcher = Unleash::ToggleFetcher.new Unleash.engine
       if Unleash.configuration.disable_client
         Unleash.logger.warn "Unleash::Client is disabled! Will only return default (or bootstrapped if available) results!"
         Unleash.logger.warn "Unleash::Client is disabled! Metrics and MetricsReporter are also disabled!"
@@ -30,6 +33,7 @@ module Unleash
       start_toggle_fetcher
       start_metrics unless Unleash.configuration.disable_metrics
     end
+    # rubocop:enable Metrics/AbcSize
 
     def is_enabled?(feature, context = nil, default_value_param = false, &fallback_blk)
       Unleash.logger.debug "Unleash::Client.is_enabled? feature: #{feature} with context #{context}"
@@ -40,15 +44,16 @@ module Unleash
                         default_value_param
                       end
 
-      toggle_as_hash = Unleash&.toggles&.select{ |toggle| toggle['name'] == feature }&.first
-      if toggle_as_hash.nil?
+      toggle_enabled = Unleash.engine.enabled?(feature, context)
+      if toggle_enabled.nil?
         Unleash.logger.debug "Unleash::Client.is_enabled? feature: #{feature} not found"
+        Unleash.engine.count_toggle(feature, false)
         return default_value
       end
 
-      toggle = Unleash::FeatureToggle.new(toggle_as_hash, Unleash&.segment_cache)
+      Unleash.engine.count_toggle(feature, toggle_enabled)
 
-      toggle.is_enabled?(context)
+      toggle_enabled
     end
 
     def is_disabled?(feature, context = nil, default_value_param = true, &fallback_blk)
@@ -71,23 +76,19 @@ module Unleash
     end
 
     def get_variant(feature, context = Unleash::Context.new, fallback_variant = disabled_variant)
-      Unleash.logger.debug "Unleash::Client.get_variant for feature: #{feature} with context #{context}"
-
-      toggle_as_hash = Unleash&.toggles&.select{ |toggle| toggle['name'] == feature }&.first
-
-      if toggle_as_hash.nil?
-        Unleash.logger.debug "Unleash::Client.get_variant feature: #{feature} not found"
-        return fallback_variant
-      end
-
-      toggle = Unleash::FeatureToggle.new(toggle_as_hash, Unleash&.segment_cache)
-      variant = toggle.get_variant(context, fallback_variant)
+      variant = Unleash.engine.get_variant(feature, context)
 
       if variant.nil?
         Unleash.logger.debug "Unleash::Client.get_variant variants for feature: #{feature} not found"
+        Unleash.engine.count_toggle(feature, false)
         return fallback_variant
       end
 
+      variant = Variant.new(variant)
+
+      Unleash.engine.count_variant(feature, variant.name)
+      Unleash.engine.count_toggle(feature, variant.feature_enabled)
+
       # TODO: Add to README: name, payload, enabled (bool)
 
       variant
@@ -96,7 +97,6 @@ module Unleash
     # safe shutdown: also flush metrics to server and toggles to disk
     def shutdown
       unless Unleash.configuration.disable_client
-        Unleash.toggle_fetcher.save!
         Unleash.reporter.post unless Unleash.configuration.disable_metrics
         shutdown!
       end
@@ -117,12 +117,12 @@ module Unleash
         'appName': Unleash.configuration.app_name,
         'instanceId': Unleash.configuration.instance_id,
         'sdkVersion': "unleash-client-ruby:" + Unleash::VERSION,
-        'strategies': Unleash.strategies.keys,
+        'strategies': Unleash.strategies.known_strategies,
         'started': Time.now.iso8601(Unleash::TIME_RESOLUTION),
         'interval': Unleash.configuration.metrics_interval_in_millis,
         'platformName': RUBY_ENGINE,
         'platformVersion': RUBY_VERSION,
-        'yggdrasilVersion': nil,
+        'yggdrasilVersion': "0.13.2",
         'specVersion': Unleash::CLIENT_SPECIFICATION_VERSION
       }
     end
@@ -140,7 +140,6 @@ module Unleash
     end
 
     def start_metrics
-      Unleash.toggle_metrics = Unleash::Metrics.new
       Unleash.reporter = Unleash::MetricsReporter.new
       self.metrics_scheduled_executor = Unleash::ScheduledExecutor.new(
         'MetricsReporter',
@@ -166,7 +165,7 @@ module Unleash
     end
 
     def disabled_variant
-      @disabled_variant ||= Unleash::FeatureToggle.disabled_variant
+      @disabled_variant ||= Unleash::Variant.disabled_variant
     end
 
     def first_fetch_is_eager

data/lib/unleash/configuration.rb

@@ -40,9 +40,9 @@ module Unleash
     def validate!
       return if self.disable_client
 
-      raise ArgumentError, "URL and app_name are required parameters." if self.app_name.nil? || self.url.nil?
+      raise ArgumentError, "app_name is a required parameter." if self.app_name.nil?
 
-      validate_custom_http_headers!(self.custom_http_headers)
+      validate_custom_http_headers!(self.custom_http_headers) unless self.url.nil?
     end
 
     def refresh_backup_file!

data/lib/unleash/context.rb

@@ -7,20 +7,36 @@ module Unleash
     def initialize(params = {})
       raise ArgumentError, "Unleash::Context must be initialized with a hash." unless params.is_a?(Hash)
 
-      self.app_name    = value_for('appName', params, Unleash&.configuration&.app_name)
-      self.environment = value_for('environment', params, Unleash&.configuration&.environment || 'default')
-      self.user_id     = value_for('userId', params)&.to_s
-      self.session_id  = value_for('sessionId', params)
-      self.remote_address = value_for('remoteAddress', params)
-      self.current_time = value_for('currentTime', params, Time.now.utc.iso8601.to_s)
-
-      properties = value_for('properties', params)
+      self.app_name = value_for("appName", params, Unleash&.configuration&.app_name)
+      self.environment = value_for("environment", params, Unleash&.configuration&.environment || "default")
+      self.user_id = value_for("userId", params)&.to_s
+      self.session_id = value_for("sessionId", params)
+      self.remote_address = value_for("remoteAddress", params)
+      self.current_time = value_for("currentTime", params, Time.now.utc.iso8601.to_s)
+
+      properties = value_for("properties", params)
       self.properties = properties.is_a?(Hash) ? properties.transform_keys(&:to_sym) : {}
     end
 
     def to_s
       "<Context: user_id=#{@user_id},session_id=#{@session_id},remote_address=#{@remote_address},properties=#{@properties}" \
-        ",app_name=#{@app_name},environment=#{@environment},current_time=#{@current_time}>"
+      ",app_name=#{@app_name},environment=#{@environment},current_time=#{@current_time}>"
+    end
+
+    def as_json
+      {
+        appName: to_safe_value(self.app_name),
+        environment: to_safe_value(self.environment),
+        userId: to_safe_value(self.user_id),
+        sessionId: to_safe_value(self.session_id),
+        remoteAddress: to_safe_value(self.remote_address),
+        currentTime: to_safe_value(self.current_time),
+        properties: self.properties.transform_values{ |value| to_safe_value(value) }
+      }
+    end
+
+    def to_json(*options)
+      as_json(*options).to_json(*options)
     end
 
     def to_h
@@ -52,6 +68,16 @@ module Unleash
       params.values_at(key, key.to_sym, underscore(key), underscore(key).to_sym).compact.first || default_value
     end
 
+    def to_safe_value(value)
+      return nil if value.nil?
+
+      if value.is_a?(Time)
+        value.utc.iso8601
+      else
+        value.to_s
+      end
+    end
+
     # converts CamelCase to snake_case
     def underscore(camel_cased_word)
       camel_cased_word.to_s.gsub(/(.)([A-Z])/, '\1_\2').downcase

data/lib/unleash/metrics_reporter.rb

@@ -1,5 +1,4 @@
 require 'unleash/configuration'
-require 'unleash/metrics'
 require 'net/http'
 require 'json'
 require 'time'
@@ -15,52 +14,39 @@ module Unleash
     end
 
     def generate_report
-      now = Time.now
+      metrics = Unleash&.engine&.get_metrics()
+      return nil if metrics.nil? || metrics.empty?
 
-      start = self.last_time
-      stop  = now
-      self.last_time = now
-
-      report = {
-        'appName': Unleash.configuration.app_name,
-        'instanceId': Unleash.configuration.instance_id,
+      {
         'platformName': RUBY_ENGINE,
         'platformVersion': RUBY_VERSION,
-        'yggdrasilVersion': nil,
+        'yggdrasilVersion': "0.13.2",
         'specVersion': Unleash::CLIENT_SPECIFICATION_VERSION,
-        'bucket': {
-          'start': start.iso8601(Unleash::TIME_RESOLUTION),
-          'stop': stop.iso8601(Unleash::TIME_RESOLUTION),
-          'toggles': Unleash.toggle_metrics.features
-        }
+        'appName': Unleash.configuration.app_name,
+        'instanceId': Unleash.configuration.instance_id,
+        'bucket': metrics
       }
-      Unleash.toggle_metrics.reset
-
-      report
     end
 
     def post
       Unleash.logger.debug "post() Report"
 
-      if bucket_empty? && (Time.now - self.last_time < LONGEST_WITHOUT_A_REPORT) # and last time is less then 10 minutes...
+      bucket = self.generate_report
+      if bucket.nil? && (Time.now - self.last_time < LONGEST_WITHOUT_A_REPORT) # and last time is less then 10 minutes...
         Unleash.logger.debug "Report not posted to server, as it would have been empty. (and has been empty for up to 10 min)"
 
         return
       end
 
-      response = Unleash::Util::Http.post(Unleash.configuration.client_metrics_uri, self.generate_report.to_json)
+      response = Unleash::Util::Http.post(Unleash.configuration.client_metrics_uri, bucket.to_json)
 
       if ['200', '202'].include? response.code
         Unleash.logger.debug "Report sent to unleash server successfully. Server responded with http code #{response.code}"
       else
+        # :nocov:
         Unleash.logger.error "Error when sending report to unleash server. Server responded with http code #{response.code}."
+        # :nocov:
       end
     end
-
-    private
-
-    def bucket_empty?
-      Unleash.toggle_metrics.features.empty?
-    end
   end
 end

data/lib/unleash/strategies.rb

@@ -1,92 +1,33 @@
-require 'unleash/strategy/base'
-Gem.find_files('unleash/strategy/**/*.rb').each{ |path| require path }
-
 module Unleash
+  class DefaultOverrideError < RuntimeError
+  end
+
   class Strategies
+    attr_accessor :strategies
+
     def initialize
       @strategies = {}
-      register_strategies
-    end
-
-    def keys
-      @strategies.keys
     end
 
     def includes?(name)
-      @strategies.has_key?(name.to_s)
-    end
-
-    def fetch(name)
-      raise Unleash::Strategy::NotImplemented, "Strategy is not implemented" unless (strategy = @strategies[name.to_s])
-
-      strategy
+      @strategies.has_key?(name.to_s) || DEFAULT_STRATEGIES.include?(name.to_s)
     end
 
     def add(strategy)
-      if default_strategy_names.include?(strategy.name)
-        Unleash.logger.error "WARNING: Overriding built in strategy '#{strategy.name}'. OVERIDING BUILT IN STRATEGIES IS \
-DEPRECATED AND WILL BE REMOVED IN A FUTURE RELEASE."
-      end
-      self.internal_add(strategy)
-    end
-
-    def []=(key, strategy)
-      warn_deprecated_registration(strategy, 'modifying Unleash::STRATEGIES')
-      @strategies[key.to_s] = strategy
-    end
+      raise DefaultOverrideError, "Cannot override a default strategy" if DEFAULT_STRATEGIES.include?(strategy.name)
 
-    def [](key)
-      @strategies[key.to_s]
-    end
-
-    def register_strategies
-      register_base_strategies
-      register_custom_strategies
-    end
-
-    protected
-
-    # Deprecated: Use Unleash.configuration to add custom strategies
-    def register_custom_strategies
-      Unleash::Strategy.constants
-        .select{ |c| Unleash::Strategy.const_get(c).is_a? Class }
-        .reject{ |c| ['NotImplemented', 'Base'].include?(c.to_s) } # Reject abstract classes
-        .map{ |c| Object.const_get("Unleash::Strategy::#{c}") }
-        .reject{ |c| DEFAULT_STRATEGIES.include?(c) } # Reject base classes
-        .each do |c|
-        strategy = c.new
-        warn_deprecated_registration(strategy, 'adding custom class into Unleash::Strategy namespace')
-        self.internal_add(strategy)
-      end
-    end
-
-    def register_base_strategies
-      DEFAULT_STRATEGIES.each{ |c| self.internal_add(c.new) }
-    end
-
-    def internal_add(strategy)
       @strategies[strategy.name] = strategy
     end
 
-    def default_strategy_names
-      DEFAULT_STRATEGIES.map{ |strategy_class| strategy_class.new.name }
+    def custom_strategies
+      @strategies.values
     end
 
-    DEFAULT_STRATEGIES = [
-      Unleash::Strategy::ApplicationHostname,
-      Unleash::Strategy::Default,
-      Unleash::Strategy::FlexibleRollout,
-      Unleash::Strategy::GradualRolloutRandom,
-      Unleash::Strategy::GradualRolloutSessionId,
-      Unleash::Strategy::GradualRolloutUserId,
-      Unleash::Strategy::RemoteAddress,
-      Unleash::Strategy::UserWithId
-    ].freeze
-
-    def warn_deprecated_registration(strategy, method)
-      warn "[DEPRECATED] Registering custom Unleash strategy by #{method} is deprecated.
-             Please use Unleash configuration to register custom strategy: " \
-           "`Unleash.configure {|c| c.strategies.add(#{strategy.class.name}.new) }`"
+    def known_strategies
+      @strategies.keys.map{ |key| { name: key } }
     end
+
+    DEFAULT_STRATEGIES = ['applicationHostname', 'default', 'flexibleRollout', 'gradualRolloutRandom', 'gradualRolloutSessionId',
+                          'gradualRolloutUserId', 'remoteAddress', 'userWithId'].freeze
   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,14 +32,6 @@ 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()"
@@ -55,16 +47,14 @@ module Unleash
       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 +62,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 +74,13 @@ 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
     end
 
     def read!
@@ -108,42 +88,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/variant.rb

@@ -14,12 +14,18 @@ module Unleash
     end
 
     def to_s
+      # :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.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 = "5.1.0".freeze
+  VERSION = "6.0.0.pre".freeze
 end

data/lib/unleash.rb

@@ -10,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

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.6"
 
   spec.add_dependency "murmurhash3", "~> 0.1.7"
+  spec.add_dependency "yggdrasil-engine", "~> 0.0.5"
 
   spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "rake", "~> 12.3"