splitclient-rb 8.11.0 → 8.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41d269b5dc5e38906001aefe42cb60bb4ef8de5376b9d71c613b5c8345cc9451
-  data.tar.gz: 6d66df400c0e2279ac23250dc22540135bd4e358467b5ba17ade47f8efdc6be9
+  metadata.gz: f75f1490dbebf79ecb7799bb96a29f180ed5259036edbd4351b3db9f1f2e1cba
+  data.tar.gz: e8f83fe01180e3a4a7487c82fd2a2c58cafdc971b951b9eb0c0c472351b00c4d
 SHA512:
-  metadata.gz: 1fd4c042221d85b902894870073ec8dda740807f59348c83ce470e5571d929b6e4ca88d19e014c597a91841464a89b4f3c558b35993f091b2d5bc142dc0bfb0e
-  data.tar.gz: b1bb37265463a9a8023f70cce31dbc880a2a84c0618b3defc4e0bef9075bb62cc558f68f212e9ea1b4310be51d180a1f5538333b6b30a2e079ce704fd4da638d
+  metadata.gz: 7d8a983e3f53437d2749ac0a7f60b83e2d124001f396b19389ee19cb63d2cee404ef4253835586414a793fbb737c803869db51f2114b0931ea7f474aa9bdfc1d
+  data.tar.gz: b6cc38e9b8d9d54b6d7858f02780059dc9b26dab95e9c022c5f92311621fc0057c4cddc1a1c2ea07b9831a27799ec5665cf5ef4b6cbc43dc0e27b4264179f51c

data/CHANGES.txt

@@ -1,5 +1,15 @@
 CHANGES
 
+8.11.1 (Jul, 23, 2026)
+- Added a retry mechanism in case the initial SSE socket connection failed, and extended the list of retryable errors when socket exceptions are caught during streaming.
+- Fixed debug logging in rule-based segment matcher class when debug_enabled parameter is not set in configuration .
+- Fixed a debug log that caused exception when streaming socket closes.
+
+8.11.0 (Mar, 12, 2026)
+- Added the ability to listen to different events triggered by the SDK. Read more in our docs.
+   - SDK_UPDATE notify when a flag or user segment has changed
+   - SDK_READY notify when the SDK is ready to evaluate
+
 8.10.1 (Jan 28, 2025)
 - Fixed rule-based segment matcher to exit when a conition is met.
 - Fixed impressions properties format in redis mode. 

data/LICENSE

@@ -157,7 +157,7 @@ Apache License
       file or class name and description of purpose be included on the
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2025 Harness Corporation
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

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

@@ -23,7 +23,6 @@ module SplitIoClient
           name = segment[:name]
 
           @adapter.initialize_set(segment_data(name)) unless @adapter.exists?(segment_data(name))
-          @config.logger.debug(segment)
           add_keys(name, segment[:added])
           remove_keys(name, segment[:removed])
           if segment[:added].length > 0 || segment[:removed].length > 0

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

@@ -21,7 +21,9 @@ module SplitIoClient
         return process_error(response) if response.status >= 400 && response.status < 500
 
         @telemetry_runtime_producer.record_sync_error(Telemetry::Domain::Constants::TOKEN_SYNC, response.status.to_i)
-        @config.logger.debug("Error connecting to: #{@config.auth_service_url}. Response status: #{response.status}") if @config.debug_enabled
+        if @config.debug_enabled
+          @config.logger.debug("Error connecting to: #{@config.auth_service_url}. Response status: #{response.status}")
+        end
         { push_enabled: false, retry: true }
       rescue StandardError => e
         @config.logger.debug("AuthApiClient error: #{e.inspect}.") if @config.debug_enabled
@@ -51,7 +53,9 @@ module SplitIoClient
       end
 
       def process_error(response)
-        @config.logger.debug("Error connecting to: #{@config.auth_service_url}. Response status: #{response.status}") if @config.debug_enabled
+        if @config.debug_enabled
+          @config.logger.debug("Error connecting to: #{@config.auth_service_url}. Response status: #{response.status}")
+        end
         @telemetry_runtime_producer.record_auth_rejections if response.status == 401
 
         { push_enabled: false, retry: false }

data/lib/splitclient-rb/engine/events/events_manager.rb

@@ -18,15 +18,15 @@ module SplitIoClient
 
           @mutex.synchronize do
             # SDK ready already fired
-            if sdk_event == SplitIoClient::Engine::Models::SdkEvent::SDK_READY && event_already_triggered(sdk_event)
-              @active_subscriptions[sdk_event] = SplitIoClient::Engine::Models::EventActiveSubscriptions.new(true, event_handler)
+            if sdk_event == Engine::Models::SdkEvent::SDK_READY && event_already_triggered(sdk_event)
+              @active_subscriptions[sdk_event] = Engine::Models::EventActiveSubscriptions.new(true, event_handler)
               @config.logger.debug('EventsManager: Firing SDK_READY event for new subscription') if @config.debug_enabled
               fire_sdk_event(sdk_event, nil)
               return
             end
 
             @config.logger.debug("EventsManager: Register event: #{sdk_event}") if @config.debug_enabled
-            @active_subscriptions[sdk_event] = SplitIoClient::Engine::Models::EventActiveSubscriptions.new(false, event_handler)
+            @active_subscriptions[sdk_event] = Engine::Models::EventActiveSubscriptions.new(false, event_handler)
           end
         end
 
@@ -66,7 +66,7 @@ module SplitIoClient
         private
 
         def check_if_register_needed(sorted_event)
-          sorted_event == SplitIoClient::Engine::Models::SdkEvent::SDK_READY &&
+          sorted_event == Engine::Models::SdkEvent::SDK_READY &&
             get_event_handler(sorted_event).nil? &&
             !@active_subscriptions.include?(sorted_event)
         end
@@ -110,7 +110,7 @@ module SplitIoClient
         end
 
         def get_sdk_event_if_applicable(sdk_internal_event)
-          final_sdk_event = SplitIoClient::Engine::Models::ValidSdkEvent.new(nil, false)
+          final_sdk_event = Engine::Models::ValidSdkEvent.new(nil, false)
 
           events_to_fire = []
           require_any_sdk_event = check_require_any(sdk_internal_event)
@@ -118,7 +118,7 @@ module SplitIoClient
             if (!event_already_triggered(require_any_sdk_event.sdk_event) &&
                execution_limit(require_any_sdk_event.sdk_event) == 1) ||
                execution_limit(require_any_sdk_event.sdk_event) == -1
-              final_sdk_event = SplitIoClient::Engine::Models::ValidSdkEvent.new(
+              final_sdk_event = Engine::Models::ValidSdkEvent.new(
                 require_any_sdk_event.sdk_event,
                 check_prerequisites(require_any_sdk_event.sdk_event) &&
                 check_suppressed_by(require_any_sdk_event.sdk_event)
@@ -178,10 +178,10 @@ module SplitIoClient
         end
 
         def check_require_any(sdk_internal_event)
-          valid_sdk_event = SplitIoClient::Engine::Models::ValidSdkEvent.new(nil, false)
+          valid_sdk_event = Engine::Models::ValidSdkEvent.new(nil, false)
           @manager_config.require_any.each do |name, val|
             if val.include?(sdk_internal_event)
-              valid_sdk_event = SplitIoClient::Engine::Models::ValidSdkEvent.new(name, true)
+              valid_sdk_event = Engine::Models::ValidSdkEvent.new(name, true)
               return valid_sdk_event
             end
           end

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

@@ -40,7 +40,7 @@ module SplitIoClient
         break if matched
       end
 
-      @logger.debug("[InRuleSegmentMatcher] #{@segment_name} is in rule based segment -> #{matched}")
+      @config.logger.debug("[InRuleSegmentMatcher] #{@segment_name} is in rule based segment -> #{matched}") if @config.debug_enabled
       matched
     end
 

data/lib/splitclient-rb/engine/models/sdk_internal_event_notification.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: false
 
 module SplitIoClient
-  module Engine::Models
-    class SdkInternalEventNotification
-      attr_reader :internal_event, :metadata
+  module Engine
+    module Models
+      class SdkInternalEventNotification
+        attr_reader :internal_event, :metadata
 
-      def initialize(internal_event, metadata)
-        @internal_event = internal_event
-        @metadata = metadata
+        def initialize(internal_event, metadata)
+          @internal_event = internal_event
+          @metadata = metadata
+        end
       end
     end
   end

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

@@ -16,17 +16,21 @@ module SplitIoClient
         response = @auth_api_client.authenticate(@api_key)
         @config.logger.debug("Auth service response push_enabled: #{response[:push_enabled]}") if @config.debug_enabled
 
-        if response[:push_enabled] && @sse_handler.start(response[:token], response[:channels])
-          schedule_next_token_refresh(response[:exp])
-          @back_off.reset
-          record_telemetry(response[:exp])
+        unless response[:push_enabled]
+          schedule_next_token_refresh(@back_off.interval) if response[:retry]
+          return false
+        end
 
-          return true
+        unless @sse_handler.start(response[:token], response[:channels])
+          @config.logger.debug('Streaming server returned error') if @config.debug_enabled
+          stop_sse
+          return false
         end
 
-        stop_sse
-        schedule_next_token_refresh(@back_off.interval) if response[:retry]
-        false
+        schedule_next_token_refresh(response[:exp])
+        @back_off.reset
+        record_telemetry(response[:exp])
+        true
       rescue StandardError => e
         @config.logger.error("start_sse: #{e.inspect}")
       end

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

@@ -6,14 +6,8 @@ module SplitIoClient
       SYNC_MODE_STREAMING = 0
       SYNC_MODE_POLLING = 1
 
-      def initialize(config,
-                     synchronizer,
-                     telemetry_runtime_producer,
-                     telemetry_synchronizer,
-                     status_manager,
-                     sse_handler,
-                     push_manager,
-                     status_queue)
+      def initialize(config, synchronizer, telemetry_runtime_producer, telemetry_synchronizer,
+                     status_manager, sse_handler, push_manager, status_queue)
         @config = config
         @synchronizer = synchronizer
         @telemetry_runtime_producer = telemetry_runtime_producer
@@ -23,6 +17,7 @@ module SplitIoClient
         @push_manager = push_manager
         @status_queue = status_queue
         @sse_connected = Concurrent::AtomicBoolean.new(false)
+        @back_off = Engine::BackOff.new(1, 3)
       end
 
       def start
@@ -119,7 +114,7 @@ module SplitIoClient
       end
 
       def process_disconnect(reconnect)
-        unless @sse_connected.value
+        unless @sse_connected.value || reconnect
           @config.logger.debug('Streaming already disconnected.') if @config.debug_enabled
           return
         end
@@ -130,6 +125,9 @@ module SplitIoClient
         record_telemetry(Telemetry::Domain::Constants::SYNC_MODE, SYNC_MODE_POLLING)
 
         if reconnect
+          wait_interval = @back_off.interval
+          @config.logger.debug("Retrying streaming connection in: #{wait_interval} seconds")
+          sleep(wait_interval)
           @push_manager.stop_sse
           @synchronizer.sync_all
           @push_manager.start_sse
@@ -155,6 +153,7 @@ module SplitIoClient
 
           case status
           when Constants::PUSH_CONNECTED
+            @back_off.reset
             process_connected
           when Constants::PUSH_RETRYABLE_ERROR
             process_disconnect(true)
@@ -169,12 +168,16 @@ module SplitIoClient
           when Constants::PUSH_SUBSYSTEM_OFF
             process_push_shutdown
           else
-            @config.logger.debug('Incorrect push status type.') if @config.debug_enabled
+            log_if_debug('Incorrect push status type.')
           end
         end
       rescue StandardError => e
         @config.logger.error("Push status handler error: #{e.inspect}")
       end
     end
+
+    def log_if_debug(msg)
+      @config.logger.debug(msg) if @config.debug_enabled
+    end
   end
 end

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

@@ -55,8 +55,8 @@ module SplitIoClient
       end
 
       def start_periodic_fetch
-        @split_fetcher.call
-        @segment_fetcher.call
+        @split_fetcher.call unless Helpers::ThreadHelper.alive?(:split_fetcher, @config)
+        @segment_fetcher.call unless Helpers::ThreadHelper.alive?(:segment_fetcher, @config)
       end
 
       def stop_periodic_fetch

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

@@ -10,7 +10,7 @@ module SplitIoClient
     module EventSource
       class Client
         DEFAULT_READ_TIMEOUT = 70
-        CONNECT_TIMEOUT = 30_000
+        CONNECT_TIMEOUT = 30
         OK_CODE = 200
         KEEP_ALIVE_RESPONSE = "c\r\n:keepalive\n\n\r\n".freeze
         ERROR_EVENT_TYPE = 'error'.freeze
@@ -37,17 +37,15 @@ module SplitIoClient
         end
 
         def close(status = nil)
-          unless connected?
-            @config.logger.debug('SSEClient already disconected.') if @config.debug_enabled
-            return
-          end
-          @config.logger.debug("Closing SSEClient socket") if @config.debug_enabled
+          return if @socket.nil?
 
+          @config.logger.debug("Closing SSEClient socket") if @config.debug_enabled
           push_status(status)
           @connected.make_false
           @socket.sync_close = true if @socket.is_a? OpenSSL::SSL::SSLSocket
           @socket.close
-          @config.logger.debug("SSEClient socket state #{@socket.state}") if @socket.is_a? OpenSSL::SSL::SSLSocket && @config.debug_enabled
+          @config.logger.debug("SSEClient socket state #{@socket.state}") if @socket.is_a?(OpenSSL::SSL::SSLSocket) && @config.debug_enabled
+          @socket = nil
         rescue StandardError => e
           @config.logger.error("SSEClient close Error: #{e.inspect}")
         end
@@ -80,21 +78,21 @@ module SplitIoClient
           @config.threads[:connect_stream] = Thread.new do
             @config.logger.info('Starting connect_stream thread ...')
             new_status = connect_stream(latch)
-            push_status(new_status)
+            push_status(new_status) unless new_status.nil?
             @config.logger.info('connect_stream thread finished.')
           end
         end
 
         def connect_stream(latch)
-          return Constants::PUSH_NONRETRYABLE_ERROR unless socket_write(latch)
+          return Constants::PUSH_RETRYABLE_ERROR unless socket_write(latch)
           while connected? || @first_event.value
             begin 
               if IO.select([@socket], nil, nil, @read_timeout)
                 begin
                   partial_data = @socket.readpartial(10_000)
-                  read_first_event(partial_data, latch)
 
-                  raise 'eof exception' if partial_data == :eof
+                  first_event_status = read_first_event(partial_data, latch)
+                  return first_event_status unless first_event_status.nil?
                 rescue IO::WaitReadable => e
                   @config.logger.debug("SSE client IO::WaitReadable transient error: #{e.inspect}") if @config.debug_enabled
                   IO.select([@socket], nil, nil, @read_timeout)
@@ -107,8 +105,8 @@ module SplitIoClient
                   @config.logger.error("SSE read operation timed out!: #{e.inspect}")
                   return Constants::PUSH_RETRYABLE_ERROR
                 rescue EOFError => e
-                  @config.logger.error("SSE read operation EOF Exception!: #{e.inspect}")
-                  raise 'eof exception'
+                  @config.logger.error("SSE read operation EOF, server closed the connection, will reconnect: #{e.inspect}")
+                  return Constants::PUSH_RETRYABLE_ERROR
                 rescue Errno::EBADF, IOError => e
                   @config.logger.error("SSE read operation EBADF or IOError: #{e.inspect}")
                   return Constants::PUSH_RETRYABLE_ERROR
@@ -123,14 +121,9 @@ module SplitIoClient
                 @config.logger.error("SSE read operation timed out, no data available.")
                 return Constants::PUSH_RETRYABLE_ERROR
               end
-            rescue Errno::EBADF
-              @config.logger.debug("SSE socket is not connected (Errno::EBADF)") if @config.debug_enabled
-              break
-            rescue RuntimeError
-              raise 'eof exception'
             rescue Exception => e
               @config.logger.debug("SSE socket is not connected: #{e.inspect}") if @config.debug_enabled
-              break
+              return Constants::PUSH_RETRYABLE_ERROR
             end
 
             process_data(partial_data)
@@ -157,19 +150,20 @@ module SplitIoClient
           response_code = @event_parser.first_event(data)
           @config.logger.debug("SSE client first event code: #{response_code}") if @config.debug_enabled
 
-          error_event = false
-          events = @event_parser.parse(data)
-          events.each { |e| error_event = true if e.event_type == ERROR_EVENT_TYPE }
           @first_event.make_false
 
-          if response_code == OK_CODE && !error_event
-            @connected.make_true
-            @config.logger.debug("SSE client first event Connected is true") if @config.debug_enabled
-            @telemetry_runtime_producer.record_streaming_event(Telemetry::Domain::Constants::SSE_CONNECTION_ESTABLISHED, nil)
-            push_status(Constants::PUSH_CONNECTED)
+          if response_code != OK_CODE
+            @config.logger.error("SSE first event failed, code: #{response_code}")
+            latch.count_down
+            return Constants::PUSH_RETRYABLE_ERROR
           end
 
+          @connected.make_true
+          @config.logger.debug("SSE client first event Connected is true") if @config.debug_enabled
+          @telemetry_runtime_producer.record_streaming_event(Telemetry::Domain::Constants::SSE_CONNECTION_ESTABLISHED, nil)
+          push_status(Constants::PUSH_CONNECTED)
           latch.count_down
+          return nil
         end
 
         def socket_connect

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

@@ -52,7 +52,9 @@ module SplitIoClient
 
         def perform
           while (notification = @queue.pop)
-            @config.logger.debug("feature_flags_worker change_number dequeue #{notification.data['changeNumber']}") if @config.debug_enabled
+            if @config.debug_enabled
+              @config.logger.debug("feature_flags_worker change_number dequeue #{notification.data['changeNumber']}")
+            end
             case notification.data['type']
             when SSE::EventSource::EventTypes::SPLIT_UPDATE
               success = update_feature_flag(notification)
@@ -117,7 +119,9 @@ module SplitIoClient
         def kill_feature_flag(notification)
           return if @feature_flags_repository.get_change_number.to_i > notification.data['changeNumber']
 
-          @config.logger.debug("feature_flags_worker kill #{notification.data['splitName']}, #{notification.data['changeNumber']}") if @config.debug_enabled
+          if @config.debug_enabled
+            @config.logger.debug("feature_flags_worker kill #{notification.data['splitName']}, #{notification.data['changeNumber']}")
+          end
           @feature_flags_repository.kill(notification.data['changeNumber'],
                                          notification.data['splitName'],
                                          notification.data['defaultTreatment'])

data/lib/splitclient-rb/version.rb

@@ -1,3 +1,3 @@
 module SplitIoClient
-  VERSION = '8.11.0'
+  VERSION = '8.11.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: splitclient-rb
 version: !ruby/object:Gem::Version
-  version: 8.11.0
+  version: 8.11.1
 platform: ruby
 authors:
 - Split Software