stoplight 6.0.0.rc5 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ade3c17bdafebab88e87b0f967dcf71a3fef99bb486c10a328e5110c4a4f456a
-  data.tar.gz: 2dff3cb5d7731a337c8d558c73d7a3091b7bf1bafb060ae7d8bd74d570f2b4c2
+  metadata.gz: e9e835f7351f236b8965d8179da39eff4eaf768bbf066c94cb35f8ed6f0360f6
+  data.tar.gz: ea64aa21f4874b40843e2f18716da346b4e0a4fbf77f57ca777bafa8e396ae5b
 SHA512:
-  metadata.gz: bd236321933ab75c09c468c3a12fddefe3002ce16cbfc7c6a28580d56fb3b6cace531792e9e5c0cae393158f5ba0ce6d62ec1425363bf4ba83abd8b6d4cb04ee
-  data.tar.gz: ce3c272066f30882c34921144dbe48773fd6ed4812d6933ea96842a0848830c4e9e5b1f23b46d7d93556c87d56cb6b7345553c06135ab54f2111f21a52aac759
+  metadata.gz: 3bfa3fb97ed1f8f2743930257fefb4eba4f380b9b7eea122af9ca792206b43c27b42fb35292d95ab6c608ad70e3f99f6cf3ca0eb319e2d31c2010943e50a9730
+  data.tar.gz: 330fce49dcde86b0d0a9864143523db53caa20f64105cd40f85fcc4930769e3cd35ddb1f199aefce184b6c08eed69259acf0d697a9c4dc4e8245f482fc4a2474

data/README.md

@@ -80,8 +80,8 @@ After the last failure, the light turns red. The next call will raise a `Stoplig
 executing the block:
 
 ```ruby
-light.run { 1 / 0 } #=> raises Stoplight::Error::RedLight: example-zero
-light.color # => "red"
+light.run { 1 / 0 } #=> raises Stoplight::Error::RedLight: Light `Example` is red - traffic stopped until recovery.
+light.color # => :red
 ```
 
 The `Stoplight::Error::RedLight` provides metadata about the error:
@@ -108,7 +108,7 @@ light.run { 1 / 1 } #=> 1
 If the test probe succeeds, the light turns green again. If it fails, the light turns red again.
 
 ```ruby
-light.color #=> "green"
+light.color #=> :green
 ```
 
 ### Using Fallbacks
@@ -388,7 +388,7 @@ By default, Stoplight uses an in-memory data store:
 
 ```ruby
 require "stoplight"
-Stoplight::Default::DATA_STORE
+Stoplight::Wiring::Default::DATA_STORE
 # => #<Stoplight::DataStore::Memory:...>
 ```
 
@@ -700,7 +700,7 @@ Fowler’s [CircuitBreaker][] article.
 [stoplight-sentry]: https://github.com/bolshakov/stoplight-sentry
 [stoplight-honeybadger]: https://github.com/qoqa/stoplight-honeybadger
 [stoplight-statsd]: https://github.com/bolshakov/stoplight-statsd
-[notifier interface documentation]: https://github.com/bolshakov/stoplight/blob/main/lib/stoplight/domain/state_transition_notifier.rb
+[notifier interface documentation]: https://github.com/bolshakov/stoplight/blob/main/sig/stoplight/domain/ports/state_transition_notifier.rbs
 [camdez]: https://github.com/camdez
 [tfausak]: https://github.com/tfausak
 [bolshakov]: https://github.com/bolshakov

data/UPGRADING.md

@@ -17,6 +17,7 @@ Here's what you'll want to tackle during your upgrade, roughly ordered from the
 - [ ] 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`
+- [ ] Check anything that parses or matches `Stoplight::Error::RedLight` messages - the message format changed
 - [ ] Test thoroughly in a staging environment
 
 ### Lights Are Registered and Reused
@@ -284,6 +285,19 @@ 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.
 
+### The `RedLight` Exception Message Changed
+
+The message of `Stoplight::Error::RedLight` used to be the bare light name. It is now a sentence that names the light
+and says what happened, so a log line or an error tracker (e.g., in Sentry) entry is readable on its own:
+
+```
+# 5.x
+Stoplight::Error::RedLight: Payment Service
+
+# 6.0
+Stoplight::Error::RedLight: Light `Payment Service` is red - traffic stopped until recovery.
+```
+
 ### 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/data_store.rb

@@ -30,6 +30,13 @@ module Stoplight
       # @see Stoplight::Infrastructure::Redis::Key
       def self.key_space = KEY_SPACE
       def key_space = self.class.key_space
+
+      # Lua scripts are loaded into Redis once per server, so every light shares a single script cache.
+      #
+      # @api private
+      def __stoplight__scripting
+        @scripting ||= Infrastructure::Redis::Storage::Scripting.new(redis:)
+      end
     end
 
     class Memory < Base

data/lib/stoplight/error.rb

@@ -18,7 +18,7 @@ module Stoplight
     end
 
     class RedLight < Base
-      EXCEPTION_MESSAGE = 'Stoplight "%{light_name}" is red - traffic stopped until recovery.'
+      EXCEPTION_MESSAGE = "Light `%{light_name}` is red - traffic stopped until recovery."
       private_constant :EXCEPTION_MESSAGE
 
       # @!attribute light_name

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

@@ -21,6 +21,7 @@ module Stoplight
             @shas = Hash.new do |hash, script_name|
               hash[script_name] = Digest::SHA1.hexdigest(resolve_source(script_name))
             end
+            @invoked = Set.new
           end
 
           def call(script_name, keys: [], args: [])
@@ -33,18 +34,23 @@ module Stoplight
             rescue ::Redis::CommandError => error
               if error.message.include?("NOSCRIPT") && !retried
                 retried = true
-                reload_script(script_name)
+                if @invoked.include?(script_name) # skip warning for the first script invocation on app boot
+                  warn "Stoplight is unable to find the script '#{script_name}' from Redis's script cache. " \
+                         "Reloading and retrying..."
+                end
+                load_script(script_name)
                 retry
               else
                 raise error
               end
+            ensure
+              @invoked << script_name
             end
           end
 
           private
 
-          def reload_script(script_name)
-            warn "Stoplight is unable to find the script '#{script_name}' in Redis's script cache. Reloading and retrying..."
+          def load_script(script_name)
             @redis.then { |client| client.script(:load, resolve_source(script_name)) }
           end
 

data/lib/stoplight/version.rb

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

data/lib/stoplight/wiring/light_factory.rb

@@ -72,7 +72,16 @@ module Stoplight
       attr_reader :system_name
 
       def recovery_lock_store = storage_set.recovery_lock_store
-      def storage_scripting = Infrastructure::Redis::Storage::Scripting.new(redis:)
+
+      def storage_scripting
+        case data_store_config
+        when DataStore::Redis
+          data_store_config.__stoplight__scripting
+        else
+          raise T.absurd(data_store_config)
+        end
+      end
+
       def failover_system = T.must(@failover_system)
 
       def key_space

data/lib/stoplight.rb

@@ -3,7 +3,6 @@
 require "concurrent/map"
 require "zeitwerk"
 
-# steep:ignore:start
 loader = Zeitwerk::Loader.for_gem
 loader.inflector.inflect("io" => "IO")
 loader.do_not_eager_load(
@@ -14,7 +13,6 @@ loader.do_not_eager_load(
 loader.ignore("#{__dir__}/generators")
 loader.ignore("#{__dir__}/stoplight/rspec.rb", "#{__dir__}/stoplight/rspec")
 loader.setup
-# steep:ignore:end
 
 module Stoplight # rubocop:disable Style/Documentation
   T = Types

data/sig/stoplight/data_store/redis.rbs

@@ -7,9 +7,12 @@ module Stoplight
       KEY_SPACE: Infrastructure::Redis::Key
 
       attr_reader redis: Infrastructure::redis
+      @scripting: Infrastructure::Redis::Storage::Scripting?
 
       def initialize: (Infrastructure::redis) -> void
 
+      def __stoplight__scripting: -> Infrastructure::Redis::Storage::Scripting
+
       def self.key_space: -> Infrastructure::Redis::Key
       def key_space: -> Infrastructure::Redis::Key
     end

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

@@ -11,6 +11,7 @@ module Stoplight
 
           @scripts_path: Array[String]
           @shas: Hash[String, String]
+          @invoked: Set[String]
           @redis: redis
 
           def initialize: (
@@ -24,7 +25,7 @@ module Stoplight
               ?args: Array[_ToS]
             ) -> untyped
 
-          private def reload_script: (String script_name) -> void
+          private def load_script: (String script_name) -> void
 
           private def resolve_source: (String script_name) -> String
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stoplight
 version: !ruby/object:Gem::Version
-  version: 6.0.0.rc5
+  version: 6.0.0
 platform: ruby
 authors:
 - Tëma Bolshakov
@@ -345,7 +345,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Traffic control for code.
 test_files: []