Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated RLQS Response handling to not reset TokenBucket state #36478

Merged
merged 3 commits into from
Oct 8, 2024
Merged

Updated RLQS Response handling to not reset TokenBucket state #36478

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4eb9ee2
Add logic to keep an existing token_bucket_limiter if a RLQS response…
bsurber Oct 7, 2024
83c698b
Move this cache-duplication check to outside of any specific strategy…
bsurber Oct 8, 2024
51bcaee
Cleanup unused func & fix CI complaint
bsurber Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion source/extensions/filters/http/rate_limit_quota/client_impl.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,20 @@ void RateLimitClientImpl::sendUsageReport(absl::optional<size_t> bucket_id) {
stream_->sendMessage(buildReport(bucket_id), /*end_stream=*/false);
}

bool cacheHasTokenBucket(const ::envoy::type::v3::TokenBucket& token_bucket,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This function is not used. Remove?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cleaned up, thanks.

const absl::optional<BucketAction> cached_action) {
if (!cached_action.has_value() || !cached_action->has_quota_assignment_action() ||
!cached_action->quota_assignment_action().has_rate_limit_strategy() ||
!cached_action->quota_assignment_action().rate_limit_strategy().has_token_bucket()) {
return false;
}
const ::envoy::type::v3::TokenBucket& cached_tb =
cached_action->quota_assignment_action().rate_limit_strategy().token_bucket();
return (cached_tb.max_tokens() == token_bucket.max_tokens() &&
cached_tb.tokens_per_fill().value() == token_bucket.tokens_per_fill().value() &&
cached_tb.fill_interval().nanos() == token_bucket.fill_interval().nanos());
}

void RateLimitClientImpl::onReceiveMessage(RateLimitQuotaResponsePtr&& response) {
ENVOY_LOG(debug, "The response that is received from RLQS server:\n{}", response->DebugString());
for (const auto& action : response->bucket_action()) {
Expand All @@ -100,8 +114,18 @@ void RateLimitClientImpl::onReceiveMessage(RateLimitQuotaResponsePtr&& response)
switch (action.bucket_action_case()) {
case envoy::service::rate_limit_quota::v3::RateLimitQuotaResponse_BucketAction::
kQuotaAssignmentAction: {
quota_buckets_[bucket_id]->cached_action = action;
absl::optional<BucketAction> cached_action = quota_buckets_[bucket_id]->cached_action;
quota_buckets_[bucket_id]->current_assignment_time = time_source_.monotonicTime();

if (cached_action.has_value() &&
Protobuf::util::MessageDifferencer::Equals(*cached_action, action)) {
ENVOY_LOG(debug,
"Cached action matches the incoming response so only TTL is updated for bucket "
"id: {}",
bucket_id);
break;
}
quota_buckets_[bucket_id]->cached_action = action;
if (quota_buckets_[bucket_id]->cached_action->has_quota_assignment_action()) {
auto rate_limit_strategy = quota_buckets_[bucket_id]
->cached_action->quota_assignment_action()
Expand Down
90 changes: 89 additions & 1 deletion test/extensions/filters/http/rate_limit_quota/client_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ class RateLimitClientTest : public testing::Test {
RateLimitTestClient test_client{};
};

using envoy::service::rate_limit_quota::v3::RateLimitQuotaResponse;

TEST_F(RateLimitClientTest, OpenAndCloseStream) {
EXPECT_OK(test_client.client_->startStream(&test_client.stream_info_));
EXPECT_CALL(test_client.stream_, closeStream());
Expand Down Expand Up @@ -53,7 +55,7 @@ TEST_F(RateLimitClientTest, SendRequestAndReceiveResponse) {

// `onQuotaResponse` callback is expected to be called.
EXPECT_CALL(test_client.callbacks_, onQuotaResponse);
envoy::service::rate_limit_quota::v3::RateLimitQuotaResponse resp;
RateLimitQuotaResponse resp;
auto response_buf = Grpc::Common::serializeMessage(resp);
EXPECT_TRUE(test_client.stream_callbacks_->onReceiveMessageRaw(std::move(response_buf)));

Expand Down Expand Up @@ -93,6 +95,92 @@ TEST_F(RateLimitClientTest, RestartStreamWhileInUse) {
{ test_client.client_->sendUsageReport(bucket_id_hash); });
}

TEST_F(RateLimitClientTest, HandlingDuplicateTokenBucketAssignments) {
EXPECT_OK(test_client.client_->startStream(test_client.stream_info_));
ASSERT_NE(test_client.stream_callbacks_, nullptr);

auto empty_request_headers = Http::RequestHeaderMapImpl::create();
test_client.stream_callbacks_->onCreateInitialMetadata(*empty_request_headers);
auto empty_response_headers = Http::ResponseHeaderMapImpl::create();
test_client.stream_callbacks_->onReceiveInitialMetadata(std::move(empty_response_headers));

// `onQuotaResponse` callback is expected to be called twice.
EXPECT_CALL(test_client.callbacks_, onQuotaResponse).Times(3);

::envoy::type::v3::TokenBucket token_bucket;
token_bucket.set_max_tokens(100);
token_bucket.mutable_tokens_per_fill()->set_value(10);
token_bucket.mutable_fill_interval()->set_seconds(1000);

::envoy::service::rate_limit_quota::v3::BucketId bucket_id;
bucket_id.mutable_bucket()->insert({"fairshare_group_id", "mock_group"});
const size_t bucket_id_hash = MessageUtil::hash(bucket_id);

Bucket initial_bucket_state;
initial_bucket_state.bucket_id = bucket_id;
test_client.bucket_cache_.insert(
{bucket_id_hash, std::make_unique<Bucket>(std::move(initial_bucket_state))});

RateLimitQuotaResponse::BucketAction action;
action.mutable_quota_assignment_action()
->mutable_rate_limit_strategy()
->mutable_token_bucket()
->MergeFrom(token_bucket);
action.mutable_bucket_id()->MergeFrom(bucket_id);

RateLimitQuotaResponse resp;
resp.add_bucket_action()->MergeFrom(action);
RateLimitQuotaResponse duplicate_resp;
duplicate_resp.add_bucket_action()->MergeFrom(action);

auto response_buf = Grpc::Common::serializeMessage(resp);
auto duplicate_response_buf = Grpc::Common::serializeMessage(duplicate_resp);
EXPECT_TRUE(test_client.stream_callbacks_->onReceiveMessageRaw(std::move(response_buf)));

ASSERT_EQ(test_client.bucket_cache_.size(), 1);
ASSERT_TRUE(test_client.bucket_cache_.contains(bucket_id_hash));
Bucket* first_bucket = test_client.bucket_cache_.at(bucket_id_hash).get();
TokenBucket* first_token_bucket_limiter = first_bucket->token_bucket_limiter.get();
EXPECT_TRUE(first_token_bucket_limiter);

// Send a duplicate response & expect the token bucket to be carried forward
// in the cache to avoid resetting token consumption.
EXPECT_TRUE(
test_client.stream_callbacks_->onReceiveMessageRaw(std::move(duplicate_response_buf)));

ASSERT_EQ(test_client.bucket_cache_.size(), 1);
ASSERT_TRUE(test_client.bucket_cache_.contains(bucket_id_hash));
Bucket* second_bucket = test_client.bucket_cache_.at(bucket_id_hash).get();
TokenBucket* second_token_bucket_limiter = second_bucket->token_bucket_limiter.get();
EXPECT_TRUE(second_token_bucket_limiter);
EXPECT_EQ(first_token_bucket_limiter, second_token_bucket_limiter);

// Expect the limiter to be replaced if the config changes.
resp.mutable_bucket_action(0)
->mutable_quota_assignment_action()
->mutable_rate_limit_strategy()
->mutable_token_bucket()
->set_max_tokens(200);
auto different_response_buf = Grpc::Common::serializeMessage(resp);
EXPECT_TRUE(
test_client.stream_callbacks_->onReceiveMessageRaw(std::move(different_response_buf)));

ASSERT_EQ(test_client.bucket_cache_.size(), 1);
ASSERT_TRUE(test_client.bucket_cache_.contains(bucket_id_hash));
Bucket* third_bucket = test_client.bucket_cache_.at(bucket_id_hash).get();
TokenBucket* third_token_bucket_limiter = third_bucket->token_bucket_limiter.get();
EXPECT_TRUE(third_token_bucket_limiter);
EXPECT_NE(first_token_bucket_limiter, third_token_bucket_limiter);

auto empty_response_trailers = Http::ResponseTrailerMapImpl::create();
test_client.stream_callbacks_->onReceiveTrailingMetadata(std::move(empty_response_trailers));

EXPECT_CALL(test_client.stream_, closeStream());
EXPECT_CALL(test_client.stream_, resetStream());
test_client.client_->closeStream();
test_client.client_->onRemoteClose(0, "");
}

} // namespace
} // namespace RateLimitQuota
} // namespace HttpFilters
Expand Down