statsig 2.0.1 → 2.8.1

data/lib/evaluator.rb

@@ -1,15 +1,15 @@
-require 'config_result'
 require 'country_lookup'
 require 'digest'
-require 'evaluation_helpers'
-require 'client_initialize_helpers'
-require 'spec_store'
 require 'time'
-require 'ua_parser'
-require 'evaluation_details'
 require 'user_agent_parser/operating_system'
-require 'user_persistent_storage_utils'
-require 'constants'
+require_relative 'client_initialize_helpers'
+require_relative 'config_result'
+require_relative 'constants'
+require_relative 'evaluation_details'
+require_relative 'evaluation_helpers'
+require_relative 'spec_store'
+require_relative 'ua_parser'
+require_relative 'user_persistent_storage_utils'
 
 module Statsig
   class Evaluator
@@ -20,6 +20,8 @@ module Statsig
 
     attr_accessor :config_overrides
 
+    attr_accessor :experiment_overrides
+
     attr_accessor :options
 
     attr_accessor :persistent_storage_utils
@@ -31,6 +33,7 @@ module Statsig
       @spec_store = store
       @gate_overrides = {}
       @config_overrides = {}
+      @experiment_overrides = {}
       @options = options
       @persistent_storage_utils = persistent_storage_utils
     end
@@ -58,19 +61,76 @@ module Statsig
 
     def lookup_config_override(config_name)
       config_name_sym = config_name.to_sym
+      if @experiment_overrides.key?(config_name_sym)
+        override = @experiment_overrides[config_name_sym]
+        return ConfigResult.new(
+          name: config_name,
+          json_value: override[:value],
+          group_name: override[:group_name],
+          rule_id: override[:rule_id],
+          evaluation_details: EvaluationDetails.local_override(
+            @spec_store.last_config_sync_time,
+            @spec_store.initial_config_sync_time
+          )
+        )
+      end
       if @config_overrides.key?(config_name_sym)
+        override = @config_overrides[config_name_sym]
         return ConfigResult.new(
           name: config_name,
-          json_value: @config_overrides[config_name_sym],
+          json_value: override,
           rule_id: Const::OVERRIDE,
-          id_type: @spec_store.has_config?(config_name) ? @spec_store.get_config(config_name)[:idType] : Const::EMPTY_STR,
           evaluation_details: EvaluationDetails.local_override(
             @spec_store.last_config_sync_time,
             @spec_store.initial_config_sync_time
           )
         )
       end
-      return nil
+      nil
+    end
+
+    def try_apply_config_mapping(gate_name, user, end_result, type, salt)
+      gate_name_sym = gate_name.to_sym
+      return false unless @spec_store.overrides.key?(gate_name_sym)
+
+      mapping_list = @spec_store.overrides[gate_name_sym]
+      mapping_list.each do |mapping|
+        rules = mapping[:rules]
+        rules.each do |rule|
+          start_time = rule[:start_time]
+          if !start_time.nil? && start_time > (Time.now.to_i * 1000)
+            next
+          end
+
+          rule_name = rule[:rule_name].to_sym
+          next unless @spec_store.override_rules.key?(rule_name)
+
+          override_rule = @spec_store.override_rules[rule_name]
+          eval_rule(user, override_rule, end_result)
+          unless end_result.gate_value
+            next
+          end
+
+          pass = eval_pass_percent(user, override_rule, salt)
+          unless pass
+            next
+          end
+
+          new_config_name = mapping[:new_config_name]
+          end_result.override_config_name = new_config_name
+          if type == Const::TYPE_FEATURE_GATE
+            check_gate(user, new_config_name, end_result)
+          end
+          if [Const::TYPE_EXPERIMENT, Const::TYPE_DYNAMIC_CONFIG, Const::TYPE_AUTOTUNE].include?(type)
+            get_config(user, new_config_name, end_result)
+          end
+          if type == Const::TYPE_LAYER
+            get_layer(user, new_config_name, end_result)
+          end
+          return true
+        end
+      end
+      false
     end
 
     def check_gate(user, gate_name, end_result, ignore_local_overrides: false, is_nested: false)
