network_resiliency 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d085dba12da295ad4c4bb4d540acb3b865c8d8486b9bdf6d812e74430efcd55f
+  data.tar.gz: 24d61f1205ecba15f7acbda327d91be3ca0c74dd0955c2fe03338f873435d478
+SHA512:
+  metadata.gz: 91e9bcd5141345e0117be83f1e01951a11f6ffc8b100c1776a0ba3a2ac2bde19642369875ee79d995f8c4f3bbc0742f72c67102295bdecb2e9afd681597f555c
+  data.tar.gz: df13161c53527c10143d7c11b56ac7cc2a75189eb58b2d698d2f9940dd50a894a3e6dae8680764a6773c68c6dc107faf8613b457c5edeb1dc7c65200fe97e491

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+###  v0.0.2  (2023-05-09)
+- rename to Network Resiliency
+- fix sample variance
+- upgrade / fix stats
+- github actions
+- register middleware
+- stats
+
+###  v0.0.1  (2021-09-10)
+- init
+

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    network_resiliency (0.0.2)
+      faraday
+
+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)
+    docile (1.4.0)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    faraday-rack (1.0.0)
+    rack (3.0.2)
+    rack-test (2.0.2)
+      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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-darwin-20
+  x86_64-darwin-21
+
+DEPENDENCIES
+  byebug
+  codecov
+  faraday-rack
+  network_resiliency!
+  rack
+  rack-test
+  redis
+  redis-client (>= 0.10)
+  rspec
+  simplecov
+
+BUNDLED WITH
+   2.2.20

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Daniel Pepper
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,26 @@
+ApiAvenger
+======
+...
+
+
+```ruby
+require "network_resiliency"
+```
+
+
+----
+## Contributing
+
+Yes please  :)
+
+1. Fork it
+1. Create your feature branch (`git checkout -b my-feature`)
+1. Ensure the tests pass (`bundle exec rspec`)
+1. Commit your changes (`git commit -am 'awesome new feature'`)
+1. Push your branch (`git push origin my-feature`)
+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)

data/lib/network_resiliency/adapter/faraday.rb

@@ -0,0 +1,59 @@
+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
+        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(
+  network_resiliency: NetworkResiliency::Adapter::Faraday,
+)

data/lib/network_resiliency/adapter/redis.rb

@@ -0,0 +1,63 @@
+require "redis"
+
+module NetworkResiliency
+  module Adapter
+    module Redis
+      def connect(redis_config)
+        puts "RedisClient.connect(#{client.connect_timeout})"
+
+        old_timeout = client.connect_timeout
+
+        already_connected = client.connected?
+
+        # client.connect_timeout = 0.1
+        ts = -NetworkResiliency.timestamp
+        super
+      ensure
+        client.connect_timeout = old_timeout
+
+        ts += NetworkResiliency.timestamp
+
+        note = already_connected ? " (already_connected)" : ""
+
+        puts "connect time: #{ts}#{note}"
+      end
+
+      def call(command, redis_config)
+        puts "RedisClient.call"
+
+        key = "#{id}:call"
+        ts = -NetworkResiliency.timestamp
+        with_timeout(1) { super }
+      ensure
+        ts += NetworkResiliency.timestamp
+        puts "call time: #{ts}"
+
+        NetworkResiliency.record(self, id, ts)
+      end
+
+      def id
+        "redis:#{client.host}"
+      end
+
+      def with_timeout(timeout)
+        old_timeouts = [
+          client.connect_timeout,
+          client.read_timeout,
+          client.write_timeout,
+        ]
+
+        client.connect_timeout = timeout
+        client.read_timeout = timeout
+        client.write_timeout = timeout
+
+        yield
+      ensure
+        client.connect_timeout, client.read_timeout, client.write_timeout = *old_timeouts
+      end
+    end
+  end
+end
+
+# RedisClient.register(RedisAvenger)
+# Redis.new(middlewares: [RedisAvenger])

data/lib/network_resiliency/stats.rb

@@ -0,0 +1,90 @@
+module NetworkResiliency
+  class Stats
+    attr_reader :n, :avg
+
+    def self.from(n, avg, sq_dist)
+      new.tap do |instance|
+        instance.instance_eval do
+          @n = n
+          @avg = avg
+          @sq_dist = sq_dist
+        end
+      end
+    end
+
+    def initialize(values = [])
+      @n = 0
+      @avg = 0.0
+      @sq_dist = 0.0 # sum of squared distance from mean
+
+      values.each {|x| update(x) }
+    end
+
+    def <<(value)
+      case value
+      when Array
+        value.each {|x| update(x) }
+      when self.class
+        merge!(value)
+      else
+        update(value)
+      end
+
+      self
+    end
+
+    def variance(sample: false)
+      @sq_dist / (sample ? (@n - 1) : @n)
+    end
+
+    def stdev
+      Math.sqrt(variance)
+    end
+
+    def merge(other)
+      dup.merge!(other)
+    end
+    alias_method :+, :merge
+
+    def merge!(other)
+      raise ArgumentError unless other.is_a?(self.class)
+
+      prev_n = n
+      @n += other.n
+
+      delta = other.avg - avg
+      @avg += delta * other.n / n
+
+      @sq_dist += other.instance_variable_get(:@sq_dist)
+      @sq_dist += (delta ** 2) * prev_n * other.n / n
+
+      self
+    end
+
+    private
+
+    def update(value)
+      raise ArgumentError unless value.is_a?(Numeric)
+
+      @n += 1
+
+      prev_avg = @avg
+      @avg += (value - @avg) / @n
+
+      @sq_dist += (value - prev_avg) * (value - @avg)
+      # @sq_dist += (sq_dist - @sq_dist) / @n
+
+# for x, w in data_weight_pairs:
+#   w_sum = w_sum + w
+#   mean_old = mean
+#   mean = mean_old + (w / w_sum) * (x - mean_old)
+#   S = S + w * (x - mean_old) * (x - mean)
+
+  # count += 1
+  # delta = newValue - mean
+  # mean += delta / count
+  # delta2 = newValue - mean
+  # M2 += delta * delta2
+    end
+  end
+end

data/lib/network_resiliency/version.rb

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

data/lib/network_resiliency.rb

@@ -0,0 +1,123 @@
+require "network_resiliency/stats"
+require "network_resiliency/version"
+
+module NetworkResiliency
+  extend self
+
+  def enabled?
+    true
+  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)
+
+    stats.avg * 10 if stats.n >= 100
+  end
+
+  def stats(adapter, key)
+    store.get(
+      [
+        adapter.class.to_s.split("::")[-1],
+        key,
+      ].join(":"),
+    )
+  end
+
+  def record(adapter, key, milliseconds)
+    compound_key = [
+      adapter.class.to_s.split("::")[-1],
+      key,
+    ].join(":")
+
+    # normalize timestamp
+    milliseconds = [ milliseconds.round, 1 ].max
+
+    store.record(compound_key, milliseconds)
+  end
+
+  def timestamp
+    Process.clock_gettime(Process::CLOCK_MONOTONIC) * 1_000
+  end
+
+  def time
+    # if block_given?
+    ts = -timestamp
+    yield
+
+    ts += timestamp
+  end
+
+  def store
+    @store ||= MemoryStore.new
+  end
+
+  class Store
+    def get(key)
+      raise NotImplemented
+    end
+
+    def record(key, time)
+      raise NotImplemented
+    end
+
+    def flush
+      raise NotImplemented
+    end
+  end
+
+  class MemoryStore < Store
+    def initialize(substore = nil)
+      @substore = substore
+      @data = {}
+    end
+
+    def get(key)
+      @data[key] ||= @substore&.get(key) || Stats.new
+    end
+
+    def record(key, time)
+      get(key) << time
+      @substore&.record(key, time)
+
+      self
+    end
+
+    def flush
+      @substore&.flush
+    end
+  end
+
+  class RedisStore < Store
+    def initialize(redis)
+      @redis = redis
+    end
+
+    def cachekey(key)
+      [ NetworkResiliency, key ].join(":")
+    end
+  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

@@ -0,0 +1,25 @@
+require_relative "lib/network_resiliency/version"
+package = NetworkResiliency
+
+Gem::Specification.new do |s|
+  s.authors     = ["Daniel Pepper"]
+  s.description = "..."
+  s.files       = `git ls-files * ':!:spec'`.split("\n")
+  s.homepage    = "https://github.com/dpep/network_resiliency_rb"
+  s.license     = "MIT"
+  s.name        = File.basename(__FILE__).split(".")[0]
+  s.summary     = package.to_s
+  s.version     = package.const_get "VERSION"
+
+  s.add_dependency "faraday"
+
+  s.add_development_dependency "byebug"
+  s.add_development_dependency "codecov"
+  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 "rspec"
+  s.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: network_resiliency
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Daniel Pepper
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: codecov
+  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: faraday-rack
+  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: rack
+  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: rack-test
+  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: redis
+  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: redis-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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
+    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: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- lib/network_resiliency.rb
+- lib/network_resiliency/adapter/faraday.rb
+- lib/network_resiliency/adapter/redis.rb
+- lib/network_resiliency/stats.rb
+- lib/network_resiliency/version.rb
+- network_resiliency.gemspec
+homepage: https://github.com/dpep/network_resiliency_rb
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: NetworkResiliency
+test_files: []