stoplight 2.2.1 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e26d25f913bb759dccd62f2b12576cbe51550753c3c6428fb16cdb6052559928
-  data.tar.gz: 6cbfd0ccd62da40cb335e671c8ba2d84348652e206520355fa651eb2276e16ea
+  metadata.gz: 4ec8f5b8b13778f792ad1fbbbc3138229ef51ac4e62149f93eb3a8b4bccc9d3a
+  data.tar.gz: d93e27dbf0563bb30a7025bf646befe712269c4bd5f259432ffeeb8c680934da
 SHA512:
-  metadata.gz: a186fc199cd54411996a65c369c687dc1165ecb2115699c72e6aa005f1b3d5b0da3b5f90402d2c49b12d73ca708628b09f5b9ba02e57c127ce89a33f8dc16cd2
-  data.tar.gz: 7ee5b81cad78ed7aaa7200aedf74cba3af8aff5b1e95940c572ca93bbefa28676ceb507ef04ce63bef28d9b6e7dcb2590653dd06704cf14b561653662c9fa30b
+  metadata.gz: c3c10ff2886343b2625c777c5143656624df7591ab75e3bb8c8c43032fc10a92dacd9f2a801eebd7c636c5adc5a744525be76cb22f4acb4f839f6a87a6f8608b
+  data.tar.gz: 28af6a4a57af91a6d21df0b79909a4584acca9e5028079aff313911a965d3cb1da36b3a0b9c934b8621b6bd372e84da34d1fa47b47c043c10e27bb99a885c6f9

data/README.md

@@ -4,7 +4,6 @@
 [![Build badge][]][build]
 [![Coverage badge][]][coverage]
 [![Climate badge][]][climate]
-[![Dependencies badge][]][dependencies]
 
 Stoplight is traffic control for code. It's an implementation of the circuit
 breaker pattern in Ruby.
@@ -29,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)
@@ -312,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
@@ -495,31 +477,28 @@ stoplight = Stoplight("test-#{rand}") { ... }
 
 ## Credits
 
-Stoplight is brought to you by [@camdez][] and [@tfausak][] from [@OrgSync][].
-A [complete list of contributors][] is available on GitHub. We were inspired by
-Martin Fowler's [CircuitBreaker][] article.
+Stoplight is brought to you by [@camdez][] and [@tfausak][] from [@OrgSync][]. [@bolshakov][] is the current 
+maintainer of the gem. A [complete list of contributors][] is available on GitHub. We were inspired by
+Martin Fowler's [CircuitBreaker][] article. 
 
 Stoplight is licensed under [the MIT License][].
 
-[Stoplight]: https://github.com/orgsync/stoplight
+[Stoplight]: https://github.com/bolshakov/stoplight
 [Version badge]: https://img.shields.io/gem/v/stoplight.svg?label=version
 [version]: https://rubygems.org/gems/stoplight
