statsig 1.9.0 → 1.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a832901a7d272c5b27408418836ded1042f720bfc0a374489ed0a81c476a1606
-  data.tar.gz: c89426f15ab949980299bfc21931466d076e8b23fbe26ddc290e13d1d92cb948
+  metadata.gz: 72321b660214bc1a0c54ffd5718115ef713be11fd0f37fe9e18429539edad855
+  data.tar.gz: 3583760dd5c9ae9aab5005bc07e7673088de8af39b7cbecec032b332249b1c6a
 SHA512:
-  metadata.gz: c92f462bf372241bdd214a9a153b597792970b70631b8631be3df01b189953b6574016eedf437e397e07f62c8ef8f1c3e7ab7834f10080febe9843514cb059e0
-  data.tar.gz: 228deaad6a9c224c80321ddc6bd33ab13a4cd6eae86cc83f822f5d8325f25aaa13bfd0903369468b3664d28847b3239df27a446b32b349e5b3d987f77ef3fb74
+  metadata.gz: bf06b989ebade0705ef7ee377455b87c6b408ce38aabfae9ccc6c4f95f6b7bc0a4e3fb9393d5473b0e32f2e04f901df730666f00a27b2f0d2a709338b31ca2bc
+  data.tar.gz: 68e77d69004f9d96d82e011ad67822732c9889871eb0e39990b88c9f109b4f84d991c55a680cd5434381c285e35e725d08e7438ee5fe1bc32809f0dd9eb78141

data/lib/config_result.rb

@@ -6,15 +6,19 @@ module Statsig
     attr_accessor :json_value
     attr_accessor :rule_id
     attr_accessor :secondary_exposures
+    attr_accessor :undelegated_sec_exps
     attr_accessor :config_delegate
+    attr_accessor :explicit_parameters
 
-    def initialize(name, gate_value = false, json_value = {}, rule_id = '', secondary_exposures = [], config_delegate = '')
+    def initialize(name, gate_value = false, json_value = {}, rule_id = '', secondary_exposures = [], undelegated_sec_exps = [], config_delegate = '', explicit_parameters = [])
       @name = name
       @gate_value = gate_value
       @json_value = json_value
       @rule_id = rule_id
       @secondary_exposures = secondary_exposures.is_a?(Array) ? secondary_exposures : []
+      @undelegated_sec_exps = undelegated_sec_exps.is_a?(Array) ? undelegated_sec_exps : []
       @config_delegate = config_delegate
+      @explicit_parameters = explicit_parameters
     end
   end
 end

data/lib/evaluator.rb

@@ -7,7 +7,7 @@ require 'time'
 require 'user_agent_parser'
 require 'user_agent_parser/operating_system'
 
-$fetch_from_server = :fetch_from_server
+$fetch_from_server = 'fetch_from_server'
 $type_dynamic_config = 'dynamic_config'
 
 module Statsig
@@ -48,17 +48,21 @@ module Statsig
         until i >= config['rules'].length do
           rule = config['rules'][i]
           result = eval_rule(user, rule)
-          return $fetch_from_server if result == $fetch_from_server
+          return $fetch_from_server if result.to_s == $fetch_from_server
           exposures = exposures + result.secondary_exposures
           if result.gate_value
+
+            if (delegated_result = eval_delegate(config['name'], user, rule, exposures))
+              return delegated_result
+            end
+
             pass = eval_pass_percent(user, rule, config['salt'])
             return Statsig::ConfigResult.new(
               config['name'],
               pass,
               pass ? result.json_value : config['defaultValue'],
               result.rule_id,
-              exposures,
-              result.config_delegate
+              exposures
             )
           end
 
@@ -77,7 +81,7 @@ module Statsig
       i = 0
       until i >= rule['conditions'].length do
         result = eval_condition(user, rule['conditions'][i])
-        if result == $fetch_from_server
+        if result.to_s == $fetch_from_server
           return $fetch_from_server
         end
 
@@ -90,17 +94,24 @@ module Statsig
         i += 1
       end
 
-      delegate = rule['configDelegate']
-      if pass and @spec_store.get_config(delegate)
-        delegated_result = self.eval_spec(user, @spec_store.get_config(delegate))
-        delegated_result.config_delegate = delegate
-        delegated_result.secondary_exposures = exposures + delegated_result.secondary_exposures
-        return delegated_result
-      end
-
       Statsig::ConfigResult.new('', pass, rule['returnValue'], rule['id'], exposures)
     end
 
+    def eval_delegate(name, user, rule, exposures)
+      return nil unless (delegate = rule['configDelegate'])
+      return nil unless (config = @spec_store.get_config(delegate))
+
+      delegated_result = self.eval_spec(user, config)
+      return $fetch_from_server if delegated_result.to_s == $fetch_from_server
+
+      delegated_result.name = name
+      delegated_result.config_delegate = delegate
+      delegated_result.secondary_exposures = exposures + delegated_result.secondary_exposures
+      delegated_result.undelegated_sec_exps = exposures
+      delegated_result.explicit_parameters = config['explicitParameters']
+      delegated_result
+    end
+
     def eval_condition(user, condition)
       value = nil
       field = condition['field']
@@ -119,7 +130,7 @@ module Statsig
         return true
       when 'fail_gate', 'pass_gate'
         other_gate_result = check_gate(user, target)
-        return $fetch_from_server if other_gate_result == $fetch_from_server
+        return $fetch_from_server if other_gate_result.to_s == $fetch_from_server
 
         gate_value = other_gate_result&.gate_value == true
         new_exposure = {
@@ -134,10 +145,10 @@ module Statsig
         }
       when 'ip_based'
         value = get_value_from_user(user, field) || get_value_from_ip(user, field)
-        return $fetch_from_server if value == $fetch_from_server
+        return $fetch_from_server if value.to_s == $fetch_from_server
       when 'ua_based'
         value = get_value_from_user(user, field) || get_value_from_ua(user, field)
-        return $fetch_from_server if value == $fetch_from_server
+        return $fetch_from_server if value.to_s == $fetch_from_server
       when 'user_field'
         value = get_value_from_user(user, field)
       when 'environment_field'
@@ -159,7 +170,7 @@ module Statsig
         return $fetch_from_server
       end
 
-      return $fetch_from_server if value == $fetch_from_server || !operator.is_a?(String)
+      return $fetch_from_server if value.to_s == $fetch_from_server || !operator.is_a?(String)
       operator = operator.downcase
 
       case operator
@@ -229,13 +240,15 @@ module Statsig
         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
+          is_in_list = false
+          id_list = @spec_store.get_id_list(target)
+          if id_list.is_a? IDList
+            hashed_id = Digest::SHA256.base64digest(value.to_s)[0, 8]
+            is_in_list = id_list.ids.include?(hashed_id)
+          end
+          return is_in_list if operator == 'in_segment_list'
+          return !is_in_list
+        rescue
           return false
         end
       else
@@ -309,7 +322,7 @@ module Statsig
     def eval_pass_percent(user, rule, config_salt)
       return false unless config_salt.is_a?(String) && !rule['passPercentage'].nil?
       begin
-        unit_id = get_unit_id(user, rule['id_type']) || ''
+        unit_id = get_unit_id(user, rule['idType']) || ''
         rule_salt = rule['salt'] || rule['id'] || ''
         hash = compute_user_hash("#{config_salt}.#{rule_salt}.#{unit_id}")
         return (hash % 10000) < (rule['passPercentage'].to_f * 100)

data/lib/id_list.rb

@@ -0,0 +1,36 @@
+module Statsig
+  class IDList
+    attr_accessor :name
+    attr_accessor :size
+    attr_accessor :creation_time
+    attr_accessor :url
+    attr_accessor :file_id
+    attr_accessor :ids
+
+    def initialize(json, ids = Set.new)
+      @name = json['name'] || ''
+      @size = json['size'] || 0
+      @creation_time = json['creationTime'] || 0
+      @url = json['url']
+      @file_id = json['fileID']
+
+      @ids = ids
+    end
+
+    def self.new_empty(json)
+      self.new(json)
+      @size = 0
+    end
+
+    def ==(other)
+      return false if other.nil?
+
+      self.name == other.name &&
+        self.size == other.size &&
+        self.creation_time == other.creation_time &&
+        self.url == other.url &&
+        self.file_id == other.file_id &&
+        self.ids == other.ids
+    end
+  end
+end

data/lib/layer.rb

@@ -2,14 +2,20 @@ class Layer
   attr_accessor :name
   attr_accessor :rule_id
 
-  def initialize(name, value = {}, rule_id = '')
+  def initialize(name, value = {}, rule_id = '', exposure_log_func = nil)
     @name = name
     @value = value
     @rule_id = rule_id
+    @exposure_log_func = exposure_log_func
   end
 
   def get(index, default_value)
     return default_value if @value.nil? || !@value.key?(index)
+
+    if @exposure_log_func.is_a? Proc
+      @exposure_log_func.call(self, index)
+    end
+
     @value[index]
   end
 end

data/lib/network.rb

@@ -1,5 +1,6 @@
 require 'http'
 require 'json'
+require 'securerandom'
 
 $retry_codes = [408, 500, 502, 503, 504, 522, 524, 599]
 
@@ -13,12 +14,14 @@ module Statsig
       @server_secret = server_secret
       @api = api
       @backoff_multiplier = backoff_mult
+      @session_id = SecureRandom.uuid
     end
 
     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,
+         "STATSIG-SERVER-SESSION-ID" => @session_id,
         "Content-Type" => "application/json; charset=UTF-8"
         }).accept(:json)
       begin

data/lib/spec_store.rb

@@ -1,6 +1,8 @@
 require 'net/http'
 require 'uri'
 
+require 'id_list'
+
 module Statsig
   class SpecStore
     def initialize(network, error_callback = nil, config_sync_interval = 10, id_lists_sync_interval = 60)
@@ -16,7 +18,7 @@ module Statsig
       }
       e = download_config_specs
       error_callback.call(e) unless error_callback.nil?
-      download_id_lists
+      get_id_lists
 
       @config_sync_thread = sync_config_specs
       @id_lists_sync_thread = sync_id_lists
@@ -73,7 +75,7 @@ module Statsig
       Thread.new do
         loop do
           sleep @id_lists_sync_interval
-          download_id_lists
+          get_id_lists
         end
       end
     end
@@ -112,53 +114,98 @@ module Statsig
       @store[:gates] = new_gates
       @store[:configs] = new_configs
       @store[:layers] = new_layers
+    end
 
-      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
+    def get_id_lists
+      response, e = @network.post_helper('get_id_lists', JSON.generate({'statsigMetadata' => Statsig.get_statsig_metadata}))
+      if !e.nil? || response.nil?
+        return
+      end
+
+      begin
+        server_id_lists = JSON.parse(response)
+        local_id_lists = @store[:id_lists]
+        if !server_id_lists.is_a?(Hash) || !local_id_lists.is_a?(Hash)
+          return
         end
+        threads = []
+
+        server_id_lists.each do |list_name, list|
+          server_list = IDList.new(list)
+          local_list = get_id_list(list_name)
+
+          unless local_list.is_a? IDList
+            local_list = IDList.new(list)
+            local_list.size = 0
+            local_id_lists[list_name] = local_list
+          end
 
-        @store[:id_lists].each do |list_name, _|
-          unless new_id_lists.key?(list_name)
-            @store[:id_lists].delete(list_name)
+          # skip if server list is invalid
+          if server_list.url.nil? || server_list.creation_time < local_list.creation_time || server_list.file_id.nil?
+            next
+          end
+
+          # skip if server list returns a newer file
+          if server_list.file_id != local_list.file_id && server_list.creation_time >= local_list.creation_time
+            local_list = IDList.new(list)
+            local_list.size = 0
+            local_id_lists[list_name] = local_list
+          end
+
+          # skip if server list is no bigger than local list, which means nothing new to read
+          if server_list.size <= local_list.size
+            next
+          end
+
+          threads << Thread.new do
+            download_single_id_list(local_list)
+          end
+        end
+        threads.each(&:join)
+        delete_lists = []
+        local_id_lists.each do |list_name, list|
+          unless server_id_lists.key? list_name
+            delete_lists.push list_name
           end
         end
+        delete_lists.each do |list_name|
+          local_id_lists.delete list_name
+        end
+      rescue
+        # Ignored, will try again
       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
+    def download_single_id_list(list)
+      nil unless list.is_a? IDList
+      http = HTTP.headers({'Range' => "bytes=#{list&.size || 0}-"}).accept(:json)
+      begin
+        res = http.get(list.url)
+        nil unless res.status.success?
+        content_length = Integer(res['content-length'])
+        nil if content_length.nil? || content_length <= 0
+        content = res.body.to_s
+        unless content.is_a?(String) && (content[0] == '-' || content[0] == '+')
+          @store[:id_lists].delete(list.name)
+          return
+        end
+        ids_clone = list.ids # clone the list, operate on the new list, and swap out the old list, so the operation is thread-safe
+        lines = content.split(/\r?\n/)
+        lines.each do |li|
+          line = li.strip
+          next if line.length <= 1
+          op = line[0]
+          id = line[1..]
+          if op == '+'
+            ids_clone.add(id)
+          elsif op == '-'
+            ids_clone.delete(id)
           end
         end
-        threads.each(&:join)
+        list.ids = ids_clone
+        list.size = list.size + content_length
+      rescue
+        nil
       end
     end
   end

data/lib/statsig.rb

@@ -22,12 +22,12 @@ module Statsig
 
   def self.get_experiment(user, experiment_name)
     ensure_initialized
-    @shared_instance&.get_config(user, experiment_name)
+    @shared_instance&.get_experiment(user, experiment_name)
   end
 
   def self.get_layer(user, layer_name)
     ensure_initialized
-    @shared_instance&.get_config(user, layer_name)
+    @shared_instance&.get_layer(user, layer_name)
   end
 
   def self.log_event(user, event_name, value, metadata)

data/lib/statsig_driver.rb

@@ -6,6 +6,8 @@ require 'statsig_logger'
 require 'statsig_options'
 require 'statsig_user'
 require 'spec_store'
+require 'dynamic_config'
+require 'layer'
 
 class StatsigDriver
   def initialize(secret_key, options = nil, error_callback = nil)
@@ -67,11 +69,11 @@ class StatsigDriver
       end
       res = get_config_fallback(user, res.config_delegate)
       # exposure logged by the server
-    else
-      @logger.log_layer_exposure(user, res.name, res.rule_id, res.secondary_exposures, res.config_delegate)
     end
 
-    Layer.new(res.name, res.json_value, res.rule_id)
+    Layer.new(res.name, res.json_value, res.rule_id, lambda { |layer, parameter_name|
+      @logger.log_layer_exposure(user, layer, parameter_name, res)
+    })
   end
 
   def log_event(user, event_name, value = nil, metadata = nil)
@@ -101,7 +103,7 @@ class StatsigDriver
   def verify_inputs(user, config_name, variable_name)
     validate_user(user)
     if !config_name.is_a?(String) || config_name.empty?
-      raise "Invalid " + variable_name +" provided"
+      raise "Invalid #{variable_name} provided"
     end
 
     check_shutdown

data/lib/statsig_logger.rb

@@ -44,16 +44,26 @@ module Statsig
       log_event(event)
     end
 
-    def log_layer_exposure(user, config_name, rule_id, secondary_exposures, allocated_experiment)
+    def log_layer_exposure(user, layer, parameter_name, config_evaluation)
+      exposures = config_evaluation.undelegated_sec_exps
+      allocated_experiment = ''
+      is_explicit = config_evaluation.explicit_parameters.include? parameter_name
+      if is_explicit
+        allocated_experiment = config_evaluation.config_delegate
+        exposures = config_evaluation.secondary_exposures
+      end
+
       event = StatsigEvent.new($layer_exposure_event)
       event.user = user
       event.metadata = {
-        'config' => config_name,
-        'ruleID' => rule_id,
-        'allocatedExperiment' => allocated_experiment
+        'config' => layer.name,
+        'ruleID' => layer.rule_id,
+        'allocatedExperiment' => allocated_experiment,
+        'parameterName' => parameter_name,
+        'isExplicitParameter' => String(is_explicit)
       }
       event.statsig_metadata = Statsig.get_statsig_metadata
-      event.secondary_exposures = secondary_exposures.is_a?(Array) ? secondary_exposures : []
+      event.secondary_exposures = exposures.is_a?(Array) ? exposures : []
       log_event(event)
     end
 

data/lib/statsig_options.rb

@@ -2,7 +2,7 @@ class StatsigOptions
   attr_reader :environment
   attr_reader :api_url_base
 
-  def initialize(environment = nil, api_url_base = 'https://api.statsig.com/v1')
+  def initialize(environment = nil, api_url_base = 'https://statsigapi.net/v1')
     @environment = environment.is_a?(Hash) ? environment : nil
     @api_url_base = api_url_base
   end

data/lib/statsig_user.rb

@@ -54,7 +54,7 @@ class StatsigUser
     if for_logging
       hash.delete('privateAttributes')
     end
-    hash
+    hash.compact
   end
 
   def value_lookup

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statsig
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.9.1
 platform: ruby
 authors:
 - Statsig, Inc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-22 00:00:00.000000000 Z
+date: 2022-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,6 +118,7 @@ files:
 - lib/dynamic_config.rb
 - lib/evaluation_helpers.rb
 - lib/evaluator.rb
+- lib/id_list.rb
 - lib/layer.rb
 - lib/network.rb
 - lib/spec_store.rb