faulty 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2eda80b5d7aba5948835addf9b8cf418aba0e8ba48453361678a15229ea4481a
-  data.tar.gz: 53a27be99ae42c157be28df1e887033b86a53ccd232b05bc290bf511ac4e9d0c
+  metadata.gz: 8604d16866bb43e4b58ebd4d9efd9e3ae2a85555bd5e2d92c1f1ec8bfa24fb69
+  data.tar.gz: a766e4e122b41e4d58cab15fc0c249a254e940e523b54e8d906d00bcefafb5e2
 SHA512:
-  metadata.gz: 766ab386706d842f4f02faa572d931b702b532071baa221f5c77c1330e3086cab1f2126f548c255254fe3d4f85ca9666698116b808c0b0e29c507ee5f6680c5c
-  data.tar.gz: c5f04aa84ad450ae186c57236d80bb872c4977e60930a0f99e876bf497aa2473c2753d2307634b1cfe0dc332ce1d3c88382281ce2158c13cf140e432afaeb97e
+  metadata.gz: d2bf7c915310ab7eac608fc738f64df191555c7acfe1b6a28eb5a8e0519e42f2cf0512ba5bd7d13d62379783cdbefef69c9fa952d08ff78bf95d973afbd7f15e
+  data.tar.gz: 56963c2e80e34f2f56ac5a4efa405032f9eb72bd176ee0e7683a2f7dd0a4d26f06535773b9056c84c50d2d5349b2c2eb6d9dcc97fa98f3ef130245e3d65adb2b

data/CHANGELOG.md

@@ -9,6 +9,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [Unreleased]
 -------------------
 
+[0.11.0] - 2023-04-26
+---------------------
+
+### Added
+
+* Add storage support for redis gem v5 #63 justinhoward
+* Add Redis 5 support for patch #67 justinhoward
+
 [0.10.0] - 2023-04-05
 ---------------------
 
@@ -300,7 +308,8 @@ of AutoWire.
 
 Initial public release
 
-[Unreleased]: https://github.com/ParentSquare/faulty/compare/v0.10.0...HEAD
+[Unreleased]: https://github.com/ParentSquare/faulty/compare/v0.11.0...HEAD
+[0.11.0]: https://github.com/ParentSquare/faulty/compare/v0.10.0...v0.11.0
 [0.10.0]: https://github.com/ParentSquare/faulty/compare/v0.9.0...v0.10.0
 [0.9.0]: https://github.com/ParentSquare/faulty/compare/v0.8.7...v0.9.0
 [0.8.7]: https://github.com/ParentSquare/faulty/compare/v0.8.6...v0.8.7

data/README.md

