diff --git a/sentry-ruby/lib/sentry/transport.rb b/sentry-ruby/lib/sentry/transport.rb index 71bd2f878..0d009368c 100644 --- a/sentry-ruby/lib/sentry/transport.rb +++ b/sentry-ruby/lib/sentry/transport.rb @@ -2,6 +2,7 @@ require "json" require "sentry/envelope" +require "sentry/transport/rate_limits" module Sentry class Transport @@ -25,13 +26,13 @@ class Transport include LoggingHelper - attr_reader :rate_limits, :discarded_events, :last_client_report_sent + attr_reader :discarded_events, :last_client_report_sent def initialize(configuration) @sdk_logger = configuration.sdk_logger @transport_configuration = configuration.transport @dsn = configuration.dsn - @rate_limits = {} + @rate_limits = RateLimits.new @send_client_reports = configuration.send_client_reports if @send_client_reports @@ -90,30 +91,18 @@ def serialize_envelope(envelope) [data, serialized_items] end - def is_rate_limited?(data_category) - # check category-specific limit - category_delay = @rate_limits[data_category] - # check universal limit if not category limit - universal_delay = @rate_limits[nil] - - delay = - if category_delay && universal_delay - if category_delay > universal_delay - category_delay - else - universal_delay - end - elsif category_delay - category_delay - else - universal_delay - end + # @return [Hash{String, nil => Time}] a copy of the rate limit deadlines by data category, + # where +nil+ is the limit for all categories; changing it does not change the rate limits + def rate_limits + @rate_limits.to_h + end - !!delay && delay > Time.now + def is_rate_limited?(data_category) + @rate_limits.limited?(data_category) end def any_rate_limited? - @rate_limits.values.any? { |t| t && t > Time.now } + @rate_limits.any_limited? end def envelope_from_event(event) diff --git a/sentry-ruby/lib/sentry/transport/http_transport.rb b/sentry-ruby/lib/sentry/transport/http_transport.rb index 88902557f..2521672fd 100644 --- a/sentry-ruby/lib/sentry/transport/http_transport.rb +++ b/sentry-ruby/lib/sentry/transport/http_transport.rb @@ -118,36 +118,23 @@ def has_rate_limited_header?(headers) end def handle_rate_limited_response(headers) - rate_limits = - if rate_limits = headers[RATE_LIMIT_HEADER] - parse_rate_limit_header(rate_limits) - elsif retry_after = headers[RETRY_AFTER_HEADER] - # although Sentry doesn't send a date string back - # based on HTTP specification, this could be a date string (instead of an integer) - retry_after = retry_after.to_i - retry_after = DEFAULT_DELAY if retry_after == 0 - - { nil => Time.now + retry_after } - else - { nil => Time.now + DEFAULT_DELAY } - end - - rate_limits.each do |category, limit| - if current_limit = @rate_limits[category] - if current_limit < limit - @rate_limits[category] = limit - end - else - @rate_limits[category] = limit - end + if rate_limit_header = headers[RATE_LIMIT_HEADER] + update_from_rate_limit_header(rate_limit_header) + elsif retry_after = headers[RETRY_AFTER_HEADER] + # although Sentry doesn't send a date string back + # based on HTTP specification, this could be a date string (instead of an integer) + retry_after = retry_after.to_i + retry_after = DEFAULT_DELAY if retry_after == 0 + + @rate_limits.update(nil, Time.now + retry_after) + else + @rate_limits.update(nil, Time.now + DEFAULT_DELAY) end end - def parse_rate_limit_header(rate_limit_header) + def update_from_rate_limit_header(rate_limit_header) time = Time.now - result = {} - limits = rate_limit_header.split(",") limits.each do |limit| next if limit.nil? || limit.empty? @@ -158,17 +145,15 @@ def parse_rate_limit_header(rate_limit_header) categories = categories.split(";") if categories.empty? - result[nil] = retry_after + @rate_limits.update(nil, retry_after) else categories.each do |category| - result[category] = retry_after + @rate_limits.update(category, retry_after) end end rescue StandardError end end - - result end def should_compress?(data) diff --git a/sentry-ruby/lib/sentry/transport/rate_limits.rb b/sentry-ruby/lib/sentry/transport/rate_limits.rb new file mode 100644 index 000000000..4fa97f08d --- /dev/null +++ b/sentry-ruby/lib/sentry/transport/rate_limits.rb @@ -0,0 +1,48 @@ +# frozen_string_literal: true + +module Sentry + class Transport + # The times until which data categories are rate limited. The +nil+ category holds the + # limit that applies to all categories. + # + # {#update} is the only write operation, and it never moves a deadline earlier, so a + # shorter rate limit can never replace a longer one, as the + # {https://develop.sentry.dev/sdk/foundations/transport/rate-limiting/#stage-2-determine-rate-limits + # rate limiting spec} requires. + # + # @api private + class RateLimits + def initialize + @deadlines = {} + end + + # Extends the rate limit for the category to the deadline, unless it already ends later. + # @param category [String, nil] the data category, or +nil+ for all categories + # @param deadline [Time] + # @return [void] + def update(category, deadline) + current = @deadlines[category] + @deadlines[category] = deadline if current.nil? || deadline > current + nil + end + + # @param category [String] + # @return [Boolean] whether the category, or all categories, are rate limited now + def limited?(category) + now = Time.now + [@deadlines[category], @deadlines[nil]].any? { |deadline| deadline && deadline > now } + end + + # @return [Boolean] whether any category is rate limited now + def any_limited? + now = Time.now + @deadlines.each_value.any? { |deadline| deadline > now } + end + + # @return [Hash{String, nil => Time}] a copy of the deadlines; changing it does not change the rate limits + def to_h + @deadlines.dup + end + end + end +end diff --git a/sentry-ruby/spec/sentry/transport/http_transport_rate_limiting_spec.rb b/sentry-ruby/spec/sentry/transport/http_transport_rate_limiting_spec.rb index 02d90f23f..2f973dd6b 100644 --- a/sentry-ruby/spec/sentry/transport/http_transport_rate_limiting_spec.rb +++ b/sentry-ruby/spec/sentry/transport/http_transport_rate_limiting_spec.rb @@ -20,12 +20,14 @@ subject { Sentry::HTTPTransport.new(configuration) } + let(:rate_limits) { subject.instance_variable_get(:@rate_limits) } + describe "#is_rate_limited?" do context "with only category limits" do it "returns true for still limited category" do - subject.rate_limits.merge!("error" => Time.now + 60, - "transaction" => Time.now + 60, - "session" => Time.now + 60) + rate_limits.update("error", Time.now + 60) + rate_limits.update("transaction", Time.now + 60) + rate_limits.update("session", Time.now + 60) expect(subject.is_rate_limited?("error")).to eq(true) expect(subject.is_rate_limited?("transaction")).to eq(true) @@ -33,9 +35,9 @@ end it "returns false for passed limited category" do - subject.rate_limits.merge!("error" => Time.now - 10, - "transaction" => Time.now - 10, - "session" => Time.now - 10) + rate_limits.update("error", Time.now - 10) + rate_limits.update("transaction", Time.now - 10) + rate_limits.update("session", Time.now - 10) expect(subject.is_rate_limited?("error")).to eq(false) expect(subject.is_rate_limited?("transaction")).to eq(false) @@ -43,7 +45,7 @@ end it "returns false for not listed category" do - subject.rate_limits.merge!("transaction" => Time.now + 10) + rate_limits.update("transaction", Time.now + 10) expect(subject.is_rate_limited?("error")).to eq(false) expect(subject.is_rate_limited?("session")).to eq(false) @@ -52,31 +54,29 @@ context "with only universal limits" do it "returns true when still limited" do - subject.rate_limits.merge!(nil => Time.now + 60) + rate_limits.update(nil, Time.now + 60) expect(subject.is_rate_limited?("error")).to eq(true) end it "returns false when passed limit" do - subject.rate_limits.merge!(nil => Time.now - 10) + rate_limits.update(nil, Time.now - 10) expect(subject.is_rate_limited?("error")).to eq(false) end end context "with both category-based and universal limits" do - it "checks both limits and picks the greater value" do - subject.rate_limits.merge!( - "error" => Time.now + 60, - nil => Time.now - 10 - ) + it "returns true when only the category limit is active" do + rate_limits.update("error", Time.now + 60) + rate_limits.update(nil, Time.now - 10) expect(subject.is_rate_limited?("error")).to eq(true) + end - subject.rate_limits.merge!( - "error" => Time.now - 60, - nil => Time.now + 10 - ) + it "returns true when only the universal limit is active" do + rate_limits.update("error", Time.now - 60) + rate_limits.update(nil, Time.now + 10) expect(subject.is_rate_limited?("error")).to eq(true) end @@ -89,17 +89,17 @@ end it "returns true for category limits" do - subject.rate_limits.merge!("error" => Time.now + 60) + rate_limits.update("error", Time.now + 60) expect(subject.any_rate_limited?).to eq(true) end it "returns true for universal limits" do - subject.rate_limits.merge!(nil => Time.now + 60) + rate_limits.update(nil, Time.now + 60) expect(subject.any_rate_limited?).to eq(true) end it "returns false for expired limits" do - subject.rate_limits.merge!("error" => Time.now - 60) + rate_limits.update("error", Time.now - 60) expect(subject.any_rate_limited?).to eq(false) end end @@ -129,6 +129,9 @@ { header: ",,foo,", expected_limits: {} }, + { + header: "3600:error:organization, 10:error:project", expected_limits: { "error" => now + 3600 } + }, { header: "42::organization, invalid, 4711:foobar;transaction;security:project", expected_limits: { @@ -156,7 +159,7 @@ end before do - subject.rate_limits.merge!("error" => now + 10) + rate_limits.update("error", now + 10) end it "overrides the current limit" do @@ -171,7 +174,7 @@ end before do - subject.rate_limits.merge!("error" => now + 120) + rate_limits.update("error", now + 120) end it "keeps the current limit" do diff --git a/sentry-ruby/spec/sentry/transport/rate_limits_spec.rb b/sentry-ruby/spec/sentry/transport/rate_limits_spec.rb new file mode 100644 index 000000000..b509eb3c2 --- /dev/null +++ b/sentry-ruby/spec/sentry/transport/rate_limits_spec.rb @@ -0,0 +1,37 @@ +# frozen_string_literal: true + +RSpec.describe Sentry::Transport::RateLimits do + subject { described_class.new } + + let(:now) { Time.now } + + describe "#update" do + [nil, "error"].each do |category| + context "with category #{category.inspect}" do + it "does not replace a longer deadline with a shorter one" do + subject.update(category, now + 3600) + subject.update(category, now + 10) + + expect(subject.to_h).to eq({ category => now + 3600 }) + end + + it "replaces a shorter deadline with a longer one" do + subject.update(category, now + 10) + subject.update(category, now + 3600) + + expect(subject.to_h).to eq({ category => now + 3600 }) + end + end + end + end + + describe "#to_h" do + it "returns a copy that does not change the rate limits" do + subject.update("error", now + 3600) + + subject.to_h["error"] = now - 10 + + expect(subject.to_h).to eq({ "error" => now + 3600 }) + end + end +end diff --git a/sentry-ruby/spec/sentry/transport_spec.rb b/sentry-ruby/spec/sentry/transport_spec.rb index a7cb90a41..6f63dc577 100644 --- a/sentry-ruby/spec/sentry/transport_spec.rb +++ b/sentry-ruby/spec/sentry/transport_spec.rb @@ -267,7 +267,7 @@ end context "when a batched log item is rate limited" do - before { subject.rate_limits.merge!("log_item" => Time.now + 60) } + before { subject.instance_variable_get(:@rate_limits).update("log_item", Time.now + 60) } it "records log_item count and log_byte size" do log_item = log_envelope.items.first @@ -279,7 +279,7 @@ end context "when a batched trace metric item is rate limited" do - before { subject.rate_limits.merge!("trace_metric" => Time.now + 60) } + before { subject.instance_variable_get(:@rate_limits).update("trace_metric", Time.now + 60) } it "records trace_metric count and trace_metric_byte size" do metric_item = metric_envelope.items.first diff --git a/sentry-ruby/spec/sentry_spec.rb b/sentry-ruby/spec/sentry_spec.rb index 77430216b..e5e0ebd97 100644 --- a/sentry-ruby/spec/sentry_spec.rb +++ b/sentry-ruby/spec/sentry_spec.rb @@ -263,7 +263,7 @@ config.transport.transport_class = Sentry::HTTPTransport end - Sentry.get_current_client.transport.rate_limits.merge!("error" => Time.now + 100) + Sentry.get_current_client.transport.instance_variable_get(:@rate_limits).update("error", Time.now + 100) end it "stops the event and logs correct message" do