faulty 0.1.1 → 0.3.0

data/lib/faulty/storage/redis.rb

@@ -1,7 +1,14 @@
 # frozen_string_literal: true
 
-module Faulty
+class Faulty
   module Storage
+    # A storage backend for storing circuit state in Redis.
+    #
+    # When using this or any networked backend, be sure to evaluate the risk,
+    # and set conservative timeouts so that the circuit storage does not cause
+    # cascading failures in your application when evaluating circuits. Always
+    # wrap this backend with a {FaultTolerantProxy} to limit the effect of
+    # these types of events.
     class Redis # rubocop:disable Metrics/ClassLength
       # Separates the time/status for history entry strings
       ENTRY_SEPARATOR = ':'
@@ -27,12 +34,17 @@ module Faulty
       #     circuit run history entry. Default `100`.
       # @!attribute [r] circuit_ttl
       #   @return [Integer] The maximum number of seconds to keep a circuit.
-      #     A value of `nil` disables circuit expiration.
+      #     A value of `nil` disables circuit expiration. This does not apply to
+      #     locks, which have an indefinite storage time.
       #     Default `604_800` (1 week).
       # @!attribute [r] list_granularity
       #   @return [Integer] The number of seconds after which a new set is
       #     created to store circuit names. The old set is kept until
       #     circuit_ttl expires. Default `3600` (1 hour).
+      # @!attribute [r] disable_warnings
+      #   @return [Boolean] By default, this class warns if the client options
+      #     are outside the recommended values. Set to true to disable these
+      #     warnings.
       Options = Struct.new(
         :client,
         :key_prefix,
@@ -40,7 +52,8 @@ module Faulty
         :max_sample_size,
         :sample_ttl,
         :circuit_ttl,
-        :list_granularity
+        :list_granularity,
+        :disable_warnings
       ) do
         include ImmutableOptions
 
@@ -53,7 +66,8 @@ module Faulty
             max_sample_size: 100,
             sample_ttl: 1800,
             circuit_ttl: 604_800,
-            list_granularity: 3600
+            list_granularity: 3600,
+            disable_warnings: false
           }
         end
 
@@ -62,7 +76,7 @@ module Faulty
         end
 
         def finalize
-          self.client = ::Redis.new unless client
+          self.client = ::Redis.new(timeout: 1) unless client
         end
       end
 
@@ -70,6 +84,8 @@ module Faulty
       # @yield [Options] For setting options in a block
       def initialize(**options, &block)
         @options = Options.new(options, &block)
+
+        check_client_options!
       end
 
       # Add an entry to storage
@@ -97,7 +113,7 @@ module Faulty
       # @return (see Interface#open)
       def open(circuit, opened_at)
         redis do |r|
-          opened = compare_and_set(r, state_key(circuit), ['closed', nil], 'open')
+          opened = compare_and_set(r, state_key(circuit), ['closed', nil], 'open', ex: options.circuit_ttl)
           r.set(opened_at_key(circuit), opened_at, ex: options.circuit_ttl) if opened
           opened
         end
@@ -110,7 +126,7 @@ module Faulty
       # @return (see Interface#reopen)
       def reopen(circuit, opened_at, previous_opened_at)
         redis do |r|
-          compare_and_set(r, opened_at_key(circuit), [previous_opened_at.to_s], opened_at)
+          compare_and_set(r, opened_at_key(circuit), [previous_opened_at.to_s], opened_at, ex: options.circuit_ttl)
         end
       end
 
@@ -121,7 +137,7 @@ module Faulty
       # @return (see Interface#close)
       def close(circuit)
         redis do |r|
-          closed = compare_and_set(r, state_key(circuit), ['open'], 'closed')
+          closed = compare_and_set(r, state_key(circuit), ['open'], 'closed', ex: options.circuit_ttl)
           r.del(entries_key(circuit)) if closed
           closed
         end
@@ -196,6 +212,9 @@ module Faulty
         map_entries(entries).reverse
       end
 
+      # List all unexpired circuits
+      #
+      # @return (see Interface#list)
       def list
         redis { |r| r.sunion(*all_list_keys) }
       end
@@ -287,16 +306,16 @@ module Faulty
       # @param new [String] The new value to set if the compare passes
       # @return [Boolean] True if the value was set to `new`, false if the CAS
       #   failed
-      def compare_and_set(redis, key, old, new)
-        result = redis.watch(key) do
+      def compare_and_set(redis, key, old, new, ex:)
+        redis.watch(key) do
           if old.include?(redis.get(key))
-            redis.multi { |m| m.set(key, new) }
+            result = redis.multi { |m| m.set(key, new, ex: ex) }
+            result && result[0] == 'OK'
           else
             redis.unwatch
+            false
           end
         end
-
-        result[0] == 'OK'
       end
 
       # Yield a Redis connection
@@ -330,6 +349,49 @@ module Faulty
           [time.to_i, state == '1']
         end
       end
+
+      def check_client_options!
+        return if options.disable_warnings
+
+        check_redis_options!
+        check_pool_options!
+      rescue StandardError => e
+        warn "Faulty error while checking client options: #{e.message}"
+      end
+
+      def check_redis_options!
+        ropts = redis { |r| r.client.options }
+
+        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
+        end
+
+        unless bad_timeouts.empty?
+          warn <<~MSG
+            Faulty recommends setting Redis timeouts <= 2 to prevent cascading
+            failures when evaluating circuits. Your options are:
+            #{bad_timeouts}
+          MSG
+        end
+
+        if ropts[:reconnect_attempts] > 1
+          warn <<~MSG
+            Faulty recommends setting Redis reconnect_attempts to <= 1 to
+            prevent cascading failures. Your setting is #{ropts[:reconnect_attempts]}
+          MSG
+        end
+      end
+
+      def check_pool_options!
+        if options.client.is_a?(ConnectionPool)
+          timeout = options.client.instance_variable_get(:@timeout)
+          warn(<<~MSG) if timeout > 2
+            Faulty recommends setting ConnectionPool timeouts <= 2 to prevent
+            cascading failures when evaluating circuits. Your setting is #{timeout}
+          MSG
+        end
+      end
     end
   end
 end

data/lib/faulty/version.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-module Faulty
+class Faulty
   # The current Faulty version
   def self.version
-    Gem::Version.new('0.1.1')
+    Gem::Version.new('0.3.0')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faulty
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Justin Howard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-28 00:00:00.000000000 Z
+date: 2020-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -24,54 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.17'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.17'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
@@ -87,33 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: irb
+  name: honeybadger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -142,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
-- !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -184,26 +108,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.38.1
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.17.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.18'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.17.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -218,20 +122,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.25
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.25
 description: 
 email:
 - jmhoward0@gmail.com
@@ -258,6 +148,8 @@ files:
 - faulty.gemspec
 - lib/faulty.rb
 - lib/faulty/cache.rb
+- lib/faulty/cache/auto_wire.rb
+- lib/faulty/cache/circuit_proxy.rb
 - lib/faulty/cache/default.rb
 - lib/faulty/cache/fault_tolerant_proxy.rb
 - lib/faulty/cache/interface.rb
@@ -268,14 +160,17 @@ files:
 - lib/faulty/error.rb
 - lib/faulty/events.rb
 - lib/faulty/events/callback_listener.rb
+- lib/faulty/events/honeybadger_listener.rb
 - lib/faulty/events/listener_interface.rb
 - lib/faulty/events/log_listener.rb
 - lib/faulty/events/notifier.rb
 - lib/faulty/immutable_options.rb
 - lib/faulty/result.rb
-- lib/faulty/scope.rb
 - lib/faulty/status.rb
 - lib/faulty/storage.rb
+- lib/faulty/storage/auto_wire.rb
+- lib/faulty/storage/circuit_proxy.rb
+- lib/faulty/storage/fallback_chain.rb
 - lib/faulty/storage/fault_tolerant_proxy.rb
 - lib/faulty/storage/interface.rb
 - lib/faulty/storage/memory.rb

data/lib/faulty/scope.rb

@@ -1,117 +0,0 @@
-# frozen_string_literal: true
-
-module Faulty
-  # A {Scope} is a group of options and circuits
-  #
-  # For most use-cases the default scope should be used, however, it's possible
-  # to create any number of scopes for applications that require a more complex
-  # configuration or for testing.
-  #
-  # For the most part, scopes are independent, however for some cache and
-  # storage backends, you will need to ensure that the cache keys and circuit
-  # names don't overlap between scopes. For example, if using the Redis storage
-  # backend, you should specify different key prefixes for each scope.
-  class Scope
-    attr_reader :options
-
-    # Options for {Scope}
-    #
-    # @!attribute [r] cache
-    #   @return [Cache::Interface] A cache backend if you want
-    #     to use Faulty's cache support. Automatically wrapped in a
-    #     {Cache::FaultTolerantProxy}. Default `Cache::Default.new`.
-    # @!attribute [r] storage
-    #   @return [Storage::Interface] The storage backend.
-    #     Automatically wrapped in a {Storage::FaultTolerantProxy}.
-    #     Default `Storage::Memory.new`.
-    # @!attribute [r] listeners
-    #   @return [Array] listeners Faulty event listeners
-    # @!attribute [r] notifier
-    #   @return [Events::Notifier] A Faulty notifier. If given, listeners are
-    #     ignored.
-    Options = Struct.new(
-      :cache,
-      :storage,
-      :listeners,
-      :notifier
-    ) do
-      include ImmutableOptions
-
-      private
-
-      def finalize
-        self.notifier ||= Events::Notifier.new(listeners || [])
-
-        self.storage ||= Storage::Memory.new
-        unless storage.fault_tolerant?
-          self.storage = Storage::FaultTolerantProxy.new(storage, notifier: notifier)
-        end
-
-        self.cache ||= Cache::Default.new
-        unless cache.fault_tolerant?
-          self.cache = Cache::FaultTolerantProxy.new(cache, notifier: notifier)
-        end
-      end
-
-      def required
-        %i[cache storage notifier]
-      end
-
-      def defaults
-        {
-          listeners: [Events::LogListener.new]
-        }
-      end
-    end
-
-    # Create a new Faulty Scope
-    #
-    # Note, the process of creating a new scope is not thread safe,
-    # so make sure scopes are setup before spawning threads.
-    #
-    # @see Options
-    # @param options [Hash] Attributes for {Options}
-    # @yield [Options] For setting options in a block
-    def initialize(**options, &block)
-      @circuits = Concurrent::Map.new
-      @options = Options.new(options, &block)
-    end
-
-    # Create or retrieve a circuit
-    #
-    # Within a scope, circuit instances have unique names, so if the given circuit
-    # name already exists, then the existing circuit will be returned, otherwise
-    # a new circuit will be created. If an existing circuit is returned, then
-    # the {options} param and block are ignored.
-    #
-    # @param name [String] The name of the circuit
-    # @param options [Hash] Attributes for {Circuit::Options}
-    # @yield [Circuit::Options] For setting options in a block
-    # @return [Circuit] The new circuit or the existing circuit if it already exists
-    def circuit(name, **options, &block)
-      name = name.to_s
-      options = options.merge(circuit_options)
-      @circuits.compute_if_absent(name) do
-        Circuit.new(name, **options, &block)
-      end
-    end
-
-    # Get a list of all circuit names
-    #
-    # @return [Array<String>] The circuit names
-    def list_circuits
-      options.storage.list
-    end
-
-    private
-
-    # Get circuit options from the scope options
-    #
-    # @return [Hash] The circuit options
-    def circuit_options
-      options = @options.to_h
-      options.delete(:listeners)
-      options
-    end
-  end
-end