splitclient-rb 6.3.0 → 8.11.0

data/NEWS

@@ -1,141 +0,0 @@
-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.
-- Added configs to SplitViews returned by the manager module.
-- Updated localhost mode. Now besides supporting the old text files with `.split` extension (to be deprecated soon), we support YAML (.yaml/.yml) files where you can
-  define configurations for your treatments and also whitelisted keys. Read more in our docs!
-  
-6.2.0
-Ensure SDK flushes information to Split servers on client destroy
-Fix for compatibility issue between Faraday < 0.13 and net-http-persistent 3
-Change default features refresh rate interval to 5 seconds
-
-6.1.0
-
-Review input validation for client API methods: get_treatment, get_treatments, track, manager. Add input validation to block_until_ready, client startup, and destroy
-Add additional logging to the SDK Client in order to help debug matcher related issues
-Fix for issue causing redis_url parameter to be ignored
-
-6.0.1
-
-Fix an issue in events and impressions API calls log messages introduced in 6.0.0
-
-6.0.0
-
-BREAKING CHANGE: Remove producer mode, make memory adapter mandatory in standalone mode, and Redis adapter mandatory in consumer mode.
-BREAKING CHANGE: Reduce the total number of Redis operations of the SDK by changing the impressions storage format and adding a memory cache for splits and segments. It requires to have Split Synchronizer > v2.0.0 running if you are using Redis.
-SDK is now compatible with net-http-persistent 3.0.
-
-5.1.2
-
-Add input validation for client API methods: get_treatment, get_treatments, track, manager
-
-5.1.1
-
-Reduces the number of calls to Redis when calling #client.get_treatments using such cache adapter.
-
-5.1.0
-
-Prevent unhandled exceptions from raising when API get calls fail on Segments and Treatments.
-
-5.0.3
-
-Creates a new configuration parameter (impressions_bulk_size) to manage the max number of impressions sent to the Split backend on each post.
-Changes impressions_queue_size so that it manages only the queue size in the memory adapter.
-A backwards compatibility fail safe is included for users of previous SDK versions.
-
-5.0.2
-
-Turn Impression Listener into an optional SDK feature.
-Prevents the impression thread from being started if a listener is not in place
-
-5.0.1
-
-Adding stop! method to the factory.
-With this method the user will be able to stop the threads that queries the Split Service. This will be used in the before_fork configuration in Puma and Unicorn to stop the threads in the master process.
-
-5.0.0
-
-This is a breaking change in how users buckets are allocated.
-Ruby SDK was wrongly picking up the right buckets and defauled to
-use a "legacy hashing" instead of our moder murmur3 algo which is
-what other SDKs use. Please reach out to support@split.io for help
-on how to upgrade to this release.
-
-4.5.0
-
-Add JRuby support
-
-4.4.0
-
-Add the ability to send event data to split service (.track() api)
-
-4.3.0
-
-Add support for impression listener, there is an ability to use user-defined class to capture all impressions
-Now you can apply attribute matcher to the traffic type
-
-4.2.0
-
-Introduce new matchers: boolean and regexp (string).
-Remove unneeded dependencies
-Introduce dependency matcher, which allows treatment of one split to depend on the evaluation of another.
-
-4.1.0
-
-Introduce set matchers: part of set, contains all and contains any, starts with, ends with and contains.
-
-4.0.0
-
-Add support for murmur3 hashing algorithm
-Optimize gem memory usage
-
-3.3.0
-
-Add support for traffic allocation
-
-3.1.0
-
-Now supporting Redis as a cache adapter
-Factory is build now as SplitIoClient::SplitFactoryBuilder.build('<API_KEY>')
-
-3.0.2
-
-now support also client.get_treatment( { :matching_key = 'bb' , "bucketing_key = ''}, ....)
-
-2.0.1
-
-No news for this release
-
-2.0.0
-
-Instantiation of the split client is now through a factory:
-
-  factory = SplitIoClient::SplitFactory.new("rbk5je8be5qflpa047m17fe4ra", options)
-  client = factory.client
-  manager = factory.manager
-
-1.0.4
-
-Added AND combiner for conditions support. Added events_uri config param which is the url where the metrics post are send to.
-
-1.0.3
-
-This version of the gem fixes two minor bugs related to the config option for the refresh rates, as well as an inconsistency for the split definitions that are not created from the web app, but directly from the api instead.
-
-1.0.2
-
-Support for all the new matchers including: number comparison with >=, <=, =, between; date comparison with is on or before, is on or after, is on, between; attribute value in a defined set of values.
-No other major updates for this release.
-
-1.0.1
-
-isTreatment was removed from the API
-local environment file was removed to match the rest of the SDKs. "split".
-No other major updates for this release.
-
-1.0.0
-
-No news for this release.

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

@@ -1,127 +0,0 @@
-module SplitIoClient
-  module Cache
-    module Repositories
-      module Metrics
-        class MemoryRepository
-          def initialize(_ = nil, adapter)
-            @counts = []
-            @latencies = []
-            @gauges = []
-          end
-
-          def add_count(counter, delta)
-            counter_hash = @counts.find { |c| c[:name] == counter }
-            if counter_hash.nil?
-              counter_delta = SumAndCount.new
-              counter_delta.add_delta(delta)
-              @counts << { name: counter, delta: counter_delta }
-            else
-              counter_hash[:delta].add_delta(delta)
-            end
-          end
-
-          def add_latency(operation, time_in_ms, binary_search)
-            operation_hash = @latencies.find { |l| l[:operation] == operation }
-            if operation_hash.nil?
-              latencies_for_op = (operation == 'sdk.get_treatment') ? binary_search.add_latency_millis(time_in_ms) : [time_in_ms]
-              @latencies << { operation: operation, latencies: latencies_for_op }
-            else
-              latencies_for_op = (operation == 'sdk.get_treatment') ? binary_search.add_latency_millis(time_in_ms) : operation_hash[:latencies].push(time_in_ms)
-            end
-          end
-
-          def add_gauge(gauge, value)
-            gauge_hash = @gauges.find { |g| g[:name] == gauge }
-            if gauge_hash.nil?
-              gauge_value = ValueAndCount.new
-              gauge_value.set_value(value)
-              @gauges << { name: gauge, value: gauge_value }
-            else
-              gauge_hash[:value].set_value(value)
-            end
-          end
-
-          def counts
-            @counts.each_with_object({}) do |count, memo|
-              memo[count[:name]] = count[:delta].sum
-            end
-          end
-
-          def latencies
-            @latencies.each_with_object({}) do |latency, memo|
-              memo[latency[:operation]] = latency[:latencies]
-            end
-          end
-
-          def gauges
-            # TODO
-          end
-
-          def clear_counts
-            @counts = []
-          end
-
-          def clear_latencies
-            @latencies = []
-          end
-
-          def clear_gauges
-            @gauges = []
-          end
-
-          def clear
-            clear_counts
-            clear_latencies
-            clear_gauges
-          end
-
-          #
-          # small class to act as DTO for counts
-          #
-          class SumAndCount
-            attr_reader :count
-            attr_reader :sum
-
-            def initialize
-              @count = 0
-              @sum = 0
-            end
-
-            def add_delta(delta)
-              @count += 1
-              @sum += delta
-            end
-
-            def clear
-              @count = 0
-              @sum = 0
-            end
-          end
-
-          #
-          # small class to act as DTO for gauges
-          #
-          class ValueAndCount
-            attr_reader :count
-            attr_reader :value
-
-            def initialize
-              @count = 0
-              @value = 0
-            end
-
-            def set_value(value)
-              @count += 1
-              @value = value
-            end
-
-            def clear
-              @count = 0
-              @value = 0
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,96 +0,0 @@
-module SplitIoClient
-  module Cache
-    module Repositories
-      module Metrics
-        class RedisRepository < Repository
-          def initialize(adapter = nil)
-            @adapter = adapter
-          end
-
-          def add_count(counter, delta)
-            prefixed_name = impressions_metrics_key("count.#{counter}")
-            counts = @adapter.find_strings_by_prefix(prefixed_name)
-
-            @adapter.inc(prefixed_name, delta)
-          end
-
-          def add_latency(operation, time_in_ms, binary_search)
-            prefixed_name = impressions_metrics_key("latency.#{operation}")
-
-            if operation == 'sdk.get_treatment'
-              @adapter.inc("#{prefixed_name}.#{binary_search.add_latency_millis(time_in_ms, true)}")
-              return
-            end
-
-            @adapter.append_to_string(prefixed_name, "#{time_in_ms},")
-          end
-
-          def add_gauge(gauge, value)
-            # TODO
-          end
-
-          def counts
-            keys = @adapter.find_strings_by_prefix(impressions_metrics_key("count"))
-
-            return [] if keys.empty?
-
-            @adapter.multiple_strings(keys).map do |name, data|
-              [name.gsub(impressions_metrics_key('count.'), ''), data]
-            end.to_h
-          end
-
-          def latencies
-            collected_latencies = {}
-            latencies_array = Array.new(BinarySearchLatencyTracker::BUCKETS.length, 0)
-            keys = @adapter.find_strings_by_prefix(impressions_metrics_key('latency'))
-
-            return [] if keys.empty?
-
-            found_latencies = @adapter.multiple_strings(keys).map do |name, data|
-              [name.gsub(impressions_metrics_key('latency.'), ''), data]
-            end.to_h
-
-            found_latencies.each do |key, value|
-              if key.start_with?('sdk.get_treatment')
-                index = key.gsub('sdk.get_treatment.', '').to_i
-                latencies_array[index] = value.to_i
-
-                next
-              end
-
-              collected_latencies[key] = value.split(',').map(&:to_f)
-            end
-
-            collected_latencies['sdk.get_treatment'] = latencies_array unless latencies_array.reduce(:+) == 0
-
-            collected_latencies
-          end
-
-          def gauges
-            # TODO
-          end
-
-          def clear_counts
-            keys = @adapter.find_strings_by_prefix(impressions_metrics_key('count'))
-            @adapter.delete(keys)
-          end
-
-          def clear_latencies
-            keys = @adapter.find_strings_by_prefix(impressions_metrics_key('latency'))
-            @adapter.delete(keys)
-          end
-
-          def clear_gauges
-            # TODO
-          end
-
-          def clear
-            clear_counts
-            clear_latencies
-            clear_gauges
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,21 +0,0 @@
-module SplitIoClient
-  module Cache
-    module Repositories
-      # Repository which forwards impressions interface to the selected adapter
-      class MetricsRepository < Repository
-        extend Forwardable
-        def_delegators :@adapter, :add_count, :add_latency, :add_gauge, :counts, :latencies, :gauges,
-                       :clear_counts, :clear_latencies, :clear_gauges, :clear
-
-        def initialize(adapter)
-          @adapter = case adapter.class.to_s
-          when 'SplitIoClient::Cache::Adapters::MemoryAdapter'
-            Repositories::Metrics::MemoryRepository.new(adapter)
-          when 'SplitIoClient::Cache::Adapters::RedisAdapter'
-            Repositories::Metrics::RedisRepository.new(adapter)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/splitclient-rb/cache/senders/metrics_sender.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-module SplitIoClient
-  module Cache
-    module Senders
-      class MetricsSender
-        def initialize(metrics_repository, api_key)
-          @metrics_repository = metrics_repository
-          @api_key = api_key
-        end
-
-        def call
-          return if ENV['SPLITCLIENT_ENV'] == 'test'
-
-          metrics_thread
-
-          if defined?(PhusionPassenger)
-            PhusionPassenger.on_event(:starting_worker_process) do |forked|
-              metrics_thread if forked
-            end
-          end
-        end
-
-        private
-
-        def metrics_thread
-          SplitIoClient.configuration.threads[:metrics_sender] = Thread.new do
-            begin
-              SplitIoClient.configuration.logger.info('Starting metrics service')
-              
-              loop do
-                post_metrics
-
-                sleep(SplitIoClient::Utilities.randomize_interval(SplitIoClient.configuration.metrics_refresh_rate))
-              end
-            rescue SplitIoClient::SDKShutdownException
-              post_metrics
-
-              SplitIoClient.configuration.logger.info('Posting metrics due to shutdown')
-            end
-          end
-        end
-
-        def post_metrics
-          metrics_api.post
-        rescue StandardError => error
-          SplitIoClient.configuration.log_found_exception(__method__.to_s, error)
-        end
-
-        def metrics_api
-          @metrics_api ||= SplitIoClient::Api::Metrics.new(@api_key, @metrics_repository)
-        end
-      end
-    end
-  end
-end

data/lib/splitclient-rb/cache/stores/sdk_blocker.rb

@@ -1,46 +0,0 @@
-require 'thread'
-require 'timeout'
-
-module SplitIoClient
-  module Cache
-    module Stores
-      class SDKBlocker
-        attr_reader :splits_repository
-
-        def initialize(splits_repository, segments_repository)
-          @splits_repository = splits_repository
-          @segments_repository = segments_repository
-
-          @splits_repository.not_ready!
-          @segments_repository.not_ready!
-        end
-
-        def splits_ready!
-          @splits_repository.ready!
-        end
-
-        def segments_ready!
-          @segments_repository.ready!
-        end
-
-        def block
-          begin
-            Timeout::timeout(SplitIoClient.configuration.block_until_ready) do
-              sleep 0.1 until ready?
-            end
-          rescue Timeout::Error
-            fail SDKBlockerTimeoutExpiredException, 'SDK start up timeout expired'
-          end
-
-          SplitIoClient.configuration.logger.info('SplitIO SDK is ready')
-          SplitIoClient.configuration.threads[:split_store].run
-          SplitIoClient.configuration.threads[:segment_store].run
-        end
-
-        def ready?
-          @splits_repository.ready? && @segments_repository.ready?
-        end
-      end
-    end
-  end
-end

data/lib/splitclient-rb/cache/stores/segment_store.rb

@@ -1,81 +0,0 @@
-module SplitIoClient
-  module Cache
-    module Stores
-      class SegmentStore
-        attr_reader :segments_repository
-
-        def initialize(segments_repository, api_key, metrics, sdk_blocker = nil)
-          @segments_repository = segments_repository
-          @api_key = api_key
-          @metrics = metrics
-          @sdk_blocker = sdk_blocker
-        end
-
-        def call
-          if ENV['SPLITCLIENT_ENV'] == 'test'
-            store_segments
-          else
-            segments_thread
-
-            if defined?(PhusionPassenger)
-              PhusionPassenger.on_event(:starting_worker_process) do |forked|
-                segments_thread if forked
-              end
-            end
-          end
-        end
-
-        private
-
-        def segments_thread
-          SplitIoClient.configuration.threads[:segment_store] = Thread.new do
-            SplitIoClient.configuration.logger.info('Starting segments fetcher service')
-            SplitIoClient.configuration.block_until_ready > 0 ? blocked_store : unblocked_store
-          end
-        end
-
-        def blocked_store
-          loop do
-            next unless @sdk_blocker.splits_repository.ready?
-
-            store_segments
-            SplitIoClient.configuration.logger.debug("Segment names: #{@segments_repository.used_segment_names.to_a}") if SplitIoClient.configuration.debug_enabled
-
-            unless @sdk_blocker.ready?
-              @sdk_blocker.segments_ready!
-              SplitIoClient.configuration.logger.info('segments are ready')
-            end
-
-            sleep_for = random_interval(SplitIoClient.configuration.segments_refresh_rate)
-            SplitIoClient.configuration.logger.debug("Segments store is sleeping for: #{sleep_for} seconds") if SplitIoClient.configuration.debug_enabled
-            sleep(sleep_for)
-          end
-        end
-
-        def unblocked_store
-          loop do
-            store_segments
-
-            sleep(random_interval(SplitIoClient.configuration.segments_refresh_rate))
-          end
-        end
-
-        def store_segments
-          segments_api.store_segments_by_names(@segments_repository.used_segment_names)
-        rescue StandardError => error
-          SplitIoClient.configuration.log_found_exception(__method__.to_s, error)
-        end
-
-        def random_interval(interval)
-          random_factor = Random.new.rand(50..100) / 100.0
-
-          interval * random_factor
-        end
-
-        def segments_api
-          @segments_api ||= SplitIoClient::Api::Segments.new(@api_key, @metrics, @segments_repository)
-        end
-      end
-    end
-  end
-end

data/lib/splitclient-rb/cache/stores/split_store.rb

@@ -1,102 +0,0 @@
-module SplitIoClient
-  module Cache
-    module Stores
-      class SplitStore
-        attr_reader :splits_repository
-
-        def initialize(splits_repository, api_key, metrics, sdk_blocker = nil)
-          @splits_repository = splits_repository
-          @api_key = api_key
-          @metrics = metrics
-          @sdk_blocker = sdk_blocker
-        end
-
-        def call
-          if ENV['SPLITCLIENT_ENV'] == 'test'
-            store_splits
-          else
-            splits_thread
-
-            if defined?(PhusionPassenger)
-              PhusionPassenger.on_event(:starting_worker_process) do |forked|
-                splits_thread if forked
-              end
-            end
-          end
-        end
-
-        private
-
-        def splits_thread
-          SplitIoClient.configuration.threads[:split_store] = Thread.new do
-            SplitIoClient.configuration.logger.info('Starting splits fetcher service')
-            loop do
-              store_splits
-
-              sleep(random_interval(SplitIoClient.configuration.features_refresh_rate))
-            end
-          end
-        end
-
-        def store_splits
-          data = splits_since(@splits_repository.get_change_number)
-
-          data[:splits] && data[:splits].each do |split|
-            add_split_unless_archived(split)
-          end
-
-          @splits_repository.set_segment_names(data[:segment_names])
-          @splits_repository.set_change_number(data[:till])
-
-          SplitIoClient.configuration.logger.debug("segments seen(#{data[:segment_names].length}): #{data[:segment_names].to_a}") if SplitIoClient.configuration.debug_enabled
-
-          if SplitIoClient.configuration.block_until_ready > 0 && !@sdk_blocker.ready?
-            @sdk_blocker.splits_ready!
-            SplitIoClient.configuration.logger.info('splits are ready')
-          end
-
-        rescue StandardError => error
-          SplitIoClient.configuration.log_found_exception(__method__.to_s, error)
-        end
-
-        def random_interval(interval)
-          random_factor = Random.new.rand(50..100) / 100.0
-
-          interval * random_factor
-        end
-
-        def splits_since(since)
-          splits_api.since(since)
-        end
-
-        def add_split_unless_archived(split)
-          if Engine::Models::Split.archived?(split)
-            SplitIoClient.configuration.logger.debug("Seeing archived split #{split[:name]}") if SplitIoClient.configuration.debug_enabled
-
-            remove_archived_split(split)
-          else
-            store_split(split)
-          end
-        end
-
-        def remove_archived_split(split)
-          SplitIoClient.configuration.logger.debug("removing split from store(#{split})") if SplitIoClient.configuration.debug_enabled
-
-          @splits_repository.remove_split(split[:name])
-        end
-
-        def store_split(split)
-          SplitIoClient.configuration.logger.debug("storing split (#{split[:name]})") if SplitIoClient.configuration.debug_enabled
-
-          @splits_repository.add_split(split)
-        end
-
-        private
-
-        def splits_api
-          @splits_api ||= SplitIoClient::Api::Splits.new(@api_key, @metrics)
-        end
-      end
-    end
-  end
-end