splitclient-rb 6.4.1.pre.rc3-java → 7.0.0-java

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
     #

data/lib/splitclient-rb/split_factory.rb

@@ -1,82 +1,94 @@
 module SplitIoClient
   class SplitFactory
     ROOT_PROCESS_ID = Process.pid
+    SINGLETON_WARN = 'We recommend keeping only one instance of the factory at all times (Singleton pattern) and reusing it throughout your application'
     include SplitIoClient::Cache::Repositories
     include SplitIoClient::Cache::Stores
 
-    attr_reader :adapter, :client, :manager
+    attr_reader :adapter, :client, :manager, :config
 
     def initialize(api_key, config_hash = {})
       at_exit do
         unless ENV['SPLITCLIENT_ENV'] == 'test'
           if (Process.pid == ROOT_PROCESS_ID)
-            SplitIoClient.configuration.logger.info('Split SDK shutdown started...')
+            @config.logger.info('Split SDK shutdown started...')
             @client.destroy if @client
             stop!
-            SplitIoClient.configuration.logger.info('Split SDK shutdown complete')
+            @config.logger.info('Split SDK shutdown complete')
           end
         end
       end
 
       @api_key = api_key
-      SplitIoClient.configure(config_hash)
+      @config = SplitConfig.new (config_hash)
 
       raise 'Invalid SDK mode' unless valid_mode
+      
+      @splits_repository = SplitsRepository.new(@config)
+      @segments_repository = SegmentsRepository.new(@config)
+      @impressions_repository = ImpressionsRepository.new(@config)
+      @metrics_repository = MetricsRepository.new(@config)
+      @events_repository = EventsRepository.new(@config, @api_key)
 
-      @cache_adapter = SplitIoClient.configuration.cache_adapter
-
-      @splits_repository = SplitsRepository.new(@cache_adapter)
-      @segments_repository = SegmentsRepository.new(@cache_adapter)
-      @impressions_repository = ImpressionsRepository.new(SplitIoClient.configuration.impressions_adapter)
-      @metrics_repository = MetricsRepository.new(SplitIoClient.configuration.metrics_adapter)
-      @events_repository = EventsRepository.new(SplitIoClient.configuration.events_adapter, @api_key)
-
-      if SplitIoClient.configuration.mode == :standalone && SplitIoClient.configuration.block_until_ready > 0
-        @sdk_blocker = SDKBlocker.new(@splits_repository, @segments_repository)
-      end
+      @sdk_blocker = SDKBlocker.new(@splits_repository, @segments_repository, @config)
 
       @adapter = start!
 
-      @client = SplitClient.new(@api_key, @adapter, @splits_repository, @segments_repository, @impressions_repository, @metrics_repository, @events_repository)
-      @manager = SplitManager.new(@api_key, @adapter, @splits_repository)
+      @client = SplitClient.new(@api_key, @adapter, @splits_repository, @segments_repository, @impressions_repository, @metrics_repository, @events_repository, @sdk_blocker, @config)
+      @manager = SplitManager.new(@api_key, @adapter, @splits_repository, @sdk_blocker, @config)
 
       validate_api_key
 
-      RedisMetricsFixer.new(@metrics_repository).call
+      RedisMetricsFixer.new(@metrics_repository, @config).call
 
-      @sdk_blocker.block if @sdk_blocker
+      register_factory
     end
 
     def start!
-      SplitAdapter.new(@api_key, @splits_repository, @segments_repository, @impressions_repository, @metrics_repository, @events_repository, @sdk_blocker)
+      SplitAdapter.new(@api_key, @splits_repository, @segments_repository, @impressions_repository, @metrics_repository, @events_repository, @sdk_blocker, @config)
     end
 
     def stop!
-      SplitIoClient.configuration.threads.each { |_, t| t.exit }
+      @config.threads.each { |_, t| t.exit }
+    end
+
+    def register_factory
+      SplitIoClient.load_factory_registry
+
+      number_of_factories = SplitIoClient.split_factory_registry.number_of_factories_for(@api_key)
+
+      if(number_of_factories > 0)
+        @config.logger.warn("Factory instantiation: You already have #{number_of_factories} factories with this API Key. #{SINGLETON_WARN}")
+      elsif(SplitIoClient.split_factory_registry.other_factories)
+        @config.logger.warn('Factory instantiation: You already have an instance of the Split factory.' \
+          " Make sure you definitely want this additional instance. #{SINGLETON_WARN}")
+      end
+
+      SplitIoClient.split_factory_registry.add(@api_key)
     end
 
     def valid_mode
       valid_startup_mode = false
-      case SplitIoClient.configuration.mode
+      case @config.mode
       when :consumer
-        if SplitIoClient.configuration.cache_adapter.is_a? SplitIoClient::Cache::Adapters::RedisAdapter
+        if @config.cache_adapter.is_a? SplitIoClient::Cache::Adapters::RedisAdapter
           valid_startup_mode = true
         else
