splitclient-rb 8.10.1.pre.rc1-java → 8.11.0-java

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

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Engine
+    module Events
+      class EventsManagerConfig
+        attr_accessor :require_all, :prerequisites, :require_any, :suppressed_by, :execution_limits, :evaluation_order
+
+        def initialize
+          @require_all = construct_require_all
+          @prerequisites = construct_prerequisites
+          @require_any = construct_require_any
+          @suppressed_by = construct_suppressed_by
+          @execution_limits = construct_execution_limits
+          @evaluation_order = construct_sorted_events
+        end
+
+        private
+
+        def construct_require_all
+          {
+            SplitIoClient::Engine::Models::SdkEvent::SDK_READY => Set.new([SplitIoClient::Engine::Models::SdkInternalEvent::SDK_READY])
+          }
+        end
+
+        def construct_prerequisites
+          {
+            SplitIoClient::Engine::Models::SdkEvent::SDK_UPDATE => Set.new([SplitIoClient::Engine::Models::SdkEvent::SDK_READY])
+          }
+        end
+
+        def construct_require_any
+          {
+            SplitIoClient::Engine::Models::SdkEvent::SDK_UPDATE => Set.new(
+              [
+                SplitIoClient::Engine::Models::SdkInternalEvent::FLAG_KILLED_NOTIFICATION,
+                SplitIoClient::Engine::Models::SdkInternalEvent::FLAGS_UPDATED,
+                SplitIoClient::Engine::Models::SdkInternalEvent::RB_SEGMENTS_UPDATED,
+                SplitIoClient::Engine::Models::SdkInternalEvent::SEGMENTS_UPDATED
+              ]
+            )
+          }
+        end
+
+        def construct_suppressed_by
+          {}
+        end
+
+        def construct_execution_limits
+          {
+            SplitIoClient::Engine::Models::SdkEvent::SDK_READY => 1,
+            SplitIoClient::Engine::Models::SdkEvent::SDK_UPDATE => -1
+          }
+        end
+
+        def construct_sorted_events
+          sorted_events = []
+          [SplitIoClient::Engine::Models::SdkEvent::SDK_READY, SplitIoClient::Engine::Models::SdkEvent::SDK_UPDATE].each do |sdk_event|
+            sorted_events = dfs_recursive(sdk_event, sorted_events)
+          end
+
+          sorted_events
+        end
+
+        def dfs_recursive(sdk_event, added)
+          return added if added.include?(sdk_event)
+
+          get_dependencies(sdk_event).each do |dependent_event|
+            added = dfs_recursive(dependent_event, added)
+          end
+
+          added.push(sdk_event)
+
+          added
+        end
+
+        def get_dependencies(sdk_event)
+          dependencies = Set.new
+          @prerequisites.each do |prerequisites_event_name, prerequisites_event_value|
+            next unless prerequisites_event_name == sdk_event
+
+            prerequisites_event_value.each do |prereq_event|
+              dependencies.add(prereq_event)
+            end
+          end
+
+          @suppressed_by.each do |suppressed_event_name, suppressed_event_value|
+            dependencies.add(suppressed_event_name) if suppressed_event_value.include?(sdk_event)
+          end
+
+          dependencies
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Engine
+    module Events
+      class EventsTask
+        attr_accessor :running
+
+        def initialize(notify_internal_events, internal_events_queue, config)
+          @notify_internal_events = notify_internal_events
+          @internal_events_queue = internal_events_queue
+          @config = config
+          @running = false
+        end
+
+        def start
+          return if @running
+
+          @config.logger.info('Starting Internal Events Task.')
+          @running = true
+          @config.threads[:internal_events_task] = Thread.new do
+            worker_thread
+          end
+        end
+
+        def stop
+          return unless @running
+
+          @config.logger.info('Stopping Internal Events Task.')
+          @running = false
+        end
+
+        private
+
+        def worker_thread
+          while (event = @internal_events_queue.pop)
+            break unless @running
+
+            @config.logger.debug("Processing sdk internal event: #{event.internal_event}") if @config.debug_enabled
+            begin
+              @notify_internal_events.call(event.internal_event, event.metadata)
+            rescue StandardError => e
+              @config.log_found_exception(__method__.to_s, e)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Engine
+    module Events
+      class NoOpEventsQueue
+        def push(sdk_event)
+          # do nothing
+        end
+      end
+    end
+  end
+end

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

