splitclient-rb 7.3.5.pre.rc3-java → 8.0.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 186060ea5e282d91426d8c220d060fe34cf8a316
-  data.tar.gz: 2217aae3d87f3dd8ba0a09128ba5d7a064fb1fae
+  metadata.gz: 2128b5a5f0a81e696c26924a12bac52759201bef
+  data.tar.gz: 56dec10fff8a05840b779473b91965525fbefcbb
 SHA512:
-  metadata.gz: e3e69c550554845b3b27ae2132a86c25e2d2f0b49c001baacdea33feec117f8ce5778ff004ccfe44388841b384d9a086db43eeb89997e2159503361adda3525b
-  data.tar.gz: fdc0ec71a389b8f48f9d941cca7bf2571d3e91cd85ee0f1ac03413e53ac8ea4367eb5d8d00b414c5649262f88cba4be8e70726d38d67cbf2f0a8c813ee830fa6
+  metadata.gz: 0d503d6990730dc6b009ef97637f136b6d043891456204528bde156b451dcf6ca41d37cb7a9dd7c58d7ae137953f49fd7b73914a556c617f6fd9ef706e83b515
+  data.tar.gz: 9fa60bb60e3e900381cf1882dc086cf6f96d04862f48ccb32f41e6ac6cc1ff62655f599d14402c9636889145f1479322fccc1c6c3b8007f3b20e1106f62b0c44

data/.github/workflows/ci.yml

@@ -1,10 +1,4 @@
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
+on: [push, pull_request]
 
 jobs:
   test:
@@ -14,16 +8,20 @@ jobs:
         image: redis
         ports:
           - 6379:6379
+    strategy:
+      matrix:
+        ruby: [ '2.5.0', '3.1.1' ]
+
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
         with:
           fetch-depth: 0
 
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.5
+          ruby-version: ${{ matrix.ruby }}
 
       - name: Install dependencies
         run: bundle install

data/.rubocop.yml

@@ -27,20 +27,6 @@ Metrics/ParameterLists:
 
 Metrics/LineLength:
   Max: 135
-  Exclude:
-    - spec/sse/**/*
-    - spec/integrations/**/*
-    - spec/engine/sync_manager_spec.rb
-    - spec/engine/auth_api_client_spec.rb
-    - spec/telemetry/synchronizer_spec.rb
-    - spec/splitclient/split_config_spec.rb
-    - spec/engine/push_manager_spec.rb
-    - spec/cache/senders/impressions_sender_adapter_spec.rb
-
-Style/BracesAroundHashParameters:
-  Exclude:
-    - spec/integrations/push_client_spec.rb
-    - spec/engine/synchronizer_spec.rb
 
 Metrics/BlockLength:
   Exclude:
@@ -51,8 +37,24 @@ Naming/FileName:
   Exclude:
     - splitclient-rb.gemspec
 
+Style/OptionalBooleanParameter:
+  Exclude:
+    - lib/splitclient-rb/engine/matchers/between_matcher.rb
+    - lib/splitclient-rb/engine/matchers/combining_matcher.rb
+    - lib/splitclient-rb/engine/matchers/equal_to_matcher.rb
+    - lib/splitclient-rb/engine/matchers/less_than_or_equal_to_matcher.rb
+    - lib/splitclient-rb/engine/matchers/greater_than_or_equal_to_matcher.rb
+
+Style/HashTransformKeys:
+  Exclude:
+    - lib/splitclient-rb/engine/matchers/combining_matcher.rb
+
+Style/RedundantReturn:
+  Exclude:
+    - lib/splitclient-rb/engine/common/impressions_manager.rb
+
 AllCops:
-  TargetRubyVersion: 2.3.6
+  TargetRubyVersion: 2.5
   Exclude:
     - gemfiles/* # excluded as appraisal generates them with errors
     - lib/*
@@ -70,3 +72,5 @@ AllCops:
     - lib/splitclient-rb/engine/synchronizer.rb
     - tmp/**/*
     - lib/splitclient-rb/sse/event_source/client.rb
+    - spec/**/*
+    - .simplecov

