gitlab-labkit 1.15.0 → 1.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5840ade4baa1fb379ae82748354a74571d6806e529c205010139846489f50579
-  data.tar.gz: 802528c013a130b2925b19760a29e8d7c33aa9c042ed3a024ac0dc9bb8fa6127
+  metadata.gz: 55b7255672a78e7ce050b17dee4a50b0c9ceadd2093986dc0d5d3822076423b0
+  data.tar.gz: fe70e4a910d27fa2d8d1a61216825bb811a8a43b9fbd75d4c0bd32220e8551b3
 SHA512:
-  metadata.gz: 9e3b44e0271effb09c593dc582cd69221c3f83b255535d5fd456033f22f6f933fe9c15e8a204d8868fa20644838bdfbf17578d151eb9fe906a731b650bbb1902
-  data.tar.gz: 98483520ad13fbfe52edd39ce6c879ea86b6240cdbf16e8deb9254abfce4d1e825029560119f79d76254efac3d97228ce35243cba21b3f269a32ec6f55612a36
+  metadata.gz: 38e4de6ac2d9e677a269f757e4c01a1bb1d9e3ce4cec0065512a03d07650339ae6e5f27415be76ba02cc316c56e5fd8d4922389e856da152be527800a6f58de6
+  data.tar.gz: 613915d89f71db61f3a984ae979d704753c9284d196dc7f31c92426b0f037ded2c0140ea9fc778dbbd42bb7c0ccfa0884b3d67e3ebc38b791bc84edfa6cb852d

data/lib/labkit/rate_limit/evaluator.rb

@@ -25,7 +25,7 @@ module Labkit
         # Intentionally broad: fail-open applies to any unexpected error (network,
         # timeout, OOM) not only Redis protocol errors.
         log_error(e, identifier)
-        Result.new(matched: false, error: true)
+        Result.new(matched: false, error: true, action: :allow)
       end
 
       private
@@ -37,7 +37,7 @@ module Labkit
           return evaluate_rule(rule, identifier)
         end
 
-        Result.new(matched: false)
+        Result.new(matched: false, action: :allow)
       end
 
       def rule_matches?(rule, identifier)
@@ -51,8 +51,9 @@ module Labkit
 
         count = incr_with_ttl(redis_key, resolved_period)
         exceeded = count > resolved_limit
+        action = exceeded ? rule.action : :allow
 
-        Result.new(matched: true, exceeded: exceeded, action: rule.action, rule: rule)
+        Result.new(matched: true, exceeded: exceeded, action: action, rule: rule)
       end
 
       def build_redis_key(rule, identifier)

data/lib/labkit/rate_limit/limiter.rb

@@ -21,11 +21,10 @@ module Labkit
 
       def initialize(name:, rules:, redis: nil, logger: nil)
         @logger = logger || RateLimit.config.logger || Labkit::Logging::JsonLogger.new($stdout)
-        validated_name = validate_name!(name)
-        @name = validated_name
+        @name = validate_name!(name)
 
         @evaluator = Evaluator.new(
-          name: validated_name,
+          name: @name,
           rules: prepare_rules(rules),
           redis: redis || RateLimit.config.redis,
           logger: @logger
@@ -36,19 +35,7 @@ module Labkit
       # @return [Result]
       def check(identifier)
         id = identifier.is_a?(Identifier) ? identifier : Identifier.new(identifier)
-        result = @evaluator.check(id)
-
-        if result.exceeded? && result.action == :block
-          @logger.warn(
-            message: "rate_limit_check",
-            name: @name,
-            rule_name: result.rule.name,
-            exceeded: true,
-            severity: "WARN"
-          )
-        end
-
-        result
+        @evaluator.check(id)
       end
 
       private

data/lib/labkit/rate_limit/result.rb

@@ -5,11 +5,16 @@ module Labkit
     # 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    - :block or :log (nil when matched? is false)
+    # 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)
     Result = Data.define(:matched, :exceeded, :action, :rule, :error) do
-      def initialize(matched:, exceeded: false, action: nil, rule: nil, error: false)
+      def initialize(matched:, action:, exceeded: false, rule: nil, error: false)
         super
       end
 

metadata

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