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

feat(common): retry loops preserve original message #12368

Merged
merged 1 commit into from
Aug 11, 2023
Merged

feat(common): retry loops preserve original message #12368

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
6 changes: 6 additions & 0 deletions google/cloud/internal/async_rest_retry_loop_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,8 @@ TEST(AsyncRestRetryLoopTest, TransientFailureNonIdempotent) {
EXPECT_THAT(actual, StatusIs(StatusCode::kUnavailable,
HasSubstr("test-message-try-again")));
auto const& metadata = actual.status().error_info().metadata();
EXPECT_THAT(metadata, Contains(Pair("gcloud-cpp.retry.original-message",
"test-message-try-again")));
EXPECT_THAT(metadata,
Contains(Pair("gcloud-cpp.retry.reason", "non-idempotent")));
EXPECT_THAT(metadata,
Expand Down Expand Up @@ -289,6 +291,8 @@ TEST(AsyncRestRetryLoopTest, PermanentFailureIdempotent) {
EXPECT_THAT(actual, StatusIs(StatusCode::kPermissionDenied,
HasSubstr("test-message-uh-oh")));
auto const& metadata = actual.status().error_info().metadata();
EXPECT_THAT(metadata, Contains(Pair("gcloud-cpp.retry.original-message",
"test-message-uh-oh")));
EXPECT_THAT(metadata,
Contains(Pair("gcloud-cpp.retry.reason", "permanent-error")));
EXPECT_THAT(metadata,
Expand Down Expand Up @@ -317,6 +321,8 @@ TEST(AsyncRestRetryLoopTest, TooManyTransientFailuresIdempotent) {
EXPECT_THAT(actual, StatusIs(StatusCode::kUnavailable,
HasSubstr("test-message-try-again")));
auto const& metadata = actual.status().error_info().metadata();
EXPECT_THAT(metadata, Contains(Pair("gcloud-cpp.retry.original-message",
"test-message-try-again")));
EXPECT_THAT(metadata, Contains(Pair("gcloud-cpp.retry.reason",
"retry-policy-exhausted")));
EXPECT_THAT(metadata, Contains(Pair("gcloud-cpp.retry.on-entry", "false")));
Expand Down
6 changes: 6 additions & 0 deletions google/cloud/internal/async_retry_loop_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,8 @@ TEST(AsyncRetryLoopTest, TransientFailureNonIdempotent) {
EXPECT_THAT(actual, StatusIs(StatusCode::kUnavailable,
HasSubstr("test-message-try-again")));
auto const& metadata = actual.status().error_info().metadata();
EXPECT_THAT(metadata, Contains(Pair("gcloud-cpp.retry.original-message",
"test-message-try-again")));
EXPECT_THAT(metadata,
Contains(Pair("gcloud-cpp.retry.reason", "non-idempotent")));
EXPECT_THAT(metadata,
Expand All @@ -280,6 +282,8 @@ TEST(AsyncRetryLoopTest, PermanentFailureIdempotent) {
EXPECT_THAT(actual, StatusIs(StatusCode::kPermissionDenied,
HasSubstr("test-message-uh-oh")));
auto const& metadata = actual.status().error_info().metadata();
EXPECT_THAT(metadata, Contains(Pair("gcloud-cpp.retry.original-message",
"test-message-uh-oh")));
EXPECT_THAT(metadata,
Contains(Pair("gcloud-cpp.retry.reason", "permanent-error")));
EXPECT_THAT(metadata,
Expand Down Expand Up @@ -308,6 +312,8 @@ TEST(AsyncRetryLoopTest, TooManyTransientFailuresIdempotent) {
EXPECT_THAT(actual, StatusIs(StatusCode::kUnavailable,
HasSubstr("test-message-try-again")));
auto const& metadata = actual.status().error_info().metadata();
EXPECT_THAT(metadata, Contains(Pair("gcloud-cpp.retry.original-message",
"test-message-try-again")));
EXPECT_THAT(metadata, Contains(Pair("gcloud-cpp.retry.reason",
"retry-policy-exhausted")));
EXPECT_THAT(metadata, Contains(Pair("gcloud-cpp.retry.on-entry", "false")));
Expand Down
6 changes: 6 additions & 0 deletions google/cloud/internal/rest_retry_loop_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,8 @@ TEST(RestRetryLoopTest, TransientFailureNonIdempotent) {
EXPECT_EQ(StatusCode::kUnavailable, actual.status().code());
EXPECT_THAT(actual.status().message(), HasSubstr("try again"));
auto const& metadata = actual.status().error_info().metadata();
EXPECT_THAT(metadata,
Contains(Pair("gcloud-cpp.retry.original-message", "try again")));
EXPECT_THAT(metadata,
Contains(Pair("gcloud-cpp.retry.reason", "non-idempotent")));
EXPECT_THAT(metadata, Contains(Pair("gcloud-cpp.retry.function", __func__)));
Expand All @@ -199,6 +201,8 @@ TEST(RestRetryLoopTest, PermanentFailureFailureIdempotent) {
EXPECT_EQ(StatusCode::kPermissionDenied, actual.status().code());
EXPECT_THAT(actual.status().message(), HasSubstr("uh oh"));
auto const& metadata = actual.status().error_info().metadata();
EXPECT_THAT(metadata,
Contains(Pair("gcloud-cpp.retry.original-message", "uh oh")));
EXPECT_THAT(metadata,
Contains(Pair("gcloud-cpp.retry.reason", "permanent-error")));
EXPECT_THAT(metadata, Contains(Pair("gcloud-cpp.retry.function", __func__)));
Expand All @@ -218,6 +222,8 @@ TEST(RestRetryLoopTest, TooManyTransientFailuresIdempotent) {
EXPECT_EQ(StatusCode::kUnavailable, actual.status().code());
EXPECT_THAT(actual.status().message(), HasSubstr("try again"));
auto const& metadata = actual.status().error_info().metadata();
EXPECT_THAT(metadata,
Contains(Pair("gcloud-cpp.retry.original-message", "try again")));
EXPECT_THAT(metadata, Contains(Pair("gcloud-cpp.retry.reason",
"retry-policy-exhausted")));
EXPECT_THAT(metadata, Contains(Pair("gcloud-cpp.retry.on-entry", "false")));
Expand Down
25 changes: 15 additions & 10 deletions google/cloud/internal/retry_loop_helpers.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
namespace internal {
namespace {

void AddErrorMetadata(ErrorInfo& ei, char const* location, char const* reason) {
void AddErrorMetadata(ErrorInfo& ei, Status const& status, char const* location,
char const* reason) {
AddMetadata(ei, "gcloud-cpp.retry.original-message", status.message());
AddMetadata(ei, "gcloud-cpp.retry.function", location);
AddMetadata(ei, "gcloud-cpp.retry.reason", reason);
}
Expand All @@ -31,9 +33,10 @@ void AddOnEntry(ErrorInfo& ei, char const* value) {
AddMetadata(ei, "gcloud-cpp.retry.on-entry", value);
}

ErrorInfoBuilder AddErrorMetadata(ErrorInfoBuilder b, char const* location,
char const* reason) {
ErrorInfoBuilder AddErrorMetadata(ErrorInfoBuilder b, Status const& status,
char const* location, char const* reason) {
return std::move(b)
.WithMetadata("gcloud-cpp.retry.original-message", status.message())
.WithMetadata("gcloud-cpp.retry.function", location)
.WithMetadata("gcloud-cpp.retry.reason", reason);
}
Expand All @@ -43,7 +46,7 @@ ErrorInfoBuilder AddErrorMetadata(ErrorInfoBuilder b, char const* location,
Status RetryLoopNonIdempotentError(Status status, char const* location) {
if (status.ok()) return status;
auto ei = status.error_info();
AddErrorMetadata(ei, location, "non-idempotent");
AddErrorMetadata(ei, status, location, "non-idempotent");
auto message =
absl::StrCat("Error in non-idempotent operation: ", status.message());
return Status(status.code(), std::move(message), std::move(ei));
Expand All @@ -61,10 +64,11 @@ Status RetryLoopPermanentError(Status const& status, char const* location) {
if (status.ok()) {
return UnknownError(
absl::StrCat("Retry policy treats kOk as permanent error"),
AddErrorMetadata(GCP_ERROR_INFO(), location, "permanent-error"));
AddErrorMetadata(GCP_ERROR_INFO(), status, location,
"permanent-error"));
}
auto ei = status.error_info();
AddErrorMetadata(ei, location, "permanent-error");
AddErrorMetadata(ei, status, location, "permanent-error");
auto message = absl::StrCat("Permanent error, with a last message of ",
status.message());
return Status(status.code(), std::move(message), std::move(ei));
Expand All @@ -76,11 +80,12 @@ Status RetryLoopPolicyExhaustedError(Status const& status,
// This indicates the retry loop never made a request.
return DeadlineExceededError(
absl::StrCat("Retry policy exhausted before first request attempt"),
AddErrorMetadata(GCP_ERROR_INFO(), location, "retry-policy-exhausted")
AddErrorMetadata(GCP_ERROR_INFO(), status, location,
"retry-policy-exhausted")
.WithMetadata("gcloud-cpp.retry.on-entry", "true"));
}
auto ei = status.error_info();
AddErrorMetadata(ei, location, "retry-policy-exhausted");
AddErrorMetadata(ei, status, location, "retry-policy-exhausted");
AddOnEntry(ei, "false");
auto message = absl::StrCat("Retry policy exhausted, with a last message of ",
status.message());
Expand All @@ -92,10 +97,10 @@ Status RetryLoopCancelled(Status const& status, char const* location) {
// This indicates the retry loop never made a request.
return CancelledError(
absl::StrCat("Retry policy cancelled"),
AddErrorMetadata(GCP_ERROR_INFO(), location, "cancelled"));
AddErrorMetadata(GCP_ERROR_INFO(), status, location, "cancelled"));
}
auto ei = status.error_info();
AddErrorMetadata(ei, location, "cancelled");
AddErrorMetadata(ei, status, location, "cancelled");
auto message = absl::StrCat("Retry loop cancelled, with a last message of ",
status.message());
return Status(status.code(), std::move(message), std::move(ei));
Expand Down
8 changes: 8 additions & 0 deletions google/cloud/internal/retry_loop_helpers_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ TEST(RetryLoopHelpers, RetryLoopNonIdempotentError) {
EXPECT_THAT(actual.error_info().reason(), ei.reason());
EXPECT_THAT(actual.error_info().domain(), ei.domain());
EXPECT_THAT(actual.error_info().metadata(), IsSupersetOf(ei.metadata()));
EXPECT_THAT(actual.error_info().metadata(),
Contains(Pair("gcloud-cpp.retry.original-message", message)));
EXPECT_THAT(actual.error_info().metadata(),
Contains(Pair("gcloud-cpp.retry.function", "SomeFunction")));
EXPECT_THAT(actual.error_info().metadata(),
Expand All @@ -63,6 +65,8 @@ TEST(RetryLoopHelpers, RetryLoopPolicyErrorExhausted) {
EXPECT_THAT(actual.error_info().reason(), ei.reason());
EXPECT_THAT(actual.error_info().domain(), ei.domain());
EXPECT_THAT(actual.error_info().metadata(), IsSupersetOf(ei.metadata()));
EXPECT_THAT(actual.error_info().metadata(),
Contains(Pair("gcloud-cpp.retry.original-message", message)));
EXPECT_THAT(actual.error_info().metadata(),
Contains(Pair("gcloud-cpp.retry.function", "SomeFunction")));
EXPECT_THAT(
Expand Down Expand Up @@ -97,6 +101,8 @@ TEST(RetryLoopHelpers, RetryLoopPolicyErrorNotExhausted) {
EXPECT_THAT(actual.error_info().reason(), ei.reason());
EXPECT_THAT(actual.error_info().domain(), ei.domain());
EXPECT_THAT(actual.error_info().metadata(), IsSupersetOf(ei.metadata()));
EXPECT_THAT(actual.error_info().metadata(),
Contains(Pair("gcloud-cpp.retry.original-message", message)));
EXPECT_THAT(actual.error_info().metadata(),
Contains(Pair("gcloud-cpp.retry.function", "SomeFunction")));
EXPECT_THAT(actual.error_info().metadata(),
Expand All @@ -122,6 +128,8 @@ TEST(RetryLoopHelpers, RetryLoopErrorCancelled) {
EXPECT_THAT(actual.error_info().reason(), ei.reason());
EXPECT_THAT(actual.error_info().domain(), ei.domain());
EXPECT_THAT(actual.error_info().metadata(), IsSupersetOf(ei.metadata()));
EXPECT_THAT(actual.error_info().metadata(),
Contains(Pair("gcloud-cpp.retry.original-message", message)));
EXPECT_THAT(actual.error_info().metadata(),
Contains(Pair("gcloud-cpp.retry.function", "SomeFunction")));
EXPECT_THAT(actual.error_info().metadata(),
Expand Down
6 changes: 6 additions & 0 deletions google/cloud/internal/retry_loop_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,8 @@ TEST(RetryLoopTest, TransientFailureNonIdempotent) {
EXPECT_EQ(StatusCode::kUnavailable, actual.status().code());
EXPECT_THAT(actual.status().message(), HasSubstr("try again"));
auto const& metadata = actual.status().error_info().metadata();
EXPECT_THAT(metadata,
Contains(Pair("gcloud-cpp.retry.original-message", "try again")));
EXPECT_THAT(metadata,
Contains(Pair("gcloud-cpp.retry.reason", "non-idempotent")));
EXPECT_THAT(metadata, Contains(Pair("gcloud-cpp.retry.function", __func__)));
Expand All @@ -178,6 +180,8 @@ TEST(RetryLoopTest, PermanentFailureFailureIdempotent) {
EXPECT_EQ(StatusCode::kPermissionDenied, actual.status().code());
EXPECT_THAT(actual.status().message(), HasSubstr("uh oh"));
auto const& metadata = actual.status().error_info().metadata();
EXPECT_THAT(metadata,
Contains(Pair("gcloud-cpp.retry.original-message", "uh oh")));
EXPECT_THAT(metadata,
Contains(Pair("gcloud-cpp.retry.reason", "permanent-error")));
EXPECT_THAT(metadata, Contains(Pair("gcloud-cpp.retry.function", __func__)));
Expand All @@ -198,6 +202,8 @@ TEST(RetryLoopTest, TooManyTransientFailuresIdempotent) {
EXPECT_EQ(StatusCode::kUnavailable, actual.status().code());
EXPECT_THAT(actual.status().message(), HasSubstr("try again"));
auto const& metadata = actual.status().error_info().metadata();
EXPECT_THAT(metadata,
Contains(Pair("gcloud-cpp.retry.original-message", "try again")));
EXPECT_THAT(metadata, Contains(Pair("gcloud-cpp.retry.reason",
"retry-policy-exhausted")));
EXPECT_THAT(metadata, Contains(Pair("gcloud-cpp.retry.on-entry", "false")));
Expand Down