network_resiliency 0.0.2 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d085dba12da295ad4c4bb4d540acb3b865c8d8486b9bdf6d812e74430efcd55f
-  data.tar.gz: 24d61f1205ecba15f7acbda327d91be3ca0c74dd0955c2fe03338f873435d478
+  metadata.gz: 1b75b4aad26c41942f4d38ad70abb82d8f098eb377e9e5f44d1f6dde41ab6225
+  data.tar.gz: 47c899a650d66cea1117743ce4b53ee7bc50cc4fef8dfca3337aa071d0f81964
 SHA512:
-  metadata.gz: 91e9bcd5141345e0117be83f1e01951a11f6ffc8b100c1776a0ba3a2ac2bde19642369875ee79d995f8c4f3bbc0742f72c67102295bdecb2e9afd681597f555c
-  data.tar.gz: df13161c53527c10143d7c11b56ac7cc2a75189eb58b2d698d2f9940dd50a894a3e6dae8680764a6773c68c6dc107faf8613b457c5edeb1dc7c65200fe97e491
+  metadata.gz: ef7d805366f84daf7a27f5fb6dc88ef846741456203fa23f30512d780ae46065b5519caa474e7750b260e2a9bca5b9e296cb4def7e60402cfabdf0ae4aa1bf7c
+  data.tar.gz: 11d564818a9700a685c8d3dc9873de64181079fffffcbc0dd192d2ddbb47f0b75e43e92ba08d4523376a0a617ba60c9dd599e07fce1c055e48398b38f2e40ee3

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+###  v0.1.1  (2023-09-27)
+- prevent double patching
+- filter ip addresses
+- simplify
+- configure
+
+###  v0.1.0  (2023-09-26)
+- rework faraday adapter
+- faraday
+- adapter scoped enabled
+- scope rspec helper
+- adapter tag
+- enable disable block mode
+- drop ruby 2.7 support
+- resiliency
+- pointer
+- code coverage upgrade
+- requirements
+- http adapter
+- mock http server
+- add ddtrace to dev
+
 ###  v0.0.2  (2023-05-09)
 - rename to Network Resiliency
 - fix sample variance

data/Gemfile.lock

@@ -1,67 +1,90 @@
 PATH
   remote: .
   specs:
