stoplight 3.0.0 → 4.0.0

data/spec/support/light/runnable/run.rb

@@ -0,0 +1,247 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'Stoplight::Light::Runnable#run' do
+  let(:code) { -> { code_result } }
+  let(:code_result) { random_string }
+  let(:fallback) { ->(_) { fallback_result } }
+  let(:fallback_result) { random_string }
+  let(:name) { random_string }
+  let(:notifiers) { [notifier] }
+  let(:notifier) { Stoplight::Notifier::IO.new(io) }
+  let(:io) { StringIO.new }
+
+  before { light.with_notifiers(notifiers) }
+
+  shared_examples 'when the light is green' do
+    before { light.data_store.clear_failures(light) }
+
+    it 'runs the code' do
+      expect(run).to eql(code_result)
+    end
+
+    context 'with some failures' do
+      before { light.data_store.record_failure(light, failure) }
+
+      it 'clears the failures' do
+        run
+        expect(light.data_store.get_failures(light).size).to eql(0)
+      end
+    end
+
+    context 'when the code is failing' do
+      let(:code_result) { raise error }
+
+      it 're-raises the error' do
+        expect { run }.to raise_error(error.class)
+      end
+
+      it 'records the failure' do
+        expect(light.data_store.get_failures(light).size).to eql(0)
+        begin
+          run
+        rescue error.class
+          nil
+        end
+        expect(light.data_store.get_failures(light).size).to eql(1)
+      end
+
+      context 'when we did not send notifications yet' do
+        it 'notifies when transitioning to red' do
+          light.threshold.times do
+            expect(io.string).to eql('')
+            begin
+              run
+            rescue error.class
+              nil
+            end
+          end
+          expect(io.string).to_not eql('')
+        end
+      end
+
+      context 'when we already sent notifications' do
+        before do
+          light.data_store.with_notification_lock(light, Stoplight::Color::GREEN, Stoplight::Color::RED) {}
+        end
+
+        it 'does not send new notifications' do
+          light.threshold.times do
+            expect(io.string).to eql('')
+            begin
+              run
+            rescue error.class
+              nil
+            end
+          end
+          expect(io.string).to eql('')
+        end
+      end
+
+      it 'notifies when transitioning to red' do
+        light.threshold.times do
+          expect(io.string).to eql('')
+          begin
+            run
+          rescue error.class
+            nil
+          end
+        end
+        expect(io.string).to_not eql('')
+      end
+
+      context 'with an error handler' do
+        let(:result) do
+          run
+          expect(false).to be(true)
+        rescue error.class
+          expect(true).to be(true)
+        end
+
+        it 'records the failure when the handler does nothing' do
+          light.with_error_handler { |_error, _handler| }
+          expect { result }
+            .to change { light.data_store.get_failures(light).size }
+            .by(1)
+        end
+
+        it 'records the failure when the handler calls handle' do
+          light.with_error_handler { |error, handle| handle.call(error) }
+          expect { result }
+            .to change { light.data_store.get_failures(light).size }
+            .by(1)
+        end
+
+        it 'does not record the failure when the handler raises' do
+          light.with_error_handler { |error, _handle| raise error }
+          expect { result }
+            .to_not change { light.data_store.get_failures(light).size }
+        end
+      end
+
+      context 'with a fallback' do
+        before { light.with_fallback(&fallback) }
+
+        it 'runs the fallback' do
+          expect(run).to eql(fallback_result)
+        end
+
+        it 'passes the error to the fallback' do
+          light.with_fallback do |e|
+            expect(e).to eql(error)
+            fallback_result
+          end
+          expect(run).to eql(fallback_result)
+        end
+      end
+    end
+
+    context 'when the data store is failing' do
+      let(:error_notifier) { ->(_) {} }
+      let(:error) { StandardError.new('something went wrong') }
+
+      before do
+        expect(data_store).to receive(:clear_failures) { raise error }
+
+        light.with_error_notifier(&error_notifier)
+      end
+
+      it 'runs the code' do
+        expect(run).to eql(code_result)
+      end
+
+      it 'notifies about the error' do
+        has_notified = false
+        light.with_error_notifier do |e|
+          has_notified = true
+          expect(e).to eq(error)
+        end
+        run
+        expect(has_notified).to eql(true)
+      end
+    end
+  end
+
+  shared_examples 'when the light is yellow' do
+    let(:failure) { Stoplight::Failure.new(error.class.name, error.message, Time.new - light.cool_off_time) }
+    let(:failure2) { Stoplight::Failure.new(error.class.name, error.message, Time.new - light.cool_off_time - 10) }
+
+    before do
+      light.with_threshold(2)
+      light.data_store.record_failure(light, failure2)
+      light.data_store.record_failure(light, failure)
+    end
+
+    it 'runs the code' do
+      expect(run).to eql(code_result)
+    end
+
+    it 'notifies when transitioning to green' do
+      expect { run }
+        .to change(io, :string)
+        .from(be_empty)
+        .to(/Switching \w+ from red to green/)
+    end
+  end
+
+  shared_examples 'when the light is red' do
+    let(:other) do
+      Stoplight::Failure.new(error.class.name, error.message, Time.new - light.cool_off_time)
+    end
+
+    before do
+      light.with_threshold(2)
+      light.data_store.record_failure(light, other)
+      light.data_store.record_failure(light, failure)
+    end
+
+    it 'raises an error' do
+      expect { run }.to raise_error(Stoplight::Error::RedLight)
+    end
+
+    it 'uses the name as the error message' do
+      expect do
+        run
+      end.to raise_error(Stoplight::Error::RedLight, light.name)
+    end
+
+    context 'with a fallback' do
+      before { light.with_fallback(&fallback) }
+
+      it 'runs the fallback' do
+        expect(run).to eql(fallback_result)
+      end
+
+      it 'does not pass anything to the fallback' do
+        light.with_fallback do |e|
+          expect(e).to eql(nil)
+          fallback_result
+        end
+        expect(run).to eql(fallback_result)
+      end
+    end
+  end
+
+  context 'with code block' do
+    subject(:light) { Stoplight::Light.new(name) }
+
+    def run
+      light.run(&code)
+    end
+
+    it_behaves_like 'when the light is green'
+    it_behaves_like 'when the light is yellow'
+    it_behaves_like 'when the light is red'
+  end
+
+  context 'without code block' do
+    subject(:light) { Stoplight::Light.new(name, &code) }
+
+    def run
+      light.run
+    end
+
+    it_behaves_like 'when the light is green'
+    it_behaves_like 'when the light is yellow'
+    it_behaves_like 'when the light is red'
+  end
+end

