kontent-delivery-sdk-ruby 2.0.10 → 2.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6fdd249e9cf25e87571caf44ef970862708e8dcef43c720507a99a43e1dc5e7
-  data.tar.gz: 6c9ec2a7b64b69d1bf544da3611647fd31d990e523a33f1bc5d03f9854cec04b
+  metadata.gz: 10a1940690541523126a2bd9f3767e54a68de48c14ca7acfb311f392e0cb3707
+  data.tar.gz: 80b485b19bef5ddc40e8964133b96dc0c1d3543f2c477c704973502c86495832
 SHA512:
-  metadata.gz: e628cb4abafc731ad06a5f9ea1ca68d11943635c8ca0942cc7b2a414a88653b2901636b2a87b1e6c38ac017059dbb7faeff895cf6293ae0b0bed402e1209368d
-  data.tar.gz: c2602cd4065a6bfa3604c01d69e3224a193495bdfcfdece618745d71bf6eae4b6484993e4c55ee84e13932da5622fd5ebffce3056eca1a8782db18036f605a48
+  metadata.gz: e11259c855f2dc4caf3146a704b0330acf6314d68cff4259a1acb03c60bee8359b567f68d10c033e2fef3bd36a51da864f8f5501485b032e05feba6b37f0a57b
+  data.tar.gz: 0a4ab01bb8be8744d83faf31ed25e35fa986b1fedaf531e7c85978138a3e58563ead1e5d19ba42e494af9d79ba73bedc87e3f1c0ea80088582a3b06790f6dbeb

data/README.md

@@ -97,15 +97,16 @@ You can then request the secure published content in your project. Be sure to no
 
 ### Retry policy
 
-By default, the SDK uses a retry policy, asking for requested content again in case of an error. The default policy retries the HTTP requests if the following status codes are returned:
+By default, the SDK uses a retry policy, asking for requested content again in case of an error. The default policy retries the HTTP request if the following status codes are returned:
 
 * 408 - `RequestTimeout`
+* 429 - `TooManyRequests`
 * 500 - `InternalServerError`
 * 502 - `BadGateway`
 * 503 - `ServiceUnavailable`
 * 504 - `GatewayTimeout`
 
-The default policy retries requests 5 times, totaling 6 overall attempts to retrieve content before returning a `ResponseBase` object containing the error. The consecutive attempts are delayed exponentially: 200 milliseconds, 400 milliseconds, 800 milliseconds, etc.
+The SDK will perform a total of 6 attempts at a maximum of 30 seconds to retrieve content before returning a `ResponseBase` object containing the error. The consecutive attempts are delayed with [exponential backoff and jitter](https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/).
 
 To disable the retry policy, you can use the `with_retry_policy` argument:
 

data/lib/delivery/client/request_manager.rb

@@ -7,8 +7,10 @@ module Kentico
       class RequestManager
         class << self
           MAX_ATTEMPTS = 6
-          INITIAL_DELAY = 0.2
-          RETRY_WHEN_CODE = [408, 500, 502, 503, 504].freeze
+          MAX_DELAY_SECONDS = 30
+          INITIAL_DELAY = 1
+          RETRY_WHEN_CODE = [408, 429, 500, 502, 503, 504].freeze
+          CODES_WITH_POSSIBLE_RETRY_HEADER = [429, 503].freeze
 
           def start(query, headers)
             @query = query
@@ -16,6 +18,7 @@ module Kentico
             @times_run = 1
             @delay = INITIAL_DELAY
             @url = @query.provide_url
+            @total_delay = 0
             continue
           end
 
@@ -23,19 +26,28 @@ module Kentico
 
           def should_retry(potential_response)
             return potential_response if @times_run == MAX_ATTEMPTS ||
-                                        !RETRY_WHEN_CODE.include?(potential_response.http_code) ||
-                                        !@query.with_retry_policy
+                                         !RETRY_WHEN_CODE.include?(potential_response.http_code) ||
+                                         !@query.with_retry_policy ||
+                                         @total_delay >= MAX_DELAY_SECONDS
 
-            @times_run += 1
-            @delay *= 2
+            next_delay
             sleep(@delay)
+            @total_delay += @delay
             continue
           end
 
+          # Generates a random delay based on times_run, then increases times_run
+          def next_delay
+            min = 0.8 * INITIAL_DELAY
+            max = (1.2 * INITIAL_DELAY) * (2**@times_run)
+            @delay = rand(min..max)
+            @times_run += 1
+          end
+
           def continue
             if ENV['TEST'] == '1'
               resp = Kentico::Kontent::Delivery::Tests::FakeResponder.get_response @query, @url, @headers
-              return resp if resp.is_a? Kentico::Kontent::Delivery::Responses::ResponseBase
+              return should_retry(resp) if resp.is_a? Kentico::Kontent::Delivery::Responses::ResponseBase
 
               make_response resp # resp is pure JSON
             else

data/lib/delivery/tests/429.json

@@ -0,0 +1,5 @@
+{
+    "request_id": "80000004-0002-fd00-b63f-84710c7967bb",
+    "error_code": 10000,
+    "message": "API rate limit exceeded. Please retry your request later."
+}

data/lib/delivery/tests/fake_responder.rb

@@ -32,6 +32,8 @@ module Kentico
                   url[BASE_URL.length...url.length]
                 end
 
+              return respond_429 if @query.code_name == '429'
+
               qs = url.contains('?') ? url.split('?')[1] : nil
               return respond_filtering qs unless qs.nil? # e.g. /items/about_us?skip=0&limit=5
 
@@ -65,6 +67,11 @@ module Kentico
               ##Kentico::Kontent::Delivery::Responses::ResponseBase.new 200, '', '', path.read if path.exist?
             end
 
+            def respond_429
+              path = Pathname.new(File.dirname(__FILE__) + '/429.json')
+              Kentico::Kontent::Delivery::Responses::ResponseBase.new 429, '', '', path.read if path.exist?
+            end
+
             def respond_401
               path = Pathname.new(File.dirname(__FILE__) + '/401.json')
               Kentico::Kontent::Delivery::Responses::ResponseBase.new 401, '', '', path.read if path.exist?

data/lib/delivery/version.rb

@@ -1,7 +1,7 @@
 module Kentico
   module Kontent
     module Delivery
-      VERSION = '2.0.10'.freeze
+      VERSION = '2.0.11'.freeze
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kontent-delivery-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.10
+  version: 2.0.11
 platform: ruby
 authors:
 - Eric Dugre
@@ -155,6 +155,7 @@ files:
 - lib/delivery/responses/delivery_type_response.rb
 - lib/delivery/responses/response_base.rb
 - lib/delivery/tests/401.json
+- lib/delivery/tests/429.json
 - lib/delivery/tests/fake_responder.rb
 - lib/delivery/tests/filtering/items_gt.json
 - lib/delivery/tests/filtering/items_with_count.json