statsig 1.6.3 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9192f1c9886d3a3b18c0a2e70599e998b4784b23245e9064018ec31c98881b25
-  data.tar.gz: eb329d5f742ce2f77391f3f33ba4229852c2c68827643159b51fd870c1fb21d9
+  metadata.gz: 4268658d92961175796c877e357cc3cf18f40656cf8aa272034fd4953bdb641e
+  data.tar.gz: e0a62e60cdca3b8b7ef8fe0302032badb88f8b9b5d86635bf20f79dc7fc011da
 SHA512:
-  metadata.gz: e8a090dc289fe6994b08578b2d2884f9196f37f4104120c546dd11b3036bc939b84a343a643f15f8e12ca01a494f920206ee01a2302de5bcb71a94efb3048b76
-  data.tar.gz: 995f91cb599608d0691e8f598d7bc2aa50f0f1b652ad1fac83f3afdb9e950132e21a34aaee44c57797849fb99005cc9dea9d4664f3f4f0ba13afb75dd120c251
+  metadata.gz: e40a7d816b2c36ec211272bfa21e1bacb035ae7a6a9a1366eb4bae9b0af917f1694f66a1d35f146018b49be6c0df1ec07fe549612d3a49e54c69ffeeb7e3e733
+  data.tar.gz: a53f398b7574bdaa47f26b5dcda0d2e11f83fbc85401b071592198ae24b59dbaec21cc74ec04f102ad909a06aeb0f552be1a49838241b035a2153b81c3250c04

data/lib/evaluation_helpers.rb

@@ -2,7 +2,7 @@ require 'time'
 
 module EvaluationHelpers
   def self.compare_numbers(a, b, func)
-    return false unless self.is_numeric(a) && self.is_numeric(b)
+    return false unless is_numeric(a) && is_numeric(b)
     func.call(a.to_f, b.to_f) rescue false
   end
 
@@ -15,8 +15,8 @@ module EvaluationHelpers
 
   def self.compare_times(a, b, func)
     begin
-      time_1 = self.get_epoch_time(a)
-      time_2 = self.get_epoch_time(b)
+      time_1 = get_epoch_time(a)
+      time_2 = get_epoch_time(b)
       func.call(time_1, time_2)
     rescue
       false
@@ -30,7 +30,7 @@ module EvaluationHelpers
   end
 
   def self.get_epoch_time(v)
-    time = self.is_numeric(v) ? Time.at(v.to_f) : Time.parse(v)
+    time = is_numeric(v) ? Time.at(v.to_f) : Time.parse(v)
     if time.year > Time.now.year + 100
       # divide by 1000 when the epoch time is in milliseconds instead of seconds
       return time.to_i / 1000

data/lib/evaluator.rb

@@ -11,36 +11,41 @@ $fetch_from_server = :fetch_from_server
 $type_dynamic_config = 'dynamic_config'
 
 class Evaluator
-  def initialize(store)
-    @spec_store = store
-    @initialized = true
+  def initialize(network, error_callback)
+    @spec_store = SpecStore.new(network, error_callback)
     @ua_parser = UserAgentParser::Parser.new
     CountryLookup.initialize
+    @initialized = true
   end
 
   def check_gate(user, gate_name)
     return nil unless @initialized && @spec_store.has_gate?(gate_name)
-    self.eval_spec(user, @spec_store.get_gate(gate_name))
+    eval_spec(user, @spec_store.get_gate(gate_name))
   end
 
   def get_config(user, config_name)
     return nil unless @initialized && @spec_store.has_config?(config_name)
-    self.eval_spec(user, @spec_store.get_config(config_name))
+    eval_spec(user, @spec_store.get_config(config_name))
+  end
+
+  def shutdown
+    @spec_store.shutdown
   end
 
   private
 
   def eval_spec(user, config)
+    default_rule_id = 'default'
+    exposures = []
     if config['enabled']
-      exposures = []
       i = 0
       until i >= config['rules'].length do
         rule = config['rules'][i]
-        result = self.eval_rule(user, rule)
+        result = eval_rule(user, rule)
         return $fetch_from_server if result == $fetch_from_server
-        exposures = exposures + result["exposures"] if result["exposures"].is_a? Array
+        exposures = exposures + result['exposures'] if result['exposures'].is_a? Array
         if result['value']
-          pass = self.eval_pass_percent(user, rule, config['salt'])
+          pass = eval_pass_percent(user, rule, config['salt'])
           return ConfigResult.new(
             config['name'],
             pass,
@@ -52,9 +57,11 @@ class Evaluator
 
         i += 1
       end
+    else
+      default_rule_id = 'disabled'
     end
 
-    ConfigResult.new(config['name'], false, config['defaultValue'], 'default', [])
+    ConfigResult.new(config['name'], false, config['defaultValue'], default_rule_id, exposures)
   end
 
   def eval_rule(user, rule)
@@ -62,20 +69,20 @@ class Evaluator
     pass = true
     i = 0
     until i >= rule['conditions'].length do
-      result = self.eval_condition(user, rule['conditions'][i])
+      result = eval_condition(user, rule['conditions'][i])
       if result == $fetch_from_server
         return $fetch_from_server
       end
 
       if result.is_a?(Hash)
-        exposures = exposures + result["exposures"] if result["exposures"].is_a? Array
-        pass = false if result["value"] == false
+        exposures = exposures + result['exposures'] if result['exposures'].is_a? Array
+        pass = false if result['value'] == false
       elsif result == false
         pass = false
       end
       i += 1
     end
-    { "value" => pass, "exposures" => exposures }
+    { 'value' => pass, 'exposures' => exposures }
   end
 
   def eval_condition(user, condition)
@@ -86,6 +93,7 @@ class Evaluator
     operator = condition['operator']
     additional_values = condition['additionalValues']
     additional_values = Hash.new unless additional_values.is_a? Hash
+    idType = condition['idType']
 
     return $fetch_from_server unless type.is_a? String
     type = type.downcase
@@ -94,19 +102,19 @@ class Evaluator
     when 'public'
       return true
     when 'fail_gate', 'pass_gate'
-      other_gate_result = self.check_gate(user, target)
+      other_gate_result = check_gate(user, target)
       return $fetch_from_server if other_gate_result == $fetch_from_server
 
       gate_value = other_gate_result&.gate_value == true
       new_exposure = {
-        "gate" => target,
-        "gateValue" => gate_value ? "true" : "false",
-        "ruleID" => other_gate_result&.rule_id
+        'gate' => target,
+        'gateValue' => gate_value ? 'true' : 'false',
+        'ruleID' => other_gate_result&.rule_id
       }
       exposures = other_gate_result&.secondary_exposures&.append(new_exposure)
       return {
-        "value" => type == 'pass_gate' ? gate_value : !gate_value,
-        "exposures" => exposures
+        'value' => type == 'pass_gate' ? gate_value : !gate_value,
+        'exposures' => exposures
       }
     when 'ip_based'
       value = get_value_from_user(user, field) || get_value_from_ip(user, field)
@@ -123,12 +131,14 @@ class Evaluator
     when 'user_bucket'
       begin
         salt = additional_values['salt']
-        user_id = user.user_id || ''
+        unit_id = get_unit_id(user, idType) || ''
         # there are only 1000 user buckets as opposed to 10k for gate pass %
-        value = compute_user_hash("#{salt}.#{user_id}") % 1000
+        value = compute_user_hash("#{salt}.#{unit_id}") % 1000
       rescue
         return false
       end
+    when 'unit_id'
+      value = get_unit_id(user, idType)
     else
       return $fetch_from_server
     end
@@ -194,6 +204,17 @@ class Evaluator
       return EvaluationHelpers::compare_times(value, target, ->(a, b) { a > b })
     when 'on'
       return EvaluationHelpers::compare_times(value, target, ->(a, b) { a.year == b.year && a.month == b.month && a.day == b.day })
+    when 'in_segment_list', 'not_in_segment_list'
+      begin
+      id_list = (@spec_store.get_id_list(target) || {:ids => {}})[:ids]
+      hashed_id = Digest::SHA256.base64digest(value.to_s)[0, 8]    
+      is_in_list = id_list.is_a?(Hash) && id_list[hashed_id] == true
+      
+      return is_in_list if operator == 'in_segment_list'
+      return !is_in_list
+      rescue StandardError => e
+        return false
+      end
     else
       return $fetch_from_server
     end
@@ -265,15 +286,23 @@ class Evaluator
   def eval_pass_percent(user, rule, config_salt)
     return false unless config_salt.is_a?(String) && !rule['passPercentage'].nil?
     begin
-      user_id = user.user_id || ''
+      unit_id = get_unit_id(user, rule['id_type']) || ''
       rule_salt = rule['salt'] || rule['id'] || ''
-      hash = compute_user_hash("#{config_salt}.#{rule_salt}.#{user_id}")
+      hash = compute_user_hash("#{config_salt}.#{rule_salt}.#{unit_id}")
       return (hash % 10000) < (rule['passPercentage'].to_f * 100)
     rescue
       return false
     end
   end
 
+  def get_unit_id(user, id_type)
+    if id_type.is_a?(String) && id_type.downcase != 'userid'
+      return nil unless user&.custom_ids.is_a? Hash
+      return user.custom_ids[id_type] || user.custom_ids[id_type.downcase]
+    end
+    user.user_id
+  end
+
   def compute_user_hash(user_hash)
     Digest::SHA256.digest(user_hash).unpack('Q>')[0]
   end

data/lib/network.rb

@@ -12,7 +12,6 @@ class Network
     end
     @server_secret = server_secret
     @api = api
-    @last_sync_time = 0
     @backoff_multiplier = backoff_mult
   end
 
@@ -24,14 +23,14 @@ class Network
       }).accept(:json)
     begin
       res = http.post(@api + endpoint, body: body)