@@ -30,15 +30,18 @@ module SplitIoClient
 
       return false unless check_excluded_segments(rule_based_segment, key, args)
 
-      matches = false
+      matched = false
       rule_based_segment[:conditions].each do |c|
         condition = SplitIoClient::Condition.new(c, @config)
         next if condition.empty?
 
-        matches = Helpers::EvaluatorHelper.matcher_type(condition, @segments_repository, @rule_based_segments_repository).match?(args)
+        matched = Helpers::EvaluatorHelper.matcher_type(condition, @segments_repository, @rule_based_segments_repository).match?(args)
+
+        break if matched
       end
-      @logger.debug("[InRuleSegmentMatcher] #{@segment_name} is in rule based segment -> #{matches}")
-      matches
+
+      @logger.debug("[InRuleSegmentMatcher] #{@segment_name} is in rule based segment -> #{matched}")
+      matched
     end
 
     private

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: false
+
+module SplitIoClient
+  module Engine::Models
+    class EventActiveSubscriptions
+      attr_accessor :triggered, :handler
+
+      def initialize(triggered, handler)
+        @triggered = triggered
+        @handler = handler
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module SplitIoClient::Engine::Models
+    class EventsMetadata
+    attr_accessor :type, :names
+
+    def initialize(type, names=nil)
+        @type = type
+        @names = names
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+class SplitIoClient::Engine::Models::SdkEvent
+  SDK_READY = 'SDK_READY'
+  SDK_UPDATE = 'SDK_UPDATE'
+end

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

@@ -0,0 +1,4 @@
+class SplitIoClient::Engine::Models::SdkEventType
+  FLAG_UPDATE = 'FLAG_UPDATE'
+  SEGMENTS_UPDATE = 'SEGMENTS_UPDATE'
+end

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

@@ -0,0 +1,8 @@
+class SplitIoClient::Engine::Models::SdkInternalEvent
+  SDK_READY = 'SDK_READY'
+  FLAGS_UPDATED = 'FLAGS_UPDATED'
+  FLAG_KILLED_NOTIFICATION = 'FLAG_KILLED_NOTIFICATION'
+  SEGMENTS_UPDATED = 'SEGMENTS_UPDATED'
+  RB_SEGMENTS_UPDATED = 'RB_SEGMENTS_UPDATED'
+  LARGE_SEGMENTS_UPDATED = 'LARGE_SEGMENTS_UPDATED'
+end

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

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

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: false
+
+module SplitIoClient
+  module Engine::Models
+    class ValidSdkEvent
+      attr_reader :sdk_event, :valid
+
+      def initialize(sdk_event, valid)
+        @sdk_event = sdk_event
+        @valid = valid
+      end
+    end
+  end
+end

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

@@ -3,9 +3,10 @@
 module SplitIoClient
   module Engine
     class StatusManager
-      def initialize(config)
+      def initialize(config, internal_events_queue)
         @config = config
         @sdk_ready = Concurrent::CountDownLatch.new(1)
+        @internal_events_queue = internal_events_queue
       end
 
       def ready?
@@ -19,6 +20,11 @@ module SplitIoClient
 
         @sdk_ready.count_down
         @config.logger.info('SplitIO SDK is ready')
+        @internal_events_queue.push(
+          SplitIoClient::Engine::Models::SdkInternalEventNotification.new(
+            SplitIoClient::Engine::Models::SdkInternalEvent::SDK_READY, nil
+          )
+        )
       end
 
       def wait_until_ready(seconds = nil)

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

@@ -47,13 +47,13 @@ module SplitIoClient
           connected = false
 
           if @config.streaming_enabled
-            @config.logger.debug('Starting Streaming mode ...')
+            @config.logger.debug('Starting Streaming mode ...') if @config.debug_enabled
             start_push_status_monitor
             connected = @push_manager.start_sse
           end
 
           unless connected
-            @config.logger.debug('Starting Polling mode ...')
+            @config.logger.debug('Starting Polling mode ...') if @config.debug_enabled
             @synchronizer.start_periodic_fetch
             record_telemetry(Telemetry::Domain::Constants::SYNC_MODE, SYNC_MODE_POLLING)
           end
@@ -92,7 +92,7 @@ module SplitIoClient
 
       def process_connected
         if @sse_connected.value
-          @config.logger.debug('Streaming already connected.')
+          @config.logger.debug('Streaming already connected.') if @config.debug_enabled
           return
         end
 
@@ -107,7 +107,7 @@ module SplitIoClient
 
       def process_forced_stop
         unless @sse_connected.value
-          @config.logger.debug('Streaming already disconnected.')
+          @config.logger.debug('Streaming already disconnected.') if @config.debug_enabled
           return
         end
 
@@ -120,7 +120,7 @@ module SplitIoClient
 
       def process_disconnect(reconnect)
         unless @sse_connected.value
-          @config.logger.debug('Streaming already disconnected.')
+          @config.logger.debug('Streaming already disconnected.') if @config.debug_enabled
           return
         end
 
@@ -169,12 +169,16 @@ module SplitIoClient
           when Constants::PUSH_SUBSYSTEM_OFF
             process_push_shutdown
           else
-            @config.logger.debug('Incorrect push status type.')
+            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/split_factory.rb

@@ -45,6 +45,7 @@ module SplitIoClient
 
       register_factory
 
+      build_events_manager
       build_telemetry_components
       build_flag_sets_filter
       build_repositories
@@ -53,13 +54,13 @@ module SplitIoClient
       build_unique_keys_tracker
       build_impressions_components
 
-      @status_manager = Engine::StatusManager.new(@config)
+      @status_manager = Engine::StatusManager.new(@config, @internal_events_queue)
       @split_validator = SplitIoClient::Validators.new(@config)
       @evaluator = Engine::Parser::Evaluator.new(@segments_repository, @splits_repository, @rule_based_segment_repository, @config)
 
       start!
       fallback_treatment_calculator = SplitIoClient::Engine::FallbackTreatmentCalculator.new(@config.fallback_treatments_configuration) 
-      @client = SplitClient.new(@api_key, repositories, @status_manager, @config, @impressions_manager, @evaluation_producer, @evaluator, @split_validator, fallback_treatment_calculator)
+      @client = SplitClient.new(@api_key, repositories, @status_manager, @config, @impressions_manager, @evaluation_producer, @evaluator, @split_validator, fallback_treatment_calculator, @events_manager)
       @manager = SplitManager.new(@splits_repository, @status_manager, @config)
     end
 
@@ -219,9 +220,9 @@ module SplitIoClient
       else
         @flag_sets_repository = SplitIoClient::Cache::Repositories::MemoryFlagSetsRepository.new(@config.flag_sets_filter)
       end
-      @splits_repository = SplitsRepository.new(@config, @flag_sets_repository, @flag_sets_filter)
-      @segments_repository = SegmentsRepository.new(@config)
-      @rule_based_segment_repository = RuleBasedSegmentsRepository.new(@config)
+      @splits_repository = SplitsRepository.new(@config, @flag_sets_repository, @flag_sets_filter, @internal_events_queue)
+      @segments_repository = SegmentsRepository.new(@config, @internal_events_queue)
+      @rule_based_segment_repository = RuleBasedSegmentsRepository.new(@config, @internal_events_queue)
       @impressions_repository = ImpressionsRepository.new(@config)
       @events_repository = EventsRepository.new(@config, @api_key, @runtime_producer)
     end
@@ -265,5 +266,19 @@ module SplitIoClient
     def build_flag_sets_filter
       @flag_sets_filter = SplitIoClient::Cache::Filter::FlagSetsFilter.new(@config.flag_sets_filter)
     end
+
+    def build_events_manager
+      @events_manager = Engine::Events::EventsManager.new(Engine::Events::EventsManagerConfig.new, 
+                            Engine::Events::EventsDelivery.new(@config), 
+                            @config)
+      if @config.consumer?
+        @internal_events_queue = Engine::Events::NoOpEventsQueue.new
+        return
+      end
+
+      @internal_events_queue = Queue.new
+      @events_task = Engine::Events::EventsTask.new(@events_manager.method(:notify_internal_event), @internal_events_queue, @config)
+      @events_task.start
+    end
   end
 end

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

@@ -38,23 +38,23 @@ module SplitIoClient
 
         def close(status = nil)
           unless connected?
-            @config.logger.debug('SSEClient already disconected.')
+            @config.logger.debug('SSEClient already disconected.') if @config.debug_enabled
             return
           end
-          @config.logger.debug("Closing SSEClient socket")
+          @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
-          push_status(status)
+          @config.logger.debug("SSEClient socket state #{@socket.state}") if @socket.is_a? OpenSSL::SSL::SSLSocket && @config.debug_enabled
         rescue StandardError => e
           @config.logger.error("SSEClient close Error: #{e.inspect}")
         end
 
         def start(url)
           if connected?
-            @config.logger.debug('SSEClient already running.')
+            @config.logger.debug('SSEClient already running.') if @config.debug_enabled
             return true
           end
 
@@ -96,18 +96,17 @@ module SplitIoClient
 
                   raise 'eof exception' if partial_data == :eof
                 rescue IO::WaitReadable => e
-                  @config.logger.debug("SSE client IO::WaitReadable transient error: #{e.inspect}")
+                  @config.logger.debug("SSE client IO::WaitReadable transient error: #{e.inspect}") if @config.debug_enabled
                   IO.select([@socket], nil, nil, @read_timeout)
                   retry
                 rescue  Errno::EAGAIN => e
-                  @config.logger.debug("SSE client transient error: #{e.inspect}")
+                  @config.logger.debug("SSE client transient error: #{e.inspect}") if @config.debug_enabled
                   IO.select([@socket], nil, nil, @read_timeout)
                   retry
                 rescue Errno::ETIMEDOUT => e
                   @config.logger.error("SSE read operation timed out!: #{e.inspect}")
                   return Constants::PUSH_RETRYABLE_ERROR
                 rescue EOFError => e
-                  puts "SSE read operation EOF Exception!: #{e.inspect}"
                   @config.logger.error("SSE read operation EOF Exception!: #{e.inspect}")
                   raise 'eof exception'
                 rescue Errno::EBADF, IOError => e
@@ -125,12 +124,12 @@ module SplitIoClient
                 return Constants::PUSH_RETRYABLE_ERROR
               end
             rescue Errno::EBADF
-              @config.logger.debug("SSE socket is not connected (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}")
+              @config.logger.debug("SSE socket is not connected: #{e.inspect}") if @config.debug_enabled
               break
             end
 
@@ -156,7 +155,7 @@ module SplitIoClient
           return unless @first_event.value
 
           response_code = @event_parser.first_event(data)
-          @config.logger.debug("SSE client first event code: #{response_code}")
+          @config.logger.debug("SSE client first event code: #{response_code}") if @config.debug_enabled
 
           error_event = false
           events = @event_parser.parse(data)
@@ -165,7 +164,7 @@ module SplitIoClient
 
           if response_code == OK_CODE && !error_event
             @connected.make_true
