amplitude-experiment 1.0.0.beta.2 → 1.0.0.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5f72aeab5a4f6fb15f3c320e90c1cd075c23f8a02401ce6e0e105ee5ea21bc5
-  data.tar.gz: 9e4c3b349d2d9b9e68e5dcec7c790a0646b03872c985d6d1bc628240603d231d
+  metadata.gz: 70f2c8f1fb01b7e1de84104c7d1b875868ea11da376725b172ad062c14789746
+  data.tar.gz: 94849ff0ec78e5ceb05169594203d84d793cbd9d1455e6f60be1383a26788237
 SHA512:
-  metadata.gz: cdedf6dd11e06202be466b83640eb4dd0f6c50a9560bbc18d0c89f71d2e59e95efa5b947e802dcd735c56e6b1ac32b12e4d754fc5740f40c10c3932e77fc0d59
-  data.tar.gz: 2c9ae0b3b18970a1eba2c64a4a6f4e629b26c62bba5eb78ca0a4a25f4816aea2074379a3397fe0b6498d43b9aae56db9da84b937887864fb449c2eafff49b17b
+  metadata.gz: 31a6213acb520c87654f4a6120b930ba6cfe17111eca31e986d7eb544aa53164e5caf2723e8f0850bf674411df76c0a5d8c5e4823c34e01af8d61f7244532c36
+  data.tar.gz: 949cffd01dc77def83fd1c64f9d323ffc34f8b2081a850f72530c6d0f19f23fcd3d73edb61b8c8b27d7f135e7bb534db8d3c3bda0e9b2418119021d22c0bd5e4

data/lib/experiment/client.rb

@@ -19,6 +19,8 @@ module Experiment
                       else
                         Logger::INFO
                       end
+      endpoint = "#{@config.server_url}/sdk/vardata"
+      @uri = URI(endpoint)
       raise ArgumentError, 'Experiment API key is empty' if @api_key.nil? || @api_key.empty?
     end
 
@@ -91,16 +93,13 @@ module Experiment
     def do_fetch(user, timeout_millis)
       start_time = Time.now
       user_context = add_context(user)
-      endpoint = "#{@config.server_url}/sdk/vardata"
       headers = {
         'Authorization' => "Api-Key #{@api_key}",
         'Content-Type' => 'application/json;charset=utf-8'
       }
-      uri = URI(endpoint)
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true
-      http.read_timeout = timeout_millis / 1000 if (timeout_millis / 1000) > 0
-      request = Net::HTTP::Post.new(uri, headers)
+      read_timeout = timeout_millis / 1000 if (timeout_millis / 1000) > 0
+      http = PersistentHttpClient.get(@uri, { read_timeout: read_timeout })
+      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")

data/lib/experiment/persistent_http_client.rb

@@ -0,0 +1,127 @@
+module Experiment
+  # Persist Http Client to reuse connection and reduce IO
+  class PersistentHttpClient
+    DEFAULT_OPTIONS = { read_timeout: 80 }.freeze
+
+    class << self
+      # url: URI / String
+      # options: any options that Net::HTTP.new accepts
+      def get(url, options = {})
+        uri = url.is_a?(URI) ? url : URI(url)
+        connection_manager.get_client(uri, options)
+      end
+
+      private
+
+      # each thread gets its own connection manager
+      def connection_manager
+        # before getting a connection manager
+        # we first clear all old ones
+        remove_old_managers
+        Thread.current[:http_connection_manager] ||= new_manager
+      end
+
+      def new_manager
+        # create a new connection manager in a thread safe way
+        mutex.synchronize do
+          manager = ConnectionManager.new
+          connection_managers << manager
+          manager
+        end
+      end
+
+      def remove_old_managers
+        mutex.synchronize do
+          removed = connection_managers.reject!(&:stale?)
+          (removed || []).each(&:close_connections!)
+        end
+      end
+
+      # mutex isn't needed for CRuby, but might be needed
+      # for other Ruby implementations
+      def mutex
+        @mutex ||= Mutex.new
+      end
+
+      def connection_managers
+        @connection_managers ||= []
+      end
+    end
+
+    # connection manager represents
+    # a cache of all keep-alive connections
+    # in a current thread
+    class ConnectionManager
+      # if a client wasn't used within this time range
+      # it gets removed from the cache and the connection closed.
+      # This helps to make sure there are no memory leaks.
+      STALE_AFTER = 300 # 5 minutes
+
+      # Seconds to reuse the connection of the previous request. If the idle time is less than this Keep-Alive Timeout,
+      # Net::HTTP reuses the TCP/IP socket used by the previous communication. Source: Ruby docs
+      KEEP_ALIVE_TIMEOUT = 30 # seconds
+
+      # KEEP_ALIVE_TIMEOUT vs STALE_AFTER
+      # STALE_AFTER - how long an Net::HTTP client object is cached in ruby
+      # KEEP_ALIVE_TIMEOUT - how long that client keeps TCP/IP socket open.
+
+      attr_accessor :clients_store, :last_used
+
+      def initialize
+        self.clients_store = {}
+        self.last_used = Time.now
+      end
+
+      def get_client(uri, options)
+        mutex.synchronize do
+          # refresh the last time a client was used,
+          # this prevents the client from becoming stale
+          self.last_used = Time.now
+
+          # we use params as a cache key for clients.
+          # 2 connections to the same host but with different
+          # options are going to use different HTTP clients
+          params = [uri.host, uri.port, options]
+          client = clients_store[params]
+
+          return client if client
+
+          client = Net::HTTP.new(uri.host, uri.port)
+          client.keep_alive_timeout = KEEP_ALIVE_TIMEOUT
+
+          # set SSL to true if a scheme is https
+          client.use_ssl = uri.scheme == 'https'
+
+          # dynamically set Net::HTTP options
+          DEFAULT_OPTIONS.merge(options).each_pair do |key, value|
+            client.public_send("#{key}=", value)
+          end
+
+          # open connection
+          client.start
+
+          # cache the client
+          clients_store[params] = client
+
+          client
+        end
+      end
+
+      # close connections for each client
+      def close_connections!
+        mutex.synchronize do
+          clients_store.values.each(&:finish)
+          self.clients_store = {}
+        end
+      end
+
+      def stale?
+        Time.now - last_used > STALE_AFTER
+      end
+
+      def mutex
+        @mutex ||= Mutex.new
+      end
+    end
+  end
+end

data/lib/experiment/version.rb

@@ -1,3 +1,3 @@
 module Experiment
-  VERSION = '1.0.0.beta.2'.freeze
+  VERSION = '1.0.0.beta.3'.freeze
 end

data/lib/experiment.rb

@@ -4,6 +4,7 @@ require 'experiment/cookie'
 require 'experiment/user'
 require 'experiment/variant'
 require 'experiment/factory'
+require 'experiment/persistent_http_client'
 require 'experiment/client'
 
 # Amplitude Experiment Module

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amplitude-experiment
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta.2
+  version: 1.0.0.beta.3
 platform: ruby
 authors:
 - Amplitude
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-28 00:00:00.000000000 Z
+date: 2022-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -124,6 +124,7 @@ files:
 - lib/experiment/config.rb
 - lib/experiment/cookie.rb
 - lib/experiment/factory.rb
+- lib/experiment/persistent_http_client.rb
 - lib/experiment/user.rb
 - lib/experiment/variant.rb
 - lib/experiment/version.rb