statsig 1.2.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90f13c55a79aa919b94e633f69d39b3cb997a92cceec3e27bdb3e00e00e8e3ef
-  data.tar.gz: cd40c863516da1b3ff0730959ccbc3fa664afe0e613775f0369a1377ccc06123
+  metadata.gz: 8dfdb320cf540cd81046ba96aae19d9d3f947ec557ad7fb7b405a35065eb67fa
+  data.tar.gz: 0e8d15d9c3f9aa0245c2e834e55394479775d2a9de23208e54dfb41be89e0326
 SHA512:
-  metadata.gz: a4c73b125853c8128d5aa57a60acfe1e80a0aa8ffc9f1fdcd89ea74e9a6ac033c93262103850d0c13ec84052ca9b9a464627836a1af945e6100c036c0fbc1359
-  data.tar.gz: 86bf2fe76cdc5cdc29126bd188a33e746f2a143e56fce1cd2e7d5a242622acb4b3783694f01e11a6e8ce10c707bc38a57a055694e15c965ee584bb951c6acb0d
+  metadata.gz: e7a479f8ed9b2cbf49f4b567bdf16000b5ba23a88015593cec6e9806477419011a13b5ed64fd578208cec5f6633101c881e3fa0b98b0474a2faebc91aaf8be1e
+  data.tar.gz: d731197be16b7ef43d6c9060f00254b3db3a205bef736243a326a382e9fca1aa72b1335102612ab13c044a03f4dc247e0b3443badfad147dffdd8be8391a038d

data/lib/dynamic_config.rb

@@ -9,8 +9,8 @@ class DynamicConfig
     @rule_id = rule_id
   end
 
-  def get(index)
-    return nil if @value.nil?
-    value[index]
+  def get(index, default_value)
+    return default_value if @value.nil? || !@value.key?(index)
+    @value[index]
   end
 end

data/lib/evaluation_helpers.rb

@@ -6,19 +6,11 @@ module EvaluationHelpers
     func.call(a.to_f, b.to_f) rescue false
   end
 
-  # returns true if array contains value, ignoring case when comparing strings
-  def self.array_contains(array, value, ignore_case)
-    return false unless array.is_a?(Array) && !value.nil?
-    if value.is_a?(String) && match_string_in_array(array, value, ignore_case, ->(a, b) { a == b })
-      return true
-    end
-    return array.include?(value)
-  end
-
   # returns true if array has any element that evaluates to true with value using func lambda, ignoring case
   def self.match_string_in_array(array, value, ignore_case, func)
-    return false unless array.is_a?(Array) && value.is_a?(String)
-    array.any?{ |s| s.is_a?(String) && ((ignore_case && func.call(value.downcase, s.downcase)) || func.call(value, s)) } rescue false
+    return false unless array.is_a?(Array) && !value.nil?
+    str_value = value.to_s
+    array.any?{ |s| !s.nil? && ((ignore_case && func.call(str_value.downcase, s.to_s.downcase)) || func.call(str_value, s.to_s)) } rescue false
   end
 
   def self.compare_times(a, b, func)

data/lib/evaluator.rb

@@ -79,16 +79,15 @@ class Evaluator
     case type
     when 'public'
       return true
-    when 'fail_gate'
-    when 'pass_gate'
+    when 'fail_gate', 'pass_gate'
       other_gate_result = self.check_gate(user, target)
       return $fetch_from_server if other_gate_result == $fetch_from_server
       return type == 'pass_gate' ? other_gate_result.gate_value : !other_gate_result.gate_value
     when 'ip_based'
-      value = get_value_from_user(user, field) || get_value_from_ip(user&.value_lookup['ip'], field)
+      value = get_value_from_user(user, field) || get_value_from_ip(user, field)
       return $fetch_from_server if value == $fetch_from_server
     when 'ua_based'
-      value = get_value_from_user(user, field) || get_value_from_ua(user&.value_lookup['userAgent'], field)
+      value = get_value_from_user(user, field) || get_value_from_ua(user, field)
       return $fetch_from_server if value == $fetch_from_server
     when 'user_field'
       value = get_value_from_user(user, field)
@@ -109,10 +108,7 @@ class Evaluator
       return $fetch_from_server
     end
 
-    return $fetch_from_server if value == $fetch_from_server
-    return false if value.nil?
-
-    return $fetch_from_server unless operator.is_a?(String)
+    return $fetch_from_server if value == $fetch_from_server || !operator.is_a?(String)
     operator = operator.downcase
 
     case operator
@@ -142,13 +138,13 @@ class Evaluator
 
       # array operations
     when 'any'
-      return EvaluationHelpers::array_contains(target, value, true)
+      return EvaluationHelpers::match_string_in_array(target, value, true, ->(a, b) { a == b })
     when 'none'
-      return !EvaluationHelpers::array_contains(target, value, true)
+      return !EvaluationHelpers::match_string_in_array(target, value, true, ->(a, b) { a == b })
     when 'any_case_sensitive'
-      return EvaluationHelpers::array_contains(target, value, false)
+      return EvaluationHelpers::match_string_in_array(target, value, false, ->(a, b) { a == b })
     when 'none_case_sensitive'
-      return !EvaluationHelpers::array_contains(target, value, false)
+      return !EvaluationHelpers::match_string_in_array(target, value, false, ->(a, b) { a == b })
 
       #string
     when 'str_starts_with_any'
@@ -157,6 +153,8 @@ class Evaluator
       return EvaluationHelpers::match_string_in_array(target, value, true, ->(a, b) { a.end_with?(b) })
     when 'str_contains_any'
       return EvaluationHelpers::match_string_in_array(target, value, true, ->(a, b) { a.include?(b) })
+    when 'str_contains_none'
+      return !EvaluationHelpers::match_string_in_array(target, value, true, ->(a, b) { a.include?(b) })
     when 'str_matches'
       return (value.is_a?(String) && !(value =~ Regexp.new(target)).nil? rescue false)
     when 'eq'
@@ -181,13 +179,22 @@ class Evaluator
 
     user_lookup_table = user&.value_lookup
     return nil unless user_lookup_table.is_a?(Hash)
-    return user_lookup_table[field.downcase] if user_lookup_table.has_key?(field.downcase)
+    return user_lookup_table[field.downcase] if user_lookup_table.has_key?(field.downcase) && !user_lookup_table[field.downcase].nil?
 
     user_custom = user_lookup_table['custom']
-    return nil unless user_custom.is_a?(Hash)
-    user_custom.each do |key, value|
-      return value if key.downcase.casecmp?(field.downcase)
+    if user_custom.is_a?(Hash)
+      user_custom.each do |key, value|
+        return value if key.downcase.casecmp?(field.downcase) && !value.nil?
+      end
+    end
+
+    private_attributes = user_lookup_table['privateAttributes']
+    if private_attributes.is_a?(Hash)
+      private_attributes.each do |key, value|
+        return value if key.downcase.casecmp?(field.downcase) && !value.nil?
+      end
     end
+
     nil
   end
 
@@ -201,17 +208,19 @@ class Evaluator
     nil
   end
 
-  def get_value_from_ip(ip, field)
-    return nil unless ip.is_a?(String) && field.is_a?(String)
+  def get_value_from_ip(user, field)
+    return nil unless user.is_a?(StatsigUser) && field.is_a?(String) && field.downcase == 'country'
+    ip = get_value_from_user(user, 'ip')
+    return nil unless ip.is_a?(String)
 
-    if field.downcase != 'country'
-      return $fetch_from_server
-    end
     CountryLookup.lookup_ip_string(ip)
   end
 
-  def get_value_from_ua(ua, field)
-    return nil unless ua.is_a?(String) && field.is_a?(String)
+  def get_value_from_ua(user, field)
+    return nil unless user.is_a?(StatsigUser) && field.is_a?(String)
+    ua = get_value_from_user(user, 'userAgent')
+    return nil unless ua.is_a?(String)
+
     parsed = @ua_parser.parse ua
     os = parsed.os
     case field.downcase

data/lib/network.rb

@@ -2,8 +2,10 @@ require 'http'
 require 'json'
 require 'dynamic_config'
 
+$retry_codes = [408, 500, 502, 503, 504, 522, 524, 599]
+
 class Network
-  def initialize(server_secret, api)
+  def initialize(server_secret, api, backoff_mult = 10)
     super()
     unless api.end_with?('/')
       api += '/'
@@ -11,22 +13,36 @@ class Network
     @server_secret = server_secret
     @api = api
     @last_sync_time = 0
+    @backoff_multiplier = backoff_mult
   end
 
-  def post_helper(endpoint, body)
+  def post_helper(endpoint, body, retries = 0, backoff = 1)
     http = HTTP.headers(
       {"STATSIG-API-KEY" => @server_secret,
        "STATSIG-CLIENT-TIME" => (Time.now.to_f * 1000).to_s,
        "Content-Type" => "application/json; charset=UTF-8"
       }).accept(:json)
-    http.post(@api + endpoint, body: body)
+    begin
+      res = http.post(@api + endpoint, body: body)
+    rescue
+      ## network error retry
+      return nil 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)
+    ## status code retry
+    sleep backoff
+    post_helper(endpoint, body, retries - 1, backoff * @backoff_multiplier)
   end
 
   def check_gate(user, gate_name)
     begin
-      request_body = JSON.generate({'user' => user&.serialize, 'gateName' => gate_name})
+      request_body = JSON.generate({'user' => user&.serialize(false), 'gateName' => gate_name})
       response = post_helper('check_gate', request_body)
-      return JSON.parse(response.body)
+      return JSON.parse(response.body) unless response.nil?
+      false
     rescue
       return false
     end
@@ -34,9 +50,10 @@ class Network
 
   def get_config(user, dynamic_config_name)
     begin
-      request_body = JSON.generate({'user' => user&.serialize, 'configName' => dynamic_config_name})
+      request_body = JSON.generate({'user' => user&.serialize(false), 'configName' => dynamic_config_name})
       response = post_helper('get_config', request_body)
-      return JSON.parse(response.body)
+      return JSON.parse(response.body) unless response.nil?
+      nil
     rescue
       return nil
     end
@@ -45,6 +62,7 @@ class Network
   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
@@ -68,9 +86,8 @@ class Network
   def post_logs(events, statsig_metadata)
     begin
       json_body = JSON.generate({'events' => events, 'statsigMetadata' => statsig_metadata})
-      post_helper('log_event', body: json_body)
+      post_helper('log_event', body: json_body, retries: 5)
     rescue
-      # TODO: retries
     end
   end
 end

data/lib/statsig_driver.rb

@@ -56,9 +56,11 @@ class StatsigDriver
 
     if res == $fetch_from_server
       res = check_gate_fallback(user, gate_name)
+      # exposure logged by the server
+    else
+      @logger.log_gate_exposure(user, res.name, res.gate_value, res.rule_id)
     end
 
-    @logger.log_gate_exposure(user, res.name, res.gate_value, res.rule_id)
     res.gate_value
   end
 
@@ -80,11 +82,12 @@ class StatsigDriver
 
     if res == $fetch_from_server
       res = get_config_fallback(user, dynamic_config_name)
+      # exposure logged by the server
+    else
+      @logger.log_config_exposure(user, res.name, res.rule_id)
     end
 
-    result_config = DynamicConfig.new(res.name, res.json_value, res.rule_id)
-    @logger.log_config_exposure(user, result_config.name, result_config.rule_id)
-    result_config
+    DynamicConfig.new(res.name, res.json_value, res.rule_id)
   end
 
   def log_event(user, event_name, value = nil, metadata = nil)
@@ -96,7 +99,7 @@ class StatsigDriver
     user = normalize_user(user)
 
     event = StatsigEvent.new(event_name)
-    event.user = user&.serialize
+    event.user = user
     event.value = value
     event.metadata = metadata
     event.statsig_metadata = @statsig_metadata
@@ -105,7 +108,7 @@ class StatsigDriver
 
   def shutdown
     @shutdown = true
-    @logger.flush
+    @logger.flush(true)
     @polling_thread&.exit
   end
 

data/lib/statsig_event.rb

@@ -1,15 +1,22 @@
 class StatsigEvent
   attr_accessor :value
-  attr_accessor :user
   attr_accessor :metadata
   attr_accessor :statsig_metadata
+  attr_reader :user
+
   def initialize(event_name)
     @event_name = event_name
     @time = Time.now.to_f * 1000
   end
 
+  def user=(value)
+    if value.is_a?(StatsigUser)
+      @user = value.serialize(true)
+    end
+  end
+
   def serialize
-    return {
+    {
       'eventName' => @event_name,
       'metadata' => @metadata,
       'value' => @value,

data/lib/statsig_logger.rb

@@ -8,6 +8,10 @@ class StatsigLogger
     @network = network
     @statsig_metadata = statsig_metadata
     @events = []
+    @background_flush = Thread.new do
+      sleep 60
+      flush
+    end
   end
 
   def log_event(event)
@@ -40,13 +44,18 @@ class StatsigLogger
     log_event(event)
   end
 
-  def flush
+  def flush(closing = false)
+    if closing
+      @background_flush.exit
+    end
     if @events.length == 0
       return
     end
     flush_events = @events.map { |e| e.serialize() }
     @events = []
 
-    @network.post_logs(flush_events, @statsig_metadata)
+    Thread.new do
+      @network.post_logs(flush_events, @statsig_metadata)
+    end
   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 :private_attributes
 
   def custom
     @custom
@@ -29,11 +30,12 @@ class StatsigUser
       @app_version = user_hash['appVersion'] || user_hash['app_version']
       @custom = user_hash['custom']
       @statsig_environment = user_hash['statsigEnvironment']
+      @private_attributes = user_hash['privateAttributes']
     end
   end
 
-  def serialize
-    {
+  def serialize(for_logging)
+    hash = {
       'userID' => @user_id,
       'email' => @email,
       'ip' => @ip,
@@ -43,7 +45,12 @@ class StatsigUser
       'appVersion' => @app_version,
       'custom' => @custom,
       'statsigEnvironment' => @statsig_environment,
+      'privateAttributes' => @private_attributes,
     }
+    if for_logging
+      hash.delete('privateAttributes')
+    end
+    hash
   end
 
   def value_lookup
@@ -62,6 +69,7 @@ class StatsigUser
       'appversion' => @app_version,
       'app_version' => @app_version,
       'custom' => @custom,
+      'privateAttributes' => @private_attributes,
     }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statsig
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Statsig, Inc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-31 00:00:00.000000000 Z
+date: 2021-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: spy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: user_agent_parser
   requirement: !ruby/object:Gem::Requirement