statsig 1.32.0 → 1.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd71ed81ad0f3658f5b6b480adba4a36f560357c67d6d9869b605e2d0e1e76c0
-  data.tar.gz: 59b7da08c4991da0e7b33dc08865612347442970932e71b8069bcd4518d50680
+  metadata.gz: 56f4bfc568fa70750a5dc1376ffffacd1163344c63750492e0e0ff841fd73d18
+  data.tar.gz: 6e41d012096437a58a9ceea49c0aa5d71532d06d273b37593afcd7cb9bc07297
 SHA512:
-  metadata.gz: 3775510747a856d9ae300ccad20a74de3cbe000bc3bca59c535c64cbab1bcb46a83069aa917299ee6dd7032f44206eecd39f3602c92f18c39a8ebbb57b45d9e9
-  data.tar.gz: e0a03db37029a260614a6eb8bf9edf1e2fe60f84d67fb9e027bf5fd72c3c4f969a7ab3145f55d0bd19f796b7d1733416547688e1076c69e066abd819c99b899c
+  metadata.gz: 7060859db57bed3e98e372c1b3808f53802bb1c7e4e76f70b366e138c022d1aef522605457d8e69f8eb029394c8bb8c32e1aa1eb0933d4fcd8746f60452afac3
+  data.tar.gz: a0857b56731a9fab6d53748700a932fc3d6a3c7b065dd8ce54d03bf89274002f215e6ae39fa0b72d49c60cb4c7cc11307f7e4d3b1f965f7f4f5a721545712978

data/lib/client_initialize_helpers.rb

@@ -4,10 +4,18 @@ require 'constants'
 
 module Statsig
   class ResponseFormatter
-    def self.get_responses(entities, evaluator, user, client_sdk_key, hash_algo, include_exposures: true)
+    def self.get_responses(
+      entities,
+      evaluator,
+      user,
+      client_sdk_key,
+      hash_algo,
+      include_exposures: true,
+      include_local_overrides: false
+    )
       result = {}
       entities.each do |name, spec|
-        hashed_name, value = to_response(name, spec, evaluator, user, client_sdk_key, hash_algo, include_exposures)
+        hashed_name, value = to_response(name, spec, evaluator, user, client_sdk_key, hash_algo, include_exposures, include_local_overrides)
         if !hashed_name.nil? && !value.nil?
           result[hashed_name] = value
         end
@@ -16,7 +24,7 @@ module Statsig
       result
     end
 
-    def self.to_response(config_name, config_spec, evaluator, user, client_sdk_key, hash_algo, include_exposures)
+    def self.to_response(config_name, config_spec, evaluator, user, client_sdk_key, hash_algo, include_exposures, include_local_overrides)
       target_app_id = evaluator.spec_store.get_app_id_for_sdk_key(client_sdk_key)
       config_target_apps = config_spec.target_app_ids
 
@@ -30,12 +38,25 @@ module Statsig
         return nil
       end
 
-      eval_result = ConfigResult.new(
-        name: config_name,
-        disable_evaluation_details: true,
-        disable_exposures: !include_exposures
-      )
-      evaluator.eval_spec(user, config_spec, eval_result)
+      if include_local_overrides
+        case category
+        when :feature_gate
+          local_override = evaluator.lookup_gate_override(config_name)
+        when :dynamic_config
+          local_override = evaluator.lookup_config_override(config_name)
+        end
+      end
+
+      if local_override.nil?
+        eval_result = ConfigResult.new(
+          name: config_name,
+          disable_evaluation_details: true,
+          disable_exposures: !include_exposures
+        )
+        evaluator.eval_spec(user, config_spec, eval_result)
+      else
+        eval_result = local_override
+      end
 
       result = {}
 

data/lib/evaluator.rb

@@ -16,6 +16,10 @@ module Statsig
 
     attr_accessor :spec_store
 
+    attr_accessor :gate_overrides
+
+    attr_accessor :config_overrides
+
     attr_accessor :options
 
     attr_accessor :persistent_storage_utils
