stoplight 5.5.0 → 5.7.0

data/lib/stoplight/wiring/light_factory/traffic_control_dsl.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Stoplight
+  module Wiring
+    class LightFactory
+      TrafficControlDsl = proc do |value|
+        case value
+        in Domain::TrafficControl::Base
+          value
+        in :consecutive_errors
+          Domain::TrafficControl::ConsecutiveErrors.new
+        in :error_rate
+          Domain::TrafficControl::ErrorRate.new
+        in {error_rate: error_rate_settings}
+          Domain::TrafficControl::ErrorRate.new(**error_rate_settings)
+        else
+          raise Stoplight::Error::ConfigurationError, <<~ERROR
+            unsupported traffic_control strategy provided (`#{value}`). Supported options:
+              * :consecutive_errors
+              * :error_rate
+          ERROR
+        end
+      end
+    end
+  end
+end

data/lib/stoplight/wiring/light_factory/traffic_recovery_dsl.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Stoplight
+  module Wiring
+    class LightFactory
+      TrafficRecoveryDsl = proc do |value|
+        case value
+        in Domain::TrafficRecovery::Base
+          value
+        in :consecutive_successes
+          Domain::TrafficRecovery::ConsecutiveSuccesses.new
+        else
+          raise Domain::Error::ConfigurationError, <<~ERROR
+            unsupported traffic_recovery strategy provided (`#{value}`). Supported options:
+              * :consecutive_successes
+          ERROR
+        end
+      end
+    end
+  end
+end

data/lib/stoplight/wiring/light_factory.rb

@@ -15,15 +15,29 @@ module Stoplight
     # @api private
 
     class LightFactory < Domain::LightFactory
-      # @!attribute [r] container
-      #   The dependency injection container holding all component configurations.
-      #   Contains config, data_store, notifiers, strategies, etc.
-      #   @return [Stoplight::Wiring::Container]
-      protected attr_reader :container
-
-      # @param container [Stoplight::Wiring::Container]
-      def initialize(container)
-        @container = container
+      DEPENDENCY_KEYS = %i[data_store traffic_recovery traffic_control notifiers error_notifier].freeze
+      private_constant :DEPENDENCY_KEYS
+
+      CONFIG_KEYS = Domain::Config.members.freeze
+      private_constant :CONFIG_KEYS
+
+      # @!attribute [r] settings
+      #   @return [Hash]
+      protected attr_reader :settings
+
+      def initialize(settings = {})
+        @settings = settings
+
+        validate_settings!
+      end
+
+      private def validate_settings!
+        recognized = CONFIG_KEYS + DEPENDENCY_KEYS
+        unknown = settings.keys - recognized
+
+        return if unknown.empty?
+
+        raise ArgumentError, "Unknown settings: #{unknown.join(", ")}", caller(2)
       end
 
       # @param settings [Hash] Settings to override in the new factory
@@ -31,16 +45,7 @@ module Stoplight
       # @return [Stoplight::Wiring::LightFactory]
       # @see Stoplight()
       def with(**settings)
-        transformed_settings = transform_settings(settings)
-        config_settings = extract_config_settings(transformed_settings)
-        dependency_settings = extract_dependency_settings(transformed_settings)
-
-        validate_settings!(transformed_settings, config_settings, dependency_settings)
-
-        new_config = container.resolve(:config).with(**config_settings)
-        new_container = container.with(config: new_config, **dependency_settings)
-
-        self.class.new(new_container)
+        self.class.new(self.settings.merge(settings))
       end
 
       # Builds a fully-configured Light instance.
@@ -60,128 +65,36 @@ module Stoplight
       #   light.run { api_call }
 
       def build
-        validate!
-
-        Stoplight::Domain::Light.new(
-          container.resolve(:config),
-          data_store: container.resolve(:data_store),
-          green_run_strategy: container.resolve(:green_run_strategy),
-          yellow_run_strategy: container.resolve(:yellow_run_strategy),
-          red_run_strategy: container.resolve(:red_run_strategy),
-          factory: self
-        )
-      end
-
-      def ==(other)
-        other.is_a?(self.class) && other.container == container
-      end
-
-      private def extract_config_settings(settings)
-        settings.slice(*container.resolve(:config).members)
-      end
+        config_settings = settings.slice(*CONFIG_KEYS)
+        dependency_settings = settings.slice(*DEPENDENCY_KEYS)
 
-      private def extract_dependency_settings(settings)
-        settings.slice(*container.keys)
-      end
-
-      private def validate_settings!(settings, config_settings, dependency_settings)
-        recognized_keys = config_settings.keys + dependency_settings.keys
-        unexpected_keys = settings.keys - recognized_keys
-
-        return if unexpected_keys.empty?
-        raise ArgumentError, "Unknown settings: #{unexpected_keys.join(", ")}"
-      end
-
-      private def transform_settings(settings)
-        settings.dup.tap do |transformed_settings|
-          transform_config_settings!(transformed_settings)
-          transform_dependencies_settings!(transformed_settings)
-        end
-      end
-
-      private def transform_config_settings!(settings)
-        if settings.key?(:tracked_errors)
-          settings[:tracked_errors] = normalize_array(settings[:tracked_errors])
-        end
-
-        if settings.key?(:skipped_errors)
-          settings[:skipped_errors] = normalize_array(settings[:skipped_errors])
-        end
-
-        if settings.key?(:cool_off_time)
-          settings[:cool_off_time] = normalize_cool_off_time(settings[:cool_off_time])
-        end
-      end
-
-      private def transform_dependencies_settings!(settings)
-        if settings.key?(:traffic_control)
-          settings[:traffic_control] = apply_traffic_control_dsl(settings[:traffic_control])
-        end
-
-        if settings.key?(:traffic_recovery)
-          settings[:traffic_recovery] = apply_traffic_recovery_dsl(settings[:traffic_recovery])
-        end
+        config, dependencies = ConfigurationPipeline.process(
+          config_settings,
+          dependency_settings
+        )
+        LightBuilder.new(factory: self, config:, **dependencies).build
       end
 
-      private def normalize_array(value) = Array(value)
-      private def normalize_cool_off_time(value) = value.to_i
-
-      private def apply_traffic_control_dsl(traffic_control)
-        case traffic_control
-        in Domain::TrafficControl::Base
-          traffic_control
-        in :consecutive_errors
-          Domain::TrafficControl::ConsecutiveErrors.new
-        in :error_rate
-          Domain::TrafficControl::ErrorRate.new
-        in {error_rate: error_rate_settings}
-          Domain::TrafficControl::ErrorRate.new(**error_rate_settings)
-        else
-          raise Domain::Error::ConfigurationError, <<~ERROR
-            unsupported traffic_control strategy provided (`#{traffic_control}`). Supported options:
-              * :consecutive_errors
-              * :error_rate
-          ERROR
-        end
-      end
+      # @return [Stoplight::Error::ConfigurationError]
+      def validate_configuration!
+        config_settings = settings.slice(*CONFIG_KEYS)
+        dependency_settings = settings.slice(*DEPENDENCY_KEYS)
 
-      def apply_traffic_recovery_dsl(traffic_recovery)
-        case traffic_recovery
-        in Domain::TrafficRecovery::Base
-          traffic_recovery
-        in :consecutive_successes
-          Domain::TrafficRecovery::ConsecutiveSuccesses.new
-        else
-          raise Domain::Error::ConfigurationError, <<~ERROR
-            unsupported traffic_recovery strategy provided (`#{traffic_recovery}`). Supported options:
-              * :consecutive_successes
-          ERROR
-        end
+        ConfigurationPipeline.process(
+          config_settings,
+          dependency_settings
+        )
+        nil
       end
 
-      private def validate!
-        validate_traffic_control!(container.resolve(:traffic_control), container.resolve(:config))
-        validate_traffic_recovery!(container.resolve(:traffic_recovery), container.resolve(:config))
+      def ==(other)
+        other.is_a?(self.class) && other.settings == settings
       end
 
