statsig 1.21.0 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e976fe13de26ad1653e42b8a5a710210b51234cb96e6eaed6cbd350097f2370f
-  data.tar.gz: d0a3e427187fd4ae7cd0ff0b0c0e3c2bb88c3cf5dd7ed14a272f5dae89b18ea1
+  metadata.gz: 89aaef291fd8cbd82af8bcf380894ea554588988b2de66507482420b475c8367
+  data.tar.gz: 3f535a1ce2a9af6e811c77df334b3b58a3c2503857f74bbf5b280764cfb041f1
 SHA512:
-  metadata.gz: 2eeaf918074df7b66ffd9746d7f1717efa1912be27e86698c44bd57869f2ca023590d5db9779bbf0b3312a26735781b51afc5fd7a5e726f13fc5af00f7395fec
-  data.tar.gz: '08d264d18cd2c772f05886782999e8c5703cf92d006a3395f57af84795b4cd309b8a7efe4d98b9e9d62378f584eb3735f3c299f859f0a46e660013e543780dca'
+  metadata.gz: 16074e02fd22c2d0bc64e8adbd4b2551d46509e60f161b9ff5009ea28e13a995f13e0abd89c48c1c737d80dad1a869b8f15de8ac2b896a47ad6da54cdadbdd70
+  data.tar.gz: ac6e8241c8132844a0ee5e8858578ab3475cb227e48847fb840d4ef15219828f58c38f24d2c2e5e2bfe26714bda07f8c1068f9a15af675d4320e4a90c6c2a7c6

data/lib/interfaces/data_store.rb

@@ -2,6 +2,9 @@
 module Statsig
   module Interfaces
     class IDataStore
+      CONFIG_SPECS_KEY = "statsig.cache"
+      ID_LISTS_KEY = "statsig.id_lists"
+
       def init
       end
 
@@ -14,6 +17,14 @@ module Statsig
 
       def shutdown
       end
+
+      ##
+      # Determines whether the SDK should poll for updates from
+      # the data adapter (instead of Statsig network) for the given key
+      #
+      # @param key Key of stored item to poll from data adapter
+      def should_be_used_for_querying_updates(key)
+      end
     end
   end
 end

data/lib/network.rb

@@ -20,16 +20,18 @@ module Statsig
   class Network
     extend T::Sig
 
-    sig { params(server_secret: String, api: String, local_mode: T::Boolean, backoff_mult: Integer).void }
+    sig { params(server_secret: String, options: StatsigOptions, backoff_mult: Integer).void }
 
-    def initialize(server_secret, api, local_mode, backoff_mult = 10)
+    def initialize(server_secret, options, backoff_mult = 10)
       super()
+      api = options.api_url_base
       unless api.end_with?('/')
         api += '/'
       end
       @server_secret = server_secret
       @api = api
-      @local_mode = local_mode
+      @local_mode = options.local_mode
+      @timeout = options.network_timeout
       @backoff_multiplier = backoff_mult
       @session_id = SecureRandom.uuid
     end
@@ -52,6 +54,9 @@ module Statsig
           "STATSIG-SDK-TYPE" => meta['sdkType'],
           "STATSIG-SDK-VERSION" => meta['sdkVersion'],
         }).accept(:json)
+      if @timeout
+        http = http.timeout(@timeout)
+      end
       begin
         res = http.post(@api + endpoint, body: body)
       rescue StandardError => e

data/lib/spec_store.rb

@@ -8,8 +8,6 @@ require 'concurrent-ruby'
 module Statsig
   class SpecStore
 
-    CONFIG_SPECS_KEY = "statsig.cache"
-
     attr_accessor :last_config_sync_time
     attr_accessor :initial_config_sync_time
     attr_accessor :init_reason
@@ -44,7 +42,7 @@ module Statsig
             puts 'data_store gets priority over bootstrap_values. bootstrap_values will be ignored'
           else
             init_diagnostics&.mark("bootstrap", "start", "load")
-            if process(options.bootstrap_values)
+            if process_specs(options.bootstrap_values)
               @init_reason = EvaluationReason::BOOTSTRAP
             end
             init_diagnostics&.mark("bootstrap", "end", "load", @init_reason == EvaluationReason::BOOTSTRAP)
@@ -57,7 +55,7 @@ module Statsig
       unless @options.data_store.nil?
         init_diagnostics&.mark("data_store", "start", "load")
         @options.data_store.init
