statsig 1.9.2 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afbf6d972c5aeead4eeaa8c352155c41b02a3710f55d80309939d5acc0fd1e80
-  data.tar.gz: c83f0399868af1d7978aeb2d2723f4bfbc860646de3ea0a7aaf840903489b92a
+  metadata.gz: 1590d900487869f3cbd76aae50f38ccb535b372ba0468a446ab5574ccfc782eb
+  data.tar.gz: 1e94c594d470d0baa21a073177677d6c631297aa1fe51747853ef25106b55c6e
 SHA512:
-  metadata.gz: babe4ac6dc398bd87df7537ea7c9391e72e4a32c4ec80944895adb507351a02042dd2bfc28deb2336e706fcf531ba4d30dfdeeb280404b108a25505fcd749ed8
-  data.tar.gz: c1bad8f27c2675b7dbc125090a56062e71c5fddb6f0cc8464c0e9ea03b910f9ca918a9ccf4e6c8db99815b7964aaf543d0cc69db5a873bcf58ddc806ef8932cc
+  metadata.gz: 7b2ceb928a74c83e00b783aa46ea45010dbd9daa4a8932a29528e7edc10d9393a6cad9139c26bcd98b13509957565637593c4d0115bd5f929425dc7872f54260
+  data.tar.gz: db7812f360b4e68b402107fedea8f7d7c591bdb83ad206265b871d22b837c6be04e867c51d879a1730dbcc8cec76097879e47f601d42d8e1c456018dda5dd44e

data/lib/dynamic_config.rb

@@ -13,4 +13,10 @@ class DynamicConfig
     return default_value if @value.nil? || !@value.key?(index)
     @value[index]
   end
+
+  def get_typed(index, default_value)
+    return default_value if @value.nil? || !@value.key?(index)
+    return default_value if @value[index].class != default_value.class and default_value.class != TrueClass and default_value.class != FalseClass
+    @value[index]
+  end
 end

data/lib/evaluator.rb

@@ -12,19 +12,34 @@ $type_dynamic_config = 'dynamic_config'
 
 module Statsig
   class Evaluator
-    def initialize(network, error_callback)
-      @spec_store = Statsig::SpecStore.new(network, error_callback)
+    def initialize(network, options, error_callback)
+      @spec_store = Statsig::SpecStore.new(network, error_callback, options.rulesets_sync_interval, options.idlists_sync_interval)
       @ua_parser = UserAgentParser::Parser.new
       CountryLookup.initialize
       @initialized = true
+
+      @gate_overrides = {}
+      @config_overrides = {}
     end
 
     def check_gate(user, gate_name)
+      return Statsig::ConfigResult.new(
+        gate_name,
+        @gate_overrides[gate_name],
+        @gate_overrides[gate_name],
+        'override',
+        []) unless !@gate_overrides.has_key?(gate_name)
       return nil unless @initialized && @spec_store.has_gate?(gate_name)
       eval_spec(user, @spec_store.get_gate(gate_name))
     end
 
     def get_config(user, config_name)
+      return Statsig::ConfigResult.new(
+        config_name,
+        false,
+        @config_overrides[config_name],
+        'override',
+        []) unless !@config_overrides.has_key?(config_name)
       return nil unless @initialized && @spec_store.has_config?(config_name)
       eval_spec(user, @spec_store.get_config(config_name))
     end
@@ -38,6 +53,14 @@ module Statsig
       @spec_store.shutdown
     end
 
+    def override_gate(gate, value)
+      @gate_overrides[gate] = value
+    end
+
+    def override_config(config, value)
+      @config_overrides[config] = value
+    end
+
     private
 
     def eval_spec(user, config)

data/lib/layer.rb

@@ -18,4 +18,15 @@ class Layer
 
     @value[index]
   end
+
+  def get_typed(index, default_value)
+    return default_value if @value.nil? || !@value.key?(index)
+    return default_value if @value[index].class != default_value.class and default_value.class != TrueClass and default_value.class != FalseClass
+
+    if @exposure_log_func.is_a? Proc
+      @exposure_log_func.call(self, index)
+    end
+
+    @value[index]
+  end
 end

data/lib/network.rb

@@ -6,18 +6,20 @@ $retry_codes = [408, 500, 502, 503, 504, 522, 524, 599]
 
 module Statsig
   class Network
-    def initialize(server_secret, api, backoff_mult = 10)
+    def initialize(server_secret, api, local_mode, backoff_mult = 10)
       super()
       unless api.end_with?('/')
         api += '/'
       end
       @server_secret = server_secret
       @api = api
+      @local_mode = local_mode
       @backoff_multiplier = backoff_mult
       @session_id = SecureRandom.uuid
     end
 
     def post_helper(endpoint, body, retries = 0, backoff = 1)
+      return nil unless !@local_mode
       http = HTTP.headers(
         {"STATSIG-API-KEY" => @server_secret,
         "STATSIG-CLIENT-TIME" => (Time.now.to_f * 1000).to_s,

data/lib/spec_store.rb

@@ -5,10 +5,10 @@ require 'id_list'
 
 module Statsig
   class SpecStore
-    def initialize(network, error_callback = nil, config_sync_interval = 10, id_lists_sync_interval = 60)
+    def initialize(network, error_callback = nil, rulesets_sync_interval = 10, id_lists_sync_interval = 60)
       @network = network
       @last_sync_time = 0
-      @config_sync_interval = config_sync_interval
+      @rulesets_sync_interval = rulesets_sync_interval
       @id_lists_sync_interval = id_lists_sync_interval
       @store = {
         :gates => {},
@@ -16,8 +16,8 @@ module Statsig
         :layers => {},
         :id_lists => {},
       }
-      e = download_config_specs
-      error_callback.call(e) unless error_callback.nil?
+      @error_callback = error_callback
+      download_config_specs
       get_id_lists
 
       @config_sync_thread = sync_config_specs
@@ -65,7 +65,7 @@ module Statsig
     def sync_config_specs
       Thread.new do
         loop do
-          sleep @config_sync_interval
+          sleep @rulesets_sync_interval
           download_config_specs
         end
       end
@@ -81,10 +81,16 @@ module Statsig
     end
 
     def download_config_specs
+      e = get_config_specs_from_network
+      @error_callback.call(e) unless e.nil? or @error_callback.nil?
+    end
+
+    def get_config_specs_from_network
       begin
         response, e = @network.post_helper('download_config_specs', JSON.generate({'sinceTime' => @last_sync_time}))
         if e.nil?
           process(JSON.parse(response.body))
+          nil
         else
           e
         end
@@ -145,7 +151,7 @@ module Statsig
             next
           end
 
-          # skip if server list returns a newer file
+          # reset local list 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

data/lib/statsig.rb

@@ -30,7 +30,7 @@ module Statsig
     @shared_instance&.get_layer(user, layer_name)
   end
 
-  def self.log_event(user, event_name, value, metadata)
+  def self.log_event(user, event_name, value = nil, metadata = nil)
     ensure_initialized
     @shared_instance&.log_event(user, event_name, value, metadata)
   end
@@ -42,10 +42,20 @@ module Statsig
     @shared_instance = nil
   end
 
+  def self.override_gate(gate_name, gate_value)
+    ensure_initialized
+    @shared_instance&.override_gate(gate_name, gate_value)
+  end
+
+  def self.override_config(config_name, config_value)
+    ensure_initialized
+    @shared_instance&.override_config(config_name, config_value)
+  end
+
   def self.get_statsig_metadata
     {
       'sdkType' => 'ruby-server',
-      'sdkVersion' => '1.9.2',
+      'sdkVersion' => '1.12.0',
     }
   end
 

data/lib/statsig_driver.rb

@@ -22,9 +22,9 @@ class StatsigDriver
     @options = options || StatsigOptions.new
     @shutdown = false
     @secret_key = secret_key
-    @net = Statsig::Network.new(secret_key, @options.api_url_base)
-    @logger = Statsig::StatsigLogger.new(@net)
-    @evaluator = Statsig::Evaluator.new(@net, error_callback)
+    @net = Statsig::Network.new(secret_key, @options.api_url_base, @options.local_mode)
+    @logger = Statsig::StatsigLogger.new(@net, @options)
+    @evaluator = Statsig::Evaluator.new(@net, @options, error_callback)
   end
 
   def check_gate(user, gate_name)
@@ -98,6 +98,14 @@ class StatsigDriver
     @evaluator.shutdown
   end
 
+  def override_gate(gate_name, gate_value)
+    @evaluator.override_gate(gate_name, gate_value)
+  end
+
+  def override_config(config_name, config_value)
+    @evaluator.override_config(config_name, config_value)
+  end
+
   private
 
   def verify_inputs(user, config_name, variable_name)
@@ -127,8 +135,14 @@ class StatsigDriver
   end
 
   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.'
+    if user.nil? ||
+      !user.instance_of?(StatsigUser) ||
+      (
+        # user_id is nil and custom_ids is not a hash with entries
+        !user.user_id.is_a?(String) &&
+        (!user.custom_ids.is_a?(Hash) || user.custom_ids.size == 0)
+      )
+      raise 'Must provide a valid StatsigUser with a user_id or at least a custom ID. See https://docs.statsig.com/messages/serverRequiredUserID/ for more details.'
     end
   end
 

data/lib/statsig_logger.rb

@@ -6,15 +6,16 @@ $layer_exposure_event = 'statsig::layer_exposure'
 
 module Statsig
   class StatsigLogger
-    def initialize(network)
+    def initialize(network, options)
       @network = network
       @events = []
       @background_flush = periodic_flush
+      @options = options
     end
 
     def log_event(event)
       @events.push(event)
-      if @events.length >= 500
+      if @events.length >= @options.logging_max_buffer_size
         flush
       end
     end
@@ -70,7 +71,7 @@ module Statsig
     def periodic_flush
       Thread.new do
         loop do
-          sleep 60
+          sleep @options.logging_interval_seconds
           flush
         end
       end
@@ -83,8 +84,9 @@ module Statsig
       if @events.length == 0
         return
       end
-      flush_events = @events.map { |e| e.serialize }
+      events_clone = @events
       @events = []
+      flush_events = events_clone.map { |e| e.serialize }
 
       @network.post_logs(flush_events)
     end

data/lib/statsig_options.rb

@@ -1,9 +1,26 @@
 class StatsigOptions
-  attr_reader :environment
-  attr_reader :api_url_base
+  attr_accessor :environment
+  attr_accessor :api_url_base
+  attr_accessor :rulesets_sync_interval
+  attr_accessor :idlists_sync_interval
+  attr_accessor :logging_interval_seconds
+  attr_accessor :logging_max_buffer_size
+  attr_accessor :local_mode
 
-  def initialize(environment = nil, api_url_base = 'https://statsigapi.net/v1')
+  def initialize(
+    environment=nil,
+    api_url_base='https://statsigapi.net/v1',
+    rulesets_sync_interval: 10,
+    idlists_sync_interval: 60,
+    logging_interval_seconds: 60,
+    logging_max_buffer_size: 1000,
+    local_mode: false)
     @environment = environment.is_a?(Hash) ? environment : nil
     @api_url_base = api_url_base
+    @rulesets_sync_interval = rulesets_sync_interval
+    @idlists_sync_interval = idlists_sync_interval
+    @logging_interval_seconds = logging_interval_seconds
+    @logging_max_buffer_size = [logging_max_buffer_size, 1000].min
+    @local_mode = local_mode
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statsig
 version: !ruby/object:Gem::Version
-  version: 1.9.2
+  version: 1.12.0
 platform: ruby
 authors:
 - Statsig, Inc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-29 00:00:00.000000000 Z
+date: 2022-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -153,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Statsig server SDK for Ruby