splitclient-rb 6.4.1 → 7.0.0

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

@@ -7,7 +7,8 @@ module SplitIoClient
   class NegationMatcher < Matcher
     MATCHER_TYPE = 'NEGATION_MATCHER'
 
-    def initialize(matcher = nil)
+    def initialize(logger, matcher = nil)
+      super(logger)
       @matcher = matcher
     end
 
@@ -19,7 +20,7 @@ module SplitIoClient
     # @return [boolean] evaluation of the negation matcher
     def match?(args)
       matches = !@matcher.match?(args)
-      SplitLogger.log_if_debug("[NegationMatcherMatcher] Matcher #{@matcher} Arguments #{args} -> #{matches}")
+      @logger.log_if_debug("[NegationMatcherMatcher] Matcher #{@matcher} Arguments #{args} -> #{matches}")
       matches
     end
 

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

@@ -6,20 +6,20 @@ module SplitIoClient
 
     attr_reader :attribute
 
-    def initialize(attribute, remote_array)
-      super(attribute, remote_array)
+    def initialize(attribute, remote_array, logger)
+      super(attribute, remote_array, logger)
     end
 
     def match?(args)
       @local_set = local_set(args[:attributes], @attribute)
 
       if @local_set.empty?
-        SplitLogger.log_if_debug('[PartOfSetMatcher] Local Set is empty.')
+        @logger.log_if_debug('[PartOfSetMatcher] Local Set is empty.')
         return false
       end
 
       matches = @local_set.subset? @remote_set
-      SplitLogger.log_if_debug("[PartOfSetMatcher] Local Set #{@local_set} is a subset of #{@remote_set} -> #{matches}")
+      @logger.log_if_debug("[PartOfSetMatcher] Local Set #{@local_set} is a subset of #{@remote_set} -> #{matches}")
       matches
     end
   end

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

@@ -10,9 +10,10 @@ module SplitIoClient
 
     protected
 
-    def initialize(attribute, remote_array)
+    def initialize(attribute, remote_array, logger)
       @attribute = attribute
       @remote_set = remote_array.to_set
+      @logger = logger
     end
 
     def local_set(data, attribute)

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

@@ -6,21 +6,22 @@ module SplitIoClient
 
     attr_reader :attribute
 
-    def initialize(attribute, prefix_list)
+    def initialize(attribute, prefix_list, logger)
       @attribute = attribute
       @prefix_list = prefix_list
+      @logger = logger
     end
 
     def match?(args)
       if @prefix_list.empty?
-        SplitLogger.log_if_debug('[StartsWithMatcher] Prefix List is empty.')
+        @logger.log_if_debug('[StartsWithMatcher] Prefix List is empty.')
         return false
       end
 
       value = get_value(args)
 
       matches = @prefix_list.any? { |prefix| value.to_s.start_with? prefix }
-      SplitLogger.log_if_debug("[StartsWithMatcher] #{value} matches any of #{@prefix_list} -> #{matches}")
+      @logger.log_if_debug("[StartsWithMatcher] #{value} matches any of #{@prefix_list} -> #{matches}")
       matches
     end
 

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

@@ -7,7 +7,8 @@ module SplitIoClient
   class UserDefinedSegmentMatcher < Matcher
     MATCHER_TYPE = 'IN_SEGMENT'
 
-    def initialize(segments_repository, segment_name)
+    def initialize(segments_repository, segment_name, logger)
+      super(logger)
       @segments_repository = segments_repository
       @segment_name = segment_name
     end
@@ -20,7 +21,7 @@ module SplitIoClient
     # @return [boolean] evaluation of the key against the segment
     def match?(args)
       matches = @segments_repository.in_segment?(@segment_name, args[:value] || args[:matching_key])
-      SplitLogger.log_if_debug("[InSegmentMatcher] #{@segment_name} is in segment -> #{matches}")
+      @logger.log_if_debug("[InSegmentMatcher] #{@segment_name} is in segment -> #{matches}")
       matches
     end
   end

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

