amplitude-experiment 1.7.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6562a2b13fb38d240e3d83762e442a558478db59f3fff36bdff10b6589cfab0d
-  data.tar.gz: 432ea0ff64724c882ad97aae3ce95ae8d8a203f9c90bfe34afd5629e00dbba28
+  metadata.gz: f40750aa31cc9abd90da453ed66d9c8af7ab7732d4887b248e47b9a878a159a7
+  data.tar.gz: 87064809c68b48a71ec4769f36fb797fc6757b763626ceb9e6a5e5a1d5656049
 SHA512:
-  metadata.gz: 507368b7f4db8a28dfc866e0df203f724a1d2911af19dab24fada0bb7327e362d185057c891d534421c7816ec12953ad6555a0252b9bfa7d4922ffaea16bc935
-  data.tar.gz: d7ad16548702c918919a9d3b4afe874d396c8c5e98fb5010ebb3f8c0f0b476ad86d4568ed4660a74040a5ee85d4a9e01197560039b19d94659ec0e38d67b0868
+  metadata.gz: c235e7a780773a4ea5873a1139917fdb3929b4bb27139a02a960f040c863226cc01f0ac3188fc4628c45897d2823c41ba383dc1d9f517f15b69c671d971b6397
+  data.tar.gz: cd4d84c2d088dfc265910c7a57147f9d54ef34d747959d172ff1623b21f96b85f1ff409bdde06900aedec6a15941e19b2a0d83da5f0ff8d8e09b4dc1027f08d4

data/lib/amplitude-experiment.rb

@@ -6,6 +6,7 @@ require 'experiment/user'
 require 'experiment/variant'
 require 'experiment/factory'
 require 'experiment/remote/client'
+require 'experiment/remote/fetch_options'
 require 'experiment/local/client'
 require 'experiment/local/config'
 require 'experiment/local/assignment/assignment'

data/lib/experiment/remote/client.rb

@@ -25,7 +25,7 @@ module AmplitudeExperiment
     # @param [User] user
     # @return [Hash] Variants Hash
     def fetch(user)
-      AmplitudeExperiment.filter_default_variants(fetch_internal(user))
+      AmplitudeExperiment.filter_default_variants(fetch_internal(user, nil))
     rescue StandardError => e
       @logger.error("[Experiment] Failed to fetch variants: #{e.message}")
       {}
@@ -36,9 +36,10 @@ module AmplitudeExperiment
     # This method will automatically retry if configured (default). This function differs from fetch as it will
     # return a default variant object if the flag was evaluated but the user was not assigned (i.e. off).
     # @param [User] user
+    # @param [FetchOptions] fetch_options
     # @return [Hash] Variants Hash
-    def fetch_v2(user)
-      fetch_internal(user)
+    def fetch_v2(user, fetch_options = nil)
+      fetch_internal(user, fetch_options)
     rescue StandardError => e
       @logger.error("[Experiment] Failed to fetch variants: #{e.message}")
       {}
@@ -51,7 +52,7 @@ module AmplitudeExperiment
     # @yield [User, Hash] callback block takes user object and variants hash
     def fetch_async(user, &callback)
       Thread.new do
-        variants = fetch_internal(user)
+        variants = AmplitudeExperiment.filter_default_variants(fetch_internal(user, nil))
         yield(user, variants) unless callback.nil?
         variants
       rescue StandardError => e
@@ -67,10 +68,10 @@ module AmplitudeExperiment
     # This method will automatically retry if configured (default).
     # @param [User] user
     # @yield [User, Hash] callback block takes user object and variants hash
-    def fetch_async_v2(user, &callback)
+    def fetch_async_v2(user, fetch_options = nil, &callback)
       Thread.new do
-        variants = fetch_internal(user)
-        yield(user, filter_default_variants(variants)) unless callback.nil?
+        variants = fetch_internal(user, fetch_options)
+        yield(user, variants) unless callback.nil?
         variants
       rescue StandardError => e
         @logger.error("[Experiment] Failed to fetch variants: #{e.message}")
@@ -82,14 +83,15 @@ module AmplitudeExperiment
     private
 
     # @param [User] user
-    def fetch_internal(user)
+    # @param [FetchOptions] fetch_options
+    def fetch_internal(user, fetch_options)
       @logger.debug("[Experiment] Fetching variants for user: #{user.as_json}")