-      private def validate_traffic_control!(traffic_control, config)
-        traffic_control.check_compatibility(config).then do |compatibility_result|
-          if compatibility_result.incompatible?
-            raise Domain::Error::ConfigurationError.new(
-              "#{traffic_control.class.name} strategy is incompatible with the Stoplight configuration: #{compatibility_result.error_messages}"
-            )
-          end
-        end
-      end
+      alias_method :eql?, :==
 
-      private def validate_traffic_recovery!(traffic_recovery, config)
-        traffic_recovery.check_compatibility(config).then do |compatibility_result|
-          if compatibility_result.incompatible?
-            raise Domain::Error::ConfigurationError.new(
-              "#{traffic_recovery.class.name} strategy is incompatible with the Stoplight configuration: #{compatibility_result.error_messages}"
-            )
-          end
-        end
+      def hash
+        [self.class, settings].hash
       end
     end
   end

data/lib/stoplight/wiring/notifier_factory.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Stoplight
+  module Wiring
+    class NotifierFactory
+      class << self
+        # Wraps a notifier with fail-safe mechanisms.
+        #
+        # @param notifier [Stoplight::Domain::StateTransitionNotifier] The notifier to wrap.
+        # @param error_notifier [Proc] called when wrapped data store fails
+        # @return [Stoplight::Notifier::FailSafe] The original notifier if it is already
+        #   a +FailSafe+ instance, otherwise a new +FailSafe+ instance.
+        def create(notifier:, error_notifier:)
+          case notifier
+          in Infrastructure::Notifier::FailSafe if notifier.error_notifier == error_notifier
+            notifier
+          in Infrastructure::Notifier::FailSafe
+            Infrastructure::Notifier::FailSafe.new(notifier: notifier.notifier, error_notifier:)
+          else
+            Infrastructure::Notifier::FailSafe.new(notifier:, error_notifier:)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stoplight/wiring/public_api.rb

@@ -12,8 +12,9 @@ module Stoplight
 
       # Namespace aliases for data stores
       module DataStore
-        Redis = Infrastructure::DataStore::Redis
-        Memory = Infrastructure::DataStore::Memory
+        Base = Stoplight::Wiring::DataStore::Base
+        Redis = Stoplight::Wiring::DataStore::Redis
+        Memory = Stoplight::Wiring::DataStore::Memory
       end
 
       # Namespace aliases for notifiers

data/lib/stoplight.rb

@@ -55,8 +55,10 @@ module Stoplight # rubocop:disable Style/Documentation
         factory_builder = Wiring::DefaultFactoryBuilder.new
         yield factory_builder.configuration if block_given?
 
+        default_light_factory = factory_builder.build
+        default_light_factory.validate_configuration!
         @default_configuration = factory_builder.configuration
-        @default_light_factory = factory_builder.build
+        @default_light_factory = default_light_factory
       end
     end
 
@@ -67,7 +69,7 @@ module Stoplight # rubocop:disable Style/Documentation
     # @return [Stoplight::Light]
     # @api private
     def system_light(name, **settings)
-      Wiring::SystemLightFactory.build_with(name: "__stoplight__#{name}", **settings)
+      Wiring::LightFactory.new.with(name: "__stoplight__#{name}", **settings).build
     end
 
     # Create a Light with the user default configuration.
@@ -121,7 +123,6 @@ end
 # @param settings [Hash] Optional settings to configure the circuit breaker.
 #   @option settings [Numeric] :cool_off_time The time to wait before resetting the circuit breaker.
 #   @option settings [Stoplight::DataStore::Base] :data_store The data store to use for storing state.
-#   @option settings [Proc] :error_notifier A proc to handle error notifications.
 #   @option settings [Array<Stoplight::Notifier::Base>] :notifiers A list of notifiers to use.
 #   @option settings [Numeric] :threshold The failure threshold to trip the circuit breaker.
 #   @option settings [Numeric] :window_size The size of the rolling window for failure tracking.
@@ -161,5 +162,19 @@ end
 #   light = Stoplight("Payment API", traffic_control: :error_rate, threshold: 0.666, window_size: 300)
 #
 def Stoplight(name, **settings) # rubocop:disable Naming/MethodName