-    rescue
+    rescue StandardError => e
       ## network error retry
-      return nil unless retries > 0
+      return nil, e unless retries > 0
       sleep backoff
       return post_helper(endpoint, body, retries - 1, backoff * @backoff_multiplier)
     end
-    return res unless !res.status.success?
-    return nil unless retries > 0 && $retry_codes.include?(res.code)
+    return res, nil unless !res.status.success?
+    return nil, StandardError.new("Got an exception when making request to #{@api + endpoint}: #{res.to_s}") unless retries > 0 && $retry_codes.include?(res.code)
     ## status code retry
     sleep backoff
     post_helper(endpoint, body, retries - 1, backoff * @backoff_multiplier)
@@ -40,7 +39,7 @@ class Network
   def check_gate(user, gate_name)
     begin
       request_body = JSON.generate({'user' => user&.serialize(false), 'gateName' => gate_name})
-      response = post_helper('check_gate', request_body)
+      response, _ = post_helper('check_gate', request_body)
       return JSON.parse(response.body) unless response.nil?
       false
     rescue
@@ -51,7 +50,7 @@ class Network
   def get_config(user, dynamic_config_name)
     begin
       request_body = JSON.generate({'user' => user&.serialize(false), 'configName' => dynamic_config_name})
-      response = post_helper('get_config', request_body)
+      response, _ = post_helper('get_config', request_body)
       return JSON.parse(response.body) unless response.nil?
       nil
     rescue
@@ -59,33 +58,9 @@ class Network
     end
   end
 
-  def download_config_specs
-    begin
-      response = post_helper('download_config_specs', JSON.generate({'sinceTime' => @last_sync_time}))
-      return nil unless !response.nil?
-      json_body = JSON.parse(response.body)
-      @last_sync_time = json_body['time']
-      return json_body
-    rescue
-      return nil
-    end
-  end
-
-  def poll_for_changes(callback)
-    Thread.new do
-      loop do
-        sleep 10
-        specs = download_config_specs
-        unless specs.nil?
-          callback.call(specs)
-        end
-      end
-    end
-  end
-
-  def post_logs(events, statsig_metadata)
+  def post_logs(events)
     begin
-      json_body = JSON.generate({'events' => events, 'statsigMetadata' => statsig_metadata})
+      json_body = JSON.generate({'events' => events, 'statsigMetadata' => Statsig.get_statsig_metadata})
       post_helper('log_event', json_body, retries: 5)
     rescue
     end

data/lib/spec_store.rb

@@ -2,40 +2,35 @@ require 'net/http'
 require 'uri'
 
 class SpecStore
-  def initialize(specs_json)
+  def initialize(network, error_callback = nil, config_sync_interval = 10, id_lists_sync_interval = 60)
+    @network = network
     @last_sync_time = 0
+    @config_sync_interval = config_sync_interval
+    @id_lists_sync_interval = id_lists_sync_interval
     @store = {
       :gates => {},
       :configs => {},
+      :id_lists => {},
     }
-    process(specs_json)
-  end
-
-  def process(specs_json)
-    if specs_json.nil?
-      return
-    end
+    e = download_config_specs
+    error_callback.call(e) unless error_callback.nil?
+    download_id_lists
 
-    @last_sync_time = specs_json['time'] || @last_sync_time
-    return unless specs_json['has_updates'] == true &&
-      !specs_json['feature_gates'].nil? &&
-      !specs_json['dynamic_configs'].nil?
-
-    @store = {
-      :gates => {},
-      :configs => {},
-    }
+    @config_sync_thread = sync_config_specs
+    @id_lists_sync_thread = sync_id_lists
+  end
 
-    specs_json['feature_gates'].map{|gate|  @store[:gates][gate['name']] = gate }
-    specs_json['dynamic_configs'].map{|config|  @store[:configs][config['name']] = config }
+  def shutdown
+    @config_sync_thread&.exit
+    @id_lists_sync_thread&.exit
   end
 
   def has_gate?(gate_name)
-    return @store[:gates].key?(gate_name)
+    @store[:gates].key?(gate_name)
   end
 
   def has_config?(config_name)
-    return @store[:configs].key?(config_name)
+    @store[:configs].key?(config_name)
   end
 
   def get_gate(gate_name)
@@ -48,4 +43,108 @@ class SpecStore
     @store[:configs][config_name]
   end
 
+  def get_id_list(list_name)
+    @store[:id_lists][list_name]
+  end
+
+  private
+
+  def sync_config_specs
+    Thread.new do
+      loop do
+        sleep @config_sync_interval
+        download_config_specs
+      end
+    end
+  end
+
+  def sync_id_lists
+    Thread.new do
+      loop do
+        sleep @id_lists_sync_interval
+        download_id_lists
+      end
+    end
+  end
+
+  def download_config_specs
+    begin
+      response, e = @network.post_helper('download_config_specs', JSON.generate({'sinceTime' => @last_sync_time}))
+      if e.nil?
+        process(JSON.parse(response.body))
+      else
+        e
+      end
+    rescue StandardError => e
+      e
+    end
+  end
+
+  def process(specs_json)
+    if specs_json.nil?
+      return
+    end
+
+    @last_sync_time = specs_json['time'] || @last_sync_time
+    return unless specs_json['has_updates'] == true &&
+      !specs_json['feature_gates'].nil? &&
+      !specs_json['dynamic_configs'].nil?
+
+    new_gates = {}
+    new_configs = {}
+
+    specs_json['feature_gates'].map{|gate|  new_gates[gate['name']] = gate }
+    specs_json['dynamic_configs'].map{|config|  new_configs[config['name']] = config }
+    @store[:gates] = new_gates
+    @store[:configs] = new_configs
+
+    new_id_lists = specs_json['id_lists']
+    if new_id_lists.is_a? Hash
+      new_id_lists.each do |list_name, _|
+        unless @store[:id_lists].key?(list_name)
+          @store[:id_lists][list_name] = { :ids => {}, :time => 0 }
+        end
+      end
+
+      @store[:id_lists].each do |list_name, _|
+        unless new_id_lists.key?(list_name)
+          @store[:id_lists].delete(list_name)
+        end
+      end
+    end
+  end
+
+  def download_id_lists
+    if @store[:id_lists].is_a? Hash
+      threads = []
+      id_lists = @store[:id_lists]
+      id_lists.each do |list_name, list|
+        threads << Thread.new do
+          response, e = @network.post_helper('download_id_list', JSON.generate({'listName' => list_name, 'statsigMetadata' => Statsig.get_statsig_metadata, 'sinceTime' => list['time'] || 0 }))
+          if e.nil? && !response.nil?
+            begin
+              data = JSON.parse(response)
+              if data['add_ids'].is_a? Array
+                data['add_ids'].each do |id|
+                  list[:ids][id] = true
+                end
+              end
+              if data['remove_ids'].is_a? Array
+                data['remove_ids'].each do |id|
+                  list[:ids]&.delete(id)
+                end
+              end
+              if data['time'].is_a? Numeric
+                list[:time] = data['time']
+              end
+            rescue
+              # Ignored
+            end
+          end
+        end
+      end
+      threads.each(&:join)
+    end
+  end
+
 end

