statsig 1.34.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c2aff544b63f731dd32e2d2a498f83b91b66222f42d507f7ad483ce11b8cadf
-  data.tar.gz: f7c1ec377a7ff7861696cb250817262bf999c8ba81904e6ed663a6e40fee9da0
+  metadata.gz: 27afba91b3e46ea8661d399ef0dc2696c6372bb214dbb993ea986e5b456edb7e
+  data.tar.gz: c06043637e4ce2ae3bbdef95ccc8a0713717b04e8149b46a0f70da502aa729db
 SHA512:
-  metadata.gz: 1d42a4f31466ad9598bfa6e9fc59d768fe3821345ff2b1964385fef7a32a480819937994443145bb9b900c6a404611c69a80bc0399fd72c62b726a08a800dd05
-  data.tar.gz: d6b3a2d232962779a8ab5de1d380bc89b28c64ee2ea5ca22c6d140a563cd096f9c5a965de712592d7c72007cf65c9bb853b86e0eaa86c78e49f4207395149759
+  metadata.gz: ac429df53886c94abbd1b801adb96a8bab92e6c8c73aa4f910a2a505b5a3bf65ba3d3b844cca6014f6dbac0b17ce05d7a967d5fde260f0bc6f3021e60c84e8af
+  data.tar.gz: 14d9c181b6093d56ca7bba00873ff1806cc063ac43608d9ff3cde9e2396423faf58fe50b4096ac4faf7806bcfaec4c946c325f9be20a83b4f311e521162958bb

data/lib/api_config.rb

@@ -2,144 +2,3 @@ require 'constants'
 
 class UnsupportedConfigException < StandardError
 end
-
-module Statsig
-  class APIConfig
-    attr_accessor :name, :type, :is_active, :salt, :default_value, :enabled,
-                  :rules, :id_type, :entity, :explicit_parameters, :has_shared_params, :target_app_ids
-
-    def self.from_json(json)
-      new(
-        name: json[:name],
-        type: json[:type],
-        is_active: json[:isActive],
-        salt: json[:salt],
-        default_value: json[:defaultValue] || {},
-        enabled: json[:enabled],
-        rules: json[:rules]&.map do |rule|
-          APIRule.from_json(rule)
-        end,
-        id_type: json[:idType],
-        entity: json[:entity],
-        explicit_parameters: json[:explicitParameters],
-        has_shared_params: json[:hasSharedParams],
-        target_app_ids: json[:targetAppIDs]
-      )
-    end
-
-    private
-
-    def initialize(name:, type:, is_active:, salt:, default_value:, enabled:, rules:, id_type:, entity:,
-                   explicit_parameters: nil, has_shared_params: nil, target_app_ids: nil)
-      @name = name
-      @type = type.to_sym unless type.nil?
-      @is_active = is_active
-      @salt = salt
-      @default_value = JSON.parse(JSON.generate(default_value))
-      @enabled = enabled
-      @rules = rules
-      @id_type = id_type
-      @entity = entity.to_sym unless entity.nil?
-      @explicit_parameters = explicit_parameters
-      @has_shared_params = has_shared_params
-      @target_app_ids = target_app_ids
-    end
-  end
-
-  class APIRule
-
-    attr_accessor :name, :pass_percentage, :return_value, :id, :salt,
-                  :conditions, :id_type, :group_name, :config_delegate, :is_experiment_group
-
-    def self.from_json(json)
-      new(
-        name: json[:name],
-        pass_percentage: json[:passPercentage],
-        return_value: json[:returnValue] || {},
-        id: json[:id],
-        salt: json[:salt],
-        conditions: json[:conditions]&.map do |condition|
-          APICondition.from_json(condition)
-        end,
-        id_type: json[:idType],
-        group_name: json[:groupName],
-        config_delegate: json[:configDelegate],
-        is_experiment_group: json[:isExperimentGroup]
-      )
-    end
-
-    private
-
-    def initialize(name:, pass_percentage:, return_value:, id:, salt:, conditions:, id_type:,
-                   group_name: nil, config_delegate: nil, is_experiment_group: nil)
-      @name = name
-      @pass_percentage = pass_percentage.to_f
-      @return_value = JSON.parse(JSON.generate(return_value))
-      @id = id
-      @salt = salt
-      @conditions = conditions
-      @id_type = id_type
-      @group_name = group_name
-      @config_delegate = config_delegate
-      @is_experiment_group = is_experiment_group
-    end
-  end
-
-  class APICondition
-
-    attr_accessor :type, :target_value, :operator, :field, :additional_values, :id_type, :hash
-    def self.from_json(json)
-      hash = Statsig::HashUtils.md5(json.to_s).to_sym
-      return Statsig::Memo.for_global(:api_condition_from_json, hash) do
-        operator = json[:operator]
-        unless operator.nil?
-          operator = operator&.downcase&.to_sym
-          unless Const::SUPPORTED_OPERATORS.include?(operator)
-            raise UnsupportedConfigException
-          end
-        end
-
-        type = json[:type]
-        unless type.nil?
-          type = type&.downcase&.to_sym
-          unless Const::SUPPORTED_CONDITION_TYPES.include?(type)
-            raise UnsupportedConfigException
-          end
-        end
-
-        new(
-          type: json[:type],
-          target_value: json[:targetValue],
-          operator: json[:operator],
-          field: json[:field],
-          additional_values: json[:additionalValues],
-          id_type: json[:idType],
-          hash: hash
-        )
-      end
-    end
-
-    private
-
-    def initialize(type:, target_value:, operator:, field:, additional_values:, id_type:, hash:)
-      @hash = hash
-      
-      @type = type.to_sym unless type.nil?
-      if operator == "any_case_sensitive" || operator == "none_case_sensitive"
-        if target_value.is_a?(Array)
-            target_value = target_value.map { |item| [item.to_s, true] }.to_h
-        end
-      end
-      if operator == "any" || operator == "none"
-        if target_value.is_a?(Array)
-            target_value = target_value.map { |item| [item.to_s.downcase, true] }.to_h
-        end
-      end
-      @target_value = target_value
-      @operator = operator.to_sym unless operator.nil?
-      @field = field
-      @additional_values = additional_values || {}
-      @id_type = id_type
-    end
-  end
-end

