splitclient-rb 7.1.4.pre.rc19 → 7.2.0.pre.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60c6946b200c0979eb6eedefce813c20b6e3db78424c35540efab92db20be6a7
-  data.tar.gz: 073435bf9df789975fcc78d6e0075314e377014722de8fd3eac296f261263499
+  metadata.gz: 26c30b8e429b82a364a8738b157f9837aa7c0063e4e928eba564ddca250a4350
+  data.tar.gz: 709736898887b3e24169bc0728380b04bf3f321754c24f51526db4f661d331a7
 SHA512:
-  metadata.gz: 420e8e14d6225c92cbab6bc4cdda21314ad9482bae315d8ce0049d3b493caed3376da696c08a563b1bc2e588e9ab11133e7dc311772d0ac56485c0599a1c597f
-  data.tar.gz: 7b8c32b0fe198035538dc00564cad7aae10a7c1a66173c428f8c4004329e4c91255ddfd8cfc4c48aeb8a28b978b2904e35239d0f4cf944bf95b675cfd96a54ee
+  metadata.gz: 621a75e4a9839183d1d327a76cfb093c286345e68f87660345d1321c53050919aac7733af400ce19b575e266f38ec8ffa0109edc917712063271a3c51fbf1b32
+  data.tar.gz: e46f618031d6f83be2f2be332a842b0424206da5cf711637190a1e8d561741cbe65380a67a07d8819a3eff7c93e1c7c7f79c98fcb40b546d158dd9af3f6f8bb6

data/CHANGES.txt

@@ -1,5 +1,10 @@
 CHANGES
 
+7.2.0 (Sep 25, 2020)
+- Added deduplication logic for impressions data.
+  - Now there are two modes for Impressions when the SDK is in standalone mode, OPTIMIZED (default) that only ships unique impressions and DEBUG for times where you need to send ALL impressions to debug an integration.
+  - Impression listener remains unchanged and will still get all impressions.
+
 7.1.3 (Jul 31, 2020)
 - Updated rake development dependency to ~> 12.3.3.
 

data/lib/splitclient-rb.rb

@@ -101,6 +101,7 @@ require 'splitclient-rb/redis_metrics_fixer'
 # SSE 
 require 'splitclient-rb/sse/event_source/back_off'
 require 'splitclient-rb/sse/event_source/client'
+require 'splitclient-rb/sse/event_source/event_parser'
 require 'splitclient-rb/sse/event_source/event_types'
 require 'splitclient-rb/sse/event_source/stream_data'
 require 'splitclient-rb/sse/workers/segments_worker'

data/lib/splitclient-rb/cache/adapters/redis_adapter.rb

@@ -142,7 +142,7 @@ module SplitIoClient
 
         # General
         def exists?(key)
-          @redis.exists(key)
+          @redis.exists?(key)
         end
 
         def delete(key)

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

@@ -15,14 +15,15 @@ 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])
+
+        if response[:push_enabled] && @sse_handler.start(response[:token], response[:channels])
           schedule_next_token_refresh(response[:exp])
           @back_off.reset
-        else
-          stop_sse
+          return
         end
 
+        stop_sse
+
         schedule_next_token_refresh(@back_off.interval) if response[:retry]
       rescue StandardError => e
         @config.logger.error("start_sse: #{e.inspect}")
@@ -31,6 +32,7 @@ module SplitIoClient
       def stop_sse
         @sse_handler.process_disconnect if @sse_handler.sse_client.nil?
         @sse_handler.stop
+        SplitIoClient::Helpers::ThreadHelper.stop(:schedule_next_token_refresh, @config)
       end
 
       private
@@ -41,7 +43,7 @@ module SplitIoClient
             @config.logger.debug("schedule_next_token_refresh refresh in #{time} seconds.") if @config.debug_enabled
             sleep(time)
             @config.logger.debug('schedule_next_token_refresh starting ...') if @config.debug_enabled
-            stop_sse
+            @sse_handler.stop
             start_sse
           rescue StandardError => e
             @config.logger.debug("schedule_next_token_refresh error: #{e.inspect}") if @config.debug_enabled

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

@@ -3,19 +3,13 @@
 module SplitIoClient
   module Engine
     class SyncManager
-      include SplitIoClient::Cache::Fetchers
-
       def initialize(
         repositories,
         api_key,
         config,
-        params
+        synchronizer
       )
