faulty 0.2.0 → 0.6.0

data/lib/faulty/storage/interface.rb

@@ -14,7 +14,8 @@ class Faulty
       # @param circuit [Circuit] The circuit that ran
       # @param time [Integer] The unix timestamp for the run
       # @param success [Boolean] True if the run succeeded
-      # @return [Status] The circuit status after the run is added
+      # @return [Array<Array>] An array of the new history tuples after adding
+      #   the new entry, see {#history}
       def entry(circuit, time, success)
         raise NotImplementedError
       end

data/lib/faulty/storage/memory.rb

@@ -4,8 +4,9 @@ class Faulty
   module Storage
     # The default in-memory storage for circuits
     #
-    # This implementation is most suitable to single-process, low volume
-    # usage. It is thread-safe and circuit state is shared across threads.
+    # This implementation is thread-safe and circuit state is shared across
+    # threads. Since state is stored in-memory, this state is not shared across
+    # processes, or persisted across application restarts.
     #
     # Circuit state and runs are stored in memory. Although runs have a maximum
     # size within a circuit, there is no limit on the number of circuits that
@@ -18,6 +19,9 @@ class Faulty
     #
     # This can be used as a reference implementation for storage backends that
     # store a list of circuit run entries.
+    #
+    # @todo Add a more sophsticated implmentation that can limit the number of
+    #   circuits stored.
     class Memory
       attr_reader :options
 
@@ -85,7 +89,7 @@ class Faulty
           runs.push([time, success])
           runs.shift if runs.size > options.max_sample_size
         end
-        memory.status(circuit.options)
+        memory.runs.value
       end
 
       # Mark a circuit as open

data/lib/faulty/storage/redis.rb

@@ -2,6 +2,13 @@
 
 class Faulty
   module Storage
+    # A storage backend for storing circuit state in Redis.
+    #
+    # When using this or any networked backend, be sure to evaluate the risk,
+    # and set conservative timeouts so that the circuit storage does not cause
+    # cascading failures in your application when evaluating circuits. Always
+    # wrap this backend with a {FaultTolerantProxy} to limit the effect of
+    # these types of events.
     class Redis # rubocop:disable Metrics/ClassLength
       # Separates the time/status for history entry strings
       ENTRY_SEPARATOR = ':'
@@ -27,12 +34,17 @@ class Faulty
       #     circuit run history entry. Default `100`.
       # @!attribute [r] circuit_ttl
       #   @return [Integer] The maximum number of seconds to keep a circuit.
-      #     A value of `nil` disables circuit expiration.
+      #     A value of `nil` disables circuit expiration. This does not apply to
+      #     locks, which have an indefinite storage time.
       #     Default `604_800` (1 week).
       # @!attribute [r] list_granularity
       #   @return [Integer] The number of seconds after which a new set is
       #     created to store circuit names. The old set is kept until
       #     circuit_ttl expires. Default `3600` (1 hour).
+      # @!attribute [r] disable_warnings
+      #   @return [Boolean] By default, this class warns if the client options
+      #     are outside the recommended values. Set to true to disable these
+      #     warnings.
       Options = Struct.new(
         :client,
         :key_prefix,
@@ -40,7 +52,8 @@ class Faulty
         :max_sample_size,
         :sample_ttl,
         :circuit_ttl,
-        :list_granularity
+        :list_granularity,
+        :disable_warnings
       ) do
         include ImmutableOptions
 
@@ -53,7 +66,8 @@ class Faulty
             max_sample_size: 100,
             sample_ttl: 1800,
             circuit_ttl: 604_800,
-            list_granularity: 3600
+            list_granularity: 3600,
+            disable_warnings: false
           }
         end
 
@@ -62,7 +76,7 @@ class Faulty
         end
 
         def finalize
-          self.client = ::Redis.new unless client
+          self.client = ::Redis.new(timeout: 1) unless client
         end
       end
 
@@ -70,6 +84,8 @@ class Faulty
       # @yield [Options] For setting options in a block
       def initialize(**options, &block)
         @options = Options.new(options, &block)
+
+        check_client_options!
       end
 
       # Add an entry to storage
@@ -79,15 +95,15 @@ class Faulty
       # @return (see Interface#entry)
       def entry(circuit, time, success)
         key = entries_key(circuit)
-        pipe do |r|
+        result = pipe do |r|
           r.sadd(list_key, circuit.name)
           r.expire(list_key, options.circuit_ttl + options.list_granularity) if options.circuit_ttl
           r.lpush(key, "#{time}#{ENTRY_SEPARATOR}#{success ? 1 : 0}")
           r.ltrim(key, 0, options.max_sample_size - 1)
           r.expire(key, options.sample_ttl) if options.sample_ttl
+          r.lrange(key, 0, -1)
         end
-
-        status(circuit)
+        map_entries(result.last)
       end
 
       # Mark a circuit as open
@@ -196,6 +212,9 @@ class Faulty
         map_entries(entries).reverse
       end
 
+      # List all unexpired circuits
+      #
+      # @return (see Interface#list)
       def list
         redis { |r| r.sunion(*all_list_keys) }
       end
@@ -330,6 +349,49 @@ class Faulty
           [time.to_i, state == '1']
         end
       end
+
+      def check_client_options!
+        return if options.disable_warnings
+
+        check_redis_options!
+        check_pool_options!
+      rescue StandardError => e
+        warn "Faulty error while checking client options: #{e.message}"
+      end
+
+      def check_redis_options!
+        ropts = redis { |r| r.instance_variable_get(:@client).options }
+
+        bad_timeouts = {}
+        %i[connect_timeout read_timeout write_timeout].each do |time_opt|
+          bad_timeouts[time_opt] = ropts[time_opt] if ropts[time_opt] > 2
+        end
+
+        unless bad_timeouts.empty?
+          warn <<~MSG
+            Faulty recommends setting Redis timeouts <= 2 to prevent cascading
+            failures when evaluating circuits. Your options are:
+            #{bad_timeouts}
+          MSG
+        end
+
+        if ropts[:reconnect_attempts] > 1
+          warn <<~MSG
+            Faulty recommends setting Redis reconnect_attempts to <= 1 to
+            prevent cascading failures. Your setting is #{ropts[:reconnect_attempts]}
+          MSG
+        end
+      end
+
+      def check_pool_options!
+        if options.client.class.name == 'ConnectionPool'
+          timeout = options.client.instance_variable_get(:@timeout)
+          warn(<<~MSG) if timeout > 2
+            Faulty recommends setting ConnectionPool timeouts <= 2 to prevent
+            cascading failures when evaluating circuits. Your setting is #{timeout}
+          MSG
+        end
+      end
     end
   end
 end

data/lib/faulty/version.rb

@@ -3,6 +3,6 @@
 class Faulty
   # The current Faulty version
   def self.version
-    Gem::Version.new('0.2.0')
+    Gem::Version.new('0.6.0')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faulty
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Justin Howard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-18 00:00:00.000000000 Z
+date: 2021-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -38,32 +38,18 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: honeybadger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
@@ -129,10 +115,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
@@ -148,6 +134,8 @@ files:
 - faulty.gemspec
 - lib/faulty.rb
 - lib/faulty/cache.rb
+- lib/faulty/cache/auto_wire.rb
+- lib/faulty/cache/circuit_proxy.rb
 - lib/faulty/cache/default.rb
 - lib/faulty/cache/fault_tolerant_proxy.rb
 - lib/faulty/cache/interface.rb
@@ -163,9 +151,16 @@ files:
 - lib/faulty/events/log_listener.rb
 - lib/faulty/events/notifier.rb
 - lib/faulty/immutable_options.rb
+- lib/faulty/patch.rb
+- lib/faulty/patch/base.rb
+- lib/faulty/patch/mysql2.rb
+- lib/faulty/patch/redis.rb
 - lib/faulty/result.rb
 - lib/faulty/status.rb
 - lib/faulty/storage.rb
+- lib/faulty/storage/auto_wire.rb
+- lib/faulty/storage/circuit_proxy.rb
+- lib/faulty/storage/fallback_chain.rb
 - lib/faulty/storage/fault_tolerant_proxy.rb
 - lib/faulty/storage/interface.rb
 - lib/faulty/storage/memory.rb
