opinionated_http 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21c5b626468b387d5b10f055e3f45b399d1b7c0e91a3962a31de1914f582848e
-  data.tar.gz: 4190403fda9fd6bb3853f8d552aa53f22e1ddf89ead008ee4fde7d9f184c7eaa
+  metadata.gz: e262dc93300a43d2a2f60cf02badf23e9cc38edf83c7359c335ad36e0a1bd7f9
+  data.tar.gz: 3a81646b073a3dc32ee7eef045697c59ede3c379c130159e9aca9efdacd47233
 SHA512:
-  metadata.gz: ff4c0ec5fadca2ac6a6cc6bbabb1e0893aa7064da3adbbfb33ef1c3561df302e2408b983ad1598360fab213ca5c35f5cc14765bcde59da95c8684d4f7f32894a
-  data.tar.gz: 274ff50c9ab8770f292ac37f2341480e01384ceddf8ef08a2ae644c139b5ecb965e0621309dd381f64e2e0a5d44bc2ee06b8037ada96c8731b8cdf645d8ab035
+  metadata.gz: 2c33ddd878ed1cf11a7a7f9ba04dc56a1fc0ee96e6e006e339ec6cc8d94ac38a0fe6a1f3a362aaee7484e72c74ceaeaea0acdcf7170dd0da6c22803d2685918f
+  data.tar.gz: 5b48a34488db8e1a107a617e0f56e40b8a218f2064dfa84c60fb66a720d12816ec2fb182101137dafd537f5f40d9764583bdb784ad008f288b4bc82f0dc17966

data/README.md

@@ -17,3 +17,56 @@ PersistentHTTP with the following enhancements:
 * Standardized Service Exception.
 * Retries on HTTP 5XX errors
 
+# Example
+
+# Configuration
+
+# Usage
+
+Create a new Opinionated HTTP instance.
+
+Parameters:
+  secret_config_prefix:
+    Required
+  metric_prefix:
+    Required
+  error_class:
+    Whenever exceptions are raised it is important that every client gets its own exception / error class
+    so that failures to specific http servers can be easily identified.
+    Required.
+  logger:
+    Default: SemanticLogger[OpinionatedHTTP]
+  Other options as supported by PersistentHTTP
+  #TODO: Expand PersistentHTTP options here
+
+Configuration:
+   Off of the `secret_config_path` path above, Opinionated HTTP uses specific configuration entry names
+   to configure the underlying HTTP setup:
+      url: [String]
+        The host url to the site to connect to.
+        Exclude any path, since that will be supplied when `#get` or `#post` is called.
+        Required.
+        Examples:
+          "https://example.com"
+          "https://example.com:8443/"
+      pool_size: [Integer]
+        default: 100
+      open_timeout: [Float]
+        default: 10
+      read_timeout: [Float]
+        default: 10
+      idle_timeout: [Float]
+        default: 300
+      keep_alive: [Float]
+        default: 300
+      pool_timeout: [Float]
+        default: 5
+      warn_timeout: [Float]
+        default: 0.25
+      proxy: [Symbol]
+        default: :ENV
+      force_retry: [true|false]
+        default: true
+
+Metrics:
+  During each call to `#get` or `#put`, the following metrics are logged using the

data/lib/opinionated_http.rb

@@ -1,76 +1,17 @@
+require 'opinionated_http/version'
 #
 # Opinionated HTTP
 #
 # An opinionated HTTP Client library using convention over configuration.
 #
-# Uses
-# * PersistentHTTP for http connection pooling.
-# * Semantic Logger for logging and metrics.
-# * Secret Config for its configuration.
-#
-# By convention the following metrics are measured and logged:
-# *
-#
-# PersistentHTTP with the following enhancements:
-# * Read config from Secret Config, just supply the `secret_config_path`.
-# * Redirect logging into standard Semantic Logger.
-# * Implements metrics and measure call durations.
-# * Standardized Service Exception.
-# * Retries on HTTP 5XX errors
-#
-
-require 'opinionated_http/version'
 module OpinionatedHTTP
   autoload :Client, 'opinionated_http/client'
   autoload :Logger, 'opinionated_http/logger'
 
-  # Create a new Opinionated HTTP instance.
   #
-  # Parameters:
-  #   secret_config_prefix:
-  #     Required
-  #   metric_prefix:
-  #     Required
-  #   error_class:
-  #     Whenever exceptions are raised it is important that every client gets its own exception / error class
-  #     so that failures to specific http servers can be easily identified.
-  #     Required.
-  #   logger:
-  #     Default: SemanticLogger[OpinionatedHTTP]
-  #   Other options as supported by PersistentHTTP
-  #   #TODO: Expand PersistentHTTP options here
-  #
-  # Configuration:
-  #    Off of the `secret_config_path` path above, Opinionated HTTP uses specific configuration entry names
-  #    to configure the underlying HTTP setup:
-  #       url: [String]
-  #         The host url to the site to connect to.
-  #         Exclude any path, since that will be supplied when `#get` or `#post` is called.
-  #         Required.
-  #         Examples:
-  #           "https://example.com"
-  #           "https://example.com:8443/"
-  #       pool_size: [Integer]
-  #         default: 100
-  #       open_timeout: [Float]
-  #         default: 10
-  #       read_timeout: [Float]
-  #         default: 10
-  #       idle_timeout: [Float]
-  #         default: 300
-  #       keep_alive: [Float]
-  #         default: 300
-  #       pool_timeout: [Float]
-  #         default: 5
-  #       warn_timeout: [Float]
-  #         default: 0.25
-  #       proxy: [Symbol]
-  #         default: :ENV
-  #       force_retry: [true|false]
-  #         default: true
+  # Create a new Opinionated HTTP instance.
   #
-  # Metrics:
-  #   During each call to `#get` or `#put`, the following metrics are logged using the
+  # See README.md for more info.
   def self.new(**args)
     Client.new(**args)
   end

data/lib/opinionated_http/client.rb

@@ -4,14 +4,24 @@ require 'semantic_logger'
 #
 # Client http implementation
 #
+# See README.md for more info.
 module OpinionatedHTTP
   class Client
-    attr_reader :secret_config_prefix, :logger, :metric_prefix, :error_class, :driver
+    # 502 Bad Gateway, 503 Service Unavailable, 504 Gateway Timeout
+    HTTP_RETRY_CODES = %w[502 503 504]
+
+    attr_reader :secret_config_prefix, :logger, :metric_prefix, :error_class, :driver,
+                :retry_count, :retry_interval, :retry_multiplier, :http_retry_codes
 
     def initialize(secret_config_prefix:, logger: nil, metric_prefix:, error_class:, **options)