-    network_resiliency (0.0.2)
-      faraday
+    network_resiliency (0.1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     byebug (11.1.3)
-    codecov (0.5.2)
-      simplecov (>= 0.15, < 0.22)
-    connection_pool (2.3.0)
-    diff-lcs (1.4.4)
+    ddtrace (1.14.0)
+      debase-ruby_core_source (= 3.2.1)
+      libdatadog (~> 3.0.0.1.0)
+      libddwaf (~> 1.9.0.0.0)
+      msgpack
+    debase-ruby_core_source (3.2.1)
+    diff-lcs (1.5.0)
     docile (1.4.0)
-    faraday (2.7.4)
-      faraday-net_http (>= 2.0, < 3.1)
+    dogstatsd-ruby (4.8.3)
+    faraday (1.10.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
       ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
     faraday-rack (1.0.0)
-    rack (3.0.2)
-    rack-test (2.0.2)
+    faraday-retry (1.0.3)
+    ffi (1.15.5)
+    libdatadog (3.0.0.1.0)
+    libddwaf (1.9.0.0.1)
+      ffi (~> 1.0)
+    msgpack (1.7.2)
+    multipart-post (2.3.0)
+    rack (3.0.8)
+    rack-test (2.1.0)
       rack (>= 1.3)
-    redis (5.0.5)
-      redis-client (>= 0.9.0)
-    redis-client (0.11.2)
-      connection_pool
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    redis (4.8.1)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
     ruby2_keywords (0.0.5)
-    simplecov (0.21.2)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
+    simplecov_json_formatter (0.1.4)
 
 PLATFORMS
-  x86_64-darwin-19
-  x86_64-darwin-20
-  x86_64-darwin-21
+  ruby
 
 DEPENDENCIES
   byebug
-  codecov
+  ddtrace (>= 1)
+  dogstatsd-ruby (<= 4.8.3)
+  faraday (~> 1)
   faraday-rack
   network_resiliency!
   rack
   rack-test
-  redis
-  redis-client (>= 0.10)
+  redis (~> 4)
   rspec
   simplecov
 
 BUNDLED WITH
-   2.2.20
+   2.4.19

data/README.md

@@ -1,6 +1,11 @@
-ApiAvenger
+NetworkResiliency
 ======
-...
+![Gem](https://img.shields.io/gem/dt/network_resiliency?style=plastic)
+[![codecov](https://codecov.io/gh/dpep/network_resiliency_rb/branch/main/graph/badge.svg)](https://codecov.io/gh/dpep/network_resiliency_rb)
+
+Making networks more resilient to errors.
+
+Resiliency: the ability to recover from adversity or adjust to change.
 
 
 ```ruby
@@ -21,6 +26,10 @@ Yes please  :)
 1. Create a Pull Request
 
 
+
 ----
-![Gem](https://img.shields.io/gem/dt/network_resiliency?style=plastic)
-[![codecov](https://codecov.io/gh/dpep/network_resiliency_rb/branch/main/graph/badge.svg)](https://codecov.io/gh/dpep/network_resiliency_rb)
+### Inspired by
+
+https://github.com/lostisland/faraday-retry/blob/main/lib/faraday/retry/middleware.rb
+
+https://github.com/ankane/the-ultimate-guide-to-ruby-timeouts

data/lib/network_resiliency/adapter/faraday.rb

@@ -2,58 +2,18 @@ require "faraday"
 
 module NetworkResiliency
   module Adapter
-    class Faraday < ::Faraday::Middleware
-      def call(env)
-        puts "NetworkResiliency called: #{env.url}"
-# env.options.timeout = 0.001
-# open_timeout
-
-        # url => id
-        # predict time
-        # get dynamic timeout
-
-        if NetworkResiliency.enabled?
-          # temp update timeout
-          # with_timeout(...) { super }
-        else
-          super
+    class Faraday < ::Faraday::Adapter::NetHttp
+      def build_connection(env)
+        super.tap do |conn|
+          unless NetworkResiliency::Adapter::HTTP.patched?(conn)
+            NetworkResiliency::Adapter::HTTP.patch(conn)
+          end
         end
-      rescue ::Faraday::Error => e
-        # note exception for ensure block
-      ensure
-        # record time taken
-
-        # reraise if applicable
-        raise e if e
-      end
-
-      def normalized_id(env)
-        env.url
-      end
-
-      def with_timeout(env, timeout)
-        old_timeouts = [
-          env.options.timeout,
-          env.options.open_timeout,
-          env.options.read_timeout,
-          env.options.write_timeout,
-        ]
-
-        env.options.timeout = [
-          env.options.timeout,
-          timeout,
-        ].compact.min
-
-        # env.options.open_timeout = [ env.options.open_timeout, timeout ].compact.min
-        # ...
-      ensure
-        env.options.timeout = old_timeouts[0]
-        # ...
       end
     end
   end
 end
 
-Faraday::Request.register_middleware(
+Faraday::Adapter.register_middleware(
   network_resiliency: NetworkResiliency::Adapter::Faraday,
 )

data/lib/network_resiliency/adapter/http.rb

@@ -0,0 +1,42 @@
+require "net/http"
+
+module NetworkResiliency
+  module Adapter
+    module HTTP
+      extend self
+
+      def patch(instance = nil)
+        (instance&.singleton_class || Net::HTTP).prepend(Instrumentation)
+      end
+
+      def patched?(instance = nil)
+        (instance&.singleton_class || Net::HTTP).ancestors.include?(Instrumentation)
+      end
+
+      module Instrumentation
+        def connect
+          return super unless NetworkResiliency.enabled?(:http)
+
+          begin
+            ts = -NetworkResiliency.timestamp
+
+            super
+          rescue Net::OpenTimeout => e
+            # capture error
+            raise
+          ensure
+            ts += NetworkResiliency.timestamp
+
+            NetworkResiliency.record(
+              adapter: "http",
+              action: "connect",
+              destination: address,
+              error: e&.class,
+              duration: ts,
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/network_resiliency/adapter/redis.rb

@@ -59,5 +59,5 @@ module NetworkResiliency
   end
 end
 
-# RedisClient.register(RedisAvenger)
-# Redis.new(middlewares: [RedisAvenger])
+# RedisClient.register(NetworkResiliency::Adapter::Redis)
+# Redis.new(middlewares: [NetworkResiliency::Adapter::Redis])

data/lib/network_resiliency/version.rb

@@ -1,3 +1,3 @@
 module NetworkResiliency
-  VERSION = "0.0.2"
+  VERSION = "0.1.1"
 end

data/lib/network_resiliency.rb

@@ -1,123 +1,77 @@
-require "network_resiliency/stats"
 require "network_resiliency/version"
 
 module NetworkResiliency
-  extend self
-
-  def enabled?
-    true
+  module Adapter
+    autoload :HTTP, "network_resiliency/adapter/http"
+    autoload :Faraday, "network_resiliency/adapter/faraday"
+    autoload :Redis, "network_resiliency/adapter/redis"
   end
 
-  def sample?
-    enabled? || rand < sample_rate
-  end
-
-  # def mode=(mode)
-  #   unless [ :avg, :x10, :sig1, :sig2, :sig3 ]
-  # end
-
-  def timeout(adapter, key)
-    stats = self.stats(adapter, key)
+  extend self
 
-    stats.avg * 10 if stats.n >= 100
-  end
+  attr_accessor :statsd
 
-  def stats(adapter, key)
-    store.get(
-      [
-        adapter.class.to_s.split("::")[-1],
-        key,
-      ].join(":"),
-    )
+  def configure
+    yield self
   end
 
-  def record(adapter, key, milliseconds)
-    compound_key = [
-      adapter.class.to_s.split("::")[-1],
-      key,
-    ].join(":")
-
-    # normalize timestamp
-    milliseconds = [ milliseconds.round, 1 ].max
+  def enabled?(adapter)
+    return true if @enabled.nil?
 
-    store.record(compound_key, milliseconds)
+    @enabled.is_a?(Proc) ? @enabled.call(adapter) : @enabled
   end
 
-  def timestamp
-    Process.clock_gettime(Process::CLOCK_MONOTONIC) * 1_000
-  end
-
-  def time
-    # if block_given?
-    ts = -timestamp
-    yield
+  def enabled=(enabled)
+    unless [ true, false ].include?(enabled) || enabled.is_a?(Proc)
+      raise ArgumentError
+    end
 
-    ts += timestamp
+    @enabled = enabled
   end
 
-  def store
-    @store ||= MemoryStore.new
-  end
+  def enable!
+    original = @enabled
+    @enabled = true
 
-  class Store
-    def get(key)
-      raise NotImplemented
-    end
+    yield if block_given?
+  ensure
+    @enabled = original if block_given?
+  end
 
-    def record(key, time)
-      raise NotImplemented
-    end
+  def disable!
+    original = @enabled
+    @enabled = false
 
-    def flush
-      raise NotImplemented
-    end
+    yield if block_given?
+  ensure
+    @enabled = original if block_given?
   end
 
-  class MemoryStore < Store
-    def initialize(substore = nil)
-      @substore = substore
-      @data = {}
-    end
+  def timestamp
+    # milliseconds
+    Process.clock_gettime(Process::CLOCK_MONOTONIC) * 1_000
+  end
 
-    def get(key)
-      @data[key] ||= @substore&.get(key) || Stats.new
-    end
+  # private
 
-    def record(key, time)
-      get(key) << time
-      @substore&.record(key, time)
+  IP_ADDRESS_REGEX = Regexp.new(/\d{1,3}(\.\d{1,3}){3}/)
 
-      self
-    end
+  def record(adapter:, action:, destination:, duration:, error: nil)
+    # filter raw IP addresses
+    return if IP_ADDRESS_REGEX.match?(destination)
 
-    def flush
-      @substore&.flush
-    end
+    NetworkResiliency.statsd&.distribution(
+      "network_resiliency.#{action}",
+      duration,
+      tags: {
+        adapter: adapter,
+        destination: destination,
+        error: error,
+      }.compact,
+    )
   end
 
-  class RedisStore < Store
-    def initialize(redis)
-      @redis = redis
-    end
-
-    def cachekey(key)
-      [ NetworkResiliency, key ].join(":")
-    end
+  def reset
+    @enabled = nil
   end
 end
-
-
-require "network_resiliency/adapter/faraday"
-require "network_resiliency/adapter/redis"
-
-# ms granularity, round up, floor(1)
-#
-
-# storage
-# get(id) / record(id, time) / flush
-
-# local storage
-#  - get(id) / save(id, time)
-# remote storage
-#  - get(id) - sync
-#  - save(id, time) - buffer and async flush

data/network_resiliency.gemspec

@@ -11,15 +11,16 @@ Gem::Specification.new do |s|
   s.summary     = package.to_s
   s.version     = package.const_get "VERSION"
 
-  s.add_dependency "faraday"
+  s.required_ruby_version = ">= 3"
 
   s.add_development_dependency "byebug"
-  s.add_development_dependency "codecov"
+  s.add_development_dependency "ddtrace", ">= 1"
+  s.add_development_dependency "dogstatsd-ruby", "<= 4.8.3"
+  s.add_development_dependency "faraday", "~> 1"
   s.add_development_dependency "faraday-rack"
   s.add_development_dependency "rack"
   s.add_development_dependency "rack-test"
-  s.add_development_dependency "redis"
-  s.add_development_dependency "redis-client", ">= 0.10"
+  s.add_development_dependency "redis", "~> 4"
   s.add_development_dependency "rspec"
   s.add_development_dependency "simplecov"
 end

metadata

@@ -1,23 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: network_resiliency
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.1
 platform: ruby
 authors:
 - Daniel Pepper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-09 00:00:00.000000000 Z
+date: 2023-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -25,49 +25,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: ddtrace
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: dogstatsd-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.8.3
 - !ruby/object:Gem::Dependency
-  name: faraday-rack
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: faraday-rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,19 +109,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redis-client
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -163,6 +163,7 @@ files:
 - README.md
 - lib/network_resiliency.rb
 - lib/network_resiliency/adapter/faraday.rb
+- lib/network_resiliency/adapter/http.rb
 - lib/network_resiliency/adapter/redis.rb
 - lib/network_resiliency/stats.rb
 - lib/network_resiliency/version.rb
@@ -179,7 +180,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="