stoplight 5.8.3 → 6.0.0.rc2

data/sig/stoplight/generators/rails_generators_base.rbs

@@ -0,0 +1,11 @@
+# Minimal stand-in for `Rails::Generators::Base` so InstallGenerator's signature resolves for
+# consumers that depend on this gem's sig/ without depending on Rails themselves (e.g. via a
+# git Gemfile source, which loads the whole sig/ tree). Real Rails apps get the full definition
+# from rbs-rails; RBS merges declarations of the same class across files, so this is harmless
+# there too.
+module Rails
+  module Generators
+    class Base
+    end
+  end
+end

data/sig/stoplight/infrastructure/config_serializer.rbs

@@ -0,0 +1,12 @@
+module Stoplight
+  module Infrastructure
+    class ConfigSerializer
+      def self.call: (Domain::Config)-> Hash[String, untyped]
+
+      private
+
+      def self.serialize_traffic_control: (Domain::_TrafficControl) -> String
+      def self.serialize_traffic_recovery: (Domain::_TrafficRecovery) -> String
+    end
+  end
+end

data/sig/stoplight/infrastructure/fail_safe/error_notifier.rbs

@@ -0,0 +1,13 @@
+module Stoplight
+  module Infrastructure
+    module FailSafe
+      class ErrorNotifier
+        include Domain::_ErrorNotifier
+
+        attr_reader error_notifier: Domain::error_notifier
+
+        def initialize: (error_notifier: Domain::error_notifier) -> void
+      end
+    end
+  end
+end

data/sig/{_private/stoplight → stoplight}/infrastructure/fail_safe/storage/metrics.rbs

@@ -6,13 +6,13 @@ module Stoplight
           include Domain::_MetricsStore
 
           attr_reader primary_store: Domain::_MetricsStore
-          attr_reader error_notifier: error_notifier
+          attr_reader error_notifier: Domain::error_notifier
           attr_reader failover_store: Domain::_MetricsStore
           attr_reader circuit_breaker: Domain::Light
 
           def initialize: (
             primary_store: Domain::_MetricsStore,
-            error_notifier: error_notifier,
+            error_notifier: Domain::error_notifier,
             failover_store: Domain::_MetricsStore,
             circuit_breaker: Domain::Light
           ) -> void

data/sig/{_private/stoplight → stoplight}/infrastructure/fail_safe/storage/recovery_lock.rbs

@@ -4,13 +4,13 @@ module Stoplight
       module Storage
         class RecoveryLock
           attr_reader primary_store: Domain::_RecoveryLockStore
-          attr_reader error_notifier: error_notifier
+          attr_reader error_notifier: Domain::error_notifier
           attr_reader failover_store: Domain::_RecoveryLockStore
           attr_reader circuit_breaker: Domain::Light
 
           def initialize: (
             primary_store: Domain::_RecoveryLockStore,
-            error_notifier: error_notifier,
+            error_notifier: Domain::error_notifier,
             failover_store: Domain::_RecoveryLockStore,
             circuit_breaker: Domain::Light
           ) -> void

data/sig/stoplight/infrastructure/fail_safe/storage/registry.rbs

@@ -0,0 +1,23 @@
+module Stoplight
+  module Infrastructure
+    module FailSafe
+      module Storage
+        class Registry
+          include Domain::_Registry
+
+          @primary_registry: Domain::_Registry
+          @error_notifier: Domain::error_notifier
+          @failover_registry: Domain::_Registry
+          @circuit_breaker: Domain::Light
+
+          def initialize: (
+            primary_registry: Domain::_Registry,
+            error_notifier: Domain::error_notifier,
+            failover_registry: Domain::_Registry,
+            circuit_breaker: Domain::Light
+          ) -> void
+        end
+      end
+    end
+  end
+end

data/sig/{_private/stoplight → stoplight}/infrastructure/fail_safe/storage/state.rbs

@@ -6,15 +6,15 @@ module Stoplight
           include Domain::_StateStore
 
           attr_reader primary_store: Domain::_StateStore
-          attr_reader error_notifier: error_notifier
+          attr_reader error_notifier: Domain::error_notifier
           attr_reader failover_store: Domain::_StateStore
-          attr_reader circuit_breaker: _Light
+          attr_reader circuit_breaker: Domain::Light
 
           def initialize: (
             primary_store: Domain::_StateStore,
-            error_notifier: error_notifier,
+            error_notifier: Domain::error_notifier,
             failover_store: Domain::_StateStore,
-            circuit_breaker: _Light,
+            circuit_breaker: Domain::Light,
           ) -> void
 
           def fallback: [T] { () -> T } -> ^(StandardError?) -> T