-            @config.logger.debug("SSE client first event Connected is 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)
           end
@@ -202,7 +201,7 @@ module SplitIoClient
         end
 
         def process_data(partial_data)
-          @config.logger.debug("Event partial data: #{partial_data}")
+          @config.logger.debug("Event partial data: #{partial_data}") if @config.debug_enabled
           return if partial_data.nil? || partial_data == KEEP_ALIVE_RESPONSE
 
           events = @event_parser.parse(partial_data)
@@ -220,7 +219,7 @@ module SplitIoClient
           req << "SplitSDKMachineName: #{@config.machine_name}\r\n"
           req << "SplitSDKClientKey: #{@api_key.split(//).last(4).join}\r\n" unless @api_key.nil?
           req << "Cache-Control: no-cache\r\n\r\n"
-          @config.logger.debug("Request info: #{req}")
+          @config.logger.debug("Request info: #{req}") if @config.debug_enabled
           req
         end
 
@@ -255,7 +254,7 @@ module SplitIoClient
         def push_status(status)
           return if status.nil?
           
-          @config.logger.debug("Pushing new sse status: #{status}")
+          @config.logger.debug("Pushing new sse status: #{status}") if @config.debug_enabled
           @status_queue.push(status)
         end
       end

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

@@ -29,14 +29,14 @@ module SplitIoClient
 
           events
         rescue StandardError => e
-          @config.logger.debug("Error during parsing a event: #{e.inspect}")
+          @config.logger.debug("Error during parsing a event: #{e.inspect}") if @config.debug_enabled
           []
         end
 
         def first_event(raw_data)
           raw_data.split("\n")[0].split(' ')[1].to_i
         rescue StandardError => e
-          @config.logger.debug("Error parsing first event: #{e.inspect}")
+          @config.logger.error("Error parsing first event: #{e.inspect}")
           BAD_REQUEST_CODE
         end
 

data/lib/splitclient-rb/sse/notification_manager_keeper.rb

@@ -42,12 +42,12 @@ module SplitIoClient
           @telemetry_runtime_producer.record_streaming_event(Telemetry::Domain::Constants::STREAMING_STATUS, DISABLED)
           push_status(Constants::PUSH_SUBSYSTEM_OFF)
         else
-          @config.logger.error("Incorrect event type: #{incoming_notification}")
+          @config.logger.error("Incorrect event type: #{incoming_notification}") if @config.debug_enabled
         end
       end
 
       def process_event_occupancy(channel, publishers)
-        @config.logger.debug("Processed occupancy event with #{publishers} publishers. Channel: #{channel}")
+        @config.logger.debug("Processed occupancy event with #{publishers} publishers. Channel: #{channel}") if @config.debug_enabled
 
         update_publishers(channel, publishers)
 
@@ -76,7 +76,7 @@ module SplitIoClient
       end
 
       def push_status(status)
-        @config.logger.debug("Pushing occupancy status: #{status}")
+        @config.logger.debug("Pushing occupancy status: #{status}") if @config.debug_enabled
         @status_queue.push(status)
       end
     end

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

@@ -14,13 +14,13 @@ module SplitIoClient
 
         def add_to_queue(change_number, segment_name)
           item = { change_number: change_number, segment_name: segment_name }
-          @config.logger.debug("SegmentsWorker add to queue #{item}")
+          @config.logger.debug("SegmentsWorker add to queue #{item}") if @config.debug_enabled
           @queue.push(item)
         end
 
         def start
           if @running.value
-            @config.logger.debug('segments worker already running.')
+            @config.logger.debug('segments worker already running.') if @config.debug_enabled
             return
           end
 
@@ -30,7 +30,7 @@ module SplitIoClient
 
         def stop
           unless @running.value
-            @config.logger.debug('segments worker not running.')
+            @config.logger.debug('segments worker not running.') if @config.debug_enabled
             return
           end
 
@@ -44,7 +44,7 @@ module SplitIoClient
           while (item = @queue.pop)
             segment_name = item[:segment_name]
             cn = item[:change_number]
-            @config.logger.debug("SegmentsWorker change_number dequeue #{segment_name}, #{cn}")
+            @config.logger.debug("SegmentsWorker change_number dequeue #{segment_name}, #{cn}") if @config.debug_enabled
 
             @synchronizer.fetch_segment(segment_name, cn)
           end

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

@@ -18,7 +18,7 @@ module SplitIoClient
 
         def start
           if @running.value
-            @config.logger.debug('feature_flags_worker already running.')
+            @config.logger.debug('feature_flags_worker already running.') if @config.debug_enabled
             return
           end
 
@@ -28,7 +28,7 @@ module SplitIoClient
 
         def stop
           unless @running.value
-            @config.logger.debug('feature_flags_worker not running.')
+            @config.logger.debug('feature_flags_worker not running.') if @config.debug_enabled
             return
           end
 
@@ -37,7 +37,7 @@ module SplitIoClient
         end
 
         def add_to_queue(notification)
-          @config.logger.debug("feature_flags_worker add to queue #{notification.data['changeNumber']}")
+          @config.logger.debug("feature_flags_worker add to queue #{notification.data['changeNumber']}") if @config.debug_enabled
           @queue.push(notification)
         end
 
@@ -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
+              @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
+            @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.10.1-rc1'
+  VERSION = '8.11.0'
 end