-          SplitIoClient.configuration.logger.error('Consumer mode cannot be used with Memory adapter. ' \
+          @config.logger.error('Consumer mode cannot be used with Memory adapter. ' \
             'Use Redis adapter instead.')
         end
       when :standalone
-        if SplitIoClient.configuration.cache_adapter.is_a? SplitIoClient::Cache::Adapters::MemoryAdapter
+        if @config.cache_adapter.is_a? SplitIoClient::Cache::Adapters::MemoryAdapter
           valid_startup_mode = true
         else
-          SplitIoClient.configuration.logger.error('Standalone mode cannot be used with Redis adapter. ' \
+          @config.logger.error('Standalone mode cannot be used with Redis adapter. ' \
             'Use Memory adapter instead.')
         end
       when :producer
-        SplitIoClient.configuration.logger.error('Producer mode is no longer supported. Use Split Synchronizer. ' \
+        @config.logger.error('Producer mode is no longer supported. Use Split Synchronizer. ' \
           'See: https://github.com/splitio/split-synchronizer')
       else
-        SplitIoClient.configuration.logger.error('Invalid SDK mode selected. ' \
+        @config.logger.error('Invalid SDK mode selected. ' \
           "Valid modes are 'standalone with memory adapter' and 'consumer with redis adapter'")
       end
 
@@ -89,11 +101,11 @@ module SplitIoClient
 
     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
+        @config.logger.error('Factory Instantiation: you passed a nil api_key, api_key must be a non-empty String')
+        @config.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
+        @config.logger.error('Factory Instantiation: you passed and empty api_key, api_key must be a non-empty String')
+        @config.valid_mode =  false
       end
     end
   end

data/lib/splitclient-rb/split_factory_builder.rb

@@ -5,9 +5,8 @@ module SplitIoClient
     def self.build(api_key, config = {})
       case api_key
       when 'localhost'
-        SplitIoClient.configure( { logger: config[:logger] } )
-
-        LocalhostSplitFactory.new(split_file(config[:split_file]), config[:reload_rate])
+        configuration = SplitConfig.new(config)
+        LocalhostSplitFactory.new(split_file(config[:split_file], configuration.logger), configuration, config[:reload_rate])
       else
         SplitFactory.new(api_key, config)
       end
@@ -15,10 +14,10 @@ module SplitIoClient
 
     private
 
-    def self.split_file(split_file_path)
+    def self.split_file(split_file_path, logger)
       return split_file_path unless split_file_path.nil?
 
-      SplitIoClient.configuration.logger.warn('Localhost mode: .split mocks ' \
+      logger.warn('Localhost mode: .split mocks ' \
         'will be deprecated soon in favor of YAML files, which provide more ' \
         'targeting power. Take a look in our documentation.')
 

data/lib/splitclient-rb/split_factory_registry.rb

@@ -0,0 +1,51 @@
+require 'logger'
+require 'socket'
+
+module SplitIoClient
+
+  class << self
+      attr_accessor :split_factory_registry
+  end
+
+  def self.load_factory_registry
+    self.split_factory_registry ||= SplitFactoryRegistry.new
+  end
+
+  #
+  # This class manages configuration options for the split client library.
+  # If not custom configuration is required the default configuration values will be used
+  #
+  class SplitFactoryRegistry
+
+    attr_accessor :api_keys_hash
+
+    def initialize
+      @api_keys_hash = Hash.new
+    end
+
+    def add(api_key)
+      return unless api_key
+
+      @api_keys_hash[api_key] = 0 unless @api_keys_hash[api_key]
+      @api_keys_hash[api_key] += 1
+    end
+
+    def remove(api_key)
+      return unless api_key
+
+      @api_keys_hash[api_key] -= 1 if @api_keys_hash[api_key]
+      @api_keys_hash.delete(api_key) if @api_keys_hash[api_key] == 0
+    end
+
+    def number_of_factories_for(api_key)
+      return 0 unless api_key
+      return 0 unless @api_keys_hash.key?(api_key)
+
+      @api_keys_hash[api_key]
+    end
+
+    def other_factories
+      return !@api_keys_hash.empty?
+    end
+  end
+end

data/lib/splitclient-rb/split_logger.rb

@@ -1,24 +1,15 @@
-require 'singleton'
-
 module SplitIoClient
   class SplitLogger
-      include Singleton
+      def initialize(config)
+        @config = config
+      end
 
       def log_if_debug(message)
-        SplitIoClient.configuration.logger.debug(message) if SplitIoClient.configuration.debug_enabled
+        @config.logger.debug(message) if @config.debug_enabled
       end
 
       def log_if_transport(message)
-        SplitIoClient.configuration.logger.debug(message) if SplitIoClient.configuration.transport_debug_enabled
-      end
-
-      def log_error(message)
-        SplitIoClient.configuration.logger.error(message)
-      end
-
-      class << self
-        extend Forwardable
-        def_delegators :instance, *SplitLogger.instance_methods(false)
+        @config.logger.debug(message) if @config.transport_debug_enabled
       end
   end
 end