amplitude-experiment 1.1.2 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53e7251a50e66bfd3145abbf399860592fec625dba57df40b84cd2f235a41fd3
-  data.tar.gz: 7405cf8193e72163cc9df7d216460e2eee5b3352ff255e97eed7ec7f5de7367a
+  metadata.gz: da33da0e966b08a4172225241b5a89b4d0b8c0b91af484b6ebaf33aa8e27fb21
+  data.tar.gz: 22176a1dcf52fcc64035eb2fc914e891718846e93b83d9f8b29faa5437ca759b
 SHA512:
-  metadata.gz: cb9498e7a4bd0112e981732e136b2b6907fd34bc9c8bb645e41645c6074edcd891e95bee9919dc987bafdd4bd26969c07e6400884051375756dbb4524d83ba11
-  data.tar.gz: 990927832f1a67b211f982c4a350997d2a2cb91b0d2a62d605b412547e835404145b5546271f4af9dd75af4582b64fb887529f380c1ee4980ac9e81330e581c6
+  metadata.gz: f41ba9124f0f65dec01fe7223a1ce0ba5337e1e93afc9e73b97a2b73442bd95e71f7c8c3c15afc2ed9aa3fa2c3af758171c7910721dc15a00a299b510810c1e2
+  data.tar.gz: 6d3a204bae5dc360865018a0fe0cf3dd5c3cc6add4f3ef925556c05c75668a066aa476f2ef07eb475d999d8bdf7b8ad586fc5e593c9777dc7e618096ce800631

data/README.md

@@ -10,6 +10,8 @@
 # Experiment Ruby SDK
 Amplitude Ruby Server SDK for Experiment.
 
+> ⚠️ **Local evaluation process fork safety:** When using a `LocalEvaluationClient` and forking the process, you must call `#start` _after forking_ to update the flag configuration state on the new process. For example, in Puma, this means calling `#start` in the [`on_worker_boot` hook](https://www.rubydoc.info/gems/puma/Puma%2FDSL:on_worker_boot). 
+
 ## Installation
 Into Gemfile from rubygems.org:
 ```ruby
@@ -24,7 +26,6 @@ To install beta versions:
 gem install amplitude-experiment --pre
 ```
 
-
 ## Remote Evaluation Quick Start
 ```ruby
 require 'amplitude-experiment'

data/lib/experiment/factory.rb

@@ -2,7 +2,6 @@
 module AmplitudeExperiment
   @local_instance = {}
   @remote_instance = {}
-  @default_instance = '$default_instance'
 
   # Initializes a singleton Client. This method returns a default singleton instance, subsequent calls to
   #  init will return the initial instance regardless of input.
@@ -10,10 +9,8 @@ module AmplitudeExperiment
   # @param [String] api_key The environment API Key
   # @param [Config] config Optional Config.
   def self.initialize_remote(api_key, config = nil)
-    unless @local_instance.key?(@default_instance)
-      @local_instance.store(@default_instance, RemoteEvaluationClient.new(api_key, config))
-    end
-    @local_instance.fetch(@default_instance)
+    @remote_instance.store(api_key, RemoteEvaluationClient.new(api_key, config)) unless @remote_instance.key?(api_key)
+    @remote_instance.fetch(api_key)
   end
 
   # Initializes a local evaluation Client. A local evaluation client can evaluate local flags or experiments for a
@@ -23,9 +20,7 @@ module AmplitudeExperiment
   # @param [String] api_key The environment API Key
   # @param [Config] config Optional Config.
   def self.initialize_local(api_key, config = nil)
-    unless @remote_instance.key?(@default_instance)
-      @remote_instance.store(@default_instance, LocalEvaluationClient.new(api_key, config))
-    end
-    @remote_instance.fetch(@default_instance)
+    @local_instance.store(api_key, LocalEvaluationClient.new(api_key, config)) unless @local_instance.key?(api_key)
+    @local_instance.fetch(api_key)
   end
 end

data/lib/experiment/local/fetcher.rb

@@ -9,7 +9,7 @@ module AmplitudeExperiment
       @api_key = api_key
       @server_url = server_url
       @logger = logger
-      @http = PersistentHttpClient.get(server_url, { read_timeout: FLAG_CONFIG_TIMEOUT })
+      @http = PersistentHttpClient.get(server_url, { read_timeout: FLAG_CONFIG_TIMEOUT }, @api_key)
     end
 
     # Fetch local evaluation mode flag configs from the Experiment API server.

data/lib/experiment/persistent_http_client.rb

@@ -1,14 +1,20 @@
 module AmplitudeExperiment
-  # Persist Http Client to reuse connection and reduce IO
+  # Persist Http Client to reuse connection and reduce IO. Connections are
+  # shared by api key.
+  #
+  # WARNING: these connections are not safe for concurrent requests. Callers
+  # must synchronize requests per connection.
   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 = {})
+      # api_key: the deployment key for ensuring different deployments don't
+      # share connections.
+      def get(url, options, api_key)
         uri = url.is_a?(URI) ? url : URI(url)
-        connection_manager.get_client(uri, options)
+        connection_manager.get_client(uri, options, api_key)
       end
 
       private
@@ -72,7 +78,7 @@ module AmplitudeExperiment
         self.last_used = Time.now
       end
 
-      def get_client(uri, options)
+      def get_client(uri, options, api_key)
         mutex.synchronize do
           # refresh the last time a client was used,
           # this prevents the client from becoming stale
@@ -81,7 +87,7 @@ module AmplitudeExperiment
           # 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]
+          params = [uri.host, uri.port, options, api_key]
           client = clients_store[params]
 
           return client if client

data/lib/experiment/remote/client.rb

@@ -99,7 +99,7 @@ module AmplitudeExperiment
         'Content-Type' => 'application/json;charset=utf-8'
       }
       read_timeout = timeout_millis / 1000 if (timeout_millis / 1000) > 0
-      http = PersistentHttpClient.get(@uri, { read_timeout: read_timeout })
+      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

data/lib/experiment/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amplitude-experiment
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.4
 platform: ruby
 authors:
 - Amplitude
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-10 00:00:00.000000000 Z
+date: 2023-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych