amplitude-experiment 1.1.4 → 1.2.0

data/lib/experiment/local/assignment/assignment_service.rb

@@ -0,0 +1,48 @@
+require_relative '../../../amplitude'
+module AmplitudeExperiment
+  # AssignmentService
+  class AssignmentService
+    def initialize(amplitude, assignment_filter)
+      @amplitude = amplitude
+      @assignment_filter = assignment_filter
+    end
+
+    def track(assignment)
+      @amplitude.track(to_event(assignment)) if @assignment_filter.should_track(assignment)
+    end
+
+    def to_event(assignment)
+      event = AmplitudeAnalytics::BaseEvent.new(
+        '[Experiment] Assignment',
+        user_id: assignment.user.user_id,
+        device_id: assignment.user.device_id,
+        event_properties: {},
+        user_properties: {}
+      )
+
+      assignment.results.each do |results_key, result|
+        event.event_properties["#{results_key}.variant"] = result['variant']['key']
+      end
+
+      set = {}
+      unset = {}
+
+      assignment.results.each do |results_key, result|
+        next if result['type'] == FLAG_TYPE_MUTUAL_EXCLUSION_GROUP
+
+        if result['isDefaultVariant']
+          unset["[Experiment] #{results_key}"] = '-'
+        else
+          set["[Experiment] #{results_key}"] = result['variant']['key']
+        end
+      end
+
+      event.user_properties['$set'] = set
+      event.user_properties['$unset'] = unset
+
+      event.insert_id = "#{event.user_id} #{event.device_id} #{AmplitudeExperiment.hash_code(assignment.canonicalize)} #{assignment.timestamp / DAY_MILLIS}"
+
+      event
+    end
+  end
+end

data/lib/experiment/local/client.rb

@@ -1,13 +1,17 @@
 require 'uri'
 require 'logger'
+require_relative '../../amplitude'
 
 module AmplitudeExperiment
+  FLAG_TYPE_MUTUAL_EXCLUSION_GROUP = 'mutual_exclusion_group'.freeze
+  FLAG_TYPE_HOLDOUT_GROUP = 'holdout-group'.freeze
   # Main client for fetching variant data.
   class LocalEvaluationClient
     # Creates a new Experiment Client instance.
     #
     # @param [String] api_key The environment API Key
     # @param [LocalEvaluationConfig] config The config object
+
     def initialize(api_key, config = nil)
       require 'experiment/local/evaluation/evaluation'
       @api_key = api_key
@@ -22,6 +26,9 @@ module AmplitudeExperiment
                       end
       @fetcher = LocalEvaluationFetcher.new(api_key, @logger, @config.server_url)
       raise ArgumentError, 'Experiment API key is empty' if @api_key.nil? || @api_key.empty?
+
+      @assignment_service = nil
+      @assignment_service = AssignmentService.new(AmplitudeAnalytics::Amplitude.new(config.assignment_config.api_key, configuration: config.assignment_config), AssignmentFilter.new(config.assignment_config.cache_capacity)) if config&.assignment_config
     end
 
     # Locally evaluates flag variants for a user.
@@ -37,10 +44,11 @@ module AmplitudeExperiment
       return {} if flags.nil?
 
       user_str = user.to_json
+
       @logger.debug("[Experiment] Evaluate: User: #{user_str} - Rules: #{flags}") if @config.debug
       result = evaluation(flags, user_str)
       @logger.debug("[Experiment] evaluate - result: #{result}") if @config.debug
-      parse_results(result, flag_keys)
+      parse_results(result, flag_keys, user)
     end
 
     # Fetch initial flag configurations and start polling for updates.
@@ -61,15 +69,20 @@ module AmplitudeExperiment
 
     private
 
-    def parse_results(result, flag_keys)
+    def parse_results(result, flag_keys, user)
       variants = {}
+      assignments = {}
       result.each do |key, value|
-        next if value['isDefaultVariant'] || (flag_keys.empty? && flag_keys.include?(key))
+        included = flag_keys.empty? || flag_keys.include?(key)
+        if !value['isDefaultVariant'] && included
+          variant_key = value['variant']['key']
+          variant_payload = value['variant']['payload']
+          variants.store(key, Variant.new(variant_key, variant_payload))
+        end
 
-        variant_key = value['variant']['key']
-        variant_payload = value['variant']['payload']
-        variants.store(key, Variant.new(variant_key, variant_payload))
+        assignments[key] = value if included || value['type'] == FLAG_TYPE_MUTUAL_EXCLUSION_GROUP || value['type'] == FLAG_TYPE_HOLDOUT_GROUP
       end
+      @assignment_service&.track(Assignment.new(user, assignments))
       variants
     end
 

data/lib/experiment/local/config.rb

@@ -16,16 +16,21 @@ module AmplitudeExperiment
     # @return [long] the value of flag config polling interval in million seconds
     attr_accessor :flag_config_polling_interval_millis
 
+    # Configuration for automatically tracking assignment events after an evaluation.
+    # @return [AssignmentConfig] the config instance
+    attr_accessor :assignment_config
+
     # @param [Boolean] debug Set to true to log some extra information to the console.
     # @param [String] server_url The server endpoint from which to request variants.
     # @param [Hash] bootstrap The value of bootstrap.
     # @param [long] flag_config_polling_interval_millis The value of flag config polling interval in million seconds.
     def initialize(server_url: DEFAULT_SERVER_URL, bootstrap: {},
-                   flag_config_polling_interval_millis: 30_000, debug: false)
+                   flag_config_polling_interval_millis: 30_000, debug: false, assignment_config: nil)
       @debug = debug || false
       @server_url = server_url
       @bootstrap = bootstrap
       @flag_config_polling_interval_millis = flag_config_polling_interval_millis