data/sig/stoplight/infrastructure/memory/storage/registry.rbs

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Stoplight
+  module Infrastructure
+    module Memory
+      module Storage
+        class Registry
+          include Domain::_Registry
+        end
+      end
+    end
+  end
+end

data/sig/{_private/stoplight → stoplight}/infrastructure/memory/storage/state.rbs

@@ -5,16 +5,16 @@ module Stoplight
         class State
           include Domain::_StateStore
 
-          attr_accessor locked_state: state
+          attr_accessor locked_state: Domain::state
           attr_accessor recovered_at: Time?
           attr_accessor recovery_scheduled_after: Time?
           attr_accessor recovery_started_at: Time?
           attr_accessor breached_at: Time?
           attr_reader mutex: Mutex
           attr_reader clock: Domain::_Clock
-          attr_reader cool_off_time: timestamp
+          attr_reader cool_off_time: Domain::duration_seconds
 
-          def initialize: (clock: Domain::_Clock, cool_off_time: timestamp) -> void
+          def initialize: (clock: Domain::_Clock, cool_off_time: Domain::duration_seconds) -> void
 
           def transition_to_green: -> bool
 

data/sig/{_private/stoplight → stoplight}/infrastructure/memory/storage/unbounded_metrics.rbs

@@ -5,19 +5,19 @@ module Stoplight
         class UnboundedMetrics
           include Domain::_MetricsStore
 
-          attr_accessor consecutive_errors: Integer
-          attr_accessor consecutive_successes: Integer
-          attr_accessor last_error: Domain::Failure?
-          attr_accessor last_success_at: Time?
-
-          attr_reader mutex: Mutex
-          attr_reader clock: Domain::_Clock
+          @consecutive_errors: Integer
+          @consecutive_successes: Integer
+          @last_error: Domain::Failure?
+          @last_success_at: Time?
+          @mutex: Mutex
+          @clock: Domain::_Clock
 
           def initialize: (clock: Domain::_Clock) -> void
 
           def last_error_at: -> Time?
 
           private def initialize_metrics: -> void
+          private def build_metrics_snapshot: -> Domain::MetricsSnapshot
         end
       end
     end

data/sig/stoplight/infrastructure/memory/storage/window_metrics/sliding_window.rbs

@@ -0,0 +1,27 @@
+module Stoplight
+  module Infrastructure
+    module Memory
+      module Storage
+        class WindowMetrics
+          class SlidingWindow
+            @buckets: Hash[Integer, Integer]
+            @running_sum: Integer
+            @evicted_through: Integer?
+            @clock: Domain::_Clock
+            @window_size: Domain::duration_seconds
+
+            def initialize: (clock: Domain::_Clock, window_size: Domain::duration_seconds) -> void
+
+            def increment: -> void
+
+            def sum_in_window: -> Integer
+
+            private def slide_window!: (Float window_start) -> void
+
+            def inspect: -> String
+          end
+        end
+      end
+    end
+  end
+end

data/sig/{_private/stoplight → stoplight}/infrastructure/memory/storage/window_metrics.rbs

@@ -5,20 +5,20 @@ module Stoplight
         class WindowMetrics
           include Domain::_MetricsStore
 
-          attr_reader mutex: Mutex
-          attr_reader clock: Domain::_Clock
-
-          @window_size: duration
+          @mutex: Mutex
+          @clock: Domain::_Clock
+          @window_size: Domain::duration_seconds
           @consecutive_errors: Integer
           @consecutive_successes: Integer
           @last_error: Domain::Failure?
           @last_success_at: Time?
-          @successes: Infrastructure::Memory::DataStore::SlidingWindow
-          @errors: Infrastructure::Memory::DataStore::SlidingWindow
+          @successes: SlidingWindow
+          @errors: SlidingWindow
 
-          def initialize: (window_size: duration, clock: Domain::_Clock) -> void
+          def initialize: (window_size: Domain::duration_seconds, clock: Domain::_Clock) -> void
 
           def initialize_metrics: -> void
+          def build_metrics_snapshot: () -> Domain::MetricsSnapshot
         end
       end
     end

data/sig/stoplight/infrastructure/notifier/fail_safe.rbs

