promoted-ruby-client 0.1.8 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9911fa22cb387f4258e9261729f5b17baa6412ae2d9ddd82cb943e35c02aef0
-  data.tar.gz: 29a8ae5517ecbdf317671280c31942781b13cf7ba8d6f3f09b9658e3101ee24a
+  metadata.gz: a0a9076395824556fe8d27dd79d469c79aa14551c607626458c93e1c81ec0622
+  data.tar.gz: 31c0867ffceb56509b210f6844387b9f8ef05b24596ea5e7d00176e623117f71
 SHA512:
-  metadata.gz: 82d1b9721132cc813ddc614292111a0003423c881d836a8dd471115a20b2a2c0b2f0cbdee4d7eb2c12cae993000623012dd21bf8844bd05a9803796f60a99d56
-  data.tar.gz: 91e3466ee73398157ab6b1e41778a89f760aa9741b7a2fcb8c0edb4ad382933ab13a4526145290d70990b4cfa8599c28ca7d0c18d968de50b2aaa81af4768f6c
+  metadata.gz: ccae2274261dd7729df3dc74cc5c5bedc903fc4ef16870271738ff62a2da7e5ef2d100f8635f1b3feb19af837cc6a7d8993fd7db81ab22e222f8bc159451b45b
+  data.tar.gz: 45fb38f78f5ec55d0e5a7e3cfbb78ad9ef928cf674ed55b1085ff93a4cddff1f3b769d960a4664b33c1417d86fa38c0b56018704c3d091a433d948d93f0c5b45

data/.gitignore

@@ -57,4 +57,7 @@ build-iPhoneSimulator/
 # .rubocop-https?--*
 
 # IDE
-.vscode/
+.vscode/
+
+# Dev
+dev/

data/Gemfile

@@ -5,11 +5,6 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in promoted-ruby-client.gemspec
 gemspec
 
-gem 'faraday', '~> 1.4.1'
-gem 'faraday_middleware'
-gem 'faraday-net_http'
-gem 'concurrent-ruby', require: 'concurrent'
-
 group :development do
     gem 'ruby-debug-ide', group: :development
     gem 'debase', '>= 0.2.5.beta2', group: :development

data/Gemfile.lock

@@ -1,7 +1,12 @@
 PATH
   remote: .
   specs:
-    promoted-ruby-client (0.1.8)
+    promoted-ruby-client (0.1.12)
+      concurrent-ruby (~> 1.1, >= 1.1.9)
+      faraday (~> 1.4, >= 1.4.3)
+      faraday-net_http (~> 1.0)
+      faraday_middleware (~> 1.0, >= 1.0.0)
+      net-http-persistent
 
 GEM
   remote: https://rubygems.org/
@@ -10,6 +15,7 @@ GEM
     backport (1.2.0)
     benchmark (0.1.1)
     concurrent-ruby (1.1.9)
+    connection_pool (2.2.5)
     debase (0.2.5.beta2)
       debase-ruby_core_source (>= 0.10.12)
     debase-ruby_core_source (0.10.12)
@@ -28,7 +34,7 @@ GEM
     faraday-em_synchrony (1.0.0)
     faraday-excon (1.1.0)
     faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.1.0)
+    faraday-net_http_persistent (1.2.0)
     faraday_middleware (1.0.0)
       faraday (~> 1.0)
     jaro_winkler (1.5.4)
@@ -38,11 +44,17 @@ GEM
       kramdown (~> 2.0)
     mini_portile2 (2.5.3)
     multipart-post (2.1.1)
+    net-http-persistent (4.0.1)
+      connection_pool (~> 2.2)
     nokogiri (1.11.7)
       mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
+    nokogiri (1.11.7-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.11.7-x86_64-linux)
+      racc (~> 1.4)
     parallel (1.20.1)
-    parser (3.0.1.1)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
     racc (1.5.2)
     rainbow (3.0.0)