@@ -87,6 +147,7 @@ module Statsig
       end
 
       if @spec_store.init_reason == EvaluationReason::UNINITIALIZED
+        end_result.gate_value = false
         unless end_result.disable_evaluation_details
           end_result.evaluation_details = EvaluationDetails.uninitialized
         end
@@ -94,11 +155,20 @@ module Statsig
       end
 
       unless @spec_store.has_gate?(gate_name)
+        if try_apply_config_mapping(gate_name, user, end_result, Const::TYPE_FEATURE_GATE, Const::EMPTY_STR)
+          return
+        end
+
         unsupported_or_unrecognized(gate_name, end_result)
         return
       end
 
-      eval_spec(gate_name, user, @spec_store.get_gate(gate_name), end_result, is_nested: is_nested)
+      spec = @spec_store.get_gate(gate_name)
+      if try_apply_config_mapping(gate_name, user, end_result, spec[:entity], spec[:salt])
+        return
+      end
+
+      eval_spec(gate_name, user, spec, end_result, is_nested: is_nested)
     end
 
     def get_config(user, config_name, end_result, user_persisted_values: nil, ignore_local_overrides: false)
@@ -108,6 +178,8 @@ module Statsig
           end_result.id_type = local_override.id_type
           end_result.rule_id = local_override.rule_id
           end_result.json_value = local_override.json_value
+          end_result.group_name = local_override.group_name
+          end_result.is_experiment_group = local_override.is_experiment_group
           unless end_result.disable_evaluation_details
             end_result.evaluation_details = local_override.evaluation_details
           end
@@ -122,13 +194,25 @@ module Statsig
         return
       end
 
+      if eval_cmab(config_name, user, end_result)
+        return
+      end
+
       unless @spec_store.has_config?(config_name)
+        if try_apply_config_mapping(config_name, user, end_result, Const::TYPE_DYNAMIC_CONFIG, Const::EMPTY_STR)
+          return
+        end
+
         unsupported_or_unrecognized(config_name, end_result)
         return
       end
 
       config = @spec_store.get_config(config_name)
 
+      if try_apply_config_mapping(config_name, user, end_result, config[:entity], config[:salt])
+        return
+      end
+
       # If persisted values is provided and the experiment is active, return sticky values if exists.
       if !user_persisted_values.nil? && config[:isActive] == true
         sticky_values = user_persisted_values[config_name]
@@ -163,6 +247,149 @@ module Statsig
       end
     end
 
+    def eval_cmab(config_name, user, end_result)
+      return false unless @spec_store.has_cmab_config?(config_name)
+
+      cmab = @spec_store.get_cmab_config(config_name)
+
+      if !cmab[:enabled] || cmab[:groups].length.zero?
+        end_result.rule_id = Const::PRESTART
+        end_result.json_value = cmab[:defaultValue]
+        finalize_cmab_eval_result(cmab, end_result, did_pass: false)
+        return true
+      end
+
+      targeting_gate = cmab[:targetingGateName]
+      unless targeting_gate.nil?
+        check_gate(user, targeting_gate, end_result, is_nested: true)
+
+        gate_value = end_result.gate_value
+
+        unless end_result.disable_exposures
+          new_exposure = {
+            gate: targeting_gate,
+            gateValue: gate_value ? Const::TRUE : Const::FALSE,
+            ruleID: end_result.rule_id
+          }
+          end_result.secondary_exposures.append(new_exposure)
+        end
+
+        if gate_value == false
+          end_result.rule_id = Const::FAILS_TARGETING
+          end_result.json_value = cmab[:defaultValue]
+          finalize_cmab_eval_result(cmab, end_result, did_pass: false)
+          return true
+        end
+      end
+
+      cmab_config = cmab[:config]
+      unit_id = user.get_unit_id(cmab[:idType]) || Const::EMPTY_STR
+      salt = cmab[:salt] || config_name
+      hash = compute_user_hash("#{salt}.#{unit_id}")
+
+      # If there is no config assign the user to a random group
+      if cmab_config.nil?
+        group_size = 10_000.0 / cmab[:groups].length
+        group = cmab[:groups][(hash % 10_000) / group_size]
+        end_result.json_value = group[:parameterValues]
+        end_result.rule_id = group[:id] + Const::EXPLORE
+        end_result.group_name = group[:name]
+        end_result.is_experiment_group = true
+        finalize_cmab_eval_result(cmab, end_result, did_pass: true)
+        return true
+      end
+
+      should_sample = (hash % 10_000) < cmab[:sampleRate] * 10_000
+      if should_sample && apply_cmab_sampling(cmab, cmab_config, end_result)
+        finalize_cmab_eval_result(cmab, end_result, did_pass: true)
+        return true
+      end
+      apply_cmab_best_group(cmab, cmab_config, user, end_result)
+      finalize_cmab_eval_result(cmab, end_result, did_pass: true)
+      true
+    end
+
+    def apply_cmab_best_group(cmab, cmab_config, user, end_result)
+      higher_better = cmab[:higherIsBetter]
+      best_score = higher_better ? -1_000_000_000 : 1_000_000_000
+      has_score = false
+      best_group = nil
+      cmab[:groups].each do |group|
+        group_id = group[:id]
+        config = cmab_config[group_id.to_sym]
+        next if config.nil?
+
+        weights_numerical = config[:weightsNumerical]
+        weights_categorical = config[:weightsCategorical]
+
+        next if weights_numerical.length.zero? && weights_categorical.length.zero?
+
+        score = 0
+        score += config[:alpha] + config[:intercept]
+
+        weights_categorical.each do |key, weights|
+          value = get_value_from_user(user, key.to_s)
+          next if value.nil?
+
+          if weights.key?(value.to_sym)
+            score += weights[value.to_sym]
+          end
+        end
+
+        weights_numerical.each do |key, weight|
+          value = get_value_from_user(user, key.to_s)
+          if value.is_a?(Numeric)
+            score += weight * value
+          end
+        end
+        if !has_score || (higher_better && score > best_score) || (!higher_better && score < best_score)
+          best_score = score
+          best_group = group
+        end
+        has_score = true
+      end
+      if best_group.nil?
+        best_group = cmab[:groups][Random.rand(cmab[:groups].length)]
+      end
+      end_result.json_value = best_group[:parameterValues]
+      end_result.rule_id = best_group[:id]
+      end_result.group_name = best_group[:name]
+      end_result.is_experiment_group = true
+    end
+
+    def apply_cmab_sampling(cmab, cmab_config, end_result)
+      total_records = 0.0
+      cmab[:groups].each do |group|
+        group_id = group[:id]
+        config = cmab_config[group_id.to_sym]
+        cur_count = 1.0
+        unless config.nil?
+          cur_count += config[:records]
+        end
+        total_records += 1.0 / cur_count
+      end
+
+      sum = 0.0
+      value = Random.rand
+      cmab[:groups].each do |group|
+        group_id = group[:id]
+        config = cmab_config[group_id.to_sym]
+        cur_count = 1.0
+        unless config.nil?
+          cur_count += config[:records]
+        end
+        sum += 1.0 / (cur_count / total_records)
+        next unless value < sum
+
+        end_result.json_value = group[:parameterValues]
+        end_result.rule_id = group[:id] + Const::EXPLORE
+        end_result.group_name = group[:name]
+        end_result.is_experiment_group = true
+        return true
+      end
+      false
+    end
+
     def get_layer(user, layer_name, end_result)
       if @spec_store.init_reason == EvaluationReason::UNINITIALIZED
         unless end_result.disable_evaluation_details
@@ -172,11 +399,20 @@ module Statsig
       end
 
       unless @spec_store.has_layer?(layer_name)
+        if try_apply_config_mapping(layer_name, user, end_result, Const::LAYER, Const::EMPTY_STR)
+          return
+        end
+
         unsupported_or_unrecognized(layer_name, end_result)
         return
       end
 
-      eval_spec(layer_name, user, @spec_store.get_layer(layer_name), end_result)
+      layer = @spec_store.get_layer(layer_name)
+      if try_apply_config_mapping(layer_name, user, end_result, layer[:entity], layer[:salt])
+        return
+      end
+
+      eval_spec(layer_name, user, layer, end_result)
     end
 
     def list_gates
@@ -257,6 +493,7 @@ module Statsig
 
     def unsupported_or_unrecognized(config_name, end_result)
       end_result.rule_id = Const::EMPTY_STR
+      end_result.gate_value = false
 
       if end_result.disable_evaluation_details
         return
@@ -300,8 +537,44 @@ module Statsig
       @config_overrides.clear
     end
 
+    def override_experiment_by_group_name(experiment_name, group_name)
+      return unless @spec_store.has_config?(experiment_name)
+
+      config = @spec_store.get_config(experiment_name)
+      return unless config[:entity] == Const::TYPE_EXPERIMENT
+
+      config[:rules].each do |rule|
+        if rule[:groupName] == group_name
+          @experiment_overrides[experiment_name.to_sym] = {
+            value: rule[:returnValue],
+            group_name: rule[:groupName],
+            rule_id: rule[:id],
+            evaluation_details: EvaluationDetails.local_override(@spec_store.last_config_sync_time, @spec_store.initial_config_sync_time)
+          }
+          return
+        end
+      end
+
+      # If no matching rule is found, create a default override with empty value
+      @experiment_overrides[experiment_name.to_sym] = {
+        value: {},
+        group_name: group_name,
+        rule_id: "#{experiment_name}:override",
+        evaluation_details: EvaluationDetails.local_override(@spec_store.last_config_sync_time, @spec_store.initial_config_sync_time)
+      }
+    end
+
+    def clear_experiment_overrides
+      @experiment_overrides.clear
+    end
+
+    def remove_experiment_override(experiment_name)
+      @experiment_overrides.delete(experiment_name.to_sym)
+    end
+
     def eval_spec(config_name, user, config, end_result, is_nested: false)
       config[:rules].each do |rule|
+        end_result.sampling_rate = rule[:samplingRate]
         eval_rule(user, rule, end_result)
 
         if end_result.gate_value
@@ -324,7 +597,12 @@ 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
+      end_result.forward_all_exposures = config[:forwardAllExposures]
+      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]
@@ -336,6 +614,7 @@ module Statsig
         end_result.group_name = rule[:groupName]
         end_result.is_experiment_group = rule[:isExperimentGroup] == true
         end_result.rule_id = rule[:id]
+        end_result.sampling_rate = rule[:samplingRate]
       end
 
       unless end_result.disable_evaluation_details
@@ -351,6 +630,21 @@ module Statsig
       end
     end
 
+    def finalize_cmab_eval_result(config, end_result, did_pass:)
+      end_result.id_type = config[:idType]
+      end_result.target_app_ids = config[:targetAppIDs]
+      end_result.gate_value = did_pass
+
+      unless end_result.disable_evaluation_details
+        end_result.evaluation_details = EvaluationDetails.new(
+          @spec_store.last_config_sync_time,
+          @spec_store.initial_config_sync_time,
+          @spec_store.init_reason
+        )
+      end
+      end_result.config_version = config[:version]
+    end
+
     def finalize_secondary_exposures(end_result)
       end_result.secondary_exposures = clean_exposures(end_result.secondary_exposures)
       end_result.undelegated_sec_exps = clean_exposures(end_result.undelegated_sec_exps)
@@ -373,11 +667,35 @@ module Statsig
     def eval_rule(user, rule, end_result)
       pass = true
       i = 0
+      memo = user.get_memo
 
       until i >= rule[:conditions].length
         condition_hash = rule[:conditions][i]
+
+        eval_rule_memo = memo[:eval_rule] || {}
+        result = eval_rule_memo[condition_hash]
+
+        if !result.nil?
+          pass = false if result != true
+          i += 1
+          next
+        end
+
         condition = @spec_store.get_condition(condition_hash)
-        result = eval_condition(user, condition, end_result)
+        result = if condition.nil?
+          puts "[Statsig]: Warning - Condition with hash #{condition_hash} could not be found."
+          false
+        else
+          eval_condition(user, condition, end_result)
+        end
+
+        if !@options.disable_evaluation_memoization &&
+          condition && condition[:type] != Const::CND_PASS_GATE && condition[:type] != Const::CND_FAIL_GATE
+          eval_rule_memo[condition_hash] = result
+        end
+
+        memo[:eval_rule] = eval_rule_memo
+
         pass = false if result != true
         i += 1
       end
@@ -413,7 +731,14 @@ module Statsig
       when Const::CND_PUBLIC
         return true
       when Const::CND_PASS_GATE, Const::CND_FAIL_GATE
+        if !target.is_a?(String) || target.empty?
+          return type == Const::CND_FAIL_GATE
+        end
+
         result = eval_nested_gate(target, user, end_result)
+        if end_result.sampling_rate == nil && !target.start_with?("segment")
+          end_result.has_seen_analytical_gates = true
+        end
         return type == Const::CND_PASS_GATE ? result : !result
       when Const::CND_MULTI_PASS_GATE, Const::CND_MULTI_FAIL_GATE
         return eval_nested_gates(target, type, user, end_result)
@@ -542,6 +867,24 @@ module Statsig
           a.year == b.year && a.month == b.month && a.day == b.day
         })
 
+        # array
+      when Const::OP_ARRAY_CONTAINS_ANY
+        if value.is_a?(Array) && target.is_a?(Array)
+          return EvaluationHelpers.array_contains_any(value, target)
+        end
+      when Const::OP_ARRAY_CONTAINS_NONE
+        if value.is_a?(Array) && target.is_a?(Array)
+          return !EvaluationHelpers.array_contains_any(value, target)
+        end
+      when Const::OP_ARRAY_CONTAINS_ALL
+        if value.is_a?(Array) && target.is_a?(Array)
+          return EvaluationHelpers.array_contains_all(value, target)
+        end
+      when Const::OP_NOT_ARRAY_CONTAINS_ALL
+        if value.is_a?(Array) && target.is_a?(Array)
+          return !EvaluationHelpers.array_contains_all(value, target)
+        end
+
         # segments
       when Const::OP_IN_SEGMENT_LIST, Const::OP_NOT_IN_SEGMENT_LIST
         begin
@@ -562,7 +905,8 @@ module Statsig
     end
 
     def eval_nested_gate(gate_name, user, end_result)
-      check_gate(user, gate_name, end_result, is_nested: true)
+      check_gate(user, gate_name, end_result, is_nested: true,
+                                              ignore_local_overrides: !end_result.include_local_overrides)
       gate_value = end_result.gate_value
 
       unless end_result.disable_exposures
@@ -582,7 +926,9 @@ module Statsig
       is_multi_pass_gate_type = condition_type == Const::CND_MULTI_PASS_GATE
       gate_names.each { |gate_name|
         result = eval_nested_gate(gate_name, user, end_result)
-
+        if end_result.sampling_rate == nil && !target.start_with?("segment")
+          end_result.has_seen_analytical_gates = true
+        end
         if is_multi_pass_gate_type == result
           has_passing_gate = true
           break
@@ -670,10 +1016,14 @@ module Statsig
     end
 
     def eval_pass_percent(user, rule, config_salt)
+      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}")
-      return (hash % 10_000) < (rule[:passPercentage] * 100)
+      return (hash % 10_000) < (pass_percentage * 100)
     end
 
     def compute_user_hash(user_hash)

data/lib/hash_utils.rb

@@ -1,11 +1,15 @@
+require 'digest'
 require 'json'
+
+TWO_TO_THE_63 = 1 << 63
+TWO_TO_THE_64 = 1 << 64
 module Statsig
   class HashUtils
     def self.djb2(input_str)
       hash = 0
-      input_str.each_char.each do |c|
-        hash = (hash << 5) - hash + c.ord
-        hash &= hash
+      input_str.each_codepoint.each do |c|
+        hash = (hash << 5) - hash + c
+        hash &= 0xFFFFFFFF
       end
       hash &= 0xFFFFFFFF # Convert to unsigned 32-bit integer
       return hash.to_s
@@ -32,5 +36,46 @@ module Statsig
       end
       return dictionary
     end
+
+    def self.bigquery_hash(string)
+      digest = Digest::SHA256.digest(string)
+      num = digest[0...8].unpack('Q>')[0]
+      
+      if num >= TWO_TO_THE_63
+        num - TWO_TO_THE_64
+      else
+        num
+      end
+    end
+
+    def self.is_hash_in_sampling_rate(key, sampling_rate)
+      hash_key = bigquery_hash(key)
+      hash_key % sampling_rate == 0
+    end
+
+    def self.compute_dedupe_key_for_gate(gate_name, rule_id, value, user_id, custom_ids = nil)
+      user_key = compute_user_key(user_id, custom_ids)
+      "n:#{gate_name};u:#{user_key}r:#{rule_id};v:#{value}"
+    end
+
+    def self.compute_dedupe_key_for_config(config_name, rule_id, user_id, custom_ids = nil)
+      user_key = compute_user_key(user_id, custom_ids)
+      "n:#{config_name};u:#{user_key}r:#{rule_id}"
+    end
+
+    def self.compute_dedupe_key_for_layer(layer_name, experiment_name, parameter_name, rule_id, user_id, custom_ids = nil)
+      user_key = compute_user_key(user_id, custom_ids)
+      "n:#{layer_name};e:#{experiment_name};p:#{parameter_name};u:#{user_key}r:#{rule_id}"
+    end
+
+    def self.compute_user_key(user_id, custom_ids = nil)
+      user_key = "u:#{user_id};"
+      if custom_ids
+        custom_ids.each do |k, v|
+          user_key += "#{k}:#{v};"
+        end
+      end
+      user_key
+    end
   end
 end

data/lib/layer.rb

@@ -52,12 +52,31 @@ class Layer
     index_sym = index.to_sym
     return default_value unless @value.key?(index_sym)
 
-    return default_value if @value[index_sym].class != default_value.class and default_value.class != TrueClass and default_value.class != FalseClass
+    value = @value[index_sym]
 
-    if @exposure_log_func.is_a? Proc
-      @exposure_log_func.call(self, index)
+    case default_value
+    when Integer
+      if @exposure_log_func.is_a? Proc
+        @exposure_log_func.call(self, index)
+      end
+      return value.to_i if value.is_a?(Numeric) && default_value.is_a?(Integer)
+    when Float
+      if @exposure_log_func.is_a? Proc
+        @exposure_log_func.call(self, index)
+      end
+      return value.to_f if value.is_a?(Numeric) && default_value.is_a?(Float)
+    when TrueClass, FalseClass
+      if @exposure_log_func.is_a? Proc
+        @exposure_log_func.call(self, index)
+      end
+      return value if [true, false].include?(value)
+    else
+      if @exposure_log_func.is_a? Proc
+        @exposure_log_func.call(self, index)
+      end
+      return value if value.class == default_value.class
     end
 
-    @value[index_sym]
+    default_value
   end
 end

data/lib/memo.rb

@@ -3,7 +3,11 @@ module Statsig
 
     @global_memo = {}
 
-    def self.for(hash, method, key)
+    def self.for(hash, method, key, disable_evaluation_memoization: false)
+      if disable_evaluation_memoization
+        return yield
+      end
+
       if key != nil
         method_hash = hash[method]
         unless method_hash