stoplight 5.3.8 → 5.5.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stoplight
 version: !ruby/object:Gem::Version
-  version: 5.3.8
+  version: 5.5.0
 platform: ruby
 authors:
 - Cameron Desautels
@@ -57,50 +57,61 @@ files:
 - lib/stoplight/admin/views/_card.erb
 - lib/stoplight/admin/views/index.erb
 - lib/stoplight/admin/views/layout.erb
-- lib/stoplight/color.rb
-- lib/stoplight/config/compatibility_result.rb
-- lib/stoplight/config/dsl.rb
-- lib/stoplight/config/library_default_config.rb
-- lib/stoplight/config/system_config.rb
-- lib/stoplight/config/user_default_config.rb
-- lib/stoplight/data_store.rb
-- lib/stoplight/data_store/base.rb
-- lib/stoplight/data_store/fail_safe.rb
-- lib/stoplight/data_store/memory.rb
-- lib/stoplight/data_store/redis.rb
-- lib/stoplight/data_store/redis/get_metadata.lua
-- lib/stoplight/data_store/redis/lua.rb
-- lib/stoplight/data_store/redis/record_failure.lua
-- lib/stoplight/data_store/redis/record_success.lua
-- lib/stoplight/data_store/redis/transition_to_green.lua
-- lib/stoplight/data_store/redis/transition_to_red.lua
-- lib/stoplight/data_store/redis/transition_to_yellow.lua
-- lib/stoplight/default.rb
-- lib/stoplight/error.rb
-- lib/stoplight/failure.rb
-- lib/stoplight/light.rb
-- lib/stoplight/light/config.rb
-- lib/stoplight/light/configuration_builder_interface.rb
-- lib/stoplight/light/green_run_strategy.rb
-- lib/stoplight/light/red_run_strategy.rb
-- lib/stoplight/light/run_strategy.rb
-- lib/stoplight/light/yellow_run_strategy.rb
-- lib/stoplight/metadata.rb
-- lib/stoplight/notifier/base.rb
-- lib/stoplight/notifier/fail_safe.rb
-- lib/stoplight/notifier/generic.rb
-- lib/stoplight/notifier/io.rb
-- lib/stoplight/notifier/logger.rb
+- lib/stoplight/domain/color.rb
+- lib/stoplight/domain/compatibility_result.rb
+- lib/stoplight/domain/config.rb
+- lib/stoplight/domain/data_store.rb
+- lib/stoplight/domain/error.rb
+- lib/stoplight/domain/failure.rb
+- lib/stoplight/domain/light.rb
+- lib/stoplight/domain/light/configuration_builder_interface.rb
+- lib/stoplight/domain/light_factory.rb
+- lib/stoplight/domain/metadata.rb
+- lib/stoplight/domain/state.rb
+- lib/stoplight/domain/state_transition_notifier.rb
+- lib/stoplight/domain/strategies/green_run_strategy.rb
+- lib/stoplight/domain/strategies/red_run_strategy.rb
+- lib/stoplight/domain/strategies/run_strategy.rb
+- lib/stoplight/domain/strategies/yellow_run_strategy.rb
+- lib/stoplight/domain/tracker/base.rb
+- lib/stoplight/domain/tracker/recovery_probe.rb
+- lib/stoplight/domain/tracker/request.rb
+- lib/stoplight/domain/traffic_control/base.rb
+- lib/stoplight/domain/traffic_control/consecutive_errors.rb
+- lib/stoplight/domain/traffic_control/error_rate.rb
+- lib/stoplight/domain/traffic_recovery.rb
+- lib/stoplight/domain/traffic_recovery/base.rb
+- lib/stoplight/domain/traffic_recovery/consecutive_successes.rb
+- lib/stoplight/infrastructure/data_store/memory.rb
+- lib/stoplight/infrastructure/data_store/memory/sliding_window.rb
+- lib/stoplight/infrastructure/data_store/redis.rb
+- lib/stoplight/infrastructure/data_store/redis/get_metadata.lua
+- lib/stoplight/infrastructure/data_store/redis/lua.rb
+- lib/stoplight/infrastructure/data_store/redis/record_failure.lua
+- lib/stoplight/infrastructure/data_store/redis/record_success.lua
+- lib/stoplight/infrastructure/data_store/redis/transition_to_green.lua
+- lib/stoplight/infrastructure/data_store/redis/transition_to_red.lua
+- lib/stoplight/infrastructure/data_store/redis/transition_to_yellow.lua
+- lib/stoplight/infrastructure/dependency_injection/container.rb
+- lib/stoplight/infrastructure/dependency_injection/unresolved_dependency_error.rb
+- lib/stoplight/infrastructure/notifier/generic.rb
+- lib/stoplight/infrastructure/notifier/io.rb
+- lib/stoplight/infrastructure/notifier/logger.rb
 - lib/stoplight/rspec.rb
 - lib/stoplight/rspec/generic_notifier.rb
