faulty 0.8.2 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff7d5c217cd03c4b1a752cef13a7547d0623f9810cb8c7602e91e8aa6a941358
-  data.tar.gz: c6df02b5ac50a0078fb43cc03ee7fad9275f5fe41c471a4a649eda05e6fa1782
+  metadata.gz: 674bada595aee5985be78855425adc16fdb25faa2741cc548758e13ea002bb5a
+  data.tar.gz: 9144ec1b6051acbba1d4cc8cccd792826bd3aee831d4fa04c13b41a860150244
 SHA512:
-  metadata.gz: 0bbd345bbfe4d1acd1ba941ae73ba51fdf7a954fe1ca7a87e214dcbb78f8b44de643cb8cc05d7eb7dbd95de9b767039dbe24535717712dcb4c22d641333a9e33
-  data.tar.gz: afa9ccb28dec10f811c3076def8722323fb491b8e8e6ebf6f6917023a6c2a92eec515f0aaf86b74f9fd99f7947ce7e0e859358d6a16412675066a90e547d62ec
+  metadata.gz: 75a8f4cf1608f65f326c66c3682826542e469891cbad97ba31b3854e75899f1e694dc5925e072582c5ac35ce29c9838535f0aca0e17d24c05a2bc5b9796cecae
+  data.tar.gz: faa2361bc38bcb52917491eee6c499ef16114f100d844385e6eb799f531097e45780d2fc0db31447330cc1a3ef982fdd4bbfa45bb5a53fdec1ef776b7ae1f010

data/.github/workflows/ci.yml

@@ -22,6 +22,11 @@ jobs:
         image: redis
         ports:
           - 6379:6379
+      elasticsearch:
+        image: elasticsearch:7.13.4
+        ports:
+          - 9200:9200
+        options: -e="discovery.type=single-node" --health-cmd="curl http://localhost:9200/_cluster/health" --health-interval=3s --health-timeout=5s --health-retries=20
     steps:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1

data/CHANGELOG.md

@@ -1,8 +1,12 @@
-## Releae v0.8.2
+## Release v0.8.4
+
+* Add Elasticsearch client patch #44 justinhoward
+
+## Release v0.8.2
 
 * Fix crash for older versions of concurrent-ruby #42 justinhoward
 
-## Releae v0.8.1
+## Release v0.8.1
 
 * Add cause message to CircuitTrippedError #40 justinhoward
 * Record failures for cache hits #41 justinhoward

data/Gemfile

@@ -13,6 +13,8 @@ not_jruby = %i[ruby mingw x64_mingw].freeze
 gem 'activesupport', '>= 4.2'
 gem 'bundler', '>= 1.17', '< 3'
 gem 'byebug', platforms: not_jruby
+# Open source licensed elasticsearch
+gem 'elasticsearch', '> 7', '< 7.14'
 gem 'honeybadger', '>= 2.0'
 gem 'irb', '~> 1.0'
 # Minimum of 0.5.0 for specific error classes

data/README.md

@@ -84,6 +84,7 @@ Also see "Release It!: Design and Deploy Production-Ready Software" by
 * [Patches](#patches)
   + [Patch::Redis](#patchredis)
   + [Patch::Mysql2](#patchmysql2)
+  + [Patch::Elasticsearch](#patchelasticsearch)
 * [Event Handling](#event-handling)
   + [CallbackListener](#callbacklistener)
   + [Other Built-in Listeners](#other-built-in-listeners)
@@ -1046,6 +1047,38 @@ mysql = Mysql2::Client.new(host: '127.0.0.1')
 mysql.query('SELECT * FROM users') # not protected by a circuit
 ```
 
+### Patch::Elasticsearch
+
+[`Faulty::Patch::Elasticsearch`](https://www.rubydoc.info/gems/faulty/Faulty/Patch/Elasticsearch)
+protects a `Elasticsearch::Client` with an internal circuit. Pass a `:faulty` key along
+with your client options to enable the circuit breaker.
+
+```ruby
+require 'faulty/patch/elasticsearch'
+
+es = Elasticsearch::Client.new(url: 'localhost:9200', faulty: {
+  # The name for the Elasticsearch::Client circuit
+  name: 'elasticsearch'
+
+  # The faulty instance to use
+  # This can also be a registered faulty instance or a constant name. See API
+  # docs for more details
+  instance: Faulty.default
+
+  # By default, circuit errors will be subclasses of
+  # Elasticsearch::Transport::Transport::Error
+  # To disable this behavior, set patch_errors to false and Faulty
+  # will raise its default errors
+  patch_errors: true
+})
+```
+
+If you're using Searchkick, you can configure Faulty with `client_options`.
+
+```ruby
+Searchkick.client_options[:faulty] = { name: 'searchkick' }
+```
+
 ## Event Handling
 
 Faulty uses an event-dispatching model to deliver notifications of internal
@@ -1300,7 +1333,8 @@ but there are and have been many other options:
 - [circuit_breaker-ruby](https://github.com/scripbox/circuit_breaker-ruby) (no
   recent activity)
 - [stoplight](https://github.com/orgsync/stoplight) (unmaintained)
-- [circuit_breaker](https://github.com/wooga/circuit_breaker) (archived)
+- [circuit_breaker](https://github.com/wsargent/circuit_breaker) (no recent
+activity)
 - [simple_circuit_breaker](https://github.com/soundcloud/simple_circuit_breaker)
   (unmaintained)
 - [breaker](https://github.com/ahawkins/breaker) (unmaintained)

data/lib/faulty/patch/elasticsearch.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'elasticsearch'
+
+class Faulty
+  module Patch
+    # Patch Elasticsearch to run requests in a circuit
+    #
+    # This module is not required by default
+    #
+    # Pass a `:faulty` key into your Elasticsearch client options to enable
+    # circuit protection. See {Patch.circuit_from_hash} for the available
+    # options.
+    #
+    # By default, all circuit errors raised by this patch inherit from
+    # `::Elasticsearch::Transport::Transport::Error`. One side effect of the way
+    # this patch wraps errors is that `host_unreachable_exceptions` raised by
+    # the inner transport adapters are converted into
+    # `Elasticsearch::Transport::Transport::Error` instead of the transport
+    # error type such as `Faraday::ConnectionFailed`.
+    #
+    # @example
+    #   require 'faulty/patch/elasticsearch'
+    #
+    #   es = Elasticsearch::Client.new(url: 'http://localhost:9200', faulty: {})
+    #   es.search(q: 'test') # raises Faulty::CircuitError if connection fails
+    #
+    #   # If the faulty key is not given, no circuit is used
+    #   es = Elasticsearch::Client.new(url: 'http://localhost:9200', faulty: {})
+    #   es.search(q: 'test') # not protected by a circuit
+    #
+    #   # With Searchkick
+    #   Searchkick.client_options[:faulty] = {}
+    #
+    # @see Patch.circuit_from_hash
+    module Elasticsearch
+      include Base
+
+      Patch.define_circuit_errors(self, ::Elasticsearch::Transport::Transport::Error)
+
+      def initialize(arguments = {}, &block)
+        super
+
+        errors = [::Elasticsearch::Transport::Transport::Error]
+        errors.concat(@transport.host_unreachable_exceptions)
+
+        @faulty_circuit = Patch.circuit_from_hash(
+          'elasticsearch',
+          arguments[:faulty],
+          errors: errors,
+          patched_error_module: Faulty::Patch::Elasticsearch
+        )
+      end
+
+      # Protect all elasticsearch requests
+      def perform_request(*args)
+        faulty_run { super }
+      end
+    end
+  end
+end
+
+::Elasticsearch::Transport::Client.prepend(Faulty::Patch::Elasticsearch)

data/lib/faulty/patch/mysql2.rb

@@ -20,6 +20,9 @@ class Faulty
     # protected by the circuit. This is to allow open transactions to be closed
     # if possible.
     #
+    # By default, all circuit errors raised by this patch inherit from
+    # `::Mysql2::Error::ConnectionError`
+    #
     # @example
     #   require 'faulty/patch/mysql2'
     #

data/lib/faulty/patch/redis.rb

@@ -12,6 +12,9 @@ class Faulty
     # circuit protection. See {Patch.circuit_from_hash} for the available
     # options.
     #
+    # By default, all circuit errors raised by this patch inherit from
+    # `::Redis::BaseConnectionError`
+    #
     # @example
     #   require 'faulty/patch/redis'
     #

data/lib/faulty/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faulty
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.4
 platform: ruby
 authors:
 - Justin Howard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-18 00:00:00.000000000 Z
+date: 2022-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -170,6 +170,7 @@ files:
 - lib/faulty/immutable_options.rb
 - lib/faulty/patch.rb
 - lib/faulty/patch/base.rb
+- lib/faulty/patch/elasticsearch.rb
 - lib/faulty/patch/mysql2.rb
 - lib/faulty/patch/redis.rb
 - lib/faulty/result.rb