splitclient-rb 6.0.1.pre.rc2-java → 6.1.0-java

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

@@ -17,7 +17,7 @@ module SplitIoClient
     #
     # @returns [object] array of splits
     def splits
-      return if @splits_repository.nil?
+      return [] if !SplitIoClient.configuration.valid_mode || @splits_repository.nil?
 
       @splits_repository.splits.each_with_object([]) do |(name, split), memo|
         split_view = build_split_view(name, split)
@@ -33,7 +33,7 @@ module SplitIoClient
     #
     # @returns [object] array of split names (String)
     def split_names
-      return if @splits_repository.nil?
+      return [] if !SplitIoClient.configuration.valid_mode || @splits_repository.nil?
 
       @splits_repository.split_names
     end
@@ -43,7 +43,14 @@ module SplitIoClient
     #
     # @returns a split view
     def split(split_name)
-      return unless @splits_repository && SplitIoClient::Validators.valid_split_parameters(split_name)
+      return unless SplitIoClient.configuration.valid_mode && @splits_repository && SplitIoClient::Validators.valid_split_parameters(split_name)
+
+      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")
+        split_name = sanitized_split_name
+      end
 
       split = @splits_repository.get_split(split_name)
 

data/lib/splitclient-rb/split_config.rb

@@ -43,7 +43,7 @@ module SplitIoClient
       @redis_url = opts[:redis_url] || SplitConfig.default_redis_url
       @redis_namespace = opts[:redis_namespace] ? "#{opts[:redis_namespace]}.#{SplitConfig.default_redis_namespace}" : SplitConfig.default_redis_namespace
       @cache_adapter = SplitConfig.init_cache_adapter(
-        opts[:cache_adapter] || SplitConfig.default_cache_adapter, :map_adapter
+        opts[:cache_adapter] || SplitConfig.default_cache_adapter, :map_adapter, nil, @redis_url
       )
       @connection_timeout = opts[:connection_timeout] || SplitConfig.default_connection_timeout
       @read_timeout = opts[:read_timeout] || SplitConfig.default_read_timeout
@@ -54,7 +54,7 @@ module SplitIoClient
       @impressions_refresh_rate = opts[:impressions_refresh_rate] || SplitConfig.default_impressions_refresh_rate
       @impressions_queue_size = opts[:impressions_queue_size] || SplitConfig.default_impressions_queue_size
       @impressions_adapter = SplitConfig.init_cache_adapter(
-        opts[:cache_adapter] || SplitConfig.default_cache_adapter, :queue_adapter, @impressions_queue_size
+        opts[:cache_adapter] || SplitConfig.default_cache_adapter, :queue_adapter, @impressions_queue_size, @redis_url
       )
       #Safeguard for users of older SDK versions.
       @disable_impressions = @impressions_queue_size == -1
@@ -62,13 +62,16 @@ module SplitIoClient
       @impressions_bulk_size = opts[:impressions_bulk_size] || @impressions_queue_size > 0 ? @impressions_queue_size : 0
 
       @metrics_adapter = SplitConfig.init_cache_adapter(
-        opts[:cache_adapter] || SplitConfig.default_cache_adapter, :map_adapter
+        opts[:cache_adapter] || SplitConfig.default_cache_adapter, :map_adapter, nil, @redis_url
       )
 
       @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
+
       @machine_name = opts[:machine_name] || SplitConfig.machine_hostname
       @machine_ip = opts[:machine_ip] || SplitConfig.machine_ip
 
@@ -83,13 +86,16 @@ module SplitIoClient
       @impression_listener = opts[:impression_listener]
       @impression_listener_refresh_rate = opts[:impression_listener_refresh_rate] || SplitConfig.default_impression_listener_refresh_rate
 
+      @max_key_size = SplitConfig.max_key_size
+
       @threads = {}
 
       @events_push_rate = opts[:events_push_rate] || SplitConfig.default_events_push_rate
       @events_queue_size = opts[:events_queue_size] || SplitConfig.default_events_queue_size
       @events_adapter = SplitConfig.init_cache_adapter(
-        opts[:cache_adapter] || SplitConfig.default_cache_adapter, :queue_adapter, @events_queue_size
+        opts[:cache_adapter] || SplitConfig.default_cache_adapter, :queue_adapter, @events_queue_size, @redis_url
       )
+      @valid_mode = true
 
       startup_log
     end
@@ -184,6 +190,8 @@ module SplitIoClient
     attr_accessor :cache_ttl
     attr_accessor :max_cache_size
 
+    attr_accessor :max_key_size
+
     attr_accessor :language
     attr_accessor :version
 
@@ -208,6 +216,8 @@ module SplitIoClient
 
     attr_accessor :threads
 
+    attr_accessor :valid_mode
+
     #
     # The schedule time for events flush after the first one
     #
@@ -240,7 +250,7 @@ module SplitIoClient
       'https://events.split.io/api/'
     end
 
-    def self.init_cache_adapter(adapter, data_structure, queue_size = nil)
+    def self.init_cache_adapter(adapter, data_structure, queue_size = nil, redis_url = nil)
       case adapter
       when :memory
         SplitIoClient::Cache::Adapters::MemoryAdapter.new(map_memory_adapter(data_structure, queue_size))
@@ -251,7 +261,7 @@ module SplitIoClient
           fail StandardError, 'To use Redis as a cache adapter you must include it in your Gemfile'
         end
 
-        SplitIoClient::Cache::Adapters::RedisAdapter.new(@redis_url)
+        SplitIoClient::Cache::Adapters::RedisAdapter.new(redis_url)
       end
     end
 
@@ -330,9 +340,17 @@ module SplitIoClient
     #
     # @return [object]
     def self.default_logger
-      (defined?(Rails) && Rails.logger) ? Rails.logger : Logger.new($stdout)
+      if defined?(Rails) && Rails.logger
+        Rails.logger
+      elsif ENV['SPLITCLIENT_ENV'] == 'test'
+        Logger.new('/dev/null')  
+      else
+       Logger.new($stdout)
+       end
     end
 
+
+
     #
     # The default debug value
     #
@@ -368,18 +386,25 @@ module SplitIoClient
     #
     # The default cache time to live
     #
-    # @return [boolean]
+    # @return [int]
     def self.cache_ttl
       5
     end
 
     # The default max cache size
     #
-    # @return [boolean]
+    # @return [int]
     def self.max_cache_size
       500
     end
 
+    # The default max key size
+    #
+    # @return [int]
+    def self.max_key_size
+      250
+    end
+
     #
     # custom logger of exceptions
     #

data/lib/splitclient-rb/split_factory.rb

@@ -1,5 +1,6 @@
 module SplitIoClient
   class SplitFactory
+    ROOT_PROCESS_ID = Process.pid
     include SplitIoClient::Cache::Repositories
     include SplitIoClient::Cache::Stores
 
@@ -25,7 +26,21 @@ module SplitIoClient
       @client = SplitClient.new(@api_key, @adapter, @splits_repository, @segments_repository, @impressions_repository, @metrics_repository, @events_repository)
       @manager = SplitManager.new(@api_key, @adapter, @splits_repository)
 
+      validate_api_key
+
       @sdk_blocker.block if SplitIoClient.configuration.block_until_ready > 0
+
+
+      at_exit do
+        unless ENV['SPLITCLIENT_ENV'] == 'test'
+          if (Process.pid == ROOT_PROCESS_ID)
+            SplitIoClient.configuration.logger.info('Split SDK shutdown started...')
+            @client.destroy
+            stop!
+            SplitIoClient.configuration.logger.info('Split SDK shutdown complete')
+          end
+        end
+      end
     end
 
     def start!
@@ -65,5 +80,17 @@ module SplitIoClient
     end
 
     alias resume! start!
+
+    private
+
+    def validate_api_key
+      if(@api_key.nil?)
+        SplitIoClient.configuration.logger.error('Factory Instantiation: you passed a nil api_key, api_key must be a non-empty String')
+        SplitIoClient.configuration.valid_mode =  false
+      elsif (@api_key.empty?)
+        SplitIoClient.configuration.logger.error('Factory Instantiation: you passed and empty api_key, api_key must be a non-empty String')
+        SplitIoClient.configuration.valid_mode =  false
+      end
+    end
   end
 end

data/lib/splitclient-rb/validators.rb

@@ -4,11 +4,12 @@ module SplitIoClient
   module Validators
     extend self
 
