splitclient-rb 6.4.1 → 7.0.0

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

data/lib/splitclient-rb/validators.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
 module SplitIoClient
-  module Validators
-    extend self
+  class Validators
+
+    def initialize(config)
+      @config = config
+    end
 
     def valid_get_treatment_parameters(method, key, split_name, matching_key, bucketing_key, attributes)
       valid_key?(method, key) &&
@@ -50,23 +53,23 @@ module SplitIoClient
     end
 
     def log_nil(key, method)
-      SplitIoClient.configuration.logger.error("#{method}: you passed a nil #{key}, #{key} must be a non-empty String or a Symbol")
+      @config.logger.error("#{method}: you passed a nil #{key}, #{key} must be a non-empty String or a Symbol")
     end
 
     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")
+      @config.logger.error("#{method}: you passed an empty #{key}, #{key} must be a non-empty String or a Symbol")
     end
 
     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")
+      @config.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, value)
-      SplitIoClient.configuration.logger.warn("#{method}: #{key} \"#{value}\" is not of type String, converting")
+      @config.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")
+      @config.logger.error("#{method}: #{key} is too long - must be #{@config.max_key_size} characters or less")
     end
 
     def valid_split_name?(method, split_name)
@@ -115,7 +118,7 @@ module SplitIoClient
 
       log_convert_numeric(:matching_key, method, matching_key) if matching_key.is_a? Numeric
 
-      if matching_key.size > SplitIoClient.configuration.max_key_size
+      if matching_key.size > @config.max_key_size
         log_key_too_long(:matching_key, method)
         return false
       end
@@ -142,7 +145,7 @@ module SplitIoClient
 
         log_convert_numeric(:bucketing_key, method, bucketing_key) if bucketing_key.is_a? Numeric
 
-        if bucketing_key.size > SplitIoClient.configuration.max_key_size
+        if bucketing_key.size > @config.max_key_size
           log_key_too_long(:bucketing_key, method)
           return false
         end
@@ -153,7 +156,7 @@ module SplitIoClient
 
     def valid_split_names?(method, split_names)
       unless !split_names.nil? && split_names.is_a?(Array)
-        SplitIoClient.configuration.logger.error("#{method}: split_names must be a non-empty Array")
+        @config.logger.error("#{method}: split_names must be a non-empty Array")
         return false
       end
 
@@ -162,7 +165,7 @@ module SplitIoClient
 
     def valid_attributes?(method, attributes)
       unless attributes.nil? || attributes.is_a?(Hash)
-        SplitIoClient.configuration.logger.error("#{method}: attributes must be of type Hash")
+        @config.logger.error("#{method}: attributes must be of type Hash")
         return false
       end
 
@@ -187,7 +190,7 @@ module SplitIoClient
 
       log_convert_numeric(:key, :track, key) if key.is_a? Numeric
 
-      if key.size > SplitIoClient.configuration.max_key_size
+      if key.size > @config.max_key_size
         log_key_too_long(:key, :track)
         return false
       end
@@ -212,7 +215,7 @@ module SplitIoClient
       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}', " \
+        @config.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')
@@ -239,7 +242,7 @@ module SplitIoClient
       end
 
       unless traffic_type_name == traffic_type_name.downcase
-        SplitIoClient.configuration.logger.warn('track: traffic_type_name should be all lowercase - ' \
+        @config.logger.warn('track: traffic_type_name should be all lowercase - ' \
           'converting string to lowercase')
       end
 
@@ -248,7 +251,7 @@ module SplitIoClient
 
     def valid_value?(value)
       unless (value.is_a?(Numeric) && !value.to_f.nan?) || value.nil?
-        SplitIoClient.configuration.logger.error('track: value must be Numeric')
+        @config.logger.error('track: value must be Numeric')
         return false
       end
 
@@ -257,7 +260,7 @@ module SplitIoClient
 
     def valid_properties?(properties)
       unless properties.is_a?(Hash) || properties.nil?
-        SplitIoClient.configuration.logger.error('track: properties must be a Hash')
+        @config.logger.error('track: properties must be a Hash')
         return false
       end
 

data/lib/splitclient-rb/version.rb

@@ -1,3 +1,3 @@
 module SplitIoClient
-  VERSION = '6.4.1'
+  VERSION = '7.0.0'
 end

data/lib/splitclient-rb.rb

@@ -39,6 +39,8 @@ require 'splitclient-rb/split_factory_builder'
 require 'splitclient-rb/localhost_split_factory'
 require 'splitclient-rb/split_config'
 require 'splitclient-rb/split_logger'
+require 'splitclient-rb/validators'
+require 'splitclient-rb/split_factory_registry'
 
 require 'splitclient-rb/engine/api/faraday_middleware/gzip'
 require 'splitclient-rb/engine/api/faraday_adapter/patched_net_http_persistent'
@@ -82,7 +84,6 @@ require 'splitclient-rb/engine/models/split'
 require 'splitclient-rb/engine/models/label'
 require 'splitclient-rb/engine/models/treatment'
 require 'splitclient-rb/utilitites'
-require 'splitclient-rb/validators'
 
 # redis metrics fixer
 require 'splitclient-rb/redis_metrics_fixer'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splitclient-rb
 version: !ruby/object:Gem::Version
-  version: 6.4.1
+  version: 7.0.0
 platform: ruby
 authors:
 - Split Software
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-26 00:00:00.000000000 Z
+date: 2019-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: allocation_stats
@@ -382,6 +382,7 @@ files:
 - lib/splitclient-rb/split_config.rb
 - lib/splitclient-rb/split_factory.rb
 - lib/splitclient-rb/split_factory_builder.rb
+- lib/splitclient-rb/split_factory_registry.rb
 - lib/splitclient-rb/split_logger.rb
 - lib/splitclient-rb/utilitites.rb
 - lib/splitclient-rb/validators.rb