data/lib/client_initialize_helpers.rb

@@ -14,7 +14,13 @@ module Statsig
       include_local_overrides: false
     )
       result = {}
+      target_app_id = evaluator.spec_store.get_app_id_for_sdk_key(client_sdk_key)
       entities.each do |name, spec|
+        config_target_apps = spec[:targetAppIDs]
+
+        unless target_app_id.nil? || (!config_target_apps.nil? && config_target_apps.include?(target_app_id))
+          next
+        end
         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
@@ -25,25 +31,18 @@ module Statsig
     end
 
     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
-
-      unless target_app_id.nil? || (!config_target_apps.nil? && config_target_apps.include?(target_app_id))
-        return nil
-      end
-
-      category = config_spec.type
-      entity_type = config_spec.entity
-      if entity_type == :segment || entity_type == :holdout
+      config_name_str = config_name.to_s
+      category = config_spec[:type]
+      entity_type = config_spec[:entity]
+      if entity_type == Const::TYPE_SEGMENT || entity_type == Const::TYPE_HOLDOUT
         return nil
       end
 
       if include_local_overrides
         case category
-        when :feature_gate
+        when Const::TYPE_FEATURE_GATE
           local_override = evaluator.lookup_gate_override(config_name)
-        when :dynamic_config
+        when Const::TYPE_DYNAMIC_CONFIG
           local_override = evaluator.lookup_config_override(config_name)
         end
       end
@@ -54,7 +53,7 @@ module Statsig
           disable_evaluation_details: true,
           disable_exposures: !include_exposures
         )
-        evaluator.eval_spec(user, config_spec, eval_result)
+        evaluator.eval_spec(config_name_str, user, config_spec, eval_result)
       else
         eval_result = local_override
       end
@@ -67,10 +66,10 @@ module Statsig
       end
 
       case category
-      when :feature_gate
+      when Const::TYPE_FEATURE_GATE
         result[:value] = eval_result.gate_value
-      when :dynamic_config
-        id_type = config_spec.id_type
+      when Const::TYPE_DYNAMIC_CONFIG
+        id_type = config_spec[:idType]
         result[:value] = eval_result.json_value
         result[:group] = eval_result.rule_id
         result[:is_device_based] = id_type.is_a?(String) && id_type.downcase == Statsig::Const::STABLEID
@@ -78,16 +77,16 @@ module Statsig
         return nil
       end
 