-        load_from_storage_adapter
+        load_config_specs_from_storage_adapter(init_diagnostics: init_diagnostics)
         init_diagnostics&.mark("data_store", "end", "load", @init_reason == EvaluationReason::DATA_ADAPTER)
       end
 
@@ -66,7 +64,11 @@ module Statsig
       end
 
       @initial_config_sync_time = @last_config_sync_time == 0 ? -1 : @last_config_sync_time
-      get_id_lists(init_diagnostics)
+      if !@options.data_store.nil?
+        get_id_lists_from_adapter(init_diagnostics)
+      else
+        get_id_lists_from_network(init_diagnostics)
+      end
 
       @config_sync_thread = sync_config_specs
       @id_lists_sync_thread = sync_id_lists
@@ -132,27 +134,38 @@ module Statsig
 
     private
 
-    def load_from_storage_adapter
-      cached_values = @options.data_store.get(CONFIG_SPECS_KEY)
-      if cached_values.nil?
-        return
-      end
-      process(cached_values, true)
+    def load_config_specs_from_storage_adapter(init_diagnostics: nil)
+      init_diagnostics&.mark("download_config_specs", "start", "fetch_from_adapter")
+      cached_values = @options.data_store.get(Interfaces::IDataStore::CONFIG_SPECS_KEY)
+      init_diagnostics&.mark("download_config_specs", "end", "fetch_from_adapter", true)
+      return if cached_values.nil?
+
+      init_diagnostics&.mark("download_config_specs", "start", "process")
+      process_specs(cached_values, from_adapter: true)
       @init_reason = EvaluationReason::DATA_ADAPTER
+      init_diagnostics&.mark("download_config_specs", "end", "process", @init_reason)
+    rescue StandardError
+      # Fallback to network
+      init_diagnostics&.mark("download_config_specs", "end", "fetch_from_adapter", false)
+      download_config_specs(init_diagnostics)
     end
 
-    def save_to_storage_adapter(specs_string)
+    def save_config_specs_to_storage_adapter(specs_string)
       if @options.data_store.nil?
         return
       end
-      @options.data_store.set(CONFIG_SPECS_KEY, specs_string)
+      @options.data_store.set(Interfaces::IDataStore::CONFIG_SPECS_KEY, specs_string)
     end
 
     def sync_config_specs
       Thread.new do
         loop do
           sleep @options.rulesets_sync_interval
-          download_config_specs
+          if @options.data_store&.should_be_used_for_querying_updates(Interfaces::IDataStore::CONFIG_SPECS_KEY)
+            load_config_specs_from_storage_adapter
+          else
+            download_config_specs
+          end
         end
       end
     end
@@ -161,7 +174,11 @@ module Statsig
       Thread.new do
         loop do
           sleep @id_lists_sync_interval
-          get_id_lists
+          if @options.data_store&.should_be_used_for_querying_updates(Interfaces::IDataStore::ID_LISTS_KEY)
+            get_id_lists_from_adapter
+          else
+            get_id_lists_from_network
+          end
         end
       end
     end
@@ -182,7 +199,7 @@ module Statsig
           unless response.nil?
             init_diagnostics&.mark("download_config_specs", "start", "process")
 
-            if process(response.body)
+            if process_specs(response.body)
               @init_reason = EvaluationReason::NETWORK
               @rules_updated_callback.call(response.body.to_s, @last_config_sync_time) unless response.body.nil? or @rules_updated_callback.nil?
             end
@@ -201,7 +218,7 @@ module Statsig
       @error_callback.call(error) unless error.nil? or @error_callback.nil?
     end
 
-    def process(specs_string, from_adapter = false)
+    def process_specs(specs_string, from_adapter: false)
       if specs_string.nil?
         return false
       end
@@ -236,12 +253,33 @@ module Statsig
       @specs[:experiment_to_layer] = new_exp_to_layer
 
       unless from_adapter
-        save_to_storage_adapter(specs_string)
+        save_config_specs_to_storage_adapter(specs_string)
       end
       true
     end
 
-    def get_id_lists(init_diagnostics = nil)
+    def get_id_lists_from_adapter(init_diagnostics = nil)
+      init_diagnostics&.mark("get_id_lists", "start", "fetch_from_adapter")
+      cached_values = @options.data_store.get(Interfaces::IDataStore::ID_LISTS_KEY)
+      return if cached_values.nil?
+
+      init_diagnostics&.mark("get_id_lists", "end", "fetch_from_adapter", true)
+      id_lists = JSON.parse(cached_values)
+      process_id_lists(id_lists, init_diagnostics, from_adapter: true)
+    rescue StandardError
+      # Fallback to network
+      init_diagnostics&.mark("get_id_lists", "end", "fetch_from_adapter", false)
+      get_id_lists_from_network(init_diagnostics)
+    end
+
+    def save_id_lists_to_adapter(id_lists)
+      if @options.data_store.nil?
+        return
+      end
+      @options.data_store.set(Interfaces::IDataStore::CONFIG_SPECS_KEY, JSON.generate(id_lists))
+    end
+
+    def get_id_lists_from_network(init_diagnostics = nil)
       init_diagnostics&.mark("get_id_lists", "start", "network_request")
       response, e = @network.post_helper('get_id_lists', JSON.generate({ 'statsigMetadata' => Statsig.get_statsig_metadata }))
       if !e.nil? || response.nil?
@@ -251,69 +289,91 @@ module Statsig
 
       begin
         server_id_lists = JSON.parse(response)
-        local_id_lists = @specs[:id_lists]
-        if !server_id_lists.is_a?(Hash) || !local_id_lists.is_a?(Hash)
-          return
-        end
-        tasks = []
-
-        if server_id_lists.length == 0
-          return
-        end
+        process_id_lists(server_id_lists, init_diagnostics)
+      rescue
+        # Ignored, will try again
+      end
+    end
 
-        init_diagnostics&.mark("get_id_lists", "start", "process", server_id_lists.length)
+    def process_id_lists(new_id_lists, init_diagnostics, from_adapter: false)
+      local_id_lists = @specs[:id_lists]
+      if !new_id_lists.is_a?(Hash) || !local_id_lists.is_a?(Hash)
+        return
+      end
+      tasks = []
 
-        server_id_lists.each do |list_name, list|
-          server_list = IDList.new(list)
-          local_list = get_id_list(list_name)
+      if new_id_lists.length == 0
+        return
+      end
 
-          unless local_list.is_a? IDList
-            local_list = IDList.new(list)
-            local_list.size = 0
-            local_id_lists[list_name] = local_list
-          end
+      init_diagnostics&.mark("get_id_lists", "start", "process", new_id_lists.length)
 
-          # 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
+      new_id_lists.each do |list_name, list|
+        new_list = IDList.new(list)
+        local_list = get_id_list(list_name)
 
-          # 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
-            local_id_lists[list_name] = local_list
-          end
+        unless local_list.is_a? IDList
+          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
+        # skip if server list is invalid
+        if new_list.url.nil? || new_list.creation_time < local_list.creation_time || new_list.file_id.nil?
+          next
+        end
 
-          tasks << Concurrent::Promise.execute(:executor => @id_list_thread_pool) do
-            download_single_id_list(local_list)
-          end
+        # reset local list if server list returns a newer file
+        if new_list.file_id != local_list.file_id && new_list.creation_time >= local_list.creation_time
+          local_list = IDList.new(list)
+          local_list.size = 0
+          local_id_lists[list_name] = local_list
         end
 
-        result = Concurrent::Promise.all?(*tasks).execute.wait(@id_lists_sync_interval)
-        if result.state != :fulfilled
-          init_diagnostics&.mark("get_id_lists", "end", "process", false)
-          return # timed out
+        # skip if server list is no bigger than local list, which means nothing new to read
+        if new_list.size <= local_list.size
+          next
         end
 
-        delete_lists = []
-        local_id_lists.each do |list_name, list|
-          unless server_id_lists.key? list_name
-            delete_lists.push list_name
+        tasks << Concurrent::Promise.execute(:executor => @id_list_thread_pool) do
+          if from_adapter
+            get_single_id_list_from_adapter(local_list)
+          else
+            download_single_id_list(local_list)
           end
         end
-        delete_lists.each do |list_name|
-          local_id_lists.delete list_name
+      end
+
+      result = Concurrent::Promise.all?(*tasks).execute.wait(@id_lists_sync_interval)
+      if result.state != :fulfilled
+        init_diagnostics&.mark("get_id_lists", "end", "process", false)
+        return # timed out
+      end
+
+      delete_lists = []
+      local_id_lists.each do |list_name, list|
+        unless new_id_lists.key? list_name
+          delete_lists.push list_name
         end
-        init_diagnostics&.mark("get_id_lists", "end", "process", true)
-      rescue
-        # Ignored, will try again
       end
