gitlab-labkit 1.17.0 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7177b8f9210f24958a14c92f17ad35cc8d4ad7732e04a9407569e865ef2bf364
-  data.tar.gz: 688c6dd7b7c1a8c1062a1e17c534fa833f86053aff8945ab4d296c2223784711
+  metadata.gz: 154a169d5b47821eb411551dd452755270a671c334b9f041b7c20090b8d35074
+  data.tar.gz: 5373cb3360f29eb1fe9facb99b866423a26785b61c9bc8390f6b4623dba6bff5
 SHA512:
-  metadata.gz: 2b54fe16d5c1cfe12c704a4e84cdea8dece8155dcaa04132c9e52442bec03e6338f6a4bcb065aa87931aa2fedcbd2ecb5ecec390b00d110267ee54e95a5c694c
-  data.tar.gz: 8abc6a48c3f1b138a84f8502e5c4300bec5f05f98b0c8defb4280d12b1d424f70cf64e0afe3cc344ce61ceae145e9aaf11f252d9611da1e5c6a1f25aa37fe867
+  metadata.gz: d8393e9574bdeb229a8089dfdcbe90ed1d68bfd9c7a35a95f654800beb18dab5121b48f82c61d71d1d00a83ba6e60e5c595a020bb8e9237b5a636d019645afd0
+  data.tar.gz: 7cf8a3cda6cca43339bf14e814cdd7ee28ebac6de0b4bf21b1c84400eb43bd4061fb0029852fb475293c16a0ae497abc5002556260dd1da680aeb39abc9fbc2c

data/lib/labkit/rate_limit/evaluator.rb

@@ -53,14 +53,17 @@ module Labkit
         resolved_limit = Integer(resolve_value(rule.limit))
         resolved_period = Integer(resolve_value(rule.period))
 
-        count = incr_with_ttl(redis_key, resolved_period)
+        count, ttl = incr_with_ttl(redis_key, resolved_period)
         exceeded = count > resolved_limit
         action = exceeded ? rule.action : :allow
-
-        Result.new(
-          matched: true, exceeded: exceeded, action: action, rule: rule,
-          resolved_limit: resolved_limit, resolved_period: resolved_period
+        info = Result::Info.new(
+          resolved_limit: resolved_limit, resolved_period: resolved_period,
+          count: count,
+          remaining: [resolved_limit - count, 0].max,
+          reset_at: Time.now.utc + (ttl >= 0 ? ttl : resolved_period)
         )
+
+        Result.new(matched: true, exceeded: exceeded, action: action, rule: rule, info: info)
       end
 
       def build_redis_key(rule, identifier)
@@ -91,12 +94,17 @@ module Labkit
         end
       end
 
+      # Pipelines INCR and TTL so both are fetched in a single round-trip.
+      # EXPIRE follows as a separate call only on first write (count == 1).
+      # On first write TTL will be -1 (expiry not yet set); callers fall back to period.
       def incr_with_ttl(redis_key, period)
         @redis.with do |conn|
-          count = conn.incr(redis_key)
-          # Set expiry only on first write to avoid resetting TTL on each call
+          count, ttl = conn.pipelined do |pipe|
+            pipe.incr(redis_key)
+            pipe.ttl(redis_key)
+          end
           conn.expire(redis_key, period) if count == 1
-          count
+          [count, ttl]
         end
       end
 
@@ -117,11 +125,11 @@ module Labkit
         )
         Metrics.limit_gauge.set(
           { rate_limiter: @name, rule: result.rule.name },
-          result.resolved_limit
+          result.info.resolved_limit
         )
         Metrics.period_gauge.set(
           { rate_limiter: @name, rule: result.rule.name },
-          result.resolved_period
+          result.info.resolved_period
         )
       end
 

data/lib/labkit/rate_limit/result.rb

@@ -3,22 +3,19 @@
 module Labkit
   module RateLimit
     # Result is the return value of Limiter#check.
-    # matched?         - true if a rule's match conditions were satisfied
-    # exceeded?        - true if the matched rule's counter exceeded its limit
-    # action           - the outcome: what the caller should do
-    #                    :block = rule matched, exceeded, rule configured to block
-    #                    :log   = rule matched, exceeded, rule configured to log only
-    #                    :allow = rule matched but count within limit, or
-    #                             no rule matched, or error (fail-open)
-    #                    The rule's configured action is available via rule.action
-    # rule             - the matched Rule object (nil when matched? is false)
-    # error?           - true if Redis was unavailable; result fails open (exceeded? is false)
-    # resolved_limit   - the resolved limit value as Integer (nil when matched? is false or error)
-    # resolved_period  - the resolved period value as Integer (nil when matched? is false or error)
-    Result = Data.define(:matched, :exceeded, :action, :rule, :error, :resolved_limit, :resolved_period) do
-      def initialize(
-        matched:, action:, exceeded: false, rule: nil, error: false,
-        resolved_limit: nil, resolved_period: nil)
+    # matched?  - true if a rule's match conditions were satisfied
+    # exceeded? - true if the matched rule's counter exceeded its limit
+    # action    - the outcome: what the caller should do
+    #             :block = rule matched, exceeded, rule configured to block
+    #             :log   = rule matched, exceeded, rule configured to log only
+    #             :allow = rule matched but count within limit, or
+    #                      no rule matched, or error (fail-open)
+    #             The rule's configured action is available via rule.action
+    # rule      - the matched Rule object (nil when matched? is false)
+    # error?    - true if Redis was unavailable; result fails open (exceeded? is false)
+    # info      - Result::Info with per-window counters; nil when matched? is false or error?
+    Result = Data.define(:matched, :exceeded, :action, :rule, :error, :info) do
+      def initialize(matched:, action: nil, exceeded: false, rule: nil, error: false, info: nil)
         super
       end
 
@@ -33,6 +30,27 @@ module Labkit
       def error?
         error
       end
+
+      # Returns RFC-compliant rate limit response headers, or {} when no rule matched or an error occurred.
+      # Keys: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset (Unix timestamp).
+      # reset_at is advisory only - derived from a pipelined redis.ttl call, not fully atomic.
+      def to_response_headers
+        return {} unless matched? && !error? && info
+
+        {
+          "RateLimit-Limit" => info.resolved_limit.to_s,
+          "RateLimit-Remaining" => info.remaining.to_s,
+          "RateLimit-Reset" => info.reset_at.to_i.to_s
+        }
+      end
     end
+
+    # Per-window counter data attached to a matched Result.
+    # resolved_limit  - the evaluated limit Integer for this rule
+    # resolved_period - the evaluated period Integer (seconds) for this rule
+    # count           - the raw INCR value; useful for utilization-ratio metrics
+    # remaining       - requests remaining before the limit is hit (floors at 0)
+    # reset_at        - best-effort UTC Time when the counter window resets
+    Result::Info = Data.define(:resolved_limit, :resolved_period, :count, :remaining, :reset_at)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-labkit
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 1.18.0
 platform: ruby
 authors:
 - Andrew Newdigate