@@ -35,17 +39,49 @@ module Statsig
       @spec_store.maybe_restart_background_threads
     end
 
-    def check_gate(user, gate_name, end_result)
+    def lookup_gate_override(gate_name)
       if @gate_overrides.key?(gate_name)
-        end_result.gate_value = @gate_overrides[gate_name]
-        end_result.rule_id = Const::OVERRIDE
-        unless end_result.disable_evaluation_details
-          end_result.evaluation_details = EvaluationDetails.local_override(
+        return ConfigResult.new(
+          name: gate_name,
+          gate_value: @gate_overrides[gate_name],
+          rule_id: Const::OVERRIDE,
+          id_type: @spec_store.has_gate?(gate_name) ? @spec_store.get_gate(gate_name).id_type : Const::EMPTY_STR,
+          evaluation_details: EvaluationDetails.local_override(
+            @spec_store.last_config_sync_time,
+            @spec_store.initial_config_sync_time
+          )
+        )
+      end
+      return nil
+    end
+
+    def lookup_config_override(config_name)
+      if @config_overrides.key?(config_name)
+        return ConfigResult.new(
+          name: config_name,
+          json_value: @config_overrides[config_name],
+          rule_id: Const::OVERRIDE,
+          id_type: @spec_store.has_config?(config_name) ? @spec_store.get_config(config_name).id_type : Const::EMPTY_STR,
+          evaluation_details: EvaluationDetails.local_override(
             @spec_store.last_config_sync_time,
             @spec_store.initial_config_sync_time
           )
+        )
+      end
+      return nil
+    end
+
+    def check_gate(user, gate_name, end_result, ignore_local_overrides: false)
+      unless ignore_local_overrides
+        local_override = lookup_gate_override(gate_name)
+        unless local_override.nil?
+          end_result.gate_value = local_override.gate_value
+          end_result.rule_id = local_override.rule_id
+          unless end_result.disable_evaluation_details
+            end_result.evaluation_details = local_override.evaluation_details
+          end
+          return
         end
-        return
       end
 
       if @spec_store.init_reason == EvaluationReason::UNINITIALIZED
@@ -63,19 +99,18 @@ module Statsig
       eval_spec(user, @spec_store.get_gate(gate_name), end_result)
     end
 
-    def get_config(user, config_name, end_result, user_persisted_values: nil)
-      if @config_overrides.key?(config_name)
-        id_type = @spec_store.has_config?(config_name) ? @spec_store.get_config(config_name).id_type : Const::EMPTY_STR
-        end_result.id_type = id_type
-        end_result.rule_id = Const::OVERRIDE
-        end_result.json_value = @config_overrides[config_name]
-        unless end_result.disable_evaluation_details
-          end_result.evaluation_details = EvaluationDetails.local_override(
-            @spec_store.last_config_sync_time,
-            @spec_store.initial_config_sync_time
-          )
+    def get_config(user, config_name, end_result, user_persisted_values: nil, ignore_local_overrides: false)
+      unless ignore_local_overrides
+        local_override = lookup_config_override(config_name)
+        unless local_override.nil?
+          end_result.id_type = local_override.id_type
+          end_result.rule_id = local_override.rule_id
+          end_result.json_value = local_override.json_value
+          unless end_result.disable_evaluation_details
+            end_result.evaluation_details = local_override.evaluation_details
+          end
+          return
         end
-        return
       end
 
       if @spec_store.init_reason == EvaluationReason::UNINITIALIZED
@@ -162,7 +197,7 @@ module Statsig
       @spec_store.layers.map { |name, _| name }
     end
 
-    def get_client_initialize_response(user, hash_algo, client_sdk_key)
+    def get_client_initialize_response(user, hash_algo, client_sdk_key, include_local_overrides)
       if @spec_store.is_ready_for_checks == false
         return nil
       end
@@ -178,11 +213,11 @@ module Statsig
 
       {
         feature_gates: Statsig::ResponseFormatter
-                         .get_responses(@spec_store.gates, self, user, client_sdk_key, hash_algo),
+                         .get_responses(@spec_store.gates, self, user, client_sdk_key, hash_algo, include_local_overrides: include_local_overrides),
         dynamic_configs: Statsig::ResponseFormatter
-                           .get_responses(@spec_store.configs, self, user, client_sdk_key, hash_algo),
+                           .get_responses(@spec_store.configs, self, user, client_sdk_key, hash_algo, include_local_overrides: include_local_overrides),
         layer_configs: Statsig::ResponseFormatter
-                         .get_responses(@spec_store.layers, self, user, client_sdk_key, hash_algo),
+                         .get_responses(@spec_store.layers, self, user, client_sdk_key, hash_algo, include_local_overrides: include_local_overrides),
         sdkParams: {},
         has_updates: true,
         generator: Const::STATSIG_RUBY_SDK,
@@ -222,10 +257,26 @@ module Statsig
       @gate_overrides[gate] = value
     end
 
+    def remove_gate_override(gate)
+      @gate_overrides.delete(gate)
+    end
+
+    def clear_gate_overrides
+      @gate_overrides.clear
+    end
+
     def override_config(config, value)
       @config_overrides[config] = value
     end
 
+    def remove_config_override(config)
+      @config_overrides.delete(config)
+    end
+
+    def clear_config_overrides
+      @config_overrides.clear
+    end
+
     def eval_spec(user, config, end_result)
       unless config.enabled
         finalize_eval_result(config, end_result, did_pass: false, rule: nil)

data/lib/statsig.rb

@@ -43,11 +43,12 @@ module Statsig
   end
 
   class CheckGateOptions
-    attr_accessor :disable_log_exposure, :disable_evaluation_details
+    attr_accessor :disable_log_exposure, :disable_evaluation_details, :ignore_local_overrides
 
-    def initialize(disable_log_exposure: false, disable_evaluation_details: false)
+    def initialize(disable_log_exposure: false, disable_evaluation_details: false, ignore_local_overrides: false)
       @disable_log_exposure = disable_log_exposure
       @disable_evaluation_details = disable_evaluation_details
+      @ignore_local_overrides = ignore_local_overrides
     end
   end
 
@@ -85,11 +86,12 @@ module Statsig
   end
 
   class GetConfigOptions
-    attr_accessor :disable_log_exposure, :disable_evaluation_details
+    attr_accessor :disable_log_exposure, :disable_evaluation_details, :ignore_local_overrides
 
-    def initialize(disable_log_exposure: false, disable_evaluation_details: false)
+    def initialize(disable_log_exposure: false, disable_evaluation_details: false, ignore_local_overrides: false)
       @disable_log_exposure = disable_log_exposure
       @disable_evaluation_details = disable_evaluation_details
+      @ignore_local_overrides = ignore_local_overrides
     end
   end
 
@@ -128,12 +130,13 @@ module Statsig
   end
 
   class GetExperimentOptions
-    attr_accessor :disable_log_exposure, :user_persisted_values, :disable_evaluation_details
+    attr_accessor :disable_log_exposure, :user_persisted_values, :disable_evaluation_details, :ignore_local_overrides
 
-    def initialize(disable_log_exposure: false, user_persisted_values: nil, disable_evaluation_details: false)
+    def initialize(disable_log_exposure: false, user_persisted_values: nil, disable_evaluation_details: false, ignore_local_overrides: false)
       @disable_log_exposure = disable_log_exposure
       @user_persisted_values = user_persisted_values
       @disable_evaluation_details = disable_evaluation_details
+      @ignore_local_overrides = ignore_local_overrides
     end
   end
 
@@ -298,6 +301,16 @@ module Statsig
     @shared_instance&.override_gate(gate_name, gate_value)
   end
 
+  def self.remove_gate_override(gate_name)
+    ensure_initialized
+    @shared_instance&.remove_gate_override(gate_name)
+  end
+
+  def self.clear_gate_overrides
+    ensure_initialized
+    @shared_instance&.clear_gate_overrides
+  end
+
   ##
   # Sets a value to be returned for the given dynamic config/experiment instead of the actual evaluated value.
   #
@@ -308,6 +321,16 @@ module Statsig
     @shared_instance&.override_config(config_name, config_value)
   end
 
+  def self.remove_config_override(config_name)
+    ensure_initialized
+    @shared_instance&.remove_config_override(config_name)
+  end
+
+  def self.clear_config_overrides
+    ensure_initialized
+    @shared_instance&.clear_config_overrides
+  end
+
   ##
   # Gets all evaluated values for the given user.
   # These values can then be given to a Statsig Client SDK via bootstrapping.
@@ -315,11 +338,17 @@ module Statsig
   # @param user A StatsigUser object used for the evaluation
   # @param hash The type of hashing algorithm to use ('sha256', 'djb2', 'none')
   # @param client_sdk_key A optional client sdk key to be used for the evaluation
+  # @param include_local_overrides Option to include local overrides
   #
   # @note See Ruby Documentation: https://docs.statsig.com/server/rubySDK)
-  def self.get_client_initialize_response(user, hash: 'sha256', client_sdk_key: nil)
+  def self.get_client_initialize_response(
+    user,
+    hash: 'sha256',
+    client_sdk_key: nil,
+    include_local_overrides: false
+  )
     ensure_initialized
-    @shared_instance&.get_client_initialize_response(user, hash, client_sdk_key)
+    @shared_instance&.get_client_initialize_response(user, hash, client_sdk_key, include_local_overrides)
   end
 
   ##
@@ -327,7 +356,7 @@ module Statsig
   def self.get_statsig_metadata
     {
       'sdkType' => 'ruby-server',
-      'sdkVersion' => '1.32.0',
+      'sdkVersion' => '1.33.0',
       'languageVersion' => RUBY_VERSION
     }
   end

data/lib/statsig_driver.rb

@@ -43,7 +43,14 @@ class StatsigDriver
     }, caller: __method__.to_s)
   end
 