-- lib/stoplight/state.rb
-- lib/stoplight/traffic_control/base.rb
-- lib/stoplight/traffic_control/consecutive_errors.rb
-- lib/stoplight/traffic_control/error_rate.rb
-- lib/stoplight/traffic_recovery.rb
-- lib/stoplight/traffic_recovery/base.rb
-- lib/stoplight/traffic_recovery/consecutive_successes.rb
 - lib/stoplight/version.rb
+- lib/stoplight/wiring/container.rb
+- lib/stoplight/wiring/default.rb
+- lib/stoplight/wiring/default_configuration.rb
+- lib/stoplight/wiring/default_factory_builder.rb
+- lib/stoplight/wiring/fail_safe_data_store.rb
+- lib/stoplight/wiring/fail_safe_notifier.rb
+- lib/stoplight/wiring/light/default_config.rb
+- lib/stoplight/wiring/light/system_config.rb
+- lib/stoplight/wiring/light_factory.rb
+- lib/stoplight/wiring/public_api.rb
+- lib/stoplight/wiring/system_container.rb
+- lib/stoplight/wiring/system_light_factory.rb
 homepage: https://github.com/bolshakov/stoplight
 licenses:
 - MIT

data/lib/stoplight/color.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Stoplight
-  module Color
-    GREEN = "green"
-    YELLOW = "yellow"
-    RED = "red"
-  end
-end

data/lib/stoplight/config/dsl.rb

@@ -1,97 +0,0 @@
-# frozen_string_literal: true
-
-module Stoplight
-  module Config
-    # This is a DSL for configuring Stoplight settings. It is responsible for
-    # transforming the provided settings into a format that can be used by Stoplight.
-    #
-    # @api private
-    class DSL
-      def transform(settings)
-        if settings.has_key?(:data_store)
-          settings[:data_store] = build_data_store(settings[:data_store])
-        end
-
-        if settings.has_key?(:notifiers)
-          settings[:notifiers] = build_notifiers(settings[:notifiers])
-        end
-
-        if settings.has_key?(:tracked_errors)
-          settings[:tracked_errors] = build_tracked_errors(settings[:tracked_errors])
-        end
-
-        if settings.has_key?(:skipped_errors)
-          settings[:skipped_errors] = build_skipped_errors(settings[:skipped_errors])
-        end
-
-        if settings.has_key?(:cool_off_time)
-          settings[:cool_off_time] = build_cool_off_time(settings[:cool_off_time])
-        end
-
-        if settings.has_key?(:traffic_control)
-          settings[:traffic_control] = build_traffic_control(settings[:traffic_control])
-        end
-
-        if settings.has_key?(:traffic_recovery)
-          settings[:traffic_recovery] = build_traffic_recovery(settings[:traffic_recovery])
-        end
-        settings
-      end
-
-      private
-
-      def build_data_store(data_store)
-        DataStore::FailSafe.wrap(data_store)
-      end
-
-      def build_notifiers(notifiers)
-        notifiers.map { |notifier| Notifier::FailSafe.wrap(notifier) }
-      end
-
-      def build_tracked_errors(tracked_error)
-        Array(tracked_error)
-      end
-
-      def build_skipped_errors(skipped_errors)
-        Array(skipped_errors)
-      end
-
-      def build_cool_off_time(cool_off_time)
-        cool_off_time.to_i
-      end
-
-      def build_traffic_control(traffic_control)
-        case traffic_control
-        in Stoplight::TrafficControl::Base
-          traffic_control
-        in :consecutive_errors
-          Stoplight::TrafficControl::ConsecutiveErrors.new
-        in :error_rate
-          Stoplight::TrafficControl::ErrorRate.new
-        in {error_rate: error_rate_settings}
-          Stoplight::TrafficControl::ErrorRate.new(**error_rate_settings)
-        else
-          raise Error::ConfigurationError, <<~ERROR
-            unsupported traffic_control strategy provided (`#{traffic_control}`). Supported options:
-              * Stoplight::TrafficControl::ConsecutiveErrors
-              * Stoplight::TrafficControl::ErrorRate
-          ERROR
-        end
-      end
-
-      def build_traffic_recovery(traffic_recovery)
-        case traffic_recovery
-        in Stoplight::TrafficRecovery::Base
-          traffic_recovery
-        in :consecutive_successes
-          Stoplight::TrafficRecovery::ConsecutiveSuccesses.new
-        else
-          raise Error::ConfigurationError, <<~ERROR
-            unsupported traffic_recovery strategy provided (`#{traffic_recovery}`). Supported options:
-              * Stoplight::TrafficRecovery::ConsecutiveSuccesses
-          ERROR
-        end
-      end
-    end
-  end
-end

data/lib/stoplight/config/library_default_config.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Stoplight
-  module Config
-    # Provides default settings for the Stoplight library.
-    # @api private
-    LibraryDefaultConfig = Light::Config.empty.with(
-      cool_off_time: Stoplight::Default::COOL_OFF_TIME,
-      data_store: Stoplight::Default::DATA_STORE,
-      error_notifier: Stoplight::Default::ERROR_NOTIFIER,
-      notifiers: Stoplight::Default::NOTIFIERS,
-      threshold: Stoplight::Default::THRESHOLD,
-      recovery_threshold: Stoplight::Default::RECOVERY_THRESHOLD,
-      window_size: Stoplight::Default::WINDOW_SIZE,
-      tracked_errors: Stoplight::Default::TRACKED_ERRORS,
-      skipped_errors: Stoplight::Default::SKIPPED_ERRORS,
-      traffic_control: Stoplight::Default::TRAFFIC_CONTROL,
-      traffic_recovery: Stoplight::Default::TRAFFIC_RECOVERY
-    )
-  end
-end

data/lib/stoplight/config/system_config.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Stoplight
-  module Config
-    SystemConfig = LibraryDefaultConfig
-  end
-end

data/lib/stoplight/data_store/fail_safe.rb

