faulty 0.8.6 → 0.8.7

data/lib/faulty/storage/redis.rb

@@ -9,7 +9,7 @@ class Faulty
     # 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
+    class Redis
       # Separates the time/status for history entry strings
       ENTRY_SEPARATOR = ':'
 
@@ -95,7 +95,7 @@ class Faulty
       # @param (see Interface#get_options)
       # @return (see Interface#get_options)
       def get_options(circuit)
-        json = redis { |r| r.get(options_key(circuit)) }
+        json = redis { |r| r.get(options_key(circuit.name)) }
         return if json.nil?
 
         JSON.parse(json, symbolize_names: true)
@@ -110,7 +110,7 @@ class Faulty
       # @return (see Interface#set_options)
       def set_options(circuit, stored_options)
         redis do |r|
-          r.set(options_key(circuit), JSON.dump(stored_options), ex: options.circuit_ttl)
+          r.set(options_key(circuit.name), JSON.dump(stored_options), ex: options.circuit_ttl)
         end
       end
 
@@ -120,7 +120,7 @@ class Faulty
       # @param (see Interface#entry)
       # @return (see Interface#entry)
       def entry(circuit, time, success, status)
-        key = entries_key(circuit)
+        key = entries_key(circuit.name)
         result = pipe do |r|
           r.sadd(list_key, circuit.name)
           r.expire(list_key, options.circuit_ttl + options.list_granularity) if options.circuit_ttl
@@ -139,11 +139,11 @@ class Faulty
       # @param (see Interface#open)
       # @return (see Interface#open)
       def open(circuit, opened_at)
-        key = state_key(circuit)
+        key = state_key(circuit.name)
         ex = options.circuit_ttl
         result = watch_exec(key, ['closed', nil]) do |m|
           m.set(key, 'open', ex: ex)
-          m.set(opened_at_key(circuit), opened_at, ex: ex)
+          m.set(opened_at_key(circuit.name), opened_at, ex: ex)
         end
 
         result && result[0] == 'OK'
@@ -155,7 +155,7 @@ class Faulty
       # @param (see Interface#reopen)
       # @return (see Interface#reopen)
       def reopen(circuit, opened_at, previous_opened_at)
-        key = opened_at_key(circuit)
+        key = opened_at_key(circuit.name)
         result = watch_exec(key, [previous_opened_at.to_s]) do |m|
           m.set(key, opened_at, ex: options.circuit_ttl)
         end
@@ -169,11 +169,11 @@ class Faulty
       # @param (see Interface#close)
       # @return (see Interface#close)
       def close(circuit)
-        key = state_key(circuit)
+        key = state_key(circuit.name)
         ex = options.circuit_ttl
         result = watch_exec(key, ['open']) do |m|
           m.set(key, 'closed', ex: ex)
-          m.del(entries_key(circuit))
+          m.del(entries_key(circuit.name))
         end
 
         result && result[0] == 'OK'
@@ -187,7 +187,7 @@ class Faulty
       # @param (see Interface#lock)
       # @return (see Interface#lock)
       def lock(circuit, state)
-        redis { |r| r.set(lock_key(circuit), state) }
+        redis { |r| r.set(lock_key(circuit.name), state) }
       end
 
       # Unlock a circuit
@@ -196,7 +196,7 @@ class Faulty
       # @param (see Interface#unlock)
       # @return (see Interface#unlock)
       def unlock(circuit)
-        redis { |r| r.del(lock_key(circuit)) }
+        redis { |r| r.del(lock_key(circuit.name)) }
       end
 
       # Reset a circuit
@@ -205,14 +205,15 @@ class Faulty
       # @param (see Interface#reset)
       # @return (see Interface#reset)
       def reset(circuit)
+        name = circuit.is_a?(Circuit) ? circuit.name : circuit
         pipe do |r|
           r.del(
-            entries_key(circuit),
-            opened_at_key(circuit),
-            lock_key(circuit),
-            options_key(circuit)
+            entries_key(name),
+            opened_at_key(name),
+            lock_key(name),
+            options_key(name)
           )
-          r.set(state_key(circuit), 'closed', ex: options.circuit_ttl)
+          r.set(state_key(name), 'closed', ex: options.circuit_ttl)
         end
       end
 
@@ -224,10 +225,10 @@ class Faulty
       def status(circuit)
         futures = {}
         pipe do |r|
