Skip to content

health_check: remove deprecated endpoint field #3891

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

Merged
zuercher merged 3 commits into from
Jul 24, 2018
Merged

health_check: remove deprecated endpoint field #3891

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6d65e13
Remove deprecated endpoint field for the health check filter
mrice32 Jul 18, 2018
df4529e
Fix docs.
mrice32 Jul 23, 2018
a5888df
Fix docs again.
mrice32 Jul 24, 2018
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
11 changes: 3 additions & 8 deletions api/envoy/config/filter/http/health_check/v2/health_check.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,8 @@ message HealthCheck {
// Specifies whether the filter operates in pass through mode or not.
google.protobuf.BoolValue pass_through_mode = 1 [(validate.rules).message.required = true];

// Specifies the incoming HTTP endpoint that should be considered the
// health check endpoint. For example */healthcheck*.
// Note that this field is deprecated in favor of
// :ref:`headers <envoy_api_field_config.filter.http.health_check.v2.HealthCheck.headers>`.
string endpoint = 2 [deprecated = true];
reserved 2;
reserved "endpoint";

// If operating in pass through mode, the amount of time in milliseconds
// that the filter should cache the upstream response.
Expand All @@ -36,8 +33,6 @@ message HealthCheck {

// Specifies a set of health check request headers to match on. The health check filter will
// check a request’s headers against all the specified headers. To specify the health check
// endpoint, set the ``:path`` header to match on. Note that if the
// :ref:`endpoint <envoy_api_field_config.filter.http.health_check.v2.HealthCheck.endpoint>`
// field is set, it will overwrite any ``:path`` header to match.
// endpoint, set the ``:path`` header to match on.
repeated envoy.api.v2.route.HeaderMatcher headers = 5;
}
3 changes: 1 addition & 2 deletions docs/root/intro/version_history.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,7 @@ Version history
* health check: health check connections can now be configured to use http/2.
* health check http filter: added
:ref:`generic header matching <envoy_api_field_config.filter.http.health_check.v2.HealthCheck.headers>`
to trigger health check response. Deprecated the
:ref:`endpoint option <envoy_api_field_config.filter.http.health_check.v2.HealthCheck.endpoint>`.
to trigger health check response. Deprecated the endpoint option.
* http: filters can now optionally support
:ref:`virtual host <envoy_api_field_route.VirtualHost.per_filter_config>`,
:ref:`route <envoy_api_field_route.Route.per_filter_config>`, and
Expand Down
5 changes: 4 additions & 1 deletion source/common/config/filter_json.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,10 @@ void FilterJson::translateHealthCheckFilter(

JSON_UTIL_SET_BOOL(json_config, proto_config, pass_through_mode);
JSON_UTIL_SET_DURATION(json_config, proto_config, cache_time);
JSON_UTIL_SET_STRING(json_config, proto_config, endpoint);
std::string endpoint = json_config.getString("endpoint");
auto& header = *proto_config.add_headers();
header.set_name(":path");
header.set_exact_match(endpoint);
}

void FilterJson::translateGrpcJsonTranscoder(
Expand Down
15 changes: 1 addition & 14 deletions source/extensions/filters/http/health_check/config.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,25 +20,12 @@ Http::FilterFactoryCb HealthCheckFilterConfig::createFilterFactoryFromProtoTyped

const bool pass_through_mode = proto_config.pass_through_mode().value();
const int64_t cache_time_ms = PROTOBUF_GET_MS_OR_DEFAULT(proto_config, cache_time, 0);
const std::string hc_endpoint = proto_config.endpoint();

auto header_match_data = std::make_shared<std::vector<Http::HeaderUtility::HeaderData>>();

// TODO(mrice32): remove endpoint field at the end of the 1.7.0 deprecation cycle.
const bool endpoint_set = !proto_config.endpoint().empty();
if (endpoint_set) {
envoy::api::v2::route::HeaderMatcher matcher;
matcher.set_name(Http::Headers::get().Path.get());
matcher.set_exact_match(proto_config.endpoint());
header_match_data->emplace_back(matcher);
}

for (const envoy::api::v2::route::HeaderMatcher& matcher : proto_config.headers()) {
Http::HeaderUtility::HeaderData single_header_match(matcher);
// Ignore any path header matchers if the endpoint field has been set.
if (!(endpoint_set && single_header_match.name_ == Http::Headers::get().Path)) {
header_match_data->push_back(std::move(single_header_match));
}
header_match_data->push_back(std::move(single_header_match));
}

if (!pass_through_mode && cache_time_ms) {
Expand Down
48 changes: 9 additions & 39 deletions test/extensions/filters/http/health_check/config_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,10 @@ TEST(HealthCheckFilterConfig, FailsWhenNotPassThroughButTimeoutSetProto) {
NiceMock<Server::Configuration::MockFactoryContext> context;

config.mutable_pass_through_mode()->set_value(false);
config.set_endpoint("foo");
config.mutable_cache_time()->set_seconds(10);
envoy::api::v2::route::HeaderMatcher& header = *config.add_headers();
header.set_name(":path");
header.set_exact_match("foo");

EXPECT_THROW(
healthCheckFilterConfig.createFilterFactoryFromProto(config, "dummy_stats_prefix", context),
Expand All @@ -85,7 +87,9 @@ TEST(HealthCheckFilterConfig, NotFailingWhenNotPassThroughAndTimeoutNotSetProto)
NiceMock<Server::Configuration::MockFactoryContext> context;

config.mutable_pass_through_mode()->set_value(false);
config.set_endpoint("foo");
envoy::api::v2::route::HeaderMatcher& header = *config.add_headers();
header.set_name(":path");
header.set_exact_match("foo");
healthCheckFilterConfig.createFilterFactoryFromProto(config, "dummy_stats_prefix", context);
}

Expand All @@ -97,7 +101,9 @@ TEST(HealthCheckFilterConfig, HealthCheckFilterWithEmptyProto) {
healthCheckFilterConfig.createEmptyConfigProto().get());

config.mutable_pass_through_mode()->set_value(false);
config.set_endpoint("foo");
envoy::api::v2::route::HeaderMatcher& header = *config.add_headers();
header.set_name(":path");
header.set_exact_match("foo");
healthCheckFilterConfig.createFilterFactoryFromProto(config, "dummy_stats_prefix", context);
}

Expand Down Expand Up @@ -195,42 +201,6 @@ TEST(HealthCheckFilterConfig, HealthCheckFilterHeaderMatchMissingHeader) {
testHealthCheckHeaderMatch(config, headers, false);
}

// If an endpoint is specified and the path matches, it should match regardless of any :path
// conditions given in the headers field.
TEST(HealthCheckFilterConfig, HealthCheckFilterEndpoint) {
envoy::config::filter::http::health_check::v2::HealthCheck config;

config.mutable_pass_through_mode()->set_value(false);

config.set_endpoint("foo");

envoy::api::v2::route::HeaderMatcher& header = *config.add_headers();
header.set_name(Http::Headers::get().Path.get());
header.set_exact_match("bar");

Http::TestHeaderMapImpl headers{{Http::Headers::get().Path.get(), "foo"}};

testHealthCheckHeaderMatch(config, headers, true);
}

// If an endpoint is specified and the path does not match, the filter should not match regardless
// of any :path conditions given in the headers field.
TEST(HealthCheckFilterConfig, HealthCheckFilterEndpointOverride) {
envoy::config::filter::http::health_check::v2::HealthCheck config;

config.mutable_pass_through_mode()->set_value(false);

config.set_endpoint("foo");

envoy::api::v2::route::HeaderMatcher& header = *config.add_headers();
header.set_name(Http::Headers::get().Path.get());
header.set_exact_match("bar");

Http::TestHeaderMapImpl headers{{Http::Headers::get().Path.get(), "bar"}};

testHealthCheckHeaderMatch(config, headers, false);
}

// Conditions for the same header should match if they are both satisfied.
TEST(HealthCheckFilterConfig, HealthCheckFilterDuplicateMatch) {
envoy::config::filter::http::health_check::v2::HealthCheck config;
Expand Down