-        split_fetcher = SplitFetcher.new(repositories[:splits], api_key, params[:metrics], config, params[:sdk_blocker])
-        segment_fetcher = SegmentFetcher.new(repositories[:segments], api_key, params[:metrics], config, params[:sdk_blocker])
-        sync_params = { split_fetcher: split_fetcher, segment_fetcher: segment_fetcher, imp_counter: params[:impression_counter] }
-
-        @synchronizer = Synchronizer.new(repositories, api_key, config, params[:sdk_blocker], sync_params)
+        @synchronizer = synchronizer
         notification_manager_keeper = SplitIoClient::SSE::NotificationManagerKeeper.new(config) do |manager|
           manager.on_occupancy { |publisher_available| process_occupancy(publisher_available) }
           manager.on_push_shutdown { process_push_shutdown }
@@ -28,10 +22,11 @@ module SplitIoClient
           notification_manager_keeper
         ) do |handler|
           handler.on_connected { process_connected }
-          handler.on_disconnect { process_disconnect }
+          handler.on_disconnect { |reconnect| process_disconnect(reconnect) }
         end
 
         @push_manager = PushManager.new(config, @sse_handler, api_key)
+        @sse_connected = Concurrent::AtomicBoolean.new(false)
         @config = config
       end
 
@@ -90,6 +85,12 @@ module SplitIoClient
       end
 
       def process_connected
+        if @sse_connected.value
+          @config.logger.debug('Streaming already connected.')
+          return
+        end
+
+        @sse_connected.make_true
         @synchronizer.stop_periodic_fetch
         @synchronizer.sync_all
         @sse_handler.start_workers
@@ -97,23 +98,42 @@ module SplitIoClient
         @config.logger.error("process_connected error: #{e.inspect}")
       end
 
-      def process_disconnect
+      def process_disconnect(reconnect)
+        unless @sse_connected.value
+          @config.logger.debug('Streaming already disconnected.')
+          return
+        end
+
+        @sse_connected.make_false
         @sse_handler.stop_workers
         @synchronizer.start_periodic_fetch
+
+        if reconnect
+          @synchronizer.sync_all
+          @push_manager.start_sse
+        end
       rescue StandardError => e
         @config.logger.error("process_disconnect error: #{e.inspect}")
       end
 
       def process_occupancy(push_enable)
-        process_disconnect unless push_enable
-        process_connected if push_enable
+        if push_enable
+          @synchronizer.stop_periodic_fetch
+          @synchronizer.sync_all
+          @sse_handler.start_workers
+          return
+        end
+
+        @sse_handler.stop_workers
+        @synchronizer.start_periodic_fetch
       rescue StandardError => e
         @config.logger.error("process_occupancy error: #{e.inspect}")
       end
 
       def process_push_shutdown
         @push_manager.stop_sse
-        process_disconnect
+        @sse_handler.stop_workers
+        @synchronizer.start_periodic_fetch
       rescue StandardError => e
         @config.logger.error("process_push_shutdown error: #{e.inspect}")
       end

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

@@ -28,9 +28,11 @@ module SplitIoClient
       end
 
       def sync_all
-        @config.logger.debug('Synchronizing Splits and Segments ...') if @config.debug_enabled
-        fetch_splits
-        fetch_segments
+        @config.threads[:sync_all_thread] = Thread.new do
+          @config.logger.debug('Synchronizing Splits and Segments ...') if @config.debug_enabled
+          fetch_splits
+          fetch_segments
+        end
       end
 
       def start_periodic_data_recording

data/lib/splitclient-rb/split_factory.rb

@@ -7,6 +7,7 @@ module SplitIoClient
     include SplitIoClient::Cache::Repositories
     include SplitIoClient::Cache::Stores
     include SplitIoClient::Cache::Senders
+    include SplitIoClient::Cache::Fetchers
 
     attr_reader :adapter, :client, :manager, :config
 
@@ -53,8 +54,12 @@ module SplitIoClient
       if @config.localhost_mode
         start_localhost_components
       else
-        params = { sdk_blocker: @sdk_blocker, metrics: @metrics, impression_counter: @impression_counter }
-        SplitIoClient::Engine::SyncManager.new(repositories, @api_key, @config, params).start
+        split_fetcher = SplitFetcher.new(@splits_repository, @api_key, @metrics, config, @sdk_blocker)
+        segment_fetcher = SegmentFetcher.new(@segments_repository, @api_key, @metrics, config, @sdk_blocker)
+        params = { split_fetcher: split_fetcher, segment_fetcher: segment_fetcher, imp_counter: @impression_counter }
+
+        synchronizer = SplitIoClient::Engine::Synchronizer.new(repositories, @api_key, @config, @sdk_blocker, params)
+        SplitIoClient::Engine::SyncManager.new(repositories, @api_key, @config, synchronizer).start
       end
     end
 
@@ -125,14 +130,13 @@ module SplitIoClient
     end
 
     def repositories
-      repos = {}
-      repos[:splits] = @splits_repository
-      repos[:segments] = @segments_repository
-      repos[:impressions] = @impressions_repository
-      repos[:events] = @events_repository
-      repos[:metrics] = @metrics_repository
-
-      repos
+      { 
+        splits: @splits_repository,
+        segments: @segments_repository,
+        impressions: @impressions_repository,
+        events: @events_repository,
+        metrics: @metrics_repository
+      }
     end
 
     def start_localhost_components

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: false
 
-require 'concurrent/atomics'
 require 'socketry'
 require 'uri'
 
@@ -9,15 +8,16 @@ module SplitIoClient
     module EventSource
       class Client
         DEFAULT_READ_TIMEOUT = 70
+        CONNECT_TIMEOUT = 30_000
         KEEP_ALIVE_RESPONSE = "c\r\n:keepalive\n\n\r\n".freeze
+        ERROR_EVENT_TYPE = 'error'.freeze
 
         def initialize(config, read_timeout: DEFAULT_READ_TIMEOUT)
           @config = config
           @read_timeout = read_timeout
           @connected = Concurrent::AtomicBoolean.new(false)
           @socket = nil
-          @back_off = BackOff.new(@config.streaming_reconnect_back_off_base)
-
+          @event_parser = SSE::EventSource::EventParser.new(config)
           @on = { event: ->(_) {}, connected: ->(_) {}, disconnect: ->(_) {} }
 
           yield self if block_given?
@@ -35,8 +35,8 @@ module SplitIoClient
           @on[:disconnect] = action
         end
 
-        def close
-          dispatch_disconnect
+        def close(reconnect = false)
+          dispatch_disconnect(reconnect)
           @connected.make_false
           SplitIoClient::Helpers::ThreadHelper.stop(:connect_stream, @config)
           @socket&.close
@@ -46,10 +46,16 @@ module SplitIoClient
 
         def start(url)
           @uri = URI(url)
+          latch = Concurrent::CountDownLatch.new(1)
+
+          connect_thread(latch)
 
-          connect_thread
+          return false unless latch.wait(CONNECT_TIMEOUT)
+
+          connected?
         rescue StandardError => e
           @config.logger.error("SSEClient start Error: #{e.inspect}")
+          connected?
         end
 
         def connected?
@@ -58,18 +64,15 @@ module SplitIoClient
 
         private
 
-        def connect_thread
+        def connect_thread(latch)
           @config.threads[:connect_stream] = Thread.new do
             @config.logger.info('Starting connect_stream thread ...') if @config.debug_enabled
-            connect_stream
+            connect_stream(latch)
           end
         end
 
-        def connect_stream
-          interval = @back_off.interval
-          sleep(interval) if interval.positive?
-
-          socket_write
+        def connect_stream(latch)
+          socket_write(latch)
 
           while @connected.value
             begin
@@ -77,24 +80,24 @@ module SplitIoClient
 
               raise 'eof exception' if partial_data == :eof
             rescue StandardError => e
-              @config.logger.error(e.inspect) if @config.debug_enabled
-              @connected.make_false
-              @socket&.close
-              @socket = nil
-              connect_stream
+              @config.logger.error('Error reading partial data: ' + e.inspect) if @config.debug_enabled
+              close(true) # close conexion & reconnect
+              return
             end
 
             process_data(partial_data)
           end
         end
 
-        def socket_write
+        def socket_write(latch)
           @socket = socket_connect
           @socket.write(build_request(@uri))
           dispatch_connected
         rescue StandardError => e
           @config.logger.error("Error during connecting to #{@uri.host}. Error: #{e.inspect}")
           close
+        ensure
+          latch.count_down
         end
 
         def socket_connect
@@ -104,11 +107,11 @@ module SplitIoClient
         end
 
         def process_data(partial_data)
-          unless partial_data.nil? || partial_data == KEEP_ALIVE_RESPONSE
-            @config.logger.debug("Event partial data: #{partial_data}") if @config.debug_enabled
-            buffer = read_partial_data(partial_data)
-            parse_event(buffer)
-          end
+          return if partial_data.nil? || partial_data == KEEP_ALIVE_RESPONSE
+
+          @config.logger.debug("Event partial data: #{partial_data}") if @config.debug_enabled
+          events = @event_parser.parse(partial_data)
+          events.each { |event| process_event(event) }
         rescue StandardError => e
           @config.logger.error("process_data error: #{e.inspect}")
         end
