splitclient-rb 7.3.0 → 7.3.2.pre.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf1cbb00018b7c3ea1bd9a1ac48076b764b52efa752133d989710bc1d70a97a7
-  data.tar.gz: 00c30f557c6beafea726021fc1a191c66cc9af8c1bdd4258afd06d636a6305c1
+  metadata.gz: a5e2471231a284347d54b5a8adb871e2b9de38178cbd0061c73cf6c8dbf8b427
+  data.tar.gz: 47ac7b25ae20621d2a28ce4bad187be9eae90035ce0b0e53d9666da71950f0e2
 SHA512:
-  metadata.gz: 385d7baa71c33a01e6bf877bcb400f63cc0481d49841e7861b7ced80b72f817918e776e656f7295f1e4c0c75a0875d65b08de20f018d81bbc50dd6fdf7e43771
-  data.tar.gz: f3d13b7eab32c3352b02ecfaf91da3b23acf168990e20f8a58c2c3753b2a55acce4061ae97c4eb7511c3262e65ab311ac75066f4b1438f68f086f7c5fe41fee7
+  metadata.gz: 92e5bb2e3bc64fec298790968d2f007a82819cb80838ed610f326db1dd95ac8b2618b0c98add8530f7bb7377d695e98a7581603040ec6ba04f17f45dcdb69a27
+  data.tar.gz: e1bf2c3b16fef2857f2556bb2e6997be2a11870f6c447b9cb069fa6c02b699a918f4d73cf2796101f3782ce6597f8bb0f871d8e78f0c56bf10c52a76055dd2ea

data/.github/workflows/ci.yml

@@ -0,0 +1,78 @@
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    services:
+      redis:
+        image: redis
+        ports:
+          - 6379:6379
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+        with:
+          ruby-version: 2.5
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run tests
+        run: bundle exec rake
+
+      - name: Fix code coverage paths
+        working-directory: ./coverage
+        run: |
+          sed -i 's@'$GITHUB_WORKSPACE'@/github/workspace/@g' .resultset.json
+          ruby -rjson -e 'sqube = JSON.load(File.read(".resultset.json"))["RSpec"]["coverage"].transform_values {|lines| lines["lines"]}; total = { "RSpec" => { "coverage" => sqube, "timestamp" => Time.now.to_i }}; puts JSON.dump(total)' > .resultset.sonarqube.json
+
+
+      - name: SonarQube Scan (Push)
+        if: github.event_name == 'push'
+        uses: SonarSource/sonarcloud-github-action@v1.5
+        env:
+          SONAR_TOKEN: ${{ secrets.SONARQUBE_TOKEN }}
+        with:
+          projectBaseDir: .
+          args: >
+            -Dsonar.host.url=${{ secrets.SONARQUBE_HOST }}
+            -Dsonar.projectName=${{ github.event.repository.name }}
+            -Dsonar.projectKey=${{ github.event.repository.name }}
+            -Dsonar.ruby.coverage.reportPaths=coverage/.resultset.sonarqube.json
+            -Dsonar.c.file.suffixes=-
+            -Dsonar.cpp.file.suffixes=-
+            -Dsonar.objc.file.suffixes=-
+            -Dsonar.links.ci="https://github.com/splitio/${{ github.event.repository.name }}/actions"
+            -Dsonar.links.scm="https://github.com/splitio/${{ github.event.repository.name }}"
+
+      - name: SonarQube Scan (Pull Request)
+        if: github.event_name == 'pull_request'
+        uses: SonarSource/sonarcloud-github-action@v1.5
+        env:
+          SONAR_TOKEN: ${{ secrets.SONARQUBE_TOKEN }}
+        with:
+          projectBaseDir: .
+          args: >
+            -Dsonar.host.url=${{ secrets.SONARQUBE_HOST }}
+            -Dsonar.projectName=${{ github.event.repository.name }}
+            -Dsonar.projectKey=${{ github.event.repository.name }}
+            -Dsonar.ruby.coverage.reportPaths=coverage/.resultset.sonarqube.json
+            -Dsonar.c.file.suffixes=-
+            -Dsonar.cpp.file.suffixes=-
+            -Dsonar.objc.file.suffixes=-
+            -Dsonar.links.ci="https://github.com/splitio/${{ github.event.repository.name }}/actions"
+            -Dsonar.links.scm="https://github.com/splitio/${{ github.event.repository.name }}"
+            -Dsonar.pullrequest.key=${{ github.event.pull_request.number }}
+            -Dsonar.pullrequest.branch=${{ github.event.pull_request.head.ref }}
+            -Dsonar.pullrequest.base=${{ github.event.pull_request.base.ref }}

data/.rubocop.yml

@@ -31,6 +31,7 @@ Metrics/LineLength:
     - spec/engine/sync_manager_spec.rb
     - spec/engine/auth_api_client_spec.rb
     - spec/telemetry/synchronizer_spec.rb
+    - spec/splitclient/split_config_spec.rb
 
 Style/BracesAroundHashParameters:
   Exclude:
@@ -62,3 +63,4 @@ AllCops:
     - lib/splitclient-rb/engine/models/**/*
     - lib/splitclient-rb/engine/parser/**/*
     - spec/telemetry/synchronizer_spec.rb
+    - lib/splitclient-rb/engine/synchronizer.rb

data/CHANGES.txt

@@ -1,5 +1,8 @@
 CHANGES
 
+7.3.1 (Jul 26, 2021)
+- Updated the synchronization flow to be more reliable in the event of an edge case generating delay in cache purge propagation, keeping the SDK cache properly synced.
+
 7.3.0 (Jul 12, 2021)
 - Updated SDK telemetry storage, metrics and updater to be more effective and send less often.
 - Fixed high cpu usage when api key is wrong.

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

