stoplight 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f7c163955f261ad3eeca89a851a06a15f5734d78d045695297f29c143532a58
-  data.tar.gz: 9ff3e5911bf7e9f198c714ce1eb0f10c6ba09834e96a8c8c2d16dd3e184ed0ce
+  metadata.gz: 4ec8f5b8b13778f792ad1fbbbc3138229ef51ac4e62149f93eb3a8b4bccc9d3a
+  data.tar.gz: d93e27dbf0563bb30a7025bf646befe712269c4bd5f259432ffeeb8c680934da
 SHA512:
-  metadata.gz: 5e42cd0050cdbf9440e80d68d70091e6c22c574c64cf06a29aa9dca320f5f4915dca48e5582ebf18db757fde4ad295c20af05bc6a879695d726afa65ff50dea8
-  data.tar.gz: a5088d9ba81a5578cbc078d0671c601fd13738f07f6a67dd12936df3e8a7927053314538d50c1e65ce6913607e9764ff09d6c05f931c4be8984e2e6744399288
+  metadata.gz: c3c10ff2886343b2625c777c5143656624df7591ab75e3bb8c8c43032fc10a92dacd9f2a801eebd7c636c5adc5a744525be76cb22f4acb4f839f6a87a6f8608b
+  data.tar.gz: 28af6a4a57af91a6d21df0b79909a4584acca9e5028079aff313911a965d3cb1da36b3a0b9c934b8621b6bd372e84da34d1fa47b47c043c10e27bb99a885c6f9

data/README.md

