splitclient-rb 7.3.0.pre.rc2-java → 7.3.2-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9686481387194125daf6ec355df9248f7f9786e
-  data.tar.gz: 338ca6327676314b7b5433334334aef23b5d35a2
+  metadata.gz: 7237dc328456c0eb3c6db4d51baba65df84f5d41
+  data.tar.gz: f4e1859a0014c14fa7fdbf81f0cc472e2cc6a99e
 SHA512:
-  metadata.gz: b30f08f411e1f51f517c3c93f9cb70b8ea6e46d3cf85b0582e5963e7c536c9b0e3a723b64f5bde9157cb13557c25229e55699d623de273d484c4294edcd0feb0
-  data.tar.gz: a869366bd4176677383e06e7307e3d9c4bc5e21b195697dc26499c5460b1ee31c861d340be35ac677c4f0d68523cd3baf3e8b2ed79febefc80b24e92892a4080
+  metadata.gz: 00f9f235011c0d248e92e92b5267e17d78da3fd48dc70f21a53ad5a5936190565307b6871e96988c99c5820f952ea6538074ac4f8d09e3f045562ca415ed1f1b
+  data.tar.gz: 06bb9639c826e606b1d24afdb994b60dbeb3ccaf4e28c2275f6b717b435e8c29421d4a7ce802a672d64765bdcb5072a9acd3346b0780afdd73324fc4eea6a7e1

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,5 @@ AllCops:
     - lib/splitclient-rb/engine/models/**/*
     - lib/splitclient-rb/engine/parser/**/*
     - spec/telemetry/synchronizer_spec.rb
+    - lib/splitclient-rb/engine/synchronizer.rb
+    - tmp/**/*

data/CHANGES.txt

@@ -1,5 +1,16 @@
 CHANGES
 
+7.3.2 (Dec 10, 2021)
+- Updated the readiness flow to be more consistent with the other sdks and improve the readiness time.
+- Updated the name of telemety key latencies in Redis.
+
+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.
+
 7.2.3 (Feb 24, 2021)
 - Fixed missing segment fetch after an SPLIT_UPDATE.
 - Updated streaming logic to support multiregion.

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright © 2020 Split Software, Inc.
+Copyright © 2021 Split Software, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -63,7 +63,7 @@ Split has built and maintains SDKs for:
 * Java [Github](https://github.com/splitio/java-client) [Docs](https://help.split.io/hc/en-us/articles/360020405151-Java-SDK)
 * Javascript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
 * Node [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)
-* .NET [Github](https://github.com/splitio/.net-core-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
+* .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
 * Ruby [Github](https://github.com/splitio/ruby-client) [Docs](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK)
 * PHP [Github](https://github.com/splitio/php-client) [Docs](https://help.split.io/hc/en-us/articles/360020350372-PHP-SDK)
 * Python [Github](https://github.com/splitio/python-client) [Docs](https://help.split.io/hc/en-us/articles/360020359652-Python-SDK)

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,12 +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
@@ -67,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,55 +33,41 @@ 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
-
-        synchronize_telemetry_config
+        start_thread
+        PhusionPassenger.on_event(:starting_worker_process) { |forked| start_thread if forked } if defined?(PhusionPassenger)
       end
 
       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
+      def start_thread
+        @config.threads[:start_sdk] = Thread.new do
+          sleep(0.5) until @synchronizer.sync_all(false)
 
-      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
+          @status_manager.ready!
+          @telemetry_synchronizer.synchronize_config
+          @synchronizer.start_periodic_data_recording
+          connected = false
 
-      # 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
+          if @config.streaming_enabled
+            @config.logger.debug('Starting Straming mode ...')
             connected = @push_manager.start_sse
-            @synchronizer.start_periodic_fetch unless connected
-          rescue StandardError => e
-            @config.logger.error("start_sse_connection_thread error : #{e.inspect}")
+
+            if defined?(PhusionPassenger)
+              PhusionPassenger.on_event(:starting_worker_process) { |forked| sse_thread_forked if forked }
+            end
           end
-        end
-      end
 
-      def start_stream_forked
-        PhusionPassenger.on_event(:starting_worker_process) { |forked| start_stream if forked }
+          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 process_action(action)
@@ -165,16 +151,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