@@ -4,7 +4,7 @@
 [![CI](https://github.com/ParentSquare/faulty/workflows/CI/badge.svg)](https://github.com/ParentSquare/faulty/actions?query=workflow%3ACI+branch%3Amaster)
 [![Code Quality](https://app.codacy.com/project/badge/Grade/16bb1df1569a4ddba893a866673dac2a)](https://www.codacy.com/gh/ParentSquare/faulty/dashboard?utm_source=github.com&utm_medium=referral&utm_content=ParentSquare/faulty&utm_campaign=Badge_Grade)
 [![Code Coverage](https://codecov.io/gh/ParentSquare/faulty/branch/master/graph/badge.svg?token=1NDT4FW1YJ)](https://codecov.io/gh/ParentSquare/faulty)
-[![Inline docs](http://inch-ci.org/github/ParentSquare/faulty.svg?branch=master)](http://inch-ci.org/github/ParentSquare/faulty)
+[![Online docs](https://img.shields.io/badge/docs-✓-green.svg)](https://www.rubydoc.info/github/ParentSquare/faulty)
 
 Fault-tolerance tools for ruby based on [circuit-breakers][martin fowler].
 
@@ -985,11 +985,12 @@ Mysql2::Client.new(host: '127.0.0.1', faulty: { instance: 'mysql2' })
 protects a Redis client with an internal circuit. Pass a `:faulty` key along
 with your connection options to enable the circuit breaker.
 
-The Redis patch supports the Redis gem versions 3 and 4.
+The Redis patch supports the Redis gem versions 3 and up
 
 ```ruby
 require 'faulty/patch/redis'
 
+# For Redis <= 4, pass faulty into the top-level connection options
 redis = Redis.new(url: 'redis://localhost:6379', faulty: {
   # The name for the redis circuit
   name: 'redis'
@@ -1004,6 +1005,12 @@ redis = Redis.new(url: 'redis://localhost:6379', faulty: {
   # will raise its default errors
   patch_errors: true
 })
+
+# Or for Redis 5+, pass faulty into the custom connection options
+redis = Redis.new(url: 'redis://localhost:6379', custom: { faulty: {
+  # ...
+}})
+
 redis.connect # raises Faulty::CircuitError if connection fails
 
 # If the faulty key is not given, no circuit is used

data/lib/faulty/circuit.rb

@@ -403,7 +403,7 @@ class Faulty
       cached_value
     end
 
-    # Excecute a run
+    # Execute a run
     #
     # @param cached_value The cached value if one is available
     # @param cache_key [String, nil] The cache key if one is given

data/lib/faulty/patch/redis/middleware.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+class Faulty
+  module Patch
+    module Redis
+      Patch.define_circuit_errors(self, ::RedisClient::ConnectionError)
+
+      class BusyError < ::RedisClient::CommandError
+      end
+
+      module Middleware
+        include Base
+
+        def initialize(client)
+          @faulty_circuit = Patch.circuit_from_hash(
+            'redis',
+            client.config.custom[:faulty],
+            errors: [
+              ::RedisClient::ConnectionError,
+              BusyError
+            ],
+            patched_error_mapper: Faulty::Patch::Redis
+          )
+
+          super
+        end
+
+        def connect(redis_config)
+          faulty_run { super }
+        end
+
+        def call(commands, redis_config)
+          faulty_run { wrap_command { super } }
+        end
+
+        def call_pipelined(commands, redis_config)
+          faulty_run { wrap_command { super } }
+        end
+
+        private
+
+        def wrap_command
+          yield
+        rescue ::RedisClient::CommandError => e
+          raise BusyError, e.message if e.message.start_with?('BUSY')
+
+          raise
+        end
+      end
+
+      ::RedisClient.register(Middleware)
+    end
+  end
+end

data/lib/faulty/patch/redis/patch.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'redis'
+
+class Faulty
+  module Patch
+    module Redis
+      include Base
+
+      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,
+            BusyError
+          ],
+          patched_error_mapper: Faulty::Patch::Redis
+        )
+
+        super
+      end
+
+      # The initial connection is protected by a circuit
+      def connect
+        faulty_run { super }
+      end
+
+      # 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) && reply.message.start_with?('BUSY')
+          reply = BusyError.new(reply.message)
+        end
+
+        reply
+      end
+    end
+  end
+end
+
+class Redis
+  class Client
+    prepend(Faulty::Patch::Redis)
+  end
+end

data/lib/faulty/patch/redis.rb

@@ -8,9 +8,12 @@ class Faulty
     #
     # This module is not required by default
     #
-    # Pass a `:faulty` key into your MySQL connection options to enable
+    # Redis <= 4
+    # ---------------------
+    # Pass a `:faulty` key into your Redis connection options to enable
     # circuit protection. See {Patch.circuit_from_hash} for the available
-    # options.
+    # options. On Redis 5+, the faulty key should be passed in the `:custom` hash
+    # instead of the top-level options. See example.
     #
     # By default, all circuit errors raised by this patch inherit from
     # `::Redis::BaseConnectionError`
@@ -18,7 +21,11 @@ class Faulty
     # @example
     #   require 'faulty/patch/redis'
     #
+    #   # Redis <= 4
     #   redis = Redis.new(url: 'redis://localhost:6379', faulty: {})
+    #   # Or for Redis 5+
+    #   redis = Redis.new(url: 'redis://localhost:6379', custom: { faulty: {} })
+    #
     #   redis.connect # raises Faulty::CircuitError if connection fails
     #
     #   # If the faulty key is not given, no circuit is used
@@ -27,72 +34,12 @@ class Faulty
     #
     # @see Patch.circuit_from_hash
     module Redis
-      include Base
-
-      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,
-            BusyError
-          ],
-          patched_error_mapper: Faulty::Patch::Redis
-        )
-
-        super
-      end
-
-      # The initial connection is protected by a circuit
-      def connect
-        faulty_run { super }
-      end
-
-      # 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) && reply.message.start_with?('BUSY')
-          reply = BusyError.new(reply.message)
-        end
-
-        reply
-      end
     end
   end
 end
 
-class Redis
-  class Client
-    prepend(Faulty::Patch::Redis)
-  end
+if Redis::VERSION.to_f < 5
+  require 'faulty/patch/redis/patch'
+else
+  require 'faulty/patch/redis/middleware'
 end

data/lib/faulty/storage/redis.rb

@@ -25,7 +25,7 @@ class Faulty
       #     circuit state. Default `faulty`.
       # @!attribute [r] key_separator
       #   @return [String] A string used to separate the parts of the Redis keys
-      #     used to store circuit state. Defaulty `:`.
+      #     used to store circuit state. Default `:`.
       # @!attribute [r] max_sample_size
       #   @return [Integer] The number of cache run entries to keep in memory
       #     for each circuit. Default `100`.
@@ -122,7 +122,7 @@ class Faulty
       def entry(circuit, time, success, status)
         key = entries_key(circuit.name)
         result = pipe do |r|
-          r.sadd(list_key, circuit.name)
+          r.call([:sadd, list_key, circuit.name])
           r.expire(list_key, options.circuit_ttl + options.list_granularity) if options.circuit_ttl
           r.lpush(key, "#{time}#{ENTRY_SEPARATOR}#{success ? 1 : 0}")
           r.ltrim(key, 0, options.max_sample_size - 1)
@@ -425,11 +425,16 @@ class Faulty
       end
 
       def check_redis_options!
-        ropts = redis { |r| r.instance_variable_get(:@client).options }
+        gte5 = ::Redis::VERSION.to_f >= 5
+        method = gte5 ? :config : :options
+        ropts = redis do |r|
+          r.instance_variable_get(:@client).public_send(method)
+        end
 
         bad_timeouts = {}
         %i[connect_timeout read_timeout write_timeout].each do |time_opt|
-          bad_timeouts[time_opt] = ropts[time_opt] if ropts[time_opt] > 2
+          value = gte5 ? ropts.public_send(time_opt) : ropts[time_opt]
+          bad_timeouts[time_opt] = value if value > 2
         end
 
         unless bad_timeouts.empty?
@@ -440,10 +445,11 @@ class Faulty
           MSG
         end
 
-        if ropts[:reconnect_attempts] > 1
+        gt1_retry = gte5 ? ropts.retry_connecting?(1, nil) : ropts[:reconnect_attempts] > 1
+        if gt1_retry
           warn <<~MSG
             Faulty recommends setting Redis reconnect_attempts to <= 1 to
-            prevent cascading failures. Your setting is #{ropts[:reconnect_attempts]}
+            prevent cascading failures. Your setting is larger.
           MSG
         end
       end

data/lib/faulty/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faulty
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Justin Howard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-05 00:00:00.000000000 Z
+date: 2023-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -132,6 +132,8 @@ files:
 - lib/faulty/patch/elasticsearch.rb
 - lib/faulty/patch/mysql2.rb
 - lib/faulty/patch/redis.rb
+- lib/faulty/patch/redis/middleware.rb
+- lib/faulty/patch/redis/patch.rb
 - lib/faulty/result.rb
 - lib/faulty/status.rb
 - lib/faulty/storage.rb
@@ -150,7 +152,7 @@ licenses:
 metadata:
   rubygems_mfa_required: 'true'
   changelog_uri: https://github.com/ParentSquare/faulty/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/faulty/0.10.0
+  documentation_uri: https://www.rubydoc.info/gems/faulty/0.11.0
 post_install_message: 
 rdoc_options: []
 require_paths: