promoted-ruby-client 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9911fa22cb387f4258e9261729f5b17baa6412ae2d9ddd82cb943e35c02aef0
-  data.tar.gz: 29a8ae5517ecbdf317671280c31942781b13cf7ba8d6f3f09b9658e3101ee24a
+  metadata.gz: efa5db6f158b8ab87cb8d17020d34e2d797025ea6b2b08ee032eb4be0f9ac715
+  data.tar.gz: 957e394b3e61cdfc55b68650392a158a492b0d5904df1bd88e17c9378078161b
 SHA512:
-  metadata.gz: 82d1b9721132cc813ddc614292111a0003423c881d836a8dd471115a20b2a2c0b2f0cbdee4d7eb2c12cae993000623012dd21bf8844bd05a9803796f60a99d56
-  data.tar.gz: 91e3466ee73398157ab6b1e41778a89f760aa9741b7a2fcb8c0edb4ad382933ab13a4526145290d70990b4cfa8599c28ca7d0c18d968de50b2aaa81af4768f6c
+  metadata.gz: a30a50a35881680fda99cb355d7469e1e805f5199db86f32713e3f803c68113e8932ae2458f3359c78f323e6c0914a974cf1579967a8a8760b7d48b0064dade9
+  data.tar.gz: fa2dde1f6bc78733f3db6fb8a37e19b8b9a00d3531d1508fc3fce3045f87360f5047086f6446906f8b9aa56dc09b2d217d076ea1c242210d098745aa2eb400da

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    promoted-ruby-client (0.1.8)
+    promoted-ruby-client (0.1.9)
 
 GEM
   remote: https://rubygems.org/

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.9.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
 
@@ -299,8 +297,12 @@ 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.
+          begin
+            send_request(delivery_request_params, @delivery_endpoint, @delivery_timeout_millis, @delivery_api_key, headers, true)
+          rescue StandardError => err
+            @logger.warn("Shadow traffic call failed with #{err}") if @logger
+          end
         end
 
         def perform_common_checks!(req)
@@ -321,14 +323,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 +331,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/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.9"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promoted-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - scottmcmaster
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-16 00:00:00.000000000 Z
+date: 2021-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,6 +76,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