faulty 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95e52bcb5c7e0ea6975567ff5d5ce3e5d00e15f0f7a4dd4c059e1998060c242e
-  data.tar.gz: 8ef55ce3375edcd1a14314baec3e3641b19a2a51da1a838e568a2dd1eff761a7
+  metadata.gz: 1fe02d7203e9d26a8f859d55efa9ffbe099ab6c2cf025fe7ca831c6ccdfd684f
+  data.tar.gz: bed9fe698b66b367dab9066ffec98567c60fd8dd57f9ea3ed7ea3a2a3a4a3b48
 SHA512:
-  metadata.gz: 7bf4a244b3d448ec4f7075e3e8eacd6d5777bdf8f3e3e5b033857876651a9be5cacb8f3b78eaabd0881cb18cfc754b0dfb39d5aad0a2105517abc9345612ec4c
-  data.tar.gz: 87f5419f6f75b4efbfeb373f1217a1a505e7d0423a19227114c8700afd1937af210d9ec81b38106f7ad6ea5e0a985d2a2b9b438db01f243d32ac2771ba34a45c
+  metadata.gz: c69668b5b99fc2dad979031bd3a61e61d608c8f1c8ba095924709f3cea1b653a4116edcc45a72fb4d3b72e367a3e8b56d7c3cd3d56ed03aadb0ae48be6f3d7bc
+  data.tar.gz: 97d9ff9d9f6bb368ca395b9338bc52b83ef545f67a1f412729b52aef997f6187d57f28fbfda989584e7d26e5e300127f075699f60b888746eaa0c48a2e3b3656

data/.github/workflows/ci.yml

@@ -25,12 +25,19 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1
+        env:
+          REDIS_VERSION: ${{ matrix.redis }}
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
       - run: bundle exec rubocop
         if: matrix.ruby == '2.7'
+      - name: start MySQL
+        run: sudo /etc/init.d/mysql start
       - run: bundle exec rspec --format doc
+        env:
+          MYSQL_USER: root
+          MYSQL_PASSWORD: root
       - name: Run codacy-coverage-reporter
         uses: codacy/codacy-coverage-reporter-action@master
         with:

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## Release v0.6.0
+
+* docs, use correct state in description for skipped event #27 senny
+* Fix CI to set REDIS_VERSION correctly #31 justinhoward
+* Fix a potential memory leak in patches #32 justinhoward
+* Capture an error for BUSY redis backend when patched #30 justinhoward
+* Add a patch for mysql2 #28 justinhoward
+
 ## Release v0.5.1
 
 * Fix Storage::FaultTolerantProxy to return empty history on entries fail #26 justinhoward

data/Gemfile

@@ -13,7 +13,10 @@ not_jruby = %i[ruby mingw x64_mingw].freeze
 gem 'activesupport', '>= 4.2'
 gem 'bundler', '>= 1.17', '< 3'
 gem 'byebug', platforms: not_jruby
+gem 'honeybadger', '>= 2.0'
 gem 'irb', '~> 1.0'
+# Minimum of 0.5.0 for specific error classes
+gem 'mysql2', '>= 0.5.0', platforms: not_jruby
 gem 'redcarpet', '~> 3.5', platforms: not_jruby
 gem 'rspec_junit_formatter', '~> 0.4'
 gem 'simplecov', '>= 0.17.1'

data/README.md

@@ -83,6 +83,7 @@ Also see "Release It!: Design and Deploy Production-Ready Software" by
   + [Locking Circuits](#locking-circuits)
 * [Patches](#patches)
   + [Patch::Redis](#patchredis)
+  + [Patch::Mysql2](#patchmysql2)
 * [Event Handling](#event-handling)
   + [CallbackListener](#callbacklistener)
   + [Other Built-in Listeners](#other-built-in-listeners)
@@ -948,15 +949,40 @@ Or require them in your `Gemfile`
 gem 'faulty', require: %w[faulty faulty/patch/redis]
 ```
 
+For core dependencies you'll most likely want to use the in-memory circuit
+storage adapter and not the Redis storage adapter. That way if Redis fails, your
+circuit storage doesn't also fail, causing cascading failures.
+
+For example, you can use a separate Faulty instance to manage your Mysql2
+circuit:
+
+```ruby
+# Setup your default config. This can use the Redis backend if you prefer
+Faulty.init do |config|
+  # ...
+end
+
+Faulty.register(:mysql) do |config|
+  # Here we decide to set some circuit defaults more useful for
+  # frequent database calls
+  config.circuit_defaults = {
+    cool_down: 20.0,
+    evaluation_window: 40,
+    sample_threshold: 25
+  }
+end
+
+# Now we can use our "mysql" faulty instance when constructing a Mysql2 client
+Mysql2::Client.new(host: '127.0.0.1', faulty: { instance: 'mysql2' })
+```
+
 ### Patch::Redis
 
 [`Faulty::Patch::Redis`](https://www.rubydoc.info/gems/faulty/Faulty/Patch/Redis)
 protects a Redis client with an internal circuit. Pass a `:faulty` key along
 with your connection options to enable the circuit breaker.
 
-Keep in mind that when using this patch, you'll most likely want to use the
-in-memory circuit storage adapter and not the Redis storage adapter. That way
-if Redis fails, your circuit storage doesn't also fail.
+The Redis patch supports the Redis gem versions 3 and 4.
 
 ```ruby
 require 'faulty/patch/redis'
@@ -982,6 +1008,43 @@ redis = Redis.new(url: 'redis://localhost:6379')
 redis.connect # not protected by a circuit
 ```
 
+### Patch::Mysql2
+
+[`Faulty::Patch::Mysql2`](https://www.rubydoc.info/gems/faulty/Faulty/Patch/Mysql2)
+protects a `Mysql2::Client` with an internal circuit. Pass a `:faulty` key along
+with your connection options to enable the circuit breaker.
+
+Faulty supports the mysql2 gem versions 0.5 and greater.
+
+Note: Although Faulty supports Ruby 2.3 in general, the Mysql2 patch is not
+fully supported on Ruby 2.3. It may work for you, but use it at your own risk.
+
+```ruby
+require 'faulty/patch/mysql2'
+
+mysql = Mysql2::Client.new(host: '127.0.0.1', faulty: {
+  # The name for the Mysql2 circuit
+  name: 'mysql2'
+
+  # 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
+  # Mysql2::Error::ConnectionError
+  # To disable this behavior, set patch_errors to false and Faulty
+  # will raise its default errors
+  patch_errors: true
+})
+
+mysql.query('SELECT * FROM users') # raises Faulty::CircuitError if connection fails
+
+# If the faulty key is not given, no circuit is used
+mysql = Mysql2::Client.new(host: '127.0.0.1')
+mysql.query('SELECT * FROM users') # not protected by a circuit
+```
+
 ## Event Handling
 
 Faulty uses an event-dispatching model to deliver notifications of internal
@@ -1000,7 +1063,7 @@ events. The full list of events is available from
 - `circuit_reopened` - A circuit execution cause the circuit to reopen from
   half-open. Payload: `circuit`, `error`.
 - `circuit_skipped` - A circuit execution was skipped because the circuit is
-  closed. Payload: `circuit`
+  open. Payload: `circuit`
 - `circuit_success` - A circuit execution was successful. Payload: `circuit`,
   `status`
 - `storage_failure` - A storage backend raised an error. Payload `circuit` (can

data/faulty.gemspec

@@ -26,7 +26,6 @@ Gem::Specification.new do |spec|
   # Only essential development tools and dependencies go here.
   # Other non-essential development dependencies go in the Gemfile.
   spec.add_development_dependency 'connection_pool', '~> 2.0'
-  spec.add_development_dependency 'honeybadger', '>= 2.0'
   spec.add_development_dependency 'redis', '>= 3.0'
   spec.add_development_dependency 'rspec', '~> 3.8'
   # 0.81 is the last rubocop version with Ruby 2.3 support

data/lib/faulty/patch/base.rb

@@ -39,7 +39,7 @@ class Faulty
         Thread.current[faulty_running_key] = true
         @faulty_circuit.run { yield }
       ensure
-        Thread.current[faulty_running_key] = false
+        Thread.current[faulty_running_key] = nil
       end
     end
   end

data/lib/faulty/patch/mysql2.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'mysql2'
+
+if Gem::Version.new(Mysql2::VERSION) < Gem::Version.new('0.5.0')
+  raise NotImplementedError, 'The faulty mysql2 patch requires mysql2 0.5.0 or later'
+end
+
+class Faulty
+  module Patch
+    # Patch Mysql2 to run connections and queries in a circuit
+    #
+    # This module is not required by default
+    #
+    # Pass a `:faulty` key into your MySQL connection options to enable
+    # circuit protection. See {Patch.circuit_from_hash} for the available
+    # options.
+    #
+    # COMMIT, ROLLBACK, and RELEASE SAVEPOINT queries are intentionally not
+    # protected by the circuit. This is to allow open transactions to be closed
+    # if possible.
+    #
+    # @example
+    #   require 'faulty/patch/mysql2'
+    #
+    #   mysql = Mysql2::Client.new(host: '127.0.0.1', faulty: {})
+    #   mysql.query('SELECT * FROM users') # raises Faulty::CircuitError if connection fails
+    #
+    #   # If the faulty key is not given, no circuit is used
+    #   mysql = Mysql2::Client.new(host: '127.0.0.1')
+    #   mysql.query('SELECT * FROM users') # not protected by a circuit
+    #
+    # @see Patch.circuit_from_hash
+    module Mysql2
+      include Base
+
+      Patch.define_circuit_errors(self, ::Mysql2::Error::ConnectionError)
+
+      QUERY_WHITELIST = [
+        %r{\A(?:/\*.*?\*/)?\s*ROLLBACK}i,
+        %r{\A(?:/\*.*?\*/)?\s*COMMIT}i,
+        %r{\A(?:/\*.*?\*/)?\s*RELEASE\s+SAVEPOINT}i
+      ].freeze
+
+      def initialize(opts = {})
+        @faulty_circuit = Patch.circuit_from_hash(
+          'mysql2',
+          opts[:faulty],
+          errors: [
+            ::Mysql2::Error::ConnectionError,
+            ::Mysql2::Error::TimeoutError
+          ],
+          patched_error_module: Faulty::Patch::Mysql2
+        )
+
+        super
+      end
+
+      # Protect manual connection pings
+      def ping
+        faulty_run { super }
+      rescue Faulty::Patch::Mysql2::FaultyError
+        false
+      end
+
+      # Protect the initial connnection
+      def connect(*args)
+        faulty_run { super }
+      end
+
+      # Protect queries unless they are whitelisted
+      def query(*args)
+        return super if QUERY_WHITELIST.any? { |r| !r.match(args.first).nil? }
+
+        faulty_run { super }
+      end
+    end
+  end
+end
+
+::Mysql2::Client.prepend(Faulty::Patch::Mysql2)

data/lib/faulty/patch/redis.rb

@@ -8,13 +8,9 @@ class Faulty
     #
     # This module is not required by default
     #
-    # Pass a `:faulty` key into your redis connection options to enable
-    # circuit protection. This hash is a hash of circuit options for the
-    # internal circuit. The hash may also have a `:instance` key, which is the
-    # faulty instance to create the circuit from. `Faulty.default` will be
-    # used if no instance is given. The `:instance` key can also reference a
-    # registered Faulty instance or a global constantso that it can be set
-    # from config files. See {Patch.circuit_from_hash}.
+    # Pass a `:faulty` key into your MySQL connection options to enable
+    # circuit protection. See {Patch.circuit_from_hash} for the available
+    # options.
     #
     # @example
     #   require 'faulty/patch/redis'
@@ -32,12 +28,18 @@ class Faulty
 
       Patch.define_circuit_errors(self, ::Redis::BaseConnectionError)
 
+      class BusyError < ::Redis::CommandError
+      end
+
       # Patches Redis to add the `:faulty` key
       def initialize(options = {})
         @faulty_circuit = Patch.circuit_from_hash(
           'redis',
           options[:faulty],
-          errors: [::Redis::BaseConnectionError],
+          errors: [
+            ::Redis::BaseConnectionError,
+            BusyError
+          ],
           patched_error_module: Faulty::Patch::Redis
         )
 
@@ -49,10 +51,41 @@ class Faulty
         faulty_run { super }
       end
 
-      # Reads/writes to redis are protected
-      def io(&block)
+      # Protect command calls
+      def call(command)
+        faulty_run { super }
+      end
+
+      # Protect command_loop calls
+      def call_loop(command, timeout = 0)
+        faulty_run { super }
+      end
+
+      # Protect pipelined commands
+      def call_pipelined(commands)
         faulty_run { super }
       end
+
+      # Inject specific error classes if client is patched
+      #
+      # This method does not raise errors, it returns them
+      # as exception objects, so we simply modify that error if necessary and
+      # return it.
+      #
+      # The call* methods above will then raise that error, so we are able to
+      # capture it with faulty_run.
+      def io(&block)
+        return super unless @faulty_circuit
+
+        reply = super
+        if reply.is_a?(::Redis::CommandError)
+          if reply.message.start_with?('BUSY')
+            reply = BusyError.new(reply.message)
+          end
+        end
+
+        reply
+      end
     end
   end
 end

data/lib/faulty/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faulty
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Justin Howard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-28 00:00:00.000000000 Z
+date: 2021-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: honeybadger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -167,6 +153,7 @@ files:
 - lib/faulty/immutable_options.rb
 - lib/faulty/patch.rb
 - lib/faulty/patch/base.rb
+- lib/faulty/patch/mysql2.rb
 - lib/faulty/patch/redis.rb
 - lib/faulty/result.rb
 - lib/faulty/status.rb