-      @metric_prefix = metric_prefix
-      @logger        = logger || SemanticLogger[self]
-      @error_class   = error_class
+      @metric_prefix    = metric_prefix
+      @logger           = logger || SemanticLogger[self]
+      @error_class      = error_class
+      @retry_count      = SecretConfig.fetch("#{secret_config_prefix}/retry_count", type: :integer, default: 11)
+      @retry_interval   = SecretConfig.fetch("#{secret_config_prefix}/retry_interval", type: :float, default: 0.01)
+      @retry_multiplier = SecretConfig.fetch("#{secret_config_prefix}/retry_multiplier", type: :float, default: 1.8)
+      http_retry_codes  = SecretConfig.fetch("#{secret_config_prefix}/http_retry_codes", type: :string, default: HTTP_RETRY_CODES.join(","))
+      @http_retry_codes = http_retry_codes.split(",").collect { |str| str.strip }
 
       internal_logger = OpinionatedHTTP::Logger.new(@logger)
       new_options     = {
@@ -40,27 +50,7 @@ module OpinionatedHTTP
       path = "#{path}?#{URI.encode_www_form(parameters)}" if parameters
 
       request  = Net::HTTP::Get.new(path)
-      response =
-        begin
-          payload = {}
-          if logger.trace?
-            payload[:parameters] = parameters
-            payload[:path]       = path
-          end
-          message = "HTTP GET: #{action}" if logger.debug?
-
-          logger.benchmark_info(message: message, metric: "#{metric_prefix}/#{action}", payload: payload) { driver.request(request) }
-        rescue StandardError => exc
-          message = "HTTP GET: #{action} Failure: #{exc.class.name}: #{exc.message}"
-          logger.error(message: message, metric: "#{metric_prefix}/exception", exception: exc)
-          raise(error_class, message)
-        end
-
-      unless response.is_a?(Net::HTTPSuccess)
-        message = "HTTP GET: #{action} Failure: (#{response.code}) #{response.message}"
-        logger.error(message: message, metric: "#{metric_prefix}/exception")
-        raise(error_class, message)
-      end
+      response = request_with_retry(action: action, path: path, request: request)
 
       response.body
     end
@@ -70,29 +60,58 @@ module OpinionatedHTTP
       request = Net::HTTP::Post.new(path)
       request.set_form_data(*parameters) if parameters
 
-      response =
+      response = request_with_retry(action: action, path: path, request: request)
+
+      response.body
+    end
+
+    private
+
+    def request_with_retry(action:, path: "/#{action}", request:, try_count: 0)
+      http_method = request.method.upcase
+      response    =
         begin
           payload = {}
           if logger.trace?
             payload[:parameters] = parameters
             payload[:path]       = path
           end
-          message = "HTTP POST: #{action}" if logger.debug?
+          message = "HTTP #{http_method}: #{action}" if logger.debug?
 
           logger.benchmark_info(message: message, metric: "#{metric_prefix}/#{action}", payload: payload) { driver.request(request) }
         rescue StandardError => exc
-          message = "HTTP POST: #{action} Failure: #{exc.class.name}: #{exc.message}"
+          message = "HTTP #{http_method}: #{action} Failure: #{exc.class.name}: #{exc.message}"
           logger.error(message: message, metric: "#{metric_prefix}/exception", exception: exc)
           raise(error_class, message)
         end
 
-      unless response.is_a?(Net::HTTPSuccess)
-        message = "HTTP POST: #{action} Failure: (#{response.code}) #{response.message}"
+      # Retry on http 5xx errors except 500 which means internal server error.
+      if http_retry_codes.include?(response.code)
+        if try_count < retry_count
+          try_count = try_count + 1
+          duration  = retry_sleep_interval(try_count)
+          logger.warn(message: "HTTP #{http_method}: #{action} Failure: (#{response.code}) #{response.message}. Retry: #{try_count}", metric: "#{metric_prefix}/retry", duration: duration * 1_000)
+          sleep(duration)
+          response = request_with_retry(action: action, path: path, request: request, try_count: try_count)
+        else
+          message = "HTTP #{http_method}: #{action} Failure: (#{response.code}) #{response.message}. Retries Exhausted"
+          logger.error(message: message, metric: "#{metric_prefix}/exception")
+          raise(error_class, message)
+        end
+      elsif !response.is_a?(Net::HTTPSuccess)
+        message = "HTTP #{http_method}: #{action} Failure: (#{response.code}) #{response.message}"
         logger.error(message: message, metric: "#{metric_prefix}/exception")
         raise(error_class, message)
       end
 
-      response.body
+      response
+    end
+
+    # First retry is immediate, next retry is after `retry_interval`,
+    # each subsequent retry interval is 100% longer than the prior interval.
+    def retry_sleep_interval(retry_count)
+      return 0 if retry_count <= 1
+      (retry_multiplier ** (retry_count - 1)) * retry_interval
     end
   end
 end

data/lib/opinionated_http/version.rb

@@ -1,3 +1,3 @@
 module OpinionatedHTTP
-  VERSION = "0.0.1".freeze
+  VERSION = "0.0.2".freeze
 end

data/test/client_test.rb

@@ -20,12 +20,12 @@ module OpinionatedHTTP
 
       describe "get" do
         it 'success' do
-          output   = {zip: '12345', population: 54321}
-          body     = output.to_json
-          response = Net::HTTPSuccess.new(200, 'OK', body)
-          http.driver.stub(:request, response) do
-            http.get(action: 'lookup', parameters: {zip: '12345'})
-          end
+          # output   = {zip: '12345', population: 54321}
+          # body     = output.to_json
+          # response = Net::HTTPSuccess.new(200, 'OK', body)
+          # http.driver.stub(:request, response) do
+          #   http.get(action: 'lookup', parameters: {zip: '12345'})
+          # end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opinionated_http
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-20 00:00:00.000000000 Z
+date: 2020-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: persistent_http