@@ -4,11 +4,10 @@ module SplitIoClient
       class SegmentFetcher
         attr_reader :segments_repository
 
-        def initialize(segments_repository, api_key, config, sdk_blocker, telemetry_runtime_producer)
+        def initialize(segments_repository, api_key, config, telemetry_runtime_producer)
           @segments_repository = segments_repository
           @api_key = api_key
           @config = config
-          @sdk_blocker = sdk_blocker
           @semaphore = Mutex.new
           @telemetry_runtime_producer = telemetry_runtime_producer
         end
@@ -30,16 +29,19 @@ module SplitIoClient
         def fetch_segments_if_not_exists(names, cache_control_headers = false)
           names.each do |name|
             change_number = @segments_repository.get_change_number(name)
-
-            fetch_segment(name, cache_control_headers) if change_number == -1
+            
+            if change_number == -1
+              fetch_options = { cache_control_headers: cache_control_headers, till: nil }
+              fetch_segment(name, fetch_options) if change_number == -1
+            end
           end
         rescue StandardError => error
           @config.log_found_exception(__method__.to_s, error)
         end
 
-        def fetch_segment(name, cache_control_headers = false)
+        def fetch_segment(name, fetch_options = { cache_control_headers: false, till: nil })
           @semaphore.synchronize do
-            segments_api.fetch_segments_by_names([name], cache_control_headers)
+            segments_api.fetch_segments_by_names([name], fetch_options)
           end
         rescue StandardError => error
           @config.log_found_exception(__method__.to_s, error)
@@ -49,11 +51,11 @@ module SplitIoClient
           @semaphore.synchronize do
             segments_api.fetch_segments_by_names(@segments_repository.used_segment_names)
 
-            @sdk_blocker.segments_ready!
-            @sdk_blocker.sdk_internal_ready
+            true
           end
         rescue StandardError => error
           @config.log_found_exception(__method__.to_s, error)
+          false
         end
 
         def stop_segments_thread
@@ -67,11 +69,6 @@ module SplitIoClient
             @config.logger.info('Starting segments fetcher service') if @config.debug_enabled
 
             loop do
-              unless @sdk_blocker.splits_repository.ready?
-                sleep 0.2
-                next
-              end
-
               fetch_segments
               @config.logger.debug("Segment names: #{@segments_repository.used_segment_names.to_a}") if @config.debug_enabled
 

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

@@ -4,11 +4,10 @@ module SplitIoClient
       class SplitFetcher
         attr_reader :splits_repository
 
-        def initialize(splits_repository, api_key, config, sdk_blocker, telemetry_runtime_producer)
+        def initialize(splits_repository, api_key, config, telemetry_runtime_producer)
           @splits_repository = splits_repository
           @api_key = api_key
           @config = config
-          @sdk_blocker = sdk_blocker
           @semaphore = Mutex.new
           @telemetry_runtime_producer = telemetry_runtime_producer
         end
@@ -27,9 +26,9 @@ module SplitIoClient
           end
         end
 
-        def fetch_splits(cache_control_headers = false)
+        def fetch_splits(fetch_options = { cache_control_headers: false, till: nil })
           @semaphore.synchronize do
-            data = splits_since(@splits_repository.get_change_number, cache_control_headers)
+            data = splits_since(@splits_repository.get_change_number, fetch_options)
 
             data[:splits] && data[:splits].each do |split|
               add_split_unless_archived(split)
@@ -40,13 +39,11 @@ module SplitIoClient
 
             @config.logger.debug("segments seen(#{data[:segment_names].length}): #{data[:segment_names].to_a}") if @config.debug_enabled
 
-            @sdk_blocker.splits_ready!
-
-            data[:segment_names]
+            { segment_names: data[:segment_names], success: true }
           end
         rescue StandardError => error
           @config.log_found_exception(__method__.to_s, error)
-          []
+          { segment_names: [], success: false }
         end
 
         def stop_splits_thread
@@ -68,8 +65,8 @@ module SplitIoClient
           end
         end
 
-        def splits_since(since, cache_control_headers = false)
-          splits_api.since(since, cache_control_headers)
+        def splits_since(since, fetch_options = { cache_control_headers: false, till: nil })
+          splits_api.since(since, fetch_options)
         end
 
         def add_split_unless_archived(split)

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

@@ -7,10 +7,10 @@ module SplitIoClient
         require 'yaml'
         attr_reader :splits_repository
 
-        def initialize(splits_repository, config, sdk_blocker = nil)
+        def initialize(splits_repository, config, status_manager = nil)
           @splits_repository = splits_repository
           @config = config
-          @sdk_blocker = sdk_blocker
+          @status_manager = status_manager
         end
 
         def call
@@ -45,10 +45,7 @@ module SplitIoClient
             store_split(split)
           end
 
-          if @sdk_blocker
-            @sdk_blocker.splits_ready!
-            @sdk_blocker.segments_ready!
-          end
+          @status_manager.ready! if @status_manager
         rescue StandardError => error
           @config.logger.error('Error while parsing the split file. ' \
             'Check that the input file matches the expected format')

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

@@ -14,13 +14,13 @@ module SplitIoClient
     # @param api_key [String] the API key for your split account
     #
     # @return [SplitIoClient] split.io client instance
-    def initialize(api_key, repositories, sdk_blocker, config, impressions_manager, telemetry_evaluation_producer)
+    def initialize(api_key, repositories, status_manager, config, impressions_manager, telemetry_evaluation_producer)
       @api_key = api_key
       @splits_repository = repositories[:splits]
       @segments_repository = repositories[:segments]
       @impressions_repository = repositories[:impressions]
       @events_repository = repositories[:events]
-      @sdk_blocker = sdk_blocker
+      @status_manager = status_manager
       @destroyed = false
       @config = config
       @impressions_manager = impressions_manager