@@ -122,64 +125,38 @@ module SplitIoClient
           req
         end
 
-        def read_partial_data(data)
-          buffer = ''
-          buffer << data
-          buffer.chomp!
-          buffer.split("\n")
-        end
-
-        def parse_event(buffer)
-          type = nil
-
-          buffer.each do |d|
-            splited_data = d.split(':')
-
-            case splited_data[0]
-            when 'event'
-              type = splited_data[1].strip
-            when 'data'
-              data = parse_event_data(d, type)
-              unless type.nil? || data[:data].nil?
-                event = StreamData.new(type, data[:client_id], data[:data], data[:channel])
-                dispatch_event(event)
-              end
-            end
+        def process_event(event)
+          case event.event_type
+          when ERROR_EVENT_TYPE
+            dispatch_error(event)
+          else
+            dispatch_event(event)
           end
-        rescue StandardError => e
-          @config.logger.error("Error during parsing a event: #{e.inspect}")
         end
 
-        def parse_event_data(data, type)
-          event_data = JSON.parse(data.sub('data: ', ''))
-          client_id = event_data['clientId']&.strip
-          channel = event_data['channel']&.strip
-          parsed_data = JSON.parse(event_data['data']) unless type == 'error'
-          parsed_data = event_data if type == 'error'
-
-          { client_id: client_id, channel: channel, data: parsed_data }
+        def dispatch_error(event)
+          @config.logger.error("Event error: #{event.event_type}, #{event.data}")
+          if event.data['code'] >= 40_140 && event.data['code'] <= 40_149
+            close(true) # close conexion & reconnect
+          elsif event.data['code'] >= 40_000 && event.data['code'] <= 49_999
+            close # close conexion
+          end
         end
 
         def dispatch_event(event)
-          raise SSEClientException.new(event), 'Error event' if event.event_type == 'error'
-
           @config.logger.debug("Dispatching event: #{event.event_type}, #{event.channel}") if @config.debug_enabled
           @on[:event].call(event)
-        rescue SSEClientException => e
-          @config.logger.error("Event error: #{e.event.event_type}, #{e.event.data}")
-          close
         end
 
         def dispatch_connected
           @connected.make_true
-          @back_off.reset
           @config.logger.debug('Dispatching connected') if @config.debug_enabled
           @on[:connected].call
         end
 
-        def dispatch_disconnect
+        def dispatch_disconnect(reconnect)
           @config.logger.debug('Dispatching disconnect') if @config.debug_enabled
-          @on[:disconnect].call
+          @on[:disconnect].call(reconnect)
         end
       end
     end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: false
+
+module SplitIoClient
+  module SSE
+    module EventSource
+      class EventParser
+        def initialize(config)
+          @config = config
+        end
+
+        def parse(raw_event)
+          type = nil
+          events = []
+          buffer = read_partial_data(raw_event)
+
+          buffer.each do |d|
+            splited_data = d.split(':')
+
+            case splited_data[0]
+            when 'event'
+              type = splited_data[1].strip
+            when 'data'
+              data = parse_event_data(d, type)
+              events << StreamData.new(type, data[:client_id], data[:data], data[:channel]) unless type.nil? || data[:data].nil?
+            end
+          end
+
+          events
+        rescue StandardError => e
+          @config.logger.error("Error during parsing a event: #{e.inspect}")
+          []
+        end
+
+        private
+
+        def parse_event_data(data, type)
+          event_data = JSON.parse(data.sub('data: ', ''))
+          client_id = event_data['clientId']&.strip
+          channel = event_data['channel']&.strip
+          parsed_data = JSON.parse(event_data['data']) unless type == 'error'
+          parsed_data = event_data if type == 'error'
+
+          { client_id: client_id, channel: channel, data: parsed_data }
+        end
+
+        def read_partial_data(data)
+          buffer = ''
+          buffer << data
+          buffer.chomp!
+          buffer.split("\n")
+        end
+      end
+    end
+  end
+end

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

@@ -14,7 +14,7 @@ module SplitIoClient
         @sse_client = SSE::EventSource::Client.new(@config) do |client|
           client.on_event { |event| handle_incoming_message(event) }
           client.on_connected { process_connected }
-          client.on_disconnect { process_disconnect }
+          client.on_disconnect { |reconnect| process_disconnect(reconnect) }
         end
 
         @on = { connected: ->(_) {}, disconnect: ->(_) {} }
@@ -56,8 +56,8 @@ module SplitIoClient
         @on[:disconnect] = action
       end
 