@@ -0,0 +1,15 @@
+module Stoplight
+  module Infrastructure
+    module Notifier
+      class FailSafe
+        include Domain::_StateTransitionNotifier
+
+        attr_reader notifier: Domain::_StateTransitionNotifier
+        attr_reader error_notifier: Domain::error_notifier
+        attr_reader circuit_breaker: Domain::Light
+
+        def initialize: (notifier: Domain::_StateTransitionNotifier, error_notifier: Domain::error_notifier, circuit_breaker: Domain::Light) -> void
+      end
+    end
+  end
+end

data/sig/{_private/stoplight → stoplight}/infrastructure/notifier/generic.rbs

@@ -9,7 +9,7 @@ module Stoplight
 
         def initialize: (T object, ?notification_formatter? formatter) -> void
 
-        def notify: (Domain::Config light, color, color, StandardError?) -> String
+        def notify: (Domain::LightInfo light, Domain::color, Domain::color, StandardError?) -> String
 
         private def put: (String) -> void
       end

data/sig/{_private/stoplight → stoplight}/infrastructure/notifier/io.rbs

@@ -2,7 +2,7 @@ module Stoplight
   module Infrastructure
     module Notifier
       class IO
-        include _StateTransitionNotifier
+        include Domain::_StateTransitionNotifier
         include Generic[::IO]
 
         def io: -> ::IO

data/sig/{_private/stoplight → stoplight}/infrastructure/notifier/logger.rbs

@@ -2,7 +2,7 @@ module Stoplight
   module Infrastructure
     module Notifier
       class Logger
-        include _StateTransitionNotifier
+        include Domain::_StateTransitionNotifier
         include Generic[::Logger]
 
         def logger: -> ::Logger

data/sig/stoplight/infrastructure/redis/key.rbs

@@ -0,0 +1,10 @@
+module Stoplight
+  module Infrastructure
+    module Redis
+      class Key < String
+        def initialize: (*String) -> void
+        def join: (*String) -> Key
+      end
+    end
+  end
+end

data/sig/{_private/stoplight → stoplight}/infrastructure/redis/storage/recovery_lock.rbs

@@ -8,13 +8,13 @@ module Stoplight
           attr_reader config: Domain::Config
           attr_reader redis: redis
           attr_reader scripting: Scripting
-          attr_reader key_space: KeySpace
+          attr_reader key_space: Key
 
           def initialize: (
             config: Domain::Config,
             redis: redis,
             scripting: Scripting,
-            key_space: KeySpace
+            key_space: Key
           ) -> void
 
           def lock_key: -> String

data/sig/stoplight/infrastructure/redis/storage/registry.rbs

@@ -0,0 +1,27 @@
+module Stoplight
+  module Infrastructure
+    module Redis
+      module Storage
+        class Registry
+          include Domain::_Registry
+
+          @redis: redis
+          @key_space: Key
+          @clock: Domain::_Clock
+          @config_serializer: singleton(ConfigSerializer)
+
+          def initialize: (
+              redis: redis,
+              key_space: Key,
+              clock: Domain::_Clock,
+              config_serializer: singleton(ConfigSerializer),
+            ) -> void
+
+          private
+
+          def key: () -> String
+        end
+      end
+    end
+  end
+end

data/sig/stoplight/infrastructure/redis/storage/scripting.rbs

@@ -0,0 +1,34 @@
+module Stoplight
+  module Infrastructure
+    module Redis
+      module Storage
+        class Scripting
+          SCRIPTS_ROOT: String
+
+          INCLUDE_DIRECTIVE: Regexp
+
+          def self.default_scripts_path: -> Array[String]
+
+          @scripts_path: Array[String]
+          @shas: Hash[String, String]
+          @redis: redis
+
+          def initialize: (
+              redis: redis,
+              ?scripts_path: Array[String],
+            ) -> void
+
+          def call: (
+              String script_name,
+              ?keys: Array[_ToS],
+              ?args: Array[_ToS]
+            ) -> untyped
+
+          private def reload_script: (String script_name) -> void
+
+          private def resolve_source: (String script_name) -> String
+        end
+      end
+    end
+  end
+end

data/sig/{_private/stoplight → stoplight}/infrastructure/redis/storage/state.rbs

@@ -7,17 +7,17 @@ module Stoplight
 
           attr_reader redis: redis
           attr_reader scripting: Scripting
-          attr_reader key_space: KeySpace
+          attr_reader key_space: Key
           attr_reader clock: Domain::_Clock
-          attr_reader cool_off_time: timestamp
+          attr_reader cool_off_time: Domain::timestamp
           attr_reader state_key: String
 
           def initialize: (
             clock: Domain::_Clock,
             redis: redis,
             scripting: Scripting,
-            key_space: KeySpace,
-            cool_off_time: timestamp
+            key_space: Key,
+            cool_off_time: Domain::timestamp
           ) -> void
 
           def transition_to_green: -> bool

data/sig/{_private/stoplight → stoplight}/infrastructure/redis/storage/unbounded_metrics.rbs

@@ -12,8 +12,15 @@ module Stoplight
             redis: redis,
             clock: Domain::_Clock,
             scripting: Scripting,
-            key_space: KeySpace,
+            key_space: Key,
           ) -> void
+
+          private def build_metrics_snapshot: (
+            consecutive_errors: String,
+            consecutive_successes: String,
+            last_error_json: String?,
+            last_success_at: String?
+          ) -> Domain::MetricsSnapshot
         end
       end
     end

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

@@ -0,0 +1,35 @@
+module Stoplight
+  module Infrastructure
+    module Redis
+      module Storage
+        class WindowMetrics < Metrics
+          METRICS_FIELDS: Array[String]
+
+          @redis: redis
+          @scripting: Scripting
+          @clock: Domain::_Clock
+          @metrics_key: Key
+          @ts_index_key: Key
+          @window_size: Integer
+
+          def initialize: (
+            redis: redis,
+            scripting: Scripting,
+            config: Domain::Config,
+            clock: Domain::_Clock,
+            key_space: Key
+          ) -> void
+
+          def build_metrics_snapshot: (
+            successes: Integer,
+            errors: Integer,
+            consecutive_errors: String,
+            consecutive_successes: String,
+            last_error_json: String?,
+            last_success_at: String?,
+          ) -> Domain::MetricsSnapshot
+        end
+      end
+    end
+  end
+end

data/sig/stoplight/infrastructure/types.rbs

@@ -0,0 +1,6 @@
+module Stoplight
+  module Infrastructure
+    type redis = ::Redis | ConnectionPool[::Redis]
+    type notification_formatter = ^(Domain::LightInfo light, Domain::color, Domain::color, StandardError?) -> String
+  end
+end

data/sig/stoplight/notifier.rbs

@@ -1,7 +1,7 @@
 module Stoplight
   module Notifier
     class Base
-      include _StateTransitionNotifier
+      include Domain::_StateTransitionNotifier
     end
 
     module Generic = Infrastructure::Notifier::Generic

data/sig/stoplight/ports/system.rbs

@@ -2,20 +2,26 @@
 
 module Stoplight
   # A System is a composition root that groups related circuit breakers
-  # with shared configuration.
+  # with shared infrastructure configuration and defaults.
   interface _System
     def name: -> String
+    # @api private
+    def config: -> Domain::Config
 
-    def light: (
+    def register: (
       String name,
-      ?cool_off_time: optional[duration],
-      ?threshold: optional[percentage | Integer],
+      ?cool_off_time: optional[Domain::duration_seconds],
+      ?threshold: optional[Domain::percentage | Integer],
       ?recovery_threshold: optional[Integer],
-      ?window_size: optional[duration?],
-      ?skipped_errors: optional[Array[_ExceptionMatcher]],
-      ?tracked_errors: optional[Array[_ExceptionMatcher]],
-      ?traffic_control: optional[traffic_control],
-      ?traffic_recovery: optional[traffic_recovery]
-    ) -> _Light
+      ?window_size: optional[Domain::duration_seconds?],
+      ?skipped_errors: optional[Array[Module] | Module],
+      ?tracked_errors: optional[Array[Module] | Module],
+      ?traffic_control: optional[Wiring::traffic_control],
+      ?traffic_recovery: optional[Wiring::traffic_recovery]
+    ) -> Domain::Light
+
+    def light: (String name) -> Domain::Light
+
+    def telemetry: -> Domain::_Telemetry
   end
 end

data/sig/stoplight/state.rbs

@@ -1,7 +1,7 @@
 module Stoplight
   module State
-    UNLOCKED: unlocked
-    LOCKED_GREEN: locked_green
-    LOCKED_RED: locked_red
+    UNLOCKED: Domain::unlocked
+    LOCKED_GREEN: Domain::locked_green
+    LOCKED_RED: Domain::locked_red
   end
 end

data/sig/stoplight/telemetry.rbs

@@ -0,0 +1,17 @@
+module Stoplight
+  # Public face of the telemetry bus. The bus and its events live in the domain layer
+  # (Domain::Telemetry); this namespace re-exports them so callers never reference the
+  # Domain:: boundary - mirroring Stoplight::Notifier and Stoplight::DataStore.
+  module Telemetry
+    class RunCompleted = Domain::Telemetry::RunCompleted
+    class TrafficBreached = Domain::Telemetry::TrafficBreached
+    class RecoveryStarted = Domain::Telemetry::RecoveryStarted
+    class RecoverySucceeded = Domain::Telemetry::RecoverySucceeded
+    class RecoveryFailed = Domain::Telemetry::RecoveryFailed
+    class LockChanged = Domain::Telemetry::LockChanged
+    class RecoveryProbeCompleted = Domain::Telemetry::RecoveryProbeCompleted
+    class LightRegistered = Domain::Telemetry::LightRegistered
+
+    module StateTransitioned = Domain::Telemetry::StateTransitioned
+  end
+end

data/sig/stoplight/types.rbs

@@ -0,0 +1,9 @@
+module Stoplight
+  module Types
+    UNDEFINED: Undefined
+
+    def self.undefined: -> Undefined
+    def self.must: [T] (T? value) -> T
+    def self.absurd: (?untyped)-> TypeError
+  end
+end

data/sig/{_private/stoplight → stoplight}/wiring/config_compatibility_validator.rbs

@@ -12,6 +12,8 @@ module Stoplight
 
       private
 
+      def validate_window_size!: -> void
+      def validate_cool_off_time!: -> void
       def validate_traffic_control!: -> void
       def validate_traffic_recovery!: -> void
     end

data/sig/stoplight/wiring/default.rbs

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

data/sig/stoplight/wiring/default_configuration.rbs

@@ -0,0 +1,39 @@
+module Stoplight
+  module Wiring
+    class DefaultConfiguration
+      @config: Domain::Config
+      @cool_off_time: optional[Domain::duration_seconds]
+      @threshold: optional[Domain::percentage | Integer]
+      @recovery_threshold: optional[Integer]
+      @window_size: optional[Domain::duration_seconds?]
+      @tracked_errors: optional[Array[Module] | Module]
+      @skipped_errors: optional[Array[Module] | Module]
+      @traffic_control: optional[traffic_control]
+      @traffic_recovery: optional[traffic_recovery]
+      @error_notifier: optional[Domain::error_notifier]
+      @data_store: optional[Domain::_DataStore]
+      @notifiers: optional[Array[Domain::_StateTransitionNotifier]]
+
+      def to_config!: -> Domain::Config
+      def notifiers: -> Array[Domain::_StateTransitionNotifier]
+      def cool_off_time=: (Domain::duration_seconds) -> void
+      def threshold=: (Domain::percentage | Integer) -> void
+      def recovery_threshold=: (Integer) -> void
+      def window_size=: (Domain::duration_seconds?) -> void
+      def tracked_errors=: (Array[Module] | Module) -> void
+      def skipped_errors=: (Array[Module] | Module) -> void
+      def traffic_control=: (Wiring::traffic_control) -> void
+      def traffic_recovery=: (Wiring::traffic_recovery) -> void
+      def error_notifier=: (Domain::error_notifier) -> void
+      def data_store=: (Domain::_DataStore) -> void
+      def notifiers=:(Array[Domain::_StateTransitionNotifier]) -> void
+
+      private
+
+      def tracked_errors: -> optional[Array[Module]]
+      def skipped_errors: -> optional[Array[Module]]
+      def traffic_control: -> optional[Domain::_TrafficControl]
+      def traffic_recovery: -> optional[Domain::_TrafficRecovery]
+    end
+  end
+end

data/sig/stoplight/wiring/external_caller.rbs

@@ -0,0 +1,13 @@
+module Stoplight
+  module Wiring
+    module ExternalCaller
+      LIB_ROOT: String
+
+      def self.backtrace: () -> Array[String]
+
+      private
+
+      def self.internal?: (Thread::Backtrace::Location) -> bool
+    end
+  end
+end

data/sig/stoplight/wiring/fail_safe_config.rbs

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Stoplight
+  module Wiring
+    FailSafeConfig: Domain::Config
+  end
+end