amplitude-experiment 1.2.5 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39fff5d1285490313a587d9df46b1cf68bb84c5672d9927871ba83b195bbf613
-  data.tar.gz: 8f26de2e9de3585d5696646cd384841a732e9c0944520b479dc42ab423f5f168
+  metadata.gz: 5bebb227696dfbf198819fdba2640a000c67ca3a9c89d593cc03a4433ef532c8
+  data.tar.gz: fb79230b6409d82cf3d849f07cb1705abc22ae10a27e7bdfbbe6d1add1e100d0
 SHA512:
-  metadata.gz: 96bb141478ceb429381894466cd63fd937ddd8e27d4d5ac4ee4b02ed6bacfef34750f151fbfffbc088fb5562e3ee2aef23e4da9ed8907f591a37a9195fc5e8b9
-  data.tar.gz: 631d94a409a81132540504f135b56b2b6ccdfb407e9e11f250486ee9cf6d74e481e5a2dc3e23e652ed07b42abde9ffb9d2cbd9f17e1128c4248b1e55e53e2d61
+  metadata.gz: bc2885c715208465d15a6b4217e684a2caa0eb055963b1a5ff0fcdc7829239b894d685f305383cd483fff2b082592c395672c1d75140e0537543b5479e425557
+  data.tar.gz: 6d1c6b2488ddc5e28d0162e3535be65c3ed3c5767e08af71acdf7933a6f42a20c3d6994638b45713c8f9a9dd20ccfe054a9323465badff1acdd6960fb5cf9376

data/lib/amplitude-experiment.rb

@@ -15,6 +15,7 @@ require 'experiment/local/assignment/assignment_service'
 require 'experiment/local/assignment/assignment_config'
 require 'experiment/util/lru_cache'
 require 'experiment/util/hash'
+require 'experiment/error'
 
 # Amplitude Experiment Module
 module AmplitudeExperiment

data/lib/experiment/error.rb

@@ -0,0 +1,11 @@
+module AmplitudeExperiment
+  # FetchError
+  class FetchError < StandardError
+    attr_reader :status_code
+
+    def initialize(status_code, message)
+      super(message)
+      @status_code = status_code
+    end
+  end
+end

data/lib/experiment/remote/client.rb

@@ -19,24 +19,37 @@ module AmplitudeExperiment
                       else
                         Logger::INFO
                       end
-      endpoint = "#{@config.server_url}/sdk/vardata"
+      endpoint = "#{@config.server_url}/sdk/v2/vardata?v=0"
       @uri = URI(endpoint)
       raise ArgumentError, 'Experiment API key is empty' if @api_key.nil? || @api_key.empty?
     end
 
-    # Fetch all variants for a user synchronous.
+    # Fetch all variants for a user synchronously.
     #
     # This method will automatically retry if configured (default).
     # @param [User] user
     # @return [Hash] Variants Hash
     def fetch(user)
+      filter_default_variants(fetch_internal(user))
+    rescue StandardError => e
+      @logger.error("[Experiment] Failed to fetch variants: #{e.message}")
+      {}
+    end
+
+    # Fetch all variants for a user synchronously.
+    #
+    # 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
+    # @return [Hash] Variants Hash
+    def fetch_v2(user)
       fetch_internal(user)
     rescue StandardError => e
       @logger.error("[Experiment] Failed to fetch variants: #{e.message}")
       {}
     end
 
-    # Fetch all variants for a user asynchronous.
+    # Fetch all variants for a user asynchronously.
     #
     # This method will automatically retry if configured (default).
     # @param [User] user
@@ -53,6 +66,24 @@ module AmplitudeExperiment
       end
     end
 
+    # Fetch all variants for a user asynchronously. 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).
+    #
+    # 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)
+      Thread.new do
+        variants = fetch_internal(user)
+        yield(user, filter_default_variants(variants)) unless callback.nil?
+        variants
+      rescue StandardError => e
+        @logger.error("[Experiment] Failed to fetch variants: #{e.message}")
+        yield(user, {}) unless callback.nil?
+        {}
+      end
+    end
+
     private
 
     # @param [User] user