-[Build badge]: https://img.shields.io/travis/orgsync/stoplight/master.svg?label=build
-[build]: https://travis-ci.org/orgsync/stoplight
-[Coverage badge]: https://img.shields.io/coveralls/orgsync/stoplight/master.svg?label=coverage
-[coverage]: https://coveralls.io/r/orgsync/stoplight
-[Climate badge]: https://img.shields.io/codeclimate/github/orgsync/stoplight.svg?label=climate
-[climate]: https://codeclimate.com/github/orgsync/stoplight
-[Dependencies badge]: https://img.shields.io/gemnasium/orgsync/stoplight.svg?label=dependencies
-[dependencies]: https://gemnasium.com/orgsync/stoplight
-[stoplight-admin]: https://github.com/orgsync/stoplight-admin
+[Build badge]: https://github.com/bolshakov/stoplight/workflows/Specs/badge.svg
+[build]: https://github.com/bolshakov/stoplight/actions?query=branch%3Amaster
+[Coverage badge]: https://img.shields.io/coveralls/bolshakov/stoplight/master.svg?label=coverage
+[coverage]: https://coveralls.io/r/bolshakov/stoplight
+[Climate badge]: https://api.codeclimate.com/v1/badges/3451c2d281ffa345441a/maintainability
+[climate]: https://codeclimate.com/github/bolshakov/stoplight
+[stoplight-admin]: https://github.com/bolshakov/stoplight-admin
 [Semantic Versioning]: http://semver.org/spec/v2.0.0.html
 [the change log]: CHANGELOG.md
 [the notifiers section]: #notifiers
 [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
@@ -529,6 +508,7 @@ Stoplight is licensed under [the MIT License][].
 [@camdez]: https://github.com/camdez
 [@tfausak]: https://github.com/tfausak
 [@orgsync]: https://github.com/OrgSync
-[complete list of contributors]: https://github.com/orgsync/stoplight/graphs/contributors
+[@bolshakov]: https://github.com/bolshakov
+[complete list of contributors]: https://github.com/bolshakov/stoplight/graphs/contributors
 [CircuitBreaker]: http://martinfowler.com/bliki/CircuitBreaker.html
 [the MIT license]: LICENSE.md

data/lib/stoplight/color.rb

@@ -1,9 +1,9 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Stoplight
   module Color
-    GREEN = 'green'.freeze
-    YELLOW = 'yellow'.freeze
-    RED = 'red'.freeze
+    GREEN = 'green'
+    YELLOW = 'yellow'
+    RED = 'red'
   end
 end

data/lib/stoplight/data_store/base.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Stoplight
   module DataStore
@@ -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

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 require 'monitor'
 
@@ -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,15 +1,18 @@
-# coding: utf-8
+# frozen_string_literal: true
+
+require 'redlock'
 
 module Stoplight
   module DataStore
     # @see Base
     class Redis < Base
-      KEY_PREFIX = 'stoplight'.freeze
-      KEY_SEPARATOR = ':'.freeze
+      KEY_PREFIX = 'stoplight'
+      KEY_SEPARATOR = ':'
 
       # @param redis [::Redis]
-      def initialize(redis)
+      def initialize(redis, redlock: Redlock::Client.new([redis]))
         @redis = redis
+        @redlock = redlock
       end
 
       def names
@@ -25,9 +28,9 @@ module Stoplight
       end
 
       def get_all(light)
-        failures, state = @redis.multi do
-          query_failures(light)
-          @redis.hget(states_key, light.name)
+        failures, state = @redis.multi do |transaction|
+          query_failures(light, transaction: transaction)
+          transaction.hget(states_key, light.name)
         end
 
         [
@@ -41,18 +44,18 @@ module Stoplight
       end
 
       def record_failure(light, failure)
-        size, = @redis.multi do
-          @redis.lpush(failures_key(light), failure.to_json)
-          @redis.ltrim(failures_key(light), 0, light.threshold - 1)
+        size, = @redis.multi do |transaction|
+          transaction.lpush(failures_key(light), failure.to_json)
+          transaction.ltrim(failures_key(light), 0, light.threshold - 1)
         end
 
         size
       end
 
       def clear_failures(light)
-        failures, = @redis.multi do
-          query_failures(light)
-          @redis.del(failures_key(light))
+        failures, = @redis.multi do |transaction|
+          query_failures(light, transaction: transaction)
+          transaction.del(failures_key(light))
         end
 
         normalize_failures(failures, light.error_notifier)
@@ -68,33 +71,57 @@ module Stoplight
       end
 
       def clear_state(light)
-        state, = @redis.multi do
-          query_state(light)
-          @redis.hdel(states_key, light.name)
+        state, = @redis.multi do |transaction|
+          query_state(light, transaction: transaction)
+          transaction.hdel(states_key, light.name)
         end
 
         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
 
-      def query_failures(light)
-        @redis.lrange(failures_key(light), 0, -1)
+      # @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
 
       def normalize_failures(failures, error_notifier)
         failures.map do |json|
-          begin
-            Failure.from_json(json)
-          rescue => error
-            error_notifier.call(error)
-            Failure.from_error(error)
-          end
+          Failure.from_json(json)
+        rescue StandardError => e
+          error_notifier.call(e)
+          Failure.from_error(e)
         end
       end
 
-      def query_state(light)
-        @redis.hget(states_key, light.name)
+      def query_state(light, transaction: @redis)
+        transaction.hget(states_key, light.name)
       end
 
       def normalize_state(state)
@@ -105,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/data_store.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Stoplight
   module DataStore # rubocop:disable Style/Documentation

data/lib/stoplight/default.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Stoplight
   module Default
@@ -6,9 +6,9 @@ module Stoplight
 
     DATA_STORE = DataStore::Memory.new
 
-    ERROR_HANDLER = -> (error, handler) { handler.call(error) }
+    ERROR_HANDLER = ->(error, handler) { handler.call(error) }
 
-    ERROR_NOTIFIER = -> (error) { warn error }
+    ERROR_NOTIFIER = ->(error) { warn error }
 
     FALLBACK = nil
 

data/lib/stoplight/error.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Stoplight
   module Error

data/lib/stoplight/failure.rb

@@ -1,11 +1,11 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 require 'json'
 require 'time'
 
 module Stoplight
   class Failure # rubocop:disable Style/Documentation
-    TIME_FORMAT = '%Y-%m-%dT%H:%M:%S.%N%:z'.freeze
+    TIME_FORMAT = '%Y-%m-%dT%H:%M:%S.%N%:z'
 
     # @return [String]
     attr_reader :error_class

data/lib/stoplight/light/runnable.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Stoplight
   class Light
@@ -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?
@@ -44,23 +48,25 @@ module Stoplight
 
       def run_red
         raise Error::RedLight, name unless fallback
+
         fallback.call(nil)
       end
 
       def run_code(on_success, on_failure)
         result = code.call
         failures = clear_failures
-        on_success.call(failures) if on_success
+        on_success&.call(failures)
         result
-      rescue Exception => error # rubocop:disable Lint/RescueException
-        handle_error(error, on_failure)
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        handle_error(e, on_failure)
       end
 
       def handle_error(error, on_failure)
         error_handler.call(error, Error::HANDLER)
         size = record_failure(error)
-        on_failure.call(size, error) if on_failure
+        on_failure&.call(size, error)
         raise error unless fallback
+
         fallback.call(error)
       end
 
@@ -73,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/light.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Stoplight
   class Light # rubocop:disable Style/Documentation

data/lib/stoplight/notifier/base.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Stoplight
   module Notifier

data/lib/stoplight/notifier/bugsnag.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Stoplight
   module Notifier
@@ -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/notifier/generic.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Stoplight
   module Notifier

data/lib/stoplight/notifier/honeybadger.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Stoplight
   module Notifier
@@ -34,7 +34,7 @@ module Stoplight
         h = options.merge(
           api_key: api_key,
           error_message: message,
-          backtrace: (error.backtrace if error)
+          backtrace: error&.backtrace
         )
         ::Honeybadger.notify(h)
         message

data/lib/stoplight/notifier/io.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Stoplight
   module Notifier

data/lib/stoplight/notifier/logger.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Stoplight
   module Notifier

data/lib/stoplight/notifier/pagerduty.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Stoplight
   module Notifier

data/lib/stoplight/notifier/raven.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Stoplight
   module Notifier
@@ -30,7 +30,7 @@ module Stoplight
 
         h = options.merge(
           configuration: configuration,
-          backtrace: (error.backtrace if error)
+          backtrace: error&.backtrace
         )
         ::Raven.capture_message(message, h)
         message

data/lib/stoplight/notifier/rollbar.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Stoplight
   module Notifier

data/lib/stoplight/notifier/slack.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Stoplight
   module Notifier

data/lib/stoplight/notifier.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Stoplight
   module Notifier # rubocop:disable Style/Documentation

data/lib/stoplight/state.rb

@@ -1,9 +1,9 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Stoplight
   module State
-    UNLOCKED = 'unlocked'.freeze
-    LOCKED_GREEN = 'locked_green'.freeze
-    LOCKED_RED = 'locked_red'.freeze
+    UNLOCKED = 'unlocked'
+    LOCKED_GREEN = 'locked_green'
+    LOCKED_RED = 'locked_red'
   end
 end

data/lib/stoplight/version.rb

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

data/lib/stoplight.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Stoplight # rubocop:disable Style/Documentation
 end
@@ -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/spec_helper.rb

@@ -1,7 +1,6 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-require 'coveralls'
-Coveralls.wear!
+require 'simplecov'
 
 require 'stoplight'
 require 'timecop'

data/spec/stoplight/color_spec.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 require 'spec_helper'
 

data/spec/stoplight/data_store/base_spec.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 require 'spec_helper'
 
@@ -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