-  def get_gate_impl(user, gate_name, disable_log_exposure: false, skip_evaluation: false, disable_evaluation_details: false)
+  def get_gate_impl(
+    user,
+    gate_name,
+    disable_log_exposure: false,
+    skip_evaluation: false,
+    disable_evaluation_details: false,
+    ignore_local_overrides: false
+  )
     if skip_evaluation
       gate = @store.get_gate(gate_name)
       return FeatureGate.new(gate_name) if gate.nil?
@@ -52,7 +59,7 @@ class StatsigDriver
     user = verify_inputs(user, gate_name, 'gate_name')
 
     res = Statsig::ConfigResult.new(name: gate_name, disable_exposures: disable_log_exposure, disable_evaluation_details: disable_evaluation_details)
-    @evaluator.check_gate(user, gate_name, res)
+    @evaluator.check_gate(user, gate_name, res, ignore_local_overrides: ignore_local_overrides)
 
     unless disable_log_exposure
       @logger.log_gate_exposure(
@@ -81,7 +88,8 @@ class StatsigDriver
           user,
           gate_name,
           disable_log_exposure: options&.disable_log_exposure == true,
-          disable_evaluation_details: options&.disable_evaluation_details == true
+          disable_evaluation_details: options&.disable_evaluation_details == true,
+          ignore_local_overrides: options&.ignore_local_overrides == true
         ).value
       }, caller: __method__.to_s)
     }, recover: -> { false }, caller: __method__.to_s)
