Merge pull request #14 from statsig-io/1-24-6

v1.24.6

Author: kenny-statsig

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

@@ -8,6 +8,10 @@ on:
   schedule:
     - cron: '0 0,15 * * *'
 
+env:
+  COVERAGE: true
+  COVERAGE_FORMAT: 'cobertura'
+
 jobs:
   test:
     runs-on: ubuntu-latest
@@ -22,7 +26,9 @@ jobs:
           ruby-version: ${{ matrix.version }}
 
       - name: Install dependencies
-        run: bundle install
+        run: |
+          bundle config set --local without 'rubocop'
+          bundle install
 
       # If you add a new dependency, be sure to run `bundle exec srb rbi update`
       - name: Typecheck
@@ -33,3 +39,29 @@ jobs:
         env:
           test_api_key: ${{ secrets.SDK_CONSISTENCY_TEST_COMPANY_API_KEY }}
           test_client_key: ${{ secrets.KONG_CLIENT_SDK_KEY }}
+
+      - name: Run tests in parallel
+        run: bundle exec rake parallel:test
+        env:
+          test_api_key: ${{ secrets.SDK_CONSISTENCY_TEST_COMPANY_API_KEY }}
+          test_client_key: ${{ secrets.KONG_CLIENT_SDK_KEY }}
+
+      - name: Code Coverage Report
+        uses: irongut/CodeCoverageSummary@v1.3.0
+        with:
+          filename: coverage/coverage.xml
+          badge: true
+          fail_below_min: true
+          format: markdown
+          hide_branch_rate: false
+          hide_complexity: true
+          indicators: true
+          output: both
+          thresholds: '80 90'
+
+      - name: Add Coverage PR Comment
+        uses: marocchino/sticky-pull-request-comment@v2
+        if: github.event_name == 'pull_request'
+        with:
+          recreate: true
+          path: code-coverage-results.md

.rubocop.yml

@@ -0,0 +1,18 @@
+Metrics/ClassLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false

Rakefile

@@ -1,9 +1,10 @@
 require 'rake/testtask'
+require 'parallel_tests/tasks'
 
 desc 'Run unit tests'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
   t.libs << 'test'
-  t.test_files = FileList['test/**/*.rb'].exclude('test/mock_server.rb')
+  t.test_files = FileList['test/**/*.rb'].exclude('test/mock_server.rb', 'test/dummy_data_adapter.rb')
   t.verbose = true
-end
+end

config/database.yml

@@ -0,0 +1,2 @@
+test:
+  database: statsig_test<%= ENV['TEST_ENV_NUMBER'] %>

lib/evaluator.rb

@@ -447,16 +447,18 @@ def get_value_from_ua(user, field)
       ua = get_value_from_user(user, 'userAgent')
       return nil unless ua.is_a?(String)
 
-      parsed = @ua_parser.parse ua
-      os = parsed.os
       case field.downcase
       when 'os_name', 'osname'
+        os = @ua_parser.parse_os(ua)
         return os&.family
       when 'os_version', 'osversion'
+        os = @ua_parser.parse_os(ua)
         return os&.version unless os&.version.nil?
       when 'browser_name', 'browsername'
+        parsed = @ua_parser.parse_ua(ua)
         return parsed.family
       when 'browser_version', 'browserversion'
+        parsed = @ua_parser.parse_ua(ua)
         return parsed.version.to_s
       else
         nil

lib/layer.rb

@@ -1,5 +1,6 @@
 # typed: false
 
+require 'sorbet-runtime'
 ##
 # Contains the current values from Statsig.
 # Will contain layer default values for all shared parameters in that layer.

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_limit = options.post_logs_retry_limit
       @session_id = SecureRandom.uuid
     end
 
@@ -57,18 +58,19 @@ def post_helper(endpoint, body, retries = 0, backoff = 1)
       if @timeout
         http = http.timeout(@timeout)
       end
+      backoff_adjusted = backoff > 10 ? backoff += Random.rand(10) : backoff # to deter overlap
       begin
         res = http.post(@api + endpoint, body: body)
       rescue StandardError => e
         ## network error retry
         return nil, e unless retries > 0
-        sleep backoff
+        sleep backoff_adjusted
         return post_helper(endpoint, body, retries - 1, backoff * @backoff_multiplier)
       end
       return res, nil if res.status.success?
       return nil, NetworkError.new("Got an exception when making request to #{@api + endpoint}: #{res.to_s}", res.status.to_i) unless retries > 0 && $retry_codes.include?(res.code)
       ## status code retry
-      sleep backoff
+      sleep backoff_adjusted
       post_helper(endpoint, body, retries - 1, backoff * @backoff_multiplier)
     end
 
@@ -97,7 +99,7 @@ def get_config(user, dynamic_config_name)
     def post_logs(events)
       begin
         json_body = JSON.generate({ 'events' => events, 'statsigMetadata' => Statsig.get_statsig_metadata })
-        post_helper('log_event', json_body, 5)
+        post_helper('log_event', json_body, @post_logs_retry_limit)
       rescue
       end
     end

lib/statsig.rb

@@ -148,7 +148,7 @@ def self.get_layer_with_exposure_logging_disabled(user, layer_name)
     @shared_instance&.get_layer(user, layer_name, StatsigDriver::GetLayerOptions.new(log_exposure: false))
   end
 
-  sig { params(user: StatsigUser, layer_name: String, parameter_name: String).returns(Layer) }
+  sig { params(user: StatsigUser, layer_name: String, parameter_name: String).void }
   ##
   # Logs an exposure event for the parameter in the given layer
   #
@@ -227,7 +227,7 @@ def self.get_client_initialize_response(user)
   def self.get_statsig_metadata
     {
       'sdkType' => 'ruby-server',
-      'sdkVersion' => '1.24.5',
+      'sdkVersion' => '1.24.6',
     }
   end
 

lib/statsig_driver.rb

@@ -170,7 +170,6 @@ def log_event(user, event_name, value = nil, metadata = nil)
       event.user = user
       event.value = value
       event.metadata = metadata
-      event.statsig_metadata = Statsig.get_statsig_metadata
       @logger.log_event(event)
     })
   end
@@ -199,6 +198,7 @@ def override_config(config_name, config_value)
   # @return [Hash]
   def get_client_initialize_response(user)
     @err_boundary.capture(-> {
+      validate_user(user)
       normalize_user(user)
       @evaluator.get_client_initialize_response(user)
     }, -> { nil })

lib/statsig_event.rb

@@ -1,9 +1,6 @@
 # typed: true
 class StatsigEvent
-  attr_accessor :value
-  attr_accessor :metadata
-  attr_accessor :statsig_metadata
-  attr_accessor :secondary_exposures
+  attr_accessor :value, :metadata, :statsig_metadata, :secondary_exposures
   attr_reader :user
 
   def initialize(event_name)
@@ -13,6 +10,7 @@ def initialize(event_name)
     @secondary_exposures = nil
     @user = nil
     @time = (Time.now.to_f * 1000).to_i
+    @statsig_metadata = Statsig.get_statsig_metadata
   end
 
   def user=(value)