amplitude-experiment 1.0.0.beta.1 → 1.0.0.beta.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f67be77264977612b2728ee49db7923a26414cdeefc71d15059cbcd6564031ac
-  data.tar.gz: d59583f45788bea92e6c5855b0cb2f754a87a2b022784f6a3e89eca239173819
+  metadata.gz: 653e4953eeea7497bb43f1e76c144c8fe7360dcc53c7aa3f9c63e3b28e1052ee
+  data.tar.gz: 9b8ea31ccb93aebd815019f6dab4f739ea49b96177800dc6a39b9f1907f64ad0
 SHA512:
-  metadata.gz: fd383c6a79f4164fbc3897d12256da8c19b5824be542faa23b43384ad32aa781c6cfee5b4101d015cd6fbef5994818ddc8ddd77addd83f8522c9716063f1dd45
-  data.tar.gz: b0d7f6429e872a86027cd0f34b2e796b04be39cc672616e5e99e543b32635dbe8226c06356f941fcfd7e118d608a4d151ce80fa6b6be10cfa5e41ae08e656138
+  metadata.gz: 4a1b221d66a28d1cc53c20c5eba088baa3a180ec628603d8801ed759ef893b6a74162abb8396ed3bac2f97f51aa45e7536adedc4509f1d719c2495ff2e129df1
+  data.tar.gz: 1757f94f26bf55016c8604ee065ae4d24d95b431ac7a27687190fe8e138d6ac402d94248eba90f9c23d94fd918179d28da8ffc02c9c03004e5bdeaafa8e24db1

data/README.md

@@ -5,8 +5,10 @@
   <br />
 </p>
 
-# experiment-ruby-server
-Ruby Server SDK for Experiment
+[![Gem Version](https://badge.fury.io/rb/amplitude-experiment.svg)](https://badge.fury.io/rb/amplitude-experiment)
+
+# Experiment Ruby SDK
+Amplitude Ruby Server SDK for Experiment.
 
 ## Installation
 Into Gemfile from rubygems.org:
@@ -17,6 +19,11 @@ Into environment gems from rubygems.org:
 ```ruby
 gem install 'amplitude-experiment'
 ```
+To install beta versions:
+```ruby
+gem install amplitude-experiment --pre
+```
+
 
 ## Quick Start
 ```ruby
@@ -57,5 +64,10 @@ unless variant.nil?
 end
 ```
 
+## More Information
+Please visit our :100:[Developer Center](https://www.docs.developers.amplitude.com/experiment/sdks/ruby-sdk/) for more instructions on using our the SDK.
+
+See our [Experiment Ruby SDK Docs](https://amplitude.github.io/experiment-ruby-server/) for a list and description of all available SDK methods.
+
 ## Need Help?
 If you have any problems or issues over our SDK, feel free to [create a github issue](https://github.com/amplitude/experiments-ruby-server/issues/new) or submit a request on [Amplitude Help](https://help.amplitude.com/hc/en-us/requests/new).

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")
@@ -130,7 +129,7 @@ module Experiment
           # value was previously under the "key" field
           variant_value = value.fetch('key')
         end
-        variants.store(key, Variant.new(variant_value, value.fetch('payload')))
+        variants.store(key, Variant.new(variant_value, value.fetch('payload', nil)))
       end
       variants
     end

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.1'.freeze
+  VERSION = '1.0.0.beta.4'.freeze
 end

data/lib/experiment.rb

@@ -1,8 +1,10 @@
+require 'experiment/version'
 require 'experiment/config'
 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.1
+  version: 1.0.0.beta.4
 platform: ruby
 authors:
 - Amplitude
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-28 00:00:00.000000000 Z
+date: 2022-06-30 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