stoplight 6.0.0.rc3 → 6.0.0.rc5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97295cc794acc8de621f091e6cb0cfc7903f2f3bc5c439773c7888cb267bd197
-  data.tar.gz: c154e63a6dcd7094d56173647f022ed800514969db64655aac9dd3aefedd566a
+  metadata.gz: ade3c17bdafebab88e87b0f967dcf71a3fef99bb486c10a328e5110c4a4f456a
+  data.tar.gz: 2dff3cb5d7731a337c8d558c73d7a3091b7bf1bafb060ae7d8bd74d570f2b4c2
 SHA512:
-  metadata.gz: b6d7af0c9ad656fca39fb69bcc563e22cb955e3ec60e24e0615a7877fa3f09d7fe58152d7cb1a8797190529bab55b92ecfda544a4fddb7dbe1c16539adbe30b3
-  data.tar.gz: 5e222668a15bdd9e7b5b384ec83fb9b94e61e069d34cc509da7855325740e932fb72afcd31f91db5ed74847ce2509f019a8b10db550245741cbb73ab37c484b3
+  metadata.gz: bd236321933ab75c09c468c3a12fddefe3002ce16cbfc7c6a28580d56fb3b6cace531792e9e5c0cae393158f5ba0ce6d62ec1425363bf4ba83abd8b6d4cb04ee
+  data.tar.gz: ce3c272066f30882c34921144dbe48773fd6ed4812d6933ea96842a0848830c4e9e5b1f23b46d7d93556c87d56cb6b7345553c06135ab54f2111f21a52aac759

data/README.md

@@ -678,8 +678,8 @@ Example: "Ruby 3.3 reaches end-of-life in March 2027, so Stoplight 7.0 will requ
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies. Run tests with `bundle exec rspec` and check 
-code style with `bundle exec standardrb`. We follow a git flow branching strategy - see our [Git Flow wiki page] for 
-details on branch naming, releases, and contribution workflow. Also check our CONTRIBUTING.md guide for contributors.
+code style with `bundle exec standardrb`. All work happens on `main` - see [CONTRIBUTING.md] for branch naming,
+releases, and the contribution workflow.
 
 ## Credits
 
@@ -708,7 +708,7 @@ Fowler’s [CircuitBreaker][] article.
 [complete list of contributors]: https://github.com/bolshakov/stoplight/graphs/contributors
 [CircuitBreaker]: http://martinfowler.com/bliki/CircuitBreaker.html
 [Redis]: https://redis.io/
