splitclient-rb 6.3.0 → 8.11.0

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

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module SSE
+    module Workers
+      class SplitsWorker
+        def initialize(synchronizer, config, feature_flags_repository, telemetry_runtime_producer,
+                       segment_fetcher, rule_based_segment_repository)
+          @synchronizer = synchronizer
+          @config = config
+          @feature_flags_repository = feature_flags_repository
+          @queue = Queue.new
+          @running = Concurrent::AtomicBoolean.new(false)
+          @telemetry_runtime_producer = telemetry_runtime_producer
+          @segment_fetcher = segment_fetcher
+          @rule_based_segment_repository = rule_based_segment_repository
+        end
+
+        def start
+          if @running.value
+            @config.logger.debug('feature_flags_worker already running.') if @config.debug_enabled
+            return
+          end
+
+          @running.make_true
+          perform_thread
+        end
+
+        def stop
+          unless @running.value
+            @config.logger.debug('feature_flags_worker not running.') if @config.debug_enabled
+            return
+          end
+
+          @running.make_false
+          Helpers::ThreadHelper.stop(:split_update_worker, @config)
+        end
+
+        def add_to_queue(notification)
+          @config.logger.debug("feature_flags_worker add to queue #{notification.data['changeNumber']}") if @config.debug_enabled
+          @queue.push(notification)
+        end
+
+        private
+
+        def perform_thread
+          @config.threads[:split_update_worker] = Thread.new do
+            @config.logger.debug('starting feature_flags_worker ...') if @config.debug_enabled
+            perform
+          end
+        end
+
+        def perform
+          while (notification = @queue.pop)
+            @config.logger.debug("feature_flags_worker change_number dequeue #{notification.data['changeNumber']}") if @config.debug_enabled
+            case notification.data['type']
+            when SSE::EventSource::EventTypes::SPLIT_UPDATE
+              success = update_feature_flag(notification)
+              @synchronizer.fetch_splits(notification.data['changeNumber'], 0) unless success
+            when SSE::EventSource::EventTypes::RB_SEGMENT_UPDATE
+              success = update_rule_based_segment(notification)
+              @synchronizer.fetch_splits(0, notification.data['changeNumber']) unless success
+            when SSE::EventSource::EventTypes::SPLIT_KILL
+              kill_feature_flag(notification)
+            end
+          end
+        end
+
+        def update_feature_flag(notification)
+          return true if @feature_flags_repository.get_change_number.to_i >= notification.data['changeNumber']
+          return false unless !notification.data['d'].nil? && @feature_flags_repository.get_change_number == notification.data['pcn']
+
+          new_split = update_feature_flag_repository(notification)
+          fetch_segments_if_not_exists(Helpers::Util.segment_names_by_object(new_split, 'IN_SEGMENT'), @feature_flags_repository)
+          if fetch_rule_based_segments_if_not_exists(Helpers::Util.segment_names_by_object(new_split, 'IN_RULE_BASED_SEGMENT'),
+                                                     notification.data['changeNumber'])
+            return true
+          end
+
+          @telemetry_runtime_producer.record_updates_from_sse(Telemetry::Domain::Constants::SPLITS)
+
+          true
+        rescue StandardError => e
+          @config.logger.debug("Failed to update Split: #{e.inspect}") if @config.debug_enabled
+
+          false
+        end
+
+        def update_feature_flag_repository(notification)
+          new_split = return_object_from_json(notification)
+          SplitIoClient::Helpers::RepositoryHelper.update_feature_flag_repository(@feature_flags_repository, [new_split],
+                                                                                  notification.data['changeNumber'], @config, false)
+          new_split
+        end
+
+        def update_rule_based_segment(notification)
+          return true if @rule_based_segment_repository.get_change_number.to_i >= notification.data['changeNumber']
+          return false unless !notification.data['d'].nil? &&
+                              @rule_based_segment_repository.get_change_number == notification.data['pcn']
+
+          new_rb_segment = return_object_from_json(notification)
+          SplitIoClient::Helpers::RepositoryHelper.update_rule_based_segment_repository(@rule_based_segment_repository,
+                                                                                        [new_rb_segment],
+                                                                                        notification.data['changeNumber'], @config)
+          fetch_segments_if_not_exists(Helpers::Util.segment_names_in_rb_segment(new_rb_segment, 'IN_SEGMENT'),
+                                       @rule_based_segment_repository)
+
+          # @telemetry_runtime_producer.record_updates_from_sse(Telemetry::Domain::Constants::SPLITS)
+
+          true
+        rescue StandardError => e
+          @config.logger.debug("Failed to update Split: #{e.inspect}") if @config.debug_enabled
+
+          false
+        end
+
+        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
+          @feature_flags_repository.kill(notification.data['changeNumber'],
+                                         notification.data['splitName'],
+                                         notification.data['defaultTreatment'])
+          @synchronizer.fetch_splits(notification.data['changeNumber'], 0)
+        end
+
+        def return_object_from_json(notification)
+          object_json = Helpers::DecryptionHelper.get_encoded_definition(notification.data['c'], notification.data['d'])
+          JSON.parse(object_json, symbolize_names: true)
+        end
+
+        def fetch_segments_if_not_exists(segment_names, object_repository)
+          return if segment_names.nil?
+
+          object_repository.set_segment_names(segment_names)
+          @segment_fetcher.fetch_segments_if_not_exists(segment_names)
+        end
+
+        def fetch_rule_based_segments_if_not_exists(segment_names, change_number)
+          return false if segment_names.nil? || segment_names.empty? || @rule_based_segment_repository.contains?(segment_names.to_a)
+
+          @synchronizer.fetch_splits(0, change_number)
+
+          true
+        end
+      end
+    end
+  end
+end