data/CHANGES.txt

@@ -1,5 +1,12 @@
 CHANGES
 
+8.0.0 (May 10, 2022)
+- BREAKING CHANGE: Deprecated support for ruby 2.3 and 2.4 versions. The minimum ruby version required is 2.5 now.
+- Updated redis command for config telemetry, using hset instead of rpush now.
+- Updated dependencies:
+  - rake to ~> 13.0
+  - faraday to >= 1.1, < 2.0
+
 7.3.4 (Feb 21, 2022)
 - Updated streaming events architecture with a new queue logic.
 - Fixed redis integration Pipelining command deprecation warning.

data/README.md

@@ -1,5 +1,5 @@
 # Split SDK for Ruby
-[![Build Status](https://travis-ci.com/splitio/ruby-client.svg?branch=master)](https://travis-ci.com/splitio/ruby-client)
+![Build Status](https://github.com/splitio/ruby-client/actions/workflows/ci.yml/badge.svg?branch=master)
 
 ## Overview
 This SDK is designed to work with Split, the platform for controlled rollouts, which serves features to your users via a Split feature flag to manage your complete customer experience.
@@ -7,7 +7,7 @@ This SDK is designed to work with Split, the platform for controlled rollouts, w
 [![Twitter Follow](https://img.shields.io/twitter/follow/splitsoftware.svg?style=social&label=Follow&maxAge=1529000)](https://twitter.com/intent/follow?screen_name=splitsoftware)
 
 ## Compatibility
-The Ruby SDK support Ruby version 2.3.0 or later and JRuby or 9.1.17 o later.
+The Ruby SDK support Ruby version 2.5.0 or later and JRuby or 9.1.17 o later.
 
 Also the Ruby SDK has been tested as a standalone app as well as using the following web servers:
  - Puma

data/Rakefile

@@ -3,7 +3,6 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
-require 'appraisal'
 
 Dir['tasks/**/*.rake'].each { |rake| load rake }
 
@@ -26,10 +25,4 @@ else
   end
 end
 
-if !ENV['APPRAISAL_INITIALIZED']
-  task :default do
-    sh 'appraisal install && rake appraisal && rake rubocop'
-  end
-else
-  task default: %i[spec rubocop]
-end
+task default: %i[spec rubocop]

data/lib/splitclient-rb/cache/fetchers/segment_fetcher.rb

@@ -30,16 +30,16 @@ module SplitIoClient
               fetch_segment(name, fetch_options) if change_number == -1
             end
           end
-        rescue StandardError => error
-          @config.log_found_exception(__method__.to_s, error)
+        rescue StandardError => e
+          @config.log_found_exception(__method__.to_s, e)
         end
 
         def fetch_segment(name, fetch_options = { cache_control_headers: false, till: nil })
           @semaphore.synchronize do
             segments_api.fetch_segments_by_names([name], fetch_options)
           end
-        rescue StandardError => error
-          @config.log_found_exception(__method__.to_s, error)
+        rescue StandardError => e
+          @config.log_found_exception(__method__.to_s, e)
         end
 
         def fetch_segments
@@ -48,8 +48,8 @@ module SplitIoClient
 
             true
           end
-        rescue StandardError => error
-          @config.log_found_exception(__method__.to_s, error)
+        rescue StandardError => e
+          @config.log_found_exception(__method__.to_s, e)
           false
         end
 

data/lib/splitclient-rb/cache/fetchers/split_fetcher.rb

@@ -36,8 +36,8 @@ module SplitIoClient
 
             { segment_names: data[:segment_names], success: true }
           end
-        rescue StandardError => error
-          @config.log_found_exception(__method__.to_s, error)
+        rescue StandardError => e
+          @config.log_found_exception(__method__.to_s, e)
           { segment_names: [], success: false }
         end
 

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

@@ -19,8 +19,8 @@ module SplitIoClient
             post_events if @size >= EVENTS_MAX_SIZE_BYTES || @adapter.length == @config.events_queue_size
 
             @telemetry_runtime_producer.record_events_stats(Telemetry::Domain::Constants::EVENTS_QUEUED, 1)
-          rescue StandardError => error
-            @config.log_found_exception(__method__.to_s, error)
+          rescue StandardError => e
+            @config.log_found_exception(__method__.to_s, e)
             @telemetry_runtime_producer.record_events_stats(Telemetry::Domain::Constants::EVENTS_DROPPED, 1)
           end
 

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

@@ -21,8 +21,8 @@ module SplitIoClient
 
         def post_events
           events_api.post(self.clear)
-        rescue StandardError => error
-          @config.log_found_exception(__method__.to_s, error)
+        rescue StandardError => e
+          @config.log_found_exception(__method__.to_s, e)
         end
 
         protected

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

@@ -78,8 +78,8 @@ module SplitIoClient
           end
           
           keys
-        rescue StandardError => error
-          @config.log_found_exception(__method__.to_s, error)
+        rescue StandardError => e
+          @config.log_found_exception(__method__.to_s, e)
           0
         end
 

data/lib/splitclient-rb/cache/routers/impression_router.rb

@@ -41,8 +41,8 @@ module SplitIoClient
         attributes: impression[:attributes]
       }
       @queue.push(imp) if @listener
-    rescue StandardError => error
-      @config.log_found_exception(__method__.to_s, error)
+    rescue StandardError => e
+      @config.log_found_exception(__method__.to_s, e)
     end
 
     def router_thread
@@ -50,8 +50,8 @@ module SplitIoClient
         loop do
           begin
             @listener.log(@queue.pop)
-          rescue StandardError => error
-            @config.log_found_exception(__method__.to_s, error)
+          rescue StandardError => e
+            @config.log_found_exception(__method__.to_s, e)
           end
         end
       end

data/lib/splitclient-rb/cache/senders/impressions_adapter/memory_sender.rb

@@ -31,17 +31,17 @@ module SplitIoClient
         def uniques_formatter(uniques)
           return if uniques.nil? || uniques.empty?
 
-          to_return = { mtks: [] }
+          to_return = { keys: [] }
           uniques.each do |key, value|
-            to_return[:mtks] << {
+            to_return[:keys] << {
               f: key,
               ks: value.to_a
             }
           end
 
           to_return
-        rescue StandardError => error
-          @config.log_found_exception(__method__.to_s, error)
+        rescue StandardError => e
+          @config.log_found_exception(__method__.to_s, e)
           nil
         end
 
@@ -61,8 +61,8 @@ module SplitIoClient
           end
 
           formated_counts
-        rescue StandardError => error
-          @config.log_found_exception(__method__.to_s, error)
+        rescue StandardError => e
+          @config.log_found_exception(__method__.to_s, e)
           nil
         end
       end

data/lib/splitclient-rb/cache/senders/impressions_adapter/redis_sender.rb

@@ -29,8 +29,6 @@ module SplitIoClient
             impressions_count.each do |key, value|
               pipeline.hincrby(impressions_count_key, key, value)
             end
-            
-            @future = pipeline.hlen(impressions_count_key)
           end
 
           expire_impressions_count_key(impressions_count, result)
@@ -67,8 +65,8 @@ module SplitIoClient
           end
 
           to_return
-        rescue StandardError => error
-          @config.log_found_exception(__method__.to_s, error)
+        rescue StandardError => e
+          @config.log_found_exception(__method__.to_s, e)
           nil
         end
       end

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

@@ -24,7 +24,7 @@ module SplitIoClient
                 sleep(@config.counter_refresh_rate)
                 post_impressions_count                
               end
-            rescue SplitIoClient::SDKShutdownException              
+            rescue SplitIoClient::SDKShutdownException
               post_impressions_count
 
               @config.logger.info('Posting impressions count due to shutdown')
@@ -34,8 +34,8 @@ module SplitIoClient
 
         def post_impressions_count
           @impressions_sender_adapter.record_impressions_count(@impression_counter.pop_all)
-        rescue StandardError => error
-          @config.log_found_exception(__method__.to_s, error)
+        rescue StandardError => e
+          @config.log_found_exception(__method__.to_s, e)
         end
       end
     end

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

@@ -39,8 +39,8 @@ module SplitIoClient
             .call(fetch_all_impressions)
 
           impressions_api.post(formatted_impressions)
-        rescue StandardError => error
-          @config.log_found_exception(__method__.to_s, error)
+        rescue StandardError => e
+          @config.log_found_exception(__method__.to_s, e)
         end
 
         def impressions_api

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

@@ -46,10 +46,10 @@ module SplitIoClient
           end
 
           @status_manager.ready! if @status_manager
-        rescue StandardError => error
+        rescue StandardError => e
           @config.logger.error('Error while parsing the split file. ' \
             'Check that the input file matches the expected format')
-          @config.log_found_exception(__method__.to_s, error)
+          @config.log_found_exception(__method__.to_s, e)
         end
 
         def store_split(split)

data/lib/splitclient-rb/clients/split_client.rb

@@ -110,8 +110,8 @@ module SplitIoClient
       @events_repository.add(key.to_s, traffic_type_name.downcase, event_type.to_s, (Time.now.to_f * 1000).to_i, value, properties, properties_size)
       record_latency(TRACK, start)
       true
-    rescue StandardError => error
-      @config.log_found_exception(__method__.to_s, error)
+    rescue StandardError => e
+      @config.log_found_exception(__method__.to_s, e)
       record_exception(TRACK)
 
       false
@@ -291,8 +291,8 @@ module SplitIoClient
         
         impression = @impressions_manager.build_impression(matching_key, bucketing_key, split_name, treatment_data, { attributes: attributes, time: nil })
         impressions << impression unless impression.nil?
-      rescue StandardError => error
-        @config.log_found_exception(__method__.to_s, error)
+      rescue StandardError => e
+        @config.log_found_exception(__method__.to_s, e)
 
         record_exception(calling_method)
 

data/lib/splitclient-rb/engine/api/client.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'net/http/persistent'
-
 module SplitIoClient
   module Api
     class Client
@@ -54,33 +52,12 @@ module SplitIoClient
       private
 
       def api_client
-        if needs_patched_net_http_persistent_adapter?
-          require 'splitclient-rb/engine/api/faraday_adapter/patched_net_http_persistent'
-
-          Faraday::Adapter.register_middleware(
-            net_http_persistent: SplitIoClient::FaradayAdapter::PatchedNetHttpPersistent
-          )
-        end
-
         @api_client ||= Faraday.new do |builder|
           builder.use SplitIoClient::FaradayMiddleware::Gzip
           builder.adapter :net_http_persistent
         end
       end
 
-      def needs_patched_net_http_persistent_adapter?
-        new_net_http_persistent? && incompatible_faraday_version?
-      end
-
-      def incompatible_faraday_version?
-        version = Faraday::VERSION.split('.')[0..1]
-        version[0].to_i == 0 && version[1].to_i < 13
-      end
-
-      def new_net_http_persistent?
-        Net::HTTP::Persistent::VERSION.split('.').first.to_i >= 3
-      end
-
       def common_headers(api_key)
         {
           'Authorization' => "Bearer #{api_key}",

data/lib/splitclient-rb/engine/api/telemetry_api.rb

@@ -18,9 +18,9 @@ module SplitIoClient
       end
 
       def record_unique_keys(uniques)
-        return if uniques[:mtks].empty?
+        return if uniques[:keys].empty?
 
-        post_telemetry("#{@config.telemetry_service_url}/mtks/ss", uniques, 'mtks')
+        post_telemetry("#{@config.telemetry_service_url}/keys/ss", uniques, 'unique_keys')
       rescue StandardError => e
         @config.log_found_exception(__method__.to_s, e)
       end

data/lib/splitclient-rb/engine/auth_api_client.rb

@@ -85,8 +85,8 @@ module SplitIoClient
         control_pri = SplitIoClient::Constants::CONTROL_PRI
         control_sec = SplitIoClient::Constants::CONTROL_SEC
         channels_string = channels_string.gsub(control_pri, "#{prefix}#{control_pri}")
-        channels_string = channels_string.gsub(control_sec, "#{prefix}#{control_sec}")
-        channels_string
+
+        channels_string.gsub(control_sec, "#{prefix}#{control_sec}")
       end
     end
   end

data/lib/splitclient-rb/engine/common/impressions_manager.rb

@@ -9,15 +9,13 @@ module SplitIoClient
                        impression_counter,
                        telemetry_runtime_producer,
                        impression_observer,
-                       unique_keys_tracker,
-                       impression_router)
+                       unique_keys_tracker)
           @config = config
           @impressions_repository = impressions_repository
           @impression_counter = impression_counter
           @impression_observer = impression_observer
           @telemetry_runtime_producer = telemetry_runtime_producer
           @unique_keys_tracker = unique_keys_tracker
-          @impression_router = impression_router
         end
 
         def build_impression(matching_key, bucketing_key, split_name, treatment, params = {})
@@ -58,12 +56,18 @@ module SplitIoClient
             @config.log_found_exception(__method__.to_s, e)
           ensure
             record_stats(stats)
-            @impression_router.add_bulk(impressions)
+            impression_router.add_bulk(impressions)
           end
         end
 
         private
 
+        def impression_router
+          @impression_router ||= SplitIoClient::ImpressionRouter.new(@config)
+        rescue StandardError => e
+          @config.log_found_exception(__method__.to_s, e)
+        end
+
         def record_stats(stats)
           return if redis?
 

data/lib/splitclient-rb/engine/matchers/contains_all_matcher.rb

@@ -6,10 +6,6 @@ module SplitIoClient
 
     attr_reader :attribute
 
-    def initialize(attribute, remote_array, logger)
-      super(attribute, remote_array, logger)
-    end
-
     def match?(args)
       if @remote_set.empty?
         @logger.log_if_debug('[ContainsAllMatcher] Remote Set Empty')

data/lib/splitclient-rb/engine/matchers/contains_any_matcher.rb

@@ -6,10 +6,6 @@ module SplitIoClient
 
     attr_reader :attribute
 
-    def initialize(attribute, remote_array, logger)
-      super(attribute, remote_array, logger)
-    end
-
     def match?(args)
       matches = local_set(args[:attributes], @attribute).intersect? @remote_set
       @logger.log_if_debug("[ContainsAnyMatcher] Remote Set #{@remote_set} contains any \

data/lib/splitclient-rb/engine/matchers/equal_to_set_matcher.rb

@@ -6,10 +6,6 @@ module SplitIoClient
 
     attr_reader :attribute
 
-    def initialize(attribute, remote_array, logger)
-      super(attribute, remote_array, logger)
-    end
-
     def match?(args)
       set = local_set(args[:attributes], @attribute)
       matches = set == @remote_set

data/lib/splitclient-rb/engine/matchers/part_of_set_matcher.rb

@@ -6,10 +6,6 @@ module SplitIoClient
 
     attr_reader :attribute
 
-    def initialize(attribute, remote_array, logger)
-      super(attribute, remote_array, logger)
-    end
-
     def match?(args)
       @local_set = local_set(args[:attributes], @attribute)
 

data/lib/splitclient-rb/engine/push_manager.rb

@@ -41,17 +41,20 @@ module SplitIoClient
       private
 
       def schedule_next_token_refresh(time)
-        @config.threads[:schedule_next_token_refresh] = Thread.new do
-          begin
-            @config.logger.debug("schedule_next_token_refresh refresh in #{time} seconds.") if @config.debug_enabled
-            sleep(time)
-            @config.logger.debug('schedule_next_token_refresh starting ...') if @config.debug_enabled
-            @sse_handler.stop
-            start_sse
-          rescue StandardError => e
-            @config.logger.debug("schedule_next_token_refresh error: #{e.inspect}") if @config.debug_enabled
-          end
-        end
+        @config.threads[:schedule_next_token_refresh] = Thread.new { refresh_token_task(time) }
+      end
+
+      def refresh_token_task(time)
+        @config.logger.debug("schedule_next_token_refresh refresh in #{time} seconds.") if @config.debug_enabled
+
+        sleep(time)
+
+        @config.logger.debug('schedule_next_token_refresh starting ...') if @config.debug_enabled
+        @sse_handler.stop
+
+        start_sse
+      rescue StandardError => e
+        @config.logger.debug("schedule_next_token_refresh error: #{e.inspect}") if @config.debug_enabled
       end
 
       def record_telemetry(time)

data/lib/splitclient-rb/engine/synchronizer.rb

@@ -96,8 +96,8 @@ module SplitIoClient
         else
           @config.logger.debug("No changes fetched after #{attempts} attempts with CDN bypassed.") if @config.debug_enabled
         end
-      rescue StandardError => error
-        @config.log_found_exception(__method__.to_s, error)
+      rescue StandardError => e
+        @config.log_found_exception(__method__.to_s, e)
       end
 
       def fetch_segment(name, target_change_number)
@@ -132,8 +132,8 @@ module SplitIoClient
         else
           @config.logger.debug("No changes fetched for segment #{name} after #{attempts} attempts with CDN bypassed.") if @config.debug_enabled
         end
-      rescue StandardError => error
-        @config.log_found_exception(__method__.to_s, error)
+      rescue StandardError => e
+        @config.log_found_exception(__method__.to_s, e)
       end
 
       private

data/lib/splitclient-rb/split_config.rb

@@ -51,7 +51,7 @@ module SplitIoClient
 
       @segments_refresh_rate = opts[:segments_refresh_rate] || SplitConfig.default_segments_refresh_rate
 
-      @impressions_mode = init_impressions_mode(opts[:impressions_mode])
+      @impressions_mode = init_impressions_mode(opts[:impressions_mode], opts[:cache_adapter])
 
       @impressions_refresh_rate = SplitConfig.init_impressions_refresh_rate(@impressions_mode, opts[:impressions_refresh_rate], SplitConfig.default_impressions_refresh_rate)
       @impressions_queue_size = opts[:impressions_queue_size] || SplitConfig.default_impressions_queue_size
@@ -314,14 +314,16 @@ module SplitIoClient
       :optimized
     end
 
-    def init_impressions_mode(impressions_mode)
+    def init_impressions_mode(impressions_mode, adapter)
       impressions_mode ||= SplitConfig.default_impressions_mode
 
+      return :debug if adapter == :redis
+
       case impressions_mode
       when :debug
         return :debug
-      when :none
-        return :none
+      # when :none  // we not support :none impression mode yet. Defaulting to :optimized mode
+      #  return :none
       else
         @logger.error('You passed an invalid impressions_mode, impressions_mode should be one of the following values: :debug or :optimized. Defaulting to :optimized mode') unless impressions_mode == :optimized
         return :optimized

data/lib/splitclient-rb/split_factory.rb

@@ -65,7 +65,7 @@ module SplitIoClient
       build_streaming_components
       build_sync_manager
 
-      @sync_manager.start if @config.valid_mode
+      @sync_manager.start
     end
 
     def stop!
@@ -127,10 +127,10 @@ module SplitIoClient
     def validate_api_key
       if(@api_key.nil?)
         @config.logger.error('Factory Instantiation: you passed a nil api_key, api_key must be a non-empty String')
-        @config.valid_mode = false
+        @config.valid_mode =  false
       elsif (@api_key.empty?)
         @config.logger.error('Factory Instantiation: you passed and empty api_key, api_key must be a non-empty String')
-        @config.valid_mode = false
+        @config.valid_mode =  false
       end
     end
 
@@ -249,8 +249,7 @@ module SplitIoClient
       build_impressions_observer
       build_impression_counter
 
-      impression_router = ImpressionRouter.new(@config)
-      @impressions_manager = Engine::Common::ImpressionManager.new(@config, @impressions_repository, @impression_counter, @runtime_producer, @impression_observer, @unique_keys_tracker, impression_router)
+      @impressions_manager = Engine::Common::ImpressionManager.new(@config, @impressions_repository, @impression_counter, @runtime_producer, @impression_observer, @unique_keys_tracker)
     end
   end
 end