faraday_middleware-circuit_breaker 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 005afebe17fb37c37d260ca776c581cc92cda261b7cafc241d6d4fb7ce39d860
-  data.tar.gz: e54b70864d6a74e8b13414c8af69dfb9ec5040a7c883663b088478ac523f19e3
+  metadata.gz: d5a3dccaa9bcc535cc6bfc148b6053694f1b00ae665fef5e804d5ba62ae06d03
+  data.tar.gz: '09ac266ab4de9e01bd451a0e74bf9fdaf69d6fd8e5d28d6c7b3307a817fbd43f'
 SHA512:
-  metadata.gz: 81884db0ec02ed879a7e09d71b370a16a64a23daa183c9d9cfeb2db8650bc4f11339c7a83702f169e814ae048723caa2bb7ecf7c6426055f8a18ad9e4b978e49
-  data.tar.gz: d4f2942b93d59d50f9a994a9e86625a52307a38356b3e40fbf7454ca54c0774da2ca75667babab2fdd2950c71883ee457d49a622f892e50b1cb4fa5c2f3c2b0e
+  metadata.gz: 98b77c124228e11873cba284f6cb21e7a967f2d150e9935fef813c7e9edc29f217585bf9e3fc8680995d638a754e377a4ed4aa7252419b25fcbb8ac8c4163901
+  data.tar.gz: a4fef74912ba82159af427ebbbd92b73cf03d97f8520b8bce434f84c710a2d3acdb9cd250e16067edffbd5bf384d94b57983ee377188327bbb6059d8bdf260f3

data/CHANGELOG.md

@@ -1,11 +1,20 @@
 # 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/),
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [0.6.0]
+### Added
+
+- Merged [12](https://github.com/textmaster/faraday_middleware-circuit_breaker/pull/12) which allows to customize the cache key for the circuit breaker
+
+### Changed
+
+- Relaxed version requirement for Faraday to include 2.x
+
 ## [0.5.0]
 
 ### Changed
@@ -32,7 +41,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * Introduces sentry/raven notifier
 
-[Unreleased]: https://github.com/textmaster/faraday_middleware-circuit_breaker/compare/v0.5.0...HEAD
+[Unreleased]: https://github.com/textmaster/faraday_middleware-circuit_breaker/compare/v0.6.0...HEAD
+[0.6.0]: https://github.com/textmaster/faraday_middleware-circuit_breaker/compare/v0.4.1...v0.6.0
 [0.5.0]: https://github.com/textmaster/faraday_middleware-circuit_breaker/compare/v0.4.1...v0.5.0
 [0.4.1]: https://github.com/textmaster/faraday_middleware-circuit_breaker/compare/v0.4.0...v0.4.1
 [0.4.0]: https://github.com/textmaster/faraday_middleware-circuit_breaker/compare/v0.3.0...v0.4.0

data/README.md

@@ -93,7 +93,7 @@ proc { Faraday::Response.new(status: 503, response_headers: {}) }
 In some situations, it might required to allow for particular error types to be exempt from tripping the circuit breaker
 (like regular 403 or 401 HTTP responses, which aren't really out-of-the-ordinary conditions that should trip the circuit breaker).
 The underlying stoplight gem supports [custom error handling](https://github.com/orgsync/stoplight#custom-errors),
-The `error_handler` option allows you to add your own customer error handler behavior: 
+The `error_handler` option allows you to add your own customer error handler behavior:
 
 ```ruby
 Faraday.new(url: 'http://foo.com') do |c|
@@ -104,7 +104,7 @@ end
 Middleware will try to call the `call` method on `error_handler` passing 2 arguments:
 
 - `exception` -- the exception raised that triggered the circuit breaker
-- `handler` -- the current error handler `Proc` that would be in charge of handling the `exception` if no `error_handler` option was passed 
+- `handler` -- the current error handler `Proc` that would be in charge of handling the `exception` if no `error_handler` option was passed
 
 You can pass a method to be eager called like this (with a handler that exempts `ArgumentError` from tripping the circuit):
 
@@ -122,6 +122,52 @@ end
 NOTE: It is most always a good idea to call the original `handler` with the exception that was passed in at the end of your
 handler. (By default, the `error_handler` will just be [`Stoplight::Default::ERROR_HANDLER`](https://github.com/orgsync/stoplight/blob/master/lib/stoplight/default.rb#L9))
 
+### Custom Stoplight key
+
+By default, the circuit breaker will count failures by domain, but this logic can be tweak by passing a lambda to the `cache_key_generator` option.
+The lambda will receive the [URI](https://docs.ruby-lang.org/en/2.1.0/URI.html) that Faraday is trying to call, and whatever string it returns will be used as the key to count the errors,
+and all URI with the same key will trip together.
+
+The default behaviour is:
+
+```ruby
+Faraday.new(url: 'http://foo.com/bar') do |c|
+  c.use :circuit_breaker, cache_key_generator: ->(url) { URI.join(url, '/').to_s }
+end
+```
+
+But for instance if when `http://foo.com/bar?id=1` trips you also want `http://foo.com/bar?id=2` to be tripped but `http://foo.com/foo` to go through, then you could pass the following:
+
+```ruby
+Faraday.new(url: 'http://foo.com/bar') do |c|
+  c.use :circuit_breaker, cache_key_generator: lambda do |url|
+        base_url = url.clone
+        base_url.fragment = base_url.query = nil
+        base_url.to_s
+      end
+end
+```
+
+Because the key is a simple string, it doesn't have to be constructed from the URI directly, so the following is also valid:
+
+```ruby
+Faraday.new(url: 'http://foo.com/bar') do |c|
+  c.use :circuit_breaker, cache_key_generator: lambda do |url|
+        if url.hostname == 'api.mydomain.com'
+          if url.path.start_with? "/users"
+            return "user_service"
+          elsif url.path.start_with? "/orders"
+            return "orders_service"
+          else
+            return "other_service"
+          end
+        end
+
+        URI.join(url, '/').to_s
+      end
+end
+```
+
 ### Notifiers
 
 Middleware send notifications to standard error by default. You can customize the receivers.
@@ -196,6 +242,22 @@ end
 
 You'll need to have [Bugsnag](https://rubygems.org/gems/bugsnag) gem installed.
 
+#### Sentry
+
+To send notifications to sentry:
+
+```ruby
+require 'sentry-raven'
+
+sentry_raven = Raven::Configuration.new
+
+Faraday.new(url: 'http://foo.com') do |c|
+  c.use :circuit_breaker, notifiers: { sentry: sentry_raven } # or { raven: sentry_raven }
+end
+```
+
+You'll need to have [Sentry](https://rubygems.org/gems/sentry-raven) gem installed.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -206,8 +268,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/faraday_middleware-circuit_breaker.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/faraday_middleware-circuit_breaker.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'faraday', '>= 0.9', '< 2.0'
+  spec.add_dependency 'faraday', '>= 0.9', '< 3.0'
   spec.add_dependency 'stoplight', '>= 2.1', '< 4.0'
 
   spec.add_development_dependency 'rspec'

data/lib/faraday_middleware/circuit_breaker/middleware.rb

@@ -17,8 +17,8 @@ module FaradayMiddleware
       end
 
       def call(env)
-        base_url = URI.join(env.url, '/')
-        Stoplight(base_url.to_s) do
+        base_url = option_set.cache_key_generator.call(env.url)
+        Stoplight(base_url) do
           @app.call(env)
         end
         .with_cool_off_time(option_set.timeout)

data/lib/faraday_middleware/circuit_breaker/option_set.rb

@@ -6,9 +6,9 @@ module FaradayMiddleware
   module CircuitBreaker
     class OptionSet
 
-      VALID_OPTIONS = %w(timeout threshold fallback notifiers data_store error_handler)
+      VALID_OPTIONS = %w(timeout threshold fallback notifiers data_store error_handler cache_key_generator)
 
-      attr_accessor :timeout, :threshold, :fallback, :notifiers, :data_store, :error_handler
+      attr_accessor :timeout, :threshold, :fallback, :notifiers, :data_store, :error_handler, :cache_key_generator
 
       def initialize(options = {})
         @timeout    = options[:timeout] || 60.0
@@ -17,6 +17,7 @@ module FaradayMiddleware
         @notifiers  = options[:notifiers] || {}
         @data_store = options[:data_store] || proc { Stoplight::Light.default_data_store }
         @error_handler = options[:error_handler] || Stoplight::Default::ERROR_HANDLER
+        @cache_key_generator = options[:cache_key_generator] || ->(url) { URI.join(url, '/').to_s }
       end
 
       def self.validate!(options)

data/lib/faraday_middleware/circuit_breaker/version.rb

@@ -1,5 +1,5 @@
 module FaradayMiddleware
   module CircuitBreaker
-    VERSION = "0.5.0".freeze
+    VERSION = "0.6.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday_middleware-circuit_breaker
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Pierre-Louis Gottfrois
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-27 00:00:00.000000000 Z
+date: 2024-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -19,7 +19,7 @@ dependencies:
         version: '0.9'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '0.9'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: stoplight
   requirement: !ruby/object:Gem::Requirement
@@ -110,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Middleware to apply circuit breaker pattern.