statsig 1.29.0 → 1.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '093cc05e0b8f3bb7e2f0f019cf36ad33e5abc4c4349d2fb1faa056c1ff5aa341'
-  data.tar.gz: d66640f8b0c317ca018ff4ccc77d1d370af89b1c84416508631deb610236d519
+  metadata.gz: 72119a11268473774b98457f89017155813cdaab4c19b8f07e1aad370ae6dd17
+  data.tar.gz: 69cb96c04c6b9c322bb239332b8c406a6b543bb42b0cab6da9e641d44fa15371
 SHA512:
-  metadata.gz: f634575320cd1ababfa25816ee8ac5fe27e34c761895b4ba6b20957363e487c295767d65e123ab7d306aa1ce2f535f55cc58570f8767790948d2647ab321150b
-  data.tar.gz: d563727b175a23afa50cb68cbaf91eb49435bae46b1a48b72d9bf0ff38febeefa86b886c34cc2632f37e357c44f96a1e2586050b41e9ac156697f4105c4f9f0b
+  metadata.gz: d75c0a0d9c6529843c554d05b3ae49e6d863cd01da11f932e679bddddffab4287ef036af37c3cd8fff9310c10cd6758bc6e5435f78626245c5d1f315b91e09eb
+  data.tar.gz: b9886d0b78d1491393cfacdea4c1f4cdeae1d2a993a0f5a0875011be1083bb63e4a7721fb3a007869eaa7eaf69ad300438d8038c099e88277958d4daf6d226f7

data/lib/config_result.rb

@@ -18,6 +18,7 @@ module Statsig
     attr_accessor :evaluation_details
     attr_accessor :group_name
     attr_accessor :id_type
+    attr_accessor :target_app_ids
 
     def initialize(
       name,
@@ -30,7 +31,8 @@ module Statsig
       is_experiment_group: false,
       evaluation_details: nil,
       group_name: nil,
-      id_type: '')
+      id_type: '',
+      target_app_ids: nil)
       @name = name
       @gate_value = gate_value
       @json_value = json_value
@@ -43,6 +45,7 @@ module Statsig
       @evaluation_details = evaluation_details
       @group_name = group_name
       @id_type = id_type
+      @target_app_ids = target_app_ids
     end
 
     sig { params(config_name: String, user_persisted_values: UserPersistedValues).returns(T.nilable(ConfigResult)) }
@@ -62,7 +65,9 @@ module Statsig
         hash['rule_id'],
         hash['secondary_exposures'],
         evaluation_details: EvaluationDetails.persisted(hash['config_sync_time'], hash['init_time']),
-        group_name: hash['group_name']
+        group_name: hash['group_name'],
+        id_type: hash['id_type'],
+        target_app_ids: hash['target_app_ids']
       )
     end
 
@@ -75,7 +80,9 @@ module Statsig
         secondary_exposures: @secondary_exposures,
         config_sync_time: @evaluation_details.config_sync_time,
         init_time: @init_time,
-        group_name: @group_name
+        group_name: @group_name,
+        id_type: @id_type,
+        target_app_ids: @target_app_ids
       }
     end
   end

data/lib/error_boundary.rb

@@ -24,6 +24,7 @@ module Statsig
         end
 
         puts '[Statsig]: An unexpected exception occurred.'
+        puts e.message
         log_exception(e, tag: caller)
         res = recover.call
       end
@@ -45,6 +46,7 @@ module Statsig
           'STATSIG-API-KEY' => @sdk_key,
           'STATSIG-SDK-TYPE' => meta['sdkType'],
           'STATSIG-SDK-VERSION' => meta['sdkVersion'],
+          'STATSIG-SDK-LANGUAGE-VERSION' => meta['languageVersion'],
           'Content-Type' => 'application/json; charset=UTF-8'
         }).accept(:json)
       body = {

data/lib/evaluator.rb

@@ -31,20 +31,16 @@ module Statsig
 
     sig do
       params(
-        network: Network,
+        store: SpecStore,
         options: StatsigOptions,
-        error_callback: T.any(Method, Proc, NilClass),
-        diagnostics: Diagnostics,
-        error_boundary: ErrorBoundary,
-        logger: StatsigLogger,
         persistent_storage_utils: UserPersistentStorageUtils,
       ).void
     end
-    def initialize(network, options, error_callback, diagnostics, error_boundary, logger, persistent_storage_utils)
-      @spec_store = Statsig::SpecStore.new(network, options, error_callback, diagnostics, error_boundary, logger)
+    def initialize(store, options, persistent_storage_utils)
       UAParser.initialize_async
       CountryLookup.initialize_async
 
+      @spec_store = store
       @gate_overrides = {}
       @config_overrides = {}
       @options = options
@@ -122,7 +118,7 @@ module Statsig
           @persistent_storage_utils.add_evaluation_to_user_persisted_values(user_persisted_values, config_name, evaluation)
           @persistent_storage_utils.save_to_storage(user, config['idType'], user_persisted_values)
         end
-      # Otherwise, remove from persisted storage
+        # Otherwise, remove from persisted storage
       else
         @persistent_storage_utils.remove_experiment_from_storage(user, config['idType'], config_name)
         evaluation = eval_spec(user, config)
@@ -143,6 +139,26 @@ module Statsig
       eval_spec(user, @spec_store.get_layer(layer_name))
     end
 
+    def list_gates
+      @spec_store.gates.map { |name, _| name }
+    end
+
+    def list_configs
+      @spec_store.configs.map { |name, config| name if config['entity'] == 'dynamic_config' }.compact
+    end
+
+    def list_experiments
+      @spec_store.configs.map { |name, config| name if config['entity'] == 'experiment' }.compact
+    end
+
+    def list_autotunes
+      @spec_store.configs.map { |name, config| name if config['entity'] == 'autotune' }.compact
+    end
+
+    def list_layers
+      @spec_store.layers.map { |name, _| name }
+    end
+
     def get_client_initialize_response(user, hash, client_sdk_key)
       if @spec_store.is_ready_for_checks == false
         return nil
@@ -226,7 +242,8 @@ module Statsig
               ),
               is_experiment_group: result.is_experiment_group,
               group_name: result.group_name,
-              id_type: config['idType']
+              id_type: config['idType'],
+              target_app_ids: config['targetAppIDs']
             )
           end
 
@@ -248,7 +265,8 @@ module Statsig
           @spec_store.init_reason
         ),
         group_name: nil,
-        id_type: config['idType']
+        id_type: config['idType'],
+        target_app_ids: config['targetAppIDs']
       )
     end
 

data/lib/feature_gate.rb

@@ -0,0 +1,70 @@
+# typed: false
+
+require 'sorbet-runtime'
+
+class FeatureGate
+  extend T::Sig
+
+  sig { returns(String) }
+  attr_accessor :name
+
+  sig { returns(T::Boolean) }
+  attr_accessor :value
+
+  sig { returns(String) }
+  attr_accessor :rule_id
+
+  sig { returns(T.nilable(String)) }
+  attr_accessor :group_name
+
+  sig { returns(String) }
+  attr_accessor :id_type
+
+  sig { returns(T.nilable(Statsig::EvaluationDetails)) }
+  attr_accessor :evaluation_details
+
+  sig { returns(T.nilable(T::Array[String])) }
+  attr_accessor :target_app_ids
+
+  sig do
+    params(
+      name: String,
+      value: T::Boolean,
+      rule_id: String,
+      group_name: T.nilable(String),
+      id_type: String,
+      evaluation_details: T.nilable(Statsig::EvaluationDetails),
+      target_app_ids: T.nilable(T::Array[String])
+    ).void
+  end
+  def initialize(
+    name,
+    value: false,
+    rule_id: '',
+    group_name: nil,
+    id_type: '',
+    evaluation_details: nil,
+    target_app_ids: nil
+  )
+    @name = name
+    @value = value
+    @rule_id = rule_id
+    @group_name = group_name
+    @id_type = id_type
+    @evaluation_details = evaluation_details
+    @target_app_ids = target_app_ids
+  end
+
+  sig { params(res: Statsig::ConfigResult).returns(FeatureGate) }
+  def self.from_config_result(res)
+    new(
+      res.name,
+      value: res.gate_value,
+      rule_id: res.rule_id,
+      group_name: res.group_name,
+      id_type: res.id_type,
+      evaluation_details: res.evaluation_details,
+      target_app_ids: res.target_app_ids
+    )
+  end
+end

data/lib/network.rb

@@ -42,6 +42,7 @@ module Statsig
             'Content-Type' => 'application/json; charset=UTF-8',
             'STATSIG-SDK-TYPE' => meta['sdkType'],
             'STATSIG-SDK-VERSION' => meta['sdkVersion'],
+            'STATSIG-SDK-LANGUAGE-VERSION' => meta['languageVersion'],
             'Accept-Encoding' => 'gzip'
           }
         ).accept(:json)

data/lib/spec_store.rb

@@ -13,7 +13,7 @@ module Statsig
     attr_accessor :initial_config_sync_time
     attr_accessor :init_reason
 
-    def initialize(network, options, error_callback, diagnostics, error_boundary, logger)
+    def initialize(network, options, error_callback, diagnostics, error_boundary, logger, secret_key)
       @init_reason = EvaluationReason::UNINITIALIZED
       @network = network
       @options = options
@@ -35,6 +35,7 @@ module Statsig
       @diagnostics = diagnostics
       @error_boundary = error_boundary
       @logger = logger
+      @secret_key = secret_key
 
       @id_list_thread_pool = Concurrent::FixedThreadPool.new(
         options.idlist_threadpool_size,
@@ -121,6 +122,18 @@ module Statsig
       @specs[:layers][layer_name]
     end
 
+    def gates
+      @specs[:gates]
+    end
+
+    def configs
+      @specs[:configs]
+    end
+
+    def layers
+      @specs[:layers]
+    end
+
     def get_id_list(list_name)
       @specs[:id_lists][list_name]
     end
@@ -276,6 +289,12 @@ module Statsig
       specs_json = JSON.parse(specs_string)
       return false unless specs_json.is_a? Hash
 
+      hashed_sdk_key_used = specs_json['hashed_sdk_key_used']
+      unless hashed_sdk_key_used.nil? or hashed_sdk_key_used == Statsig::HashUtils.djb2(@secret_key)
+        err_boundary.log_exception(Statsig::InvalidSDKKeyResponse.new)
+        return false
+      end
+
       @last_config_sync_time = specs_json['time'] || @last_config_sync_time
       return false unless specs_json['has_updates'] == true &&
         !specs_json['feature_gates'].nil? &&

data/lib/statsig.rb

@@ -26,6 +26,23 @@ module Statsig
     @shared_instance = StatsigDriver.new(secret_key, options, error_callback)
   end
 
+  class GetGateOptions < T::Struct
+    prop :disable_log_exposure, T::Boolean, default: false
+    prop :skip_evaluation, T::Boolean, default: false
+  end
+
+  sig { params(user: StatsigUser, gate_name: String, options: GetGateOptions).returns(FeatureGate) }
+  ##
+  # Gets the gate, evaluated against the given user. An exposure event will automatically be logged for the gate.
+  #
+  # @param user A StatsigUser object used for the evaluation
+  # @param gate_name The name of the gate being checked
+  # @param options Additional options for evaluating the gate
+  def self.get_gate(user, gate_name, options = GetGateOptions.new)
+    ensure_initialized
+    @shared_instance&.get_gate(user, gate_name, options)
+  end
+
   class CheckGateOptions < T::Struct
     prop :disable_log_exposure, T::Boolean, default: false
   end
@@ -212,6 +229,51 @@ module Statsig
     @shared_instance&.manually_sync_idlists
   end
 
+  sig { returns(T::Array[String]) }
+  ##
+  # Returns a list of all gate names
+  #
+  def self.list_gates
+    ensure_initialized
+    @shared_instance&.list_gates
+  end
+
+  sig { returns(T::Array[String]) }
+  ##
+  # Returns a list of all config names
+  #
+  def self.list_configs
+    ensure_initialized
+    @shared_instance&.list_configs
+  end
+
+  sig { returns(T::Array[String]) }
+  ##
+  # Returns a list of all experiment names
+  #
+  def self.list_experiments
+    ensure_initialized
+    @shared_instance&.list_experiments
+  end
+
+  sig { returns(T::Array[String]) }
+  ##
+  # Returns a list of all autotune names
+  #
+  def self.list_autotunes
+    ensure_initialized
+    @shared_instance&.list_autotunes
+  end
+
+  sig { returns(T::Array[String]) }
+  ##
+  # Returns a list of all layer names
+  #
+  def self.list_layers
+    ensure_initialized
+    @shared_instance&.list_layers
+  end
+
   sig { void }
   ##
   # Stops all Statsig activity and flushes any pending events.
@@ -265,7 +327,8 @@ module Statsig
   def self.get_statsig_metadata
     {
       'sdkType' => 'ruby-server',
-      'sdkVersion' => '1.29.0',
+      'sdkVersion' => '1.30.0',
+      'languageVersion' => RUBY_VERSION
     }
   end
 

data/lib/statsig_driver.rb

@@ -10,6 +10,7 @@ require 'statsig_options'
 require 'statsig_user'
 require 'spec_store'
 require 'dynamic_config'
+require 'feature_gate'
 require 'error_boundary'
 require 'layer'
 require 'sorbet-runtime'
@@ -38,34 +39,62 @@ class StatsigDriver
       @net = Statsig::Network.new(secret_key, @options)
       @logger = Statsig::StatsigLogger.new(@net, @options, @err_boundary)
       @persistent_storage_utils = Statsig::UserPersistentStorageUtils.new(@options)
-      @evaluator = Statsig::Evaluator.new(@net, @options, error_callback, @diagnostics, @err_boundary, @logger, @persistent_storage_utils)
+      @store = Statsig::SpecStore.new(@net, @options, error_callback, @diagnostics, @err_boundary, @logger, secret_key)
+      @evaluator = Statsig::Evaluator.new(@store, @options, @persistent_storage_utils)
       tracker.end(success: true)
 
       @logger.log_diagnostics_event(@diagnostics)
     }, caller: __method__.to_s)
   end
 
