splitclient-rb 8.4.0 → 8.11.0

data/lib/splitclient-rb/engine/events/noop_events_queue.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Engine
+    module Events
+      class NoOpEventsQueue
+        def push(sdk_event)
+          # do nothing
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Engine
+    class FallbackTreatmentCalculator
+      attr_accessor :fallback_treatments_configuration, :label_prefix
+
+      def initialize(fallback_treatment_configuration)
+        @label_prefix = 'fallback - '
+        @fallback_treatments_configuration = fallback_treatment_configuration
+      end
+
+      def resolve(flag_name, label)
+        default_fallback_treatment = Engine::Models::FallbackTreatment.new(
+          Engine::Models::Treatment::CONTROL,
+          nil,
+          label
+        )
+        return default_fallback_treatment if @fallback_treatments_configuration.nil?
+
+        if !@fallback_treatments_configuration.by_flag_fallback_treatment.nil? \
+            && !@fallback_treatments_configuration.by_flag_fallback_treatment.fetch(flag_name, nil).nil?
+          return copy_with_label(
+            @fallback_treatments_configuration.by_flag_fallback_treatment[flag_name],
+            resolve_label(label)
+          )
+        end
+
+        return copy_with_label(@fallback_treatments_configuration.global_fallback_treatment, resolve_label(label)) \
+          unless @fallback_treatments_configuration.global_fallback_treatment.nil?
+
+        default_fallback_treatment
+      end
+
+      private
+
+      def resolve_label(label)
+        return nil if label.nil?
+
+        @label_prefix + label
+      end
+
+      def copy_with_label(fallback_treatment, label)
+        Engine::Models::FallbackTreatment.new(fallback_treatment.treatment, fallback_treatment.config, label)
+      end
+    end
+  end
+end

data/lib/splitclient-rb/engine/impressions/unique_keys_tracker.rb

@@ -14,9 +14,9 @@ module SplitIoClient
           @filter_adapter = filter_adapter
           @sender_adapter = sender_adapter
           @cache = cache
-          @cache_max_size = config.unique_keys_cache_max_size
           @max_bulk_size = config.unique_keys_bulk_size
           @semaphore = Mutex.new
+          @keys_size = 0
         end
 
         def call
@@ -30,8 +30,9 @@ module SplitIoClient
           @filter_adapter.add(feature_name, key)
 
           add_or_update(feature_name, key)
+          @keys_size += 1
 
-          send_bulk_data if @cache.size >= @cache_max_size
+          send_bulk_data if @keys_size >= @max_bulk_size
 
           true
         rescue StandardError => e
@@ -70,27 +71,73 @@ module SplitIoClient
           end
         end
 
+        def clear_cache
+          uniques = @cache.clone
+          keys_size = @keys_size
+          @cache.clear
+          @keys_size = 0
+
+          [uniques, keys_size]
+        end
+
         def send_bulk_data
           @semaphore.synchronize do
             return if @cache.empty?
 
-            uniques = @cache.clone
-            @cache.clear
-
-            if uniques.size <= @max_bulk_size
+            uniques, keys_size = clear_cache
+            if keys_size <= @max_bulk_size
               @sender_adapter.record_uniques_key(uniques)
               return
-            end
-
-            bulks = SplitIoClient::Utilities.split_bulk_to_send(uniques, uniques.size / @max_bulk_size)
 
-            bulks.each do |b|
-              @sender_adapter.record_uniques_key(b)
             end
+            bulks = flatten_bulks(uniques)
+            bulks_to_post = group_bulks_by_max_size(bulks)
+            @sender_adapter.record_uniques_key(bulks_to_post)
           end
         rescue StandardError => e
           @config.log_found_exception(__method__.to_s, e)
         end
+
+        def group_bulks_by_max_size(bulks)
+          current_size = 0
+          bulks_to_post = Concurrent::Hash.new
+          bulks.each do |bulk|
+            key, value = bulk.first
+            if (value.size + current_size) > @max_bulk_size
+              @sender_adapter.record_uniques_key(bulks_to_post)
+              bulks_to_post = Concurrent::Hash.new
+              current_size = 0
+            end
+            bulks_to_post[key] = value
+            current_size += value.size
+          end
+
+          bulks_to_post
+        end
+
+        def flatten_bulks(uniques)
+          bulks = []
+          uniques.each_key do |unique_key|
+            bulks += check_keys_and_split_to_bulks(uniques[unique_key], unique_key)
+          end
+
+          bulks
+        end
+
+        def check_keys_and_split_to_bulks(value, key)
+          unique_updated = []
+          if value.size > @max_bulk_size
+            sub_bulks = SplitIoClient::Utilities.split_bulk_to_send(value, @max_bulk_size)
+            sub_bulks.each do |sub_bulk|
+              unique_updated << { key => sub_bulk.to_set }
+            end
+            return unique_updated
+
+          end
+          unique_updated << { key => value }
+
+          unique_updated
+        end
       end
     end
   end

data/lib/splitclient-rb/engine/matchers/combining_matcher.rb

@@ -56,7 +56,9 @@ module SplitIoClient
 
       @matchers.all? do |matcher|
         if match_with_key?(matcher)
-          matcher.match?(value: args[:matching_key])
+          key = args[:value]
+          key = args[:matching_key] unless args[:matching_key].nil?
+          matcher.match?(value: key)
         else
           matcher.match?(args)
         end

data/lib/splitclient-rb/engine/matchers/prerequisites_matcher.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  class PrerequisitesMatcher
+    def initialize(prerequisites, logger)
+      @prerequisites = prerequisites
+      @logger = logger
+    end
+
+    def match?(args)
+      keys = { matching_key: args[:matching_key], bucketing_key: args[:bucketing_key] }
+
+      match = true
+      @prerequisites.each do |prerequisite|
+        evaluate = args[:evaluator].evaluate_feature_flag(keys, prerequisite[:n], args[:attributes])
+        next if prerequisite[:ts].include?(evaluate[:treatment])
+
+        @logger.log_if_debug("[PrerequisitesMatcher] feature flag #{prerequisite[:n]} evaluated to #{evaluate[:treatment]} \
+          that does not exist in prerequisited treatments.")
+        match = false
+        break
+      end
+
+      match
+    end
+
+    def string_type?
+      false
+    end
+  end
+end

data/lib/splitclient-rb/engine/matchers/rule_based_segment_matcher.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  #
+  # class to implement the user defined matcher
+  #
+  class RuleBasedSegmentMatcher < Matcher
+    MATCHER_TYPE = 'IN_RULE_BASED_SEGMENT'
+
+    def initialize(segments_repository, rule_based_segments_repository, segment_name, config)
+      super(config.logger)
+      @rule_based_segments_repository = rule_based_segments_repository
+      @segments_repository = segments_repository
+      @segment_name = segment_name
+      @config = config
+    end
+
+    #
+    # evaluates if the key matches the matcher
+    #
+    # @param key [string] key value to be matched
+    #
+    # @return [boolean] evaluation of the key against the segment
+    def match?(args)
+      rule_based_segment = @rule_based_segments_repository.get_rule_based_segment(@segment_name)
+      return false if rule_based_segment.nil?
+
+      key = update_key(args)
+      return false if rule_based_segment[:excluded][:keys].include?(key)
+
+      return false unless check_excluded_segments(rule_based_segment, key, args)
+
+      matched = false
+      rule_based_segment[:conditions].each do |c|
+        condition = SplitIoClient::Condition.new(c, @config)
+        next if condition.empty?
+
+        matched = Helpers::EvaluatorHelper.matcher_type(condition, @segments_repository, @rule_based_segments_repository).match?(args)
+
+        break if matched
+      end
+
+      @logger.debug("[InRuleSegmentMatcher] #{@segment_name} is in rule based segment -> #{matched}")
+      matched
+    end
+
+    private
+
+    def check_excluded_segments(rule_based_segment, key, args)
+      rule_based_segment[:excluded][:segments].each do |segment|
+        if segment[:type] == SplitIoClient::Engine::Models::SegmentType::STANDARD &&
+           @segments_repository.in_segment?(segment[:name], key)
+          return false
+        end
+        return false if segment[:type] == SplitIoClient::Engine::Models::SegmentType::RULE_BASED_SEGMENT && match_rbs(
+          @rule_based_segments_repository.get_rule_based_segment(segment[:name]), args
+        )
+      end
+      true
+    end
+
+    def update_key(args)
+      if args[:value].nil? || args[:value].empty?
+        args[:matching_key]
+      else
+        args[:value]
+      end
+    end
+
+    def match_rbs(rule_based_segment, args)
+      rbs_matcher = RuleBasedSegmentMatcher.new(@segments_repository, @rule_based_segments_repository,
+                                                rule_based_segment[:name], @config)
+      rbs_matcher.match?(matching_key: args[:matching_key],
+                         bucketing_key: args[:value],
+                         attributes: args[:attributes])
+    end
+  end
+end

data/lib/splitclient-rb/engine/models/evaluation_options.rb

@@ -0,0 +1,9 @@
+module SplitIoClient::Engine::Models
+    class EvaluationOptions
+    attr_accessor :properties
+
+    def initialize(properties)
+        @properties = properties
+    end
+  end
+end

data/lib/splitclient-rb/engine/models/event_active_subscriptions.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: false
+
+module SplitIoClient
+  module Engine::Models
+    class EventActiveSubscriptions
+      attr_accessor :triggered, :handler
+
+      def initialize(triggered, handler)
+        @triggered = triggered
+        @handler = handler
+      end
+    end
+  end
+end

data/lib/splitclient-rb/engine/models/events_metadata.rb

@@ -0,0 +1,10 @@
+module SplitIoClient::Engine::Models
+    class EventsMetadata
+    attr_accessor :type, :names
+
+    def initialize(type, names=nil)
+        @type = type
+        @names = names
+    end
+  end
+end

data/lib/splitclient-rb/engine/models/fallback_treatment.rb

@@ -0,0 +1,11 @@
+module SplitIoClient::Engine::Models
+    class FallbackTreatment
+    attr_accessor :treatment, :config, :label
+
+    def initialize(treatment, config=nil, label=nil)
+        @treatment = treatment
+        @config = config
+        @label = label
+    end
+  end
+end

data/lib/splitclient-rb/engine/models/fallback_treatments_configuration.rb

@@ -0,0 +1,36 @@
+module SplitIoClient::Engine::Models
+    class FallbackTreatmentsConfiguration
+    attr_accessor :global_fallback_treatment, :by_flag_fallback_treatment
+
+    def initialize(global_fallback_treatment=nil, by_flag_fallback_treatment=nil)
+        @global_fallback_treatment = build_global_fallback_treatment(global_fallback_treatment)
+        @by_flag_fallback_treatment = build_by_flag_fallback_treatment(by_flag_fallback_treatment)
+    end
+
+    private 
+
+    def build_global_fallback_treatment(global_fallback_treatment)
+      if global_fallback_treatment.is_a? String
+        return FallbackTreatment.new(global_fallback_treatment)
+      end
+      
+      global_fallback_treatment
+    end
+
+    def build_by_flag_fallback_treatment(by_flag_fallback_treatment)
+      return nil unless by_flag_fallback_treatment.is_a?(Hash)
+      processed_by_flag_fallback_treatment = Hash.new
+      
+      by_flag_fallback_treatment.each do |key, value|
+        if value.is_a? String
+          processed_by_flag_fallback_treatment[key] = FallbackTreatment.new(value)
+          next
+        end
+
+        processed_by_flag_fallback_treatment[key] = value
+      end
+
+      processed_by_flag_fallback_treatment
+    end
+  end
+end

data/lib/splitclient-rb/engine/models/label.rb

@@ -6,4 +6,5 @@ class SplitIoClient::Engine::Models::Label
   NOT_IN_SPLIT = 'not in split'.freeze
   NOT_READY = 'not ready'.freeze
   NOT_FOUND = 'definition not found'.freeze
+  PREREQUISITES_NOT_MET = 'prerequisites not met'.freeze
 end

data/lib/splitclient-rb/engine/models/sdk_event.rb

@@ -0,0 +1,4 @@
+class SplitIoClient::Engine::Models::SdkEvent
+  SDK_READY = 'SDK_READY'
+  SDK_UPDATE = 'SDK_UPDATE'
+end

data/lib/splitclient-rb/engine/models/sdk_event_type.rb

@@ -0,0 +1,4 @@
+class SplitIoClient::Engine::Models::SdkEventType
+  FLAG_UPDATE = 'FLAG_UPDATE'
+  SEGMENTS_UPDATE = 'SEGMENTS_UPDATE'
+end

data/lib/splitclient-rb/engine/models/sdk_internal_event.rb

@@ -0,0 +1,8 @@
+class SplitIoClient::Engine::Models::SdkInternalEvent
+  SDK_READY = 'SDK_READY'
+  FLAGS_UPDATED = 'FLAGS_UPDATED'
+  FLAG_KILLED_NOTIFICATION = 'FLAG_KILLED_NOTIFICATION'
+  SEGMENTS_UPDATED = 'SEGMENTS_UPDATED'
+  RB_SEGMENTS_UPDATED = 'RB_SEGMENTS_UPDATED'
+  LARGE_SEGMENTS_UPDATED = 'LARGE_SEGMENTS_UPDATED'
+end

data/lib/splitclient-rb/engine/models/sdk_internal_event_notification.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: false
+
+module SplitIoClient
+  module Engine::Models
+    class SdkInternalEventNotification
+      attr_reader :internal_event, :metadata
+
+      def initialize(internal_event, metadata)
+        @internal_event = internal_event
+        @metadata = metadata
+      end
+    end
+  end
+end

data/lib/splitclient-rb/engine/models/segment_type.rb

@@ -0,0 +1,4 @@
+class SplitIoClient::Engine::Models::SegmentType
+  STANDARD = 'standard'
+  RULE_BASED_SEGMENT = 'rule-based'
+end

data/lib/splitclient-rb/engine/models/split_http_response.rb

@@ -0,0 +1,19 @@
+module SplitIoClient
+  module Engine
+    module Models
+      class SplitHttpResponse
+        attr_accessor :status, :body
+
+        def initialize(status, body, success)
+          @status = status
+          @body = body
+          @success = success
+        end
+
+        def success?
+          @success
+        end
+      end
+    end
+  end
+end

data/lib/splitclient-rb/engine/models/valid_sdk_event.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: false
+
+module SplitIoClient
+  module Engine::Models
+    class ValidSdkEvent
+      attr_reader :sdk_event, :valid
+
+      def initialize(sdk_event, valid)
+        @sdk_event = sdk_event
+        @valid = valid
+      end
+    end
+  end
+end

data/lib/splitclient-rb/engine/parser/condition.rb

@@ -230,6 +230,13 @@ module SplitIoClient
       )
     end
 
+    def matcher_in_rule_based_segment(params)
+      matcher = params[:matcher]
+      segment_name = matcher[:userDefinedSegmentMatcherData] && matcher[:userDefinedSegmentMatcherData][:segmentName]
+
+      RuleBasedSegmentMatcher.new(params[:segments_repository], params[:rule_based_segments_repository], segment_name, @config)
+    end
+
     #
     # @return [object] the negate value for this condition
     def negate
@@ -246,6 +253,8 @@ module SplitIoClient
     # @return [void]
     def set_partitions
       partitions_list = []
+      return partitions_list unless @data.key?(:partitions) or @data.key?('partitions')
+      
       @data[:partitions].each do |p|
         partition = SplitIoClient::Partition.new(p)
         partitions_list << partition

data/lib/splitclient-rb/engine/parser/evaluator.rb

@@ -2,9 +2,10 @@ module SplitIoClient
   module Engine
     module Parser
       class Evaluator
-        def initialize(segments_repository, splits_repository, config)
+        def initialize(segments_repository, splits_repository, rb_segment_repository, config)
           @splits_repository = splits_repository
           @segments_repository = segments_repository
+          @rb_segment_repository = rb_segment_repository
           @config = config
         end
 
@@ -37,6 +38,9 @@ module SplitIoClient
         end
 
         def match(split, keys, attributes)
+
+          return treatment_hash(Models::Label::PREREQUISITES_NOT_MET, split[:defaultTreatment], split[:changeNumber], split_configurations(split[:defaultTreatment], split)) unless check_prerequisites_matcher(split, keys, attributes)
+
           in_rollout = false
           key = keys[:bucketing_key] ? keys[:bucketing_key] : keys[:matching_key]
           legacy_algo = (split[:algo] == 1 || split[:algo] == nil) ? true : false
@@ -58,8 +62,7 @@ module SplitIoClient
 
               in_rollout = true
             end