data/lib/statsig.rb

@@ -1,32 +1,32 @@
 require 'statsig_driver'
 
 module Statsig
-  def self.initialize(secret_key, options = nil)
+  def self.initialize(secret_key, options = nil, error_callback = nil)
     unless @shared_instance.nil?
       puts 'Statsig already initialized.'
       return @shared_instance
     end
 
-    @shared_instance = StatsigDriver.new(secret_key, options)
+    @shared_instance = StatsigDriver.new(secret_key, options, error_callback)
   end
 
   def self.check_gate(user, gate_name)
-    self.ensure_initialized
+    ensure_initialized
     @shared_instance&.check_gate(user, gate_name)
   end
 
   def self.get_config(user, dynamic_config_name)
-    self.ensure_initialized
+    ensure_initialized
     @shared_instance&.get_config(user, dynamic_config_name)
   end
 
   def self.get_experiment(user, experiment_name)
-    self.ensure_initialized
+    ensure_initialized
     @shared_instance&.get_config(user, experiment_name)
   end
 
   def self.log_event(user, event_name, value, metadata)
-    self.ensure_initialized
+    ensure_initialized
     @shared_instance&.log_event(user, event_name, value, metadata)
   end
 
@@ -37,6 +37,13 @@ module Statsig
     @shared_instance = nil
   end
 
+  def self.get_statsig_metadata
+    {
+      'sdkType' => 'ruby-server',
+      'sdkVersion' => '1.8.0',
+    }
+  end
+
   private
 
   def self.ensure_initialized

data/lib/statsig_driver.rb

@@ -8,7 +8,7 @@ require 'statsig_user'
 require 'spec_store'
 
 class StatsigDriver
-  def initialize(secret_key, options = nil)
+  def initialize(secret_key, options = nil, error_callback = nil)
     super()
     if !secret_key.is_a?(String) || !secret_key.start_with?('secret-')
       raise 'Invalid secret key provided. Provide your project secret key from the Statsig console'
@@ -17,25 +17,12 @@ class StatsigDriver
       raise 'Invalid options provided. Either provide a valid StatsigOptions object or nil'
     end
 
-    @options = options || StatsigOptions.new()
+    @options = options || StatsigOptions.new
     @shutdown = false
     @secret_key = secret_key
     @net = Network.new(secret_key, @options.api_url_base)
-    @statsig_metadata = {
-      'sdkType' => 'ruby-server',
-      'sdkVersion' => Gem::Specification::load('statsig.gemspec')&.version,
-    }
-    @logger = StatsigLogger.new(@net, @statsig_metadata)
-
-    downloaded_specs = @net.download_config_specs
-    unless downloaded_specs.nil?
-      @initialized = true
-    end
-
-    @store = SpecStore.new(downloaded_specs)
-    @evaluator = Evaluator.new(@store)
-
-    @polling_thread = @net.poll_for_changes(-> (config_specs) { @store.process(config_specs) })
+    @logger = StatsigLogger.new(@net)
+    @evaluator = Evaluator.new(@net, error_callback)
   end
 
   def check_gate(user, gate_name)
