promoted-ruby-client 0.1.15 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99ee2c76dc1547104c6e40f5b05c1b7897fb609108d3009c686236ef5646f33b
-  data.tar.gz: ff7dc6ed3901dac8112564687353c4942352b044d7b158ce2e9bd554843d777a
+  metadata.gz: a2c2ac1232cfaf7a98ca948a7949a420a6ab311c4b54d92ea8098e8b830e931b
+  data.tar.gz: 9ae8796dc993ecc11e01f1980a2200a7ee10dedb8287504a2bafcebec2f50105
 SHA512:
-  metadata.gz: f7d4ab79296c610db92af6ba93d86023f254fef6d59753e991df0915b028b303a505e11cdce623345f1bc78414f30ecd72f8c237e3f2eb87a93f7c4b331ae690
-  data.tar.gz: b612ddec96289bffe5b6eb2e9dff2b58f103d2008d53e8ff91069f2b6b13d24a179a25fbbe99315ea29b69cf227ad862da1eeb6204a05a288ab6a6caa0f23c3b
+  metadata.gz: d3df3068c668514c3666435fc1a4b25216223258fd305ba69e4cebf333f5026ff008f868a4bd7f3a15e748bd9b00ddb6dfbb9e0c0de7c72a9ed06ad4a175ddbe
+  data.tar.gz: 7adb59ff3806736008764d32a51176e1a064547259c8f4d7c9d800b4737e688d00b25593c07e5b2ecffc05daad1795830d17efb3f66284d6fc8f02b5045dd1f8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    promoted-ruby-client (0.1.15)
+    promoted-ruby-client (0.1.16)
       concurrent-ruby (~> 1)
       faraday (>= 0.9.0)
       faraday_middleware (>= 0.9.0)

data/README.md

@@ -17,6 +17,8 @@ More information at [http://www.promoted.ai](http://www.promoted.ai)
 
 ### [Faraday](https://github.com/lostisland/faraday)
 HTTP client for calling Promoted.
+### [Net::HTTP::Persistent](https://github.com/drbrain/net-http-persistent)
+Faraday binding (provides connection pool support)
 ### [Concurrent Ruby](https://github.com/ruby-concurrency/concurrent-ruby)
 Provides a thread pool for making shadow traffic requests to Delivery API in the background on a subset of calls to ```prepare_for_logging```
 ## Creating a Client
@@ -50,6 +52,7 @@ Name | Type | Description
 ```:default_request_headers``` | Hash | Additional headers to send on the request beyond ```x-api-key```. Defaults to {}
 ```:default_only_log``` | Boolean | If true, the ```deliver``` method will not direct traffic to Delivery API but rather return a request suitable for logging. Defaults to false.
 ```:should_apply_treatment_func``` | Proc | Called during delivery, accepts an experiment and returns a Boolean indicating whether the request should be considered part of the control group (false) or in the experiment (true). If nil, the default behavior of checking the experiement ```:arm``` is applied.
+```:warmup``` | Boolean | If true, the client will prime the `Net::HTTP::Persistent` connection pool on construction; this can make the first few calls to Promoted complete faster. Defaults to false.
 
 ## Data Types
 

data/dev.md

@@ -4,5 +4,5 @@
 2. Get credentials for deployment from 1password.
 3. Modify `promoted-ruby-client.gemspec`'s push block.
 4. Run `gem build promoted-ruby-client.gemspec` to generate `gem`.
-5. Run (using new output) `gem push promoted-ruby-client-0.1.15.gem`
+5. Run (using new output) `gem push promoted-ruby-client-0.1.16.gem`
 6. Update README with new version.

data/lib/promoted/ruby/client.rb

@@ -73,7 +73,7 @@ module Promoted
           @delivery_timeout_millis = params[:delivery_timeout_millis] || DEFAULT_DELIVERY_TIMEOUT_MILLIS
           @metrics_timeout_millis  = params[:metrics_timeout_millis] || DEFAULT_METRICS_TIMEOUT_MILLIS
 
-          @http_client = FaradayHTTPClient.new
+          @http_client = FaradayHTTPClient.new(@logger)
           @validator = Promoted::Ruby::Client::Validator.new
 
           @async_shadow_traffic = true
@@ -97,6 +97,10 @@ module Promoted
           if params[:enabled] != nil
             @enabled = params[:enabled] || false
           end
+
+          if params[:warmup]
+            do_warmup
+          end
         end
         
         ##
@@ -109,7 +113,7 @@ module Promoted
         end
 
         ##
-        # Make a delivery request.
+        # Make a delivery request. If @perform_checks is set, input validation will occur and possibly raise errors.
         def deliver args, headers={}
           args = Promoted::Ruby::Client::Util.translate_args(args)
 
@@ -124,7 +128,16 @@ module Promoted
           delivery_request_builder = RequestBuilder.new
           delivery_request_builder.set_request_params(args)
 
-          perform_common_checks!(args) if @perform_checks
+          # perform_checks raises errors.
+          if @perform_checks
+            perform_common_checks!(args)
+
+            if args[:insertion_page_type] == Promoted::Ruby::Client::INSERTION_PAGING_TYPE['PRE_PAGED'] then
+              err = DeliveryInsertionPageType.new
+              @logger.error(err) if @logger
+              raise err
+            end
+          end
 
           delivery_request_builder.ensure_client_timestamp
   
@@ -135,10 +148,15 @@ module Promoted
           only_log = delivery_request_builder.only_log != nil ? delivery_request_builder.only_log : @default_only_log
           deliver_err = false
 
-          if !@pager.validate_paging(delivery_request_builder.full_insertion, delivery_request_builder.request[:paging])
+          begin
+            @pager.validate_paging(delivery_request_builder.full_insertion, delivery_request_builder.request[:paging])
+          rescue InvalidPagingError => err
             # Invalid input, log and do SDK-side delivery.
-            @logger.warn("Invalid paging parameters") if @logger
-            only_log = true
+            @logger.warn(err) if @logger
+            return {
+              insertion: err.default_insertions_page
+              # No log request returned when no response insertions due to invalid paging
+            }
           end
 
           if !only_log
@@ -248,6 +266,22 @@ module Promoted
 
         private
 
+        def do_warmup
+          if !@delivery_endpoint
+            # Warmup only supported when delivery is enabled.
+            return
+          end
+
+          warmup_url = @delivery_endpoint.reverse.sub("/deliver".reverse, "/healthz".reverse).reverse
+          @logger.info("Warming up at #{warmup_url}") if @logger
+          1.upto(20) do
+            resp = @http_client.get(warmup_url)
+            if resp != "ok"
+              @logger.warn("Got a failure warming up") if @logger
+            end
+          end
+        end
+
         def send_request payload, endpoint, timeout_millis, api_key, headers={}, send_async=false
           resp = nil
 
@@ -305,8 +339,9 @@ module Promoted
 
           # Call Delivery API and log/ignore errors.
           start_time = Time.now
+          response = nil
           begin
-            send_request(delivery_request_params, @delivery_endpoint, @delivery_timeout_millis, @delivery_api_key, headers, @async_shadow_traffic)
+            response = send_request(delivery_request_params, @delivery_endpoint, @delivery_timeout_millis, @delivery_api_key, headers, @async_shadow_traffic)
           rescue StandardError => err
             @logger.warn("Shadow traffic call failed with #{err}") if @logger
             return
@@ -314,7 +349,8 @@ module Promoted
           
           if !@async_shadow_traffic
             ellapsed_time = Time.now - start_time
-            @logger.info("Shadow traffic call completed in #{ellapsed_time.to_f * 1000} ms") if @logger
+            insertions = response ? response[:insertion] : []
+            @logger.info("Shadow traffic call completed in #{ellapsed_time.to_f * 1000} ms with #{insertions.length} insertions") if @logger
           end
         end
 

data/lib/promoted/ruby/client/errors.rb

@@ -7,6 +7,12 @@ module Promoted
         end
       end
 
+      class DeliveryInsertionPageType < StandardError
+        def message
+          'Delivery insertions must be unpaged'
+        end
+      end
+
       class EndpointError < StandardError
         attr_reader :cause
         def initialize(cause)

data/lib/promoted/ruby/client/faraday_http_client.rb

@@ -6,10 +6,13 @@ module Promoted
       module Client
         class FaradayHTTPClient
  
-            def initialize
+            def initialize(logger = nil)
                 @conn = Faraday.new do |f|
                     f.request :json
                     f.request :retry, max: 3
+                    if logger
+                      f.response :logger, logger, { headers: false, bodies: true, log_level: :debug }
+                    end
                     f.use Faraday::Response::RaiseError # raises on 4xx and 5xx responses
                     f.adapter :net_http_persistent
                 end
@@ -30,6 +33,10 @@ module Promoted
                     response.body
                   end
             end
+
+            def get(endpoint)
+              @conn.get(endpoint).body
+            end
         end
       end
     end

data/lib/promoted/ruby/client/pager.rb

@@ -1,18 +1,28 @@
 module Promoted
     module Ruby
       module Client
+        class InvalidPagingError < StandardError
+          attr_reader :default_insertions_page
+
+          def initialize(message, default_insertions_page)
+            super(message)
+            @default_insertions_page = default_insertions_page
+          end
+        end
+        
         class Pager
             def validate_paging (insertions, paging)
-              if paging && paging[:offset]
-                return paging[:offset] < insertions.length
+              if paging && paging[:offset] && paging[:offset] >= insertions.length
+                raise InvalidPagingError.new("Invalid page offset (insertion size #{insertions.length}, offset #{paging[:offset]})", [])
               end
-              return true          
             end
 
             def apply_paging (insertions, insertion_page_type, paging = nil)
-              # This is invalid input, stop it before it goes to the server.
-              if !validate_paging(insertions, paging)
-                return []
+              begin
+                validate_paging(insertions, paging)
+              rescue InvalidPagingError => err
+                # This is invalid input, stop it before it goes to the server.
+                return err.default_insertions_page
               end
 
               if !paging
@@ -54,4 +64,4 @@ module Promoted
         end
       end
    end
-end
+end

data/lib/promoted/ruby/client/request_builder.rb

@@ -99,10 +99,13 @@ module Promoted
           params = {
             user_info: user_info,
             timing: timing,
-            cohort_membership: @experiment,
             client_info: @client_info
           }
 
+          if @experiment
+            params[:cohort_membership] = [@experiment]
+          end
+
           # Log request allows for multiple requests but here we only send one.
           if include_request
             request[:request_id] = request[:request_id] || @id_generator.newID

data/lib/promoted/ruby/client/version.rb

@@ -1,7 +1,7 @@
 module Promoted
   module Ruby
     module Client
-      VERSION = "0.1.15"
+      VERSION = "0.1.16"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promoted-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.16
 platform: ruby
 authors:
 - scottmcmaster
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-24 00:00:00.000000000 Z
+date: 2021-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -167,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.24
 signing_key: 
 specification_version: 4
 summary: A Ruby Client to contact Promoted APIs.