-    def valid_get_treatment_parameters(key, split_name, matching_key, bucketing_key)
+    def valid_get_treatment_parameters(key, split_name, matching_key, bucketing_key, attributes)
       valid_key?(key) &&
         valid_split_name?(split_name) &&
         valid_matching_key?(matching_key) &&
-        valid_bucketing_key?(key, bucketing_key)
+        valid_bucketing_key?(key, bucketing_key) &&
+        valid_attributes?(attributes)
     end
 
     def valid_get_treatments_parameters(split_names)
@@ -26,30 +27,45 @@ module SplitIoClient
       valid_split_name?(split_name, :split)
     end
 
+    def valid_matcher_arguments(args)
+      return false if !args.key?(:attributes) && !args.key?(:value)
+      return false if args.key?(:value) && args[:value].nil?
+      return false if args.key?(:attributes) && args[:attributes].nil?
+      true
+    end
+
     private
 
     def string?(value)
       value.is_a?(String) || value.is_a?(Symbol)
     end
 
+    def empty_string?(value)
+      value.is_a?(String) && value.empty?
+    end
+
     def number_or_string?(value)
-      value.is_a?(Numeric) || string?(value)
+      (value.is_a?(Numeric) && !value.to_f.nan?) || string?(value)
     end
 
     def log_nil(key, method)
-      SplitIoClient.configuration.logger.error("#{method}: #{key} cannot be nil")
+      SplitIoClient.configuration.logger.error("#{method}: you passed a nil #{key}, #{key} must be a non-empty String or a Symbol")
     end
 
-    def log_string(key, method)
-      SplitIoClient.configuration.logger.error("#{method}: #{key} must be a String or a Symbol")
+    def log_empty_string(key, method)
+      SplitIoClient.configuration.logger.error("#{method}: you passed an empty #{key}, #{key} must be a non-empty String or a Symbol")
     end
 
-    def log_number_or_string(key, method)
-      SplitIoClient.configuration.logger.error("#{method}: #{key} must be a String")
+    def log_invalid_type(key, method)
+      SplitIoClient.configuration.logger.error("#{method}: you passed an invalid #{key} type, #{key} must be a non-empty String or a Symbol")
     end
 
-    def log_convert_numeric(key, method)
-      SplitIoClient.configuration.logger.warn("#{method}: #{key} is not of type String, converting to String")
+    def log_convert_numeric(key, method, value)
+      SplitIoClient.configuration.logger.warn("#{method}: #{key} \"#{value}\" is not of type String, converting")
+    end
+
+    def log_key_too_long(key, method)
+      SplitIoClient.configuration.logger.error("#{method}: #{key} is too long - must be #{SplitIoClient.configuration.max_key_size} characters or less")
     end
 
     def valid_split_name?(split_name, method = :get_treatment)
@@ -59,7 +75,12 @@ module SplitIoClient
       end
 
       unless string?(split_name)
-        log_string(:split_name, method)
+        log_invalid_type(:split_name, method)
+        return false
+      end
+
+      if empty_string?(split_name)
+        log_empty_string(:split_name, method)
         return false
       end
 
@@ -82,41 +103,65 @@ module SplitIoClient
       end
 
       unless number_or_string?(matching_key)
-        log_number_or_string(:matching_key, :get_treatment)
+        log_invalid_type(:matching_key, :get_treatment)
         return false
       end
 
-      log_convert_numeric(:matching_key, :get_treatment) if matching_key.is_a? Numeric
+      if empty_string?(matching_key)
+        log_empty_string(:matching_key, :get_treatment)
+        return false
+      end
+
+      log_convert_numeric(:matching_key, :get_treatment, matching_key) if matching_key.is_a? Numeric
+
+      if matching_key.size > SplitIoClient.configuration.max_key_size
+        log_key_too_long(:matching_key, :get_treatment)
+        return false
+      end
 
       true
     end
 
     def valid_bucketing_key?(key, bucketing_key)
-      if bucketing_key.nil?
-        if key.is_a? Hash
-          SplitIoClient.configuration.logger.warn('get_treatment: key object should have bucketing_key set')
+      if key.is_a? Hash
+        if bucketing_key.nil?
+          log_nil(:bucketing_key, :get_treatment)
+          return false
         end
-        return true
-      end
 
