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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e671cc2e51a3805008b98809bccb0bf01f9a6d0
-  data.tar.gz: b182b2ce898ff203ffd495b71646ced49446b03e
+  metadata.gz: f6a5b99ba163bda9744577f231e0ed127d808c34
+  data.tar.gz: 72bbfaef6c8afe8dd3e3193c87d2b7f7e2447a37
 SHA512:
-  metadata.gz: 55a19aeb9a951a9ef18f11de72662879096b7b383103caa634811a5068a302a90d47b666fb32f3c735150f6aa2b01ba1811952e266ee6bc2518dbfe87b56d8f0
-  data.tar.gz: 9ea074692f9a588406dc035fc6df200fb76dbeeb0e73b0478da9f154c2d4b95605b4fdab3c4170f06ebfa6fb46f17b58aebd209c509b903c74baa1b0b0bea315
+  metadata.gz: 8403fd2036600e5a22fd06202365cca5063a71fa1668622b02509a89cf6233d7dcaf8229657a4cdd61398da5ea4282200a776096cefab33ce0f157e03082e7ee
+  data.tar.gz: 38f478dd7467fc9396430bcd69338026ddbe185dd789b09ec44022ea850a1244163a475732619f33915d2f7ebd3087df1ebb32a16457f082a1c7706700d937f9

data/CHANGES.txt

@@ -1,5 +1,19 @@
-6.3.0 (Apr 30, 2019)
+7.0.0 (Aug 23, 2019)
+ - BREAKING CHANGE: block_until_ready is now a method in both split_client and split_manager that needs to be explicitly called. The block_until_ready parameter is now ignored if passed in the configuration, and defaults to 15s unless passed as a parameter of the block_until_ready method.
+ - Added warning to track calls when traffic type does not belong to an existing split (only issued in the online client and when SDK is ready).
+ - Added warning to the get_treatment's method family when split does not exist in the current environment (only issued by online client and when SDK is ready).
+ - Added warning to the split_manager's split method when split does not exist in the current environment (only issued by online client and when SDK is ready).
+ - Added ability to create multiple split_factory instances. Added factory counts and warnings.
+ - Added SDK not ready impressions label.
+ - Changed the splits method implementation in the splits_repository to make use of get_splits, which outperforms the current implementation.
+
+6.4.1 (Jul 26, 2019)
+ - Fixed an issue in the latency metrics format preventing the synchronizer from correctly picking them up (consumer mode only). Old keys will be deleted on SDK startup.
 
+6.4.0 (Jul 05, 2019)
+ - Added properties to track method.
+
+6.3.0 (Apr 30, 2019)
 - Added Dynamic Configurations support through two new methods that mimick the regular ones, changing the type of what is returned.
   - get_treatment_with_config: Same as get_treatment but returning the treatment with it's config.
   - get_treatments_with_config: Same as get_treatments, but instead of a map of string it returns a map of treatments with config.

data/Detailed-README.md

@@ -72,15 +72,12 @@ else
 end
 ```
 
-**Note**: You can ensure the SDK resources are loaded before querying for treatments by using `block_until_ready`. See [Advanced Configuration](#advanced-configuration).
-``` ruby
-options = {
-  block_until_ready: 10
-}
+**Note**: You can ensure the SDK resources are loaded before querying for treatments by using `block_until_ready`.
 
-# Then init the factory passing the options hash
-factory  = SplitIoClient::SplitFactoryBuilder.build('YOUR_API_KEY', options)
+``` ruby
+factory  = SplitIoClient::SplitFactoryBuilder.build('YOUR_API_KEY')
 split_client = factory.client
+split_client.block_until_ready # Wait for a specified time (default 15 seconds). SDK raises an SDKBlockerTimeoutExpiredException if not ready by then
 ```
 
 For features that use targeting rules based on user attributes, you can call the `get_treatment` method the following way:
@@ -108,8 +105,6 @@ An scenario that requires the usage of both keys is a visitor user that browses
 
  Split solves this situation by introducing the concept of a matching_key and a bucketing key. By providing the `subscriber_id` as the `matching_key` and the `visitor_id` as the `bucketing_key`, Split will give the same treatment back to the user that it used to give to the visitor.
 