+  sig do
+    params(
+      user: StatsigUser,
+      gate_name: String,
+      disable_log_exposure: T::Boolean,
+      skip_evaluation: T::Boolean
+    ).returns(FeatureGate)
+  end
+  def get_gate_impl(user, gate_name, disable_log_exposure: false, skip_evaluation: false)
+    if skip_evaluation
+      gate = @store.get_gate(gate_name)
+      return FeatureGate.new(gate_name) if gate.nil?
+      return FeatureGate.new(gate['name'], target_app_ids: gate['targetAppIDs'])
+    end
+    user = verify_inputs(user, gate_name, 'gate_name')
+
+    res = @evaluator.check_gate(user, gate_name)
+    if res.nil?
+      res = Statsig::ConfigResult.new(gate_name)
+    end
+
+    if res == $fetch_from_server
+      res = check_gate_fallback(user, gate_name)
+      # exposure logged by the server
+    else
+      unless disable_log_exposure
+        @logger.log_gate_exposure(
+          user, res.name, res.gate_value, res.rule_id, res.secondary_exposures, res.evaluation_details
+        )
+      end
+    end
+    FeatureGate.from_config_result(res)
+  end
+
+  sig { params(user: StatsigUser, gate_name: String, options: Statsig::GetGateOptions).returns(FeatureGate) }
+  def get_gate(user, gate_name, options = Statsig::GetGateOptions.new)
+    @err_boundary.capture(task: lambda {
+      run_with_diagnostics(task: lambda {
+        get_gate_impl(user, gate_name, disable_log_exposure: options.disable_log_exposure, skip_evaluation: options.skip_evaluation)
+      }, caller: __method__.to_s)
+    }, recover: -> { false }, caller: __method__.to_s)
+  end
+
   sig { params(user: StatsigUser, gate_name: String, options: Statsig::CheckGateOptions).returns(T::Boolean) }
   def check_gate(user, gate_name, options = Statsig::CheckGateOptions.new)
     @err_boundary.capture(task: lambda {
       run_with_diagnostics(task: lambda {
-        user = verify_inputs(user, gate_name, "gate_name")
-
-        res = @evaluator.check_gate(user, gate_name)
-        if res.nil?
-          res = Statsig::ConfigResult.new(gate_name)
-        end
-
-        if res == $fetch_from_server
-          res = check_gate_fallback(user, gate_name)
-          # exposure logged by the server
-        else
-          if !options.disable_log_exposure
-            @logger.log_gate_exposure(user, res.name, res.gate_value, res.rule_id, res.secondary_exposures, res.evaluation_details)
-          end
-        end
-
-        res.gate_value
+        get_gate_impl(user, gate_name, disable_log_exposure: options.disable_log_exposure).value
       }, caller: __method__.to_s)
     }, recover: -> { false }, caller: __method__.to_s)
   end
@@ -184,6 +213,41 @@ class StatsigDriver
     }, caller: __method__.to_s)
   end
 
+  sig { returns(T::Array[String]) }
+  def list_gates
+    @err_boundary.capture(task: lambda {
+      @evaluator.list_gates
+    }, caller: __method__.to_s)
+  end
+
+  sig { returns(T::Array[String]) }
+  def list_configs
+    @err_boundary.capture(task: lambda {
+      @evaluator.list_configs
+    }, caller: __method__.to_s)
+  end
+
+  sig { returns(T::Array[String]) }
+  def list_experiments
+    @err_boundary.capture(task: lambda {
+      @evaluator.list_experiments
+    }, caller: __method__.to_s)
+  end
+
+  sig { returns(T::Array[String]) }
+  def list_autotunes
+    @err_boundary.capture(task: lambda {
+      @evaluator.list_autotunes
+    }, caller: __method__.to_s)
+  end
+
+  sig { returns(T::Array[String]) }
+  def list_layers
+    @err_boundary.capture(task: lambda {
+      @evaluator.list_layers
+    }, caller: __method__.to_s)
+  end
+
   def shutdown
     @err_boundary.capture(task: lambda {
       @shutdown = true

data/lib/statsig_errors.rb

@@ -9,4 +9,10 @@ module Statsig
   class ValueError < StandardError
 
   end
+
+  class InvalidSDKKeyResponse < StandardError
+    def initialize(msg="Incorrect SDK Key used to generate response.")
+      super
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statsig
 version: !ruby/object:Gem::Version
-  version: 1.29.0
+  version: 1.30.0
 platform: ruby
 authors:
 - Statsig, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-13 00:00:00.000000000 Z
+date: 2024-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -330,6 +330,7 @@ files:
 - lib/evaluation_details.rb
 - lib/evaluation_helpers.rb
 - lib/evaluator.rb
+- lib/feature_gate.rb
 - lib/hash_utils.rb
 - lib/id_list.rb
 - lib/interfaces/data_store.rb