+      delete_lists.each do |list_name|
+        local_id_lists.delete list_name
+      end
+      init_diagnostics&.mark("get_id_lists", "end", "process", true)
+    end
+
+    def get_single_id_list_from_adapter(list)
+      cached_values = @options.data_store.get("#{Interfaces::IDataStore::ID_LISTS_KEY}::#{list.name}")
+      content = cached_values.to_s
+      process_single_id_list(list, content)
+    rescue StandardError
+      nil
+    end
+
+    def save_single_id_list_to_adapter(name, content)
+      return if @options.data_store.nil?
+
+      @options.data_store.set("#{Interfaces::IDataStore::ID_LISTS_KEY}::#{name}", content)
     end
 
     def download_single_id_list(list)
@@ -325,9 +385,19 @@ module Statsig
         content_length = Integer(res['content-length'])
         nil if content_length.nil? || content_length <= 0
         content = res.body.to_s
+        success = process_single_id_list(list, content, content_length)
+        save_single_id_list_to_adapter(list.name, content) unless success.nil? || !success
+      rescue
+        nil
+      end
+    end
+
+    def process_single_id_list(list, content, content_length = nil)
+      false unless list.is_a? IDList
+      begin
         unless content.is_a?(String) && (content[0] == '-' || content[0] == '+')
           @specs[:id_lists].delete(list.name)
-          return
+          return false
         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/)
@@ -343,9 +413,14 @@ module Statsig
           end
         end
         list.ids = ids_clone
-        list.size = list.size + content_length
+        list.size = if content_length.nil?
+                      list.size + content.bytesize
+                    else
+                      list.size + content_length
+                    end
+        return true
       rescue
-        nil
+        return false
       end
     end
   end

data/lib/statsig.rb

@@ -227,7 +227,7 @@ module Statsig
   def self.get_statsig_metadata
     {
       'sdkType' => 'ruby-server',
-      'sdkVersion' => '1.21.0',
+      'sdkVersion' => '1.23.0',
     }
   end
 

data/lib/statsig_driver.rb

@@ -36,7 +36,7 @@ class StatsigDriver
       @options = options || StatsigOptions.new
       @shutdown = false
       @secret_key = secret_key
-      @net = Statsig::Network.new(secret_key, @options.api_url_base, @options.local_mode)
+      @net = Statsig::Network.new(secret_key, @options)
       @logger = Statsig::StatsigLogger.new(@net, @options)
       @evaluator = Statsig::Evaluator.new(@net, @options, error_callback, @init_diagnostics)
       @init_diagnostics.mark("overall", "end")

data/lib/statsig_options.rb

@@ -75,6 +75,10 @@ class StatsigOptions
   # default: false
   attr_accessor :disable_sorbet_logging_handlers
 
+  sig { returns(T.any(Integer, NilClass)) }
+  # Number of seconds before a network call is timed out
+  attr_accessor :network_timeout
+
   sig do
     params(
       environment: T.any(T::Hash[String, String], NilClass),
@@ -89,7 +93,8 @@ class StatsigOptions
       data_store: T.any(Statsig::Interfaces::IDataStore, NilClass),
       idlist_threadpool_size: Integer,
       disable_diagnostics_logging: T::Boolean,
-      disable_sorbet_logging_handlers: T::Boolean
+      disable_sorbet_logging_handlers: T::Boolean,
+      network_timeout: T.any(Integer, NilClass)
     ).void
   end
 
@@ -106,7 +111,8 @@ class StatsigOptions
     data_store: nil,
     idlist_threadpool_size: 3,
     disable_diagnostics_logging: false,
-    disable_sorbet_logging_handlers: false)
+    disable_sorbet_logging_handlers: false,
+    network_timeout: nil)
     @environment = environment.is_a?(Hash) ? environment : nil
     @api_url_base = api_url_base
     @rulesets_sync_interval = rulesets_sync_interval
@@ -120,5 +126,6 @@ class StatsigOptions
     @idlist_threadpool_size = idlist_threadpool_size
     @disable_diagnostics_logging = disable_diagnostics_logging
     @disable_sorbet_logging_handlers = disable_sorbet_logging_handlers
+    @network_timeout = network_timeout
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statsig
 version: !ruby/object:Gem::Version
-  version: 1.21.0
+  version: 1.23.0
 platform: ruby
 authors:
 - Statsig, Inc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-31 00:00:00.000000000 Z
+date: 2023-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.27
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: user_agent_parser
   requirement: !ruby/object:Gem::Requirement
@@ -215,7 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Statsig server SDK for Ruby