@@ -28,7 +28,6 @@ Check out [stoplight-admin][] for controlling your stoplights.
     - [Redis](#redis)
   - [Notifiers](#notifiers)
     - [Bugsnag](#bugsnag)
-    - [HipChat](#hipchat)
     - [Honeybadger](#honeybadger)
     - [Logger](#logger)
     - [Pagerduty](#pagerduty)
@@ -311,22 +310,6 @@ Stoplight::Light.default_notifiers += [notifier]
 # => [#<Stoplight::Notifier::IO:...>, #<Stoplight::Notifier::Bugsnag:...>]
 ```
 
-#### HipChat
-
-Make sure you have [the HipChat gem][] (`~> 1.5`) installed before configuring
-Stoplight.
-
-``` rb
-require 'hipchat'
-# => true
-hip_chat = HipChat::Client.new('token')
-# => #<HipChat::Client:...>
-notifier = Stoplight::Notifier::HipChat.new(hip_chat, 'room')
-# => #<Stoplight::Notifier::HipChat:...>
-Stoplight::Light.default_notifiers += [notifier]
-# => [#<Stoplight::Notifier::IO:...>, #<Stoplight::Notifier::HipChat:...>]
-```
-
 #### Honeybadger
 
 Make sure you have [the Honeybadger gem][] (`~> 2.5`) installed before
@@ -516,7 +499,6 @@ Stoplight is licensed under [the MIT License][].
 [the cool off time section]: #custom-cool-off-time
 [the Redis gem]: https://rubygems.org/gems/redis
 [the Bugsnag gem]: https://rubygems.org/gems/bugsnag
-[the HipChat gem]: https://rubygems.org/gems/hipchat
 [the Honeybadger gem]: https://rubygems.org/gems/honeybadger
 [the Logger class]: http://ruby-doc.org/stdlib-2.2.3/libdoc/logger/rdoc/Logger.html
 [the Rollbar gem]: https://rubygems.org/gems/rollbar

data/lib/stoplight/data_store/base.rb

@@ -52,6 +52,15 @@ module Stoplight
       def clear_state(_light)
         raise NotImplementedError
       end
+
+      # @param _light [Light]
+      # @param _from_color [String]
+      # @param _to_color [String]
+      # @yield _block
+      # @return [Void]
+      def with_notification_lock(_light, _from_color, _to_color, &_block)
+        raise NotImplementedError
+      end
     end
   end
 end

data/lib/stoplight/data_store/memory.rb

@@ -7,10 +7,12 @@ module Stoplight
     # @see Base
     class Memory < Base
       include MonitorMixin
+      KEY_SEPARATOR = ':'
 
       def initialize
         @failures = Hash.new { |h, k| h[k] = [] }
         @states = Hash.new { |h, k| h[k] = State::UNLOCKED }
+        @last_notifications = {}
         super() # MonitorMixin
       end
 
@@ -49,6 +51,30 @@ module Stoplight
       def clear_state(light)
         synchronize { @states.delete(light.name) }
       end
+
+      def with_notification_lock(light, from_color, to_color)
+        synchronize do
+          if last_notification(light) != [from_color, to_color]
+            set_last_notification(light, from_color, to_color)
+
+            yield
+          end
+        end
+      end
+
+      # @param light [Stoplight::Light]
+      # @return [Array, nil]
+      def last_notification(light)
+        @last_notifications[light.name]
+      end
+
+      # @param light [Stoplight::Light]
+      # @param from_color [String]
+      # @param to_color [String]
+      # @return [void]
+      def set_last_notification(light, from_color, to_color)
+        @last_notifications[light.name] = [from_color, to_color]
+      end
     end
   end
 end

data/lib/stoplight/data_store/redis.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'redlock'
+
 module Stoplight
   module DataStore
     # @see Base
@@ -8,8 +10,9 @@ module Stoplight
       KEY_SEPARATOR = ':'
 
       # @param redis [::Redis]
-      def initialize(redis)
+      def initialize(redis, redlock: Redlock::Client.new([redis]))
         @redis = redis
+        @redlock = redlock
       end
 
       def names
@@ -76,8 +79,34 @@ module Stoplight
         normalize_state(state)
       end
 
+      LOCK_TTL = 2_000 # milliseconds
+
+      def with_notification_lock(light, from_color, to_color)
+        @redlock.lock(notification_lock_key(light), LOCK_TTL) do
+          if last_notification(light) != [from_color, to_color]
+            set_last_notification(light, from_color, to_color)
+
+            yield
+          end
+        end
+      end
+
       private
 
+      # @param light [Stoplight::Light]
+      # @return [Array, nil]
+      def last_notification(light)
+        @redis.get(last_notification_key(light))&.split('->')
+      end
+
+      # @param light [Stoplight::Light]
+      # @param from_color [String]
+      # @param to_color [String]
+      # @return [void]
+      def set_last_notification(light, from_color, to_color)
+        @redis.set(last_notification_key(light), [from_color, to_color].join('->'))
+      end
+
       def query_failures(light, transaction: @redis)
         transaction.lrange(failures_key(light), 0, -1)
       end
@@ -103,6 +132,14 @@ module Stoplight
         key('failures', light.name)
       end
 
+      def notification_lock_key(light)
+        key('notification_lock', light.name)
+      end
+
+      def last_notification_key(light)
+        key('last_notification', light.name)
+      end
+
       def states_key
         key('states')
       end

data/lib/stoplight/light/runnable.rb

@@ -30,11 +30,15 @@ module Stoplight
 
       def run_green
         on_failure = lambda do |size, error|
-          notify(Color::GREEN, Color::RED, error) if size == threshold
+          notify(Color::GREEN, Color::RED, error) if failures_threshold_breached?(size, threshold)
         end
         run_code(nil, on_failure)
       end
 
+      def failures_threshold_breached?(current_failures_count, max_errors_threshold)
+        current_failures_count == max_errors_threshold
+      end
+
       def run_yellow
         on_success = lambda do |failures|
           notify(Color::RED, Color::GREEN) unless failures.empty?
@@ -75,8 +79,10 @@ module Stoplight
       end
 
       def notify(from_color, to_color, error = nil)
-        notifiers.each do |notifier|
-          safely { notifier.notify(self, from_color, to_color, error) }
+        data_store.with_notification_lock(self, from_color, to_color) do
+          notifiers.each do |notifier|
+            safely { notifier.notify(self, from_color, to_color, error) }
+          end
         end
       end
 

data/lib/stoplight/notifier/bugsnag.rb

@@ -29,7 +29,7 @@ module Stoplight
 
       def notify(light, from_color, to_color, error)
         message = formatter.call(light, from_color, to_color, error)
-        bugsnag.notify(StoplightStatusChange.new(message), options)
+        bugsnag.notify(StoplightStatusChange.new(message), **options)
         message
       end
     end

data/lib/stoplight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stoplight
-  VERSION = Gem::Version.new('3.0.0')
+  VERSION = Gem::Version.new('3.0.1')
 end

data/lib/stoplight.rb

@@ -20,7 +20,6 @@ require 'stoplight/notifier/base'
 require 'stoplight/notifier/generic'
 
 require 'stoplight/notifier/bugsnag'
-require 'stoplight/notifier/hip_chat'
 require 'stoplight/notifier/honeybadger'
 require 'stoplight/notifier/io'
 require 'stoplight/notifier/logger'
@@ -35,6 +34,6 @@ require 'stoplight/light/runnable'
 require 'stoplight/light'
 
 # @see Stoplight::Light#initialize
-def Stoplight(name, &code) # rubocop:disable Style/MethodName
+def Stoplight(name, &code) # rubocop:disable Naming/MethodName
   Stoplight::Light.new(name, &code)
 end

data/spec/stoplight/data_store/base_spec.rb

@@ -61,4 +61,11 @@ RSpec.describe Stoplight::DataStore::Base do
         .to raise_error(NotImplementedError)
     end
   end
+
+  describe '#with_notification_lock' do
+    it 'is not implemented' do
+      expect { data_store.with_notification_lock(nil, nil, nil) }
+        .to raise_error(NotImplementedError)
+    end
+  end
 end

data/spec/stoplight/data_store/memory_spec.rb

@@ -130,4 +130,30 @@ RSpec.describe Stoplight::DataStore::Memory do
       expect(data_store.get_state(light)).to eql(Stoplight::State::UNLOCKED)
     end
   end
+
+  describe '#with_notification_lock' do
+    context 'when notification is already sent' do
+      before do
+        data_store.with_notification_lock(light, Stoplight::Color::GREEN, Stoplight::Color::RED) {}
+      end
+
+      it 'does not yield passed block' do
+        expect do |b|
+          data_store.with_notification_lock(light, Stoplight::Color::GREEN, Stoplight::Color::RED, &b)
+        end.not_to yield_control
+      end
+    end
+
+    context 'when notification is not already sent' do
+      before do
+        data_store.with_notification_lock(light, Stoplight::Color::GREEN, Stoplight::Color::RED) {}
+      end
+
+      it 'yields passed block' do
+        expect do |b|
+          data_store.with_notification_lock(light, Stoplight::Color::RED, Stoplight::Color::GREEN, &b)
+        end.to yield_control
+      end
+    end
+  end
 end

data/spec/stoplight/data_store/redis_spec.rb

@@ -1,17 +1,16 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
-require 'fakeredis'
+require 'mock_redis'
 
 RSpec.describe Stoplight::DataStore::Redis do
-  let(:data_store) { described_class.new(redis) }
-  let(:redis) { Redis.new }
+  let(:data_store) { described_class.new(redis, redlock: redlock) }
+  let(:redis) { MockRedis.new }
+  let(:redlock) { instance_double(Redlock::Client) }
   let(:light) { Stoplight::Light.new(name) {} }
   let(:name) { ('a'..'z').to_a.shuffle.join }
   let(:failure) { Stoplight::Failure.new('class', 'message', Time.new) }
 
-  before { Redis::Connection::Memory.reset_all_databases }
-
   it 'is a class' do
     expect(described_class).to be_a(Class)
   end
@@ -143,4 +142,36 @@ RSpec.describe Stoplight::DataStore::Redis do
       expect(data_store.get_state(light)).to eql(Stoplight::State::UNLOCKED)
     end
   end
+
+  describe '#with_notification_lock' do
+    let(:lock_key) { "stoplight:notification_lock:#{name}" }
+
+    before do
+      allow(redlock).to receive(:lock).with(lock_key, 2_000).and_yield
+    end
+
+    context 'when notification is already sent' do
+      before do
+        data_store.with_notification_lock(light, Stoplight::Color::GREEN, Stoplight::Color::RED) {}
+      end
+
+      it 'does not yield passed block' do
+        expect do |b|
+          data_store.with_notification_lock(light, Stoplight::Color::GREEN, Stoplight::Color::RED, &b)
+        end.not_to yield_control
+      end
+    end
+
+    context 'when notification is not already sent' do
+      before do
+        data_store.with_notification_lock(light, Stoplight::Color::GREEN, Stoplight::Color::RED) {}
+      end
+
+      it 'yields passed block' do
+        expect do |b|
+          data_store.with_notification_lock(light, Stoplight::Color::RED, Stoplight::Color::GREEN, &b)
+        end.to yield_control
+      end
+    end
+  end
 end

data/spec/stoplight/light/runnable_spec.rb

@@ -109,6 +109,38 @@ RSpec.describe Stoplight::Light::Runnable do
           expect(subject.data_store.get_failures(subject).size).to eql(1)
         end
 
+        context 'when we did not send notifications yet' do
+          it 'notifies when transitioning to red' do
+            subject.threshold.times do
+              expect(io.string).to eql('')
+              begin
+                subject.run
+              rescue error.class
+                nil
+              end
+            end
+            expect(io.string).to_not eql('')
+          end
+        end
+
+        context 'when we already sent notifications' do
+          before do
+            subject.data_store.with_notification_lock(subject, Stoplight::Color::GREEN, Stoplight::Color::RED) {}
+          end
+
+          it 'does not send new notifications' do
+            subject.threshold.times do
+              expect(io.string).to eql('')
+              begin
+                subject.run
+              rescue error.class
+                nil
+              end
+            end
+            expect(io.string).to eql('')
+          end
+        end
+
         it 'notifies when transitioning to red' do
           subject.threshold.times do
             expect(io.string).to eql('')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stoplight
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Cameron Desautels
@@ -10,8 +10,22 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-23 00:00:00.000000000 Z
+date: 2022-12-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: redlock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
@@ -46,42 +60,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: hipchat
+  name: honeybadger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
-  name: honeybadger
+  name: mock_redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '0.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: pagerduty
   requirement: !ruby/object:Gem::Requirement
@@ -116,28 +130,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -214,14 +228,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
 description: An implementation of the circuit breaker pattern.
 email:
 - camdez@gmail.com
@@ -249,7 +263,6 @@ files:
 - 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
@@ -273,7 +286,6 @@ files:
 - 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
@@ -304,7 +316,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !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.
@@ -323,7 +335,6 @@ test_files:
 - 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

data/lib/stoplight/notifier/hip_chat.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Stoplight
-  module Notifier
-    # @see Base
-    class HipChat < Base
-      DEFAULT_OPTIONS = {
-        color: 'purple',
-        message_format: 'text',
-        notify: true
-      }.freeze
-
-      # @return [Proc]
-      attr_reader :formatter
-      # @return [::HipChat::Client]
-      attr_reader :hip_chat
-      # @return [Hash{Symbol => Object}]
-      attr_reader :options
-      # @return [String]
-      attr_reader :room
-
-      # @param hip_chat [::HipChat::Client]
-      # @param room [String]
-      # @param formatter [Proc, nil]
-      # @param options [Hash{Symbol => Object}]
-      # @option options [String] :color
-      # @option options [String] :message_format
-      # @option options [Boolean] :notify
-      def initialize(hip_chat, room, formatter = nil, options = {})
-        @hip_chat = hip_chat
-        @room = room
-        @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)
-        hip_chat[room].send('Stoplight', message, options)
-        message
-      end
-    end
-  end
-end

data/spec/stoplight/notifier/hip_chat_spec.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-# require 'hipchat'
-module HipChat
-  class Client
-    def initialize(*); end
-  end
-end
-
-RSpec.describe Stoplight::Notifier::HipChat do
-  it 'is a class' do
-    expect(described_class).to be_a(Class)
-  end
-
-  it 'is a subclass of Base' do
-    expect(described_class).to be < Stoplight::Notifier::Base
-  end
-
-  describe '#formatter' do
-    it 'is initially the default' do
-      expect(described_class.new(nil, nil).formatter)
-        .to eql(Stoplight::Default::FORMATTER)
-    end
-
-    it 'reads the formatter' do
-      formatter = proc {}
-      expect(described_class.new(nil, nil, formatter).formatter)
-        .to eql(formatter)
-    end
-  end
-
-  describe '#hip_chat' do
-    it 'reads the HipChat client' do
-      hip_chat = HipChat::Client.new('API token')
-      expect(described_class.new(hip_chat, nil).hip_chat)
-        .to eql(hip_chat)
-    end
-  end
-
-  describe '#options' do
-    it 'is initially the default' do
-      expect(described_class.new(nil, nil).options)
-        .to eql(Stoplight::Notifier::HipChat::DEFAULT_OPTIONS)
-    end
-
-    it 'reads the options' do
-      options = { key: :value }
-      expect(described_class.new(nil, nil, nil, options).options)
-        .to eql(Stoplight::Notifier::HipChat::DEFAULT_OPTIONS.merge(options))
-    end
-  end
-
-  describe '#room' do
-    it 'reads the room' do
-      room = 'Notifications'
-      expect(described_class.new(nil, room).room).to eql(room)
-    end
-  end
-
-  describe '#notify' do
-    let(:light) { Stoplight::Light.new(name, &code) }
-    let(:name) { ('a'..'z').to_a.shuffle.join }
-    let(:code) { -> {} }
-    let(:from_color) { Stoplight::Color::GREEN }
-    let(:to_color) { Stoplight::Color::RED }
-    let(:notifier) { described_class.new(hip_chat, room) }
-    let(:hip_chat) { double(HipChat::Client) }
-    let(:room) { ('a'..'z').to_a.shuffle.join }
-
-    before do
-      tmp = double
-      expect(hip_chat).to receive(:[]).with(room).and_return(tmp)
-      expect(tmp).to receive(:send)
-        .with('Stoplight', kind_of(String), kind_of(Hash)).and_return(true)
-    end
-
-    it 'returns the message' do
-      error = nil
-      expect(notifier.notify(light, from_color, to_color, error))
-        .to eql(notifier.formatter.call(light, from_color, to_color, error))
-    end
-
-    it 'returns the message with an error' do
-      error = ZeroDivisionError.new('divided by 0')
-      expect(notifier.notify(light, from_color, to_color, error))
-        .to eql(notifier.formatter.call(light, from_color, to_color, error))
-    end
-  end
-end