+  Stoplight::Common::Deprecations.deprecate(<<~MSG) if settings.include?(:error_notifier)
+    Passing "error_notifier" to Stoplight('#{name}') is deprecated and will be removed in v6.0.0.
+
+    IMPORTANT: The `error_notifier` is NOT called for exceptions in your protected code.
+    It only reports internal Stoplight failures (e.g., Redis connection errors).
+
+    To fix: Move `error_notifier` to global configuration:
+
+      Stoplight.configure do |config|
+        config.error_notifier = ->(error) { Logger.warn(error) }
+      end
+
+    See: https://github.com/bolshakov/stoplight#error-notifiers
+  MSG
   Stoplight.light(name, **settings)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stoplight
 version: !ruby/object:Gem::Version
-  version: 5.5.0
+  version: 5.7.0
 platform: ruby
 authors:
 - Cameron Desautels
@@ -25,6 +25,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: An implementation of the circuit breaker pattern.
 email:
 - camdez@gmail.com
@@ -47,6 +61,7 @@ files:
 - lib/stoplight/admin/actions/lock_all_green.rb
 - lib/stoplight/admin/actions/lock_green.rb
 - lib/stoplight/admin/actions/lock_red.rb
+- lib/stoplight/admin/actions/remove.rb
 - lib/stoplight/admin/actions/stats.rb
 - lib/stoplight/admin/actions/unlock.rb
 - lib/stoplight/admin/dependencies.rb
@@ -57,6 +72,7 @@ files:
 - lib/stoplight/admin/views/_card.erb
 - lib/stoplight/admin/views/index.erb
 - lib/stoplight/admin/views/layout.erb
+- lib/stoplight/common/deprecations.rb
 - lib/stoplight/domain/color.rb
 - lib/stoplight/domain/compatibility_result.rb
 - lib/stoplight/domain/config.rb
@@ -66,9 +82,14 @@ files:
 - 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/metrics.rb
+- lib/stoplight/domain/recovery_lock_token.rb
 - lib/stoplight/domain/state.rb
+- lib/stoplight/domain/state_snapshot.rb
 - lib/stoplight/domain/state_transition_notifier.rb
+- lib/stoplight/domain/storage/metrics.rb
+- lib/stoplight/domain/storage/recovery_lock.rb
+- lib/stoplight/domain/storage/state.rb
 - lib/stoplight/domain/strategies/green_run_strategy.rb
 - lib/stoplight/domain/strategies/red_run_strategy.rb
 - lib/stoplight/domain/strategies/run_strategy.rb
@@ -82,36 +103,54 @@ files:
 - 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/fail_safe.rb
 - lib/stoplight/infrastructure/data_store/memory.rb
+- lib/stoplight/infrastructure/data_store/memory/metrics.rb
+- lib/stoplight/infrastructure/data_store/memory/recovery_lock_store.rb
+- lib/stoplight/infrastructure/data_store/memory/recovery_lock_token.rb
 - lib/stoplight/infrastructure/data_store/memory/sliding_window.rb
+- lib/stoplight/infrastructure/data_store/memory/state.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/data_store/redis/lua_scripts/get_metrics.lua
+- lib/stoplight/infrastructure/data_store/redis/lua_scripts/record_failure.lua
+- lib/stoplight/infrastructure/data_store/redis/lua_scripts/record_recovery_probe_failure.lua
+- lib/stoplight/infrastructure/data_store/redis/lua_scripts/record_recovery_probe_success.lua
+- lib/stoplight/infrastructure/data_store/redis/lua_scripts/record_success.lua
+- lib/stoplight/infrastructure/data_store/redis/lua_scripts/release_lock.lua
+- lib/stoplight/infrastructure/data_store/redis/lua_scripts/transition_to_green.lua
+- lib/stoplight/infrastructure/data_store/redis/lua_scripts/transition_to_red.lua
+- lib/stoplight/infrastructure/data_store/redis/lua_scripts/transition_to_yellow.lua
+- lib/stoplight/infrastructure/data_store/redis/recovery_lock_store.rb
+- lib/stoplight/infrastructure/data_store/redis/recovery_lock_token.rb
+- lib/stoplight/infrastructure/data_store/redis/scripting.rb
+- lib/stoplight/infrastructure/notifier/fail_safe.rb
 - lib/stoplight/infrastructure/notifier/generic.rb
 - lib/stoplight/infrastructure/notifier/io.rb
 - lib/stoplight/infrastructure/notifier/logger.rb
