breakers 0.7.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d07e3fb5d5ea487bfd3a050d06ec8e5094efcb604e18554be68f849cdb0bf5a7
-  data.tar.gz: 4754bcc47f248d9f099dde4a9aaf494bfe47a6e9060ee592c84693e5eaceee2c
+  metadata.gz: 1471486e4b71db051dc6b073a4f5f98cd3a2bb6a10b51a3da6d12d24b1bba5f6
+  data.tar.gz: d7703097ccb4bb819a32c80c28cfabc6563520ffd7552961546873243ab2f125
 SHA512:
-  metadata.gz: 0ff3ede40289743dc8f709dbcba90797b93d48b9e4ccf6215b61b0d45eb0dcb8bc04f7214d4cc8c3a53aa1e43f2318461729e24e1aebcd9490c0b137a3260ee8
-  data.tar.gz: bc44523288871ac14ca612e46fe4bfe167219714bae37dcb7d2fc3c97fa9f894a669fffa70b5c4060629411309bc1ab16d089d1e4b9d03491e2ec7f2dde032fd
+  metadata.gz: b99274dd003feb7f3b362950844eca5f9b194b9a30b0959dfdf8003e4163752dc0400cf69d868069a816089467c6d529788de5b4024186fe1c52f0e70db43ebf
+  data.tar.gz: a112b8f32680017e9c98fbd55b122aa2ab30bc33a1a950e9e2c9236ca4d294df4b96338012dab8e4f23e5e0fb89dba04768b37ee43b9eff0e34a1bebb4e78a4a

data/.github/workflows/rspec.yml

@@ -0,0 +1,27 @@
+name: Run RSpec Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3.6'
+          bundler-cache: true
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run RSpec tests
+        run: bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## [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

@@ -26,7 +26,7 @@ Or install it yourself as:
 ```ruby
 service = Breakers::Service.new(
   name: 'messaging',
-  request_matcher: proc { |request_env| request_env.url.host =~ /.*messaging\.va\.gov/ }
+  request_matcher: proc { |breakers_service, request_env, request_service_name| request_env.url.host =~ /.*messaging\.va\.gov/ }
 )
 
 client = Breakers::Client.new(redis_connection: redis, services: [service])
@@ -57,7 +57,7 @@ are defined like this:
 ```ruby
 service = Breakers::Service.new(
   name: 'messaging',
-  request_matcher: proc { |request_env| request_env.url.host =~ /.*messaging\.va\.gov/ },
+  request_matcher: proc { |breakers_service, request_env, request_service_name| breakers_service.name == request_service_name },
   seconds_before_retry: 60,
   error_threshold: 50
 )
@@ -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
 
@@ -177,6 +174,10 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+**NOTE** If you have not previously signed in to Rubygems, you'll be prompted to:
+* create and/or sign in to your account via your terminal
+* (if you aren't already an owner) have an owner add you with `gem owner breakers --add <your_email@email.com>`
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/department-of-veterans-affairs/breakers.

data/breakers.gemspec

@@ -22,11 +22,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'base64', '~> 0.2'
   spec.add_dependency 'faraday', ['>= 1.2.0', '< 3.0']
   spec.add_dependency 'multi_json', '~> 1.0'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'byebug', '~> 9.0'
+  spec.add_development_dependency 'byebug', '~> 11.1'
   spec.add_development_dependency 'fakeredis', '~> 0.6.0'
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

data/lib/breakers/client.rb

@@ -23,10 +23,11 @@ module Breakers
     # Given a request environment, return the service that should handle it.
     #
     # @param request_env [Faraday::Env] the request environment
+    # @param service_name [String] the service name
     # @return [Breakers::Service] the service object
-    def service_for_request(request_env:)
+    def service_for_request(request_env:, service_name:)
       @services.find do |service|
-        service.handles_request?(request_env: request_env)
+        service.handles_request?(request_env: request_env, service_name: service_name)
       end
     end
   end

data/lib/breakers/service.rb

@@ -33,8 +33,8 @@ module Breakers
     #
     # @param request_env [Faraday::Env] the request environment
     # @return [Boolean] should the service handle the request
-    def handles_request?(request_env:)
-      @configuration[:request_matcher].call(request_env)
+    def handles_request?(request_env:, service_name:)
+      @configuration[:request_matcher].call(self, request_env, service_name)
     end
 
     # Get the seconds before retry parameter

data/lib/breakers/uptime_middleware.rb

@@ -4,16 +4,21 @@ require 'multi_json'
 module Breakers
   # The faraday middleware
   class UptimeMiddleware < Faraday::Middleware
-    def initialize(app)
+    def initialize(app, args = nil)
+      @service_name = args&.dig(:service_name)
       super(app)
     end
 
+    def service_name
+      @service_name
+    end
+
     def call(request_env)
       if Breakers.disabled?
         return @app.call(request_env)
       end
 
-      service = Breakers.client.service_for_request(request_env: request_env)
+      service = Breakers.client.service_for_request(request_env: request_env, service_name: @service_name)
 
       if !service
         return @app.call(request_env)
@@ -21,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
@@ -40,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 = '0.7.1'.freeze
+  VERSION = '1.0.1'.freeze
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: breakers
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Aubrey Holland
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-08 00:00:00.000000000 Z
+date: 2025-06-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -64,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '11.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '11.1'
 - !ruby/object:Gem::Dependency
   name: fakeredis
   requirement: !ruby/object:Gem::Requirement
@@ -179,10 +193,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/codeql.yml"
+- ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.md
@@ -217,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.21
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Handle outages to backend systems with a Faraday middleware