-[Git Flow wiki page]: https://github.com/bolshakov/stoplight/wiki/Git-Flow
+[CONTRIBUTING.md]: CONTRIBUTING.md
 [Valkey]: https://valkey.io/
 [Ruby Maintenance Branches]: https://www.ruby-lang.org/en/downloads/branches/
 [Redis's support policy]: https://redis.io/about/releases/

data/UPGRADING.md

@@ -8,6 +8,7 @@ Here's what you'll want to tackle during your upgrade, roughly ordered from the
 
 - [ ] Make every `Stoplight("name", ...)` call site for the same name pass identical settings
 - [ ] Move `data_store`, `notifiers`, and `error_notifier` from individual lights to `Stoplight.configure`
+- [ ] Make sure that you run at least Ruby 3.3+, Redis 7.4+ (or Valkey 7.2+)
 - [ ] Replace the `with_*` builder methods with settings passed at creation time
 - [ ] Replace proc and anonymous-class error matchers with named classes or modules
 - [ ] Account for Stoplight state reset after deployment
@@ -87,6 +88,13 @@ end
 If you genuinely need more than one data store - separate Redis instances per tenant, for example - use named
 systems, which own their own infrastructure. See [Systems: Namespace Isolation & Configuration][systems] for setup.
 
+### Ruby 3.3 and Redis 7.4 Are the new Minimum
+
+Stoplight 6 requires Ruby 3.3 or newer.
+We also require Redis 7.4 or newer and Valkey 7.2 or newer and no longer tested or supported earlier versions.
+
+See the [maintenance policy] for the versions under test.
+
 ### The Light Builder API Is Gone
 
 `Light#with` and the whole `with_*` family are removed: `with_data_store`, `with_cool_off_time`, `with_threshold`,
@@ -582,6 +590,7 @@ Nothing. Stoplight will function as usual.
 [Community-supported notifiers]: https://github.com/bolshakov/stoplight/tree/master#community-supported-notifiers
 [How to implement your own notifier?]: https://github.com/bolshakov/stoplight/blob/master/lib/stoplight/notifier/generic.rb
 [dropped notifiers]: https://github.com/bolshakov/stoplight/tree/v3.0.1/lib/stoplight/notifier
+[maintenance policy]: https://github.com/bolshakov/stoplight#maintenance-policy
 [without passing an empty block]: https://github.com/bolshakov/stoplight-admin/blob/9c9848eb94410e46b20972548f0863db224cb6da/lib/sinatra/stoplight_admin.rb#L30
 [sliding window]: https://github.com/bolshakov/stoplight#custom-window-size
 [systems]: https://github.com/bolshakov/stoplight/blob/master/docs/systems.md

data/lib/stoplight/infrastructure/redis/storage/state/state_snapshot.lua

@@ -0,0 +1,9 @@
+-- @include now
+
+local meta_key = KEYS[1]
+
+local state = redis.call('HMGET', meta_key, 'breached_at', 'locked_state', 'recovery_scheduled_after', 'recovery_started_at')
+local current_time = now()
+state[5] = current_time
+
+return state

data/lib/stoplight/infrastructure/redis/storage/state/transition_to_red.lua

@@ -1,8 +1,9 @@
 -- @include now
 
 local meta_key = KEYS[1]
-local recovery_scheduled_after_ts = tonumber(ARGV[1])
+local cool_off_time = tonumber(ARGV[1])
 local current_ts = now() / 1000
+local recovery_scheduled_after_ts = current_ts + cool_off_time
 
 --  1 if the field is a new field in the hash and the value was set
 local became_red = redis.call('HSETNX', meta_key, 'breached_at', current_ts)

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

@@ -57,16 +57,19 @@ module Stoplight
           end
 
           def state_snapshot
-            breached_at_raw, locked_state, recovery_scheduled_after_raw, recovery_started_at_raw = redis.with do |client|
-              client.hmget(state_key, :breached_at, :locked_state, :recovery_scheduled_after, :recovery_started_at)
-            end
+            breached_at_raw, locked_state, recovery_scheduled_after_raw, recovery_started_at_raw, now_ms =
+              scripting.call(
+                "state/state_snapshot",
+                args: [],
+                keys: [state_key]
+              )
 
             Domain::StateSnapshot.new(
               breached_at: breached_at_raw && clock.at(breached_at_raw.to_f),
               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
+              time: clock.at(now_ms.fdiv(1000))
             )
           end
 
@@ -123,12 +126,9 @@ module Stoplight
           # Transitions to RED state and ensures only one notification
           #
           def transition_to_red
-            current_ts = clock.current_time.to_f
-            recovery_scheduled_after_ts = current_ts + cool_off_time
-
             became_red = scripting.call(
               "state/transition_to_red",
-              args: [recovery_scheduled_after_ts],
+              args: [cool_off_time],
               keys: [state_key]
             )
 

data/lib/stoplight/infrastructure/redis/storage/window_metrics/_evict.lua

@@ -18,6 +18,8 @@ local function evict_buckets(metrics_key, ts_index_key, window_start)
     return
   end
 
+  local failures, successes = 0, 0
+
   for from = 1, #buckets, EVICT_BATCH_SIZE do
     local to = math.min(from + EVICT_BATCH_SIZE - 1, #buckets)
 
@@ -29,16 +31,15 @@ local function evict_buckets(metrics_key, ts_index_key, window_start)
 
     local values = redis.call('HMGET', metrics_key, unpack(fields))
 
-    local failures, successes = 0, 0
     for i = 1, #values, 2 do
       failures = failures + (tonumber(values[i]) or 0)
       successes = successes + (tonumber(values[i + 1]) or 0)
     end
 
-    redis.call('HINCRBY', metrics_key, 'total_failures', -failures)
-    redis.call('HINCRBY', metrics_key, 'total_successes', -successes)
     redis.call('HDEL', metrics_key, unpack(fields))
   end
 
+  redis.call('HINCRBY', metrics_key, 'total_failures', -failures)
+  redis.call('HINCRBY', metrics_key, 'total_successes', -successes)
   redis.call('ZREMRANGEBYSCORE', ts_index_key, '-inf', window_start)
 end

data/lib/stoplight/version.rb

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

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stoplight
 version: !ruby/object:Gem::Version
-  version: 6.0.0.rc3
+  version: 6.0.0.rc5
 platform: ruby
 authors:
 - Tëma Bolshakov
@@ -145,6 +145,7 @@ files:
 - lib/stoplight/infrastructure/redis/storage/registry.rb
 - lib/stoplight/infrastructure/redis/storage/scripting.rb
 - lib/stoplight/infrastructure/redis/storage/state.rb
+- lib/stoplight/infrastructure/redis/storage/state/state_snapshot.lua
 - lib/stoplight/infrastructure/redis/storage/state/transition_to_green.lua
 - lib/stoplight/infrastructure/redis/storage/state/transition_to_red.lua
 - lib/stoplight/infrastructure/redis/storage/state/transition_to_yellow.lua