@@ -137,7 +137,7 @@ module SplitIoClient
       else
         {
           treatment: treatment_data[:treatment],
-          config: treatment_data[:config]
+          config: treatment_data[:config],
         }
       end
     end
@@ -157,7 +157,7 @@ module SplitIoClient
     end
 
     def block_until_ready(time = nil)
-      @sdk_blocker.block(time) if @sdk_blocker && !@sdk_blocker.ready?
+      @status_manager.wait_until_ready(time) if @status_manager
     end
 
     private
@@ -310,7 +310,7 @@ module SplitIoClient
     end
 
     def ready?
-      return @sdk_blocker.ready? if @sdk_blocker
+      return @status_manager.ready? if @status_manager
       true
     end
 

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

@@ -11,13 +11,14 @@ module SplitIoClient
         @telemetry_runtime_producer = telemetry_runtime_producer
       end
 
-      def fetch_segments_by_names(names, cache_control_headers = false)
+      def fetch_segments_by_names(names, fetch_options = { cache_control_headers: false, till: nil })
         return if names.nil? || names.empty?
 
         names.each do |name|
           since = @segments_repository.get_change_number(name)
+
           loop do
-            segment = fetch_segment_changes(name, since, cache_control_headers)
+            segment = fetch_segment_changes(name, since, fetch_options)
             @segments_repository.add_to_segment(segment)
 
             @config.split_logger.log_if_debug("Segment #{name} fetched before: #{since}, \
@@ -32,9 +33,12 @@ module SplitIoClient
 
       private
 
-      def fetch_segment_changes(name, since, cache_control_headers = false)
+      def fetch_segment_changes(name, since, fetch_options = { cache_control_headers: false, till: nil })
         start = Time.now
-        response = get_api("#{@config.base_uri}/segmentChanges/#{name}", @api_key, { since: since }, cache_control_headers)
+
+        params = { since: since }
+        params[:till] = fetch_options[:till] unless fetch_options[:till].nil?
+        response = get_api("#{@config.base_uri}/segmentChanges/#{name}", @api_key, params, fetch_options[:cache_control_headers])
 
         if response.success?
           segment = JSON.parse(response.body, symbolize_names: true)

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

@@ -10,10 +10,12 @@ module SplitIoClient
         @telemetry_runtime_producer = telemetry_runtime_producer
       end
 
-      def since(since, cache_control_headers = false)
+      def since(since, fetch_options = { cache_control_headers: false, till: nil })
         start = Time.now
-
-        response = get_api("#{@config.base_uri}/splitChanges", @api_key, { since: since }, cache_control_headers)
+        
+        params = { since: since }
+        params[:till] = fetch_options[:till] unless fetch_options[:till].nil?
+        response = get_api("#{@config.base_uri}/splitChanges", @api_key, params, fetch_options[:cache_control_headers])
         if response.success?
           result = splits_with_segment_names(response.body)
 

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: false
+
+module SplitIoClient
+  module Engine
+    BACKOFF_MAX_ALLOWED = 1.8
+    class BackOff
+      def initialize(back_off_base, attempt = 0, max_allowed = BACKOFF_MAX_ALLOWED)
+        @attempt = attempt
+        @back_off_base = back_off_base
+        @max_allowed = max_allowed
+      end
+
+      def interval
+        interval = 0
+        interval = (@back_off_base * (2**@attempt)) if @attempt.positive?
+        @attempt += 1
+
+        interval >= @max_allowed ? @max_allowed : interval
+      end
+
+      def reset
+        @attempt = 0
+      end
+    end
+  end
+end

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

@@ -21,8 +21,8 @@ module SplitIoClient
           @impression_counter.inc(split_name, impression_data[:m]) if optimized? && !redis?
 
           impression(impression_data, params[:attributes])
-        rescue StandardError => error
-          @config.log_found_exception(__method__.to_s, error)
+        rescue StandardError => e
+          @config.log_found_exception(__method__.to_s, e)
         end
 
         def track(impressions)
@@ -48,8 +48,8 @@ module SplitIoClient
           end
 
           record_stats(queued, dropped, dedupe)
-        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/engine/push_manager.rb

@@ -8,7 +8,7 @@ module SplitIoClient
         @sse_handler = sse_handler
         @auth_api_client = AuthApiClient.new(@config, telemetry_runtime_producer)
         @api_key = api_key
-        @back_off = SplitIoClient::SSE::EventSource::BackOff.new(@config.auth_retry_back_off_base, 1)
+        @back_off = Engine::BackOff.new(@config.auth_retry_back_off_base, 1)
         @telemetry_runtime_producer = telemetry_runtime_producer
       end
 

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Engine
+    class StatusManager
+      def initialize(config)
+        @config = config
+        @sdk_ready = Concurrent::CountDownLatch.new(1)
+      end
+
+      def ready?
+        return true if @config.consumer?
+
+        @sdk_ready.wait(0)
+      end
+
+      def ready!
+        return if ready?
+
+        @sdk_ready.count_down
+        @config.logger.info('SplitIO SDK is ready')
+      end
+
+      def wait_until_ready(seconds = nil)
+        return if @config.consumer?
+
+        timeout = seconds || @config.block_until_ready
+
+        raise SDKBlockerTimeoutExpiredException, 'SDK start up timeout expired' unless @sdk_ready.wait(timeout)
+      end
+    end
+  end
+end

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

@@ -12,8 +12,8 @@ module SplitIoClient
         config,
         synchronizer,
         telemetry_runtime_producer,
-        sdk_blocker,
-        telemetry_synchronizer
+        telemetry_synchronizer,
+        status_manager
       )
         @synchronizer = synchronizer
         notification_manager_keeper = SSE::NotificationManagerKeeper.new(config, telemetry_runtime_producer) do |manager|
@@ -33,56 +33,37 @@ module SplitIoClient
         @sse_connected = Concurrent::AtomicBoolean.new(false)
         @config = config
         @telemetry_runtime_producer = telemetry_runtime_producer
-        @sdk_blocker = sdk_blocker
         @telemetry_synchronizer = telemetry_synchronizer
+        @status_manager = status_manager
       end
 
       def start
-        if @config.streaming_enabled
-          start_stream
-          start_stream_forked if defined?(PhusionPassenger)
-        elsif @config.standalone?
-          start_poll
-        end
+        @config.threads[:start_sdk] = Thread.new do
+          sleep(0.5) until @synchronizer.sync_all(false)
 
-        synchronize_telemetry_config
-      end
+          @status_manager.ready!
+          @telemetry_synchronizer.synchronize_config
+          @synchronizer.start_periodic_data_recording
+          connected = false
 
-      private
-
-      # Starts tasks if stream is enabled.
-      def start_stream
-        @config.logger.debug('Starting push mode ...')
-        @synchronizer.sync_all
-        @synchronizer.start_periodic_data_recording
-
-        start_sse_connection_thread
-      end
+          if @config.streaming_enabled
+            @config.logger.debug('Starting Straming mode ...')
+            connected = @push_manager.start_sse
 
-      def start_poll
-        @config.logger.debug('Starting polling mode ...')
-        @synchronizer.start_periodic_fetch
-        @synchronizer.start_periodic_data_recording
-        record_telemetry(Telemetry::Domain::Constants::SYNC_MODE, SYNC_MODE_POLLING)
-      rescue StandardError => e
-        @config.logger.error("start_poll error : #{e.inspect}")
-      end
+            if defined?(PhusionPassenger)
+              PhusionPassenger.on_event(:starting_worker_process) { |forked| sse_thread_forked if forked }
+            end
+          end
 
-      # Starts thread which connect to sse and after that fetch splits and segments once.
-      def start_sse_connection_thread
-        @config.threads[:sync_manager_start_sse] = Thread.new do
-          begin
-            connected = @push_manager.start_sse
-            @synchronizer.start_periodic_fetch unless connected
-          rescue StandardError => e
-            @config.logger.error("start_sse_connection_thread error : #{e.inspect}")
+          unless connected
+            @config.logger.debug('Starting polling mode ...')
+            @synchronizer.start_periodic_fetch
+            record_telemetry(Telemetry::Domain::Constants::SYNC_MODE, SYNC_MODE_POLLING)
           end
         end
       end
 
-      def start_stream_forked
-        PhusionPassenger.on_event(:starting_worker_process) { |forked| start_stream if forked }
-      end
+      private
 
       def process_action(action)
         case action
@@ -165,16 +146,9 @@ module SplitIoClient
         @telemetry_runtime_producer.record_streaming_event(type, data)
       end
 
-      def synchronize_telemetry_config
-        @config.threads[:telemetry_config_sender] = Thread.new do
-          begin
-            @sdk_blocker.wait_unitil_internal_ready unless @config.consumer?
-            @telemetry_synchronizer.synchronize_config
-          rescue SplitIoClient::SDKShutdownException
-            @telemetry_synchronizer.synchronize_config
-            @config.logger.info('Posting Telemetry config due to shutdown')
-          end
-        end
+      def sse_thread_forked
+        connected = @push_manager.start_sse
+        @synchronizer.start_periodic_fetch unless connected
       end
     end
   end

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

@@ -6,13 +6,14 @@ module SplitIoClient
       include SplitIoClient::Cache::Fetchers
       include SplitIoClient::Cache::Senders
 
-      FORCE_CACHE_CONTROL_HEADERS = true
+      ON_DEMAND_FETCH_BACKOFF_BASE_SECONDS = 10
+      ON_DEMAND_FETCH_BACKOFF_MAX_WAIT_SECONDS = 60
+      ON_DEMAND_FETCH_BACKOFF_MAX_RETRIES = 10
 
       def initialize(
         repositories,
         api_key,
         config,
-        sdk_blocker,
         params
       )
         @splits_repository = repositories[:splits]
@@ -21,7 +22,6 @@ module SplitIoClient
         @events_repository = repositories[:events]
         @api_key = api_key
         @config = config
-        @sdk_blocker = sdk_blocker
         @split_fetcher = params[:split_fetcher]
         @segment_fetcher = params[:segment_fetcher]
         @impressions_api = SplitIoClient::Api::Impressions.new(@api_key, @config, params[:telemetry_runtime_producer])
@@ -29,12 +29,16 @@ module SplitIoClient
         @telemetry_synchronizer = params[:telemetry_synchronizer]
       end
 
-      def sync_all
+      def sync_all(asynchronous = true)
+        unless asynchronous
+          return sync_splits_and_segments
+        end
+
         @config.threads[:sync_all_thread] = Thread.new do
-          @config.logger.debug('Synchronizing Splits and Segments ...') if @config.debug_enabled
-          @split_fetcher.fetch_splits
-          @segment_fetcher.fetch_segments
+          sync_splits_and_segments
         end
+
+        true
       end
 
       def start_periodic_data_recording
@@ -54,19 +58,114 @@ module SplitIoClient
         @segment_fetcher.stop_segments_thread
       end
 
