network_resiliency 0.6.8 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b907866b5327e9488dca8b828bbf3b14c84a257c6a62c6381197455f11fc337b
-  data.tar.gz: 8aa6d3fbe7a1a0bae41711b18f02659363b620af749bc9cc778fd244398c9e36
+  metadata.gz: 0b05ddc43d74cc05325b32b3a45cbc1377bee1228c2c2f8ad7f2fd717ed7b49f
+  data.tar.gz: 8a9b5274e52a3ebc039f00e4aad18af9a7c2e645a7a246fd9e45cc474bbfb50b
 SHA512:
-  metadata.gz: 98c21b67a95c4ac785df751ae874e53f5116908462e5d17944831202e414ddc3644601d7e9c3ca6b00703a900490e56d575cff7a896a2606ef3167521ebfde88
-  data.tar.gz: 7f9d19f1546bfb251243cd142899af1eb74d561e9004e25b91b28e072d7f23f68646c0c2ba5b145ab933c28eafc762303e56811169ce4dd8f2822f60a235bef5
+  metadata.gz: ffe3b488a66c2721a25a3a995a007ff89a822d4ea2b85638b370535a4895968c5e74084ef89ee7a9bc97a325beba410f74e4ce2ecf4c941e99b00bc3f07daf4a
+  data.tar.gz: 5632e5111b856b1fc9d34b31f8d099b584491dbb9beb623ddcff016a058b8f839900fe65554ef60619930843b5b98c4137b92f15722c5040547632b91ec5ac7e

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+###  v0.7.0  (2023-12-11)
+- proc support for mode
+- rails adapater and deadline
+
+###  v0.6.9  (2023-12-07)
+- tag mode
+- request timeout header
+
 ###  v0.6.8  (2023-12-04)
 - slim metrics
 

data/Gemfile.lock

@@ -1,14 +1,95 @@
 PATH
   remote: .
   specs:
-    network_resiliency (0.6.8)
+    network_resiliency (0.7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (7.1.2)
+      actionpack (= 7.1.2)
+      activesupport (= 7.1.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.1.2)
+      actionpack (= 7.1.2)
+      activejob (= 7.1.2)
+      activerecord (= 7.1.2)
+      activestorage (= 7.1.2)
+      activesupport (= 7.1.2)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.1.2)
+      actionpack (= 7.1.2)
+      actionview (= 7.1.2)
+      activejob (= 7.1.2)
+      activesupport (= 7.1.2)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.2)
+      actionview (= 7.1.2)
+      activesupport (= 7.1.2)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actiontext (7.1.2)
+      actionpack (= 7.1.2)
+      activerecord (= 7.1.2)
+      activestorage (= 7.1.2)
+      activesupport (= 7.1.2)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.1.2)
+      activesupport (= 7.1.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.1.2)
+      activesupport (= 7.1.2)
+      globalid (>= 0.3.6)
+    activemodel (7.1.2)
+      activesupport (= 7.1.2)
+    activerecord (7.1.2)
+      activemodel (= 7.1.2)
+      activesupport (= 7.1.2)
+      timeout (>= 0.4.0)
+    activestorage (7.1.2)
+      actionpack (= 7.1.2)
+      activejob (= 7.1.2)
+      activerecord (= 7.1.2)
+      activesupport (= 7.1.2)
+      marcel (~> 1.0)
+    activesupport (7.1.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.4)
+    builder (3.2.4)
     byebug (11.1.3)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    crass (1.0.6)
     datadog-ci (0.2.0)
       msgpack
+    date (3.3.4)
     ddtrace (1.15.0)
       datadog-ci (~> 0.2.0)
       debase-ruby_core_source (= 3.2.2)
@@ -19,6 +100,9 @@ GEM
     diff-lcs (1.5.0)
     docile (1.4.0)
     dogstatsd-ruby (4.8.3)
+    drb (2.2.0)
+      ruby2_keywords
+    erubi (1.12.0)
     faraday (1.10.3)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
