stoplight 6.0.0.rc2 → 6.0.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dc15c81e94d811df03fe4acdd4ff76e3633931a1c4df022b7c26480834135e8
-  data.tar.gz: 82b93fba4751312a3ad6ac33602b0b50c40fc6ebd5d72554d66f040ab7efd133
+  metadata.gz: 97295cc794acc8de621f091e6cb0cfc7903f2f3bc5c439773c7888cb267bd197
+  data.tar.gz: c154e63a6dcd7094d56173647f022ed800514969db64655aac9dd3aefedd566a
 SHA512:
-  metadata.gz: 3a97e8dec725453ffd76e95d7d2ab59ef8929b89aa6ac2350a816d3e280aa49f893d3818dc28d6b465e20bf508c9cf10b37265e6968c436836ba9b5bdc374bb8
-  data.tar.gz: 9550e279df8c4ceaa1cc4de1a76a85dcb2fa84cb079e7dbd3716e699479b5cf94fe1d577f99f713840b693b6520d1c19b8f1b2b01fc9325b6db7cf89abdcfed3
+  metadata.gz: b6d7af0c9ad656fca39fb69bcc563e22cb955e3ec60e24e0615a7877fa3f09d7fe58152d7cb1a8797190529bab55b92ecfda544a4fddb7dbe1c16539adbe30b3
+  data.tar.gz: 5e222668a15bdd9e7b5b384ec83fb9b94e61e069d34cc509da7855325740e932fb72afcd31f91db5ed74847ce2509f019a8b10db550245741cbb73ab37c484b3

data/UPGRADING.md

@@ -15,6 +15,7 @@ Here's what you'll want to tackle during your upgrade, roughly ordered from the
 - [ ] Round any fractional `window_size` up to a whole number of seconds
 - [ ] Round any fractional `cool_off_time` up to a whole number of seconds, at least 1
 - [ ] Drop `warn_on_clock_skew` from your Redis data store setup
+- [ ] Compare `light.color` and `light.state` against symbols, not strings, and pass a symbol to `light.lock`
 - [ ] Test thoroughly in a staging environment
 
 ### Lights Are Registered and Reused
@@ -250,6 +251,31 @@ Stoplight::DataStore::Redis.new(redis)
 All time-dependent decisions are now made from Redis's own clock, so every instance reads the same time no matter
 what its host believes. With the coordination problem solved at the source, there is no skew left to warn about.
 
+### Colors and Lock States Are Symbols
+
+`light.color` now returns `:green`, `:yellow`, or `:red` instead of `"green"`, `"yellow"`, or `"red"`, and
+`light.state` returns `:unlocked`, `:locked_green`, or `:locked_red`. The constants under `Stoplight::Color` and
+`Stoplight::State` hold the same symbols, and every telemetry event carries them too: `from_color` and `to_color` on
+each transition, `from_state` and `to_state` on `LockChanged`.
+
+`light.lock` only recognises the symbols, so `light.lock("red")` now raises `Stoplight::Error::IncorrectColor`.
+
+Code that compares against the constants keeps working. Code that compares against, or passes, string literals needs
+updating:
+
+```ruby
+# Old way that won't work anymore
+alert! if light.color == "red"
+light.lock("green")
+
+# New way
+alert! if light.color == Stoplight::Color::RED
+light.lock(Stoplight::Color::GREEN)
+```
+
+Symbols are the idiomatic Ruby choice for a closed set of values. Anything that serializes them - logs, metrics tags,
+the Admin dashboard's JSON - renders the same text as before.
+
 ### Getting Help
 
 If you run into anything this guide doesn't cover, post to our [Discussions forum]. The configuration errors in 6.0

data/lib/stoplight/admin/helpers.rb

@@ -9,6 +9,10 @@ module Stoplight
         Color::RED
       ].freeze
 
+      def red?(light) = light.color == Color::RED
+
+      def yellow?(light) = light.color == Color::YELLOW
+
       def dependencies
         Dependencies.new(system: current_system)
       end

data/lib/stoplight/admin/views/_card.erb

@@ -28,15 +28,15 @@
       </p>
       <span class="flex items-center text-sm font-medium text-gray-500 dark:text-gray-400 truncate me-3">
         <span class="flex w-2.5 h-2.5 bg-<%= color %>-600 rounded-full me-1.5 shrink-0"></span>
