stoplight 5.7.0 → 5.8.0

data/sig/_private/stoplight/infrastructure/redis/storage/unbounded_metrics.rbs

@@ -0,0 +1,21 @@
+module Stoplight
+  module Infrastructure
+    module Redis
+      module Storage
+        class UnboundedMetrics < Metrics
+          attr_reader redis: redis
+          attr_reader scripting: Scripting
+          attr_reader metrics_key: String
+          attr_reader clock: Domain::_Clock
+
+          def initialize: (
+            redis: redis,
+            clock: Domain::_Clock,
+            scripting: Scripting,
+            key_space: KeySpace,
+          ) -> void
+        end
+      end
+    end
+  end
+end

data/sig/_private/stoplight/infrastructure/redis/storage/window_metrics.rbs

@@ -0,0 +1,34 @@
+module Stoplight
+  module Infrastructure
+    module Redis
+      module Storage
+        class WindowMetrics < Metrics
+          attr_reader config: Domain::Config
+          attr_reader redis: redis
+          attr_reader scripting: Scripting
+          attr_reader metrics_key: String
+          attr_reader clock: Domain::_Clock
+          attr_reader key_space: KeySpace
+          @window_size: Integer
+
+          def initialize: (
+            redis: redis,
+            scripting: Scripting,
+            config: Domain::Config,
+            clock: Domain::_Clock,
+            key_space: KeySpace
+          ) -> void
+
+          def bucket_key: (metric: Symbol, time: _ToI) -> String
+          def bucket_size: -> Integer
+          def bucket_ttl: -> Integer
+          def buckets_for_window: (metric: Symbol, window_end: _ToI) -> Array[String]
+          def successes_key: (time: _ToI) -> String
+          def errors_key: (time: _ToI) -> String
+          def failure_bucket_keys: (_ToI window_end) -> Array[String]
+          def success_bucket_keys: (_ToI window_end) -> Array[String]
+        end
+      end
+    end
+  end
+end

data/sig/_private/stoplight/infrastructure/storage/compatibility_metrics.rbs

@@ -0,0 +1,17 @@
+module Stoplight
+  module Infrastructure
+    module Storage
+      class CompatibilityMetrics
+        include Domain::_MetricsStore
+
+        private attr_reader data_store: Domain::_DataStore
+        private attr_reader config: Domain::Config
+
+        def initialize: (
+          data_store: Domain::_DataStore,
+          config: Domain::Config,
+        ) -> void
+      end
+    end
+  end
+end

data/sig/_private/stoplight/infrastructure/storage/compatibility_recovery_lock.rbs

@@ -0,0 +1,13 @@
+module Stoplight
+  module Infrastructure
+    module Storage
+      class CompatibilityRecoveryLock
+        include Domain::_RecoveryLockStore
+        private attr_reader data_store: Domain::_DataStore
+        private attr_reader config: Domain::Config
+
+        def initialize: (data_store: Domain::_DataStore, config: Domain::Config) -> void
+      end
+    end
+  end
+end

data/sig/_private/stoplight/infrastructure/storage/compatibility_recovery_metrics.rbs

@@ -0,0 +1,14 @@
+module Stoplight
+  module Infrastructure
+    module Storage
+      class CompatibilityRecoveryMetrics
+        include Domain::_MetricsStore
+
+        private attr_reader data_store: Domain::_DataStore
+        private attr_reader config: Domain::Config
+
+        def initialize: (data_store: Domain::_DataStore, config: Domain::Config) -> void
+      end
+    end
+  end
+end

data/sig/_private/stoplight/infrastructure/storage/compatibility_state.rbs

@@ -0,0 +1,14 @@
+module Stoplight
+  module Infrastructure
+    module Storage
+      class CompatibilityState
+        include Domain::_StateStore
+
+        private attr_reader data_store: Domain::_DataStore
+        private attr_reader config: Domain::Config
+
+        def initialize: (data_store: Domain::_DataStore, config: Domain::Config) -> void
+      end
+    end
+  end
+end

data/sig/_private/stoplight/infrastructure/system_clock.rbs

@@ -0,0 +1,7 @@
+module Stoplight
+  module Infrastructure
+    class SystemClock
+      include Domain::_Clock
+    end
+  end
+end

data/sig/_private/stoplight/system/light_builder.rbs

@@ -0,0 +1,23 @@
+module Stoplight
+  module Wiring
+    class System
+      class LightBuilder < Wiring::LightBuilder
+        attr_reader system: System
+
+        @failover_system: _System
+        @storage_set: StorageSet
+        @key_space: Infrastructure::Redis::Storage::KeySpace
+
+        def initialize: (config: Domain::Config, factory: Domain::_LightFactory, system: System) -> void
+
+        def key_space: -> Infrastructure::Redis::Storage::KeySpace
+
+        private def redis: -> redis
+        private def storage_scripting: -> Infrastructure::Redis::Storage::Scripting
+        private def failover_system: -> _System
+        private def storage_set: -> StorageSet
+        private def build_backend: -> DataStoreBackend
+      end
+    end
+  end
+end

data/sig/_private/stoplight/system/light_factory.rbs

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Stoplight
+  module Wiring
+    class System
+      class LightFactory < Wiring::LightFactory
+        class InternalLightFactory
+          include Domain::_LightFactory
+        end
+
+        attr_reader system: System
+
+        def initialize: (system: System, config: Domain::Config) -> void
+      end
+    end
+  end
+end

data/sig/_private/stoplight/types.rbs

@@ -0,0 +1,6 @@
+module Stoplight
+  module Types
+    def self.undefined: -> Undefined
+    def self.must: [T < Object] (T? value) -> T
+  end
+end

data/sig/_private/stoplight/wiring/config_compatibility_validator.rbs

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Stoplight
+  module Wiring
+    class ConfigCompatibilityValidator
+      attr_reader config: Domain::Config
+
+      def self.call: (config: Domain::Config) -> Domain::Config
+
+      def initialize: (config: Domain::Config) -> void
+      def call: -> Domain::Config
+
+      private
+
+      def validate_traffic_control!: -> void
+      def validate_traffic_recovery!: -> void
+    end
+  end
+end

data/sig/_private/stoplight/wiring/configuration_dsl.rbs

@@ -0,0 +1,43 @@
+module Stoplight
+  module Wiring
+    class ConfigurationDsl
+      @tracked_errors: optional[Array[_ExceptionMatcher] | _ExceptionMatcher]
+      @skipped_errors: optional[Array[_ExceptionMatcher] | _ExceptionMatcher]
+      @traffic_control: optional[traffic_control]
+      @traffic_recovery: optional[traffic_recovery]
+
+      def initialize: (
+        ?name: optional[String],
+        ?cool_off_time: optional[duration],
+        ?threshold: optional[percentage | Integer],
+        ?recovery_threshold: optional[Integer],
+        ?window_size: optional[duration?],
+        ?tracked_errors: optional[Array[_ExceptionMatcher] | _ExceptionMatcher],
+        ?skipped_errors: optional[Array[_ExceptionMatcher] | _ExceptionMatcher],
+        ?data_store: optional[data_store],
+        ?error_notifier: optional[error_notifier],
+        ?notifiers: optional[Array[state_transition_notifier]],
+        ?traffic_control: optional[traffic_control],
+        ?traffic_recovery: optional[traffic_recovery],
+      ) -> void
+
+      def configure!: (Domain::Config default_config) -> Domain::Config
+
+      private
+
+      attr_reader name: optional[String]
+      attr_reader cool_off_time: optional[duration]
+      attr_reader threshold: optional[percentage | Integer]
+      attr_reader recovery_threshold: optional[Integer]
+      attr_reader window_size: optional[duration?]
+      attr_reader data_store: optional[data_store]
+      attr_reader error_notifier: optional[error_notifier]
+      attr_reader notifiers: optional[Array[state_transition_notifier]]
+
+      def tracked_errors: -> optional[Array[_ExceptionMatcher]]
+      def skipped_errors: -> optional[Array[_ExceptionMatcher]]
+      def traffic_control: -> optional[Domain::_TrafficControl]
+      def traffic_recovery: -> optional[Domain::_TrafficRecovery]
+    end
+  end
+end

data/sig/_private/stoplight/wiring/data_store_backend.rbs

