statsig 1.6.2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 325d5430e48a3d71b68d2e284e20b66b0052bf1a4d9e99e7a92a84069b680ab8
-  data.tar.gz: b227e1fede44928035b1a03ebc8e8c006425466b50b007f89c452f6a47b51cd6
+  metadata.gz: d24b945d9500781cda02ab594f003360d81c5a1bca99f366a2ceb95013b53dad
+  data.tar.gz: 63c9ea1a9d6347ecec9bff74949665b2af20bfe774e21a6851e96ba9b7eea397
 SHA512:
-  metadata.gz: 28017886b1a5d3f5c37e36680f0dfbd300cf5a0f6e0678430af69631486bc88689a622d74a63da1687ef7d610d612227d68cb58b85a7572b7cc5cfcaee0794dd
-  data.tar.gz: 10a66e7674df116a65351b97b8d27055bacd46f021309c3256bc5605fe3a972416e2c595135262fc9d18117e447a5038db3ebe1b89cb71495f308430fe4d2a32
+  metadata.gz: e47350b9ba8e20f659b65a909955d40e66bf2397306aa798aaab60e73fb3b58fd1d3cade5ea0077fd37f847c5f6e976f7ecbfc978db4830884e463bfa6656574
+  data.tar.gz: 8e8b11dd34de6f35585c916d3125be3a36f6f897b69facb1788364702bcd15d1729109d8ad8aadfda98f9909a7f053077433ba6221f3ca7c27d2b5686214fda6

data/lib/config_result.rb

@@ -3,11 +3,13 @@ class ConfigResult
   attr_accessor :gate_value
   attr_accessor :json_value
   attr_accessor :rule_id
+  attr_accessor :secondary_exposures
 
-  def initialize(name, gate_value = false, json_value = {}, rule_id = '')
+  def initialize(name, gate_value = false, json_value = {}, rule_id = '', secondary_exposures = [])
     @name = name
     @gate_value = gate_value
     @json_value = json_value
     @rule_id = rule_id
+    @secondary_exposures = secondary_exposures.is_a?(Array) ? secondary_exposures : []
   end
 end

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

@@ -20,48 +20,64 @@ class Evaluator
 
   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
 
   private
 
   def eval_spec(user, config)
+    default_rule_id = 'default'
+    exposures = []
     if config['enabled']
       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
-        if result
-          pass = self.eval_pass_percent(user, rule, config['salt'])
+        exposures = exposures + result['exposures'] if result['exposures'].is_a? Array
+        if result['value']
+          pass = eval_pass_percent(user, rule, config['salt'])
           return ConfigResult.new(
             config['name'],
             pass,
             pass ? rule['returnValue'] : config['defaultValue'],
             rule['id'],
+            exposures
           )
         end
 
         i += 1
       end
+    elsif (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)
+    exposures = []
+    pass = true
     i = 0
     until i >= rule['conditions'].length do
-      result = self.eval_condition(user, rule['conditions'][i])
-      return result unless result == true
+      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
+      elsif result == false
+        pass = false
+      end
       i += 1
     end
-    true
+    { 'value' => pass, 'exposures' => exposures }
   end
 
   def eval_condition(user, condition)
@@ -80,9 +96,20 @@ 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
-      return type == 'pass_gate' ? other_gate_result.gate_value : !other_gate_result.gate_value
+
+      gate_value = other_gate_result&.gate_value == true
+      new_exposure = {
+        '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
+      }
     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

data/lib/network.rb

@@ -24,14 +24,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 +40,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 +51,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
@@ -61,13 +61,13 @@ class Network
 
   def download_config_specs
     begin
-      response = post_helper('download_config_specs', JSON.generate({'sinceTime' => @last_sync_time}))
-      return nil unless !response.nil?
+      response, e = post_helper('download_config_specs', JSON.generate({'sinceTime' => @last_sync_time}))
+      return nil, e if response.nil?
       json_body = JSON.parse(response.body)
       @last_sync_time = json_body['time']
-      return json_body
-    rescue
-      return nil
+      return json_body, nil
+    rescue StandardError => e
+      return nil, e
     end
   end
 
@@ -75,7 +75,7 @@ class Network
     Thread.new do
       loop do
         sleep 10
-        specs = download_config_specs
+        specs, _ = download_config_specs
         unless specs.nil?
           callback.call(specs)
         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
 

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,7 +17,7 @@ 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)
@@ -27,7 +27,7 @@ class StatsigDriver
     }
     @logger = StatsigLogger.new(@net, @statsig_metadata)
 
-    downloaded_specs = @net.download_config_specs
+    downloaded_specs, e = @net.download_config_specs
     unless downloaded_specs.nil?
       @initialized = true
     end
@@ -36,6 +36,8 @@ class StatsigDriver
     @evaluator = Evaluator.new(@store)
 
     @polling_thread = @net.poll_for_changes(-> (config_specs) { @store.process(config_specs) })
+
+    error_callback.call(e) unless error_callback.nil?
   end
 
   def check_gate(user, gate_name)
@@ -58,7 +60,7 @@ class StatsigDriver
       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)
+      @logger.log_gate_exposure(user, res.name, res.gate_value, res.rule_id, res.secondary_exposures)
     end
 
     res.gate_value
@@ -84,12 +86,19 @@ class StatsigDriver
       res = get_config_fallback(user, dynamic_config_name)
       # exposure logged by the server
     else
-      @logger.log_config_exposure(user, res.name, res.rule_id)
+      @logger.log_config_exposure(user, res.name, res.rule_id, res.secondary_exposures)
     end
 
     DynamicConfig.new(res.name, res.json_value, res.rule_id)
   end
 
+  def get_experiment(user, experiment_name)
+    if !experiment_name.is_a?(String) || experiment_name.empty?
+      raise "Invalid experiment_name provided"
+    end
+    get_config(user, experiment_name)
+  end
+
   def log_event(user, event_name, value = nil, metadata = nil)
     if !user.nil? && !user.instance_of?(StatsigUser)
       raise 'Must provide a valid StatsigUser or nil'

data/lib/statsig_event.rb

@@ -2,6 +2,7 @@ class StatsigEvent
   attr_accessor :value
   attr_accessor :metadata
   attr_accessor :statsig_metadata
+  attr_accessor :secondary_exposures
   attr_reader :user
 
   def initialize(event_name)
@@ -23,6 +24,7 @@ class StatsigEvent
       'user' => @user,
       'time' => @time,
       'statsigMetadata' => @statsig_metadata,
+      'secondaryExposures' => @secondary_exposures
     }
   end
 end

data/lib/statsig_logger.rb

@@ -21,7 +21,7 @@ class StatsigLogger
     end
   end
 
-  def log_gate_exposure(user, gate_name, value, rule_id)
+  def log_gate_exposure(user, gate_name, value, rule_id, secondary_exposures)
     event = StatsigEvent.new($gate_exposure_event)
     event.user = user
     event.metadata = {
@@ -30,10 +30,11 @@ class StatsigLogger
       'ruleID' => rule_id
     }
     event.statsig_metadata = @statsig_metadata
+    event.secondary_exposures = secondary_exposures.is_a?(Array) ? secondary_exposures : []
     log_event(event)
   end
 
-  def log_config_exposure(user, config_name, rule_id)
+  def log_config_exposure(user, config_name, rule_id, secondary_exposures)
     event = StatsigEvent.new($config_exposure_event)
     event.user = user
     event.metadata = {
@@ -41,6 +42,7 @@ class StatsigLogger
       'ruleID' => rule_id
     }
     event.statsig_metadata = @statsig_metadata
+    event.secondary_exposures = secondary_exposures.is_a?(Array) ? secondary_exposures : []
     log_event(event)
   end
 
@@ -51,7 +53,7 @@ class StatsigLogger
     if @events.length == 0
       return
     end
-    flush_events = @events.map { |e| e.serialize() }
+    flush_events = @events.map { |e| e.serialize }
     @events = []
 
     @network.post_logs(flush_events, @statsig_metadata)

metadata

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