-      def fetch_splits
-        segment_names = @split_fetcher.fetch_splits(FORCE_CACHE_CONTROL_HEADERS)
-        @segment_fetcher.fetch_segments_if_not_exists(segment_names, FORCE_CACHE_CONTROL_HEADERS) unless segment_names.empty?
+      def fetch_splits(target_change_number)
+        return if target_change_number <= @splits_repository.get_change_number.to_i
+
+        fetch_options = { cache_control_headers: true, till: nil }
+
+        result = attempt_splits_sync(target_change_number,
+                                     fetch_options,
+                                     @config.on_demand_fetch_max_retries,
+                                     @config.on_demand_fetch_retry_delay_seconds,
+                                     false)
+
+        attempts = @config.on_demand_fetch_max_retries - result[:remaining_attempts]
+        if result[:success]
+          @segment_fetcher.fetch_segments_if_not_exists(result[:segment_names], true) unless result[:segment_names].empty?
+          @config.logger.debug("Refresh completed in #{attempts} attempts.") if @config.debug_enabled
+
+          return
+        end
+
+        fetch_options[:till] = target_change_number
+        result = attempt_splits_sync(target_change_number,
+                                     fetch_options,
+                                     ON_DEMAND_FETCH_BACKOFF_MAX_RETRIES,
+                                     nil,
+                                     true)
+
+        attempts = ON_DEMAND_FETCH_BACKOFF_MAX_RETRIES - result[:remaining_attempts]
+
+        if result[:success]
+          @segment_fetcher.fetch_segments_if_not_exists(result[:segment_names], true) unless result[:segment_names].empty?
+          @config.logger.debug("Refresh completed bypassing the CDN in #{attempts} attempts.") if @config.debug_enabled
+        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)
       end
 
-      def fetch_segment(name)
-        @segment_fetcher.fetch_segment(name, FORCE_CACHE_CONTROL_HEADERS)
+      def fetch_segment(name, target_change_number)
+        return if target_change_number <= @segments_repository.get_change_number(name).to_i
+
+        fetch_options = { cache_control_headers: true, till: nil }
+        result = attempt_segment_sync(name,
+                                      target_change_number,
+                                      fetch_options,
+                                      @config.on_demand_fetch_max_retries,
+                                      @config.on_demand_fetch_retry_delay_seconds,
+                                      false)
+
+        attempts = @config.on_demand_fetch_max_retries - result[:remaining_attempts]
+        if result[:success]
+          @config.logger.debug("Segment #{name} refresh completed in #{attempts} attempts.") if @config.debug_enabled
+
+          return
+        end
+
+        fetch_options = { cache_control_headers: true, till: target_change_number }
+        result = attempt_segment_sync(name,
+                                      target_change_number,
+                                      fetch_options,
+                                      ON_DEMAND_FETCH_BACKOFF_MAX_RETRIES,
+                                      nil,
+                                      true)
+
+        attempts = @config.on_demand_fetch_max_retries - result[:remaining_attempts]
+        if result[:success]
+          @config.logger.debug("Segment #{name} refresh completed bypassing the CDN in #{attempts} attempts.") if @config.debug_enabled
+        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)
       end
 
       private
 
-      def fetch_segments
-        @segment_fetcher.fetch_segments
+      def attempt_segment_sync(name, target_cn, fetch_options, max_retries, retry_delay_seconds, with_backoff)
+        remaining_attempts = max_retries
+        backoff = Engine::BackOff.new(ON_DEMAND_FETCH_BACKOFF_BASE_SECONDS, 0, ON_DEMAND_FETCH_BACKOFF_MAX_WAIT_SECONDS) if with_backoff
+
+        loop do
+          remaining_attempts -= 1
+
+          @segment_fetcher.fetch_segment(name, fetch_options)
+
+          return sync_result(true, remaining_attempts) if target_cn <= @segments_repository.get_change_number(name).to_i
+          return sync_result(false, remaining_attempts) if remaining_attempts <= 0
+
+          delay = with_backoff ? backoff.interval : retry_delay_seconds
+          sleep(delay)
+        end
+      end
+
+      def attempt_splits_sync(target_cn, fetch_options, max_retries, retry_delay_seconds, with_backoff)
+        remaining_attempts = max_retries
+        backoff = Engine::BackOff.new(ON_DEMAND_FETCH_BACKOFF_BASE_SECONDS, 0, ON_DEMAND_FETCH_BACKOFF_MAX_WAIT_SECONDS) if with_backoff
+
+        loop do
+          remaining_attempts -= 1
+
+          result = @split_fetcher.fetch_splits(fetch_options)
+
+          return sync_result(true, remaining_attempts, result[:segment_names]) if target_cn <= @splits_repository.get_change_number
+          return sync_result(false, remaining_attempts, result[:segment_names]) if remaining_attempts <= 0
+
+          delay = with_backoff ? backoff.interval : retry_delay_seconds
+          sleep(delay)
+        end
       end
 
       # Starts thread which loops constantly and sends impressions to the Split API
@@ -87,6 +186,17 @@ module SplitIoClient
       def start_telemetry_sync_task
         Telemetry::SyncTask.new(@config, @telemetry_synchronizer).call
       end
+
+      def sync_result(success, remaining_attempts, segment_names = nil)
+        { success: success, remaining_attempts: remaining_attempts, segment_names: segment_names }
+      end
+
+      def sync_splits_and_segments
+        @config.logger.debug('Synchronizing Splits and Segments ...') if @config.debug_enabled
+        splits_result = @split_fetcher.fetch_splits
+        
+        splits_result[:success] && @segment_fetcher.fetch_segments
+      end
     end
   end
 end

data/lib/splitclient-rb/managers/split_manager.rb

@@ -4,9 +4,9 @@ module SplitIoClient
     # Creates a new split manager instance that connects to split.io API.
     #
     # @return [SplitIoManager] split.io client instance
-    def initialize(splits_repository = nil, sdk_blocker, config)
+    def initialize(splits_repository = nil, status_manager, config)
       @splits_repository = splits_repository
-      @sdk_blocker = sdk_blocker
+      @status_manager = status_manager
       @config = config
     end
 