@@ -1,113 +0,0 @@
-# frozen_string_literal: true
-
-require "securerandom"
-
-module Stoplight
-  module DataStore
-    # A wrapper around a data store that provides fail-safe mechanisms using a
-    # circuit breaker. It ensures that operations on the data store can gracefully
-    # handle failures by falling back to default values when necessary.
-    #
-    # @api private
-    class FailSafe < Base
-      # @!attribute [r] data_store
-      #   @return [Stoplight::DataStore::Base] The underlying data store being wrapped.
-      protected attr_reader :data_store
-
-      class << self
-        # Wraps a data store with fail-safe mechanisms.
-        #
-        # @param data_store [Stoplight::DataStore::Base] The data store to wrap.
-        # @return [Stoplight::DataStore::Base, FailSafe] The original data store if it is already
-        #   a +Memory+ or +FailSafe+ instance, otherwise a new +FailSafe+ instance.
-        def wrap(data_store)
-          case data_store
-          when Memory, FailSafe
-            data_store
-          else
-            new(data_store)
-          end
-        end
-      end
-
-      # @param data_store [Stoplight::DataStore::Base]
-      def initialize(data_store)
-        @data_store = data_store
-        @circuit_breaker = Stoplight(
-          "stoplight:data_store:fail_safe:#{data_store.class.name}",
-          data_store: Default::DATA_STORE,
-          traffic_control: TrafficControl::ConsecutiveErrors.new,
-          threshold: Default::THRESHOLD
-        )
-      end
-
-      def names
-        with_fallback([]) do
-          data_store.names
-        end
-      end
-
-      def get_metadata(config)
-        with_fallback(Metadata.new, config) do
-          data_store.get_metadata(config)
-        end
-      end
-
-      def record_failure(config, failure)
-        with_fallback(Metadata.new, config) do
-          data_store.record_failure(config, failure)
-        end
-      end
-
-      def record_success(config, **args)
-        with_fallback(nil, config) do
-          data_store.record_success(config, **args)
-        end
-      end
-
-      def record_recovery_probe_success(config, **args)
-        with_fallback(Metadata.new, config) do
-          data_store.record_recovery_probe_success(config, **args)
-        end
-      end
-
-      def record_recovery_probe_failure(config, failure)
-        with_fallback(Metadata.new, config) do
-          data_store.record_recovery_probe_failure(config, failure)
-        end
-      end
-
-      def set_state(config, state)
-        with_fallback(State::UNLOCKED, config) do
-          data_store.set_state(config, state)
-        end
-      end
-
-      def transition_to_color(config, color)
-        with_fallback(false, config) do
-          data_store.transition_to_color(config, color)
-        end
-      end
-
-      def ==(other)
-        other.is_a?(self.class) && other.data_store == data_store
-      end
-
-      # @param default [Object, nil]
-      # @param config [Stoplight::Light::Config]
-      private def with_fallback(default = nil, config = nil, &code)
-        fallback = proc do |error|
-          config.error_notifier.call(error) if config && error
-          default
-        end
-
-        circuit_breaker.run(fallback, &code)
-      end
-
-      # @return [Stoplight::Light] The circuit breaker used to handle failures.
-      private def circuit_breaker
-        @circuit_breaker ||= Stoplight.system_light("stoplight:data_store:fail_safe:#{data_store.class.name}")
-      end
-    end
-  end
-end

data/lib/stoplight/data_store/memory.rb