-
-            condition_matched = matcher_type(condition).match?(
+            condition_matched = Helpers::EvaluatorHelper::matcher_type(condition, @segments_repository, @rb_segment_repository).match?(
               matching_key: keys[:matching_key],
               bucketing_key: keys[:bucketing_key],
               evaluator: self,
@@ -70,35 +73,19 @@ module SplitIoClient
 
             result = splitter.get_treatment(key, split[:seed], condition.partitions, split[:algo])
 
-            if result.nil?
-              return treatment_hash(Models::Label::NO_RULE_MATCHED, split[:defaultTreatment], split[:changeNumber], split_configurations(split[:defaultTreatment], split))
-            else
-              return treatment_hash(c[:label], result, split[:changeNumber],split_configurations(result, split))
-            end
+            return treatment_from_result(result, split, c)
           end
 
           treatment_hash(Models::Label::NO_RULE_MATCHED, split[:defaultTreatment], split[:changeNumber], split_configurations(split[:defaultTreatment], split))
         end
 
-        def matcher_type(condition)
-          matchers = []
-
-          @segments_repository.adapter.pipelined do
-            condition.matchers.each do |matcher|
-              matchers << if matcher[:negate]
-                condition.negation_matcher(matcher_instance(matcher[:matcherType], condition, matcher))
-              else
-                matcher_instance(matcher[:matcherType], condition, matcher)
-              end
-            end
-          end
-
-          final_matcher = condition.create_condition_matcher(matchers)
+        private
 
-          if final_matcher.nil?
-            @logger.error('Invalid matcher type')
+        def treatment_from_result(result, split, condition)
+          if result.nil?
+            return treatment_hash(Models::Label::NO_RULE_MATCHED, split[:defaultTreatment], split[:changeNumber], split_configurations(split[:defaultTreatment], split))
           else
-            final_matcher
+            return treatment_hash(condition[:label], result, split[:changeNumber],split_configurations(result, split))
           end
         end
 
@@ -106,11 +93,18 @@ module SplitIoClient
           { label: label, treatment: treatment, change_number: change_number, config: configurations }
         end
 
-        def matcher_instance(type, condition, matcher)
-          condition.send(
-            "matcher_#{type.downcase}",
-            matcher: matcher, segments_repository: @segments_repository
-          )
+        def check_prerequisites_matcher(split, keys, attributes)
+          if split.key?(:prerequisites) && !split[:prerequisites].nil?
+              prerequisites_matcher = SplitIoClient::PrerequisitesMatcher.new(split[:prerequisites], @config.split_logger) 
+              return prerequisites_matcher.match?(
+                  matching_key: keys[:matching_key],
+                  bucketing_key: keys[:bucketing_key],
+                  evaluator: self,
+                  attributes: attributes
+                )
+          end
+
+          true
         end
       end
     end

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

@@ -3,9 +3,10 @@
 module SplitIoClient
   module Engine
     class StatusManager
-      def initialize(config)
+      def initialize(config, internal_events_queue)
         @config = config
         @sdk_ready = Concurrent::CountDownLatch.new(1)
+        @internal_events_queue = internal_events_queue
       end
 
       def ready?
@@ -19,6 +20,11 @@ module SplitIoClient
 
         @sdk_ready.count_down
         @config.logger.info('SplitIO SDK is ready')
+        @internal_events_queue.push(
+          SplitIoClient::Engine::Models::SdkInternalEventNotification.new(
+            SplitIoClient::Engine::Models::SdkInternalEvent::SDK_READY, nil
+          )
+        )
       end
 
       def wait_until_ready(seconds = nil)

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

@@ -47,13 +47,13 @@ module SplitIoClient
           connected = false
 
           if @config.streaming_enabled
-            @config.logger.debug('Starting Streaming mode ...')
+            @config.logger.debug('Starting Streaming mode ...') if @config.debug_enabled
             start_push_status_monitor
             connected = @push_manager.start_sse
           end
 
           unless connected
-            @config.logger.debug('Starting Polling mode ...')
+            @config.logger.debug('Starting Polling mode ...') if @config.debug_enabled
             @synchronizer.start_periodic_fetch
             record_telemetry(Telemetry::Domain::Constants::SYNC_MODE, SYNC_MODE_POLLING)
           end
@@ -92,7 +92,7 @@ module SplitIoClient
 
       def process_connected
         if @sse_connected.value
-          @config.logger.debug('Streaming already connected.')
+          @config.logger.debug('Streaming already connected.') if @config.debug_enabled
           return
         end
 
@@ -107,7 +107,7 @@ module SplitIoClient
 
       def process_forced_stop
         unless @sse_connected.value
-          @config.logger.debug('Streaming already disconnected.')
+          @config.logger.debug('Streaming already disconnected.') if @config.debug_enabled
           return
         end
 
@@ -120,7 +120,7 @@ module SplitIoClient
 
       def process_disconnect(reconnect)
         unless @sse_connected.value
-          @config.logger.debug('Streaming already disconnected.')
+          @config.logger.debug('Streaming already disconnected.') if @config.debug_enabled
           return
         end
 
@@ -169,7 +169,7 @@ module SplitIoClient
           when Constants::PUSH_SUBSYSTEM_OFF
             process_push_shutdown
           else
-            @config.logger.debug('Incorrect push status type.')
+            @config.logger.debug('Incorrect push status type.') if @config.debug_enabled
           end
         end
       rescue StandardError => e