updated factory and split_client with integration tests

Author: chillaq

lib/splitclient-rb.rb

@@ -70,6 +70,7 @@
 require 'splitclient-rb/engine/events/events_manager.rb'
 require 'splitclient-rb/engine/events/events_task.rb'
 require 'splitclient-rb/engine/events/events_delivery.rb'
+require 'splitclient-rb/engine/events/noop_events_queue.rb'
 require 'splitclient-rb/engine/parser/condition'
 require 'splitclient-rb/engine/parser/partition'
 require 'splitclient-rb/engine/parser/evaluator'

lib/splitclient-rb/clients/split_client.rb

@@ -18,7 +18,7 @@ class SplitClient
     # @param sdk_key [String] the SDK key for your split account
     #
     # @return [SplitIoClient] split.io client instance
-    def initialize(sdk_key, repositories, status_manager, config, impressions_manager, telemetry_evaluation_producer, evaluator, split_validator, fallback_treatment_calculator)
+    def initialize(sdk_key, repositories, status_manager, config, impressions_manager, telemetry_evaluation_producer, evaluator, split_validator, fallback_treatment_calculator, events_manager)
       @api_key = sdk_key
       @splits_repository = repositories[:splits]
       @segments_repository = repositories[:segments]
@@ -33,6 +33,7 @@ def initialize(sdk_key, repositories, status_manager, config, impressions_manage
       @split_validator = split_validator
       @evaluator = evaluator
       @fallback_treatment_calculator = fallback_treatment_calculator
+      @events_manager = events_manager
     end
 
     def get_treatment(
@@ -176,6 +177,14 @@ def block_until_ready(time = nil)
       @status_manager.wait_until_ready(time) if @status_manager
     end
 
+    def register(sdk_event, handler)
+      @events_manager.register(sdk_event, handler)
+    end
+
+    def unregister(sdk_event, handler)
+      @events_manager.unregister(sdk_event)
+    end
+
     private
 
     def check_properties_size(properties_size, msg = "Event not queued")

lib/splitclient-rb/engine/api/faraday_middleware/gzip.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'faraday'
+require 'stringio'
 
 module SplitIoClient
   module FaradayMiddleware

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

@@ -14,7 +14,7 @@ def initialize(events_manager_config, events_delivery, config)
         end
 
         def register(sdk_event, event_handler)
-          return unless !@active_subscriptions.key?(sdk_event) || get_event_handler(sdk_event).nil?
+          return if @active_subscriptions.key?(sdk_event) && !get_event_handler(sdk_event).nil?
 
           @mutex.synchronize do
             # SDK ready already fired
@@ -25,6 +25,7 @@ def register(sdk_event, event_handler)
               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)
           end
         end

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

lib/splitclient-rb/split_factory.rb

@@ -45,6 +45,7 @@ def initialize(api_key, config_hash = {})
 
       register_factory
 
+      build_events_manager
       build_telemetry_components
       build_flag_sets_filter
       build_repositories
@@ -53,13 +54,13 @@ def initialize(api_key, config_hash = {})
       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 @@ def build_repositories
       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 @@ def build_impressions_components
     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

lib/splitclient-rb/version.rb

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

spec/integrations/push_client_spec.rb

@@ -39,6 +39,9 @@
   let(:auth_body_response) do
     File.read(File.join(SplitIoClient.root, 'spec/test_data/integrations/auth_body_response.json'))
   end
+  let(:metadata) { nil }
+  let(:event_ready) { false }
+  let(:sdk_update) { false }
 
   before do
     stub_request(:any, /https:\/\/events.*/).to_return(status: 200, body: '')
@@ -155,29 +158,51 @@
       stub_request(:get, auth_service_url + "?s=1.3").to_return(status: 200, body: auth_body_response)
 
       mock_server do |server|
-
+        log = StringIO.new
         streaming_service_url = server.base_uri
         factory = SplitIoClient::SplitFactory.new(
           'test_api_key',
           streaming_service_url: streaming_service_url,
-          auth_service_url: auth_service_url
+          auth_service_url: auth_service_url,
+          logger: Logger.new(log),
+          debug_enabled: true
         )
 
+        reset_flags
         client = factory.client
+        client.register(SplitIoClient::Engine::Models::SdkEvent::SDK_READY, method(:ready_call_back))
+        client.register(SplitIoClient::Engine::Models::SdkEvent::SDK_UPDATE, method(:update_call_back))
         client.block_until_ready
 
         server.setup_response('/') do |_, res|
           send_content(res, event_split_iff_update_no_compression)
         end
-
         treatment = 'control'
         for i in 1..10 do
           sleep(1)
           treatment = client.get_treatment('admin', 'bilal_split')
           break if treatment != 'control'
         end
 
+        expect(@metadata.length).to eq(2)
+        check1 = false
+        check2 = false
+        @metadata.each do |meta|
+          if meta.type == SplitIoClient::Engine::Models::SdkEventType::FLAG_UPDATE
+            expect(meta.names).to eq(['bilal_split'])
+            check1 = true
+          end
+          if meta.type == SplitIoClient::Engine::Models::SdkEventType::SEGMENTS_UPDATE
+            expect(meta.names).to eq([])
+            check2 = true
+          end
+        end
+        expect(check1).to be(true)
+        expect(check2).to be(true)
+        expect(@event_ready).to be(true)
+        expect(@sdk_update).to eq(true)
         expect(treatment).to eq('off')
+
         client.destroy
       end
     end
@@ -319,20 +344,35 @@
         stub_request(:get, auth_service_url + "?s=1.3").to_return(status: 200, body: auth_body_response)
 
         streaming_service_url = server.base_uri
+        log = StringIO.new
         factory = SplitIoClient::SplitFactory.new(
           'test_api_key',
           streaming_enabled: true,
           streaming_service_url: streaming_service_url,
-          auth_service_url: auth_service_url
+          auth_service_url: auth_service_url,
+          logger: Logger.new(log),
+          debug_enabled: true
         )
 
+        reset_flags
         client = factory.client
+        client.register(SplitIoClient::Engine::Models::SdkEvent::SDK_UPDATE, method(:update_call_back))
         client.block_until_ready(1)
         sleep(2)
         expect(client.get_treatment('admin', 'push_test')).to eq('on')
         expect(a_request(:get, 'https://sdk.split.io/api/splitChanges?s=1.3&since=-1&rbSince=-1')).to have_been_made.times(1)
         expect(a_request(:get, 'https://sdk.split.io/api/splitChanges?s=1.3&since=1585948850109&rbSince=-1')).to have_been_made.times(1)
         expect(a_request(:get, 'https://sdk.split.io/api/splitChanges?s=1.3&since=1585948850110&rbSince=-1')).to have_been_made.times(0)
+
+        check1 = false
+        @metadata.each do |meta|
+          if meta.type == SplitIoClient::Engine::Models::SdkEventType::FLAG_UPDATE
+            expect(meta.names.include?('push_test')).to eq(true)
+            check1 = true
+          end
+        end
+        expect(check1).to eq(true)
+
         client.destroy
       end
     end
@@ -572,4 +612,19 @@ def mock_segment_changes(segment_name, segment_json, since)
     stub_request(:get, "https://sdk.split.io/api/segmentChanges/#{segment_name}?since=#{since}")
       .to_return(status: 200, body: segment_json)
   end
+
+  def ready_call_back(metadata)
+    @event_ready = true
+  end
+
+  def update_call_back(metadata)
+    @sdk_update = true
+    @metadata.push(metadata)
+  end
+
+  def reset_flags
+    @event_ready = false
+    @sdk_update = false
+    @metadata = []
+  end
 end