-      do_fetch(user, @config.connect_timeout_millis, @config.fetch_timeout_millis)
+      do_fetch(user, fetch_options, @config.connect_timeout_millis, @config.fetch_timeout_millis)
     rescue StandardError => e
       @logger.error("[Experiment] Fetch failed: #{e.message}")
       if should_retry_fetch?(e)
         begin
-          retry_fetch(user)
+          retry_fetch(user, fetch_options)
         rescue StandardError => err
           @logger.error("[Experiment] Retry Fetch failed: #{err.message}")
         end
@@ -98,7 +100,8 @@ module AmplitudeExperiment
     end
 
     # @param [User] user
-    def retry_fetch(user)
+    # @param [FetchOptions] fetch_options
+    def retry_fetch(user, fetch_options)
       return {} if @config.fetch_retries.zero?
 
       @logger.debug('[Experiment] Retrying fetch')
@@ -107,7 +110,7 @@ module AmplitudeExperiment
       @config.fetch_retries.times do
         sleep(delay_millis.to_f / 1000.0)
         begin
-          return do_fetch(user, @config.connect_timeout_millis, @config.fetch_retry_timeout_millis)
+          return do_fetch(user, fetch_options, @config.connect_timeout_millis, @config.fetch_retry_timeout_millis)
         rescue StandardError => e
           @logger.error("[Experiment] Retry failed: #{e.message}")
           err = e
@@ -118,15 +121,24 @@ module AmplitudeExperiment
     end
 
     # @param [User] user
+    # @param [FetchOptions] fetch_options
     # @param [Integer] connect_timeout_millis
     # @param [Integer] fetch_timeout_millis
-    def do_fetch(user, connect_timeout_millis, fetch_timeout_millis)
+    def do_fetch(user, fetch_options, connect_timeout_millis, fetch_timeout_millis)
       start_time = Time.now
       user_context = add_context(user)
       headers = {
         'Authorization' => "Api-Key #{@api_key}",
         'Content-Type' => 'application/json;charset=utf-8'
       }
+      unless fetch_options.nil?
+        unless fetch_options.tracks_assignment.nil?
+          headers['X-Amp-Exp-Track'] = fetch_options.tracks_assignment ? 'track' : 'no-track'
+        end
+        unless fetch_options.tracks_exposure.nil?
+          headers['X-Amp-Exp-Exposure-Track'] = fetch_options.tracks_exposure ? 'track' : 'no-track'
+        end
+      end
       connect_timeout = connect_timeout_millis.to_f / 1000 if (connect_timeout_millis.to_f / 1000) > 0
       read_timeout = fetch_timeout_millis.to_f / 1000 if (fetch_timeout_millis.to_f / 1000) > 0
       http = PersistentHttpClient.get(@uri, { open_timeout: connect_timeout, read_timeout: read_timeout }, @api_key)

data/lib/experiment/remote/fetch_options.rb

@@ -0,0 +1,19 @@
+module AmplitudeExperiment
+  # Fetch options
+  class FetchOptions
+    # Whether to track assignment events.
+    # If not provided, the default is null, which will use server default (to track assignment events).
+    # @return [Boolean, nil] the value of tracks_assignment
+    attr_accessor :tracks_assignment
+
+    # Whether to track exposure events.
+    # If not provided, the default is null, which will use server default (to not track exposure events).
+    # @return [Boolean, nil] the value of tracks_exposure
+    attr_accessor :tracks_exposure
+
+    def initialize(tracks_assignment: nil, tracks_exposure: nil)
+      @tracks_assignment = tracks_assignment
+      @tracks_exposure = tracks_exposure
+    end
+  end
+end

data/lib/experiment/version.rb

@@ -1,3 +1,3 @@
 module AmplitudeExperiment
-  VERSION = '1.7.1'.freeze
+  VERSION = '1.8.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amplitude-experiment
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.8.0
 platform: ruby
 authors:
 - Amplitude
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-04 00:00:00.000000000 Z
+date: 2025-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -216,6 +216,7 @@ files:
 - lib/experiment/persistent_http_client.rb
 - lib/experiment/remote/client.rb
 - lib/experiment/remote/config.rb
+- lib/experiment/remote/fetch_options.rb
 - lib/experiment/user.rb
 - lib/experiment/util/flag_config.rb
 - lib/experiment/util/hash.rb