@@ -78,7 +78,7 @@ module SplitIoClient
     end
 
     def block_until_ready(time = nil)
-      @sdk_blocker.block(time) if @sdk_blocker && !@sdk_blocker.ready?
+      @status_manager.wait_until_ready(time) if @status_manager
     end
 
     private
@@ -111,7 +111,7 @@ module SplitIoClient
 
     # move to blocker, alongside block until ready to avoid duplication
     def ready?
-      return @sdk_blocker.ready? if @sdk_blocker
+      return @status_manager.ready? if @status_manager
       true
     end
   end

data/lib/splitclient-rb/split_config.rb

@@ -113,6 +113,9 @@ module SplitIoClient
 
       @sdk_start_time = Time.now
 
+      @on_demand_fetch_retry_delay_seconds = SplitConfig.default_on_demand_fetch_retry_delay_seconds
+      @on_demand_fetch_max_retries = SplitConfig.default_on_demand_fetch_max_retries
+
       startup_log
     end
 
@@ -278,6 +281,17 @@ module SplitIoClient
 
     attr_accessor :sdk_start_time
 
+    attr_accessor :on_demand_fetch_retry_delay_seconds    
+    attr_accessor :on_demand_fetch_max_retries
+
+    def self.default_on_demand_fetch_retry_delay_seconds
+      0.05
+    end
+
+    def self.default_on_demand_fetch_max_retries
+      10
+    end
+
     def self.default_impressions_mode
       :optimized
     end

data/lib/splitclient-rb/split_factory.rb

@@ -34,16 +34,16 @@ module SplitIoClient
       @segments_repository = SegmentsRepository.new(@config)
       @impressions_repository = ImpressionsRepository.new(@config)
       @events_repository = EventsRepository.new(@config, @api_key, @runtime_producer)
-      @sdk_blocker = SDKBlocker.new(@splits_repository, @segments_repository, @config)
       @impression_counter = SplitIoClient::Engine::Common::ImpressionCounter.new
       @impressions_manager = SplitIoClient::Engine::Common::ImpressionManager.new(@config, @impressions_repository, @impression_counter, @runtime_producer)
       @telemetry_api = SplitIoClient::Api::TelemetryApi.new(@config, @api_key, @runtime_producer)
       @telemetry_synchronizer = Telemetry::Synchronizer.new(@config, @telemetry_consumers, @init_producer, repositories, @telemetry_api)
+      @status_manager = Engine::StatusManager.new(@config)
 
       start!
 
-      @client = SplitClient.new(@api_key, repositories, @sdk_blocker, @config, @impressions_manager, @evaluation_producer)
-      @manager = SplitManager.new(@splits_repository, @sdk_blocker, @config)
+      @client = SplitClient.new(@api_key, repositories, @status_manager, @config, @impressions_manager, @evaluation_producer)
+      @manager = SplitManager.new(@splits_repository, @status_manager, @config)
 
       validate_api_key
 
@@ -51,22 +51,20 @@ module SplitIoClient
     end
 
     def start!
-      if @config.localhost_mode
-        start_localhost_components
-      else
-        split_fetcher = SplitFetcher.new(@splits_repository, @api_key, config, @sdk_blocker, @runtime_producer)
-        segment_fetcher = SegmentFetcher.new(@segments_repository, @api_key, config, @sdk_blocker, @runtime_producer)
-        params = { 
-          split_fetcher: split_fetcher,
-          segment_fetcher: segment_fetcher,
-          imp_counter: @impression_counter,
-          telemetry_runtime_producer: @runtime_producer,
-          telemetry_synchronizer: @telemetry_synchronizer
-        }
-
-        synchronizer = SplitIoClient::Engine::Synchronizer.new(repositories, @api_key, @config, @sdk_blocker, params)
-        SplitIoClient::Engine::SyncManager.new(repositories, @api_key, @config, synchronizer, @runtime_producer, @sdk_blocker, @telemetry_synchronizer).start
-      end
+      return start_localhost_components if @config.localhost_mode
+      
+      split_fetcher = SplitFetcher.new(@splits_repository, @api_key, config, @runtime_producer)
+      segment_fetcher = SegmentFetcher.new(@segments_repository, @api_key, config, @runtime_producer)
+      params = {
+        split_fetcher: split_fetcher,
+        segment_fetcher: segment_fetcher,
+        imp_counter: @impression_counter,
+        telemetry_runtime_producer: @runtime_producer,
+        telemetry_synchronizer: @telemetry_synchronizer
+      }
+
+      synchronizer = SplitIoClient::Engine::Synchronizer.new(repositories, @api_key, @config, params)
+      SplitIoClient::Engine::SyncManager.new(repositories, @api_key, @config, synchronizer, @runtime_producer, @telemetry_synchronizer, @status_manager).start
     end
 
     def stop!
@@ -145,7 +143,7 @@ module SplitIoClient
     end
 
     def start_localhost_components
-      LocalhostSplitStore.new(@splits_repository, @config, @sdk_blocker).call
+      LocalhostSplitStore.new(@splits_repository, @config, @status_manager).call
 
       # Starts thread which loops constantly and cleans up repositories to avoid memory issues in localhost mode
       LocalhostRepoCleaner.new(@impressions_repository, @events_repository, @config).call

data/lib/splitclient-rb/sse/event_source/client.rb

@@ -77,7 +77,7 @@ module SplitIoClient
         end
 
         def connect_stream(latch)
-          socket_write
+          socket_write(latch)
 
           while connected? || @first_event.value
             begin
@@ -96,13 +96,14 @@ module SplitIoClient
           end
         end
 
-        def socket_write
+        def socket_write(latch)
           @first_event.make_true
           @socket = socket_connect
           @socket.write(build_request(@uri))
         rescue StandardError => e
           @config.logger.error("Error during connecting to #{@uri.host}. Error: #{e.inspect}")
           close(Constants::PUSH_NONRETRYABLE_ERROR)
