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

orca: fix the delimiter of the native http parser #37724

Merged
merged 5 commits into from
Dec 19, 2024
Merged

orca: fix the delimiter of the native http parser #37724

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c597a6e
orca: fix the delimiter of the native http parser
Dec 18, 2024
ffe67a3
add change log
Dec 18, 2024
9164f00
Merge branch 'main' of https://github.com/envoyproxy/envoy into dev-f…
Dec 18, 2024
b07de5f
use both = and :
Dec 18, 2024
d27eeef
Merge branch 'main' of https://github.com/envoyproxy/envoy into dev-f…
Dec 19, 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
5 changes: 5 additions & 0 deletions changelogs/current.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,11 @@ bug_fixes:
- area: csrf
change: |
Handle requests that have a "privacy sensitive" / opaque origin (``Origin: null``) as if the request had no origin information.
- area: orca
change: |
The previous ORCA parser will use ``:`` as the delimiter of key/value pair in the native HTTP report. This is wrong
based on the design document. The correct delimiter should be ``=``. This change add the ``=`` delimiter support to
match the design document and keep the ``:`` delimiter for backward compatibility.
- area: http/1
change: |
Fixes sending overload crashes when HTTP/1 request is reset.
Expand Down
2 changes: 1 addition & 1 deletion source/common/orca/orca_parser.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ absl::Status tryParseNativeHttpEncoded(const absl::string_view header,
absl::flat_hash_set<absl::string_view> metric_names;
for (const auto value : values) {
std::pair<absl::string_view, absl::string_view> entry =
absl::StrSplit(value, absl::MaxSplits(':', 1), absl::SkipWhitespace());
absl::StrSplit(value, absl::MaxSplits(absl::ByAnyChar("=:"), 1), absl::SkipWhitespace());
if (metric_names.contains(entry.first)) {
return absl::AlreadyExistsError(
absl::StrCat(kEndpointLoadMetricsHeader, " contains duplicate metric: ", entry.first));
Expand Down
29 changes: 20 additions & 9 deletions test/common/orca/orca_parser_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,17 @@ TEST(OrcaParserUtilTest, EmptyOrcaHeader) {
}

TEST(OrcaParserUtilTest, NativeHttpEncodedHeader) {
Http::TestRequestHeaderMapImpl headers{
{std::string(kEndpointLoadMetricsHeader),
absl::StrCat(kHeaderFormatPrefixText,
"cpu_utilization=0.7,application_utilization=0.8,mem_utilization=0.9,"
"rps_fractional=1000,eps=2,"
"named_metrics.foo=123,named_metrics.bar=0.2,utilization.total=0.5")}};
EXPECT_THAT(parseOrcaLoadReportHeaders(headers),
StatusHelpers::IsOkAndHolds(ProtoEq(exampleOrcaLoadReport())));
}

TEST(OrcaParserUtilTest, NativeHttpEncodedHeaderWithColon) {
Http::TestRequestHeaderMapImpl headers{
{std::string(kEndpointLoadMetricsHeader),
absl::StrCat(kHeaderFormatPrefixText,
Expand All @@ -83,7 +94,7 @@ TEST(OrcaParserUtilTest, NativeHttpEncodedHeader) {
TEST(OrcaParserUtilTest, NativeHttpEncodedHeaderIncorrectFieldType) {
Http::TestRequestHeaderMapImpl headers{
{std::string(kEndpointLoadMetricsHeader),
absl::StrCat(kHeaderFormatPrefixText, "cpu_utilization:\"0.7\"")}};
absl::StrCat(kHeaderFormatPrefixText, "cpu_utilization=\"0.7\"")}};
adisuissa marked this conversation as resolved.
Show resolved Hide resolved
EXPECT_THAT(parseOrcaLoadReportHeaders(headers),
StatusHelpers::HasStatus(
absl::InvalidArgumentError("unable to parse custom backend load metric "
Expand All @@ -92,7 +103,7 @@ TEST(OrcaParserUtilTest, NativeHttpEncodedHeaderIncorrectFieldType) {

TEST(OrcaParserUtilTest, NativeHttpEncodedHeaderNanMetricValue) {
Http::TestRequestHeaderMapImpl headers{{std::string(kEndpointLoadMetricsHeader),
absl::StrCat(kHeaderFormatPrefixText, "cpu_utilization:",
absl::StrCat(kHeaderFormatPrefixText, "cpu_utilization=",
std::numeric_limits<double>::quiet_NaN())}};
EXPECT_THAT(parseOrcaLoadReportHeaders(headers),
StatusHelpers::HasStatus(absl::InvalidArgumentError(
Expand All @@ -101,7 +112,7 @@ TEST(OrcaParserUtilTest, NativeHttpEncodedHeaderNanMetricValue) {

TEST(OrcaParserUtilTest, NativeHttpEncodedHeaderInfinityMetricValue) {
Http::TestRequestHeaderMapImpl headers{{std::string(kEndpointLoadMetricsHeader),
absl::StrCat(kHeaderFormatPrefixText, "cpu_utilization:",
absl::StrCat(kHeaderFormatPrefixText, "cpu_utilization=",
std::numeric_limits<double>::infinity())}};
EXPECT_THAT(parseOrcaLoadReportHeaders(headers),
StatusHelpers::HasStatus(absl::InvalidArgumentError(
Expand All @@ -112,7 +123,7 @@ TEST(OrcaParserUtilTest, NativeHttpEncodedHeaderInfinityMetricValue) {
TEST(OrcaParserUtilTest, NativeHttpEncodedHeaderNegativeMetricValue) {
Http::TestRequestHeaderMapImpl headers{
{std::string(kEndpointLoadMetricsHeader),
absl::StrCat(kHeaderFormatPrefixText, "cpu_utilization:-1")}};
absl::StrCat(kHeaderFormatPrefixText, "cpu_utilization=-1")}};
EXPECT_THAT(parseOrcaLoadReportHeaders(headers),
StatusHelpers::HasStatus(absl::InvalidArgumentError(
"custom backend load metric value(cpu_utilization) cannot be negative.")));
Expand All @@ -121,7 +132,7 @@ TEST(OrcaParserUtilTest, NativeHttpEncodedHeaderNegativeMetricValue) {
TEST(OrcaParserUtilTest, NativeHttpEncodedHeaderContainsDuplicateMetric) {
Http::TestRequestHeaderMapImpl headers{
{std::string(kEndpointLoadMetricsHeader),
absl::StrCat(kHeaderFormatPrefixText, "cpu_utilization:0.7,cpu_utilization:0.8")}};
absl::StrCat(kHeaderFormatPrefixText, "cpu_utilization=0.7,cpu_utilization=0.8")}};
EXPECT_THAT(parseOrcaLoadReportHeaders(headers),
StatusHelpers::HasStatus(absl::AlreadyExistsError(absl::StrCat(
kEndpointLoadMetricsHeader, " contains duplicate metric: cpu_utilization"))));
Expand All @@ -130,7 +141,7 @@ TEST(OrcaParserUtilTest, NativeHttpEncodedHeaderContainsDuplicateMetric) {
TEST(OrcaParserUtilTest, NativeHttpEncodedHeaderUnsupportedMetric) {
Http::TestRequestHeaderMapImpl headers{
{std::string(kEndpointLoadMetricsHeader),
absl::StrCat(kHeaderFormatPrefixText, "cpu_utilization:0.7,unsupported_metric:0.8")}};
absl::StrCat(kHeaderFormatPrefixText, "cpu_utilization=0.7,unsupported_metric=0.8")}};
EXPECT_THAT(parseOrcaLoadReportHeaders(headers),
StatusHelpers::HasStatus(
absl::InvalidArgumentError("unsupported metric name: unsupported_metric")));
Expand All @@ -139,7 +150,7 @@ TEST(OrcaParserUtilTest, NativeHttpEncodedHeaderUnsupportedMetric) {
TEST(OrcaParserUtilTest, NativeHttpEncodedHeaderContainsEmptyUtilizationMetricKey) {
Http::TestRequestHeaderMapImpl headers{
{std::string(kEndpointLoadMetricsHeader),
absl::StrCat(kHeaderFormatPrefixText, "utilization.:0.9")}};
absl::StrCat(kHeaderFormatPrefixText, "utilization.=0.9")}};
EXPECT_THAT(
parseOrcaLoadReportHeaders(headers),
StatusHelpers::HasStatus(absl::InvalidArgumentError("utilization metric key is empty.")));
Expand All @@ -150,7 +161,7 @@ TEST(OrcaParserUtilTest, NativeHttpEncodedHeaderContainsDuplicateNamedMetric) {
{std::string(kEndpointLoadMetricsHeader),
absl::StrCat(
kHeaderFormatPrefixText,
"named_metrics.foo:123,named_metrics.duplicate:123,named_metrics.duplicate:0.2")}};
"named_metrics.foo=123,named_metrics.duplicate=123,named_metrics.duplicate=0.2")}};
EXPECT_THAT(
parseOrcaLoadReportHeaders(headers),
StatusHelpers::HasStatus(absl::AlreadyExistsError(absl::StrCat(
Expand All @@ -160,7 +171,7 @@ TEST(OrcaParserUtilTest, NativeHttpEncodedHeaderContainsDuplicateNamedMetric) {
TEST(OrcaParserUtilTest, NativeHttpEncodedHeaderContainsEmptyNamedMetricKey) {
Http::TestRequestHeaderMapImpl headers{
{std::string(kEndpointLoadMetricsHeader),
absl::StrCat(kHeaderFormatPrefixText, "named_metrics.:123")}};
absl::StrCat(kHeaderFormatPrefixText, "named_metrics.=123")}};
EXPECT_THAT(parseOrcaLoadReportHeaders(headers),
StatusHelpers::HasStatus(absl::InvalidArgumentError("named metric key is empty.")));
}
Expand Down
Loading