@@ -64,28 +76,28 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.17.0)
+    rubocop (1.18.4)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 1.8.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.7.0)
+    rubocop-ast (1.8.0)
       parser (>= 3.0.1.1)
     ruby-debug-ide (0.7.2)
       rake (>= 0.8.1)
     ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.4)
+    ruby2_keywords (0.0.5)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.3)
-    solargraph (0.42.3)
+    solargraph (0.42.4)
       backport (~> 1.2)
       benchmark
       bundler (>= 1.17.2)
@@ -107,14 +119,12 @@ GEM
 
 PLATFORMS
   ruby
+  x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
-  bundler (~> 1.17)
-  concurrent-ruby
+  bundler (~> 2.2, >= 2.2.24)
   debase (>= 0.2.5.beta2)
-  faraday (~> 1.4.1)
-  faraday-net_http
-  faraday_middleware
   jaro_winkler
   promoted-ruby-client!
   rake (~> 10.0)
@@ -124,4 +134,4 @@ DEPENDENCIES
   solargraph
 
 BUNDLED WITH
-   1.17.3
+   2.2.24

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.8.gem`
+5. Run (using new output) `gem push promoted-ruby-client-0.1.12.gem`
 6. Update README with new version.

data/lib/promoted/ruby/client.rb

@@ -61,6 +61,7 @@ module Promoted
           raise ArgumentError.new("Invalid shadow_traffic_delivery_percent, must be between 0 and 1") if @shadow_traffic_delivery_percent < 0 || @shadow_traffic_delivery_percent > 1.0
 
           @sampler = Sampler.new
+          @pager   = Pager.new
 
           # HTTP Client creation
           @delivery_endpoint = params[:delivery_endpoint] || DEFAULT_DELIVERY_ENDPOINT
@@ -115,7 +116,7 @@ module Promoted
           # Respect the enabled state
           if !@enabled
             return {
-              insertion: apply_paging(args[:full_insertion], args[:request][:paging])
+              insertion: @pager.apply_paging(args[:full_insertion], Promoted::Ruby::Client::INSERTION_PAGING_TYPE['UNPAGED'], args[:request][:paging])
               # No log request returned when disabled
             }
           end
@@ -125,7 +126,7 @@ module Promoted
 
           perform_common_checks!(args) if @perform_checks
 
-          pre_delivery_fillin_fields delivery_request_builder
+          delivery_request_builder.ensure_client_timestamp
   
           response_insertions = []
           cohort_membership_to_log = nil
@@ -133,6 +134,13 @@ 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])
+            # Invalid input, log and do SDK-side delivery.
+            @logger.warn("Invalid paging parameters") if @logger
+            only_log = true
+          end
+
           if !only_log
             cohort_membership_to_log = delivery_request_builder.new_cohort_membership_to_log
 
@@ -158,7 +166,7 @@ module Promoted
           request_to_log = nil
           if !insertions_from_delivery then
             request_to_log = delivery_request_builder.request
-            response_insertions = apply_paging(delivery_request_builder.full_insertion, delivery_request_builder.request[:paging])
+            response_insertions = @pager.apply_paging(delivery_request_builder.full_insertion, Promoted::Ruby::Client::INSERTION_PAGING_TYPE['UNPAGED'], delivery_request_builder.request[:paging])
           end
 
           log_req = nil
@@ -176,8 +184,6 @@ module Promoted
             log_request_builder.platform_id = delivery_request_builder.platform_id
             log_request_builder.timing      = delivery_request_builder.timing
             log_request_builder.user_info   = delivery_request_builder.user_info
-            pre_delivery_fillin_fields log_request_builder
-
 
             # On a successful delivery request, we don't log the insertions
             # or the request since they are logged on the server-side.
@@ -220,7 +226,7 @@ module Promoted
             end
           end
           
-          pre_delivery_fillin_fields log_request_builder
+          log_request_builder.ensure_client_timestamp
 
           if !shadow_traffic_err && should_send_as_shadow_traffic?
             deliver_shadow_traffic args, headers
@@ -242,14 +248,6 @@ module Promoted
 
         private
 
-        def apply_paging full_insertion, paging
-          size = nil
-          if paging
-            size = paging[:size]
-          end
-          return size != nil ? full_insertion[0..size - 1] : full_insertion
-        end
-
         def send_request payload, endpoint, timeout_millis, api_key, headers={}, send_async=false
           resp = nil
 
@@ -264,23 +262,29 @@ module Promoted
 
           if send_async && @pool
             @pool.post do
-              start_time = Time.now.to_i
+              start_time = Time.now
               begin
                 resp = @http_client.send(endpoint, timeout_millis, payload, use_headers)
               rescue Faraday::Error => err
-                @logger.warn("Deliver call failed with #{err}") if @logger
+                @logger.warn("Async send_request failed with #{err}") if @logger
                 return
               end
-              ellapsed_time = Time.now.to_i - start_time
-              @logger.info("Deliver call completed in #{ellapsed_time} ms") if @logger
+
+              ellapsed_time = Time.now - start_time
+              @logger.debug("Async send_request completed in #{ellapsed_time.to_f * 1000} ms") if @logger
             end
           else
+            start_time = Time.now
             begin
               resp = @http_client.send(endpoint, timeout_millis, payload, use_headers)
             rescue Faraday::Error => err
+              @logger.warn("Sync send_request failed with #{err}") if @logger
               raise EndpointError.new(err)
             end
-          end
+
+            ellapsed_time = Time.now - start_time
+            @logger.debug("Sync send_request completed in #{ellapsed_time.to_f * 1000} ms") if @logger
+        end
 
           return resp
         end
@@ -299,8 +303,19 @@ module Promoted
           delivery_request_params = delivery_request_builder.delivery_request_params(should_compact: false)
           delivery_request_params[:client_info][:traffic_type] = Promoted::Ruby::Client::TRAFFIC_TYPE['SHADOW']
 
-          # Call Delivery API async (fire and forget)
-          send_request(delivery_request_params, @delivery_endpoint, @delivery_timeout_millis, @delivery_api_key, headers, true)
+          # Call Delivery API and log/ignore errors.
+          start_time = Time.now
+          begin
+            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
+          end
+          
+          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
+          end
         end
 
         def perform_common_checks!(req)
@@ -321,14 +336,7 @@ module Promoted
             return true if !cohort_membership[:arm]
             return cohort_membership[:arm] != Promoted::Ruby::Client::COHORT_ARM['CONTROL']
           end
-        end
-        
-        # TODO: This probably just goes better in the RequestBuilder class.
-        def pre_delivery_fillin_fields(log_request_builder)
-          if log_request_builder.timing[:client_log_timestamp].nil?
-            log_request_builder.timing[:client_log_timestamp] = Time.now.to_i
-          end
-        end
+        end        
       end
     end
   end
@@ -336,6 +344,7 @@ end
 
 # dependent /libs
 require "promoted/ruby/client/request_builder"
+require "promoted/ruby/client/pager"
 require "promoted/ruby/client/sampler"
 require "promoted/ruby/client/util"
 require "promoted/ruby/client/validator"

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

@@ -11,7 +11,7 @@ module Promoted
                     f.request :json
                     f.request :retry, max: 3
                     f.use Faraday::Response::RaiseError # raises on 4xx and 5xx responses
-                    f.adapter :net_http
+                    f.adapter :net_http_persistent
                 end
             end
 

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

@@ -0,0 +1,57 @@
+module Promoted
+    module Ruby
+      module Client
+        class Pager
+            def validate_paging (insertions, paging)
+              if paging && paging[:offset]
+                return paging[:offset] < insertions.length
+              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 []
+              end
+
+              if !paging
+                paging = {
+                  :offset => 0,
+                  :size => insertions.length
+                }
+              end
+
+              offset = [0, paging[:offset]].max
+
+              index = offset
+              if insertion_page_type == Promoted::Ruby::Client::INSERTION_PAGING_TYPE['PRE_PAGED']
+                # When insertions are pre-paged, we don't use offset to
+                # window into the provided insertions, although we do use it when
+                # assigning positions.
+                index = 0
+              end
+
+              size = paging[:size]
+              if size <= 0
+                size = insertions.length
+              end
+
+              final_insertion_size = [size, insertions.length].min
+              insertion_page = Array.new(final_insertion_size)
+              0.upto(final_insertion_size - 1) {|i|
+                insertion = insertions[index]
+                if insertion[:position] == nil
+                  insertion[:position] = offset
+                end
+                insertion_page[i] = insertion
+                index = index + 1
+                offset = offset + 1
+              }
+
+              return insertion_page
+            end
+        end
+      end
+   end
+end

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

@@ -31,6 +31,9 @@ module Promoted
           @timing                  = request[:timing] || { :client_log_timestamp => Time.now.to_i }
           @to_compact_metrics_insertion_func       = args[:to_compact_metrics_insertion_func]
           @to_compact_delivery_insertion_func      = args[:to_compact_delivery_insertion_func]
+
+          # If the user didn't create a client request id, we do it for them.
+          request[:client_request_id] = request[:client_request_id] || @id_generator.newID
         end
 
         # Only used in delivery
@@ -60,7 +63,8 @@ module Promoted
             use_case: @use_case,
             search_query: request[:search_query],
             properties: request[:properties],
-            paging: request[:paging]
+            paging: request[:paging],
+            client_request_id: request[:client_request_id]
           }
           params[:insertion] = should_compact ? compact_delivery_insertions : full_insertion
 
@@ -99,10 +103,11 @@ module Promoted
             client_info: @client_info
           }
 
-          request[:request_id] = @id_generator.newID if not request[:request_id]
-
           # Log request allows for multiple requests but here we only send one.
-          params[:request] = [request] if include_request
+          if include_request
+            request[:request_id] = request[:request_id] || @id_generator.newID
+            params[:request] = [request]
+          end
 
           if include_insertions
             params[:insertion] = compact_metrics_insertions if include_insertions
@@ -120,6 +125,12 @@ module Promoted
           end
         end
 
+        def ensure_client_timestamp
+          if timing[:client_log_timestamp].nil?
+            timing[:client_log_timestamp] = Time.now.to_i
+          end
+        end
+
         # TODO: This looks overly complicated.
         def compact_metrics_insertions
           @insertion            = [] # insertion should be set according to the compact insertion

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

@@ -1,7 +1,7 @@
 module Promoted
   module Ruby
     module Client
-      VERSION = "0.1.8"
+      VERSION = "0.1.12"
     end
   end
 end

data/promoted-ruby-client.gemspec

@@ -28,7 +28,13 @@ Gem::Specification.new do |spec|
   spec.executables      = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths    = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_runtime_dependency 'faraday', '~> 1.4', '>= 1.4.3'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 1.0', '>= 1.0.0'
+  spec.add_runtime_dependency 'faraday-net_http', '~> 1.0'
+  spec.add_runtime_dependency 'net-http-persistent', '~> 4.0'
+  spec.add_runtime_dependency 'concurrent-ruby', '~> 1.1', '>= 1.1.9'
+
+  spec.add_development_dependency "bundler", '~> 2.2', '>= 2.2.24'
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,29 +1,123 @@
 --- !ruby/object:Gem::Specification
 name: promoted-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.12
 platform: ruby
 authors:
 - scottmcmaster
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-16 00:00:00.000000000 Z
+date: 2021-07-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-net_http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.9
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.24
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.24
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -76,6 +170,7 @@ files:
 - lib/promoted/ruby/client/extensions.rb
 - lib/promoted/ruby/client/faraday_http_client.rb
 - lib/promoted/ruby/client/id_generator.rb
+- lib/promoted/ruby/client/pager.rb
 - lib/promoted/ruby/client/request_builder.rb
 - lib/promoted/ruby/client/sampler.rb
 - lib/promoted/ruby/client/util.rb