@@ -0,0 +1,11 @@
+module Stoplight
+  module Wiring
+    class DataStoreBackend
+      def windowed_metrics_store: -> Domain::_MetricsStore
+      def unbounded_metrics_store: -> Domain::_MetricsStore
+      def recovery_metrics_store: -> Domain::_MetricsStore
+      def state_store: -> Domain::_StateStore
+      def recovery_lock_store: -> Domain::_RecoveryLockStore
+    end
+  end
+end

data/sig/_private/stoplight/wiring/default.rbs

@@ -0,0 +1,26 @@
+module Stoplight
+  module Wiring
+    module Default
+      COOL_OFF_TIME: duration
+
+      DATA_STORE: data_store
+
+      ERROR_NOTIFIER: error_notifier
+
+      FORMATTER: notification_formatter
+
+      NOTIFIERS: Array[state_transition_notifier]
+
+      THRESHOLD: percentage | Integer
+      RECOVERY_THRESHOLD: Integer
+
+      WINDOW_SIZE: duration?
+
+      TRACKED_ERRORS: Array[_ExceptionMatcher]
+      SKIPPED_ERRORS: Array[_ExceptionMatcher]
+
+      TRAFFIC_CONTROL: Domain::_TrafficControl
+      TRAFFIC_RECOVERY: Domain::_TrafficRecovery
+    end
+  end
+end

data/{lib/stoplight/wiring/data_store/memory.rb → sig/_private/stoplight/wiring/default_config.rbs}

@@ -2,9 +2,6 @@
 
 module Stoplight
   module Wiring
-    module DataStore
-      class Memory < Base
-      end
-    end
+    DefaultConfig: Domain::Config
   end
 end

data/sig/_private/stoplight/wiring/default_configuration.rbs

@@ -0,0 +1,29 @@
+module Stoplight
+  module Wiring
+    class DefaultConfiguration
+      include _Configuration
+
+      @config: Domain::Config
+      @cool_off_time: optional[duration]
+      @threshold: optional[percentage | Integer]
+      @recovery_threshold: optional[Integer]
+      @window_size: optional[duration?]
+      @tracked_errors: optional[Array[_ExceptionMatcher] | _ExceptionMatcher]
+      @skipped_errors: optional[Array[_ExceptionMatcher] | _ExceptionMatcher]
+      @traffic_control: optional[traffic_control]
+      @traffic_recovery: optional[traffic_recovery]
+      @error_notifier: optional[error_notifier]
+      @data_store: optional[data_store]
+      @notifiers: optional[Array[state_transition_notifier]]
+
+      def to_config!: -> Domain::Config
+
+      private
+
+      def tracked_errors: -> optional[Array[_ExceptionMatcher]]
+      def skipped_errors: -> optional[Array[_ExceptionMatcher]]
+      def traffic_control: -> optional[Domain::_TrafficControl]
+      def traffic_recovery: -> optional[Domain::_TrafficRecovery]
+    end
+  end
+end

data/sig/_private/stoplight/wiring/light_builder.rbs

@@ -0,0 +1,48 @@
+module Stoplight
+  module Wiring
+    class LightBuilder
+      FAILOVER_DATA_STORE_CONFIG: Stoplight::DataStore::Memory
+      MEMORY_REGISTRY: Concurrent::Map[Integer, Infrastructure::Memory::DataStore]
+
+      attr_reader data_store_config: data_store
+      attr_reader error_notifier: error_notifier
+      attr_reader factory: Domain::_LightFactory
+      attr_reader clock: Domain::_Clock
+
+      attr_reader traffic_recovery: Domain::_TrafficRecovery
+      attr_reader traffic_control: Domain::_TrafficControl
+      attr_reader config: Domain::Config
+
+      @notifiers: Array[state_transition_notifier]
+      @name: String
+      @cool_off_time: duration
+      @error_tracking_policy: Domain::ErrorTrackingPolicy
+
+      def initialize: (config: Domain::Config, factory: Domain::_LightFactory) -> void
+
+      def build: -> Domain::Light
+
+      def state_store: -> Domain::_StateStore
+      def notifiers: -> Array[state_transition_notifier]
+      def redis_recovery_lock_store: -> Infrastructure::Redis::DataStore::RecoveryLockStore
+      def scripting: -> Infrastructure::Redis::DataStore::Scripting
+
+      def memory_recovery_lock_store: -> Infrastructure::Memory::DataStore::RecoveryLockStore
+      def failover_data_store: -> Domain::_DataStore
+      def data_store: -> Domain::_DataStore
+
+      def metrics_store: -> Domain::_MetricsStore
+      def recovery_lock_store: -> Domain::_RecoveryLockStore
+      def request_tracker: -> Domain::Tracker::Request
+      def recovery_probe_tracker: -> Domain::Tracker::RecoveryProbe
+      def recovery_metrics_store: -> Domain::_MetricsStore
+
+      def green_run_strategy: -> Domain::Strategies::GreenRunStrategy
+      def yellow_run_strategy: -> Domain::Strategies::YellowRunStrategy
+      def red_run_strategy: -> Domain::Strategies::RedRunStrategy
+      def create_data_store: (data_store) -> Domain::_DataStore
+      def memory_registry: -> Concurrent::Map[Integer, Infrastructure::Memory::DataStore]
+      def redis: -> redis
+    end
+  end
+end

data/sig/_private/stoplight/wiring/light_factory/traffic_control_dsl.rbs

@@ -0,0 +1,7 @@
+module Stoplight
+  module Wiring
+    class LightFactory
+      TrafficControlDsl: ^(traffic_control | Domain::_TrafficControl) -> Domain::_TrafficControl
+    end
+  end
+end

data/sig/_private/stoplight/wiring/light_factory/traffic_recovery_dsl.rbs

@@ -0,0 +1,7 @@
+module Stoplight
+  module Wiring
+    class LightFactory
+      TrafficRecoveryDsl: ^(traffic_recovery | Domain::_TrafficRecovery) -> Domain::_TrafficRecovery
+    end
+  end
+end

data/sig/_private/stoplight/wiring/light_factory.rbs

@@ -0,0 +1,16 @@
+module Stoplight
+  module Wiring
+    class LightFactory
+      include Domain::_LightFactory
+      attr_reader config: Domain::Config
+
+      def initialize: (config: Domain::Config) -> void
+
+      def eql: (untyped other) -> bool
+      def hash: -> Integer
+
+      def light_builder: (config: Domain::Config) -> LightBuilder
+      def light_factory: -> Domain::_LightFactory
+    end
+  end
+end

data/sig/_private/stoplight/wiring/memory/backend.rbs

@@ -0,0 +1,26 @@
+module Stoplight
+  module Wiring
+    module Memory
+      class Backend < DataStoreBackend
+        @clock: Domain::_Clock
+        @config: Domain::Config
+        @state_store: Infrastructure::Memory::Storage::State
+        @recovery_lock_store: Infrastructure::Memory::Storage::RecoveryLock
+        @recovery_metrics_store: Infrastructure::Memory::Storage::RecoveryMetrics
+        @windowed_metrics_store: Infrastructure::Memory::Storage::WindowMetrics
+        @unbounded_metrics_store: Infrastructure::Memory::Storage::UnboundedMetrics
+
+        def initialize: (
+            clock: Domain::_Clock,
+            config: Domain::Config
+          ) -> void
+
+        def state_stare: -> Infrastructure::Memory::Storage::State
+        def recovery_lock_store: -> Infrastructure::Memory::Storage::RecoveryLock
+        def recovery_metrics_store: -> Infrastructure::Memory::Storage::RecoveryMetrics
+        def windowed_metrics_store: -> Infrastructure::Memory::Storage::WindowMetrics
+        def unbounded_metrics_store: -> Infrastructure::Memory::Storage::UnboundedMetrics
+      end
+    end
+  end
+end

data/sig/_private/stoplight/wiring/notifier_factory.rbs

@@ -0,0 +1,10 @@
+module Stoplight
+  module Wiring
+    class NotifierFactory
+      def self.create: (
+        notifier: _StateTransitionNotifier,
+        error_notifier: error_notifier,
+      ) -> _StateTransitionNotifier
+    end
+  end
+end

data/sig/_private/stoplight/wiring/redis/backend.rbs

@@ -0,0 +1,38 @@
+module Stoplight
+  module Wiring
+    module Redis
+      class Backend < DataStoreBackend
+        @redis: redis
+        @scripting: Infrastructure::Redis::Storage::Scripting
+        @key_space: Infrastructure::Redis::Storage::KeySpace
+        @config: Domain::Config
+        @error_notifier: error_notifier
+        @failover_light: Domain::Light
+        @clock: Domain::_Clock
+
+        @memory_fallback: Memory::Backend
+        @state_store: Infrastructure::FailSafe::Storage::State
+        @recovery_lock_store: Infrastructure::FailSafe::Storage::RecoveryLock
+        @recovery_metrics_store: Infrastructure::FailSafe::Storage::Metrics
+        @windowed_metrics_store: Infrastructure::FailSafe::Storage::Metrics
+        @unbounded_metrics_store: Infrastructure::FailSafe::Storage::Metrics
+
+        def initialize: (
+          redis: redis,
+          scripting: Infrastructure::Redis::Storage::Scripting,
+          key_space: Infrastructure::Redis::Storage::KeySpace,
+          config: Domain::Config,
+          error_notifier: error_notifier,
+          failover_light: Domain::Light,
+          clock: Domain::_Clock,
+          ) -> void
+
+        def state_stare: -> Infrastructure::FailSafe::Storage::State
+        def recovery_lock_store: -> Infrastructure::FailSafe::Storage::RecoveryLock
+        def recovery_metrics_store: -> Infrastructure::FailSafe::Storage::Metrics
+        def windowed_metrics_store: -> Infrastructure::FailSafe::Storage::Metrics
+        def unbounded_metrics_store: -> Infrastructure::FailSafe::Storage::Metrics
+      end
+    end
+  end
+end

data/sig/_private/stoplight/wiring/storage_set.rbs

@@ -0,0 +1,38 @@
+module Stoplight
+  module Wiring
+    # Immutable container for all storage components required by a Light.
+    #
+    # StorageSet groups the four storage interfaces that a circuit breaker needs:
+    # metrics tracking, recovery metrics, state persistence, and recovery locking.
+    # This allows the storage layer to be constructed once and passed as a unit,
+    # making dependencies explicit and simplifying Light construction.
+    #
+    # @example
+    #   storage_set = StorageSetBuilder.new(backend:, windowed: true).build
+    #   storage_set.metrics_store      #=> WindowMetrics instance
+    #   storage_set.state_store        #=> State instance
+    #
+    # @see StorageSetBuilder
+    # @api private
+    class StorageSet < Data
+      attr_reader metrics_store: Domain::_MetricsStore
+      attr_reader recovery_metrics_store: Domain::_MetricsStore
+      attr_reader state_store: Domain::_StateStore
+      attr_reader recovery_lock_store: Domain::_RecoveryLockStore
+
+      def self.new: (
+        metrics_store: Domain::_MetricsStore,
+        recovery_metrics_store: Domain::_MetricsStore,
+        state_store: Domain::_StateStore,
+        recovery_lock_store: Domain::_RecoveryLockStore
+      ) -> instance
+
+      def initialize: (
+          metrics_store: Domain::_MetricsStore,
+          recovery_metrics_store: Domain::_MetricsStore,
+          state_store: Domain::_StateStore,
+          recovery_lock_store: Domain::_RecoveryLockStore
+        ) -> void
+    end
+  end
+end

data/sig/_private/stoplight/wiring/storage_set_builder.rbs

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Stoplight
+  module Wiring
+    class StorageSetBuilder
+      attr_reader backend: DataStoreBackend
+      attr_reader windowed: bool
+
+      def initialize: (backend: DataStoreBackend, windowed: bool) -> void
+
+      def build: -> StorageSet
+      def metrics_store: -> Domain::_MetricsStore
+    end
+  end
+end

data/sig/_private/stoplight/wiring/system.rbs

@@ -0,0 +1,15 @@
+module Stoplight
+  module Wiring
+    class System
+      include _System
+
+      @name: String
+
+      attr_reader light_factory: Domain::_LightFactory
+      attr_reader lights: Concurrent::Map[String, [_Light, Domain::Config]]
+      attr_reader system_config: Domain::Config
+
+      def initialize: (config: Domain::Config) -> void
+    end
+  end
+end

data/sig/_private/stoplight.rbs

@@ -0,0 +1,48 @@
+module Stoplight
+  T: singleton(Types)
+  CONFIG_MUTEX: Mutex
+
+  self.@configured:  bool?
+  self.@default_config: Domain::Config?
+  self.@systems: Concurrent::Map[String, _System]
+  self.@default_light_factory: Wiring::LightFactory?
+
+  def self.warn_if_reconfiguring: (bool) { () -> void } -> void
+  def self.configured?: -> bool
+  def self.__stoplight__reset!: -> void
+
+  def self.system_light: (
+      String name,
+      ?cool_off_time: optional[duration],
+      ?threshold: optional[percentage | Integer],
+      ?recovery_threshold: optional[Integer],
+      ?window_size: optional[duration?],
+      ?tracked_errors: optional[Array[_ExceptionMatcher]],
+      ?skipped_errors: optional[Array[_ExceptionMatcher]],
+      ?data_store: optional[data_store],
+      ?error_notifier: optional[error_notifier],
+      ?notifiers: optional[Array[state_transition_notifier]],
+      ?traffic_control: optional[traffic_control],
+      ?traffic_recovery: optional[traffic_recovery],
+    ) -> Domain::Light
+
+  def self.systems: -> Concurrent::Map[String, _System]
+  def self.default_config: -> Domain::Config
+  def self.ensure_configured: -> void
+  def self.__stoplight__system: (
+      _ToS name,
+      ?cool_off_time: optional[duration],
+      ?threshold: optional[percentage | Integer],
+      ?recovery_threshold: optional[Integer],
+      ?window_size: optional[duration?],
+      ?tracked_errors: optional[Array[_ExceptionMatcher]],
+      ?skipped_errors: optional[Array[_ExceptionMatcher]],
+      ?data_store: optional[data_store],
+      ?error_notifier: optional[error_notifier],
+      ?notifiers: optional[Array[state_transition_notifier]],
+      ?traffic_control: optional[traffic_control],
+      ?traffic_recovery: optional[traffic_recovery],
+    ) -> _System
+  def self.__stoplight__default_configuration: -> Domain::Config
+  def self.__stoplight__default_light_factory: -> Wiring::LightFactory
+end

data/sig/stoplight/color.rbs

@@ -0,0 +1,7 @@
+module Stoplight
+  module Color
+    GREEN: green
+    YELLOW: yellow
+    RED: red
+  end
+end

data/sig/stoplight/data_store.rbs

@@ -0,0 +1,19 @@
+module Stoplight
+  module DataStore
+    # Configuration for Redis-backed Stoplight storage.
+    #
+    # @note This is a configuration object, not the storage implementation itself.
+    class Redis < Base
+      attr_reader redis: redis
+      attr_reader warn_on_clock_skew: bool
+
+      def initialize: (redis, ?warn_on_clock_skew: bool) -> void
+    end
+
+    # Configuration for Memory-backed Stoplight storage.
+    #
+    # @note This is a configuration object, not the storage implementation itself.
+    class Memory < Base
+    end
+  end
+end

data/sig/stoplight/error.rbs

@@ -0,0 +1,20 @@
+module Stoplight
+  module Error
+    class Base < StandardError
+    end
+
+    class ConfigurationError < Base
+    end
+
+    class IncorrectColor < Base
+    end
+
+    class RedLight < Base
+      attr_reader light_name: String
+      attr_reader cool_off_time: Numeric
+      attr_reader retry_after: Time?
+
+      def initialize: (String light_name, cool_off_time: Numeric, retry_after: Time?) -> void
+    end
+  end
+end

data/sig/stoplight/notifier.rbs

@@ -0,0 +1,11 @@
+module Stoplight
+  module Notifier
+    class Base
+      include _StateTransitionNotifier
+    end
+
+    module Generic = Infrastructure::Notifier::Generic
+    class IO = Infrastructure::Notifier::IO
+    class Logger = Infrastructure::Notifier::Logger
+  end
+end