shift-circuit-breaker 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6535db8c80cfc5b58b0741994700a0921d3c8966
-  data.tar.gz: 9b10e2822b263229c819e4e00898853242dcf3f0
+SHA256:
+  metadata.gz: bda401bde485debfe14c8dfd0ce54701967e877d2e4839a54b268ed85980daef
+  data.tar.gz: a4f3eb047181e8a48c43de680d27098d90c3c6862cece5664f5e4ae5d3c7a836
 SHA512:
-  metadata.gz: 5310e8cdfb5c8951fb70fe41059befa851b76d9d70c838b7d10abdb03616008bb2b1f728fa5ea02351c0365d52fea1d5ed7751c495d3af4bba7fb0d1f9beb091
-  data.tar.gz: 681d7e60c9139f48e5abcabf6413e08f202224dfe4c7a9e7b7ec6a22690036b81ca33f60fe779acac334e533ada5fcf0b01676f3f316072a6da5bcd35ff513de
+  metadata.gz: ea8da391a6b84eefb37961224417ba54bb7fc967d1e8b9a8178fcaee75ad4a89b75e2f0d7820031f74cedb89aa7f73de2533470b629b4bd898bc7093dd9dfa6c
+  data.tar.gz: 51d1f97c57448055dca2222c0e1d98909bf15903503811b96ca14b4f1b6b7b2a562891d65445e0a0c890bfcacaf84ccf73cfbb5db516c73b9e263360accf55f7

data/.codeclimate.yml

@@ -7,5 +7,8 @@ plugins:
       - ruby
   reek:
     enabled: true
+    checks:
+      Attribute:
+        enabled: false
   rubocop:
     enabled: true

data/lib/shift/circuit_breaker.rb

@@ -27,6 +27,7 @@ module Shift
   #   CIRCUIT_BREAKER = Shift::CircuitBreaker.new(:an_identifier_for_the_circuit,
   #                                               error_threshold: 10,
   #                                               skip_duration: 60,
+  #                                               log_errors: true,
   #                                               additional_exception_classes: [Faraday::ClientError]
   #                                             )
   #

data/lib/shift/circuit_breaker/circuit_handler.rb

@@ -13,9 +13,11 @@ module Shift
     # the defined skip_duration, ie. no operations are executed and the provided fallback is called.
     #
     class CircuitHandler
-      attr_accessor :name, :error_threshold, :skip_duration, :exception_classes, :error_count, :last_error_time, :state, :logger, :monitor
+      attr_accessor :name, :error_threshold, :skip_duration, :exception_classes, :error_logging_enabled, :error_count
+      attr_accessor :last_error_time, :state, :logger, :monitor
 
       DEFAULT_EXCEPTION_CLASSES = [Net::OpenTimeout, Net::ReadTimeout, Faraday::TimeoutError, Timeout::Error].freeze
+      DEFAULT_ERROR_LOGGING_STATE = true
 
       # Initializer creates an instance of the service
       #
@@ -23,24 +25,27 @@ module Shift
       # @param [Integer] error_threshold   - The minimum error threshold required for the circuit to be opened/tripped
       # @param [Integer] skip_duration     - The duration in seconds the circuit should be open for before operations are allowed through/executed
       # @param [Array]   additional_exception_classes - Any additional exception classes to rescue along the DEFAULT_EXCEPTION_CLASSES
+      # @param [Boolean] error_logging_enabled         - Decided whether to log errors or not. Still they will be monitored
       # @param [Object]  logger            - service to handle error logging
       # @param [Object]  monitor           - service to monitor metric
       def initialize(name,
                      error_threshold:,
                      skip_duration:,
                      additional_exception_classes: [],
+                     error_logging_enabled: DEFAULT_ERROR_LOGGING_STATE,
                      logger: Shift::CircuitBreaker::CircuitLogger.new,
                      monitor: Shift::CircuitBreaker::CircuitMonitor.new)
 
-        self.name               = name
-        self.error_threshold    = error_threshold
-        self.skip_duration      = skip_duration
-        self.exception_classes  = (additional_exception_classes | DEFAULT_EXCEPTION_CLASSES)
-        self.logger             = logger
-        self.monitor            = monitor
-        self.error_count        = 0
-        self.last_error_time    = nil
-        self.state              = :closed
+        self.name                 = name
+        self.error_threshold      = error_threshold
+        self.skip_duration        = skip_duration
+        self.error_logging_enabled = error_logging_enabled
+        self.exception_classes    = (additional_exception_classes | DEFAULT_EXCEPTION_CLASSES)
+        self.logger               = logger
+        self.monitor              = monitor
+        self.error_count          = 0
+        self.last_error_time      = nil
+        self.state                = :closed
       end
 
       # Performs the given operation within the circuit
@@ -98,10 +103,14 @@ module Shift
       def handle_exception(exception, fallback)
         record_error
         set_state
+        log_errors(exception)
         monitor.record_metric(name, state)
-        logger.error(circuit_name: name, state: state, error_message: exception.message)
         fallback.call
       end
+
+      def log_errors(exception)
+        logger.error(circuit_name: name, state: state, error_message: exception.message) if error_logging_enabled
+      end
     end
   end
 end

data/lib/shift/circuit_breaker/version.rb

@@ -2,6 +2,6 @@
 
 module Shift
   module CircuitBreaker
-    VERSION = "0.2.1"
+    VERSION = "0.2.2"
   end
 end

data/spec/shift/circuit_breaker/circuit_handler_exception_handling_spec.rb

@@ -137,6 +137,55 @@ module Shift
           end
         end
       end
+
+      context "Error Logging" do
+        let(:default_error_threshold) { 5 }
+        let(:default_skip_duration)   { 6 }
+
+        context "when it is enabled" do
+          it "should log errors" do
+            # Arrange
+            operation_stub  = instance_double("Operation")
+            fallback_stub   = instance_double("Fallback")
+            error_logger    = instance_double("Error")
+
+            allow(operation_stub).to receive(:perform_task).and_raise(Timeout::Error, "Request Timeout")
+            allow(error_logger).to receive(:error).and_return({})
+            # Act
+            cb = described_class.new(:test_circuit_breaker, error_threshold: default_error_threshold, skip_duration: default_skip_duration, logger: error_logger)
+            operation_result = cb.call(operation: -> { operation_stub.perform_task }, fallback: -> { fallback_stub })
+
+            # Assert
+            aggregate_failures do
+              expect(operation_result).to eq(fallback_stub)
+              expect(cb.error_count).to eq(1)
+              expect(error_logger).to have_received(:error)
+            end
+          end
+        end
+
+        context "when it is disabled" do
+          it "should not log errors" do
+            # Arrange
+            operation_stub  = instance_double("Operation")
+            fallback_stub   = instance_double("Fallback")
+            error_logger    = instance_double("Error")
+
+            allow(operation_stub).to receive(:perform_task).and_raise(Timeout::Error, "Request Timeout")
+            allow(error_logger).to receive(:error).and_return({})
+            # Act
+            cb = described_class.new(:test_circuit_breaker, error_threshold: default_error_threshold, skip_duration: default_skip_duration, error_logging_enabled: false, logger: error_logger)
+            operation_result = cb.call(operation: -> { operation_stub.perform_task }, fallback: -> { fallback_stub })
+
+            # Assert
+            aggregate_failures do
+              expect(operation_result).to eq(fallback_stub)
+              expect(cb.error_count).to eq(1)
+              expect(error_logger).not_to have_received(:error)
+            end
+          end
+        end
+      end
     end
   end
 end

data/spec/shift/circuit_breaker/circuit_handler_monitoring_spec.rb

@@ -20,7 +20,7 @@ module Shift
             operation_stub        = instance_double("Operation")
             fallback_stub         = instance_double("Fallback")
             expected_result_stub  = instance_double("ExpectedResult")
-bb
+
             allow(monitor_stub).to receive(:record_metric)
             allow(operation_stub).to receive(:perform_task).and_return(expected_result_stub)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shift-circuit-breaker
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Mufudzi Masaire
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-22 00:00:00.000000000 Z
+date: 2018-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -223,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A generic implementation of the Circuit Breaker pattern in Ruby