-      if entity_type == :experiment
+      if entity_type == Const::TYPE_EXPERIMENT
         populate_experiment_fields(name, config_spec, eval_result, result, evaluator)
       end
 
-      if entity_type == :layer
+      if entity_type == Const::TYPE_LAYER
         populate_layer_fields(config_spec, eval_result, result, evaluator, hash_algo, include_exposures)
         result.delete(:id_type) # not exposed for layer configs in /initialize
       end
 
-      hashed_name = hash_name(config_name, hash_algo)
+      hashed_name = hash_name(config_name_str, hash_algo)
 
       result[:name] = hashed_name
       result[:rule_id] = eval_result.rule_id
@@ -101,14 +100,14 @@ module Statsig
 
     def self.populate_experiment_fields(config_name, config_spec, eval_result, result, evaluator)
       result[:is_user_in_experiment] = eval_result.is_experiment_group
-      result[:is_experiment_active] = config_spec.is_active == true
+      result[:is_experiment_active] = config_spec[:isActive] == true
 
-      if config_spec.has_shared_params != true
+      if config_spec[:hasSharedParams] != true
         return
       end
 
       result[:is_in_layer] = true
-      result[:explicit_parameters] = config_spec.explicit_parameters || []
+      result[:explicit_parameters] = config_spec[:explicitParameters] || []
 
       layer_name = evaluator.spec_store.experiment_to_layer[config_name]
       if layer_name.nil? || evaluator.spec_store.layers[layer_name].nil?
@@ -121,15 +120,15 @@ module Statsig
 
     def self.populate_layer_fields(config_spec, eval_result, result, evaluator, hash_algo, include_exposures)
       delegate = eval_result.config_delegate
-      result[:explicit_parameters] = config_spec.explicit_parameters || []
+      result[:explicit_parameters] = config_spec[:explicitParameters] || []
 
       if delegate.nil? == false && delegate.empty? == false
-        delegate_spec = evaluator.spec_store.configs[delegate]
+        delegate_spec = evaluator.spec_store.configs[delegate.to_sym]
 
         result[:allocated_experiment_name] = hash_name(delegate, hash_algo)
         result[:is_user_in_experiment] = eval_result.is_experiment_group
-        result[:is_experiment_active] = delegate_spec.is_active == true
-        result[:explicit_parameters] = delegate_spec.explicit_parameters || []
+        result[:is_experiment_active] = delegate_spec[:isActive] == true
+        result[:explicit_parameters] = delegate_spec[:explicitParameters] || []
       end
 
       if include_exposures

data/lib/constants.rb

@@ -47,6 +47,12 @@ module Statsig
     USER_ID = 'user_id'.freeze
     USERAGENT = 'useragent'.freeze
     USERID = 'userid'.freeze
+    DICTIONARY = 'dictionary'.freeze
+    SEGMENT_PREFIX = 'segment:'.freeze
+
+    DYNAMIC_CONFIG_NAME = 'dynamic_config_name'.freeze
+    EXPERIMENT_NAME = 'experiment_name'.freeze
+    LAYER_NAME = 'layer_name'.freeze
 
     # Persisted Evaluations
     GATE_VALUE = 'gate_value'.freeze
@@ -58,5 +64,64 @@ module Statsig
     TARGET_APP_IDS = 'target_app_ids'.freeze
     CONFIG_SYNC_TIME = 'config_sync_time'.freeze
     INIT_TIME = 'init_time'.freeze