+      @assignment_config = assignment_config
     end
   end
 end

data/lib/experiment/remote/client.rb

@@ -102,9 +102,7 @@ module AmplitudeExperiment
       http = PersistentHttpClient.get(@uri, { read_timeout: read_timeout }, @api_key)
       request = Net::HTTP::Post.new(@uri, headers)
       request.body = user_context.to_json
-      if request.body.length > 8000
-        @logger.warn("[Experiment] encoded user object length #{request.body.length} cannot be cached by CDN; must be < 8KB")
-      end
+      @logger.warn("[Experiment] encoded user object length #{request.body.length} cannot be cached by CDN; must be < 8KB") if request.body.length > 8000
       @logger.debug("[Experiment] Fetch variants for user: #{request.body}")
       response = http.request(request)
       end_time = Time.now

data/lib/experiment/util/hash.rb

@@ -0,0 +1,15 @@
+# AmplitudeExperiment
+module AmplitudeExperiment
+  def self.hash_code(string)
+    hash = 0
+    return hash if string.empty?
+
+    string.each_char do |char|
+      chr_code = char.ord
+      hash = ((hash << 5) - hash) + chr_code
+      hash &= 0xFFFFFFFF
+    end
+
+    hash
+  end
+end

data/lib/experiment/util/lru_cache.rb

@@ -0,0 +1,107 @@
+module AmplitudeExperiment
+  # ListNode
+  class ListNode
+    attr_accessor :prev, :next, :data
+
+    def initialize(data)
+      @prev = nil
+      @next = nil
+      @data = data
+    end
+  end
+
+  # CacheItem
+  class CacheItem
+    attr_accessor :key, :value, :created_at
+
+    def initialize(key, value)
+      @key = key
+      @value = value
+      @created_at = (Time.now.to_f * 1000).to_i
+    end
+  end
+
+  # Cache
+  class LRUCache
+    def initialize(capacity, ttl_millis)
+      @capacity = capacity
+      @ttl_millis = ttl_millis
+      @cache = {}
+      @head = nil
+      @tail = nil
+    end
+
+    def put(key, value)
+      if @cache.key?(key)
+        remove_from_list(key)
+      elsif @cache.size >= @capacity
+        evict_lru
+      end
+
+      cache_item = CacheItem.new(key, value)
+      node = ListNode.new(cache_item)
+      @cache[key] = node
+      insert_to_list(node)
+    end
+
+    def get(key)
+      node = @cache[key]
+      return nil unless node
+
+      time_elapsed = (Time.now.to_f * 1000).to_i - node.data.created_at
+      if time_elapsed > @ttl_millis
+        remove(key)
+        return nil
+      end
+
+      remove_from_list(key)
+      insert_to_list(node)
+      node.data.value
+    end
+
+    def remove(key)
+      remove_from_list(key)
+      @cache.delete(key)
+    end
+
+    def clear
+      @cache.clear
+      @head = nil
+      @tail = nil
+    end
+
+    private
+
+    def evict_lru
+      remove(@head.data.key) if @head
+    end
+
+    def remove_from_list(key)
+      node = @cache[key]
+      return unless node
+
+      if node.prev
+        node.prev.next = node.next
+      else
+        @head = node.next
+      end
+
+      if node.next
+        node.next.prev = node.prev
+      else
+        @tail = node.prev
+      end
+    end
+
+    def insert_to_list(node)
+      if @tail
+        @tail.next = node
+        node.prev = @tail
+        node.next = nil
+      else
+        @head = node
+      end
+      @tail = node
+    end
+  end
+end

data/lib/experiment/version.rb

@@ -1,3 +1,3 @@
 module AmplitudeExperiment
-  VERSION = '1.1.4'.freeze
+  VERSION = '1.2.0'.freeze
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: amplitude-experiment
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
 platform: ruby
 authors:
 - Amplitude
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-12 00:00:00.000000000 Z
+date: 2023-09-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
 - !ruby/object:Gem::Dependency
   name: psych
   requirement: !ruby/object:Gem::Requirement
@@ -148,8 +162,25 @@ files:
 - README.md
 - amplitude-experiment.gemspec
 - lib/amplitude-experiment.rb
+- lib/amplitude.rb
+- lib/amplitude/client.rb
+- lib/amplitude/config.rb
+- lib/amplitude/constants.rb
+- lib/amplitude/event.rb
+- lib/amplitude/exception.rb
+- lib/amplitude/http_client.rb
+- lib/amplitude/plugin.rb
+- lib/amplitude/processor.rb
+- lib/amplitude/storage.rb
+- lib/amplitude/timeline.rb
+- lib/amplitude/utils.rb
+- lib/amplitude/workers.rb
 - lib/experiment/cookie.rb
 - lib/experiment/factory.rb
+- lib/experiment/local/assignment/assignment.rb
+- lib/experiment/local/assignment/assignment_config.rb
+- lib/experiment/local/assignment/assignment_filter.rb
+- lib/experiment/local/assignment/assignment_service.rb
 - lib/experiment/local/client.rb
 - lib/experiment/local/config.rb
 - lib/experiment/local/evaluation/evaluation.rb
@@ -166,6 +197,8 @@ files:
 - lib/experiment/remote/client.rb
 - lib/experiment/remote/config.rb
 - lib/experiment/user.rb
+- lib/experiment/util/hash.rb
+- lib/experiment/util/lru_cache.rb
 - lib/experiment/variant.rb
 - lib/experiment/version.rb
 homepage: https://github.com/amplitude/experiment-ruby-server