-      def process_disconnect
-        @on[:disconnect].call
+      def process_disconnect(reconnect)
+        @on[:disconnect].call(reconnect)
       end
 
       private

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

@@ -8,27 +8,39 @@ module SplitIoClient
           @synchronizer = synchronizer
           @config = config
           @segments_repository = segments_repository
-          @queue = nil
-        end
-
-        def start
-          return if SplitIoClient::Helpers::ThreadHelper.alive?(:segment_update_worker, @config)
-
           @queue = Queue.new
-          perform_thread
+          @running = Concurrent::AtomicBoolean.new(false)
         end
 
         def add_to_queue(change_number, segment_name)
-          return if @queue.nil?
+          unless @running.value
+            @config.logger.debug('segments worker not running.')
+            return
+          end
 
           item = { change_number: change_number, segment_name: segment_name }
           @config.logger.debug("SegmentsWorker add to queue #{item}")
           @queue.push(item)
         end
 
+        def start
+          if @running.value
+            @config.logger.debug('segments worker already running.')
+            return
+          end
+
+          @running.make_true
+          perform_thread
+        end
+
         def stop
+          unless @running.value
+            @config.logger.debug('segments worker not running.')
+            return
+          end
+
+          @running.make_false
           SplitIoClient::Helpers::ThreadHelper.stop(:segment_update_worker, @config)
-          @queue = nil
         end
 
         private

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

@@ -8,35 +8,53 @@ module SplitIoClient
           @synchronizer = synchronizer
           @config = config
           @splits_repository = splits_repository
+          @queue = Queue.new
+          @running = Concurrent::AtomicBoolean.new(false)
         end
 
         def start
-          return if SplitIoClient::Helpers::ThreadHelper.alive?(:split_update_worker, @config)
+          if @running.value
+            @config.logger.debug('splits worker already running.')
+            return
+          end
 
-          @queue = Queue.new
+          @running.make_true
           perform_thread
         end
 
+        def stop
+          unless @running.value
+            @config.logger.debug('splits worker not running.')
+            return
+          end
+
+          @running.make_false
+          SplitIoClient::Helpers::ThreadHelper.stop(:split_update_worker, @config)
+        end
+
         def add_to_queue(change_number)
-          return if @queue.nil?
+          unless @running.value
+            @config.logger.debug('splits worker not running.')
+            return
+          end
 
           @config.logger.debug("SplitsWorker add to queue #{change_number}")
           @queue.push(change_number)
         end
 
         def kill_split(change_number, split_name, default_treatment)
-          return if @queue.nil?
+          unless @running.value
+            @config.logger.debug('splits worker not running.')
+            return
+          end
+
+          return if @splits_repository.get_change_number.to_i > change_number
 
           @config.logger.debug("SplitsWorker kill #{split_name}, #{change_number}")
           @splits_repository.kill(change_number, split_name, default_treatment)
           add_to_queue(change_number)
         end
 
-        def stop
-          SplitIoClient::Helpers::ThreadHelper.stop(:split_update_worker, @config)
-          @queue = nil
-        end
-
         private
 
         def perform

data/lib/splitclient-rb/version.rb

@@ -1,3 +1,3 @@
 module SplitIoClient
-  VERSION = '7.1.4.pre.rc19'
+  VERSION = '7.2.0.pre.rc1'
 end

data/splitclient-rb.gemspec

@@ -55,7 +55,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'jwt', '>= 2.2.1'
   spec.add_runtime_dependency 'lru_redux'
   spec.add_runtime_dependency 'net-http-persistent', '>= 2.9'
-  spec.add_runtime_dependency 'redis', '>= 3.2'
+  spec.add_runtime_dependency 'redis', '>= 4.2.2'
   spec.add_runtime_dependency 'socketry', '~> 0.5.1'
   spec.add_runtime_dependency 'thread_safe', '>= 0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splitclient-rb
 version: !ruby/object:Gem::Version
-  version: 7.1.4.pre.rc19
+  version: 7.2.0.pre.rc1
 platform: ruby
 authors:
 - Split Software
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-23 00:00:00.000000000 Z
+date: 2020-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: allocation_stats
@@ -268,14 +268,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 4.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 4.2.2
 - !ruby/object:Gem::Dependency
   name: socketry
   requirement: !ruby/object:Gem::Requirement
@@ -425,6 +425,7 @@ files:
 - 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
 - lib/splitclient-rb/sse/event_source/stream_data.rb
 - lib/splitclient-rb/sse/notification_manager_keeper.rb