faulty 0.8.6 → 0.8.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae75506209beb5e9490a5f2a939519060340e22022c0f0d0be07bbd8c32bd34a
-  data.tar.gz: d08fbe083462251ac184ed0578dda3dcfdab624e48cef270662ed04bab0b337b
+  metadata.gz: 3148a3eb0ec2e45213ddb40bef524a3b0fa83e83b467101982d7ced65cbac71a
+  data.tar.gz: fd9584532fde4f3409720ca1884f825fc4d6eabb4ebe133c80e969bc0131ab9f
 SHA512:
-  metadata.gz: 182af6be2df0089e41be78ceed0d3b866f9b6db43f2423fe1c4bd788b196c76fa206055f9ca07b558676afad7a3544c39c0215990a43fe2b8bdec593ea259d95
-  data.tar.gz: cf3726daff78ed12b39313aab5188c53a804ac68e9e0810faf1abf4e5d11e96c85168b46b4b814334bad5d922e6188c8a9b6ed5f0b499961c3e33fde434bb5c0
+  metadata.gz: 330476d53d625bb22dbd2f5855dd40f4f4849135b1407df72e9ff3849504341f9e67cf6ce5bb0606bd62100a9d11dda2f7d7754be081b40b8c81784d1e25265d
+  data.tar.gz: 9f8023dbd90ea1d9fb55a1a5c7a9c96a9344b0db43e0735113545406734e0f02ea14bcc1550b8d2b335e1b59bd63591812ed2426f66f097789185531f6d2db51

data/CHANGELOG.md

@@ -1,12 +1,46 @@
-## Release v0.8.6
+Changelog
+===================
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+[Unreleased]
+-------------------
+
+[0.8.7] - 2022-08-11
+-------------------
+
+### Added
+
+* Add a Faulty#clear method to reset all circuits #55 justinhoward
+
+### Fixed
+
+* Update rubocop cleanup gemspec #56 justinhoward
+
+[0.8.6] - 2022-02-24
+-------------------
+
+### Added
 
 * Define an inspect method that represent circuit #50 JuanitoFatas
 
-## Release v0.8.5
+[0.8.5] - 2022-02-17
+-------------------
+
+### Added
+
+* Add granular errors for Elasticsearch patch #48 justinhoward
+
+### Fixed
 
 * Fix yard warnings #49 justinhoward
 * Fix crash in Redis storage backend if opened_at was missing #46 justinhoward
-* Add granular errors for Elasticsearch patch #48 justinhoward
+
+### Changed
+
 * Return status conditionally for Storage::Interface#entry #45 justinhoward
 
 ### Deprecations
@@ -18,22 +52,35 @@
 * The error_module option is deprecated. Patches should use the error_mapper
   option instead. The option will be removed in 0.9
 
+[0.8.4] - 2022-01-28
+-------------------
 
-## Release v0.8.4
+### Added
 
 * Add Elasticsearch client patch #44 justinhoward
 
-## Release v0.8.2
+[0.8.2] - 2021-10-18
+-------------------
+
+### Fixed
 
 * Fix crash for older versions of concurrent-ruby #42 justinhoward
 
-## Release v0.8.1
+[0.8.1] - 2021-09-22
+-------------------
+
+### Changed
 
 * Add cause message to CircuitTrippedError #40 justinhoward
+
+### Fixed
+
 * Record failures for cache hits #41 justinhoward
 
+[0.8.0] - 2021-09-14
+-------------------
 
-## Release v0.8.0
+### Added
 
 * Store circuit options in the backend when run #34 justinhoward
 
@@ -52,16 +99,28 @@
   instances, so likely this will not be a breaking change for most
   cases.
 
-## Release v0.7.2
+[0.7.2] - 2021-09-02
+-------------------
+
+### Added
 
 * Add Faulty.disable! for disabling globally #38 justinhoward
+
+### Changed
+
 * Suppress circuit_success for proxy circuits #39 justinhoward
 
-## Release v0.7.1
+[0.7.1] - 2021-09-02
+-------------------
+
+### Fixed
 
 * Fix success event crash in log listener #37 justinhoward
 
-## Release v0.7.0
+[0.7.0] - 2021-09-02
+-------------------
+
+### Added
 
 * Add initial benchmarks and performance improvements #36 justinhoward
 
@@ -70,22 +129,37 @@
 The `circuit_success` event no longer contains the status value. Computing this
 value was causing performance problems.
 
-## Release v0.6.0
+[0.6.0] - 2021-06-10
+-------------------
+
+### Added
+
+* Capture an error for BUSY redis backend when patched #30 justinhoward
+* Add a patch for mysql2 #28 justinhoward
+
+### Fixed
 
 * docs, use correct state in description for skipped event #27 senny
 * Fix CI to set REDIS_VERSION correctly #31 justinhoward
 * Fix a potential memory leak in patches #32 justinhoward
-* Capture an error for BUSY redis backend when patched #30 justinhoward
-* Add a patch for mysql2 #28 justinhoward
 
-## Release v0.5.1
+[0.5.1] - 2021-05-28
+-------------------
+
+### Fixed
 
 * Fix Storage::FaultTolerantProxy to return empty history on entries fail #26 justinhoward
 
-## Release v0.5.0
+[0.5.0] - 2021-05-28
+-------------------
+
+### Added
 
 * Allow creating a new Faulty instance in Faulty#register #24 justinhoward
 * Add support for patches to core dependencies starting with redis #14 justinhoward
+
+### Fixed
+
 * Improve storage #entries performance by returning entries #23 justinhoward
 
 ### Breaking Changes
@@ -95,23 +169,35 @@ value was causing performance problems.
 * Faulty::Storage::Interface must now return a history array instead of a
   circuit status object. Custom storage backends must be updated.
 
-## Release v0.4.0
+[0.4.0] - 2021-02-19
+-------------------
+
+### Added
 
-* Switch from Travis CI to GitHub actions #11 justinhoward
-* Only run rubocop for Ruby 2.7 in CI #12 justinhoward
 * Explicitly add support for Redis 3 and 4 #15 justinhoward
 * Allow setting default circuit options on Faulty instances #16 justinhoward
+
+### Changed
+
+* Switch from Travis CI to GitHub actions #11 justinhoward
+* Only run rubocop for Ruby 2.7 in CI #12 justinhoward
 * Switch to codacy for quality metrics #17 justinhoward
+* Allow passing custom circuit to AutoWire #22 justinhoward
+
+### Fixed
+
 * Small logic fix to README #19 silasb
 * Fix Redis storage dependency on ConnectionPool #21 justinhoward
-* Allow passing custom circuit to AutoWire #22 justinhoward
 
 ### Breaking Changes
 
 AutoWire.new is replaced with AutoWire.wrap and no longer creates an instance
 of AutoWire.
 
-## Release v0.3.0
+[0.3.0] - 2020-10-24
+-------------------
+
+### Added
 
 * Add tools for backend fault-tolerance #10
   * CircuitProxy for wrapping storage in an internal circuit
@@ -120,7 +206,10 @@ of AutoWire.
   * AutoWire wrappers for automatically configuring storage and cache
   * Better documentation for fault-tolerance
 
-## Release v0.2.0
+[0.2.0] - 2020-10-18
+-------------------
+
+### Changed
 
 * Remove Scopes and replace them with Faulty instances #9
 
@@ -129,28 +218,71 @@ of AutoWire.
 * `Faulty::Scope` has been removed. Use `Faulty.new` instead.
 * `Faulty` is now a class, not a module
 
-## Release v0.1.5
+[0.1.5] - 2020-10-18
+-------------------
+
+### Fixed
 
 * Fix redis storage to expire state key when using CAS #8
 
-## Release v0.1.4
+[0.1.4] - 2020-10-18
+-------------------
+
+### Fixed
 
 * Improve spec coverage for supporting classes #6
 * Fix redis bug where concurrent CAS requests could crash #7
 
-## Release v0.1.3
+[0.1.3] - 2020-09-29
+-------------------
+
+### Added
 
-* Fix bug where memory storage would delete the newest entries #5
 * Add HoneybadgerListener for error reporting #4
 
-## Release v0.1.2
+### Fixed
+
+* Fix bug where memory storage would delete the newest entries #5
+
+[0.1.2] - 2020-08-28
+-------------------
+
+### Fixed
 
 * Fix Storage::FaultTolerantProxy open and reopen methods #2
 
-## Release v0.1.1
+[0.1.1] - 2020-08-28
+-------------------
+
+### Fixed
 
 * Fix a crash when Storage::FaultTolerantProxy created a status stub #1
 
-## Release v0.1.0
+[0.1.0] - 2020-08-27
+-------------------
 
 Initial public release
+
+[Unreleased]: https://github.com/ParentSquare/faulty/compare/v0.5.0...HEAD
+[0.8.6]: https://github.com/ParentSquare/faulty/compare/v0.8.5...v0.8.6
+[0.8.5]: https://github.com/ParentSquare/faulty/compare/v0.8.4...v0.8.5
+[0.8.4]: https://github.com/ParentSquare/faulty/compare/v0.8.3...v0.8.4
+[0.8.3]: https://github.com/ParentSquare/faulty/compare/v0.8.2...v0.8.3
+[0.8.2]: https://github.com/ParentSquare/faulty/compare/v0.8.1...v0.8.2
+[0.8.1]: https://github.com/ParentSquare/faulty/compare/v0.8.0...v0.8.1
+[0.8.0]: https://github.com/ParentSquare/faulty/compare/v0.7.2...v0.8.0
+[0.7.2]: https://github.com/ParentSquare/faulty/compare/v0.7.1...v0.7.2
+[0.7.1]: https://github.com/ParentSquare/faulty/compare/v0.7.0...v0.7.1
+[0.7.0]: https://github.com/ParentSquare/faulty/compare/v0.6.0...v0.7.0
+[0.6.0]: https://github.com/ParentSquare/faulty/compare/v0.5.1...v0.5.0
+[0.5.1]: https://github.com/ParentSquare/faulty/compare/v0.5.0...v0.5.1
+[0.5.0]: https://github.com/ParentSquare/faulty/compare/v0.4.0...v0.5.0
+[0.4.0]: https://github.com/ParentSquare/faulty/compare/v0.3.0...v0.4.0
+[0.3.0]: https://github.com/ParentSquare/faulty/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/ParentSquare/faulty/compare/v0.1.5...v0.2.0
+[0.1.5]: https://github.com/ParentSquare/faulty/releases/tag/v0.1.4...v0.1.5
+[0.1.4]: https://github.com/ParentSquare/faulty/releases/tag/v0.1.3...v0.1.4
+[0.1.3]: https://github.com/ParentSquare/faulty/releases/tag/v0.1.2...v0.1.3
+[0.1.2]: https://github.com/ParentSquare/faulty/releases/tag/v0.1.1...v0.1.2
+[0.1.1]: https://github.com/ParentSquare/faulty/releases/tag/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/ParentSquare/faulty/releases/tag/v0.1.0

data/README.md

@@ -90,6 +90,7 @@ Also see "Release It!: Design and Deploy Production-Ready Software" by
   + [Other Built-in Listeners](#other-built-in-listeners)
   + [Custom Listeners](#custom-listeners)
 * [Disabling Faulty Globally](#disabling-faulty-globally)
+* [Testing with Faulty](#testing-with-faulty)
 * [How it Works](#how-it-works)
   + [Caching](#caching)
   + [Fault Tolerance](#fault-tolerance)
@@ -1173,6 +1174,24 @@ not affect the stored state of circuits.
 Faulty will **still use the cache** even when disabled. If you also want to
 disable the cache, configure Faulty to use a `Faulty::Cache::Null` cache.
 
+## Testing with Faulty
+
+Depending on your application, you could choose to
+[disable Faulty globally](#disabling-faulty-globally), but sometimes you may
+want to test your application's behavior in a failure scenario.
+
+If you have such tests, you will want to prevent failures in one test from
+affecting other tests. To clear all circuit states between tests, use `#clear!`.
+For example, with rspec:
+
+```ruby
+RSpec.configure do |config|
+  config.after do
+    Faulty.clear!
+  end
+end
+```
+
 ## How it Works
 
 Faulty implements a version of circuit breakers inspired by "Release It!: Design

data/lib/faulty/circuit.rb

@@ -23,7 +23,7 @@ class Faulty
   # write your own code to periodically check how long it has been running.
   # If you're sure you want ruby's generic Timeout, you can apply it yourself
   # inside the circuit run block.
-  class Circuit # rubocop:disable Metrics/ClassLength
+  class Circuit
     CACHE_REFRESH_SUFFIX = '.faulty_refresh'
 
     attr_reader :name
@@ -462,15 +462,13 @@ class Faulty
       end
       options.notifier.notify(:circuit_failure, circuit: self, status: status, error: error)
 
-      opened = if status.half_open?
+      if status.half_open?
         reopen!(error, status.opened_at)
       elsif status.fails_threshold?
         open!(error)
       else
         false
       end
-
-      opened
     end
 
     def deprecated_entry?
@@ -550,7 +548,7 @@ class Faulty
     # @return [Boolean] true if the cache should be refreshed
     def cache_should_refresh?(key)
       time = options.cache.read(cache_refresh_key(key.to_s)).to_i
-      time + (rand * 2 - 1) * options.cache_refresh_jitter < Faulty.current_time
+      time + (((rand * 2) - 1) * options.cache_refresh_jitter) < Faulty.current_time
     end
 
     # Get the next time to refresh the cache when writing to it

data/lib/faulty/deprecation.rb

@@ -5,7 +5,7 @@ class Faulty
   module Deprecation
     class << self
       # Call to raise errors instead of logging warnings for Faulty deprecations
-      def raise_errors!(enabled = true)
+      def raise_errors!(enabled = true) # rubocop:disable Style/OptionalBooleanParameter
         @raise_errors = (enabled == true)
       end
 

data/lib/faulty/patch/base.rb

@@ -31,13 +31,13 @@ class Faulty
       #
       # @yield A block to run inside the circuit
       # @return The block return value
-      def faulty_run
+      def faulty_run(&block)
         faulty_running_key = "faulty_running_#{object_id}"
         return yield unless @faulty_circuit
         return yield if Thread.current[faulty_running_key]
 
         Thread.current[faulty_running_key] = true
-        @faulty_circuit.run { yield }
+        @faulty_circuit.run(&block)
       ensure
         Thread.current[faulty_running_key] = nil
       end

data/lib/faulty/patch/redis.rb

@@ -81,10 +81,8 @@ class Faulty
         return super unless @faulty_circuit
 
         reply = super
-        if reply.is_a?(::Redis::CommandError)
-          if reply.message.start_with?('BUSY')
-            reply = BusyError.new(reply.message)
-          end
+        if reply.is_a?(::Redis::CommandError) && reply.message.start_with?('BUSY')
+          reply = BusyError.new(reply.message)
         end
 
         reply

data/lib/faulty/status.rb

@@ -38,7 +38,9 @@ class Faulty
     :sample_size,
     :options,
     :stub
-  ) do
+  )
+
+  class Status
     include ImmutableOptions
 
     # The allowed state values

data/lib/faulty/storage/circuit_proxy.rb

@@ -58,6 +58,7 @@ class Faulty
         status
         history
         list
+        clear
       ].each do |method|
         define_method(method) do |*args|
           options.circuit.run { @storage.public_send(method, *args) }

data/lib/faulty/storage/fallback_chain.rb

@@ -159,6 +159,14 @@ class Faulty
         end
       end
 
+      # Clears circuits in all storage backends
+      #
+      # @param (see Interface#clear)
+      # @return (see Interface#clear)
+      def clear
+        send_all(:clear)
+      end
+
       # This is fault tolerant if any of the available backends are fault tolerant
       #
       # @param (see Interface#fault_tolerant?)

data/lib/faulty/storage/fault_tolerant_proxy.rb

@@ -81,7 +81,14 @@ class Faulty
       #   @see Interface#list
       #   @param (see Interface#list)
       #   @return (see Interface#list)
-      def_delegators :@storage, :lock, :unlock, :reset, :history, :list
+      #
+      # @!method clear
+      #   Clear is not called in normal operation, so it doesn't capture errors
+      #
+      #   @see Interface#list
+      #   @param (see Interface#list)
+      #   @return (see Interface#list)
+      def_delegators :@storage, :lock, :unlock, :reset, :history, :list, :clear
 
       # Get circuit options safely
       #

data/lib/faulty/storage/interface.rb

@@ -172,6 +172,17 @@ class Faulty
         raise NotImplementedError
       end
 
+      # Reset all circuits
+      #
+      # Some implementions may clear circuits on a best-effort basis since
+      # all circuits may not be known.
+      #
+      # @raise NotImplementedError If the storage backend does not support clearing.
+      # @return [void]
+      def clear
+        raise NotImplementedError
+      end
+
       # Can this storage backend raise an error?
       #
       # If the storage backend returns false from this method, it will be wrapped

data/lib/faulty/storage/memory.rb

@@ -196,6 +196,13 @@ class Faulty
         @circuits.keys
       end
 
+      # Clears all circuits
+      #
+      # @return [void]
+      def clear
+        @circuits.clear
+      end
+
       # Memory storage is fault-tolerant by default
       #
       # @return [true]

data/lib/faulty/storage/null.rb

@@ -79,6 +79,11 @@ class Faulty
         []
       end
 
+      # @param (see Interface#clear)
+      # @return (see Interface#clear)
+      def clear
+      end
+
       # This backend is fault tolerant
       #
       # @param (see Interface#fault_tolerant?)