data/lib/splitclient-rb/telemetry/domain/constants.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Telemetry
+    module Domain
+      class Constants
+        BUR_TIMEOUT = 'bur_timeout'
+        NON_READY_USAGES = 'non_ready_usages'
+
+        IMPRESSIONS_DROPPED = 'impressions_dropped'
+        IMPRESSIONS_DEDUPE = 'impressions_deduped'
+        IMPRESSIONS_QUEUED = 'impressions_queued'
+
+        EVENTS_DROPPED = 'events_dropped'
+        EVENTS_QUEUED = 'events_queued'
+
+        SPLIT_SYNC = 'split_sync'
+        SEGMENT_SYNC = 'segment_sync'
+        IMPRESSIONS_SYNC = 'impressions_sync'
+        IMPRESSION_COUNT_SYNC = 'impression_count_sync'
+        EVENT_SYNC = 'event_sync'
+        TELEMETRY_SYNC = 'telemetry_sync'
+        TOKEN_SYNC = 'token_sync'
+
+        SSE_CONNECTION_ESTABLISHED = 0
+        OCCUPANCY_PRI = 10
+        OCCUPANCY_SEC = 20
+        STREAMING_STATUS = 30
+        CONNECTION_ERROR = 40
+        TOKEN_REFRESH = 50
+        ABLY_ERROR = 60
+        SYNC_MODE = 70
+
+        TREATMENT = 'treatment'
+        TREATMENTS = 'treatments'
+        TREATMENT_WITH_CONFIG = 'treatmentWithConfig'
+        TREATMENTS_WITH_CONFIG = 'treatmentsWithConfig'
+        TREATMENTS_BY_FLAG_SET = 'treatmentsByFlagSet'
+        TREATMENTS_BY_FLAG_SETS = 'treatmentsByFlagSets'
+        TREATMENTS_WITH_CONFIG_BY_FLAG_SET = 'treatmentWithConfigByFlagSet'
+        TREATMENTS_WITH_CONFIG_BY_FLAG_SETS = 'treatmentsWithConfigByFlagSets'
+        TRACK = 'track'
+
+        SPLITS = 'splits'
+      end
+    end
+  end
+end