@@ -1,311 +0,0 @@
-# frozen_string_literal: true
-
-require "monitor"
-
-module Stoplight
-  module DataStore
-    # @see Base
-    class Memory < Base
-      include MonitorMixin
-
-      KEY_SEPARATOR = ":"
-
-      def initialize
-        @errors = Hash.new { |h, k| h[k] = [] }
-        @successes = Hash.new { |h, k| h[k] = [] }
-
-        @recovery_probe_errors = Hash.new { |h, k| h[k] = [] }
-        @recovery_probe_successes = Hash.new { |h, k| h[k] = [] }
-
-        @metadata = Hash.new { |h, k| h[k] = Metadata.new }
-        super # MonitorMixin
-      end
-
-      # @return [Array<String>]
-      def names
-        synchronize { @metadata.keys }
-      end
-
-      # @param config [Stoplight::Light::Config]
-      # @return [Stoplight::Metadata]
-      def get_metadata(config)
-        light_name = config.name
-
-        synchronize do
-          current_time = Time.now
-          recovery_window = (current_time - config.cool_off_time)..current_time
-          recovered_at = @metadata[light_name].recovered_at
-          window = if config.window_size
-            window_start = [recovered_at, (current_time - config.window_size)].compact.max
-            (window_start..current_time)
-          else
-            (..current_time)
-          end
-
-          errors = @errors[config.name].count do |request_time|
-            window.cover?(request_time)
-          end
-
-          successes = @successes[config.name].count do |request_time|
-            window.cover?(request_time)
-          end
-
-          recovery_probe_errors = @recovery_probe_errors[config.name].count do |request_time|
-            recovery_window.cover?(request_time)
-          end
-          recovery_probe_successes = @recovery_probe_successes[config.name].count do |request_time|
-            recovery_window.cover?(request_time)
-          end
-
-          @metadata[light_name].with(
-            current_time:,
-            errors:,
-            successes:,
-            recovery_probe_errors:,
-            recovery_probe_successes:
-          )
-        end
-      end
-
-      # @param metrics [<Time>]
-      # @param window_size [Numeric, nil]
-      # @return [void]
-      def cleanup(metrics, window_size:)
-        min_age = Time.now - [window_size&.*(3), METRICS_RETENTION_TIME].compact.min
-
-        metrics.reject! { _1 < min_age }
-      end
-
-      # @param config [Stoplight::Light::Config]
-      # @param failure [Stoplight::Failure]
-      # @return [Stoplight::Metadata]
-      def record_failure(config, failure)
-        light_name = config.name
-
-        synchronize do
-          @errors[light_name].unshift(failure.time) if config.window_size
-
-          cleanup(@errors[light_name], window_size: config.window_size)
-
-          metadata = @metadata[light_name]
-          @metadata[light_name] = if metadata.last_error_at.nil? || failure.time > metadata.last_error_at
-            metadata.with(
-              last_error_at: failure.time,
-              last_error: failure,
-              consecutive_errors: metadata.consecutive_errors.succ,
-              consecutive_successes: 0
-            )
-          else
-            metadata.with(
-              consecutive_errors: metadata.consecutive_errors.succ,
-              consecutive_successes: 0
-            )
-          end
-          get_metadata(config)
-        end
-      end
-
-      # @param config [Stoplight::Light::Config]
-      # @param request_id [String]
-      # @param request_time [Time]
-      # @return [void]
-      def record_success(config, request_time: Time.now, request_id: SecureRandom.hex(12))
-        light_name = config.name
-
-        synchronize do
-          @successes[light_name].unshift(request_time) if config.window_size
-          cleanup(@successes[light_name], window_size: config.window_size)
-
-          metadata = @metadata[light_name]
-          @metadata[light_name] = if metadata.last_success_at.nil? || request_time > metadata.last_success_at
-            metadata.with(
-              last_success_at: request_time,
-              consecutive_errors: 0,
-              consecutive_successes: metadata.consecutive_successes.succ
-            )
-          else
-            metadata.with(
-              consecutive_errors: 0,
-              consecutive_successes: metadata.consecutive_successes.succ
-            )
-          end
-        end
-      end
-
-      # @param config [Stoplight::Light::Config]
-      # @param failure [Stoplight::Failure]
-      # @return [Stoplight::Metadata]
-      def record_recovery_probe_failure(config, failure)
-        light_name = config.name
-
-        synchronize do
-          @recovery_probe_errors[light_name].unshift(failure.time)
-          cleanup(@recovery_probe_errors[light_name], window_size: config.cool_off_time)
-
-          metadata = @metadata[light_name]
-          @metadata[light_name] = if metadata.last_error_at.nil? || failure.time > metadata.last_error_at
-            metadata.with(
-              last_error_at: failure.time,
-              last_error: failure,
-              consecutive_errors: metadata.consecutive_errors.succ,
-              consecutive_successes: 0
-            )
-          else
-            metadata.with(
-              consecutive_errors: metadata.consecutive_errors.succ,
-              consecutive_successes: 0
-            )
-          end
-          get_metadata(config)
-        end
-      end
-
-      # @param config [Stoplight::Light::Config]
-      # @param request_id [String]
-      # @param request_time [Time]
-      # @return [Stoplight::Metadata]
-      def record_recovery_probe_success(config, request_time: Time.now, request_id: SecureRandom.hex(12))
-        light_name = config.name
-
-        synchronize do
-          @recovery_probe_successes[light_name].unshift(request_time)
-          cleanup(@recovery_probe_successes[light_name], window_size: config.cool_off_time)
-
-          metadata = @metadata[light_name]
-          @metadata[light_name] = if metadata.last_success_at.nil? || request_time > metadata.last_success_at
-            metadata.with(
-              last_success_at: request_time,
-              consecutive_errors: 0,
-              consecutive_successes: metadata.consecutive_successes.succ
-            )
-          else
-            metadata.with(
-              consecutive_errors: 0,
-              consecutive_successes: metadata.consecutive_successes.succ
-            )
-          end
-          get_metadata(config)
-        end
-      end
-
-      # @param config [Stoplight::Light::Config]
-      # @param state [String]
-      # @return [String]
-      def set_state(config, state)
-        light_name = config.name
-
-        synchronize do
-          metadata = @metadata[light_name]
-          @metadata[light_name] = metadata.with(locked_state: state)
-        end
-        state
-      end
-
-      # @return [String]
-      def inspect
-        "#<#{self.class.name}>"
-      end
-
-      # Combined method that performs the state transition based on color
-      #
-      # @param config [Stoplight::Light::Config] The light configuration
-      # @param color [String] The color to transition to ("GREEN", "YELLOW", or "RED")
-      # @param current_time [Time]
-      # @return [Boolean] true if this is the first instance to detect this transition
-      def transition_to_color(config, color, current_time: Time.now)
-        case color
-        when Color::GREEN
-          transition_to_green(config)
-        when Color::YELLOW
-          transition_to_yellow(config, current_time:)
-        when Color::RED
-          transition_to_red(config, current_time:)
-        else
-          raise ArgumentError, "Invalid color: #{color}"
-        end
-      end
-
-      # Transitions to GREEN state and ensures only one notification
-      #
-      # @param config [Stoplight::Light::Config] The light configuration
-      # @return [Boolean] true if this is the first instance to detect this transition
-      private def transition_to_green(config, current_time: Time.now)
-        light_name = config.name
-
-        synchronize do
-          metadata = @metadata[light_name]
-          if metadata.recovered_at
-            false
-          else
-            @metadata[light_name] = metadata.with(
-              recovered_at: current_time,
-              recovery_started_at: nil,
-              breached_at: nil,
-              recovery_scheduled_after: nil
-            )
-            true
-          end
-        end
-      end
-
-      # Transitions to YELLOW (recovery) state and ensures only one notification
-      #
-      # @param config [Stoplight::Light::Config] The light configuration
-      # @param current_time [Time]
-      # @return [Boolean] true if this is the first instance to detect this transition
-      private def transition_to_yellow(config, current_time: Time.now)
-        light_name = config.name
-
-        synchronize do
-          metadata = @metadata[light_name]
-          if metadata.recovery_started_at.nil?
-            @metadata[light_name] = metadata.with(
-              recovery_started_at: current_time,
-              recovery_scheduled_after: nil,
-              recovered_at: nil,
-              breached_at: nil
-            )
-            true
-          else
-            @metadata[light_name] = metadata.with(
-              recovery_scheduled_after: nil,
-              recovered_at: nil,
-              breached_at: nil
-            )
-            false
-          end
-        end
-      end
-
-      # Transitions to RED state and ensures only one notification
-      #
-      # @param config [Stoplight::Light::Config] The light configuration
-      # @param current_time [Time]
-      # @return [Boolean] true if this is the first instance to detect this transition
-      private def transition_to_red(config, current_time: Time.now)
-        light_name = config.name
-        recovery_scheduled_after = current_time + config.cool_off_time
-
-        synchronize do
-          metadata = @metadata[light_name]
-          if metadata.breached_at
-            @metadata[light_name] = metadata.with(
-              recovery_scheduled_after: recovery_scheduled_after,
-              recovery_started_at: nil,
-              recovered_at: nil
-            )
-            false
-          else
-            @metadata[light_name] = metadata.with(
-              breached_at: current_time,
-              recovery_scheduled_after: recovery_scheduled_after,
-              recovery_started_at: nil,
-              recovered_at: nil
-            )
-            true
-          end
-        end
-      end
-    end
-  end
-end