-          futures[:state] = r.get(state_key(circuit))
-          futures[:lock] = r.get(lock_key(circuit))
-          futures[:opened_at] = r.get(opened_at_key(circuit))
-          futures[:entries] = r.lrange(entries_key(circuit), 0, -1)
+          futures[:state] = r.get(state_key(circuit.name))
+          futures[:lock] = r.get(lock_key(circuit.name))
+          futures[:opened_at] = r.get(opened_at_key(circuit.name))
+          futures[:entries] = r.lrange(entries_key(circuit.name), 0, -1)
         end
 
         state = futures[:state].value&.to_sym || :closed
@@ -249,7 +250,7 @@ class Faulty
       # @param (see Interface#history)
       # @return (see Interface#history)
       def history(circuit)
-        entries = redis { |r| r.lrange(entries_key(circuit), 0, -1) }
+        entries = redis { |r| r.lrange(entries_key(circuit.name), 0, -1) }
         map_entries(entries).reverse
       end
 
@@ -260,6 +261,21 @@ class Faulty
         redis { |r| r.sunion(*all_list_keys) }
       end
 
+      # Reset all circuits
+      #
+      # This does not empty the list of circuits as returned by {#list}. This is
+      # because that would be a thread-usafe operation that could result in
+      # circuits not being in the list.
+      #
+      # This implmenentation resets circuits individually, and will be very
+      # slow for large numbers of circuits. It should not be used in production
+      # code.
+      #
+      # @return [void]
+      def clear
+        list.each { |c| reset(c) }
+      end
+
       # Redis storage is not fault-tolerant
       #
       # @return [true]
@@ -276,33 +292,33 @@ class Faulty
         [options.key_prefix, *parts].join(options.key_separator)
       end
 
-      def ckey(circuit, *parts)
-        key('circuit', circuit.name, *parts)
+      def ckey(circuit_name, *parts)
+        key('circuit', circuit_name, *parts)
       end
 
       # @return [String] The key for circuit options
-      def options_key(circuit)
-        ckey(circuit, 'options')
+      def options_key(circuit_name)
+        ckey(circuit_name, 'options')
       end
 
       # @return [String] The key for circuit state
-      def state_key(circuit)
-        ckey(circuit, 'state')
+      def state_key(circuit_name)
+        ckey(circuit_name, 'state')
       end
 
       # @return [String] The key for circuit run history entries
-      def entries_key(circuit)
-        ckey(circuit, 'entries')
+      def entries_key(circuit_name)
+        ckey(circuit_name, 'entries')
       end
 
       # @return [String] The key for circuit locks
-      def lock_key(circuit)
-        ckey(circuit, 'lock')
+      def lock_key(circuit_name)
+        ckey(circuit_name, 'lock')
       end
 
       # @return [String] The key for circuit opened_at
-      def opened_at_key(circuit)
-        ckey(circuit, 'opened_at')
+      def opened_at_key(circuit_name)
+        ckey(circuit_name, 'opened_at')
       end
 
       # Get the current key to add circuit names to
@@ -354,13 +370,11 @@ class Faulty
       #   the watch succeeds and the comparison passes
       # @return [Array] An array of Redis results from the commands executed
       #   inside the block
-      def watch_exec(key, old)
+      def watch_exec(key, old, &block)
         redis do |r|
           r.watch(key) do
             if old.include?(r.get(key))
-              r.multi do |m|
-                yield m
-              end
+              r.multi(&block)
             else
               r.unwatch
               nil
@@ -373,9 +387,9 @@ class Faulty
       #
       # @yield [Redis] Yields the connection to the block
       # @return The value returned from the block
-      def redis
+      def redis(&block)
         if options.client.respond_to?(:with)
-          options.client.with { |redis| yield redis }
+          options.client.with(&block)
         else
           yield options.client
         end
@@ -385,8 +399,8 @@ class Faulty
       #
       # @yield [Redis::Pipeline] Yields the connection to the block
       # @return [void]
-      def pipe
-        redis { |r| r.pipelined { |p| yield p } }
+      def pipe(&block)
+        redis { |r| r.pipelined(&block) }
       end
 
       # Map raw Redis history entries to Faulty format
@@ -435,7 +449,7 @@ class Faulty
       end
 
       def check_pool_options!
-        if options.client.class.name == 'ConnectionPool'
+        if options.client.instance_of?(ConnectionPool)
           timeout = options.client.instance_variable_get(:@timeout)
           warn(<<~MSG) if timeout > 2
             Faulty recommends setting ConnectionPool timeouts <= 2 to prevent

data/lib/faulty/version.rb

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

data/lib/faulty.rb

@@ -116,6 +116,7 @@ class Faulty
 
     # Get a list of all circuit names for the default instance
     #
+    # @see #list_circuits
     # @return [Array<String>] The circuit names
     def list_circuits
       options.storage.list
@@ -157,6 +158,14 @@ class Faulty
     def disabled?
       @disabled == true
     end
+
+    # Reset all circuits for the default instance
+    #
+    # @see #clear
+    # @return [void]
+    def clear!
+      default.clear
+    end
   end
 
   attr_reader :options
@@ -255,6 +264,20 @@ class Faulty
     options.storage.list
   end
 
+  # Reset all circuits
+  #
+  # Intended for use in tests. This can be expensive and is not appropriate
+  # to call in production code
+  #
+  # See the documentation for your chosen backend for specific semantics and
+  # safety concerns. For example, the Redis backend resets all circuits, but
+  # it does not clear the circuit list to maintain thread-safety.
+  #
+  # @return [void]
+  def clear!
+    options.storage.clear
+  end
+
   private
 
   # Get circuit options from the {Faulty} options

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faulty
 version: !ruby/object:Gem::Version
-  version: 0.8.6
+  version: 0.8.7
 platform: ruby
 authors:
 - Justin Howard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2022-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -80,34 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.81.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.81.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.38.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.38.1
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -129,24 +101,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ci.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
 - ".yardopts"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- bin/benchmark
-- bin/check-version
-- bin/console
-- bin/rspec
-- bin/rubocop
-- bin/yard
-- bin/yardoc
-- bin/yri
-- faulty.gemspec
 - lib/faulty.rb
 - lib/faulty/cache.rb
 - lib/faulty/cache/auto_wire.rb
@@ -189,7 +147,10 @@ files:
 homepage: https://github.com/ParentSquare/faulty
 licenses:
 - MIT
-metadata: {}
+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.8.7
 post_install_message: 
 rdoc_options: []
 require_paths:

data/.github/workflows/ci.yml

@@ -1,66 +0,0 @@
----
-name: CI
-on:
-  push:
-    tags: ['v*']
-    branches: [master]
-  pull_request:
-    branches: ['**']
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        redis: [4]
-        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, 3.0, jruby-9.2.10, truffleruby-20.2.0]
-        include:
-          - redis: 3
-            ruby: 2.7
-    services:
-      redis:
-        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
-        env:
-          REDIS_VERSION: ${{ matrix.redis }}
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-      - run: bundle exec rubocop
-        if: matrix.ruby == '2.7'
-      - run: bin/yardoc --fail-on-warning
-        if: matrix.ruby == '2.7'
-      - run: bin/check-version
-      - 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
-        env:
-          CODACY_PROJECT_TOKEN: ${{ secrets.CODACY_PROJECT_TOKEN }}
-        if: matrix.ruby == '2.7' && env.CODACY_PROJECT_TOKEN
-        uses: codacy/codacy-coverage-reporter-action@master
-        with:
-          project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
-          coverage-reports: coverage/lcov/faulty.lcov
-
-  release:
-    needs: test
-    if: startsWith(github.ref, 'refs/tags/v')
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: dawidd6/action-publish-gem@v1
-        with:
-          api_key: ${{secrets.RUBYGEMS_API_KEY}}

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/Gemfile.lock
-/vendor/
-/.ruby-version
-/*.gem
-
-/coverage/
-/doc/
-/.yardoc/
-
-.byebug_history

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/.rubocop.yml

@@ -1,97 +0,0 @@
----
-require:
-  - rubocop-rspec
-
-AllCops:
-  TargetRubyVersion: 2.3
-
-Layout/ArgumentAlignment:
-  EnforcedStyle: with_fixed_indentation
-
-Layout/CaseIndentation:
-  EnforcedStyle: end
-
-Layout/ParameterAlignment:
-  EnforcedStyle: with_fixed_indentation
-
-Layout/EndAlignment:
-  EnforcedStyleAlignWith: start_of_line
-
-Layout/FirstArgumentIndentation:
-  EnforcedStyle: consistent
-
-Layout/FirstArrayElementIndentation:
-  EnforcedStyle: consistent
-
-Layout/FirstHashElementIndentation:
-  EnforcedStyle: consistent
-
-Layout/LineLength:
-  Max: 120
-
-Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented
-
-Layout/RescueEnsureAlignment:
-  Enabled: false
-
-Lint/RaiseException:
-  Enabled: true
-
-Lint/StructNewOverride:
-  Enabled: true
-
-RSpec/ExampleLength:
-  Enabled: false
-
-RSpec/FilePath:
-  Enabled: false
-
-RSpec/NamedSubject:
-  Enabled: false
-
-RSpec/MessageSpies:
-  Enabled: false
-
-RSpec/MultipleExpectations:
-  Enabled: false
-
-RSpec/SubjectStub:
-  Enabled: false
-
-Metrics/AbcSize:
-  Max: 35
-
-Metrics/BlockLength:
-  Enabled: false
-
-Metrics/MethodLength:
-  Max: 30
-
-Naming/MethodParameterName:
-  MinNameLength: 1
-
-Style/Documentation:
-  Enabled: false
-
-Style/EmptyMethod:
-  EnforcedStyle: expanded
-
-Style/FrozenStringLiteralComment:
-  Enabled: true
-  EnforcedStyle: always
-
-Style/GuardClause:
-  Enabled: false
-
-Style/HashEachMethods:
-  Enabled: true
-
-Style/HashTransformKeys:
-  Enabled: false
-
-Style/HashTransformValues:
-  Enabled: false
-
-Style/IfUnlessModifier:
-  Enabled: false

data/Gemfile

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gemspec
-
-# We add non-essential gems like debugging tools and CI dependencies
-# here. This also allows us to use conditional dependencies that depend on the
-# platform
-
-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
-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'
-# 0.8 is incompatible with simplecov < 0.18
-# https://github.com/fortissimo1997/simplecov-lcov/pull/25
-gem 'simplecov-lcov', '~> 0.7', '< 0.8'
-gem 'yard', '~> 0.9.25', platforms: not_jruby
-
-if ENV['REDIS_VERSION']
-  gem 'redis', "~> #{ENV['REDIS_VERSION']}"
-end

data/bin/benchmark

@@ -1,75 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'benchmark'
-require 'faulty'
-require 'redis'
-require 'json'
-
-n = 100_000
-width = 25
-puts "In memory circuits x#{n}"
-Benchmark.bm(width) do |b|
-  in_memory = Faulty.new(listeners: [])
-  b.report('memory storage') do
-    n.times { in_memory.circuit(:memory).run { true } }
-  end
-
-  b.report('memory storage failures') do
-    n.times do
-      begin
-        in_memory.circuit(:memory_fail, sample_threshold: n + 1).run { raise 'fail' }
-      rescue StandardError
-        # Expected to raise here
-      end
-    end
-  end
-
-  in_memory_large = Faulty.new(listeners: [], storage: Faulty::Storage::Memory.new(max_sample_size: 1000))
-  b.report('large memory storage') do
-    n.times { in_memory_large.circuit(:memory_large).run { true } }
-  end
-end
-
-n = 1000
-puts "\n\Redis circuits x#{n}"
-Benchmark.bm(width) do |b|
-  redis = Faulty.new(listeners: [], storage: Faulty::Storage::Redis.new)
-  b.report('redis storage') do
-    n.times { redis.circuit(:memory).run { true } }
-  end
-
-  b.report('redis storage failures') do
-    n.times do
-      begin
-        redis.circuit(:memory_fail, sample_threshold: n + 1).run { raise 'fail' }
-      rescue StandardError
-        # Expected to raise here
-      end
-    end
-  end
-
-  redis_large = Faulty.new(listeners: [], storage: Faulty::Storage::Redis.new(max_sample_size: 1000))
-  b.report('large redis storage') do
-    n.times { redis_large.circuit(:memory).run { true } }
-  end
-end
-
-n = 1_000_000
-puts "\n\nExtra x#{n}"
-Benchmark.bm(width) do |b|
-  in_memory = Faulty.new(listeners: [])
-
-  log_listener = Faulty::Events::LogListener.new(Logger.new(File::NULL))
-  log_circuit = in_memory.circuit(:log_listener)
-  log_status = log_circuit.status
-  b.report('log listener success') do
-    n.times { log_listener.handle(:circuit_success, circuit: log_circuit, status: log_status) }
-  end
-
-  log_error = StandardError.new('test error')
-  b.report('log listener failure') do
-    n.times { log_listener.handle(:circuit_failure, error: log_error, circuit: log_circuit, status: log_status) }
-  end
-end

data/bin/check-version

@@ -1,14 +0,0 @@
-#!/usr/bin/env sh
-
-set -e
-
-tag="$(git describe --abbrev=0 2>/dev/null || echo)"
-echo "Tag: ${tag}"
-tag="${tag#v}"
-echo "Git Version: ${tag}"
-[ "$tag" = '' ] && exit 0
-gem_version="$(ruby -r ./lib/faulty/version -e "puts Faulty.version" | tail -n1)"
-echo "Gem Version: ${gem_version}"
-
-tag_gt_version="$(ruby -r ./lib/faulty/version -e "puts Faulty.version >= Gem::Version.new('${tag}')" | tail -n1)"
-test "$tag_gt_version" = true