@@ -104,7 +112,8 @@ class StatsigDriver
           user,
           dynamic_config_name,
           options&.disable_log_exposure == true,
-          disable_evaluation_details: options&.disable_evaluation_details == true
+          disable_evaluation_details: options&.disable_evaluation_details == true,
+          ignore_local_overrides: options&.ignore_local_overrides == true
         )
       }, caller: __method__.to_s)
     }, recover: -> { DynamicConfig.new(dynamic_config_name) }, caller: __method__.to_s)
@@ -119,7 +128,8 @@ class StatsigDriver
           experiment_name,
           options&.disable_log_exposure == true,
           user_persisted_values: options&.user_persisted_values,
-          disable_evaluation_details: options&.disable_evaluation_details == true
+          disable_evaluation_details: options&.disable_evaluation_details == true,
+          ignore_local_overrides: options&.ignore_local_overrides == true
         )
       }, caller: __method__.to_s)
     }, recover: -> { DynamicConfig.new(experiment_name) }, caller: __method__.to_s)
@@ -249,20 +259,45 @@ class StatsigDriver
     }, caller: __method__.to_s)
   end
 
+  def remove_gate_override(gate_name)
+    @err_boundary.capture(task: lambda {
+      @evaluator.remove_gate_override(gate_name)
+    }, caller: __method__.to_s)
+  end
+
+  def clear_gate_overrides
+    @err_boundary.capture(task: lambda {
+      @evaluator.clear_gate_overrides
+    }, caller: __method__.to_s)
+  end
+
   def override_config(config_name, config_value)
     @err_boundary.capture(task: lambda {
       @evaluator.override_config(config_name, config_value)
     }, caller: __method__.to_s)
   end
 