-        <% if light.color == "red" %>
+        <% if red?(light) %>
           Open
-        <% elsif light.color == "yellow" %>
+        <% elsif yellow?(light) %>
           Half-Open
         <% else %>
           Closed
         <% end %>
 
-        <% if light.color == "yellow" %>
+        <% if yellow?(light) %>
           (Recovering)
         <% elsif light.locked? %>
           (Locked)

data/lib/stoplight/admin.rb

@@ -142,14 +142,14 @@ module Stoplight
 
     patch "/systems/:system_id/lights/:light_id/lock" do
       light_id = T.must(params[:light_id])
-      color = T.must(params[:color])
+      color = T.must(params[:color]).to_sym
       dependencies.lock_action.call(light_id:, color:)
 
       redirect system_url(current_system_id, "/lights")
     end
 
     patch "/systems/:system_id/lights/lock" do
-      color = T.must(params[:color])
+      color = T.must(params[:color]).to_sym
       dependencies.lock_all_action.call(color:)
 
       redirect system_url(current_system_id, "/lights")

data/lib/stoplight/color.rb

@@ -2,8 +2,8 @@
 
 module Stoplight
   module Color
-    GREEN = "green"
-    YELLOW = "yellow"
-    RED = "red"
+    GREEN = :green
+    YELLOW = :yellow
+    RED = :red
   end
 end

data/lib/stoplight/domain/state_snapshot.rb

@@ -23,7 +23,7 @@ module Stoplight
       # @!attribute time
       #   The time when the snapshot was taken
 
-      # @return [String] one of +Color::GREEN+, +Color::RED+, or +Color::YELLOW+
+      # @return [Symbol] one of +Color::GREEN+, +Color::RED+, or +Color::YELLOW+
       def color
         if locked_state == State::LOCKED_GREEN
           Color::GREEN

data/lib/stoplight/infrastructure/redis/storage/state.rb

@@ -63,7 +63,7 @@ module Stoplight
 
             Domain::StateSnapshot.new(
               breached_at: breached_at_raw && clock.at(breached_at_raw.to_f),
-              locked_state: locked_state || Stoplight::State::UNLOCKED,
+              locked_state: locked_state&.to_sym || Stoplight::State::UNLOCKED,
               recovery_scheduled_after: recovery_scheduled_after_raw && clock.at(recovery_scheduled_after_raw.to_f),
               recovery_started_at: recovery_started_at_raw && clock.at(recovery_started_at_raw.to_f),
               time: clock.current_time

data/lib/stoplight/state.rb

@@ -2,8 +2,8 @@
 
 module Stoplight
   module State
-    UNLOCKED = "unlocked"
-    LOCKED_GREEN = "locked_green"
-    LOCKED_RED = "locked_red"
+    UNLOCKED = :unlocked
+    LOCKED_GREEN = :locked_green
+    LOCKED_RED = :locked_red
   end
 end

data/lib/stoplight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stoplight
-  VERSION = Gem::Version.new("6.0.0.rc2")
+  VERSION = Gem::Version.new("6.0.0.rc3")
 end

data/lib/stoplight/wiring/system.rb

@@ -46,6 +46,9 @@ module Stoplight
       REGISTRATION_FRAME_LIMIT = 5
       private_constant :REGISTRATION_FRAME_LIMIT
 
+      Registration = Data.define(:light, :digest, :backtrace, :without_settings)
+      private_constant :Registration
+
       attr_reader :name
       # @api private
       attr_reader :config
@@ -113,6 +116,16 @@ module Stoplight
         traffic_control: T.undefined,
         traffic_recovery: T.undefined
       )
+        without_settings = cool_off_time.is_a?(Undefined) && threshold.is_a?(Undefined) &&
+          recovery_threshold.is_a?(Undefined) && window_size.is_a?(Undefined) &&
+          tracked_errors.is_a?(Undefined) && skipped_errors.is_a?(Undefined) &&
+          traffic_control.is_a?(Undefined) && traffic_recovery.is_a?(Undefined)
+
+        if without_settings
+          registration = @lights[name]
+          return registration.light if registration&.without_settings
+        end
+
         light_dsl = LightConfigurationDsl.new(
           name:,
           cool_off_time:,
@@ -126,8 +139,8 @@ module Stoplight
         )
         config_digest = light_dsl.digest
 