@@ -61,12 +92,14 @@ module AmplitudeExperiment
       do_fetch(user, @config.fetch_timeout_millis)
     rescue StandardError => e
       @logger.error("[Experiment] Fetch failed: #{e.message}")
-      begin
-        return retry_fetch(user)
-      rescue StandardError => err
-        @logger.error("[Experiment] Retry Fetch failed: #{err.message}")
+      if should_retry_fetch?(e)
+        begin
+          retry_fetch(user)
+        rescue StandardError => err
+          @logger.error("[Experiment] Retry Fetch failed: #{err.message}")
+        end
       end
-      throw e
+      raise e
     end
 
     # @param [User] user
@@ -108,6 +141,8 @@ module AmplitudeExperiment
       end_time = Time.now
       elapsed = (end_time - start_time) * 1000.0
       @logger.debug("[Experiment] Fetch complete in #{elapsed.round(3)} ms")
+      raise FetchError.new(response.code.to_i, "Fetch error response: status=#{response.code} #{response.message}") if response.code != '200'
+
       json = JSON.parse(response.body)
       variants = parse_json_variants(json)
       @logger.debug("[Experiment] Fetched variants: #{variants}")
@@ -128,7 +163,7 @@ module AmplitudeExperiment
           # value was previously under the "key" field
           variant_value = value.fetch('key')
         end
-        variants.store(key, Variant.new(variant_value, value.fetch('payload', nil)))
+        variants.store(key, Variant.new(variant_value, value.fetch('payload', nil), value.fetch('key', nil), value.fetch('metadata', nil)))
       end
       variants
     end
@@ -140,5 +175,24 @@ module AmplitudeExperiment
       user.library = "experiment-ruby-server/#{VERSION}"
       user
     end
+
+    def should_retry_fetch?(err)
+      return err.status_code < 400 || err.status_code >= 500 || err.status_code == 429 if err.is_a?(FetchError)
+
+      true
+    end
+
+    def filter_default_variants(variants)
+      variants.each do |key, value|
+        default = value&.metadata&.fetch('default', nil)
+        deployed = value&.metadata&.fetch('deployed', nil)
+        default = false if default.nil?
+        deployed = true if deployed.nil?
+        variants.delete(key) if default || !deployed
+      end
+      variants
+    end
+
+    private :filter_default_variants
   end
 end

data/lib/experiment/variant.rb

@@ -1,6 +1,10 @@
 module AmplitudeExperiment
   # Variant
   class Variant
+    # The key of the variant determined by the flag configuration.
+    # @return [String] the value of variant key
+    attr_accessor :key
+
     # The value of the variant determined by the flag configuration.
     # @return [String] the value of variant value
     attr_accessor :value
@@ -9,17 +13,21 @@ module AmplitudeExperiment
     # @return [Object, nil] the value of variant payload
     attr_accessor :payload
 
+    attr_accessor :metadata
+
     # @param [String] value The value of the variant determined by the flag configuration.
     # @param [Object, nil] payload The attached payload, if any.
-    def initialize(value, payload = nil)
+    def initialize(value, payload = nil, key = nil, metadata = nil)
+      @key = key
       @value = value
       @payload = payload
+      @metadata = metadata
     end
 
     # Determine if current variant equal other variant
     # @param [Variant] other
     def ==(other)
-      value == other.value &&
+      key == other.key && value == other.value &&
         payload == other.payload
     end
   end

data/lib/experiment/version.rb

@@ -1,3 +1,3 @@
 module AmplitudeExperiment
-  VERSION = '1.2.5'.freeze
+  VERSION = '1.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amplitude-experiment
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.3.0
 platform: ruby
 authors:
 - Amplitude
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-30 00:00:00.000000000 Z
+date: 2024-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -176,6 +176,7 @@ files:
 - lib/amplitude/utils.rb
 - lib/amplitude/workers.rb
 - lib/experiment/cookie.rb
+- lib/experiment/error.rb
 - lib/experiment/factory.rb
 - lib/experiment/local/assignment/assignment.rb
 - lib/experiment/local/assignment/assignment_config.rb