+  def remove_config_override(config_name)
+    @err_boundary.capture(task: lambda {
+      @evaluator.remove_config_override(config_name)
+    }, caller: __method__.to_s)
+  end
+
+  def clear_config_overrides
+    @err_boundary.capture(task: lambda {
+      @evaluator.clear_config_overrides
+    }, caller: __method__.to_s)
+  end
+
   # @param [StatsigUser] user
   # @param [String | nil] client_sdk_key
+  # @param [Boolean] include_local_overrides
   # @return [Hash]
-  def get_client_initialize_response(user, hash, client_sdk_key)
+  def get_client_initialize_response(user, hash, client_sdk_key, include_local_overrides)
     @err_boundary.capture(task: lambda {
       validate_user(user)
       normalize_user(user)
-      @evaluator.get_client_initialize_response(user, hash, client_sdk_key)
+      @evaluator.get_client_initialize_response(user, hash, client_sdk_key, include_local_overrides)
     }, recover: -> { nil }, caller: __method__.to_s)
   end
 
@@ -308,13 +343,13 @@ class StatsigDriver
     normalize_user(user)
   end
 
-  def get_config_impl(user, config_name, disable_log_exposure, user_persisted_values: nil, disable_evaluation_details: false)
+  def get_config_impl(user, config_name, disable_log_exposure, user_persisted_values: nil, disable_evaluation_details: false, ignore_local_overrides: false)
     res = Statsig::ConfigResult.new(
       name: config_name,
       disable_exposures: disable_log_exposure,
       disable_evaluation_details: disable_evaluation_details
     )
-    @evaluator.get_config(user, config_name, res, user_persisted_values: user_persisted_values)
+    @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)
@@ -336,7 +371,7 @@ class StatsigDriver
   end
 
   def normalize_user(user)
-    if !@options&.environment.nil?
+    if user.statsig_environment.nil? && !@options&.environment.nil?
       user.statsig_environment = @options.environment
     end
     user

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statsig
 version: !ruby/object:Gem::Version
-  version: 1.32.0
+  version: 1.33.0
 platform: ruby
 authors:
 - Statsig, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-26 00:00:00.000000000 Z
+date: 2024-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,20 +94,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: sorbet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.5.10461
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.5.10461
 - !ruby/object:Gem::Dependency
   name: tapioca
   requirement: !ruby/object:Gem::Requirement
@@ -288,20 +274,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.1
-- !ruby/object:Gem::Dependency
-  name: sorbet-runtime
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.10461
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.10461
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement