faulty 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d954b29a9efe4360a4b3ab940afa5f4d9b51642c6244bcbc3875fb7bdf569c7
-  data.tar.gz: b0babca45decf10cf5b0505b301e7c89837385cd21a5727048599f2c9097549d
+  metadata.gz: d963d5c58861cc9e39c3222b5dc78a2a537c15fc10e0ed76d9d5b41a6704356b
+  data.tar.gz: e31811fc1b5be36975982e966106ea7f323b4e334b87cfaca85667f550245584
 SHA512:
-  metadata.gz: 56c406768fe13d23cec5c56b1c6d25f278f578895c90c01731dda8f3b002f7a2ca1b06b17195cf7f86d358699b7b8fc3c9648c8aa6b0a2d30fd12f7a3a0e92e6
-  data.tar.gz: 0bfed6c5968d43262d4c1e02735339f6a9858a9bbebecbffcb8d9ed36a4bf2ea068fa5c6035675592eaaed3df267815c1e24b73a484f4aa421cac17ab602a805
+  metadata.gz: 52aae6a3997fca7d38aebd124399747ee21a687114076e5d73c135d86ab147360e71a9f7a95ee4a5f548b6709089697e77fa472730c3fc18cb9c1d412bdac4ca
+  data.tar.gz: 56b02cad8fe96373c916746bfc7c6f83665a74e7a3771d7b761244373b1d4b79aeb44d94fbe9401f82f8671b4e21c625a079b4845a42565dfbfbdfd37a07d2bf

data/CHANGELOG.md

@@ -1,6 +1,11 @@
+## Release v0.7.2
+
+* Add Faulty.disable! for disabling globally #38 justinhoward
+* Suppress circuit_success for proxy circuits #39 justinhoward
+
 ## Release v0.7.1
 
-- Fix success event crash in log listener #37 justinhoward
+* Fix success event crash in log listener #37 justinhoward
 
 ## Release v0.7.0
 

data/README.md

@@ -88,6 +88,7 @@ Also see "Release It!: Design and Deploy Production-Ready Software" by
   + [CallbackListener](#callbacklistener)
   + [Other Built-in Listeners](#other-built-in-listeners)
   + [Custom Listeners](#custom-listeners)
+* [Disabling Faulty Globally](#disabling-faulty-globally)
 * [How it Works](#how-it-works)
   + [Caching](#caching)
   + [Fault Tolerance](#fault-tolerance)
@@ -1124,6 +1125,21 @@ Faulty.init do |config|
 end
 ```
 
+## Disabling Faulty Globally
+
+For testing or for some environments, you may wish to disable Faulty circuits
+at a global level.
+
+```ruby
+Faulty.disable!
+```
+
+This only affects the process where you run the `#disable!` method and it does
+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.
+
 ## How it Works
 
 Faulty implements a version of circuit breakers inspired by "Release It!: Design

data/lib/faulty/cache/circuit_proxy.rb

@@ -33,7 +33,7 @@ class Faulty
 
           self.circuit ||= Circuit.new(
             Faulty::Storage::CircuitProxy.name,
-            notifier: notifier,
+            notifier: Events::FilterNotifier.new(notifier, exclude: %i[circuit_success]),
             cache: Cache::Null.new
           )
         end

data/lib/faulty/circuit.rb

@@ -433,6 +433,8 @@ class Faulty
     #
     # @return [Storage::Interface]
     def storage
+      return Faulty::Storage::Null.new if Faulty.disabled?
+
       options.storage
     end
   end

data/lib/faulty/events/filter_notifier.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Faulty
+  module Events
+    # Wraps a Notifier and filters events by name
+    class FilterNotifier
+      # @param notifier [Notifier] The internal notifier to filter events for
+      # @param events [Array, nil] An array of events to allow. If nil, all
+      #   {EVENTS} will be used
+      # @param exclude [Array, nil] An array of events to disallow. If nil,
+      #   no events will be disallowed. Takes priority over `events`.
+      def initialize(notifier, events: nil, exclude: nil)
+        @notifier = notifier
+        @events = Set.new(events || EVENTS)
+        exclude&.each { |e| @events.delete(e) }
+      end
+
+      # Notify all listeners of an event
+      #
+      # If a listener raises an error while handling an event, that error will
+      # be captured and written to STDERR.
+      #
+      # @param (see Notifier)
+      def notify(event, payload)
+        return unless @events.include?(event)
+
+        @notifier.notify(event, payload)
+      end
+    end
+  end
+end

data/lib/faulty/events.rb

@@ -26,3 +26,4 @@ require 'faulty/events/callback_listener'
 require 'faulty/events/honeybadger_listener'
 require 'faulty/events/log_listener'
 require 'faulty/events/notifier'
+require 'faulty/events/filter_notifier'

data/lib/faulty/storage/circuit_proxy.rb

@@ -33,7 +33,7 @@ class Faulty
 
           self.circuit ||= Circuit.new(
             Faulty::Storage::CircuitProxy.name,
-            notifier: notifier,
+            notifier: Events::FilterNotifier.new(notifier, exclude: %i[circuit_success]),
             cache: Cache::Null.new
           )
         end

data/lib/faulty/storage/null.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+class Faulty
+  module Storage
+    # A no-op backend for disabling circuits
+    class Null
+      # Define a single global instance
+      @instance = new
+
+      def self.new
+        @instance
+      end
+
+      # @param (see Interface#entry)
+      # @return (see Interface#entry)
+      def entry(_circuit, _time, _success)
+        []
+      end
+
+      # @param (see Interface#open)
+      # @return (see Interface#open)
+      def open(_circuit, _opened_at)
+        true
+      end
+
+      # @param (see Interface#reopen)
+      # @return (see Interface#reopen)
+      def reopen(_circuit, _opened_at, _previous_opened_at)
+        true
+      end
+
+      # @param (see Interface#close)
+      # @return (see Interface#close)
+      def close(_circuit)
+        true
+      end
+
+      # @param (see Interface#lock)
+      # @return (see Interface#lock)
+      def lock(_circuit, _state)
+      end
+
+      # @param (see Interface#unlock)
+      # @return (see Interface#unlock)
+      def unlock(_circuit)
+      end
+
+      # @param (see Interface#reset)
+      # @return (see Interface#reset)
+      def reset(_circuit)
+      end
+
+      # @param (see Interface#status)
+      # @return (see Interface#status)
+      def status(circuit)
+        Faulty::Status.new(
+          options: circuit.options,
+          stub: true
+        )
+      end
+
+      # @param (see Interface#history)
+      # @return (see Interface#history)
+      def history(_circuit)
+        []
+      end
+
+      # @param (see Interface#list)
+      # @return (see Interface#list)
+      def list
+        []
+      end
+
+      # This backend is fault tolerant
+      #
+      # @param (see Interface#fault_tolerant?)
+      # @return (see Interface#fault_tolerant?)
+      def fault_tolerant?
+        true
+      end
+    end
+  end
+end

data/lib/faulty/storage.rb

@@ -10,5 +10,6 @@ require 'faulty/storage/auto_wire'
 require 'faulty/storage/circuit_proxy'
 require 'faulty/storage/fallback_chain'
 require 'faulty/storage/fault_tolerant_proxy'
+require 'faulty/storage/null'
 require 'faulty/storage/memory'
 require 'faulty/storage/redis'

data/lib/faulty/version.rb

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

data/lib/faulty.rb

@@ -128,6 +128,33 @@ class Faulty
     def current_time
       Time.now.to_i
     end
+
+    # Disable Faulty circuits
+    #
+    # This allows circuits to run as if they were always closed. Does
+    # not disable caching.
+    #
+    # Intended for use in tests, or to disable Faulty entirely for an
+    # environment.
+    #
+    # @return [void]
+    def disable!
+      @disabled = true
+    end
+
+    # Re-enable Faulty if disabled with {#disable!}
+    #
+    # @return [void]
+    def enable!
+      @disabled = false
+    end
+
+    # Check whether Faulty was disabled with {#disable!}
+    #
+    # @return [Boolean] True if disabled
+    def disabled?
+      @disabled == true
+    end
   end
 
   attr_reader :options

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faulty
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Justin Howard
@@ -147,6 +147,7 @@ files:
 - lib/faulty/error.rb
 - lib/faulty/events.rb
 - lib/faulty/events/callback_listener.rb
+- lib/faulty/events/filter_notifier.rb
 - lib/faulty/events/honeybadger_listener.rb
 - lib/faulty/events/listener_interface.rb
 - lib/faulty/events/log_listener.rb
@@ -165,6 +166,7 @@ files:
 - lib/faulty/storage/fault_tolerant_proxy.rb
 - lib/faulty/storage/interface.rb
 - lib/faulty/storage/memory.rb
+- lib/faulty/storage/null.rb
 - lib/faulty/storage/redis.rb
 - lib/faulty/version.rb
 homepage: https://github.com/ParentSquare/faulty