shift-circuit-breaker 0.2.0

data/spec/shift/circuit_breaker/circuit_logger_spec.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Shift
+  module CircuitBreaker
+    describe CircuitLogger do
+      before do
+        allow($stdout).to receive(:write)
+      end
+
+      context "#error" do
+        it "logs the given error message" do
+          # Arrange
+          context         = { circuit_name: :test_circuit_breaker, error_message: "timeout", state: :open }
+          error_message   = (described_class::ERROR_MESSAGE % context)
+          logger_instance = ::Logger.new(STDOUT)
+          logger          = described_class.new(logger: logger_instance)
+
+          allow(logger_instance).to receive(:error)
+
+          # Act
+          logger.error(context)
+
+          # Assert
+          expect(logger_instance).to have_received(:error).with(include(error_message))
+        end
+
+        it "logs the given error message using the provided remote_logger" do
+          # Arrange
+          context       = { circuit_name: :test_circuit_breaker, error_message: "timeout", state: :open }
+          error_message = (described_class::ERROR_MESSAGE % context)
+          remote_logger = Shift::CircuitBreaker::Adapters::SentryAdapter
+          logger        = described_class.new(remote_logger: remote_logger)
+
+          allow(remote_logger).to receive(:call)
+
+          # Act
+          logger.error(context)
+
+          # Assert
+          aggregate_failures do
+            expect(logger.remote_logger).to eq(remote_logger)
+            expect(remote_logger).to have_received(:call).with(include(error_message))
+          end
+        end
+      end
+
+      context "#info" do
+        it "logs the given input" do
+          # Arrange
+          message         = "some message"
+          logger_instance = ::Logger.new(STDOUT)
+          logger          = described_class.new(logger: logger_instance)
+
+          allow(logger_instance).to receive(:info)
+
+          # Act
+          logger.info(message)
+
+          # Assert
+          expect(logger_instance).to have_received(:info).with(include(message))
+        end
+      end
+    end
+  end
+end

data/spec/shift/circuit_breaker/circuit_monitor_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Shift
+  module CircuitBreaker
+    describe CircuitMonitor do
+      before do
+        allow($stdout).to receive(:write)
+      end
+
+      context "#record_metric" do
+        it "logs the metric information" do
+          # Arrange
+          circuit_breaker_name  = :test_circuit_breaker
+          circuit_breaker_state = :open
+          metric                = "Custom/#{circuit_breaker_name.to_s.classify}CircuitBreaker/#{circuit_breaker_state.to_s.classify}"
+          logger_instance       = ::Logger.new(STDOUT)
+          circuit_monitor       = described_class.new(logger: logger_instance)
+
+          allow(logger_instance).to receive(:info)
+
+          # Act
+          circuit_monitor.record_metric(circuit_breaker_name, circuit_breaker_state)
+
+          # Assert
+          expect(logger_instance).to have_received(:info).with(include(metric))
+        end
+
+        it "logs the metric information using the provided monitor" do
+          # Arrange
+          circuit_breaker_name  = :test_circuit_breaker
+          circuit_breaker_state = :open
+          metric                = "Custom/#{circuit_breaker_name.to_s.classify}CircuitBreaker/#{circuit_breaker_state.to_s.classify}"
+          metric_monitor        = Shift::CircuitBreaker::Adapters::NewRelicAdapter
+          circuit_monitor       = described_class.new(monitor: metric_monitor)
+
+          allow(metric_monitor).to receive(:call)
+
+          # Act
+          circuit_monitor.record_metric(circuit_breaker_name, circuit_breaker_state)
+
+          # Assert
+          aggregate_failures do
+            expect(circuit_monitor.monitor).to eq(metric_monitor)
+            expect(metric_monitor).to have_received(:call).with(metric)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/shift/circuit_breaker_spec.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Shift
+  describe CircuitBreaker do
+    before do
+      allow($stdout).to receive(:write)
+    end
+
+    context "Configuration" do
+      it "correctly assigns the configuration keys" do
+        # Arrange
+        dummy_new_relic_license_key = SecureRandom.hex(10)
+        dummy_new_relic_app_name    = "Test App"
+        dummy_sentry_dsn            = SecureRandom.hex(10)
+        dummy_sentry_environments   = %w[production]
+
+        # Act
+        Shift::CircuitBreaker.configure do |config|
+          config.new_relic_license_key  = dummy_new_relic_license_key
+          config.new_relic_app_name     = dummy_new_relic_app_name
+          config.sentry_dsn             = dummy_sentry_dsn
+          config.sentry_environments    = dummy_sentry_environments
+        end
+
+        config = Shift::CircuitBreaker.config
+
+        # Assert
+        aggregate_failures do
+          expect(config.new_relic_license_key).to eq(dummy_new_relic_license_key)
+          expect(config.new_relic_app_name).to eq(dummy_new_relic_app_name)
+          expect(config.sentry_dsn).to eq(dummy_sentry_dsn)
+          expect(config.sentry_environments).to include("production")
+        end
+      end
+    end
+
+    context "Instantiation" do
+      it "creates an instance of the circuit breaker" do
+        # Arrange
+        cb_name                       = :test_circuit
+        error_threshold               = 10
+        skip_duration                 = 60
+        additional_exception_classes  = [Faraday::ClientError]
+        logger_stub                   = instance_double("CustomLogger")
+        monitor_stub                  = instance_double("CustomMonitor")
+
+        # Act
+        cb_instance = Shift::CircuitBreaker.new(cb_name,
+                                                error_threshold: error_threshold,
+                                                skip_duration: skip_duration,
+                                                additional_exception_classes: additional_exception_classes,
+                                                logger: logger_stub,
+                                                monitor: monitor_stub)
+
+        # Assert
+        aggregate_failures do
+          expect(described_class).to be_a(Module)
+          expect(cb_instance).to be_a(Shift::CircuitBreaker::CircuitHandler)
+          expect(cb_instance.name).to eq(cb_name)
+          expect(cb_instance.error_threshold).to eq(error_threshold)
+          expect(cb_instance.skip_duration).to eq(skip_duration)
+          expect(cb_instance.exception_classes).to include(Faraday::ClientError)
+          expect(cb_instance.logger).to eq(logger_stub)
+          expect(cb_instance.monitor).to eq(monitor_stub)
+          expect(cb_instance.error_count).to eq(0)
+          expect(cb_instance.state).to eq(:closed)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/numeric/time"
+require "rspec"
+require "pry"
+require "securerandom"
+require "shift/circuit_breaker"
+require "timecop"
+
+ENV["RACK_ENV"] ||= "test"
+
+Timecop.safe_mode = true
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+    expectations.on_potential_false_positives = :nothing
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end

metadata

@@ -0,0 +1,230 @@
+--- !ruby/object:Gem::Specification
+name: shift-circuit-breaker
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Mufudzi Masaire
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: newrelic_rpm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.8.0.341
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.8.0.341
+- !ruby/object:Gem::Dependency
+  name: sentry-raven
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description: |2
+      The library provides a mechanism for detecting, monitoring and controlling external service calls that will
+      most-likely fail at some point (e.g. timeout) and cause request queuing, thus preventing cascading system failures.
+email: mufudzi.masaire@shiftcommerce.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".reek"
+- ".rspec"
+- ".rubocop.yml"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/newrelic.yml
+- config/rubocop/.layout_rubocop.yml
+- config/rubocop/.lint_rubocop.yml
+- config/rubocop/.metrics_rubocop.yml
+- config/rubocop/.naming_rubocop.yml
+- config/rubocop/.performance_rubocop.yml
+- config/rubocop/.style_rubocop.yml
+- lib/shift/circuit_breaker.rb
+- lib/shift/circuit_breaker/adapters/base_adapter.rb
+- lib/shift/circuit_breaker/adapters/newrelic_adapter.rb
+- lib/shift/circuit_breaker/adapters/sentry_adapter.rb
+- lib/shift/circuit_breaker/circuit_handler.rb
+- lib/shift/circuit_breaker/circuit_logger.rb
+- lib/shift/circuit_breaker/circuit_monitor.rb
+- lib/shift/circuit_breaker/config.rb
+- lib/shift/circuit_breaker/version.rb
+- shift-circuit-breaker.gemspec
+- spec/shift/adapters/base_adapter_spec.rb
+- spec/shift/adapters/newrelic_adapter_spec.rb
+- spec/shift/adapters/sentry_adapter_spec.rb
+- spec/shift/circuit_breaker/circuit_handler_exception_handling_spec.rb
+- spec/shift/circuit_breaker/circuit_handler_monitoring_spec.rb
+- spec/shift/circuit_breaker/circuit_handler_spec.rb
+- spec/shift/circuit_breaker/circuit_logger_spec.rb
+- spec/shift/circuit_breaker/circuit_monitor_spec.rb
+- spec/shift/circuit_breaker_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/shiftcommerce/shift-circuit-breaker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A generic implementation of the Circuit Breaker pattern in Ruby
+test_files: []