-      unless number_or_string?(bucketing_key)
-        log_number_or_string(:bucketing_key, :get_treatment)
-        return false
-      end
+        unless number_or_string?(bucketing_key)
+          log_invalid_type(:bucketing_key, :get_treatment)
+          return false
+        end
 
-      log_convert_numeric(:bucketing_key, :get_treatment) if bucketing_key.is_a? Numeric
+        if empty_string?(bucketing_key)
+          log_empty_string(:bucketing_key, :get_treatment)
+          return false
+        end
+
+        log_convert_numeric(:bucketing_key, :get_treatment, bucketing_key) if bucketing_key.is_a? Numeric
+
+        if bucketing_key.size > SplitIoClient.configuration.max_key_size
+          log_key_too_long(:bucketing_key, :get_treatment)
+          return false
+        end
+      end
 
       true
     end
 
     def valid_split_names?(split_names)
-      if split_names.nil?
-        log_nil(:split_names, :get_treatments)
+      unless !split_names.nil? && split_names.is_a?(Array)
+        SplitIoClient.configuration.logger.error('get_treatments: split_names must be a non-empty Array')
         return false
       end
 
-      unless split_names.is_a? Array
-        SplitIoClient.configuration.logger.warn('get_treatments: split_names must be an Array')
+      true
+    end
+
+    def valid_attributes?(attributes)
+      unless attributes.nil? || attributes.is_a?(Hash)
+        SplitIoClient.configuration.logger.error('get_treatment: attributes must be of type Hash')
         return false
       end
 
@@ -130,11 +175,21 @@ module SplitIoClient
       end
 
       unless number_or_string?(key)
-        log_number_or_string(:key, :track)
+        log_invalid_type(:key, :track)
         return false
       end
 
-      log_convert_numeric(:key, :track) if key.is_a? Numeric
+      if empty_string?(key)
+        log_empty_string(:key, :track)
+        return false
+      end
+
+      log_convert_numeric(:key, :track, key) if key.is_a? Numeric
+
+      if key.size > SplitIoClient.configuration.max_key_size
+        log_key_too_long(:key, :track)
+        return false
+      end
 
       true
     end
@@ -146,12 +201,20 @@ module SplitIoClient
       end
 
       unless string?(event_type)
-        log_string(:event_type, :track)
+        log_invalid_type(:event_type, :track)
         return false
       end
 
-      if (event_type.to_s =~ /[a-zA-Z0-9][-_\.a-zA-Z0-9]{0,62}/).nil?
-        SplitIoClient.configuration.logger.error('track: event_type must adhere to [a-zA-Z0-9][-_\.a-zA-Z0-9]{0,62}')
+      if event_type.empty?
+        log_empty_string(:event_type, :track)
+        return false
+      end
+
+      if (event_type.to_s =~ /^[a-zA-Z0-9][-_.:a-zA-Z0-9]{0,79}$/).nil?
+        SplitIoClient.configuration.logger.error("track: you passed '#{event_type}', " \
+          'event_type must adhere to the regular expression ^[a-zA-Z0-9][-_.:a-zA-Z0-9]{0,79}$. ' \
+          'This means an event name must be alphanumeric, cannot be more than 80 characters long, ' \
+          'and can only include a dash, underscore, period, or colon as separators of alphanumeric characters')
         return false
       end
 
@@ -165,21 +228,26 @@ module SplitIoClient
       end
 
       unless string?(traffic_type_name)
-        log_string(:traffic_type_name, :track)
+        log_invalid_type(:traffic_type_name, :track)
         return false
       end
 
       if traffic_type_name.empty?
-        SplitIoClient.configuration.logger.error('track: traffic_type_name must not be an empty String')
+        log_empty_string(:traffic_type_name, :track)
         return false
       end
 
+      unless traffic_type_name == traffic_type_name.downcase
+        SplitIoClient.configuration.logger.warn('track: traffic_type_name should be all lowercase - ' \
+          'converting string to lowercase')
+      end
+
       true
     end
 
     def valid_value?(value)
-      unless value.is_a?(Numeric) || value.nil?
-        SplitIoClient.configuration.logger.error('track: value must be a number')
+      unless (value.is_a?(Numeric) && !value.to_f.nan?) || value.nil?
+        SplitIoClient.configuration.logger.error('track: value must be Numeric')
         return false
       end