data/spec/support/light/runnable.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'runnable/color'
+require_relative 'runnable/run'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stoplight
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Cameron Desautels
@@ -10,218 +10,22 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-23 00:00:00.000000000 Z
+date: 2023-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: benchmark-ips
+  name: redlock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :development
+        version: '1.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
-- !ruby/object:Gem::Dependency
-  name: bugsnag
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: fakeredis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-- !ruby/object:Gem::Dependency
-  name: hipchat
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: honeybadger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
-- !ruby/object:Gem::Dependency
-  name: pagerduty
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.1.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.1.1
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: redis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: sentry-raven
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.21'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.21'
-- !ruby/object:Gem::Dependency
-  name: simplecov-lcov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: slack-notifier
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.0'
 description: An implementation of the circuit breaker pattern.
 email:
 - camdez@gmail.com
@@ -235,7 +39,11 @@ files:
 - LICENSE.md
 - README.md
 - lib/stoplight.rb
+- lib/stoplight/builder.rb
+- lib/stoplight/circuit_breaker.rb
 - lib/stoplight/color.rb
+- lib/stoplight/configurable.rb
+- lib/stoplight/configuration.rb
 - lib/stoplight/data_store.rb
 - lib/stoplight/data_store/base.rb
 - lib/stoplight/data_store/memory.rb
@@ -244,23 +52,23 @@ files:
 - lib/stoplight/error.rb
 - lib/stoplight/failure.rb
 - lib/stoplight/light.rb
+- lib/stoplight/light/deprecated.rb
+- lib/stoplight/light/lockable.rb
 - lib/stoplight/light/runnable.rb
 - lib/stoplight/notifier.rb
 - lib/stoplight/notifier/base.rb
-- lib/stoplight/notifier/bugsnag.rb
 - lib/stoplight/notifier/generic.rb
-- lib/stoplight/notifier/hip_chat.rb
-- lib/stoplight/notifier/honeybadger.rb
 - lib/stoplight/notifier/io.rb
 - lib/stoplight/notifier/logger.rb
-- lib/stoplight/notifier/pagerduty.rb
-- lib/stoplight/notifier/raven.rb
-- lib/stoplight/notifier/rollbar.rb
-- lib/stoplight/notifier/slack.rb
+- lib/stoplight/rspec.rb
+- lib/stoplight/rspec/generic_notifier.rb
 - lib/stoplight/state.rb
 - lib/stoplight/version.rb
 - spec/spec_helper.rb
+- spec/stoplight/builder_spec.rb
+- spec/stoplight/circuit_breaker_spec.rb
 - spec/stoplight/color_spec.rb
+- spec/stoplight/configurable_spec.rb
 - spec/stoplight/data_store/base_spec.rb
 - spec/stoplight/data_store/memory_spec.rb
 - spec/stoplight/data_store/redis_spec.rb
@@ -268,23 +76,33 @@ files:
 - spec/stoplight/default_spec.rb
 - spec/stoplight/error_spec.rb
 - spec/stoplight/failure_spec.rb
+- spec/stoplight/light/lockable_spec.rb
 - spec/stoplight/light/runnable_spec.rb
 - spec/stoplight/light_spec.rb
 - spec/stoplight/notifier/base_spec.rb
-- spec/stoplight/notifier/bugsnag_spec.rb
 - spec/stoplight/notifier/generic_spec.rb
-- spec/stoplight/notifier/hip_chat_spec.rb
-- spec/stoplight/notifier/honeybadger_spec.rb
 - spec/stoplight/notifier/io_spec.rb
 - spec/stoplight/notifier/logger_spec.rb
-- spec/stoplight/notifier/pagerduty_spec.rb
-- spec/stoplight/notifier/raven_spec.rb
-- spec/stoplight/notifier/rollbar_spec.rb
-- spec/stoplight/notifier/slack_spec.rb
 - spec/stoplight/notifier_spec.rb
 - spec/stoplight/state_spec.rb
 - spec/stoplight/version_spec.rb
 - spec/stoplight_spec.rb
+- spec/support/configurable.rb
+- spec/support/data_store/base.rb
+- spec/support/data_store/base/clear_failures.rb
+- spec/support/data_store/base/clear_state.rb
+- spec/support/data_store/base/get_all.rb
+- spec/support/data_store/base/get_failures.rb
+- spec/support/data_store/base/get_state.rb
+- spec/support/data_store/base/names.rb
+- spec/support/data_store/base/record_failures.rb
+- spec/support/data_store/base/set_state.rb
+- spec/support/data_store/base/with_notification_lock.rb
+- spec/support/database_cleaner.rb
+- spec/support/exception_helpers.rb
+- spec/support/light/runnable.rb
+- spec/support/light/runnable/color.rb
+- spec/support/light/runnable/run.rb
 homepage: https://github.com/bolshakov/stoplight
 licenses:
 - MIT
@@ -297,20 +115,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: 3.0.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Traffic control for code.
 test_files:
 - spec/spec_helper.rb
+- spec/stoplight/builder_spec.rb
+- spec/stoplight/circuit_breaker_spec.rb
 - spec/stoplight/color_spec.rb
+- spec/stoplight/configurable_spec.rb
 - spec/stoplight/data_store/base_spec.rb
 - spec/stoplight/data_store/memory_spec.rb
 - spec/stoplight/data_store/redis_spec.rb
@@ -318,20 +139,30 @@ test_files:
 - spec/stoplight/default_spec.rb
 - spec/stoplight/error_spec.rb
 - spec/stoplight/failure_spec.rb
+- spec/stoplight/light/lockable_spec.rb
 - spec/stoplight/light/runnable_spec.rb
 - spec/stoplight/light_spec.rb
 - spec/stoplight/notifier/base_spec.rb
-- spec/stoplight/notifier/bugsnag_spec.rb
 - spec/stoplight/notifier/generic_spec.rb
-- spec/stoplight/notifier/hip_chat_spec.rb
-- spec/stoplight/notifier/honeybadger_spec.rb
 - spec/stoplight/notifier/io_spec.rb
 - spec/stoplight/notifier/logger_spec.rb
-- spec/stoplight/notifier/pagerduty_spec.rb
-- spec/stoplight/notifier/raven_spec.rb
-- spec/stoplight/notifier/rollbar_spec.rb
-- spec/stoplight/notifier/slack_spec.rb
 - spec/stoplight/notifier_spec.rb
 - spec/stoplight/state_spec.rb
 - spec/stoplight/version_spec.rb
 - spec/stoplight_spec.rb
+- spec/support/configurable.rb
+- spec/support/data_store/base/clear_failures.rb
+- spec/support/data_store/base/clear_state.rb
+- spec/support/data_store/base/get_all.rb
+- spec/support/data_store/base/get_failures.rb
+- spec/support/data_store/base/get_state.rb
+- spec/support/data_store/base/names.rb
+- spec/support/data_store/base/record_failures.rb
+- spec/support/data_store/base/set_state.rb
+- spec/support/data_store/base/with_notification_lock.rb
+- spec/support/data_store/base.rb
+- spec/support/database_cleaner.rb
+- spec/support/exception_helpers.rb
+- spec/support/light/runnable/color.rb
+- spec/support/light/runnable/run.rb
+- spec/support/light/runnable.rb

data/lib/stoplight/notifier/bugsnag.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module Stoplight
-  module Notifier
-    # @see Base
-    class Bugsnag < Base
-      DEFAULT_OPTIONS = {
-        severity: 'info'
-      }.freeze
-
-      StoplightStatusChange = Class.new(Error::Base)
-
-      # @return [Proc]
-      attr_reader :formatter
-      # @return [::Bugsnag]
-      attr_reader :bugsnag
-      # @return [Hash{Symbol => Object}]
-      attr_reader :options
-
-      # @param bugsnag [::Bugsnag]
-      # @param formatter [Proc, nil]
-      # @param options [Hash{Symbol => Object}]
-      # @option options [String] :severity
-      def initialize(bugsnag, formatter = nil, options = {})
-        @bugsnag = bugsnag
-        @formatter = formatter || Default::FORMATTER
-        @options = DEFAULT_OPTIONS.merge(options)
-      end
-
-      def notify(light, from_color, to_color, error)
-        message = formatter.call(light, from_color, to_color, error)
-        bugsnag.notify(StoplightStatusChange.new(message), options)
-        message
-      end
-    end
-  end
-end