data/lib/splitclient-rb/telemetry/domain/structs.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Telemetry
+    # sp: splits, se: segments, im: impressions, ic:impression count, ev: events, te: telemetry, to: token.
+    LastSynchronization = Struct.new(:sp, :se, :im, :ic, :ev, :te, :to)
+    HttpErrors = Struct.new(:sp, :se, :im, :ic, :ev, :te, :to)
+    HttpLatencies = Struct.new(:sp, :se, :im, :ic, :ev, :te, :to)
+
+    # sp: splits, se: segmentos, im: impressions, ev: events, t: telemetry
+    Rates = Struct.new(:sp, :se, :im, :ev, :te)
+
+    # s: sdkUrl, e: eventsUrl, a: authUrl, st: streamUrl, t: telemetryUrl
+    UrlOverrides = Struct.new(:s, :e, :a, :st, :t)
+
+    # om: operationMode, st: storage, af: activeFactories, rf: redundantActiveFactories, t: tags, se: streamingEnabled,
+    # rr: refreshRate, uo: urlOverrides, iq: impressionsQueueSize, eq: eventsQueueSize, im: impressionsMode,
+    # il: impressionListenerEnabled, hp: httpProxyDetected, tr: timeUntilSdkReady, bt: burTimeouts,
+    # nr: sdkNotReadyUsage, i: integrations, fsT: Total flagsets, fsI: Invalid flagsets
+    ConfigInit = Struct.new(:om, :st, :af, :rf, :t, :fsT, :fsI, :se, :rr, :uo, :iq, :eq, :im, :il, :hp, :tr, :bt, :nr, :i)
+
+    # ls: lastSynchronization, ml: clientMethodLatencies, me: clientMethodExceptions, he: httpErros, hl: httpLatencies,
+    # tr: tokenRefreshes, ar: authRejections, iq: impressionsQueued, ide: impressionsDeduped, idr: impressionsDropped,
+    # spc: splitsCount, sec: segmentCount, skc: segmentKeyCount, sl: sessionLengthMs, eq: eventsQueued, ed: eventsDropped,
+    # se: streamingEvents, t: tags, ufs: updates from sse
+    Usage = Struct.new(:ls, :ml, :me, :he, :hl, :tr, :ar, :iq, :ide, :idr, :spc, :sec, :skc, :sl, :eq, :ed, :se, :t, :ufs)
+
+    # t: treatment, ts: treatments, tc: treatmentWithConfig, tcs: treatmentsWithConfig, tr: track
+    ClientMethodLatencies = Struct.new(:t, :ts, :tc, :tcs, :tf, :tfs, :tcf, :tcfs, :tr)
+    ClientMethodExceptions = Struct.new(:t, :ts, :tc, :tcs, :tf, :tfs, :tcf, :tcfs, :tr)
+
+    # sp: splits
+    UpdatesFromSSE = Struct.new(:sp)
+  end
+end

data/lib/splitclient-rb/telemetry/evaluation_consumer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Telemetry
+    class EvaluationConsumer
+      extend Forwardable
+      def_delegators :@evaluation, :pop_latencies, :pop_exceptions
+
+      def initialize(config)
+        @evaluation = SplitIoClient::Telemetry::MemoryEvaluationConsumer.new(config)
+      end
+    end
+  end
+end

data/lib/splitclient-rb/telemetry/evaluation_producer.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Telemetry
+    class EvaluationProducer
+      extend Forwardable
+      def_delegators :@evaluation,
+                     :record_latency,
+                     :record_exception
+
+      def initialize(config)
+        @evaluation = case config.telemetry_adapter.class.to_s
+                      when 'SplitIoClient::Cache::Adapters::RedisAdapter'
+                        SplitIoClient::Telemetry::RedisEvaluationProducer.new(config)
+                      else
+                        SplitIoClient::Telemetry::MemoryEvaluationProducer.new(config)
+                      end
+      end
+    end
+  end
+end

data/lib/splitclient-rb/telemetry/init_consumer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Telemetry
+    class InitConsumer
+      extend Forwardable
+      def_delegators :@init, :non_ready_usages, :bur_timeouts
+
+      def initialize(config)
+        @init = SplitIoClient::Telemetry::MemoryInitConsumer.new(config)
+      end
+    end
+  end
+end

data/lib/splitclient-rb/telemetry/init_producer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Telemetry
+    class InitProducer
+      extend Forwardable
+      def_delegators :@init, :record_config, :record_non_ready_usages, :record_bur_timeout
+
+      def initialize(config)
+        @init = case config.telemetry_adapter.class.to_s
+                when 'SplitIoClient::Cache::Adapters::RedisAdapter'
+                  SplitIoClient::Telemetry::RedisInitProducer.new(config)
+                else
+                  SplitIoClient::Telemetry::MemoryInitProducer.new(config)
+                end
+      end
+    end
+  end
+end

data/lib/splitclient-rb/telemetry/memory/memory_evaluation_consumer.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Telemetry
+    class MemoryEvaluationConsumer
+      def initialize(config)
+        @config = config
+        @adapter = config.telemetry_adapter
+      end
+
+      def pop_latencies
+        to_return = @adapter.latencies.each_with_object({}) do |latency, memo|
+          memo[latency[:method]] = latency[:latencies]
+        end
+
+        @adapter.init_latencies
+
+        to_return
+      end
+
+      def pop_exceptions
+        to_return = @adapter.exceptions.each_with_object({}) do |exception, memo|
+          memo[exception[:method]] = exception[:exceptions].value
+        end
+
+        @adapter.init_exceptions
+
+        to_return
+      end
+    end
+  end
+end

data/lib/splitclient-rb/telemetry/memory/memory_evaluation_producer.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Telemetry
+    class MemoryEvaluationProducer
+      def initialize(config)
+        @config = config
+        @adapter = config.telemetry_adapter
+      end
+
+      def record_latency(method, bucket)
+        @adapter.latencies.find { |l| l[:method] == method }[:latencies][bucket] += 1
+      rescue StandardError => e
+        @config.log_found_exception(__method__.to_s, e)
+      end
+
+      def record_exception(method)
+        @adapter.exceptions.find { |l| l[:method] == method }[:exceptions].increment
+      rescue StandardError => e
+        @config.log_found_exception(__method__.to_s, e)
+      end
+    end
+  end
+end

data/lib/splitclient-rb/telemetry/memory/memory_init_consumer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Telemetry
+    class MemoryInitConsumer
+      DEFAULT_VALUE = 0
+
+      def initialize(config)
+        @config = config
+        @adapter = config.telemetry_adapter
+      end
+
+      def non_ready_usages
+        find_counts(Domain::Constants::NON_READY_USAGES)
+      end
+
+      def bur_timeouts
+        find_counts(Domain::Constants::BUR_TIMEOUT)
+      end
+
+      private
+
+      def find_counts(action)
+        @adapter.factory_counters.find { |l| l[:action] == action }[:counts].value
+      end
+    end
+  end
+end

data/lib/splitclient-rb/telemetry/memory/memory_init_producer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Telemetry
+    class MemoryInitProducer
+      def initialize(config)
+        @config = config
+        @adapter = config.telemetry_adapter
+      end
+
+      def record_config
+        # no op
+      end
+
+      def record_bur_timeout
+        find_factory_counters(Domain::Constants::BUR_TIMEOUT)[:counts].increment
+      rescue StandardError => e
+        @config.log_found_exception(__method__.to_s, e)
+      end
+
+      def record_non_ready_usages
+        find_factory_counters(Domain::Constants::NON_READY_USAGES)[:counts].increment
+      rescue StandardError => e
+        @config.log_found_exception(__method__.to_s, e)
+      end
+
+      private
+
+      def find_factory_counters(action)
+        @adapter.factory_counters.find { |l| l[:action] == action }
+      end
+    end
+  end
+end

data/lib/splitclient-rb/telemetry/memory/memory_runtime_consumer.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Telemetry
+    class MemoryRuntimeConsumer
+      DEFAULT_VALUE = 0
+
+      def initialize(config)
+        @config = config
+        @adapter = config.telemetry_adapter
+      end
+
+      def pop_tags
+        to_return = @adapter.tags
+
+        @adapter.init_tags
+
+        to_return
+      end
+
+      def impressions_stats(type)
+        @adapter.impressions_data_records.find { |l| l[:type] == type }[:value].value
+      end
+
+      def events_stats(type)
+        @adapter.events_data_records.find { |l| l[:type] == type }[:value].value
+      end
+
+      def last_synchronizations
+        splits = find_last_synchronization(Domain::Constants::SPLIT_SYNC)
+        segments = find_last_synchronization(Domain::Constants::SEGMENT_SYNC)
+        impressions = find_last_synchronization(Domain::Constants::IMPRESSIONS_SYNC)
+        imp_count = find_last_synchronization(Domain::Constants::IMPRESSION_COUNT_SYNC)
+        events = find_last_synchronization(Domain::Constants::EVENT_SYNC)
+        telemetry = find_last_synchronization(Domain::Constants::TELEMETRY_SYNC)
+        token = find_last_synchronization(Domain::Constants::TOKEN_SYNC)
+
+        LastSynchronization.new(splits, segments, impressions, imp_count, events, telemetry, token)
+      end
+
+      def pop_http_errors
+        splits = find_http_errors(Domain::Constants::SPLIT_SYNC)
+        segments = find_http_errors(Domain::Constants::SEGMENT_SYNC)
+        impressions = find_http_errors(Domain::Constants::IMPRESSIONS_SYNC)
+        imp_count = find_http_errors(Domain::Constants::IMPRESSION_COUNT_SYNC)
+        events = find_http_errors(Domain::Constants::EVENT_SYNC)
+        telemetry = find_http_errors(Domain::Constants::TELEMETRY_SYNC)
+        token = find_http_errors(Domain::Constants::TOKEN_SYNC)
+
+        @adapter.init_http_errors
+
+        HttpErrors.new(splits, segments, impressions, imp_count, events, telemetry, token)
+      end
+
+      def pop_http_latencies
+        splits = find_http_latencies(Domain::Constants::SPLIT_SYNC)
+        segments = find_http_latencies(Domain::Constants::SEGMENT_SYNC)
+        impressions = find_http_latencies(Domain::Constants::IMPRESSIONS_SYNC)
+        imp_count = find_http_latencies(Domain::Constants::IMPRESSION_COUNT_SYNC)
+        events = find_http_latencies(Domain::Constants::EVENT_SYNC)
+        telemetry = find_http_latencies(Domain::Constants::TELEMETRY_SYNC)
+        token = find_http_latencies(Domain::Constants::TOKEN_SYNC)
+
+        @adapter.init_http_latencies
+
+        HttpLatencies.new(splits, segments, impressions, imp_count, events, telemetry, token)
+      end
+
+      def pop_auth_rejections
+        to_return = @adapter.auth_rejections
+
+        @adapter.init_auth_rejections
+
+        to_return.value
+      end
+
+      def pop_token_refreshes
+        to_return = @adapter.token_refreshes
+
+        @adapter.init_token_refreshes
+
+        to_return.value
+      end
+
+      def pop_streaming_events
+        events = @adapter.streaming_events
+
+        @adapter.init_streaming_events.map
+
+        events
+      end
+
+      def session_length
+        @adapter.session_length.value
+      end
+
+      def pop_updates_from_sse
+        splits = @adapter.updates_from_sse[Domain::Constants::SPLITS]
+        @adapter.updates_from_sse[Domain::Constants::SPLITS] = 0
+
+        UpdatesFromSSE.new(splits)
+      end
+
+      private
+
+      def find_last_synchronization(type)
+        @adapter.last_synchronization.find { |l| l[:type] == type }[:value].value
+      end
+
+      def find_http_errors(type)
+        @adapter.http_errors.find { |l| l[:type] == type }[:value]
+      end
+
+      def find_http_latencies(type)
+        @adapter.http_latencies.find { |l| l[:type] == type }[:value]
+      end
+    end
+  end
+end

data/lib/splitclient-rb/telemetry/memory/memory_runtime_producer.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Telemetry
+    class MemoryRuntimeProducer
+      def initialize(config)
+        @config = config
+        @adapter = config.telemetry_adapter
+      end
+
+      def add_tag(tag)
+        return if tag.length >= 9
+
+        @adapter.tags << tag
+      end
+
+      def record_impressions_stats(type, count)
+        @adapter.impressions_data_records.find { |l| l[:type] == type }[:value].value += count unless count.zero?
+      rescue StandardError => e
+        @config.log_found_exception(__method__.to_s, e)
+      end
+
+      def record_events_stats(type, count)
+        @adapter.events_data_records.find { |l| l[:type] == type }[:value].value += count unless count.zero?
+      rescue StandardError => e
+        @config.log_found_exception(__method__.to_s, e)
+      end
+
+      def record_successful_sync(type, value = nil)
+        value = (Time.now.to_f * 1000.0).to_i if value.nil?
+
+        @adapter.last_synchronization.find { |l| l[:type] == type }[:value] = Concurrent::AtomicFixnum.new(value)
+      rescue StandardError => e
+        @config.log_found_exception(__method__.to_s, e)
+      end
+
+      def record_sync_error(type, status)
+        http_errors = @adapter.http_errors.find { |l| l[:type] == type }[:value]
+
+        begin
+          http_errors[status] += 1
+        rescue StandardError => _e
+          http_errors[status] = 1
+        end
+      rescue StandardError => e
+        @config.log_found_exception(__method__.to_s, e)
+      end
+
+      def record_sync_latency(type, bucket)
+        @adapter.http_latencies.find { |l| l[:type] == type }[:value][bucket] += 1
+      rescue StandardError => e
+        @config.log_found_exception(__method__.to_s, e)
+      end
+
+      def record_auth_rejections
+        @adapter.auth_rejections.increment
+      rescue StandardError => e
+        @config.log_found_exception(__method__.to_s, e)
+      end
+
+      def record_token_refreshes
+        @adapter.token_refreshes.increment
+      rescue StandardError => e
+        @config.log_found_exception(__method__.to_s, e)
+      end
+
+      def record_streaming_event(type, data = nil, timestamp = nil)
+        timestamp ||= (Time.now.to_f * 1000.0).to_i
+        @adapter.streaming_events << { e: type, d: data, t: timestamp } unless @adapter.streaming_events.length >= 19
+      rescue StandardError => e
+        @config.log_found_exception(__method__.to_s, e)
+      end
+
+      def record_session_length(session)
+        @adapter.session_length.value = session
+      rescue StandardError => e
+        @config.log_found_exception(__method__.to_s, e)
+      end
+
+      def record_updates_from_sse(event)
+        @adapter.updates_from_sse[event] += 1
+      rescue StandardError => e
+        @config.log_found_exception(__method__.to_s, e)
+      end
+    end
+  end
+end