+
+    # Spec Types
+    TYPE_FEATURE_GATE = 'feature_gate'.freeze
+    TYPE_SEGMENT = 'segment'.freeze
+    TYPE_HOLDOUT = 'holdout'.freeze
+    TYPE_EXPERIMENT = 'experiment'.freeze
+    TYPE_LAYER = 'layer'.freeze
+    TYPE_DYNAMIC_CONFIG = 'dynamic_config'.freeze
+    TYPE_AUTOTUNE = 'autotune'.freeze
+
+    # API Conditions
+    CND_PUBLIC = 'public'.freeze
+    CND_IP_BASED = 'ip_based'.freeze
+    CND_UA_BASED = 'ua_based'.freeze
+    CND_USER_FIELD = 'user_field'.freeze
+    CND_PASS_GATE = 'pass_gate'.freeze
+    CND_FAIL_GATE = 'fail_gate'.freeze
+    CND_MULTI_PASS_GATE = 'multi_pass_gate'.freeze
+    CND_MULTI_FAIL_GATE = 'multi_fail_gate'.freeze
+    CND_CURRENT_TIME = 'current_time'.freeze
+    CND_ENVIRONMENT_FIELD = 'environment_field'.freeze
+    CND_USER_BUCKET = 'user_bucket'.freeze
+    CND_UNIT_ID = 'unit_id'.freeze
+
+    # API Operators
+    OP_GREATER_THAN = 'gt'.freeze
+    OP_GREATER_THAN_OR_EQUAL = 'gte'.freeze
+    OP_LESS_THAN = 'lt'.freeze
+    OP_LESS_THAN_OR_EQUAL = 'lte'.freeze
+    OP_ANY = 'any'.freeze
+    OP_NONE = 'none'.freeze
+    OP_ANY_CASE_SENSITIVE = 'any_case_sensitive'.freeze
+    OP_NONE_CASE_SENSITIVE = 'none_case_sensitive'.freeze
+    OP_EQUAL = 'eq'.freeze
+    OP_NOT_EQUAL = 'neq'.freeze
+
+    # API Operators (Version)
+    OP_VERSION_GREATER_THAN = 'version_gt'.freeze
+    OP_VERSION_GREATER_THAN_OR_EQUAL = 'version_gte'.freeze
+    OP_VERSION_LESS_THAN = 'version_lt'.freeze
+    OP_VERSION_LESS_THAN_OR_EQUAL = 'version_lte'.freeze
+    OP_VERSION_EQUAL = 'version_eq'.freeze
+    OP_VERSION_NOT_EQUAL = 'version_neq'.freeze
+
+    # API Operators (String)
+    OP_STR_STARTS_WITH_ANY = 'str_starts_with_any'.freeze
+    OP_STR_END_WITH_ANY = 'str_ends_with_any'.freeze
+    OP_STR_CONTAINS_ANY = 'str_contains_any'.freeze
+    OP_STR_CONTAINS_NONE = 'str_contains_none'.freeze
+    OP_STR_MATCHES = 'str_matches'.freeze
+
+    # API Operators (Time)
+    OP_BEFORE = 'before'.freeze
+    OP_AFTER = 'after'.freeze
+    OP_ON = 'on'.freeze
+
+    # API Operators (Segments)
+    OP_IN_SEGMENT_LIST = 'in_segment_list'.freeze
+    OP_NOT_IN_SEGMENT_LIST = 'not_in_segment_list'.freeze
   end
 end

data/lib/dynamic_config.rb

@@ -33,8 +33,12 @@ class DynamicConfig
   # @param index The name of parameter being fetched
   # @param default_value The fallback value if the name cannot be found
   def get(index, default_value)
-    return default_value if @value.nil? || !@value.key?(index)
-    @value[index]
+    return default_value if @value.nil?
+
+    index_sym = index.to_sym
+    return default_value unless @value.key?(index_sym)
+
+    @value[index_sym]
   end
 
   ##
@@ -44,8 +48,12 @@ class DynamicConfig
   # @param index The name of parameter being fetched
   # @param default_value The fallback value if the name cannot be found
   def get_typed(index, default_value)
-    return default_value if @value.nil? || !@value.key?(index)
-    return default_value if @value[index].class != default_value.class and default_value.class != TrueClass and default_value.class != FalseClass
-    @value[index]
+    return default_value if @value.nil?
+
+    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[index_sym]
   end
 end

data/lib/evaluation_helpers.rb

@@ -25,15 +25,26 @@ module EvaluationHelpers
   end
 
   def self.equal_string_in_array(array, value, ignore_case)
-    return false if array.nil?
+    if array.is_a?(Hash)
+      return array.has_key?(value.to_sym)
+    end
 
     str_value = value.to_s
     str_value_downcased = nil
 
-    if ignore_case
-      return array.has_key?(value.to_s.downcase)
-    else
-      return array.has_key?(value.to_s)
+    return false if array.nil?
+
+    return array.any? do |item|
+      next false if item.nil?
+      item_str = item.to_s
+
+      next false unless item_str.length == str_value.length
+
+      return true if item_str == str_value
+      next false unless ignore_case
+
+      str_value_downcased ||= str_value.downcase
+      item_str.downcase == str_value_downcased
     end
   end