+          latch.count_down
         end
 
         def read_first_event(data, latch)

data/lib/splitclient-rb/sse/workers/segments_worker.rb

@@ -51,11 +51,7 @@ module SplitIoClient
             cn = item[:change_number]
             @config.logger.debug("SegmentsWorker change_number dequeue #{segment_name}, #{cn}")
 
-            attempt = 0
-            while cn > @segments_repository.get_change_number(segment_name).to_i && attempt <= Workers::MAX_RETRIES_ALLOWED
-              @synchronizer.fetch_segment(segment_name)
-              attempt += 1
-            end
+            @synchronizer.fetch_segment(segment_name, cn)
           end
         end
 

data/lib/splitclient-rb/sse/workers/splits_worker.rb

@@ -3,8 +3,6 @@
 module SplitIoClient
   module SSE
     module Workers
-      MAX_RETRIES_ALLOWED = 10
-
       class SplitsWorker
         def initialize(synchronizer, config, splits_repository)
           @synchronizer = synchronizer
@@ -62,12 +60,7 @@ module SplitIoClient
         def perform
           while (change_number = @queue.pop)
             @config.logger.debug("SplitsWorker change_number dequeue #{change_number}")
-
-            attempt = 0
-            while change_number > @splits_repository.get_change_number.to_i && attempt <= Workers::MAX_RETRIES_ALLOWED
-              @synchronizer.fetch_splits
-              attempt += 1
-            end
+            @synchronizer.fetch_splits(change_number)
           end
         end
 

data/lib/splitclient-rb/version.rb

@@ -1,3 +1,3 @@
 module SplitIoClient
-  VERSION = '7.3.0'
+  VERSION = '7.3.2.pre.rc2'
 end

data/lib/splitclient-rb.rb

@@ -28,10 +28,9 @@ require 'splitclient-rb/cache/senders/impressions_sender'
 require 'splitclient-rb/cache/senders/events_sender'
 require 'splitclient-rb/cache/senders/impressions_count_sender'
 require 'splitclient-rb/cache/senders/localhost_repo_cleaner'
-require 'splitclient-rb/cache/stores/store_utils'
 require 'splitclient-rb/cache/stores/localhost_split_builder'
-require 'splitclient-rb/cache/stores/sdk_blocker'
 require 'splitclient-rb/cache/stores/localhost_split_store'
+require 'splitclient-rb/cache/stores/store_utils'
 
 require 'splitclient-rb/clients/split_client'
 require 'splitclient-rb/managers/split_manager'
@@ -85,13 +84,14 @@ require 'splitclient-rb/engine/models/split'
 require 'splitclient-rb/engine/models/label'
 require 'splitclient-rb/engine/models/treatment'
 require 'splitclient-rb/engine/auth_api_client'
+require 'splitclient-rb/engine/back_off'
 require 'splitclient-rb/engine/push_manager'
+require 'splitclient-rb/engine/status_manager'
 require 'splitclient-rb/engine/sync_manager'
 require 'splitclient-rb/engine/synchronizer'
 require 'splitclient-rb/utilitites'
 
-# SSE 
-require 'splitclient-rb/sse/event_source/back_off'
+# SSE
 require 'splitclient-rb/sse/event_source/client'
 require 'splitclient-rb/sse/event_source/event_parser'
 require 'splitclient-rb/sse/event_source/event_types'

data/splitclient-rb.gemspec

@@ -38,14 +38,15 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'allocation_stats'
   spec.add_development_dependency 'appraisal'
-  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'bundler', '~> 2.2'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-nav'
   spec.add_development_dependency 'rake', '12.3.3'
   spec.add_development_dependency 'rake-compiler'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop', '0.59.0'
-  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov', '0.20.0'
+  spec.add_development_dependency 'simplecov-json'
   spec.add_development_dependency 'timecop'
   spec.add_development_dependency 'webmock'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splitclient-rb
 version: !ruby/object:Gem::Version
-  version: 7.3.0
+  version: 7.3.2.pre.rc2
 platform: ruby
 authors:
 - Split Software
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-13 00:00:00.000000000 Z
+date: 2021-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: allocation_stats
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -138,6 +138,20 @@ dependencies:
         version: 0.59.0
 - !ruby/object:Gem::Dependency
   name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -313,10 +327,10 @@ extensions:
 extra_rdoc_files: []
 files:
 - ".github/pull_request_template.md"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".simplecov"
-- ".travis.yml"
 - Appraisals
 - CHANGES.txt
 - CONTRIBUTORS-GUIDE.md
@@ -361,7 +375,6 @@ files:
 - lib/splitclient-rb/cache/senders/localhost_repo_cleaner.rb
 - lib/splitclient-rb/cache/stores/localhost_split_builder.rb
 - lib/splitclient-rb/cache/stores/localhost_split_store.rb
-- lib/splitclient-rb/cache/stores/sdk_blocker.rb
 - lib/splitclient-rb/cache/stores/store_utils.rb
 - lib/splitclient-rb/clients/split_client.rb
 - lib/splitclient-rb/constants.rb
@@ -374,6 +387,7 @@ files:
 - lib/splitclient-rb/engine/api/splits.rb
 - lib/splitclient-rb/engine/api/telemetry_api.rb
 - lib/splitclient-rb/engine/auth_api_client.rb
+- lib/splitclient-rb/engine/back_off.rb
 - lib/splitclient-rb/engine/common/impressions_counter.rb
 - lib/splitclient-rb/engine/common/impressions_manager.rb
 - lib/splitclient-rb/engine/evaluator/splitter.rb
@@ -407,6 +421,7 @@ files:
 - lib/splitclient-rb/engine/parser/evaluator.rb
 - lib/splitclient-rb/engine/parser/partition.rb
 - lib/splitclient-rb/engine/push_manager.rb
+- lib/splitclient-rb/engine/status_manager.rb
 - lib/splitclient-rb/engine/sync_manager.rb
 - lib/splitclient-rb/engine/synchronizer.rb
 - lib/splitclient-rb/exceptions.rb
@@ -417,7 +432,6 @@ files:
 - lib/splitclient-rb/split_factory_builder.rb
 - lib/splitclient-rb/split_factory_registry.rb
 - lib/splitclient-rb/split_logger.rb
-- lib/splitclient-rb/sse/event_source/back_off.rb
 - lib/splitclient-rb/sse/event_source/client.rb
 - lib/splitclient-rb/sse/event_source/event_parser.rb
 - lib/splitclient-rb/sse/event_source/event_types.rb
@@ -451,7 +465,6 @@ files:
 - lib/splitclient-rb/utilitites.rb
 - lib/splitclient-rb/validators.rb
 - lib/splitclient-rb/version.rb
-- sonar-scanner.sh
 - splitclient-rb.gemspec
 - tasks/benchmark_get_treatment.rake
 - tasks/irb.rake
@@ -459,7 +472,7 @@ homepage: https://github.com/splitio/ruby-client
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -470,12 +483,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Ruby client for split SDK.
 test_files: []

data/.travis.yml

@@ -1,20 +0,0 @@
-language: ruby
-
-rvm:
-  - "2.3.6"
-
-services:
-  - redis-server
-
-addons:
-  sonarqube: true
-
-git:
-  depth: false
-
-before_install:
-  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
-  - gem install bundler -v '< 2'
-
-after_success:
-  - bash sonar-scanner.sh

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

@@ -1,64 +0,0 @@
-require 'thread'
-require 'timeout'
-
-module SplitIoClient
-  module Cache
-    module Stores
-      class SDKBlocker
-        attr_reader :splits_repository
-
-        def initialize(splits_repository, segments_repository, config)
-          @splits_repository = splits_repository
-          @segments_repository = segments_repository
-          @config = config
-          @internal_ready = Concurrent::CountDownLatch.new(1)
-
-          if @config.standalone?
-            @splits_repository.not_ready!
-            @segments_repository.not_ready!
-          end
-        end
-
-        def splits_ready!
-          if !ready?
-            @splits_repository.ready!
-            @config.logger.info('splits are ready')
-          end
-        end
-
-        def segments_ready!
-          if !ready?
-            @segments_repository.ready!
-            @config.logger.info('segments are ready')
-          end
-        end
-
-        def block(time = nil)
-          begin
-            timeout = time || @config.block_until_ready
-            Timeout::timeout(timeout) do
-              sleep 0.1 until ready?
-            end
-          rescue Timeout::Error
-            fail SDKBlockerTimeoutExpiredException, 'SDK start up timeout expired'
-          end
-
-          @config.logger.info('SplitIO SDK is ready')
-        end
-
-        def ready?
-          return true if @config.consumer?
-          @splits_repository.ready? && @segments_repository.ready?
-        end
-
-        def sdk_internal_ready
-          @internal_ready.count_down
-        end
-
-        def wait_unitil_internal_ready
-          @internal_ready.wait
-        end
-      end
-    end
-  end
-end

data/lib/splitclient-rb/sse/event_source/back_off.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: false
-
-module SplitIoClient
-  module SSE
-    module EventSource
-      class BackOff
-        def initialize(back_off_base, attempt = 0)
-          @attempt = attempt
-          @back_off_base = back_off_base
-        end
-
-        def interval
-          interval = (@back_off_base * (2**@attempt)) if @attempt.positive?
-          @attempt += 1
-
-          interval || 0
-        end
-
-        def reset
-          @attempt = 0
-        end
-      end
-    end
-  end
-end

data/sonar-scanner.sh

@@ -1,42 +0,0 @@
-#/bin/bash -e
-
-sonar_scanner() {
-  local params=$@
-
-  sonar-scanner \
-    -Dsonar.host.url='https://sonarqube.split-internal.com' \
-    -Dsonar.login="$SONAR_TOKEN" \
-    -Dsonar.ws.timeout='300' \
-    -Dsonar.sources='lib' \
-    -Dsonar.projectName='ruby-client' \
-    -Dsonar.projectKey='ruby-client' \
-    -Dsonar.ruby.coverage.reportPaths='coverage/.resultset.json' \
-    -Dsonar.links.ci='https://travis-ci.com/splitio/ruby-client' \
-    -Dsonar.links.scm='https://github.com/splitio/ruby-client' \
-    ${params}
-
-  return $?
-}
-
-if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then
-  sonar_scanner \
-    -Dsonar.pullrequest.provider='GitHub' \
-    -Dsonar.pullrequest.github.repository='splitio/ruby-client' \
-    -Dsonar.pullrequest.key=$TRAVIS_PULL_REQUEST \
-    -Dsonar.pullrequest.branch=$TRAVIS_PULL_REQUEST_BRANCH \
-    -Dsonar.pullrequest.base=$TRAVIS_BRANCH
-else
-  if [ "$TRAVIS_BRANCH" == 'master' ]; then
-    sonar_scanner \
-      -Dsonar.branch.name=$TRAVIS_BRANCH
-  else
-    if [ "$TRAVIS_BRANCH" == 'development' ]; then
-      TARGET_BRANCH='master'
-    else
-      TARGET_BRANCH='development'
-    fi
-    sonar_scanner \
-      -Dsonar.branch.name=$TRAVIS_BRANCH \
-      -Dsonar.branch.target=$TARGET_BRANCH
-  fi
-fi