- **Note**: read more about this topic [here](https://docs.split.io/docs/anonymous-to-logged-in).
-
 The `bucketing_key` may be `nil`. In that case the `matching_key` would be used instead, so calling:
 ```ruby
 split_client.get_treatment(
@@ -174,6 +169,8 @@ Which would produce an output similar to:
 ]
  ```
 
+**Note**: `block_until_ready` is also available as a Split manager method
+
  #### Localhost Mode
 
  You can run the SDK in _localhost_ mode. In this mode, the SDK won't actually communicate with the Split API, but it'll rather return treatments based on a `.split` file on your local environment. This file must be a list of `split_name treatment_name_to_be_returned` entries. e.g.:
@@ -216,7 +213,7 @@ In order to provide consistency among the SDKs for the different programming lan
 
 - `matching_key`, `bucketing_key`: the containing `Hash` must have both keys, and the same rules above apply for each.
 
-- `split_name`: must be a non-empty `String` or a `Symbol`. Whitespaces will be trimmed from both ends of it. The trimmed version of the `split_name` will be used for both evaluation and to store the resulting impression.
+- `split_name`: must be a non-empty `String` or a `Symbol`. Whitespaces will be trimmed from both ends of it. The trimmed version of the `split_name` will be used for both evaluation and to store the resulting impression. In addition, split must exist in the environment.
 
 - `attributes`: must be of type `Hash`.
 
@@ -238,15 +235,12 @@ In order to provide consistency among the SDKs for the different programming lan
 
 #### split (split_manager)
 
-- `split_name`: must be a non-empty `String` or a `Symbol`.
+- `split_name`: must be a non-empty `String` or a `Symbol`. In addition, split must exist in the environment.
 
 #### Configuration Parameters
 
 - `api_key`: must be a non-empty `String` or a `Symbol` of type `sdk` (`browser` type API keys will break this rule).
 
-- `block_until_ready`: a warning log message will be issued if this value is not set.
-
-
 #### Client Destroyed Rules
 Calls to the SDK methods are still possible after `destroy` is called. All will log an error message stating _client has been destroyed_.
 
@@ -329,12 +323,6 @@ The following values can be customized:
 
 *default value* = (no impression listener)
 
-**block_until_ready** : The SDK will block your app for the provided amount of seconds until it's ready. A `SplitIoClient::SDKBlockerTimeoutExpiredException` will be thrown If the provided time expires. When `0` is provided, the SDK runs in non-blocking mode.
-
-_When using consumer mode, blocking has no effect._
-
-*default value* = `0`
-
 **labels_enabled** : Allows preventing labels from being sent to the Split servers, as they may contain sensitive information.
 
 *default value* = `true`
@@ -448,7 +436,7 @@ In the example above, the listener simply takes an impression and logs it to the
 The SDK is capable of running in two different modes to fit in different infrastructure configurations:
 
 - `:standalone` - (default) : The SDK will retrieve information (e.g. split definitions) periodically from the Split servers, and store it in the memory cache. It'll also store the application execution information (e.g. impressions) in the cache and send it periodically to the Split servers. As it name implies, in this mode, the SDK neither relies nor synchronizes with any other component. _This mode is only available when using the `memory` cache adapter._
-- `:consumer` - If using a load balancer or more than one SDK in your application, guaranteeing that all changes in split definitions are picked up by all SDK instances at the same time is highly recommended in order to ensure consistent results across your infrastructure (i.e. getting the same treatment for a specific split and user pair). To achieve this, use the [Split Synchronizer](https://docs.split.io/docs/split-synchronizer)) and setup your SDKs to work in the `consumer` mode. Setting the components this way, all communication with the Split server is orchestrated by the Synchronizer, while the SDKs pick up definitions and store the execution information from / into a shared Redis data store. _This mode is only available when using the `redis` cache adapter._
+- `:consumer` - If using a load balancer or more than one SDK in your application, guaranteeing that all changes in split definitions are picked up by all SDK instances at the same time is highly recommended in order to ensure consistent results across your infrastructure (i.e. getting the same treatment for a specific split and user pair). To achieve this, use the [Split Synchronizer](https://docs.split.io/docs/split-synchronizer)) and setup your SDKs to work in the `consumer` mode. Setting the components this way, all communication with the Split server is orchestrated by the Synchronizer, while the SDKs pick up definitions and store the execution information from / into a shared Redis data store. _This mode is only available when using the `redis` cache adapter. In addition, note that `block_until_ready` has no effect in this mode_
 
 _You can choose between these 2 modes setting the `mode` option in the config. An invalid combination of `cache_adaper` and `mode` will result in an Invalid Mode exception being raised._
 

data/NEWS

@@ -1,3 +1,6 @@
+6.4.0 (Jul 05, 2019)
+ - Added properties to track method.
+
 6.3.0 (Apr 30, 2019)
 
 - Added Dynamic Configurations support through two new methods that mimick the regular ones, changing the type of what is returned.

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'

data/lib/splitclient-rb/cache/adapters/cache_adapter.rb

@@ -7,9 +7,9 @@ module SplitIoClient
         extend Forwardable
         def_delegators :@adapter, :initialize_set, :set_bool, :pipelined
 
-        def initialize(adapter)
-          @cache = LruRedux::TTL::ThreadSafeCache.new(SplitIoClient.configuration.max_cache_size, SplitIoClient.configuration.cache_ttl)
-          @adapter = adapter
+        def initialize(config)
+          @cache = LruRedux::TTL::ThreadSafeCache.new(config.max_cache_size, config.cache_ttl)
+          @adapter = config.cache_adapter
         end
 
         def delete(key)

data/lib/splitclient-rb/cache/repositories/events/memory_repository.rb

@@ -5,8 +5,9 @@ module SplitIoClient
         class MemoryRepository < EventsRepository
           EVENTS_MAX_SIZE_BYTES = 5242880
 
-          def initialize(adapter)
-            @adapter = adapter
+          def initialize(config)
+            @config = config
+            @adapter = @config.events_adapter
             @size = 0
           end
 
@@ -14,10 +15,10 @@ module SplitIoClient
             @adapter.add_to_queue(m: metadata, e: event(key, traffic_type, event_type, time, value, properties))
             @size += event_size
 
-            post_events if @size >= EVENTS_MAX_SIZE_BYTES || @adapter.length == SplitIoClient.configuration.events_queue_size
+            post_events if @size >= EVENTS_MAX_SIZE_BYTES || @adapter.length == @config.events_queue_size
 
             rescue StandardError => error
-              SplitIoClient.configuration.log_found_exception(__method__.to_s, error)
+              @config.log_found_exception(__method__.to_s, error)
           end
 
           def clear

data/lib/splitclient-rb/cache/repositories/events/redis_repository.rb

@@ -4,8 +4,9 @@ module SplitIoClient
       module Events
         class RedisRepository < EventsRepository
 
-          def initialize(adapter)
-            @adapter = adapter
+          def initialize(config)
+            @config = config
+            @adapter = @config.events_adapter
           end
 
           def add(key, traffic_type, event_type, time, value, properties, size)
@@ -20,7 +21,7 @@ module SplitIoClient
               JSON.parse(e, symbolize_names: true)
             end
           rescue StandardError => e
-            SplitIoClient.configuration.logger.error("Exception while clearing events cache: #{e}")
+            @config.logger.error("Exception while clearing events cache: #{e}")
             []
           end
         end

data/lib/splitclient-rb/cache/repositories/events_repository.rb

@@ -6,12 +6,13 @@ module SplitIoClient
         extend Forwardable
         def_delegators :@repository, :add, :clear
 
-        def initialize(adapter, api_key)
-          @repository = case adapter.class.to_s
+        def initialize(config, api_key)
+          super(config)
+          @repository = case @config.events_adapter.class.to_s
           when 'SplitIoClient::Cache::Adapters::MemoryAdapter'
-            Repositories::Events::MemoryRepository.new(adapter)
+            Repositories::Events::MemoryRepository.new(@config)
           when 'SplitIoClient::Cache::Adapters::RedisAdapter'
-            Repositories::Events::RedisRepository.new(adapter)
+            Repositories::Events::RedisRepository.new(@config)
           end
 
           @api_key = api_key
@@ -20,16 +21,16 @@ module SplitIoClient
         def post_events
           events_api.post(self.clear)
         rescue StandardError => error
-          SplitIoClient.configuration.log_found_exception(__method__.to_s, error)
+          @config.log_found_exception(__method__.to_s, error)
         end
 
         protected
 
         def metadata
           {
-            s: "#{SplitIoClient.configuration.language}-#{SplitIoClient.configuration.version}",
-            i: SplitIoClient.configuration.machine_ip,
-            n: SplitIoClient.configuration.machine_name
+            s: "#{@config.language}-#{@config.version}",
+            i: @config.machine_ip,
+            n: @config.machine_name
           }
         end
 
@@ -47,7 +48,7 @@ module SplitIoClient
         private
 
         def events_api
-          @events_api ||= SplitIoClient::Api::Events.new(@api_key)
+          @events_api ||= SplitIoClient::Api::Events.new(@api_key, @config)
         end
       end
     end

data/lib/splitclient-rb/cache/repositories/impressions/memory_repository.rb

@@ -5,8 +5,9 @@ module SplitIoClient
     module Repositories
       module Impressions
         class MemoryRepository < ImpressionsRepository
-          def initialize(adapter)
-            @adapter = adapter
+          def initialize(config)
+            @config = config
+            @adapter = @config.impressions_adapter
           end
 
           # Store impression data in the selected adapter
@@ -23,8 +24,8 @@ module SplitIoClient
             )
           rescue ThreadError # queue is full
             if random_sampler.rand(1..1000) <= 2 # log only 0.2 % of the time
-              SplitIoClient.configuration.logger.warn("Dropping impressions. Current size is \
-                #{SplitIoClient.configuration.impressions_queue_size}. " \
+              @config.logger.warn("Dropping impressions. Current size is \
+                #{@config.impressions_queue_size}. " \
                 'Consider increasing impressions_queue_size')
             end
           end
@@ -36,9 +37,9 @@ module SplitIoClient
           end
 
           def batch
-            return [] if SplitIoClient.configuration.impressions_bulk_size.zero?
+            return [] if @config.impressions_bulk_size.zero?
 
-            @adapter.get_batch(SplitIoClient.configuration.impressions_bulk_size)
+            @adapter.get_batch(@config.impressions_bulk_size)
           end
 
           def clear

data/lib/splitclient-rb/cache/repositories/impressions/redis_repository.rb

@@ -7,8 +7,9 @@ module SplitIoClient
         class RedisRepository < ImpressionsRepository
           EXPIRE_SECONDS = 3600
 
-          def initialize(adapter)
-            @adapter = adapter
+          def initialize(config)
+            @config = config
+            @adapter = @config.impressions_adapter
           end
 
           def add(matching_key, bucketing_key, split_name, treatment, time)
@@ -42,12 +43,12 @@ module SplitIoClient
               impression
             end
           rescue StandardError => e
-            SplitIoClient.configuration.logger.error("Exception while clearing impressions cache: #{e}")
+            @config.logger.error("Exception while clearing impressions cache: #{e}")
             []
           end
 
           def batch
-            get_impressions(SplitIoClient.configuration.impressions_bulk_size)
+            get_impressions(@config.impressions_bulk_size)
           end
 
           def clear

data/lib/splitclient-rb/cache/repositories/impressions_repository.rb

@@ -8,12 +8,13 @@ module SplitIoClient
         extend Forwardable
         def_delegators :@adapter, :add, :add_bulk, :batch, :clear, :empty?
 
-        def initialize(adapter)
-          @adapter = case adapter.class.to_s
+        def initialize(config)
+          super(config)
+          @adapter = case @config.impressions_adapter.class.to_s
                      when 'SplitIoClient::Cache::Adapters::MemoryAdapter'
-                       Repositories::Impressions::MemoryRepository.new(adapter)
+                       Repositories::Impressions::MemoryRepository.new(@config)
                      when 'SplitIoClient::Cache::Adapters::RedisAdapter'
-                       Repositories::Impressions::RedisRepository.new(adapter)
+                       Repositories::Impressions::RedisRepository.new(@config)
                      end
         end
 
@@ -33,14 +34,14 @@ module SplitIoClient
 
         def metadata
           {
-            s: "#{SplitIoClient.configuration.language}-#{SplitIoClient.configuration.version}",
-            i: SplitIoClient.configuration.machine_ip,
-            n: SplitIoClient.configuration.machine_name
+            s: "#{@config.language}-#{@config.version}",
+            i: @config.machine_ip,
+            n: @config.machine_name
           }
         end
 
         def applied_rule(label)
-          SplitIoClient.configuration.labels_enabled ? label : nil
+          @config.labels_enabled ? label : nil
         end
       end
     end

data/lib/splitclient-rb/cache/repositories/metrics/memory_repository.rb

@@ -5,10 +5,11 @@ module SplitIoClient
         class MemoryRepository
           OPERATIONS = %w(sdk.get_treatment sdk.get_treatments sdk.get_treatment_with_config sdk.get_treatments_with_config)
 
-          def initialize(_ = nil, adapter)
+          def initialize(_ = nil, config)
             @counts = []
             @latencies = []
             @gauges = []
+            @config = config
           end
 
           def add_count(counter, delta)
@@ -127,7 +128,7 @@ module SplitIoClient
           end
 
           private
-          
+
           def increase_latency_bucket(operation, index)
             operation_latencies = find_operation_latencies(operation)
 

data/lib/splitclient-rb/cache/repositories/metrics/redis_repository.rb

@@ -3,8 +3,9 @@ module SplitIoClient
     module Repositories
       module Metrics
         class RedisRepository < Repository
-          def initialize(adapter = nil)
-            @adapter = adapter
+          def initialize(config)
+            @config = config
+            @adapter = config.metrics_adapter
           end
 
           def add_count(counter, delta)
@@ -78,7 +79,7 @@ module SplitIoClient
 
             keys.concat @adapter.find_strings_by_pattern(latencies_to_be_deleted_key_pattern_prefix('*.time'))
 
-            SplitIoClient.configuration.logger.info("Found incorrect latency keys, deleting. Keys: #{keys}") unless keys.size == 0
+            @config.logger.info("Found incorrect latency keys, deleting. Keys: #{keys}") unless keys.size == 0
 
             keys.each_slice(500) do |chunk|
               @adapter.pipelined do
@@ -90,7 +91,7 @@ module SplitIoClient
           end
 
           def latencies_to_be_deleted_key_pattern_prefix(key)
-            "#{SplitIoClient.configuration.redis_namespace}/#{SplitIoClient.configuration.language}-*/latency.#{key}"
+            "#{@config.redis_namespace}/#{@config.language}-*/latency.#{key}"
           end
 
           def clear_gauges

data/lib/splitclient-rb/cache/repositories/metrics_repository.rb

@@ -7,14 +7,16 @@ module SplitIoClient
         def_delegators :@adapter, :add_count, :add_latency, :add_gauge, :counts, :latencies, :gauges,
                        :clear_counts, :clear_latencies, :clear_gauges, :clear, :fix_latencies
 
-        def initialize(adapter)
-          @adapter = case adapter.class.to_s
+        def initialize(config)
+          super(config)
+          @adapter = case @config.metrics_adapter.class.to_s
           when 'SplitIoClient::Cache::Adapters::MemoryAdapter'
-            Repositories::Metrics::MemoryRepository.new(adapter)
+            Repositories::Metrics::MemoryRepository.new(@config)
           when 'SplitIoClient::Cache::Adapters::RedisAdapter'
-            Repositories::Metrics::RedisRepository.new(adapter)
+            Repositories::Metrics::RedisRepository.new(@config)
           end
         end
+
       end
     end
   end

data/lib/splitclient-rb/cache/repositories/repository.rb

@@ -1,6 +1,11 @@
 module SplitIoClient
   module Cache
     class Repository
+
+      def initialize(config)
+        @config = config
+      end
+
       def set_string(key, str)
         @adapter.set_string(namespace_key(key), str)
       end
@@ -12,11 +17,11 @@ module SplitIoClient
       protected
 
       def namespace_key(key = '')
-        "#{SplitIoClient.configuration.redis_namespace}#{key}"
+        "#{@config.redis_namespace}#{key}"
       end
 
       def impressions_metrics_key(key)
-        namespace_key("/#{SplitIoClient.configuration.language}-#{SplitIoClient.configuration.version}/#{SplitIoClient.configuration.machine_ip}/#{key}")
+        namespace_key("/#{@config.language}-#{@config.version}/#{@config.machine_ip}/#{key}")
       end
     end
   end