@@ -9,7 +9,9 @@ module SplitIoClient
 
     attr_reader :attribute
 
-    def initialize(whitelist_data)
+    def initialize(whitelist_data, logger, validator)
+      super(logger)
+      @validator = validator
       @whitelist = case whitelist_data
                    when Array
                      whitelist_data
@@ -26,9 +28,9 @@ module SplitIoClient
     def match?(args)
       return matches_user_whitelist(args) unless @matcher_type == 'ATTR_WHITELIST'
 
-      SplitLogger.log_if_debug('[WhitelistMatcher] evaluating value and attributes.')
+      @logger.log_if_debug('[WhitelistMatcher] evaluating value and attributes.')
 
-      return false unless SplitIoClient::Validators.valid_matcher_arguments(args)
+      return false unless @validator.valid_matcher_arguments(args)
 
       matches_attr_whitelist(args)
     end
@@ -49,14 +51,14 @@ module SplitIoClient
 
     def matches_user_whitelist(args)
       matches = @whitelist.include?(args[:value] || args[:matching_key])
-      SplitLogger.log_if_debug("[WhitelistMatcher] #{@whitelist} include \
+      @logger.log_if_debug("[WhitelistMatcher] #{@whitelist} include \
         #{args[:value] || args[:matching_key]} -> #{matches}")
       matches
     end
 
     def matches_attr_whitelist(args)
       matches = @whitelist.include?(args[:value] || args[:attributes][@attribute.to_sym])
-      SplitLogger.log_if_debug("[WhitelistMatcher] #{@whitelist} include \
+      @logger.log_if_debug("[WhitelistMatcher] #{@whitelist} include \
         #{args[:value] || args[:attributes][@attribute.to_sym]} -> #{matches}")
       matches
     end

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

@@ -4,4 +4,6 @@ class SplitIoClient::Engine::Models::Label
   EXCEPTION = 'exception'.freeze
   KILLED = 'killed'.freeze
   NOT_IN_SPLIT = 'not in split'.freeze
+  NOT_READY = 'not ready'.freeze
+  NOT_FOUND = 'definition not found'.freeze
 end

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

@@ -11,13 +11,14 @@ module SplitIoClient
     # @returns [object] condition values
     attr_accessor :data
 
-    def initialize(condition)
+    def initialize(condition, config)
       @data = condition
       @partitions = set_partitions
+      @config = config
     end
 
     def create_condition_matcher(matchers)
-      CombiningMatcher.new(combiner, matchers) if combiner
+      CombiningMatcher.new(@config.split_logger, combiner, matchers) if combiner
     end
 
     #
@@ -45,11 +46,11 @@ module SplitIoClient
     end
 
     def negation_matcher(matcher)
-      NegationMatcher.new(matcher)
+      NegationMatcher.new(@config.split_logger, matcher)
     end
 
     def matcher_all_keys(_params)
-      @matcher_all_keys ||= AllKeysMatcher.new
+      @matcher_all_keys ||= AllKeysMatcher.new(@config.split_logger)
     end
 
     # returns UserDefinedSegmentMatcher[object]
@@ -57,7 +58,7 @@ module SplitIoClient
       matcher = params[:matcher]
       segment_name = matcher[:userDefinedSegmentMatcherData] && matcher[:userDefinedSegmentMatcherData][:segmentName]
 
-      UserDefinedSegmentMatcher.new(params[:segments_repository], segment_name)
+      UserDefinedSegmentMatcher.new(params[:segments_repository], segment_name, @config.split_logger)
     end
 
     # returns WhitelistMatcher[object] the whitelist for this condition in case it has a whitelist matcher
@@ -72,7 +73,7 @@ module SplitIoClient
         white_list = (matcher[:whitelistMatcherData])[:whitelist]
         result =  { attribute: attribute, value: white_list }
       end
-      WhitelistMatcher.new(result)
+      WhitelistMatcher.new(result, @config.split_logger, @config.split_validator)
     end
 
     def matcher_equal_to(params)
@@ -80,7 +81,7 @@ module SplitIoClient
       attribute = (matcher[:keySelector])[:attribute]
       value = (matcher[:unaryNumericMatcherData])[:value]
       data_type = (matcher[:unaryNumericMatcherData])[:dataType]
-      EqualToMatcher.new(attribute: attribute, value: value, data_type: data_type)
+      EqualToMatcher.new({attribute: attribute, value: value, data_type: data_type}, @config.split_logger, @config.split_validator)
     end
 
     def matcher_greater_than_or_equal_to(params)
@@ -88,7 +89,7 @@ module SplitIoClient
       attribute = (matcher[:keySelector])[:attribute]
       value = (matcher[:unaryNumericMatcherData])[:value]
       data_type = (matcher[:unaryNumericMatcherData])[:dataType]
-      GreaterThanOrEqualToMatcher.new(attribute: attribute, value: value, data_type: data_type)
+      GreaterThanOrEqualToMatcher.new({attribute: attribute, value: value, data_type: data_type}, @config.split_logger, @config.split_validator)
     end
 
     def matcher_less_than_or_equal_to(params)
@@ -96,7 +97,7 @@ module SplitIoClient
       attribute = (matcher[:keySelector])[:attribute]
       value = (matcher[:unaryNumericMatcherData])[:value]
       data_type = (matcher[:unaryNumericMatcherData])[:dataType]
-      LessThanOrEqualToMatcher.new(attribute: attribute, value: value, data_type: data_type)
+      LessThanOrEqualToMatcher.new({attribute: attribute, value: value, data_type: data_type}, @config.split_logger, @config.split_validator)
     end
 
     def matcher_between(params)
@@ -105,76 +106,86 @@ module SplitIoClient
       start_value = (matcher[:betweenMatcherData])[:start]
       end_value = (matcher[:betweenMatcherData])[:end]
       data_type = (matcher[:betweenMatcherData])[:dataType]
-      BetweenMatcher.new(attribute: attribute, start_value: start_value, end_value: end_value, data_type: data_type)
+      BetweenMatcher.new({attribute: attribute, start_value: start_value, end_value: end_value, data_type: data_type}, @config.split_logger, @config.split_validator)
     end
 
     def matcher_equal_to_set(params)
       EqualToSetMatcher.new(
         params[:matcher][:keySelector][:attribute],
-        params[:matcher][:whitelistMatcherData][:whitelist]
+        params[:matcher][:whitelistMatcherData][:whitelist],
+        @config.split_logger
       )
     end
 
     def matcher_contains_any_of_set(params)
       ContainsAnyMatcher.new(
         params[:matcher][:keySelector][:attribute],
-        params[:matcher][:whitelistMatcherData][:whitelist]
+        params[:matcher][:whitelistMatcherData][:whitelist],
+        @config.split_logger
       )
     end
 
     def matcher_contains_all_of_set(params)
       ContainsAllMatcher.new(
         params[:matcher][:keySelector][:attribute],
-        params[:matcher][:whitelistMatcherData][:whitelist]
+        params[:matcher][:whitelistMatcherData][:whitelist],
+        @config.split_logger
       )
     end
 
     def matcher_part_of_set(params)
       PartOfSetMatcher.new(
         params[:matcher][:keySelector][:attribute],
-        params[:matcher][:whitelistMatcherData][:whitelist]
+        params[:matcher][:whitelistMatcherData][:whitelist],
+        @config.split_logger
       )
     end
 
     def matcher_starts_with(params)
       StartsWithMatcher.new(
         params[:matcher][:keySelector][:attribute],
-        params[:matcher][:whitelistMatcherData][:whitelist]
+        params[:matcher][:whitelistMatcherData][:whitelist],
+        @config.split_logger
       )
     end
 
     def matcher_ends_with(params)
       EndsWithMatcher.new(
         params[:matcher][:keySelector][:attribute],
-        params[:matcher][:whitelistMatcherData][:whitelist]
+        params[:matcher][:whitelistMatcherData][:whitelist],
+        @config.split_logger
       )
     end
 
     def matcher_contains_string(params)
       ContainsMatcher.new(
         params[:matcher][:keySelector][:attribute],
-        params[:matcher][:whitelistMatcherData][:whitelist]
+        params[:matcher][:whitelistMatcherData][:whitelist],
+        @config.split_logger, @config.split_validator
       )
     end
 
     def matcher_in_split_treatment(params)
       DependencyMatcher.new(
         params[:matcher][:dependencyMatcherData][:split],
-        params[:matcher][:dependencyMatcherData][:treatments]
+        params[:matcher][:dependencyMatcherData][:treatments],
+        @config.split_logger
       )
     end
 
     def matcher_equal_to_boolean(params)
       EqualToBooleanMatcher.new(
         params[:matcher][:keySelector][:attribute],
-        params[:matcher][:booleanMatcherData]
+        params[:matcher][:booleanMatcherData],
+        @config.split_logger
       )
     end
 
     def matcher_matches_string(params)
       MatchesStringMatcher.new(
         params[:matcher][:keySelector][:attribute],
-        params[:matcher][:stringMatcherData]
+        params[:matcher][:stringMatcherData],
+        @config.split_logger
       )
     end
 

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

@@ -2,10 +2,11 @@ module SplitIoClient
   module Engine
     module Parser
       class Evaluator
-        def initialize(segments_repository, splits_repository, multiple = false)
+        def initialize(segments_repository, splits_repository, config, multiple = false)
           @splits_repository = splits_repository
           @segments_repository = segments_repository
           @multiple = multiple
+          @config = config
           @cache = {}
         end
 
@@ -48,7 +49,7 @@ module SplitIoClient
           splitter = Splitter.new
 
           split[:conditions].each do |c|
-            condition = SplitIoClient::Condition.new(c)
+            condition = SplitIoClient::Condition.new(c, @config)
 
             next if condition.empty?
 

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

@@ -31,7 +31,8 @@ module SplitIoClient
       impressions_repository,
       metrics_repository,
       events_repository,
-      sdk_blocker
+      sdk_blocker,
+      config
     )
       @api_key = api_key
       @splits_repository = splits_repository
@@ -41,8 +42,9 @@ module SplitIoClient
       @events_repository = events_repository
       @metrics = Metrics.new(100, @metrics_repository)
       @sdk_blocker = sdk_blocker
+      @config = config
 
-      start_standalone_components if SplitIoClient.configuration.mode == :standalone
+      start_standalone_components if @config.standalone?
     end
 
     def start_standalone_components
@@ -55,27 +57,27 @@ module SplitIoClient
 
     # Starts thread which loops constantly and stores splits in the splits_repository of choice
     def split_store
-      SplitStore.new(@splits_repository, @api_key, @metrics, @sdk_blocker).call
+      SplitStore.new(@splits_repository, @api_key, @metrics, @config, @sdk_blocker).call
     end
 
     # Starts thread which loops constantly and stores segments in the segments_repository of choice
     def segment_store
-      SegmentStore.new(@segments_repository, @api_key, @metrics, @sdk_blocker).call
+      SegmentStore.new(@segments_repository, @api_key, @metrics, @config, @sdk_blocker).call
     end
 
     # Starts thread which loops constantly and sends impressions to the Split API
     def impressions_sender
-      ImpressionsSender.new(@impressions_repository, @api_key).call
+      ImpressionsSender.new(@impressions_repository, @api_key, @config).call
     end
 
     # Starts thread which loops constantly and sends metrics to the Split API
     def metrics_sender
-      MetricsSender.new(@metrics_repository, @api_key).call
+      MetricsSender.new(@metrics_repository, @api_key, @config).call
     end
 
     # Starts thread which loops constantly and sends events to the Split API
     def events_sender
-      EventsSender.new(@events_repository).call
+      EventsSender.new(@events_repository, @config).call
     end
   end
 end

data/lib/splitclient-rb/localhost_split_factory.rb

@@ -2,11 +2,12 @@ module SplitIoClient
   class LocalhostSplitFactory
     attr_reader :client, :manager
 
-    def initialize(splits_file, reload_rate = nil, logger = nil)
+    def initialize(splits_file, config, reload_rate = nil, logger = nil)
       @splits_file = splits_file
       @reload_rate = reload_rate
+      @config = config
 
-      @client = LocalhostSplitClient.new(@splits_file, @reload_rate)
+      @client = LocalhostSplitClient.new(@splits_file, @config, @reload_rate)
       @manager = LocalhostSplitManager.new(@splits_file, @reload_rate)
     end
   end

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

@@ -6,10 +6,12 @@ module SplitIoClient
     # @param api_key [String] the API key for your split account
     #
     # @return [SplitIoManager] split.io client instance
-    def initialize(api_key, adapter = nil, splits_repository = nil)
+    def initialize(api_key, adapter = nil, splits_repository = nil, sdk_blocker, config)
       @localhost_mode_features = []
       @splits_repository = splits_repository
       @adapter = adapter
+      @sdk_blocker = sdk_blocker
+      @config = config
     end
 
     #
@@ -17,7 +19,12 @@ module SplitIoClient
     #
     # @returns [object] array of splits
     def splits
-      return [] if !SplitIoClient.configuration.valid_mode || @splits_repository.nil?
+      return [] if !@config.valid_mode || @splits_repository.nil?
+
+      if !ready?
+        @config.logger.error("splits: the SDK is not ready, the operation cannot be executed")
+        return []
+      end
 
       @splits_repository.splits.each_with_object([]) do |(name, split), memo|
         split_view = build_split_view(name, split)
@@ -33,7 +40,12 @@ module SplitIoClient
     #
     # @returns [object] array of split names (String)
     def split_names
-      return [] if !SplitIoClient.configuration.valid_mode || @splits_repository.nil?
+      return [] if !@config.valid_mode || @splits_repository.nil?
+
+      if !ready?
+        @config.logger.error("split_names: the SDK is not ready, the operation cannot be executed")
+        return []
+      end
 
       @splits_repository.split_names
     end
@@ -43,22 +55,38 @@ module SplitIoClient
     #
     # @returns a split view
     def split(split_name)
-      return unless SplitIoClient.configuration.valid_mode && @splits_repository && SplitIoClient::Validators.valid_split_parameters(split_name)
+      return unless @config.valid_mode && @splits_repository && @config.split_validator.valid_split_parameters(split_name)
+
+      if !ready?
+        @config.logger.error("split: the SDK is not ready, the operation cannot be executed")
+        return
+      end
 
       sanitized_split_name= split_name.to_s.strip
 
       if split_name.to_s != sanitized_split_name
-        SplitIoClient.configuration.logger.warn("split: split_name #{split_name} has extra whitespace, trimming")
+        @config.logger.warn("split: split_name #{split_name} has extra whitespace, trimming")
         split_name = sanitized_split_name
       end
 
       split = @splits_repository.get_split(split_name)
 
+      if ready? && split.nil?
+        @config.logger.warn("split: you passed #{split_name} " \
+          'that does not exist in this environment, please double check what Splits exist in the web console')
+      end
+
       return if split.nil? || Engine::Models::Split.archived?(split)
 
       build_split_view(split_name, split)
     end
 
+    def block_until_ready(time = nil)
+      @sdk_blocker.block(time) if @sdk_blocker && !@sdk_blocker.ready?
+    end
+
+    private
+
     def build_split_view(name, split)
       return {} unless split
 
@@ -79,5 +107,11 @@ module SplitIoClient
           configs: split[:configurations] || {}
         }
     end
+
+    # move to blocker, alongside block until ready to avoid duplication
+    def ready?
+      return @sdk_blocker.ready? if @sdk_blocker
+      true
+    end
   end
 end

data/lib/splitclient-rb/redis_metrics_fixer.rb

@@ -2,12 +2,13 @@
 
 module SplitIoClient
   class RedisMetricsFixer
-    def initialize(metrics_repository)
+    def initialize(metrics_repository, config)
       @metrics_repository = metrics_repository
+      @config = config
     end
 
     def call
-      return if ENV['SPLITCLIENT_ENV'] == 'test' || SplitIoClient.configuration.mode == :standalone
+      return if ENV['SPLITCLIENT_ENV'] == 'test' || @config.mode == :standalone
 
       fixer_thread
 
@@ -23,11 +24,11 @@ module SplitIoClient
     def fixer_thread
       Thread.new do
         begin
-          SplitIoClient.configuration.logger.info('Starting redis metrics fixer')
+          @config.logger.info('Starting redis metrics fixer')
 
           @metrics_repository.fix_latencies
         rescue StandardError => error
-          SplitIoClient.configuration.log_found_exception(__method__.to_s, error)
+          @config.log_found_exception(__method__.to_s, error)
         end
       end
     end

data/lib/splitclient-rb/split_config.rb

@@ -2,15 +2,6 @@ require 'logger'
 require 'socket'
 
 module SplitIoClient
-
-  class << self
-      attr_accessor :configuration
-  end
-
-  def self.configure(opts={})
-    self.configuration ||= SplitConfig.new(opts)
-  end
-
   #
   # This class manages configuration options for the split client library.
   # If not custom configuration is required the default configuration values will be used
@@ -68,9 +59,7 @@ module SplitIoClient
       @logger = opts[:logger] || SplitConfig.default_logger
       @debug_enabled = opts[:debug_enabled] || SplitConfig.default_debug
       @transport_debug_enabled = opts[:transport_debug_enabled] || SplitConfig.default_debug
-      @block_until_ready = opts[:ready] || opts[:block_until_ready] || 0
-
-      @logger.warn 'no ready parameter has been set - incorrect control treatments could be logged' if block_until_ready == 0 && !mode.equal?(:consumer) 
+      @block_until_ready = SplitConfig.default_block_until_ready
 
       @machine_name = opts[:machine_name] || SplitConfig.machine_hostname
       @machine_ip = opts[:machine_ip] || SplitConfig.machine_ip
@@ -96,7 +85,8 @@ module SplitIoClient
         opts[:cache_adapter] || SplitConfig.default_cache_adapter, :queue_adapter, @events_queue_size, @redis_url
       )
       @valid_mode = true
-
+      @split_logger = SplitIoClient::SplitLogger.new(self)
+      @split_validator = SplitIoClient::Validators.new(self)
       startup_log
     end
 
@@ -160,6 +150,21 @@ module SplitIoClient
     # @return [Logger] The configured logger
     attr_accessor :logger
 
+    #
+    # The split logger. The client library uses the split logger
+    # to use common functions around the logger
+    #
+    # @return [SplitLogger] The configured logger
+    attr_accessor :split_logger
+
+
+    #
+    # The split validator. The client library uses the split validator
+    # to validate inputs accross the sdk
+    #
+    # @return [SplitValidator] The validator
+    attr_accessor :split_validator
+
     #
     # The boolean that represents the state of the debug log level
     #
@@ -343,7 +348,7 @@ module SplitIoClient
       if defined?(Rails) && Rails.logger
         Rails.logger
       elsif ENV['SPLITCLIENT_ENV'] == 'test'
-        Logger.new('/dev/null')  
+        Logger.new('/dev/null')
       else
        Logger.new($stdout)
        end
@@ -375,6 +380,14 @@ module SplitIoClient
       'SPLITIO'
     end
 
+    #
+    # The default block until ready value
+    #
+    # @return [int]
+    def self.default_block_until_ready
+      15
+    end
+
     #
     # The default transport_debug_enabled value
     #
@@ -429,6 +442,14 @@ module SplitIoClient
       @logger.info("Loaded cache class: #{@cache_adapter.class}")
     end
 
+    def standalone?
+      @mode.equal?(:standalone)
+    end
+
+    def consumer?
+      @mode.equal?(:consumer)
+    end
+
     #
     # gets the hostname where the sdk gem is running
     #