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.

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

Make admission_control exception free #38308

Merged
merged 1 commit into from
Feb 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 8 additions & 4 deletions source/extensions/filters/http/admission_control/config.cc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ AdmissionControlFilterFactory::createFilterFactoryFromProtoTyped(
const std::string& stats_prefix, DualInfo dual_info,
Server::Configuration::ServerFactoryContext& context) {
if (config.has_sr_threshold() && config.sr_threshold().default_value().value() < 1.0) {
throw EnvoyException("Success rate threshold cannot be less than 1.0%.");
return absl::InvalidArgumentError("Success rate threshold cannot be less than 1.0%.");
}

const std::string prefix = stats_prefix + "admission_control.";
Expand All @@ -39,11 +39,15 @@ AdmissionControlFilterFactory::createFilterFactoryFromProtoTyped(

std::unique_ptr<ResponseEvaluator> response_evaluator;
switch (config.evaluation_criteria_case()) {
case AdmissionControlProto::EvaluationCriteriaCase::kSuccessCriteria:
response_evaluator = std::make_unique<SuccessCriteriaEvaluator>(config.success_criteria());
case AdmissionControlProto::EvaluationCriteriaCase::kSuccessCriteria: {
absl::StatusOr<std::unique_ptr<SuccessCriteriaEvaluator>> response_evaluator_or =
SuccessCriteriaEvaluator::create(config.success_criteria());
RETURN_IF_NOT_OK(response_evaluator_or.status());
response_evaluator = std::move(response_evaluator_or.value());
break;
}
case AdmissionControlProto::EvaluationCriteriaCase::EVALUATION_CRITERIA_NOT_SET:
throw EnvoyException("Evaluation criteria not set");
return absl::InvalidArgumentError("Evaluation criteria not set");
}

AdmissionControlFilterConfigSharedPtr filter_config =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,24 @@ namespace Extensions {
namespace HttpFilters {
namespace AdmissionControl {

SuccessCriteriaEvaluator::SuccessCriteriaEvaluator(const SuccessCriteria& success_criteria) {
absl::StatusOr<std::unique_ptr<SuccessCriteriaEvaluator>>
SuccessCriteriaEvaluator::create(const SuccessCriteria& success_criteria) {
absl::Status status = absl::OkStatus();
auto evaluator = std::unique_ptr<SuccessCriteriaEvaluator>(
new SuccessCriteriaEvaluator(success_criteria, status));
RETURN_IF_NOT_OK_REF(status);
return evaluator;
}

SuccessCriteriaEvaluator::SuccessCriteriaEvaluator(const SuccessCriteria& success_criteria,
absl::Status& creation_status) {
// HTTP status.
if (success_criteria.has_http_criteria()) {
for (const auto& range : success_criteria.http_criteria().http_success_status()) {
if (!validHttpRange(range.start(), range.end())) {
throw EnvoyException(
creation_status = absl::InvalidArgumentError(
fmt::format("invalid HTTP range: [{}, {})", range.start(), range.end()));
return;
}

const auto start = static_cast<uint64_t>(range.start());
Expand All @@ -36,7 +47,8 @@ SuccessCriteriaEvaluator::SuccessCriteriaEvaluator(const SuccessCriteria& succes
if (success_criteria.has_grpc_criteria()) {
for (const auto& status : success_criteria.grpc_criteria().grpc_success_status()) {
if (status > 16) {
throw EnvoyException(fmt::format("invalid gRPC code {}", status));
creation_status = absl::InvalidArgumentError(fmt::format("invalid gRPC code {}", status));
return;
}

grpc_success_codes_.emplace_back(status);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

#include "source/extensions/filters/http/admission_control/evaluators/response_evaluator.h"

#include "absl/status/statusor.h"

namespace Envoy {
namespace Extensions {
namespace HttpFilters {
Expand All @@ -16,12 +18,16 @@ class SuccessCriteriaEvaluator : public ResponseEvaluator {
public:
using SuccessCriteria =
envoy::extensions::filters::http::admission_control::v3::AdmissionControl::SuccessCriteria;
SuccessCriteriaEvaluator(const SuccessCriteria& evaluation_criteria);
static absl::StatusOr<std::unique_ptr<SuccessCriteriaEvaluator>>
create(const SuccessCriteria& success_criteria);

// ResponseEvaluator
bool isHttpSuccess(uint64_t code) const override;
bool isGrpcSuccess(uint32_t status) const override;

private:
SuccessCriteriaEvaluator(const SuccessCriteria& evaluation_criteria, absl::Status& status);

bool validHttpRange(const int32_t start, const int32_t end) const {
return start <= end && start < 600 && start >= 100 && end <= 600 && end >= 100;
}
Expand Down
26 changes: 11 additions & 15 deletions test/extensions/filters/http/admission_control/config_test.cc
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,9 @@ class AdmissionControlConfigTest : public testing::Test {
TestUtility::loadFromYamlAndValidate(yaml, proto);
auto tls = ThreadLocal::TypedSlot<ThreadLocalControllerImpl>::makeUnique(
context_.server_factory_context_.threadLocal());
auto evaluator = std::make_unique<SuccessCriteriaEvaluator>(proto.success_criteria());
auto evaluator_or = SuccessCriteriaEvaluator::create(proto.success_criteria());
EXPECT_TRUE(evaluator_or.ok());
auto evaluator = std::move(evaluator_or.value());
return std::make_shared<AdmissionControlFilterConfig>(proto, runtime_, random_, scope_,
std::move(tls), std::move(evaluator));
}
Expand Down Expand Up @@ -74,13 +76,10 @@ sampling_window: 1337s
AdmissionControlProto proto;
TestUtility::loadFromYamlAndValidate(yaml, proto);
NiceMock<Server::Configuration::MockFactoryContext> factory_context;
EXPECT_THROW_WITH_MESSAGE(
admission_control_filter_factory
.createFilterFactoryFromProtoTyped(proto, "whatever", dual_info_,
factory_context.serverFactoryContext())
.status()
.IgnoreError(),
EnvoyException, "Success rate threshold cannot be less than 1.0%.");
auto status_or = admission_control_filter_factory.createFilterFactoryFromProtoTyped(
proto, "whatever", dual_info_, factory_context.serverFactoryContext());
EXPECT_FALSE(status_or.ok());
EXPECT_EQ("Success rate threshold cannot be less than 1.0%.", status_or.status().message());
}

TEST_F(AdmissionControlConfigTest, SmallSuccessRateThreshold) {
Expand All @@ -105,13 +104,10 @@ sampling_window: 1337s
AdmissionControlProto proto;
TestUtility::loadFromYamlAndValidate(yaml, proto);
NiceMock<Server::Configuration::MockFactoryContext> factory_context;
EXPECT_THROW_WITH_MESSAGE(
admission_control_filter_factory
.createFilterFactoryFromProtoTyped(proto, "whatever", dual_info_,
factory_context.serverFactoryContext())
.status()
.IgnoreError(),
EnvoyException, "Success rate threshold cannot be less than 1.0%.");
auto status_or = admission_control_filter_factory.createFilterFactoryFromProtoTyped(
proto, "whatever", dual_info_, factory_context.serverFactoryContext());
EXPECT_FALSE(status_or.ok());
EXPECT_EQ("Success rate threshold cannot be less than 1.0%.", status_or.status().message());
}

// Verify the configuration when all fields are set.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,19 @@ class SuccessCriteriaTest : public testing::Test {
public:
SuccessCriteriaTest() = default;

void makeEvaluator(const std::string& yaml) {
void makeEvaluator(const std::string& yaml,
absl::optional<std::string> error_status_message = absl::nullopt) {
AdmissionControlProto::SuccessCriteria proto;
TestUtility::loadFromYamlAndValidate(yaml, proto);

evaluator_ = std::make_unique<SuccessCriteriaEvaluator>(proto);
absl::StatusOr<std::unique_ptr<SuccessCriteriaEvaluator>> evaluator_or =
SuccessCriteriaEvaluator::create(proto);
if (error_status_message.has_value()) {
EXPECT_EQ(error_status_message.value(), evaluator_or.status().message());
return;
}
EXPECT_TRUE(evaluator_or.ok());
evaluator_ = std::move(evaluator_or.value());
}

void expectHttpSuccess(int code) { EXPECT_TRUE(evaluator_->isHttpSuccess(code)); }
Expand Down Expand Up @@ -139,35 +147,34 @@ TEST_F(SuccessCriteriaTest, GrpcRangeValidation) {
grpc_success_status:
- 17
)EOF";
EXPECT_THROW_WITH_REGEX(makeEvaluator(yaml), EnvoyException, "invalid gRPC code*");
makeEvaluator(yaml, "invalid gRPC code 17");
}

// Verify correct HTTP range validation.
TEST_F(SuccessCriteriaTest, HttpRangeValidation) {
auto check_ranges = [this](std::string&& yaml) {
EXPECT_THROW_WITH_REGEX(makeEvaluator(yaml), EnvoyException, "invalid HTTP range*");
};

check_ranges(R"EOF(
makeEvaluator(R"EOF(
http_criteria:
http_success_status:
- start: 300
end: 200
)EOF");
)EOF",
"invalid HTTP range: [300, 200)");

check_ranges(R"EOF(
makeEvaluator(R"EOF(
http_criteria:
http_success_status:
- start: 600
end: 600
)EOF");
)EOF",
"invalid HTTP range: [600, 600)");

check_ranges(R"EOF(
makeEvaluator(R"EOF(
http_criteria:
http_success_status:
- start: 99
end: 99
)EOF");
)EOF",
"invalid HTTP range: [99, 99)");
}

} // namespace
Expand Down
1 change: 0 additions & 1 deletion tools/code_format/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,6 @@ paths:
- source/extensions/config_subscription
- source/extensions/compression/zstd/common/dictionary_manager.h
- source/extensions/filters/http/adaptive_concurrency/controller
- source/extensions/filters/http/admission_control
- source/extensions/filters/http/aws_lambda
- source/extensions/filters/http/basic_auth
- source/extensions/filters/http/cache
Expand Down