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

Error message to mention UpstreamCodec filter #36367

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+64 −13
Open

Error message to mention UpstreamCodec filter #36367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 23 additions & 0 deletions source/common/config/utility.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,5 +346,28 @@ Utility::buildJitteredExponentialBackOffStrategy(
default_base_interval_ms, default_base_interval_ms * 10, random);
}

absl::Status Utility::validateTerminalFilters(const std::string& name,
const std::string& filter_type,
const std::string& filter_chain_type,
bool is_terminal_filter,
bool last_filter_in_current_config) {
if (is_terminal_filter && !last_filter_in_current_config) {
return absl::InvalidArgumentError(
fmt::format("Error: terminal filter named {} of type {} must be the "
"last filter in a {} filter chain.",
name, filter_type, filter_chain_type));
} else if (!is_terminal_filter && last_filter_in_current_config) {
absl::string_view extra = "";
if (filter_chain_type == "router upstream http") {
extra = " When upstream_http_filters are specified, they must explicitly end with an "
"UpstreamCodec filter.";
}
return absl::InvalidArgumentError(fmt::format("Error: non-terminal filter named {} of type "
"{} is the last filter in a {} filter chain.{}",
name, filter_type, filter_chain_type, extra));
}
return absl::OkStatus();
}

} // namespace Config
} // namespace Envoy
14 changes: 1 addition & 13 deletions source/common/config/utility.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -424,19 +424,7 @@ class Utility {
const std::string& filter_type,
const std::string& filter_chain_type,
bool is_terminal_filter,
bool last_filter_in_current_config) {
if (is_terminal_filter && !last_filter_in_current_config) {
return absl::InvalidArgumentError(
fmt::format("Error: terminal filter named {} of type {} must be the "
"last filter in a {} filter chain.",
name, filter_type, filter_chain_type));
} else if (!is_terminal_filter && last_filter_in_current_config) {
return absl::InvalidArgumentError(fmt::format(
"Error: non-terminal filter named {} of type {} is the last filter in a {} filter chain.",
name, filter_type, filter_chain_type));
}
return absl::OkStatus();
}
bool last_filter_in_current_config);

/**
* Prepares the DNS failure refresh backoff strategy given the cluster configuration.
Expand Down
1 change: 1 addition & 0 deletions test/common/config/BUILD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ envoy_cc_test(
"//test/mocks/upstream:thread_local_cluster_mocks",
"//test/test_common:environment_lib",
"//test/test_common:logging_lib",
"//test/test_common:status_utility_lib",
"//test/test_common:test_runtime_lib",
"//test/test_common:utility_lib",
"@com_github_cncf_xds//udpa/type/v1:pkg_cc_proto",
Expand Down
39 changes: 39 additions & 0 deletions test/common/config/utility_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
#include "test/mocks/upstream/thread_local_cluster.h"
#include "test/test_common/environment.h"
#include "test/test_common/logging.h"
#include "test/test_common/status_utility.h"
#include "test/test_common/test_runtime.h"
#include "test/test_common/utility.h"

Expand All @@ -29,6 +30,7 @@
#include "udpa/type/v1/typed_struct.pb.h"
#include "xds/type/v3/typed_struct.pb.h"

using Envoy::StatusHelpers::HasStatusMessage;
using testing::ContainsRegex;
using testing::Eq;
using testing::HasSubstr;
Expand Down Expand Up @@ -894,6 +896,43 @@ TEST(UtilityTest, GetGrpcControlPlane) {
}
}

TEST(UtilityTest, ValidateTerminalFiltersSucceeds) {
EXPECT_OK(Utility::validateTerminalFilters("filter_name", "filter_type", "chain_type",
/*is_terminal_filter=*/true,
/*last_filter_in_current_config=*/true));
EXPECT_OK(Utility::validateTerminalFilters("filter_name", "filter_type", "chain_type",
/*is_terminal_filter=*/false,
/*last_filter_in_current_config=*/false));
}

TEST(UtilityTest, ValidateTerminalFilterFailsWithMisplacedTerminalFilter) {
EXPECT_THAT(
Utility::validateTerminalFilters("filter_name", "filter_type", "chain_type",
/*is_terminal_filter=*/true,
/*last_filter_in_current_config=*/false),
HasStatusMessage("Error: terminal filter named filter_name of type filter_type must be the "
"last filter in a chain_type filter chain."));
}

TEST(UtilityTest, ValidateTerminalFilterFailsWithMissingTerminalFilter) {
EXPECT_THAT(Utility::validateTerminalFilters("filter_name", "filter_type", "chain_type",
/*is_terminal_filter=*/false,
/*last_filter_in_current_config=*/true),
HasStatusMessage("Error: non-terminal filter named filter_name of type "
"filter_type is the last filter in a chain_type filter chain."));
}

TEST(UtilityTest, ValidateTerminalFilterFailsWithMissingUpstreamTerminalFilter) {
EXPECT_THAT(
Utility::validateTerminalFilters("filter_name", "filter_type", "router upstream http",
/*is_terminal_filter=*/false,
/*last_filter_in_current_config=*/true),
HasStatusMessage("Error: non-terminal filter named filter_name of type "
"filter_type is the last filter in a router upstream http filter chain. "
"When upstream_http_filters are specified, they must explicitly end with an "
"UpstreamCodec filter."));
}

} // namespace
} // namespace Config
} // namespace Envoy