+- lib/stoplight/infrastructure/storage/compatibility_metrics.rb
+- lib/stoplight/infrastructure/storage/compatibility_recovery_lock.rb
+- lib/stoplight/infrastructure/storage/compatibility_recovery_metrics.rb
+- lib/stoplight/infrastructure/storage/compatibility_state.rb
 - lib/stoplight/rspec.rb
 - lib/stoplight/rspec/generic_notifier.rb
 - lib/stoplight/version.rb
-- lib/stoplight/wiring/container.rb
+- lib/stoplight/wiring/data_store/base.rb
+- lib/stoplight/wiring/data_store/memory.rb
+- lib/stoplight/wiring/data_store/redis.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_builder.rb
 - lib/stoplight/wiring/light_factory.rb
+- lib/stoplight/wiring/light_factory/compatibility_validator.rb
+- lib/stoplight/wiring/light_factory/config_normalizer.rb
+- lib/stoplight/wiring/light_factory/configuration_pipeline.rb
+- lib/stoplight/wiring/light_factory/traffic_control_dsl.rb
+- lib/stoplight/wiring/light_factory/traffic_recovery_dsl.rb
+- lib/stoplight/wiring/notifier_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/infrastructure/data_store/redis/get_metadata.lua

@@ -1,38 +0,0 @@
-local number_of_metric_buckets = tonumber(ARGV[1])
-local number_of_recovery_buckets = tonumber(ARGV[2])
-local window_start_ts = tonumber(ARGV[3])
-local window_end_ts = tonumber(ARGV[4])
-local recovery_window_start_ts = tonumber(ARGV[5])
-
-local metadata_key = KEYS[1]
-
--- It possible that after a successful recovery, Stoplight still see metrics
--- that are older than the recovery window. To prevent this from happening,
--- we need to limit the start time of the window to the time of the last recovery.
-local recovered_at = redis.call('HGET', metadata_key, "recovered_at")
-if recovered_at then
-  window_start_ts = math.max(window_start_ts, tonumber(recovered_at))
-end
-
-local function count_events(start_idx, bucket_count, start_ts)
-  local total = 0
-  for idx = start_idx, start_idx + bucket_count - 1 do
-    total = total + tonumber(redis.call('ZCOUNT', KEYS[idx], start_ts, window_end_ts))
-  end
-  return total
-end
-
-local offset = 2
-local successes = count_events(2, number_of_metric_buckets, window_start_ts)
-
-offset = offset + number_of_metric_buckets
-local errors = count_events(offset, number_of_metric_buckets, window_start_ts)
-
-offset = offset + number_of_metric_buckets
-local recovery_probe_successes = count_events(offset, number_of_recovery_buckets, recovery_window_start_ts)
-
-offset = offset + number_of_recovery_buckets
-local recovery_probe_errors = count_events(offset, number_of_recovery_buckets, recovery_window_start_ts)
-
-local metadata = redis.call('HGETALL',  metadata_key)
-return {successes, errors, recovery_probe_successes, recovery_probe_errors, metadata}

data/lib/stoplight/infrastructure/data_store/redis/lua.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Stoplight
-  module Infrastructure
-    module DataStore
-      class Redis
-        # @api private
-        module Lua
-          class << self
-            def read_lua_file(name_without_extension)
-              File.read(File.join(__dir__, "#{name_without_extension}.lua"))
-            end
-          end
-
-          RECORD_FAILURE = read_lua_file("record_failure")
-          RECORD_SUCCESS = read_lua_file("record_success")
-          GET_METADATA = read_lua_file("get_metadata")
-          TRANSITION_TO_YELLOW = read_lua_file("transition_to_yellow")
-          TRANSITION_TO_RED = read_lua_file("transition_to_red")
-          TRANSITION_TO_GREEN = read_lua_file("transition_to_green")
-        end
-      end
-    end
-  end
-end