@@ -43,17 +127,93 @@ GEM
     faraday-rack (1.0.0)
     faraday-retry (1.0.3)
     ffi (1.16.3)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    io-console (0.6.0)
+    irb (1.10.1)
+      rdoc
+      reline (>= 0.3.8)
     libdatadog (5.0.0.1.0)
     libddwaf (1.14.0.0.0)
       ffi (~> 1.0)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.5)
+    minitest (5.20.0)
     msgpack (1.7.2)
     multipart-post (2.3.0)
+    mutex_m (0.2.0)
     mysql2 (0.5.5)
+    net-imap (0.4.7)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.4.0)
+      net-protocol
+    nio4r (2.7.0)
+    nokogiri (1.15.5)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
     pg (1.5.4)
+    psych (5.1.1.1)
+      stringio
+    racc (1.7.3)
     rack (3.0.8)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
     rack-test (2.1.0)
       rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails (7.1.2)
+      actioncable (= 7.1.2)
+      actionmailbox (= 7.1.2)
+      actionmailer (= 7.1.2)
+      actionpack (= 7.1.2)
+      actiontext (= 7.1.2)
+      actionview (= 7.1.2)
+      activejob (= 7.1.2)
+      activemodel (= 7.1.2)
+      activerecord (= 7.1.2)
+      activestorage (= 7.1.2)
+      activesupport (= 7.1.2)
+      bundler (>= 1.15.0)
+      railties (= 7.1.2)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.2)
+      actionpack (= 7.1.2)
+      activesupport (= 7.1.2)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rake (13.1.0)
+    rdoc (6.6.1)
+      psych (>= 4.0.0)
     redis (4.8.1)
+    reline (0.4.1)
+      io-console (~> 0.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -66,6 +226,14 @@ GEM
     rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
+    rspec-rails (6.1.0)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      railties (>= 6.1)
+      rspec-core (~> 3.12)
+      rspec-expectations (~> 3.12)
+      rspec-mocks (~> 3.12)
+      rspec-support (~> 3.12)
     rspec-support (3.12.1)
     ruby2_keywords (0.0.5)
     simplecov (0.22.0)
@@ -74,6 +242,17 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
+    stringio (3.1.0)
+    thor (1.3.0)
+    timecop (0.9.8)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    webrick (1.8.1)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   ruby
@@ -89,9 +268,12 @@ DEPENDENCIES
   pg (~> 1.1)
   rack
   rack-test
+  rails (>= 5)
   redis (~> 4)
   rspec
+  rspec-rails
   simplecov
+  timecop
 
 BUNDLED WITH
    2.4.20

data/README.md

@@ -13,9 +13,6 @@ require "network_resiliency"
 
 NetworkResiliency.configure do |conf|
   conf.statsd = Datadog::Statsd.new
-
-  # patch Redis instances
-  conf.patch :redis
 end
 
 Redis.new.ping

data/lib/network_resiliency/adapter/http.rb

@@ -5,6 +5,15 @@ module NetworkResiliency
     module HTTP
       extend self
 
+      ERRORS = [
+        Timeout::Error,
+        IOError,
+        SystemCallError,
+        (OpenSSL::OpenSSLError if defined?(OpenSSL::SSL)),
+      ].compact
+
+      REQUEST_TIMEOUT_HEADER = "X-Request-Timeout"
+
       def patch(instance = nil)
         return if patched?(instance)
 
@@ -39,8 +48,8 @@ module NetworkResiliency
           end
 
           timeouts = NetworkResiliency.timeouts_for(
-            adapter: "http",
-            action: action.to_s,
+            adapter: :http,
+            action: action,
             destination: destination,
             max: original_timeout,
             units: :seconds,
@@ -61,13 +70,11 @@ module NetworkResiliency
             attempts += 1
             error = nil
 
-            set_timeout.call(timeouts.shift)
-
-            yield
-          rescue ::Timeout::Error,
-             defined?(OpenSSL::SSL) ? OpenSSL::OpenSSLError : IOError,
-             SystemCallError => e
+            timeout = timeouts.shift
+            set_timeout.call(timeout)
 
+            yield timeout
+          rescue *ERRORS => e
             # capture error
             error = e.class
 
@@ -80,8 +87,8 @@ module NetworkResiliency
             self.max_retries = original_max_retries
 
             NetworkResiliency.record(
-              adapter: "http",
-              action: action.to_s,
+              adapter: :http,
+              action: action,
               destination: destination,
               duration: ts,
               error: error,
@@ -115,7 +122,12 @@ module NetworkResiliency
 
           idepotent = Net::HTTP::IDEMPOTENT_METHODS_.include?(req.method)
 
-          with_resilience(:request, destination, idepotent) { super }
+          with_resilience(:request, destination, idepotent) do |timeout|
+            # send timeout via headers
+            req[REQUEST_TIMEOUT_HEADER] = timeout
+
+            super
+          end
         end
       end
     end

data/lib/network_resiliency/adapter/mysql.rb

@@ -31,8 +31,8 @@ module NetworkResiliency
             ts += NetworkResiliency.timestamp
 
             NetworkResiliency.record(
-              adapter: "mysql",
-              action: "connect",
+              adapter: :mysql,
+              action: :connect,
               destination: host,
               error: e&.class,
               duration: ts,

data/lib/network_resiliency/adapter/postgres.rb

@@ -33,8 +33,8 @@ module NetworkResiliency
             ts += NetworkResiliency.timestamp
 
             NetworkResiliency.record(
-              adapter: "postgres",
-              action: "connect",
+              adapter: :postgres,
+              action: :connect,
               destination: host,
               error: e&.class,
               duration: ts,

data/lib/network_resiliency/adapter/rails.rb

@@ -0,0 +1,48 @@
+gem "rails", ">= 5"
+require "rails"
+
+module NetworkResiliency
+  module Adapter
+    module Rails
+      extend self
+
+      def patch(instance = nil)
+        instance ||= ::Rails.application
+
+        unless instance.is_a?(::Rails::Application)
+          raise ArgumentError, "expected Rails::Application instance, found: #{instance}"
+        end
+
+        return if patched?(instance)
+
+        instance.config.middleware.use Middleware
+      end
+
+      def patched?(instance = nil)
+        instance ||= ::Rails.application
+
+        return false unless instance.initialized?
+
+        instance.config.middleware.include?(Middleware)
+      end
+
+      class Middleware
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          header = HTTP::REQUEST_TIMEOUT_HEADER.upcase.tr('-', '_')
+          timeout = env["HTTP_#{header}"]&.to_f
+
+          NetworkResiliency.deadline = timeout if timeout
+
+          @app.call(env)
+        ensure
+          NetworkResiliency.deadline = nil
+        end
+      end
+    end
+  end
+end
+

data/lib/network_resiliency/adapter/redis.rb

@@ -61,8 +61,8 @@ module NetworkResiliency
           original_timeout = @options[timeout_key]
 
           timeouts = NetworkResiliency.timeouts_for(
-            adapter: "redis",
-            action: action.to_s,
+            adapter: :redis,
+            action: action,
             destination: destination,
             max: @options[timeout_key],
             units: :seconds,
@@ -101,8 +101,8 @@ module NetworkResiliency
             @options[timeout_key] = original_timeout
 
             NetworkResiliency.record(
-              adapter: "redis",
-              action: action.to_s,
+              adapter: :redis,
+              action: action,
               destination: destination,
               duration: ts,
               error: error,

data/lib/network_resiliency/version.rb

@@ -1,3 +1,3 @@
 module NetworkResiliency
-  VERSION = "0.6.8"
+  VERSION = "0.7.0"
 end

data/lib/network_resiliency.rb

@@ -13,10 +13,11 @@ module NetworkResiliency
     autoload :Redis, "network_resiliency/adapter/redis"
     autoload :Mysql, "network_resiliency/adapter/mysql"
     autoload :Postgres, "network_resiliency/adapter/postgres"
+    autoload :Rails, "network_resiliency/adapter/rails"
   end
 
   ACTIONS = [ :connect, :request ].freeze
-  ADAPTERS = [ :http, :faraday, :redis, :mysql, :postgres ].freeze
+  ADAPTERS = [ :http, :faraday, :redis, :mysql, :postgres, :rails ].freeze
   MODE = [ :observe, :resilient ].freeze
   RESILIENCY_SIZE_THRESHOLD = 1_000
 
@@ -49,6 +50,8 @@ module NetworkResiliency
         Adapter::Mysql.patch
       when :postgres
         Adapter::Postgres.patch
+      when :rails
+        Adapter::Rails.patch
       else
         raise NotImplementedError
       end
@@ -108,13 +111,38 @@ module NetworkResiliency
       raise ArgumentError, "invalid NetworkResiliency action: #{action}"
     end
 
-    (@mode && @mode[action]) || :observe
+    mode = if @mode.is_a?(Proc)
+      @mode.call(action)
+    elsif @mode
+      @mode[action]
+    end || :observe
+
+    unless MODE.include?(mode)
+      raise ArgumentError, "invalid NetworkResiliency mode: #{mode}"
+    end
+
+    mode
+  rescue => e
+    NetworkResiliency.statsd&.increment(
+      "network_resiliency.error",
+      tags: {
+        method: __method__,
+        type: e.class,
+      },
+    )
+
+    warn "[ERROR] NetworkResiliency: #{e.class}: #{e.message}"
+
+    :observe
   end
 
   def mode=(mode)
     @mode = {}
 
-    if mode.is_a?(Hash)
+    case mode
+    when Proc
+      @mode = mode
+    when Hash
       invalid = mode.keys - ACTIONS
 
       unless invalid.empty?
@@ -139,6 +167,25 @@ module NetworkResiliency
     @mode.freeze
   end
 
+  def deadline
+    thread_state["deadline"]
+  end
+
+  def deadline=(ts)
+    thread_state["deadline"] = case ts
+    when Numeric
+      Time.now + ts
+    when Time
+      ts
+    when nil
+      nil
+    else
+      raise ArgumentError, "invalid deadline: #{ts}"
+    end
+
+    # warn or raise if we're already past the deadline?
+  end
+
   def normalize_request(adapter, request = nil, **context, &block)
     unless ADAPTERS.include?(adapter)
       raise ArgumentError, "invalid adapter: #{adapter}"
@@ -177,6 +224,7 @@ module NetworkResiliency
         adapter: adapter,
         destination: destination,
         error: error,
+        mode: mode(action),
         attempts: (attempts if attempts > 1),
       }.compact,
     )

data/network_resiliency.gemspec

@@ -22,7 +22,10 @@ Gem::Specification.new do |s|
   s.add_development_dependency "pg", "~> 1.1"
   s.add_development_dependency "rack"
   s.add_development_dependency "rack-test"
+  s.add_development_dependency "rails", ">= 5"
   s.add_development_dependency "redis", "~> 4"
   s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec-rails"
   s.add_development_dependency "simplecov"
+  s.add_development_dependency "timecop"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: network_resiliency
 version: !ruby/object:Gem::Version
-  version: 0.6.8
+  version: 0.7.0
 platform: ruby
 authors:
 - Daniel Pepper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-04 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +206,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: "..."
 email:
 executables: []
@@ -194,6 +236,7 @@ files:
 - lib/network_resiliency/adapter/http.rb
 - lib/network_resiliency/adapter/mysql.rb
 - lib/network_resiliency/adapter/postgres.rb
+- lib/network_resiliency/adapter/rails.rb
 - lib/network_resiliency/adapter/redis.rb
 - lib/network_resiliency/refinements.rb
 - lib/network_resiliency/stats.rb