Merge pull request #17 from statsig-io/1-25-0

v1.25.0

Author: kenny-statsig

.github/workflows/build-and-test.yml

@@ -48,6 +48,7 @@ jobs:
 
       - name: Code Coverage Report
         uses: irongut/CodeCoverageSummary@v1.3.0
+        if: ${{ matrix.version }} == 3.2.0
         with:
           filename: coverage/coverage.xml
           badge: true
@@ -61,7 +62,7 @@ jobs:
 
       - name: Add Coverage PR Comment
         uses: marocchino/sticky-pull-request-comment@v2
-        if: github.event_name == 'pull_request'
+        if: github.event_name == 'pull_request' && ${{ matrix.version }} == 3.2.0
         with:
           recreate: true
           path: code-coverage-results.md

.rubocop.yml

@@ -15,4 +15,6 @@ Style/FrozenStringLiteralComment:
 Style/Documentation:
   Enabled: false
 Style/IfUnlessModifier:
+  Enabled: false
+Style/ConditionalAssignment:
   Enabled: false

lib/evaluator.rb

@@ -6,7 +6,7 @@
 require 'client_initialize_helpers'
 require 'spec_store'
 require 'time'
-require 'user_agent_parser'
+require 'ua_parser'
 require 'evaluation_details'
 require 'user_agent_parser/operating_system'
 
@@ -19,8 +19,8 @@ class Evaluator
 
     def initialize(network, options, error_callback, init_diagnostics = nil)
       @spec_store = Statsig::SpecStore.new(network, options, error_callback, init_diagnostics)
-      @ua_parser = UserAgentParser::Parser.new
-      CountryLookup.initialize
+      UAParser.initialize_async
+      CountryLookup.initialize_async
 
       @gate_overrides = {}
       @config_overrides = {}
@@ -449,16 +449,16 @@ def get_value_from_ua(user, field)
 
       case field.downcase
       when 'os_name', 'osname'
-        os = @ua_parser.parse_os(ua)
+        os = UAParser.parse_os(ua)
         return os&.family
       when 'os_version', 'osversion'
-        os = @ua_parser.parse_os(ua)
+        os = UAParser.parse_os(ua)
         return os&.version unless os&.version.nil?
       when 'browser_name', 'browsername'
-        parsed = @ua_parser.parse_ua(ua)
+        parsed = UAParser.parse_ua(ua)
         return parsed.family
       when 'browser_version', 'browserversion'
-        parsed = @ua_parser.parse_ua(ua)
+        parsed = UAParser.parse_ua(ua)
         return parsed.version.to_s
       else
         nil

lib/network.rb

@@ -33,6 +33,7 @@ def initialize(server_secret, options, backoff_mult = 10)
       @local_mode = options.local_mode
       @timeout = options.network_timeout
       @backoff_multiplier = backoff_mult
+      @post_logs_retry_backoff = options.post_logs_retry_backoff
       @post_logs_retry_limit = options.post_logs_retry_limit
       @session_id = SecureRandom.uuid
     end
@@ -59,6 +60,13 @@ def post_helper(endpoint, body, retries = 0, backoff = 1)
         http = http.timeout(@timeout)
       end
       backoff_adjusted = backoff > 10 ? backoff += Random.rand(10) : backoff # to deter overlap
+      if @post_logs_retry_backoff
+        if @post_logs_retry_backoff.is_a? Integer
+          backoff_adjusted = @post_logs_retry_backoff
+        else
+          backoff_adjusted = @post_logs_retry_backoff.call(retries)
+        end
+      end
       begin
         res = http.post(@api + endpoint, body: body)
       rescue StandardError => e

lib/spec_store.rb

@@ -32,6 +32,7 @@ def initialize(network, options, error_callback, init_diagnostics = nil)
 
       @id_list_thread_pool = Concurrent::FixedThreadPool.new(
         options.idlist_threadpool_size,
+        name: 'statsig-idlist',
         max_queue: 100,
         fallback_policy: :discard,
       )
@@ -309,6 +310,16 @@ def process_id_lists(new_id_lists, init_diagnostics, from_adapter: false)
 
       init_diagnostics&.mark("get_id_lists", "start", "process", new_id_lists.length)
 
+      delete_lists = []
+      local_id_lists.each do |list_name, list|
+        unless new_id_lists.key? list_name
+          delete_lists.push list_name
+        end
+      end
+      delete_lists.each do |list_name|
+        local_id_lists.delete list_name
+      end
+
       new_id_lists.each do |list_name, list|
         new_list = IDList.new(list)
         local_list = get_id_list(list_name)
@@ -346,21 +357,7 @@ def process_id_lists(new_id_lists, init_diagnostics, from_adapter: false)
       end
 
       result = Concurrent::Promise.all?(*tasks).execute.wait(@id_lists_sync_interval)
-      if result.state != :fulfilled
-        init_diagnostics&.mark("get_id_lists", "end", "process", false)
-        return # timed out
-      end
-
-      delete_lists = []
-      local_id_lists.each do |list_name, list|
-        unless new_id_lists.key? list_name
-          delete_lists.push list_name
-        end
-      end
-      delete_lists.each do |list_name|
-        local_id_lists.delete list_name
-      end
-      init_diagnostics&.mark("get_id_lists", "end", "process", true)
+      init_diagnostics&.mark("get_id_lists", "end", "process", result.state == :fulfilled)
     end
 
     def get_single_id_list_from_adapter(list)

lib/statsig_logger.rb

@@ -15,10 +15,11 @@ def initialize(network, options)
       @options = options
 
       @logging_pool = Concurrent::ThreadPoolExecutor.new(
-        min_threads: [2, Concurrent.processor_count].min,
-        max_threads: [5, Concurrent.processor_count].min,
+        name: 'statsig-logger',
+        min_threads: @options.logger_threadpool_size,
+        max_threads: @options.logger_threadpool_size,
         # max jobs pending before we start dropping
-        max_queue: [5, Concurrent.processor_count].min * 5,
+        max_queue: 100,
         fallback_policy: :discard
       )
 
@@ -106,7 +107,7 @@ def periodic_flush
       Thread.new do
         loop do
           sleep @options.logging_interval_seconds
-          flush
+          flush_async
           @interval += 1
           @deduper.clear if @interval % 2 == 0
         end

lib/statsig_options.rb

@@ -64,6 +64,11 @@ class StatsigOptions
   # default: 3
   attr_accessor :idlist_threadpool_size
 
+  sig { returns(Integer) }
+  # The number of threads allocated to posting event logs.
+  # default: 3
+  attr_accessor :logger_threadpool_size
+
   sig { returns(T::Boolean) }
   # Should diagnostics be logged. These include performance metrics for initialize.
   # default: false
@@ -83,6 +88,11 @@ class StatsigOptions
   # Number of times to retry sending a batch of failed log events
   attr_accessor :post_logs_retry_limit
 
+  sig { returns(T.any(Method, Proc, Integer, NilClass)) }
+  # The number of seconds, or a function that returns the number of seconds based on the number of retries remaining
+  # which overrides the default backoff time between retries
+  attr_accessor :post_logs_retry_backoff
+
   sig do
     params(
       environment: T.any(T::Hash[String, String], NilClass),
@@ -96,10 +106,12 @@ class StatsigOptions
       rules_updated_callback: T.any(Method, Proc, NilClass),
       data_store: T.any(Statsig::Interfaces::IDataStore, NilClass),
       idlist_threadpool_size: Integer,
+      logger_threadpool_size: Integer,
       disable_diagnostics_logging: T::Boolean,
       disable_sorbet_logging_handlers: T::Boolean,
       network_timeout: T.any(Integer, NilClass),
-      post_logs_retry_limit: Integer
+      post_logs_retry_limit: Integer,
+      post_logs_retry_backoff: T.any(Method, Proc, Integer, NilClass)
     ).void
   end
 
@@ -115,10 +127,12 @@ def initialize(
     rules_updated_callback: nil,
     data_store: nil,
     idlist_threadpool_size: 3,
+    logger_threadpool_size: 3,
     disable_diagnostics_logging: false,
     disable_sorbet_logging_handlers: false,
     network_timeout: nil,
-    post_logs_retry_limit: 3)
+    post_logs_retry_limit: 3,
+    post_logs_retry_backoff: nil)
     @environment = environment.is_a?(Hash) ? environment : nil
     @api_url_base = api_url_base
     @rulesets_sync_interval = rulesets_sync_interval
@@ -130,9 +144,11 @@ def initialize(
     @rules_updated_callback = rules_updated_callback
     @data_store = data_store
     @idlist_threadpool_size = idlist_threadpool_size
+    @logger_threadpool_size = logger_threadpool_size
     @disable_diagnostics_logging = disable_diagnostics_logging
     @disable_sorbet_logging_handlers = disable_sorbet_logging_handlers
     @network_timeout = network_timeout
     @post_logs_retry_limit = post_logs_retry_limit
+    @post_logs_retry_backoff = post_logs_retry_backoff
   end
 end

lib/ua_parser.rb

@@ -0,0 +1,57 @@
+require 'user_agent_parser'
+
+module UAParser
+  class Parser
+    def initialize
+      @ua_parser = UserAgentParser::Parser.new
+    end
+
+    def parse_os(*args)
+      @ua_parser.parse_os(*args)
+    end
+
+    def parse_ua(*args)
+      @ua_parser.parse_ua(*args)
+    end
+
+    def parse_device(*args)
+      @ua_parser.parse_device(*args)
+    end
+  end
+
+  def self.initialize
+    if !@initialize_bg_thread.nil? && @initialize_bg_thread.alive?
+      @initialize_bg_thread.kill.join
+    end
+    @parser = Parser.new
+  end
+
+  def self.initialize_async
+    if !@initialize_bg_thread.nil? && @initialize_bg_thread.alive?
+      @initialize_bg_thread.kill.join
+    end
+    @initialize_bg_thread = Thread.new { @parser = Parser.new }
+    @initialize_bg_thread
+  end
+
+  def self.parse_os(*args)
+    if @parser.nil?
+      initialize
+    end
+    @parser.parse_os(*args)
+  end
+
+  def self.parse_ua(*args)
+    if @parser.nil?
+      initialize
+    end
+    @parser.parse_ua(*args)
+  end
+
+  def self.parse_device(*args)
+    if @parser.nil?
+      initialize
+    end
+    @parser.parse_device(*args)
+  end
+end

statsig.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'statsig'
-  s.version     = '1.24.6'
+  s.version     = '1.25.0'
   s.summary     = 'Statsig server SDK for Ruby'
   s.description = 'Statsig server SDK for feature gates and experimentation in Ruby'
   s.authors     = ['Statsig, Inc']
@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'simplecov-cobertura', '~> 2.1'
   s.add_runtime_dependency 'user_agent_parser', '~> 2.15.0'
   s.add_runtime_dependency 'http', '>= 4.4', '< 6.0'
-  s.add_runtime_dependency 'ip3country', '0.1.1'
+  s.add_runtime_dependency 'ip3country', '~> 0.2.1'
   s.add_runtime_dependency 'sorbet-runtime', '~> 0.5.10461'
   s.add_runtime_dependency 'concurrent-ruby', '~> 1.1'
 end

test/data_adapter_test.rb

@@ -43,7 +43,7 @@ def test_datastore_overwritten_by_network
     options.data_store = DummyDataAdapter.new
     driver = StatsigDriver.new('secret-testcase', options)
 
-    sleep 2
+    sleep 1.1
 
     adapter_specs = options.data_store&.get(Statsig::Interfaces::IDataStore::CONFIG_SPECS_KEY)
     specs_json = JSON.parse(adapter_specs)
@@ -98,7 +98,7 @@ def test_datastore_used_for_polling
     options.data_store.remove_feature_gate("gate_from_adapter")
     options.data_store.update_id_lists
 
-    sleep 1
+    sleep 1.1
 
     result = driver.check_gate(@user, "gate_from_adapter")
     assert(result == false)
@@ -122,7 +122,7 @@ def test_datastore_fallback_to_network
 
     options.data_store.corrupt_store
 
-    sleep 1
+    sleep 1.1
 
     result = driver.check_gate(@user, "gate_from_adapter")
     assert(result == false)