-        light, existing_digest, existing_backtrace = @lights[name] || begin
-          registered_at = ExternalCaller.backtrace.first(REGISTRATION_FRAME_LIMIT)
+        registration = @lights[name] || begin
+          backtrace = ExternalCaller.backtrace.first(REGISTRATION_FRAME_LIMIT)
           config = light_dsl.configure!(@config)
           @lights.compute_if_absent(name) do
             built = LightFactory.new(
@@ -137,12 +150,12 @@ module Stoplight
               telemetry: @telemetry
             ).build
             @registry.register(config)
-            [built, config_digest, registered_at]
+            Registration.new(light: built, digest: config_digest, backtrace:, without_settings:)
           end
         end
 
-        if config_digest != existing_digest
-          original_site = existing_backtrace.map { |frame| "  #{frame}" }.join("\n")
+        if config_digest != registration.digest
+          original_site = registration.backtrace.map { |frame| "  #{frame}" }.join("\n")
 
           raise Stoplight::Error::ConfigurationError, <<~MSG, ExternalCaller.backtrace
             Light `#{name}` already registered with different configuration.
@@ -154,12 +167,12 @@ module Stoplight
           MSG
         end
 
-        light
+        registration.light
       end
 
       # @raise [Stoplight::Error::UnregisteredLightError] if no light was registered under +name+
       def light(name)
-        @lights[name]&.first || raise(Stoplight::Error::UnregisteredLightError, <<~MSG)
+        @lights[name]&.light || raise(Stoplight::Error::UnregisteredLightError, <<~MSG)
           Light `#{name}` was never registered on system `#{@name}`.
           Call `.register(#{name.inspect}, ...)` at boot before using it.
         MSG

data/sig/stoplight/admin/actions/action.rbs

@@ -3,7 +3,7 @@ module Stoplight
   class Admin
     module Actions
       class Action
-        def halt: (Integer status) -> void
+        def halt: (Integer status) -> bot
       end
     end
   end

data/sig/stoplight/admin/helpers.rbs

@@ -3,6 +3,9 @@ module Stoplight
     module Helpers : Sinatra::Base
       COLORS: Array[Domain::color]
 
+      def red?: (LightView) -> bool
+      def yellow?: (LightView) -> bool
+
       def dependencies: -> Dependencies
       def system_url: (String system_id, String path) -> String
       def asset_path: (String) -> String

data/sig/stoplight/domain/types.rbs

@@ -5,15 +5,15 @@ module Stoplight
     type duration_ms = Float
 
     # Light Colors
-    type green = "green"
-    type yellow = "yellow"
-    type red = "red"
+    type green = :green
+    type yellow = :yellow
+    type red = :red
     type color = green | yellow | red
 
     # Light States
-    type unlocked = "unlocked"
-    type locked_green = "locked_green"
-    type locked_red = "locked_red"
+    type unlocked = :unlocked
+    type locked_green = :locked_green
+    type locked_red = :locked_red
     type state = unlocked | locked_green | locked_red
 
     type recovery_decision = :green | :yellow | :red

data/sig/stoplight/wiring/system.rbs

@@ -6,7 +6,28 @@ module Stoplight
       @name: String
       REGISTRATION_FRAME_LIMIT: Integer
 
-      @lights: Concurrent::Map[String, [Domain::Light, Integer, Array[String]]]
+      class Registration < Data
+        attr_reader light: Domain::Light
+        attr_reader digest: Integer
+        attr_reader backtrace: Array[String]
+        attr_reader without_settings: bool
+
+        def self.new: (
+            light: Domain::Light,
+            digest: Integer,
+            backtrace: Array[String],
+            without_settings: bool,
+          ) -> instance
+
+        def initialize: (
+            light: Domain::Light,
+            digest: Integer,
+            backtrace: Array[String],
+            without_settings: bool,
+          ) -> void
+      end
+
+      @lights: Concurrent::Map[String, Registration]
       @failover_system: _System?
       @registry: Domain::_Registry
       @telemetry: Domain::Telemetry::Bus

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stoplight
 version: !ruby/object:Gem::Version
-  version: 6.0.0.rc2
+  version: 6.0.0.rc3
 platform: ruby
 authors:
 - Tëma Bolshakov