@@ -45,9 +32,6 @@ class StatsigDriver
       raise 'Invalid gate_name provided'
     end
     check_shutdown
-    unless @initialized
-      return false
-    end
 
     res = @evaluator.check_gate(user, gate_name)
     if res.nil?
@@ -71,9 +55,6 @@ class StatsigDriver
       raise "Invalid dynamic_config_name provided"
     end
     check_shutdown
-    unless @initialized
-      return DynamicConfig.new(dynamic_config_name)
-    end
 
     res = @evaluator.get_config(user, dynamic_config_name)
     if res.nil?
@@ -109,14 +90,14 @@ class StatsigDriver
     event.user = user
     event.value = value
     event.metadata = metadata
-    event.statsig_metadata = @statsig_metadata
+    event.statsig_metadata = Statsig.get_statsig_metadata
     @logger.log_event(event)
   end
 
   def shutdown
     @shutdown = true
     @logger.flush(true)
-    @polling_thread&.exit
+    @evaluator.shutdown
   end
 
   private

data/lib/statsig_logger.rb

@@ -4,9 +4,8 @@ $gate_exposure_event = 'statsig::gate_exposure'
 $config_exposure_event = 'statsig::config_exposure'
 
 class StatsigLogger
-  def initialize(network, statsig_metadata)
+  def initialize(network)
     @network = network
-    @statsig_metadata = statsig_metadata
     @events = []
     @background_flush = Thread.new do
       sleep 60
@@ -29,7 +28,7 @@ class StatsigLogger
       'gateValue' => value.to_s,
       'ruleID' => rule_id
     }
-    event.statsig_metadata = @statsig_metadata
+    event.statsig_metadata = Statsig.get_statsig_metadata
     event.secondary_exposures = secondary_exposures.is_a?(Array) ? secondary_exposures : []
     log_event(event)
   end
@@ -41,7 +40,7 @@ class StatsigLogger
       'config' => config_name,
       'ruleID' => rule_id
     }
-    event.statsig_metadata = @statsig_metadata
+    event.statsig_metadata = Statsig.get_statsig_metadata
     event.secondary_exposures = secondary_exposures.is_a?(Array) ? secondary_exposures : []
     log_event(event)
   end
@@ -56,6 +55,6 @@ class StatsigLogger
     flush_events = @events.map { |e| e.serialize }
     @events = []
 
-    @network.post_logs(flush_events, @statsig_metadata)
+    @network.post_logs(flush_events)
   end
 end

data/lib/statsig_user.rb

@@ -7,6 +7,7 @@ class StatsigUser
   attr_accessor :locale
   attr_accessor :app_version
   attr_accessor :statsig_environment
+  attr_accessor :custom_ids
   attr_accessor :private_attributes
 
   def custom
@@ -28,9 +29,11 @@ class StatsigUser
       @country = user_hash['country']
       @locale = user_hash['locale']
       @app_version = user_hash['appVersion'] || user_hash['app_version']
-      @custom = user_hash['custom']
+      @custom = user_hash['custom'] if user_hash['custom'].is_a? Hash
       @statsig_environment = user_hash['statsigEnvironment']
-      @private_attributes = user_hash['privateAttributes']
+      @private_attributes = user_hash['privateAttributes'] if user_hash['privateAttributes'].is_a? Hash
+      custom_ids = user_hash['customIDs'] || user_hash['custom_ids']
+      @custom_ids = custom_ids if custom_ids.is_a? Hash
     end
   end
 
@@ -46,6 +49,7 @@ class StatsigUser
       'custom' => @custom,
       'statsigEnvironment' => @statsig_environment,
       'privateAttributes' => @private_attributes,
+      'customIDs' => @custom_ids,
     }
     if for_logging
       hash.delete('privateAttributes')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statsig
 version: !ruby/object:Gem::Version
-  version: 1.6.3
+  version: 1.8.0
 platform: ruby
 authors:
 - Statsig, Inc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-22 00:00:00.000000000 Z
+date: 2021-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler