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

tag extractor: removing exceptions #33191

Merged
merged 1 commit into from
Mar 29, 2024
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
2 changes: 1 addition & 1 deletion envoy/common/exception.h
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ class EnvoyException : public std::runtime_error {

template <class Type> Type returnOrThrow(absl::StatusOr<Type> type_or_error) {
THROW_IF_STATUS_NOT_OK(type_or_error, throw);
return type_or_error.value();
return std::move(type_or_error.value());
}

#define THROW_OR_RETURN_VALUE(expression, type) returnOrThrow<type>(expression)
Expand Down
13 changes: 6 additions & 7 deletions source/common/stats/tag_extractor_impl.cc
Original file line number Diff line number Diff line change
Expand Up @@ -66,17 +66,16 @@ std::string TagExtractorImplBase::extractRegexPrefix(absl::string_view regex) {
return prefix;
}

TagExtractorPtr TagExtractorImplBase::createTagExtractor(absl::string_view name,
absl::string_view regex,
absl::string_view substr,
absl::string_view negative_match,
Regex::Type re_type) {
absl::StatusOr<TagExtractorPtr>
TagExtractorImplBase::createTagExtractor(absl::string_view name, absl::string_view regex,
absl::string_view substr, absl::string_view negative_match,
Regex::Type re_type) {
if (name.empty()) {
throwEnvoyExceptionOrPanic("tag_name cannot be empty");
return absl::InvalidArgumentError("tag_name cannot be empty");
}

if (regex.empty()) {
throwEnvoyExceptionOrPanic(fmt::format(
return absl::InvalidArgumentError(fmt::format(
"No regex specified for tag specifier and no default regex for name: '{}'", name));
}
switch (re_type) {
Expand Down
10 changes: 5 additions & 5 deletions source/common/stats/tag_extractor_impl.h
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,12 @@ class TagExtractorImplBase : public TagExtractor {
* in order to match the regex. This is an optional performance tweak
* to avoid large numbers of failed regex lookups.
* @param re_type the regular expression syntax used (Regex::Type::StdRegex or Regex::Type::Re2).
* @return TagExtractorPtr newly constructed TagExtractor.
* @return TagExtractorPtr newly constructed TagExtractor or a failure status.
*/
static TagExtractorPtr createTagExtractor(absl::string_view name, absl::string_view regex,
absl::string_view substr = "",
absl::string_view negative_match = "",
Regex::Type re_type = Regex::Type::StdRegex);
static absl::StatusOr<TagExtractorPtr>
createTagExtractor(absl::string_view name, absl::string_view regex, absl::string_view substr = "",
absl::string_view negative_match = "",
Regex::Type re_type = Regex::Type::StdRegex);

TagExtractorImplBase(absl::string_view name, absl::string_view regex,
absl::string_view substr = "");
Expand Down
16 changes: 11 additions & 5 deletions source/common/stats/tag_producer_impl.cc
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@ TagProducerImpl::TagProducerImpl(const envoy::config::metrics::v3::StatsConfig&
"No regex specified for tag specifier and no default regex for name: '{}'", name));
}
} else {
addExtractor(TagExtractorImplBase::createTagExtractor(name, tag_specifier.regex()));
addExtractor(THROW_OR_RETURN_VALUE(
TagExtractorImplBase::createTagExtractor(name, tag_specifier.regex()),
TagExtractorPtr));
}
} else if (tag_specifier.tag_value_case() ==
envoy::config::metrics::v3::TagSpecifier::TagValueCase::kFixedValue) {
Expand All @@ -53,8 +55,10 @@ int TagProducerImpl::addExtractorsMatching(absl::string_view name) {
int num_found = 0;
for (const auto& desc : Config::TagNames::get().descriptorVec()) {
if (desc.name_ == name) {
addExtractor(TagExtractorImplBase::createTagExtractor(desc.name_, desc.regex_, desc.substr_,
desc.negative_match_, desc.re_type_));
addExtractor(THROW_OR_RETURN_VALUE(
TagExtractorImplBase::createTagExtractor(desc.name_, desc.regex_, desc.substr_,
desc.negative_match_, desc.re_type_),
TagExtractorPtr));
++num_found;
}
}
Expand Down Expand Up @@ -135,8 +139,10 @@ void TagProducerImpl::reserveResources(const envoy::config::metrics::v3::StatsCo
void TagProducerImpl::addDefaultExtractors(const envoy::config::metrics::v3::StatsConfig& config) {
if (!config.has_use_all_default_tags() || config.use_all_default_tags().value()) {
for (const auto& desc : Config::TagNames::get().descriptorVec()) {
addExtractor(TagExtractorImplBase::createTagExtractor(desc.name_, desc.regex_, desc.substr_,
desc.negative_match_, desc.re_type_));
addExtractor(THROW_OR_RETURN_VALUE(
TagExtractorImplBase::createTagExtractor(desc.name_, desc.regex_, desc.substr_,
desc.negative_match_, desc.re_type_),
TagExtractorPtr));
}
for (const auto& desc : Config::TagNames::get().tokenizedDescriptorVec()) {
addExtractor(std::make_unique<TagExtractorTokensImpl>(desc.name_, desc.pattern_));
Expand Down
16 changes: 9 additions & 7 deletions test/common/stats/tag_extractor_impl_test.cc
Original file line number Diff line number Diff line change
Expand Up @@ -74,14 +74,15 @@ TEST(TagExtractorTest, noSubstrMismatch) {
}

TEST(TagExtractorTest, EmptyName) {
EXPECT_THROW_WITH_MESSAGE(
TagExtractorStdRegexImpl::createTagExtractor("", "^listener\\.(\\d+?\\.)"), EnvoyException,
EXPECT_EQ(
TagExtractorStdRegexImpl::createTagExtractor("", "^listener\\.(\\d+?\\.)").status().message(),
"tag_name cannot be empty");
}

TEST(TagExtractorTest, BadRegex) {
EXPECT_THROW_WITH_REGEX(TagExtractorStdRegexImpl::createTagExtractor("cluster_name", "+invalid"),
EnvoyException, "Invalid regex '\\+invalid':");
EXPECT_THROW_WITH_REGEX(
TagExtractorStdRegexImpl::createTagExtractor("cluster_name", "+invalid").IgnoreError(),
EnvoyException, "Invalid regex '\\+invalid':");
}

class DefaultTagRegexTester {
Expand Down Expand Up @@ -489,7 +490,7 @@ TEST(TagExtractorTest, ExtAuthzTagExtractors) {
TEST(TagExtractorTest, ExtractRegexPrefix) {
TagExtractorPtr tag_extractor; // Keep tag_extractor in this scope to prolong prefix lifetime.
auto extractRegexPrefix = [&tag_extractor](const std::string& regex) -> absl::string_view {
tag_extractor = TagExtractorStdRegexImpl::createTagExtractor("foo", regex);
tag_extractor = TagExtractorStdRegexImpl::createTagExtractor("foo", regex).value();
return tag_extractor->prefixToken();
};

Expand All @@ -504,8 +505,9 @@ TEST(TagExtractorTest, ExtractRegexPrefix) {
}

TEST(TagExtractorTest, CreateTagExtractorNoRegex) {
EXPECT_THROW_WITH_REGEX(TagExtractorStdRegexImpl::createTagExtractor("no such default tag", ""),
EnvoyException, "^No regex specified for tag specifier and no default");
EXPECT_THAT(
TagExtractorStdRegexImpl::createTagExtractor("no such default tag", "").status().message(),
testing::ContainsRegex("^No regex specified for tag specifier and no default"));
}

class TagExtractorTokensTest : public testing::Test {
Expand Down
Loading