@@ -190,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Fault-tolerance tools for ruby based on circuit-breakers

data/.travis.yml

@@ -1,46 +0,0 @@
----
-language: ruby
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-  - jruby
-  - truffleruby
-
-env:
-  global:
-    - COVERAGE=1
-    # Encrypted code climate CC_TEST_REPORTER_ID=
-    - secure: 'a/qmESTnDq37KvBY4u1VcBEjd7Y3b16L28AiV0y3d7SbrGeuWPmTR7WMvD8b0CV1Ou5wpic9HAxC9u2ZYhy0/BN9I4AOnkyj4IXF9K+ETbTq2XOAix38hNF4a/Hl89mgKD3IPtjxVrQ83h7pxbqtQ2jPnLyiR7mTj0rfOmzTSaItcn/auONuvanHuitGjYTw3xUA1okbhMy8cVh3nbozP0m3eujSbSOpLD3N9+s+A8lE+6VbNvoygqoqdcQqlYH4q5x+SGaD7L1illIywxVWpExygB9jIum3mhaXe7ThJ/FkUfCHqINRejR63QDVwvYGRPnrlg0c8rNiLDjfVyY83ESSqXN1hf/vzyVtGruj4t/35VsFL/fyE/iNGDDmMu/GH5Gbsa9+lykeRSOL97VAlzAuVeb4AwvZ9HFV5QcbGnNkrVG8sTMIOcUzJVGX2C38fnElGxGwrbpV8+ReMZtcQZSg2isRRKDUFRBdFFUrHKK8uqII+a5oZDi5OK7ytZHg8XTbrpJXStYhQjRMfbHsd2YFGeiyLWqzrASd/bpgdyLtZuQ1/r7z1IVGJjb01nNhD4mchU3Lj4mxaQe2zvBEhbUZufz2zrIDPiKxsQvYcqw4nvHJE7zWM0cMgHvQrzcZH44sHVtdVavjSPoOzN6665zaA9sCcYffESCPPQTnopE='
-
-services:
-  - redis-server
-
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-
-script:
-  - bundle exec rubocop
-  - bundle exec rspec --format doc
-  - bin/check-version
-
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
-
-jobs:
-  include:
-    - stage: release
-      rvm: 2.7
-      script: skip
-      deploy:
-        provider: rubygems
-        api_key:
-          secure: 'eS6u+XyT6hHk/0gLXWzoe3RTJzEVFQHcJ+MNGSp7iq+cavJHisndcYBmUxi6/Ttb/aT/YoczhIWYo6WPbcjDqWszDfUsrQyaiOiZy4BBcMwN1WHeHkeRHfO2NX7us0AKO66TAiNfpMqUR2UT/c1LCPtLb+bkG6IFWxRuF5Fo32e0th6Z+hJ4Se2E/Qg1lrZk5zBlhQSOtU88vWQAkT9FdzpwBskVENBuDmH5YTV2Y28QYHsDtSNIxoDiUK9LOoPxaYUQp5ZZ58HZHtPdNydPHvtOXaWcBlakH5HNkh3FUHsxqbA1b3U412PC4TK+0jnxfISH4EOAMZEkL1nmroJORlb5nlwG1eiHpPVbOke1z2cZarGmWWAEf9bGE99GVbuxUxRrm9i1rmPdJY2G6Z0Kz8zoLTDYI/9l2P81/99a7h84rWACeeI3bcdvqViLxUuVMiwQjQsOZhzfq1M6jjETAWAI3AMRLxaGSgp0LV3WtaSWk1T5qvOvOF2HIfQ1EMd74kblJrVGWUiqd94/UgQoB/+lg9PdP/h4aHY5Cq1ec83wzaO6leKNlO+EQfyAVD1nd8kxo7YHEUpcB8wWCNFA5iaLqwIMt7aeWvG/BVUIH0apppzJGDy9UZ0gGsYi6ID3gbRRgmHIdJospr6TN7hksu1ZqkwEaprpXq8zH0KFYW0='
-        gem: faulty
-        on:
-          tags: true
-          repo: ParentSquare/faulty