discourse/spec/lib/middleware/overload_protections_spec.rb
Alan Guo Xiang Tan 9c781af9d1
PERF: Reject anonymous requests with 503 upon aggressive queuing (#36519)
This commit adds a default protection to all Discourse app which will
turn away all anonymous requests that has queued for more than the
duration configured
by the `reject_anonymous_min_queue_seconds` global setting, 1 second
by default. A queue time of 1 second is a sign that the app is very
overloaded so we are opting to turn away anonymous requests when that
happens.

While there may be better solutions like introducing an adaptive
concurrency limit somewhere in the stack, we like this solution for its
simplicity. We may consider the more complex solutions in the future but
the time is not now.

Other significant changes in this commit:

1. Moved setting of the `REQUEST_QUEUE_SECONDS` key in `env` to
   `Middleware::ProcessingRequest`.
2. Introduction of the `reject_anonymous_min_queue_seconds` global
   Setting.
2025-12-18 10:23:42 +08:00

64 lines
2 KiB
Ruby

# frozen_string_literal: true
RSpec.describe Middleware::OverloadProtections do
let(:app) { described_class.new(->(env) { [200, {}, ["OK"]] }) }
describe "#call" do
it "returns 503 for anonymous users when queue time exceeds threshold" do
global_setting :reject_anonymous_min_queue_seconds, 1.0
env =
create_request_env.merge(
Middleware::ProcessingRequest::REQUEST_QUEUE_SECONDS_ENV_KEY => 1.1,
)
status, _headers, body = app.call(env)
expect(status).to eq(503)
expect(body).to eq(["Server is currently experiencing high load. Please try again later."])
end
it "returns 503 when user's auth cookie is invalid and queue time exceeds threshold" do
global_setting :reject_anonymous_min_queue_seconds, 1.0
env =
create_request_env.merge(
Middleware::ProcessingRequest::REQUEST_QUEUE_SECONDS_ENV_KEY => 1.1,
"HTTP_COOKIE" => "_t=invalid_cookie",
)
status, _headers, body = app.call(env)
expect(status).to eq(503)
expect(body).to eq(["Server is currently experiencing high load. Please try again later."])
end
it "returns 200 for anonymous users when queue time is below threshold" do
global_setting :reject_anonymous_min_queue_seconds, 2.0
env =
create_request_env.merge(
Middleware::ProcessingRequest::REQUEST_QUEUE_SECONDS_ENV_KEY => 1.5,
)
status, _headers, body = app.call(env)
expect(status).to eq(200)
end
it "returns 200 for logged-in users even when queue time exceeds threshold" do
global_setting :reject_anonymous_min_queue_seconds, 1.0
cookie = create_auth_cookie(token: SecureRandom.hex)
env =
create_request_env.merge(
Middleware::ProcessingRequest::REQUEST_QUEUE_SECONDS_ENV_KEY => 1.1,
"HTTP_COOKIE" => "_t=#{cookie}",
)
status, _headers, body = app.call(env)
expect(status).to eq(200)
end
end
end