knifeswitch 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a4ccbfd70b65a64a5dd7ca2b4415776a2edbf69ecff735d264410f52e872c9c
-  data.tar.gz: e05145c272a86defde56a34123049f1e05995c456291a8f3b08c9e8b46728890
+  metadata.gz: 9c6aa778648af60364b2908e30af44007663408f56e151c8be0648582ada1148
+  data.tar.gz: 91c9fe63b444786c685fb4c58e1f2f3635fd462836097179813ce0610c79779f
 SHA512:
-  metadata.gz: 333b47a38d2c6cfb4a71f9a2fd44a7502e9ca294d93310d31d9279fcce504136ec1b1a5fcbf734a4bb45e9bf4c05479e3687fc2f1b5684bd774f7cb3291ed651
-  data.tar.gz: fdfbfe1d54427f06991127547f6f1a700dd0caba0dffe7de0514e9970eed1a769cc594ac5d53b684f263f88a7b104db3a1460a9925b959c52ca59336c6434f29
+  metadata.gz: c69427977d6d5a5c5ec5eea19e3cbb3606f0b7881c57938c33775d499a56f7a0ee017bdb5ebba4906e99075520969debdb77e77b612e9d2b64e924754b296712
+  data.tar.gz: 47a9dbfcd419a66f6423f08a9b1eeedf5a3fcd07a919366d195d16cabf98679efeaff9448f7f6dd9b7e26384286cfce2a474e5eec51e2ce0a211adf04a841d52

data/README.md

@@ -10,13 +10,13 @@ Yet another circuit breaker gem. This one strives to be as small and simple as p
 circuit = Knifeswitch::Circuit.new(
   namespace:       'whatever',
   exceptions:      [TimeoutExceptionToCatch, Timeout::Error],
-  error_threshold: 5,
-  error_timeout:   60
+  error_threshold: 5, # Open circuit after 5 consecutive errors
+  error_timeout:   60 # Stay open for 60 seconds
 )
 
 response = circuit.run { client.request(...) }
 # 'run' will raise Knifeswitch::CircuitOpen if its error_threshold has
-# been exceeded. In this case: when a timeout occurs 5 times in a row.
+# been exceeded: after a watched exception has been raised 5 times.
 # 
 # The error threshold counter is shared among all Knifeswitch::Circuit
 # instances with the same namespace. The counters are stored in the db,
@@ -28,6 +28,11 @@ response = circuit.run { client.request(...) }
 # When closed, it will just run the block like normal and return the result.
 ```
 
+### Disabling
+
+To "disable" knifeswitch globally, set the environment variable `KNIFESWITCH=OFF`.
+This makes all calls to `Knifeswitch::Circuit#run` yield unconditionally.
+
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -56,18 +61,17 @@ $ bin/dockertest
 You'll need to set up the test Rails app's database. Edit `test/dummy/config/database.yml` as you see fit, and run:
 
 ```bash
-$ rake knifeswitch:create_migrations db:create db:migrate
+$ cd test/dummy && rake knifeswitch:create_migrations db:create db:migrate
 ```
-inside of the `test/dummy` directory.
 
 After that you can run:
 ```bash
 $ bin/test
 ```
-in the project root with no problem. If you end up changing the migration generation rake task, you'll have to clean up and re-run it manually.
+in the project root with no problem. If you end up changing the migration generation rake task, you'll have to manually remove the old migration from the dummy app.
 
 ## Limitations
 
 To keep the gem simple, Knifeswitch depends on [Rails](https://github.com/rails/rails). Technically, it should be pretty simple to make Knifeswitch work without the Rails dependency, but for us since we use Rails it's easier to just keep it as is.
 
-Knifeswitch also softly depends on MySQL, in that it uses MySQL's `ON DUPLICATE KEY UPDATE` syntax.
+Knifeswitch softly depends on MySQL because it uses MySQL's `ON DUPLICATE KEY UPDATE` syntax.

data/lib/knifeswitch/circuit.rb

@@ -30,6 +30,7 @@ module Knifeswitch
     # exceptions:      an array of error types that bump the counter
     # error_threshold: number of errors required to open the circuit
     # error_timeout:   seconds to keep the circuit open
+    # callback:        proc to be called when watched errors raise
     def initialize(
       namespace: 'default',
       exceptions: [Timeout::Error],
@@ -47,11 +48,15 @@ module Knifeswitch
     # Call this with a block to execute the contents of the block under
     # circuit breaker protection.
     #
+    # When ENV['KNIFESWITCH'] == 'OFF', this method always just yields.
+    #
     # Raises Knifeswitch::CircuitOpen when called while the circuit is open.
     def run
+      return yield if turned_off?
+
       with_connection do
         if open?
-          callback.try(:call, CircuitOpen.new)
+          callback&.call CircuitOpen.new
           raise CircuitOpen
         end
 
@@ -60,7 +65,7 @@ module Knifeswitch
         rescue Exception => error
           if exceptions.any? { |watched| error.is_a?(watched) }
             increment_counter!
-            callback.try(:call, error)
+            callback&.call error
           else
             reset_counter!
           end
@@ -127,7 +132,13 @@ module Knifeswitch
 
     private
 
+    # If this is true, knifeswitch should not do anything
+    def turned_off?
+      ENV['KNIFESWITCH']&.downcase == 'off'
+    end
+
     def load_record
+      return nil if turned_off?
       sql(:select_one, %(
         SELECT counter, closetime FROM knifeswitch_counters
         WHERE name = ?

data/lib/knifeswitch/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Knifeswitch
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knifeswitch
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Nigel Baillie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-28 00:00:00.000000000 Z
+date: 2019-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails