splitclient-rb 8.4.0 → 8.11.0

data/lib/splitclient-rb/engine/synchronizer.rb

@@ -15,6 +15,7 @@ module SplitIoClient
       )
         @splits_repository = repositories[:splits]
         @segments_repository = repositories[:segments]
+        @rule_based_segments_repository = repositories[:rule_based_segments]
         @impressions_repository = repositories[:impressions]
         @events_repository = repositories[:events]
         @config = config
@@ -48,7 +49,7 @@ module SplitIoClient
           events_sender
           start_telemetry_sync_task
         end
-        
+
         impressions_count_sender
         start_unique_keys_tracker_task
       end
@@ -63,12 +64,12 @@ module SplitIoClient
         @segment_fetcher.stop_segments_thread
       end
 
-      def fetch_splits(target_change_number)
-        return if target_change_number <= @splits_repository.get_change_number.to_i
+      def fetch_splits(target_change_number, rbs_target_change_number)
+        return if check_exit_conditions(target_change_number, rbs_target_change_number)
 
         fetch_options = { cache_control_headers: true, till: nil }
 
-        result = attempt_splits_sync(target_change_number,
+        result = attempt_splits_sync(target_change_number, rbs_target_change_number,
                                      fetch_options,
                                      @config.on_demand_fetch_max_retries,
                                      @config.on_demand_fetch_retry_delay_seconds,
@@ -82,8 +83,13 @@ module SplitIoClient
           return
         end
 
-        fetch_options[:till] = target_change_number
-        result = attempt_splits_sync(target_change_number,
+        if target_change_number != 0
+          fetch_options[:till] = target_change_number 
+        else
+          fetch_options[:till] = rbs_target_change_number 
+        end
+
+        result = attempt_splits_sync(target_change_number, rbs_target_change_number,
                                      fetch_options,
                                      ON_DEMAND_FETCH_BACKOFF_MAX_RETRIES,
                                      nil,
@@ -91,12 +97,7 @@ module SplitIoClient
 
         attempts = ON_DEMAND_FETCH_BACKOFF_MAX_RETRIES - result[:remaining_attempts]
 
-        if result[:success]
-          @segment_fetcher.fetch_segments_if_not_exists(result[:segment_names], true) unless result[:segment_names].empty?
-          @config.logger.debug("Refresh completed bypassing the CDN in #{attempts} attempts.") if @config.debug_enabled
-        else
-          @config.logger.debug("No changes fetched after #{attempts} attempts with CDN bypassed.") if @config.debug_enabled
-        end
+        process_result(result, attempts)
       rescue StandardError => e
         @config.log_found_exception(__method__.to_s, e)
       end
@@ -139,6 +140,15 @@ module SplitIoClient
 
       private
 
+      def process_result(result, attempts)
+        if result[:success]
+          @segment_fetcher.fetch_segments_if_not_exists(result[:segment_names], true) unless result[:segment_names].empty?
+          @config.logger.debug("Refresh completed bypassing the CDN in #{attempts} attempts.") if @config.debug_enabled
+        else
+          @config.logger.debug("No changes fetched after #{attempts} attempts with CDN bypassed.") if @config.debug_enabled
+        end
+      end
+
       def attempt_segment_sync(name, target_cn, fetch_options, max_retries, retry_delay_seconds, with_backoff)
         remaining_attempts = max_retries
         @segments_sync_backoff.reset
@@ -156,7 +166,7 @@ module SplitIoClient
         end
       end
 
-      def attempt_splits_sync(target_cn, fetch_options, max_retries, retry_delay_seconds, with_backoff)
+      def attempt_splits_sync(target_cn, rbs_target_cn, fetch_options, max_retries, retry_delay_seconds, with_backoff)
         remaining_attempts = max_retries
         @splits_sync_backoff.reset
 
@@ -165,7 +175,7 @@ module SplitIoClient
 
           result = @split_fetcher.fetch_splits(fetch_options)
 
-          return sync_result(true, remaining_attempts, result[:segment_names]) if target_cn <= @splits_repository.get_change_number
+          return sync_result(true, remaining_attempts, result[:segment_names]) if check_exit_conditions(target_cn, rbs_target_cn)
           return sync_result(false, remaining_attempts, result[:segment_names]) if remaining_attempts <= 0
 
           delay = with_backoff ? @splits_sync_backoff.interval : retry_delay_seconds
@@ -175,7 +185,7 @@ module SplitIoClient
 
       # Starts thread which loops constantly and sends impressions to the Split API
       def impressions_sender
-        ImpressionsSender.new(@impressions_repository, @config, @impressions_api).call unless @config.impressions_mode == :none
+        ImpressionsSender.new(@impressions_repository, @config, @impressions_api).call
       end
 
       # Starts thread which loops constantly and sends events to the Split API
@@ -185,7 +195,7 @@ module SplitIoClient
 
       # Starts thread which loops constantly and sends impressions count to the Split API
       def impressions_count_sender
-        ImpressionsCountSender.new(@config, @impression_counter, @impressions_sender_adapter).call unless @config.impressions_mode == :debug
+        ImpressionsCountSender.new(@config, @impression_counter, @impressions_sender_adapter).call
       end
 
       def start_telemetry_sync_task
@@ -203,9 +213,19 @@ module SplitIoClient
       def sync_splits_and_segments
         @config.logger.debug('Synchronizing feature flags and segments ...') if @config.debug_enabled
         splits_result = @split_fetcher.fetch_splits
-        
+
         splits_result[:success] && @segment_fetcher.fetch_segments
       end
+
+      def check_exit_conditions(target_change_number, rbs_target_change_number)
+        return true if rbs_target_change_number == 0 and target_change_number == 0
+
+        return target_change_number <= @splits_repository.get_change_number.to_i if rbs_target_change_number == 0
+          
+        return rbs_target_change_number <= @rule_based_segments_repository.get_change_number.to_i if target_change_number == 0
+
+        return (target_change_number <= @splits_repository.get_change_number.to_i and rbs_target_change_number <= @rule_based_segments_repository.get_change_number.to_i)
+      end
     end
   end
 end

data/lib/splitclient-rb/helpers/evaluator_helper.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Helpers
+    class EvaluatorHelper
+      def self.matcher_type(condition, segments_repository, rb_segment_repository)
+        matchers = []
+        segments_repository.adapter.pipelined do
+          condition.matchers.each do |matcher|
+            matchers << if matcher[:negate]
+                          condition.negation_matcher(matcher_instance(matcher[:matcherType], condition,
+                                                                      matcher, segments_repository,
+                                                                      rb_segment_repository))
+                        else
+                          matcher_instance(matcher[:matcherType], condition, matcher, segments_repository, rb_segment_repository)
+                        end
+          end
+        end
+        final_matcher = condition.create_condition_matcher(matchers)
+
+        if final_matcher.nil?
+          config.logger.error('Invalid matcher type')
+        else
+          final_matcher
+        end
+        final_matcher
+      end
+
+      def self.matcher_instance(type, condition, matcher, segments_repository, rb_segment_repository)
+        condition.send(
+          "matcher_#{type.downcase}",
+          matcher: matcher, segments_repository: segments_repository, rule_based_segments_repository: rb_segment_repository
+        )
+      end
+    end
+  end
+end

data/lib/splitclient-rb/helpers/repository_helper.rb

@@ -3,7 +3,7 @@
 module SplitIoClient
   module Helpers
     class RepositoryHelper
-      def self.update_feature_flag_repository(feature_flag_repository, feature_flags, change_number, config)
+      def self.update_feature_flag_repository(feature_flag_repository, feature_flags, change_number, config, clear_storage)
         to_add = []
         to_delete = []
         feature_flags.each do |feature_flag|
@@ -13,11 +13,49 @@ module SplitIoClient
             next
           end
 
+          feature_flag = check_missing_elements(feature_flag, config)
+
           config.logger.debug("storing feature flag (#{feature_flag[:name]})") if config.debug_enabled
           to_add.push(feature_flag)
         end
+        feature_flag_repository.clear if clear_storage
         feature_flag_repository.update(to_add, to_delete, change_number)
       end
+
+      def self.check_missing_elements(feature_flag, config)
+        unless feature_flag.key?(:impressionsDisabled)
+          feature_flag[:impressionsDisabled] = false
+          if config.debug_enabled
+            config.logger.debug("feature flag (#{feature_flag[:name]}) does not have impressionsDisabled field, setting it to false")
+          end
+        end
+
+        unless feature_flag.key?(:prerequisites)
+          feature_flag[:prerequisites] = []
+          if config.debug_enabled
+            config.logger.debug("feature flag (#{feature_flag[:name]}) does not have prerequisites field, setting it to empty array")
+          end
+        end
+
+        feature_flag
+      end
+
+      def self.update_rule_based_segment_repository(rule_based_segment_repository, rule_based_segments, change_number, config)
+        to_add = []
+        to_delete = []
+        rule_based_segments.each do |rule_based_segment|
+          if Engine::Models::Split.archived?(rule_based_segment)
+            config.logger.debug("removing rule based segment from store(#{rule_based_segment})") if config.debug_enabled
+            to_delete.push(rule_based_segment)
+            next
+          end
+
+          config.logger.debug("storing rule based segment (#{rule_based_segment[:name]})") if config.debug_enabled
+          to_add.push(rule_based_segment)
+        end
+
+        rule_based_segment_repository.update(to_add, to_delete, change_number)
+      end
     end
   end
 end

data/lib/splitclient-rb/helpers/util.rb

@@ -3,15 +3,24 @@
 module SplitIoClient
   module Helpers
     class Util
-      def self.segment_names_by_feature_flag(feature_flag)
-        feature_flag[:conditions].each_with_object(Set.new) do |condition, names|
+      def self.segment_names_by_object(object, matcher_type)
+        object[:conditions].each_with_object(Set.new) do |condition, names|
           condition[:matcherGroup][:matchers].each do |matcher|
-            next if matcher[:userDefinedSegmentMatcherData].nil?
+            next if matcher[:userDefinedSegmentMatcherData].nil? || matcher[:matcherType] != matcher_type
 
             names << matcher[:userDefinedSegmentMatcherData][:segmentName]
           end
         end
       end
+
+      def self.segment_names_in_rb_segment(object, matcher_type)
+        names = Set.new
+        names.merge segment_names_by_object(object, matcher_type)
+        object[:excluded][:segments].each do |segment|
+          names.add(segment[:name]) if segment[:type] == SplitIoClient::Engine::Models::SegmentType::STANDARD
+        end
+        names
+      end
     end
   end
 end

data/lib/splitclient-rb/managers/split_manager.rb

@@ -107,7 +107,8 @@ module SplitIoClient
           change_number: split[:changeNumber],
           configs: split[:configurations] || {},
           sets: split[:sets] || [],
-          default_treatment: split[:defaultTreatment]
+          default_treatment: split[:defaultTreatment],
+          impressions_disabled: split[:impressionsDisabled]
         }
     end
 

data/lib/splitclient-rb/spec.rb

@@ -3,7 +3,7 @@
 module SplitIoClient
   module Spec
     class FeatureFlags
-      SPEC_VERSION = "1.1"
+      SPEC_VERSION = "1.3"
     end
   end
 end

data/lib/splitclient-rb/split_config.rb

@@ -112,7 +112,7 @@ module SplitIoClient
       @telemetry_service_url = opts[:telemetry_service_url] || SplitConfig.default_telemetry_service_url
 
       @unique_keys_refresh_rate = SplitConfig.default_unique_keys_refresh_rate(@cache_adapter)
-      @unique_keys_cache_max_size = SplitConfig.default_unique_keys_cache_max_size
+      # @unique_keys_cache_max_size = SplitConfig.default_unique_keys_cache_max_size
       @unique_keys_bulk_size = SplitConfig.default_unique_keys_bulk_size(@cache_adapter)
 
       @counter_refresh_rate = SplitConfig.default_counter_refresh_rate(@cache_adapter)
@@ -123,6 +123,8 @@ module SplitIoClient
       @on_demand_fetch_max_retries = SplitConfig.default_on_demand_fetch_max_retries
 
       @flag_sets_filter = SplitConfig.sanitize_flag_set_filter(opts[:flag_sets_filter], @split_validator, opts[:cache_adapter], @logger)
+
+      @fallback_treatments_configuration = SplitConfig.sanitize_fallback_config(opts[:fallback_treatments], @split_validator, @logger)
       startup_log
     end
 
@@ -292,7 +294,7 @@ module SplitIoClient
     attr_accessor :on_demand_fetch_max_retries
 
     attr_accessor :unique_keys_refresh_rate
-    attr_accessor :unique_keys_cache_max_size
+    #attr_accessor :unique_keys_cache_max_size
     attr_accessor :unique_keys_bulk_size
 
     attr_accessor :counter_refresh_rate
@@ -303,6 +305,8 @@ module SplitIoClient
     # @return [Array]
     attr_accessor :flag_sets_filter
 
+    attr_accessor :fallback_treatments_configuration
+
     def self.default_counter_refresh_rate(adapter)
       return 300 if adapter == :redis # Send bulk impressions count - Refresh rate: 5 min.
 
@@ -498,9 +502,9 @@ module SplitIoClient
       900
     end
 
-    def self.default_unique_keys_cache_max_size
-      30000
-    end
+#    def self.default_unique_keys_cache_max_size
+#      30000
+#    end
 
     def self.default_unique_keys_bulk_size(adapter)
       return 2000 if adapter == :redis
@@ -645,6 +649,10 @@ module SplitIoClient
       @mode.equal?(:consumer)
     end
 
+    def sdk_url_overriden?
+      return @base_uri != SplitConfig.default_base_uri
+    end
+    
     #
     # gets the hostname where the sdk gem is running
     #
@@ -693,5 +701,37 @@ module SplitIoClient
 
       return ''.freeze
     end
+
+    def self.sanitize_fallback_config(fallback_config, validator, logger)
+      return fallback_config if fallback_config.nil?
+      
+      processed = Engine::Models::FallbackTreatmentsConfiguration.new
+      if !fallback_config.is_a?(Engine::Models::FallbackTreatmentsConfiguration)
+        logger.warn('Config: fallbackTreatments parameter should be of `FallbackTreatmentsConfiguration` class.')
+        return processed        
+      end
+
+      sanitized_global_fallback_treatment = fallback_config.global_fallback_treatment
+      if !fallback_config.global_fallback_treatment.nil? && !validator.validate_fallback_treatment('Config', fallback_config.global_fallback_treatment)
+        logger.warn('Config: global fallbacktreatment parameter is discarded.')
+        sanitized_global_fallback_treatment = nil
+      end
+
+      sanitized_flag_fallback_treatments = nil
+      if !fallback_config.by_flag_fallback_treatment.nil? && fallback_config.by_flag_fallback_treatment.is_a?(Hash)
+        sanitized_flag_fallback_treatments = Hash.new
+        for feature_name in fallback_config.by_flag_fallback_treatment.keys()
+          if !validator.valid_split_name?('Config', feature_name) || !validator.validate_fallback_treatment('Config', fallback_config.by_flag_fallback_treatment[feature_name])
+            logger.warn("Config: fallback treatment parameter for feature flag #{feature_name} is discarded.")
+            next
+          end   
+
+          sanitized_flag_fallback_treatments[feature_name] = fallback_config.by_flag_fallback_treatment[feature_name]
+        end
+      end          
+      processed = Engine::Models::FallbackTreatmentsConfiguration.new(sanitized_global_fallback_treatment, sanitized_flag_fallback_treatments)
+
+      processed
+    end
   end
 end

data/lib/splitclient-rb/split_factory.rb

@@ -45,6 +45,7 @@ module SplitIoClient
 
       register_factory
 
+      build_events_manager
       build_telemetry_components
       build_flag_sets_filter
       build_repositories
@@ -53,13 +54,13 @@ module SplitIoClient
       build_unique_keys_tracker
       build_impressions_components
 
-      @status_manager = Engine::StatusManager.new(@config)
+      @status_manager = Engine::StatusManager.new(@config, @internal_events_queue)
       @split_validator = SplitIoClient::Validators.new(@config)
-      @evaluator = Engine::Parser::Evaluator.new(@segments_repository, @splits_repository, @config)
+      @evaluator = Engine::Parser::Evaluator.new(@segments_repository, @splits_repository, @rule_based_segment_repository, @config)
 
       start!
-
-      @client = SplitClient.new(@api_key, repositories, @status_manager, @config, @impressions_manager, @evaluation_producer, @evaluator, @split_validator)
+      fallback_treatment_calculator = SplitIoClient::Engine::FallbackTreatmentCalculator.new(@config.fallback_treatments_configuration) 
+      @client = SplitClient.new(@api_key, repositories, @status_manager, @config, @impressions_manager, @evaluation_producer, @evaluator, @split_validator, fallback_treatment_calculator, @events_manager)
       @manager = SplitManager.new(@splits_repository, @status_manager, @config)
     end
 
@@ -154,6 +155,7 @@ module SplitIoClient
         segments: @segments_repository,
         impressions: @impressions_repository,
         events: @events_repository,
+        rule_based_segments: @rule_based_segment_repository
       }
     end
 
@@ -178,7 +180,7 @@ module SplitIoClient
     end
 
     def build_fetchers
-      @split_fetcher = SplitFetcher.new(@splits_repository, @api_key, @config, @runtime_producer)
+      @split_fetcher = SplitFetcher.new(@splits_repository, @rule_based_segment_repository, @api_key, @config, @runtime_producer)
       @segment_fetcher = SegmentFetcher.new(@segments_repository, @api_key, @config, @runtime_producer)
     end
 
@@ -198,7 +200,7 @@ module SplitIoClient
 
     def build_streaming_components
       @push_status_queue = Queue.new
-      splits_worker = SSE::Workers::SplitsWorker.new(@synchronizer, @config, @splits_repository, @runtime_producer, @segment_fetcher)
+      splits_worker = SSE::Workers::SplitsWorker.new(@synchronizer, @config, @splits_repository, @runtime_producer, @segment_fetcher, @rule_based_segment_repository)
       segments_worker = SSE::Workers::SegmentsWorker.new(@synchronizer, @config, @segments_repository)
       notification_manager_keeper = SSE::NotificationManagerKeeper.new(@config, @runtime_producer, @push_status_queue)
       notification_processor = SSE::NotificationProcessor.new(@config, splits_worker, segments_worker)
@@ -218,8 +220,9 @@ module SplitIoClient
       else
         @flag_sets_repository = SplitIoClient::Cache::Repositories::MemoryFlagSetsRepository.new(@config.flag_sets_filter)
       end
-      @splits_repository = SplitsRepository.new(@config, @flag_sets_repository, @flag_sets_filter)
-      @segments_repository = SegmentsRepository.new(@config)
+      @splits_repository = SplitsRepository.new(@config, @flag_sets_repository, @flag_sets_filter, @internal_events_queue)
+      @segments_repository = SegmentsRepository.new(@config, @internal_events_queue)
+      @rule_based_segment_repository = RuleBasedSegmentsRepository.new(@config, @internal_events_queue)
       @impressions_repository = ImpressionsRepository.new(@config)
       @events_repository = EventsRepository.new(@config, @api_key, @runtime_producer)
     end
@@ -230,11 +233,6 @@ module SplitIoClient
     end
 
     def build_unique_keys_tracker
-      if @config.impressions_mode != :none
-        @unique_keys_tracker = Engine::Impressions::NoopUniqueKeysTracker.new
-        return
-      end
-
       bf = Cache::Filter::BloomFilter.new(30_000_000)
       filter_adapter = Cache::Filter::FilterAdapter.new(@config, bf)
       cache = Concurrent::Hash.new
@@ -242,8 +240,7 @@ module SplitIoClient
     end
 
     def build_impressions_observer
-      if (@config.cache_adapter == :redis && @config.impressions_mode != :optimized) ||
-         (@config.cache_adapter == :memory && @config.impressions_mode == :none)
+      if (@config.cache_adapter == :redis && @config.impressions_mode != :optimized)
         @impression_observer = Observers::NoopImpressionObserver.new
       else
         @impression_observer = Observers::ImpressionObserver.new
@@ -251,12 +248,7 @@ module SplitIoClient
     end
 
     def build_impression_counter
-      case @config.impressions_mode
-      when :debug
-        @impression_counter = Engine::Common::NoopImpressionCounter.new
-      else
-        @impression_counter = Engine::Common::ImpressionCounter.new
-      end
+      @impression_counter = Engine::Common::ImpressionCounter.new
     end
 
     def build_impressions_sender_adapter
@@ -274,5 +266,19 @@ module SplitIoClient
     def build_flag_sets_filter
       @flag_sets_filter = SplitIoClient::Cache::Filter::FlagSetsFilter.new(@config.flag_sets_filter)
     end
+
+    def build_events_manager
+      @events_manager = Engine::Events::EventsManager.new(Engine::Events::EventsManagerConfig.new, 
+                            Engine::Events::EventsDelivery.new(@config), 
+                            @config)
+      if @config.consumer?
+        @internal_events_queue = Engine::Events::NoOpEventsQueue.new
+        return
+      end
+
+      @internal_events_queue = Queue.new
+      @events_task = Engine::Events::EventsTask.new(@events_manager.method(:notify_internal_event), @internal_events_queue, @config)
+      @events_task.start
+    end
   end
 end