statsig 2.1.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd554df4ba15f0d1addaecc5e76502c1218c1b08842152eeeffd0f6e121dbcba
-  data.tar.gz: b1d19d91608685488db9705e213559c4a36c21731b0822137b55fab0693a871d
+  metadata.gz: 7b9e465d382f7e7e2a4640eaf549bc3e882b0aac3c2333c9874fc6855a6af1cc
+  data.tar.gz: 844845547c6b1914908e38438dc932486e3ea5740ef32c3b59eb1cc67a4274ed
 SHA512:
-  metadata.gz: b360f7fb18b06e87b538eb005ce0f7344f8a633a1cb9915d3e6f74e5b0fab3b7d87d46ab4b4498548e66766d00a4f60a9bb5f502c270e09925e67c24575da7ca
-  data.tar.gz: 337e0fd5ecfc11fa5565980df91d21ee17cc6586d49f1a18b333eaa4de1da29094c453a00daf1671ce8e6872d03882b85c169df6709aa41e543500cdc5c78057
+  metadata.gz: a61ad75521667fd2dc1d1a2df7f653e770b0ce111b66302c16302d4b59394719ac2f3617968adb4dce303bbd3791ecd7aa3da7698ad9cf448dc522bc3564ac00
+  data.tar.gz: 79a119ba9af5c7c2da630ce9501596dc0e230adeff7e8c022b5904e7c2e5e5475efc3a1ee968d23be105940e4ab60e3da1154d3ce1ec8e9dd8ef2547f9be1a84

data/lib/config_result.rb

@@ -16,6 +16,7 @@ module Statsig
     attr_accessor :target_app_ids
     attr_accessor :disable_evaluation_details
     attr_accessor :disable_exposures
+    attr_accessor :config_version
 
     def initialize(
       name:,
@@ -31,7 +32,8 @@ module Statsig
       id_type: nil,
       target_app_ids: nil,
       disable_evaluation_details: false,
-      disable_exposures: false
+      disable_exposures: false,
+      config_version: nil
     )
       @name = name
       @gate_value = gate_value
@@ -48,6 +50,7 @@ module Statsig
       @target_app_ids = target_app_ids
       @disable_evaluation_details = disable_evaluation_details
       @disable_exposures = disable_exposures
+      @config_version = config_version
     end
 
     def self.from_user_persisted_values(config_name, user_persisted_values)

data/lib/evaluator.rb

@@ -324,7 +324,11 @@ module Statsig
     def finalize_eval_result(config, end_result, did_pass:, rule:, is_nested: false)
       end_result.id_type = config[:idType]
       end_result.target_app_ids = config[:targetAppIDs]
-      end_result.gate_value = did_pass ? rule[:returnValue] == true : config[:defaultValue] == true
+      end_result.gate_value = did_pass
+      if config[:entity] == Const::TYPE_FEATURE_GATE
+        end_result.gate_value = did_pass ? rule[:returnValue] == true : config[:defaultValue] == true
+      end
+      end_result.config_version = config[:version]
 
       if rule.nil?
         end_result.json_value = config[:defaultValue]
@@ -691,7 +695,7 @@ module Statsig
       pass_percentage = rule[:passPercentage]
       return true if pass_percentage == 100.0
       return false if pass_percentage == 0.0
-    
+
       unit_id = user.get_unit_id(rule[:idType]) || Const::EMPTY_STR
       rule_salt = rule[:salt] || rule[:id] || Const::EMPTY_STR
       hash = compute_user_hash("#{config_salt}.#{rule_salt}.#{unit_id}")

data/lib/spec_store.rb

@@ -44,6 +44,8 @@ module Statsig
       @secret_key = secret_key
       @unsupported_configs = Set.new
 
+      startTime = (Time.now.to_f * 1000).to_i
+
       @id_list_thread_pool = Concurrent::FixedThreadPool.new(
         options.idlist_threadpool_size,
         name: 'statsig-idlist',
@@ -57,7 +59,7 @@ module Statsig
         else
           tracker = @diagnostics.track('initialize','bootstrap', 'process')
           begin
-            if process_specs(options.bootstrap_values)
+            if process_specs(options.bootstrap_values).nil?
               @init_reason = EvaluationReason::BOOTSTRAP
             end
           rescue StandardError
@@ -68,13 +70,15 @@ module Statsig
         end
       end
 
+      failure_details = nil
+
       unless @options.data_store.nil?
         @options.data_store.init
-        load_config_specs_from_storage_adapter('initialize')
+        failure_details = load_config_specs_from_storage_adapter('initialize')
       end
 
       if @init_reason == EvaluationReason::UNINITIALIZED
-        download_config_specs('initialize')
+        failure_details = download_config_specs('initialize')
       end
 
       @initial_config_sync_time = @last_config_sync_time == 0 ? -1 : @last_config_sync_time
@@ -86,12 +90,18 @@ module Statsig
 
       @config_sync_thread = spawn_sync_config_specs_thread
       @id_lists_sync_thread = spawn_sync_id_lists_thread
+      endTime = (Time.now.to_f * 1000).to_i
+      @initialization_details = {duration: endTime - startTime, isSDKReady: true, configSpecReady: @init_reason != EvaluationReason::UNINITIALIZED, failureDetails: failure_details}
     end
 
     def is_ready_for_checks
       @last_config_sync_time != 0
     end
 
+    def get_initialization_details
+      @initialization_details
+    end
+
     def shutdown
       @config_sync_thread&.exit
       @id_lists_sync_thread&.exit
@@ -202,13 +212,19 @@ module Statsig
       return if cached_values.nil?
 
       tracker = @diagnostics.track(context, 'data_store_config_specs', 'process')
-      process_specs(cached_values, from_adapter: true)
-      @init_reason = EvaluationReason::DATA_ADAPTER
-      tracker.end(success: true)
+      failure_details = process_specs(cached_values, from_adapter: true)
+      if failure_details.nil?
+        @init_reason = EvaluationReason::DATA_ADAPTER
+        tracker.end(success: true)
+      else
+        tracker.end(success: false)
+        return download_config_specs(context)
+      end
+      return failure_details
     rescue StandardError
       # Fallback to network
       tracker.end(success: false)
-      download_config_specs(context)
+      return download_config_specs(context)
     end
 
     def save_rulesets_to_storage_adapter(rulesets_string)
@@ -253,18 +269,21 @@ module Statsig
       tracker = @diagnostics.track(context, 'download_config_specs', 'network_request')
 
       error = nil
+      failure_details = nil
       begin
         response, e = @network.download_config_specs(@last_config_sync_time)
         code = response&.status.to_i
         if e.is_a? NetworkError
           code = e.http_code
+          failure_details = {statusCode: code, exception: e, reason: "CONFIG_SPECS_NETWORK_ERROR"}
         end
         tracker.end(statusCode: code, success: e.nil?, sdkRegion: response&.headers&.[]('X-Statsig-Region'))
 
         if e.nil?
           unless response.nil?
             tracker = @diagnostics.track(context, 'download_config_specs', 'process')
-            if process_specs(response.body.to_s)
+            failure_details = process_specs(response.body.to_s)
+            if failure_details.nil?
               @init_reason = EvaluationReason::NETWORK
             end
             tracker.end(success: @init_reason == EvaluationReason::NETWORK)
@@ -274,59 +293,63 @@ module Statsig
                                            @last_config_sync_time)
             end
           end
-
-          nil
         else
           error = e
         end
       rescue StandardError => e
+        failure_details = {exception: e, reason: "INTERNAL_ERROR"}
         error = e
       end
 
       @error_callback.call(error) unless error.nil? or @error_callback.nil?
+      return failure_details
     end
 
     def process_specs(specs_string, from_adapter: false)
       if specs_string.nil?
-        return false
+        return {reason: "EMPTY_SPEC"}
       end
 
-      specs_json = JSON.parse(specs_string, { symbolize_names: true })
-      return false unless specs_json.is_a? Hash
+      begin
+        specs_json = JSON.parse(specs_string, { symbolize_names: true })
+        return {reason: "PARSE_RESPONSE_ERROR"} unless specs_json.is_a? Hash
 
-      hashed_sdk_key_used = specs_json[:hashed_sdk_key_used]
-      unless hashed_sdk_key_used.nil? or hashed_sdk_key_used == Statsig::HashUtils.djb2(@secret_key)
-        err_boundary.log_exception(Statsig::InvalidSDKKeyResponse.new)
-        return false
-      end
+        hashed_sdk_key_used = specs_json[:hashed_sdk_key_used]
+        unless hashed_sdk_key_used.nil? or hashed_sdk_key_used == Statsig::HashUtils.djb2(@secret_key)
+          err_boundary.log_exception(Statsig::InvalidSDKKeyResponse.new)
+          return {reason: "PARSE_RESPONSE_ERROR"}
+        end
 
-      new_specs_sync_time = specs_json[:time]
-      if new_specs_sync_time.nil? \
-        || new_specs_sync_time < @last_config_sync_time \
-        || specs_json[:has_updates] != true \
-        || specs_json[:feature_gates].nil? \
-        || specs_json[:dynamic_configs].nil? \
-        || specs_json[:layer_configs].nil?
-        return false
-      end
+        new_specs_sync_time = specs_json[:time]
+        if new_specs_sync_time.nil? \
+          || new_specs_sync_time < @last_config_sync_time \
+          || specs_json[:has_updates] != true \
+          || specs_json[:feature_gates].nil? \
+          || specs_json[:dynamic_configs].nil? \
+          || specs_json[:layer_configs].nil?
+          return {reason: "PARSE_RESPONSE_ERROR"}
+        end
 
-      @last_config_sync_time = new_specs_sync_time
-      @unsupported_configs.clear
+        @last_config_sync_time = new_specs_sync_time
+        @unsupported_configs.clear
 
-      specs_json[:diagnostics]&.each { |key, value| @diagnostics.sample_rates[key.to_s] = value }
+        specs_json[:diagnostics]&.each { |key, value| @diagnostics.sample_rates[key.to_s] = value }
 
-      @gates = specs_json[:feature_gates]
-      @configs = specs_json[:dynamic_configs]
-      @layers = specs_json[:layer_configs]
-      @condition_map = specs_json[:condition_map]
-      @experiment_to_layer = specs_json[:experiment_to_layer]
-      @sdk_keys_to_app_ids = specs_json[:sdk_keys_to_app_ids] || {}
-      @hashed_sdk_keys_to_app_ids = specs_json[:hashed_sdk_keys_to_app_ids] || {}
+        @gates = specs_json[:feature_gates]
+        @configs = specs_json[:dynamic_configs]
+        @layers = specs_json[:layer_configs]
+        @condition_map = specs_json[:condition_map]
+        @experiment_to_layer = specs_json[:experiment_to_layer]
+        @sdk_keys_to_app_ids = specs_json[:sdk_keys_to_app_ids] || {}
+        @hashed_sdk_keys_to_app_ids = specs_json[:hashed_sdk_keys_to_app_ids] || {}
 
-      unless from_adapter
-        save_rulesets_to_storage_adapter(specs_string)
+        unless from_adapter
+          save_rulesets_to_storage_adapter(specs_string)
+        end
+      rescue StandardError => e
+        return {reason: "PARSE_RESPONSE_ERROR"}
       end
-      true
+      nil
     end
 
     def get_id_lists_from_adapter(context)

data/lib/statsig.rb

@@ -20,6 +20,13 @@ module Statsig
     @shared_instance = StatsigDriver.new(secret_key, options, error_callback)
   end
 
+  def self.get_initialization_details
+    if not defined? @shared_instance or @shared_instance.nil?
+      return {duration: 0, isSDKReady: false, configSpecReady: false, failure_details: {exception: Statsig::UninitializedError.new, reason: 'INTERNAL_ERROR'}}
+    end
+    @shared_instance.get_initialization_details
+  end
+
   class GetGateOptions
     attr_accessor :disable_log_exposure, :skip_evaluation, :disable_evaluation_details
 
@@ -65,7 +72,7 @@ module Statsig
   end
 
   ##
-  # @deprecated - use check_gate(user, gate, options) and disable_exposure_logging in options
+  # @deprecated - use check_gate(user, gate, options) with CheckGateOptions.new(disable_log_exposure: true) as options
   # Gets the boolean result of a gate, evaluated against the given user.
   #
   # @param user A StatsigUser object used for the evaluation
@@ -108,7 +115,7 @@ module Statsig
   end
 
   ##
-  # @deprecated - use get_config(user, config, options) and disable_exposure_logging in options
+  # @deprecated - use get_config(user, config, options) with GetConfigOptions.new(disable_log_exposure: true) as options
   # Get the values of a dynamic config, evaluated against the given user.
   #
   # @param [StatsigUser] user A StatsigUser object used for the evaluation
@@ -152,7 +159,7 @@ module Statsig
   end
 
   ##
-  # @deprecated - use get_experiment(user, experiment, options) and disable_exposure_logging in options
+  # @deprecated - use get_experiment(user, experiment, options) with GetExperimentOptions.new(disable_log_exposure: true) as options
   # Get the values of an experiment, evaluated against the given user.
   #
   # @param [StatsigUser] user A StatsigUser object used for the evaluation
@@ -199,7 +206,7 @@ module Statsig
   end
 
   ##
-  # @deprecated - use get_layer(user, gate, options) and disable_exposure_logging in options
+  # @deprecated - use get_layer(user, gate, options) with GetLayerOptions.new(disable_log_exposure: true) as options
   # Get the values of a layer, evaluated against the given user.
   #
   # @param user A StatsigUser object used for the evaluation
@@ -363,7 +370,7 @@ module Statsig
   def self.get_statsig_metadata
     {
       'sdkType' => 'ruby-server',
-      'sdkVersion' => '2.1.0',
+      'sdkVersion' => '2.2.1',
       'languageVersion' => RUBY_VERSION
     }
   end

data/lib/statsig_driver.rb

@@ -43,6 +43,10 @@ class StatsigDriver
     end
   end
 
+  def get_initialization_details
+    @store.get_initialization_details
+  end
+
   def get_gate_impl(
     user,
     gate_name,
@@ -68,9 +72,7 @@ class StatsigDriver
       @evaluator.check_gate(user, gate_name, res, ignore_local_overrides: ignore_local_overrides)
 
       unless disable_log_exposure
-        @logger.log_gate_exposure(
-          user, res.name, res.gate_value, res.rule_id, res.secondary_exposures, res.evaluation_details
-        )
+        @logger.log_gate_exposure(user, res)
       end
 
       FeatureGate.from_config_result(res)
@@ -109,7 +111,7 @@ class StatsigDriver
       res = Statsig::ConfigResult.new(name: gate_name)
       @evaluator.check_gate(user, gate_name, res)
       context = { :is_manual_exposure => true }
-      @logger.log_gate_exposure(user, gate_name, res.gate_value, res.rule_id, res.secondary_exposures, res.evaluation_details, context)
+      @logger.log_gate_exposure(user, res, context)
     end
   end
 
@@ -150,7 +152,7 @@ class StatsigDriver
       @evaluator.get_config(user, config_name, res)
 
       context = { :is_manual_exposure => true }
-      @logger.log_config_exposure(user, res.name, res.rule_id, res.secondary_exposures, res.evaluation_details, context)
+      @logger.log_config_exposure(user, res, context)
     end
   end
 
@@ -381,7 +383,7 @@ class StatsigDriver
       @evaluator.get_config(user, config_name, res, user_persisted_values: user_persisted_values, ignore_local_overrides: ignore_local_overrides)
 
       unless disable_log_exposure
-        @logger.log_config_exposure(user, res.name, res.rule_id, res.secondary_exposures, res.evaluation_details)
+        @logger.log_config_exposure(user, res)
       end
 
       DynamicConfig.new(res.name, res.json_value, res.rule_id, res.group_name, res.id_type, res.evaluation_details)

data/lib/statsig_logger.rb

@@ -38,42 +38,49 @@ module Statsig
       end
     end
 
-    def log_gate_exposure(user, gate_name, value, rule_id, secondary_exposures, eval_details, context = nil)
+    def log_gate_exposure(user, result, context = nil)
       event = StatsigEvent.new($gate_exposure_event)
       event.user = user
       metadata = {
-        gate: gate_name,
-        gateValue: value.to_s,
-        ruleID: rule_id || Statsig::Const::EMPTY_STR,
+        gate: result.name,
+        gateValue: result.gate_value.to_s,
+        ruleID: result.rule_id || Statsig::Const::EMPTY_STR,
       }
+      if result.config_version != nil
+        metadata[:configVersion] = result.config_version.to_s
+      end
       if @debug_info != nil
         metadata[:debugInfo] = @debug_info
       end
       return false if not is_unique_exposure(user, $gate_exposure_event, metadata)
       event.metadata = metadata
 
-      event.secondary_exposures = secondary_exposures.is_a?(Array) ? secondary_exposures : []
+      event.secondary_exposures = result.secondary_exposures.is_a?(Array) ? result.secondary_exposures : []
 
-      safe_add_eval_details(eval_details, event)
+      safe_add_eval_details(result.evaluation_details, event)
       safe_add_exposure_context(context, event)
       log_event(event)
     end
 
-    def log_config_exposure(user, config_name, rule_id, secondary_exposures, eval_details, context = nil)
+    def log_config_exposure(user, result, context = nil)
       event = StatsigEvent.new($config_exposure_event)
       event.user = user
       metadata = {
-        config: config_name,
-        ruleID: rule_id || Statsig::Const::EMPTY_STR,
+        config: result.name,
+        ruleID: result.rule_id || Statsig::Const::EMPTY_STR,
+        rulePassed: result.gate_value.to_s,
       }
+      if result.config_version != nil
+        metadata[:configVersion] = result.config_version.to_s
+      end
       if @debug_info != nil
         metadata[:debugInfo] = @debug_info
       end
       return false if not is_unique_exposure(user, $config_exposure_event, metadata)
       event.metadata = metadata
-      event.secondary_exposures = secondary_exposures.is_a?(Array) ? secondary_exposures : []
+      event.secondary_exposures = result.secondary_exposures.is_a?(Array) ? result.secondary_exposures : []
 
-      safe_add_eval_details(eval_details, event)
+      safe_add_eval_details(result.evaluation_details, event)
       safe_add_exposure_context(context, event)
       log_event(event)
     end
@@ -96,6 +103,9 @@ module Statsig
         parameterName: parameter_name,
         isExplicitParameter: String(is_explicit)
       }
+      if config_evaluation.config_version != nil
+        metadata[:configVersion] = config_evaluation.config_version.to_s
+      end
       if @debug_info != nil
         metadata[:debugInfo] = @debug_info
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statsig
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Statsig, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-26 00:00:00.000000000 Z
+date: 2024-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler