breakers 1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 194de9e7c8098e9f42bbcef74c01a05d5dcd21549745ad926a3d91e45683e51a
-  data.tar.gz: 3821978885ed7aa4c18d17e1575965be6093219a30f4bbfa83bbbf53a595da11
+  metadata.gz: 1471486e4b71db051dc6b073a4f5f98cd3a2bb6a10b51a3da6d12d24b1bba5f6
+  data.tar.gz: d7703097ccb4bb819a32c80c28cfabc6563520ffd7552961546873243ab2f125
 SHA512:
-  metadata.gz: 5f8100e0b7f6a97c2afc9005656432357c4ae727e20b44370b4267e647cbca6d0f75fa00aa59b5129d9abf17948da944cd6e016cb1dad02d0ac1d709cff917b5
-  data.tar.gz: d80a4a4df1b473e5da6cf4ec1b3ce61043fc3e9b99ffd65a70934edc4c827ebed130636546e9999ed71fafb64087fc2a2e3d5bcdfbae8914f0212820f80cb9c7
+  metadata.gz: b99274dd003feb7f3b362950844eca5f9b194b9a30b0959dfdf8003e4163752dc0400cf69d868069a816089467c6d529788de5b4024186fe1c52f0e70db43ebf
+  data.tar.gz: a112b8f32680017e9c98fbd55b122aa2ab30bc33a1a950e9e2c9236ca4d294df4b96338012dab8e4f23e5e0fb89dba04768b37ee43b9eff0e34a1bebb4e78a4a

data/CHANGELOG.md

@@ -3,3 +3,7 @@
 ## [1.0] - 2025-03-24
 ### Added
 - Support matching by service name (#40)
+
+## [1.0.1] - 2025-06-05
+### Added
+- Allows forced outages to persist until explicitly ended, using `bundle exec rake breakers:end_forced_outage service="VAOS"`, for example.

data/README.md

@@ -142,17 +142,14 @@ It's ok for your plugin to implement only part of this interface.
 
 ### Forcing an Outage
 
-Some services will have status endpoints that you can use to check their availability, and you may want to create an outage based on that.
-Because this is a middleware, it doesn't have the ability to periodically check these endpoints, but you can add that type of check to your
-application and then force an outage in breakers:
-
-```ruby
-service.begin_forced_outage!
-service.end_forced_outage!
+You can test an outage by faking or forcing an outage using:
+```
+Breakers::Outage#begin_forced_outage!
+```
+Once an forced outage is started, you must manually stop it using:
+```
+Breakers::Outage#end_forced_outage!
 ```
-
-Unlike with outages detected by the middleware, forced outages are not periodically tested to see if they have completed and must be
-manually ended with a call to `end_forced_outage!`.
 
 ### Changing the Outage Response
 

data/lib/breakers/uptime_middleware.rb

@@ -26,13 +26,15 @@ module Breakers
 
       latest_outage = service.latest_outage
 
-      if latest_outage && !latest_outage.ended?
-        if latest_outage.ready_for_retest?(wait_seconds: service.seconds_before_retry)
+      if !latest_outage.nil? && !latest_outage&.ended?
+        if latest_outage.ready_for_retest?(wait_seconds: service.seconds_before_retry) && !latest_outage.forced?
+          # No outage detected, proceed with the request
           handle_request(service: service, request_env: request_env, current_outage: latest_outage)
         else
           outage_response(outage: latest_outage, service: service)
         end
       else
+        # No outage detected, proceed with the request
         handle_request(service: service, request_env: request_env)
       end
     end
@@ -45,9 +47,10 @@ module Breakers
       end
       if Breakers.outage_response[:type] == :status_code
         Faraday::Response.new.tap do |response|
+          forced = outage.forced? ? '[FORCED] ' : ''
           response.finish(
             status: Breakers.outage_response[:status_code],
-            body: "Outage detected on #{service.name} beginning at #{outage.start_time.to_i}",
+            body: "#{forced}Outage detected on #{service.name} beginning at #{outage.start_time.to_i}",
             response_headers: {}
           )
         end

data/lib/breakers/version.rb

@@ -1,3 +1,3 @@
 module Breakers
-  VERSION = '1.0'.freeze
+  VERSION = '1.0.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: breakers
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.0.1
 platform: ruby
 authors:
 - Aubrey Holland
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-25 00:00:00.000000000 Z
+date: 2025-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -233,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Handle outages to backend systems with a Faraday middleware