statsig 1.6.1 → 1.7.0.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dfdb320cf540cd81046ba96aae19d9d3f947ec557ad7fb7b405a35065eb67fa
-  data.tar.gz: 0e8d15d9c3f9aa0245c2e834e55394479775d2a9de23208e54dfb41be89e0326
+  metadata.gz: 889dec377c0c563738b53a97153d54cde36d34518bfa67d1e56a1f2ac6b161b3
+  data.tar.gz: 9da0ba2bf4b241042e5e2a2ae0822700f2906f0454d5ddfda625b99b69c1fd2f
 SHA512:
-  metadata.gz: e7a479f8ed9b2cbf49f4b567bdf16000b5ba23a88015593cec6e9806477419011a13b5ed64fd578208cec5f6633101c881e3fa0b98b0474a2faebc91aaf8be1e
-  data.tar.gz: d731197be16b7ef43d6c9060f00254b3db3a205bef736243a326a382e9fca1aa72b1335102612ab13c044a03f4dc247e0b3443badfad147dffdd8be8391a038d
+  metadata.gz: fd0c026a5d93e99c8862fa36e215c185aef5704173c1f56fde1ff01765d276633880233e0d60b65f079b00f63d6618c447dfd10f1f037311b30804b5362db916
+  data.tar.gz: 4cf98a1164ce38977d05d682d94b761eda719e7cb1188a363c0b565e1ea9ad402f8719454363edf83dfefba4603666e2e1bd64573b04cbb899d008815e20b665

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

@@ -23,8 +23,6 @@ module EvaluationHelpers
     end
   end
 
-  private
-
   def self.is_numeric(v)
     !(v.to_s =~ /\A[-+]?\d*\.?\d+\z/).nil?
   end

data/lib/evaluator.rb

@@ -28,40 +28,54 @@ class Evaluator
     self.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)
         return $fetch_from_server if result == $fetch_from_server
-        if result
+        exposures = exposures + result['exposures'] if result['exposures'].is_a? Array
+        if result['value']
           pass = self.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
+      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)
@@ -82,7 +96,18 @@ class Evaluator
     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
+
+      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
@@ -86,7 +86,7 @@ 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, retries: 5)
+      post_helper('log_event', json_body, retries: 5)
     rescue
     end
   end

data/lib/statsig.rb

@@ -1,13 +1,13 @@
 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)
@@ -37,8 +37,6 @@ module Statsig
     @shared_instance = nil
   end
 
-  private
-
   def self.ensure_initialized
     if @shared_instance.nil?
       raise 'Must call initialize first.'

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'
@@ -112,8 +121,6 @@ class StatsigDriver
     @polling_thread&.exit
   end
 
-  private
-
   def validate_user(user)
     if user.nil? || !user.instance_of?(StatsigUser) || !user.user_id.is_a?(String)
       raise 'Must provide a valid StatsigUser with a user_id to use the server SDK. See https://docs.statsig.com/messages/serverRequiredUserID/ for more details.'

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,11 +53,9 @@ class StatsigLogger
     if @events.length == 0
       return
     end
-    flush_events = @events.map { |e| e.serialize() }
+    flush_events = @events.map { |e| e.serialize }
     @events = []
 
-    Thread.new do
-      @network.post_logs(flush_events, @statsig_metadata)
-    end
+    @network.post_logs(flush_events, @statsig_metadata)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statsig
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0.beta.2
 platform: ruby
 authors:
 - Statsig, Inc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-11 00:00:00.000000000 Z
+date: 2021-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -141,9 +141,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.2.3
 signing_key: