Skip to content

Commit

Permalink
New Retry Strategy and Headers
Browse files Browse the repository at this point in the history
1. Add new request headers for each attempt to retry:
amz-sdk-invocation-id: <uuid>
amz-sdk-request: ttl=<current time + request timeout + clock skew>; attempt=<current attempt number>; max=<max number of attempts>

2. Add a new retry strategy
With the new StandardRetryStrategy, SDK is using retry quotas to limit the number of failed retries.
Each request will acquire tokens from available retry quotas to retry, and release tokens if succeeds. If the service client is running out of quotas, SDK will not retry the requests.

3. Add a new date parser for ISO_8601_BASIC: %Y%m%dT%H%M%SZ
  • Loading branch information
wps132230 authored and Pushen Wang committed Apr 30, 2020
1 parent 9acede8 commit cac7d64
Show file tree
Hide file tree
Showing 23 changed files with 1,015 additions and 89 deletions.
149 changes: 137 additions & 12 deletions aws-cpp-sdk-core-tests/aws/client/AWSClientTest.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,33 @@ class AWSClientTestSuite : public ::testing::Test
}
mockHttpClient->AddResponseToReturn(httpResponse);
}

void QueueMockResponse(const AWSError<CoreErrors>& clientError, const HeaderValueCollection& headers)
{
auto httpRequest = CreateHttpRequest(URI("http://www.uri.com/path/to/res"),
HttpMethod::HTTP_GET, Aws::Utils::Stream::DefaultResponseStreamFactoryMethod);
auto httpResponse = Aws::MakeShared<StandardHttpResponse>(ALLOCATION_TAG, httpRequest);
httpResponse->SetClientErrorType(clientError.GetErrorType());
httpResponse->SetClientErrorMessage(clientError.GetMessage());
httpResponse->GetResponseBody() << "";
for(auto&& header : headers)
{
httpResponse->AddHeader(header.first, header.second);
}
mockHttpClient->AddResponseToReturn(httpResponse);
}

Aws::String ExtractFromRequestInfo(const Aws::String& requestInfo, const Aws::String& key)
{
auto iter = requestInfo.find(key + "=");
if (iter == Aws::String::npos)
{
return {};
}
Aws::String substr = requestInfo.substr(iter + key.size() + 1);
substr.erase(std::find_if(substr.begin(), substr.end(), [](char ch) {return ch == ';';} ), substr.end());
return substr;
}
};

class AWSConfigTestSuite : public ::testing::Test
Expand Down Expand Up @@ -139,11 +166,9 @@ class AWSConfigTestSuite : public ::testing::Test

TEST_F(AWSClientTestSuite, TestClockSkewOutsideAcceptableRange)
{
HeaderValueCollection responseHeaders, requestHeaders;
HeaderValueCollection responseHeaders;
responseHeaders.emplace("Date", (DateTime::Now() + std::chrono::hours(1)).ToGmtString(DateFormat::RFC822)); // server is ahead of us by 1 hour
AmazonWebServiceRequestMock request;
requestHeaders.emplace("X-Amz-Date", DateTime::Now().ToGmtString(DateFormat::ISO_8601));
request.SetHeaders(requestHeaders);
QueueMockResponse(HttpResponseCode::BAD_REQUEST, responseHeaders);
QueueMockResponse(HttpResponseCode::BAD_REQUEST, responseHeaders);
auto outcome = client->MakeRequest(request);
Expand All @@ -153,11 +178,9 @@ TEST_F(AWSClientTestSuite, TestClockSkewOutsideAcceptableRange)

TEST_F(AWSClientTestSuite, TestClockSkewWithinAcceptableRange)
{
HeaderValueCollection responseHeaders, requestHeaders;
HeaderValueCollection responseHeaders;
responseHeaders.emplace("Date", (DateTime::Now() + std::chrono::minutes(2)).ToGmtString(DateFormat::RFC822)); // server is ahead of us by 2 minutes
AmazonWebServiceRequestMock request;
requestHeaders.emplace("X-Amz-Date", DateTime::Now().ToGmtString(DateFormat::ISO_8601));
request.SetHeaders(requestHeaders);
QueueMockResponse(HttpResponseCode::BAD_REQUEST, responseHeaders);
auto outcome = client->MakeRequest(request);
ASSERT_FALSE(outcome.IsSuccess());
Expand All @@ -167,11 +190,9 @@ TEST_F(AWSClientTestSuite, TestClockSkewWithinAcceptableRange)
TEST_F(AWSClientTestSuite, TestClockSkewConsecutiveRequests)
{
// first request should set the skew offset and retry, but following requests should not
HeaderValueCollection responseHeaders, requestHeaders;
HeaderValueCollection responseHeaders;
responseHeaders.emplace("Date", (DateTime::Now() + std::chrono::hours(1)).ToGmtString(DateFormat::RFC822)); // server is ahead of us by 1 hour
AmazonWebServiceRequestMock request;
requestHeaders.emplace("X-Amz-Date", DateTime::Now().ToGmtString(DateFormat::ISO_8601));
request.SetHeaders(requestHeaders);
QueueMockResponse(HttpResponseCode::BAD_REQUEST, responseHeaders);
QueueMockResponse(HttpResponseCode::BAD_REQUEST, responseHeaders);
auto outcome = client->MakeRequest(request);
Expand All @@ -198,11 +219,9 @@ TEST_F(AWSClientTestSuite, TestClockChangesAfterSkewHasBeenSet)
// The skew should reflect the clock's changes.

// make an initial request so that a skew adjustment is set
HeaderValueCollection responseHeaders, requestHeaders;
HeaderValueCollection responseHeaders;
responseHeaders.emplace("Date", (DateTime::Now() + std::chrono::hours(1)).ToGmtString(DateFormat::RFC822)); // server is ahead of us by 1 hour
AmazonWebServiceRequestMock request;
requestHeaders.emplace("X-Amz-Date", DateTime::Now().ToGmtString(DateFormat::ISO_8601));
request.SetHeaders(requestHeaders);
QueueMockResponse(HttpResponseCode::BAD_REQUEST, responseHeaders);
QueueMockResponse(HttpResponseCode::BAD_REQUEST, responseHeaders);
auto outcome = client->MakeRequest(request);
Expand All @@ -228,6 +247,112 @@ TEST_F(AWSClientTestSuite, TestClockChangesAfterSkewHasBeenSet)
ASSERT_EQ(1, client->GetRequestAttemptedRetries());
}

TEST_F(AWSClientTestSuite, TestRetryHeaders)
{
// The first server time is ahead of us by 1 hour.
DateTime serverTime1 = DateTime::Now() + std::chrono::hours(1);
QueueMockResponse(HttpResponseCode::REQUEST_NOT_MADE, HeaderValueCollection{std::make_pair("Date", serverTime1.ToGmtString(DateFormat::RFC822))});
// The second server time is ahead of us by 2 hour.
DateTime serverTime2 = DateTime::Now() + std::chrono::hours(2);
QueueMockResponse(HttpResponseCode::REQUEST_NOT_MADE, HeaderValueCollection{std::make_pair("Date", serverTime2.ToGmtString(DateFormat::RFC822))});
// The third server time is ahead of us by 3 hour.
DateTime serverTime3 = DateTime::Now() + std::chrono::hours(3);
QueueMockResponse(HttpResponseCode::OK, HeaderValueCollection{std::make_pair("Date", serverTime3.ToGmtString(DateFormat::RFC822))});
AmazonWebServiceRequestMock request;
auto outcome = client->MakeRequest(request);
ASSERT_TRUE(outcome.IsSuccess());
ASSERT_EQ(2, client->GetRequestAttemptedRetries());
const auto& requests = mockHttpClient->GetAllRequestsMade();
ASSERT_EQ(3u, requests.size());
// The first request to send.
Aws::String invocationId = requests[0].GetHeaders()[Http::SDK_INVOCATION_ID_HEADER];
Aws::String requestInfo = requests[0].GetHeaders()[Http::SDK_REQUEST_HEADER];
ASSERT_TRUE(ExtractFromRequestInfo(requestInfo, "ttl").empty());
ASSERT_STREQ("1", ExtractFromRequestInfo(requestInfo, "attempt").c_str());
ASSERT_TRUE(ExtractFromRequestInfo(requestInfo, "max").empty());
// The second request to send.
ASSERT_STREQ(invocationId.c_str(), requests[1].GetHeaders()[Http::SDK_INVOCATION_ID_HEADER].c_str());
requestInfo = requests[1].GetHeaders()[Http::SDK_REQUEST_HEADER];
Aws::String ttl = ExtractFromRequestInfo(requestInfo, "ttl");
ASSERT_FALSE(ttl.empty());
auto diff = DateTime::Diff(DateTime(ttl, DateFormat::ISO_8601_BASIC), serverTime1 + std::chrono::milliseconds(30000)); // request timeout is 30,000 ms.
ASSERT_LT(diff, std::chrono::seconds(2));
ASSERT_GT(diff, std::chrono::seconds(-2));
ASSERT_STREQ("2", ExtractFromRequestInfo(requestInfo, "attempt").c_str());
ASSERT_STREQ("11", ExtractFromRequestInfo(requestInfo, "max").c_str());
// The third request to send.
ASSERT_STREQ(invocationId.c_str(), requests[2].GetHeaders()[Http::SDK_INVOCATION_ID_HEADER].c_str());
requestInfo = requests[2].GetHeaders()[Http::SDK_REQUEST_HEADER];
ttl = ExtractFromRequestInfo(requestInfo, "ttl");
ASSERT_FALSE(ttl.empty());
diff = DateTime::Diff(DateTime(ttl, DateFormat::ISO_8601_BASIC), serverTime2 + std::chrono::milliseconds(30000)); // request timeout is 30,000 ms.
ASSERT_LT(diff, std::chrono::seconds(2));
ASSERT_GT(diff, std::chrono::seconds(-2));
ASSERT_STREQ("3", ExtractFromRequestInfo(requestInfo, "attempt").c_str());
ASSERT_STREQ("11", ExtractFromRequestInfo(requestInfo, "max").c_str());
}

TEST_F(AWSClientTestSuite, TestStandardRetryStrategy)
{
ClientConfiguration config;
auto retryQuotaContainer = Aws::MakeShared<DefaultRetryQuotaContainer>(ALLOCATION_TAG); // 500 tokens in total
auto countedRetryStrategy = Aws::MakeShared<CountedStandardRetryStrategy>(ALLOCATION_TAG, retryQuotaContainer);
config.retryStrategy = countedRetryStrategy;
MockAWSClientWithStandardRetryStrategy clientWithStandardRetryStrategy(config);

// 1. Successful request.
HeaderValueCollection responseHeaders;
QueueMockResponse(HttpResponseCode::OK, responseHeaders);
AmazonWebServiceRequestMock request;
auto outcome = clientWithStandardRetryStrategy.MakeRequest(request);
ASSERT_TRUE(outcome.IsSuccess());
ASSERT_EQ(0, clientWithStandardRetryStrategy.GetRequestAttemptedRetries());
ASSERT_EQ(500, clientWithStandardRetryStrategy.GetRetryQuotaContainer()->GetRetryQuota());

// 2. Fail due to max attempts reached.
AWSError<CoreErrors> connectionError(CoreErrors::NETWORK_CONNECTION, true);
AWSError<CoreErrors> requestTimeoutError(CoreErrors::REQUEST_TIMEOUT, true);
QueueMockResponse(connectionError, responseHeaders); // Acquire 5 tokens
QueueMockResponse(requestTimeoutError, responseHeaders); // Acquire 10 tokens
QueueMockResponse(connectionError, responseHeaders); // Max attempts reached, will not acquire more tokens
outcome = clientWithStandardRetryStrategy.MakeRequest(request);
ASSERT_FALSE(outcome.IsSuccess());
ASSERT_EQ(2, clientWithStandardRetryStrategy.GetRequestAttemptedRetries());
ASSERT_EQ(485, clientWithStandardRetryStrategy.GetRetryQuotaContainer()->GetRetryQuota());

// 3. Retry eventually succeeds.
QueueMockResponse(connectionError, responseHeaders); // Acquire 5 tokens
QueueMockResponse(requestTimeoutError, responseHeaders); // Acquire 10 tokens
QueueMockResponse(HttpResponseCode::OK, responseHeaders); // Release 10 tokens
outcome = clientWithStandardRetryStrategy.MakeRequest(request);
ASSERT_TRUE(outcome.IsSuccess());
ASSERT_EQ(2, clientWithStandardRetryStrategy.GetRequestAttemptedRetries());
ASSERT_EQ(480, clientWithStandardRetryStrategy.GetRetryQuotaContainer()->GetRetryQuota());

// 4. Retry Quota reached after a single retry.
ASSERT_TRUE(clientWithStandardRetryStrategy.GetRetryQuotaContainer()->AcquireRetryQuota(473)); // Acquire 473 tokens
QueueMockResponse(connectionError, responseHeaders); // Acquire 5 tokens
QueueMockResponse(connectionError, responseHeaders); // Not able to acquire more tokens
outcome = clientWithStandardRetryStrategy.MakeRequest(request);
ASSERT_FALSE(outcome.IsSuccess());
ASSERT_EQ(1, clientWithStandardRetryStrategy.GetRequestAttemptedRetries());
ASSERT_EQ(2, clientWithStandardRetryStrategy.GetRetryQuotaContainer()->GetRetryQuota());

// 5. No retries at all.
QueueMockResponse(connectionError, responseHeaders); // Acquire 5 tokens
outcome = clientWithStandardRetryStrategy.MakeRequest(request);
ASSERT_FALSE(outcome.IsSuccess());
ASSERT_EQ(0, clientWithStandardRetryStrategy.GetRequestAttemptedRetries());
ASSERT_EQ(2, clientWithStandardRetryStrategy.GetRetryQuotaContainer()->GetRetryQuota());

// 6. Successful request.
QueueMockResponse(HttpResponseCode::OK, responseHeaders); // Release 1 token
outcome = clientWithStandardRetryStrategy.MakeRequest(request);
ASSERT_TRUE(outcome.IsSuccess());
ASSERT_EQ(0, clientWithStandardRetryStrategy.GetRequestAttemptedRetries());
ASSERT_EQ(3, clientWithStandardRetryStrategy.GetRetryQuotaContainer()->GetRetryQuota());
}

TEST(AWSClientTest, TestBuildHttpRequestWithHeadersOnly)
{
HeaderValueCollection headerValues;
Expand Down
134 changes: 134 additions & 0 deletions aws-cpp-sdk-core-tests/aws/client/RetryStrategyTest.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
/*
* Copyright 2010-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/


#include <aws/external/gtest.h>
#include <aws/core/client/AWSError.h>
#include <aws/core/client/CoreErrors.h>
#include <aws/core/client/RetryStrategy.h>
#include <aws/core/http/URI.h>
#include <aws/core/http/HttpClientFactory.h>
#include <aws/core/http/standard/StandardHttpRequest.h>
#include <aws/core/http/standard/StandardHttpResponse.h>
#include <aws/core/utils/stream/ResponseStream.h>
#include <aws/core/utils/Outcome.h>

using namespace Aws::Client;
using namespace Aws::Http;
using namespace Aws::Utils::Threading;

static const char ALLOCATION_TAG[] = "RetryStrategyTest";

class MockStandardRetryStrategy : public Aws::Client::StandardRetryStrategy
{
public:
const std::shared_ptr<Aws::Client::RetryQuotaContainer>& GetRetryQuotaContainer() const
{
return m_retryQuotaContainer;
}
};

TEST(RetryStrategyTest, TestDefaultRetryQuotaContainer)
{
AWSError<CoreErrors> requestTimeoutError(CoreErrors::REQUEST_TIMEOUT, true);
AWSError<CoreErrors> retryableError(CoreErrors::NETWORK_CONNECTION, true);

DefaultRetryQuotaContainer retryQuotaContainer;
ASSERT_EQ(500, retryQuotaContainer.GetRetryQuota());
retryQuotaContainer.ReleaseRetryQuota(1);
ASSERT_EQ(500, retryQuotaContainer.GetRetryQuota());

// Acquire 5 tokens, remains 495.
ASSERT_TRUE(retryQuotaContainer.AcquireRetryQuota(retryableError));
ASSERT_EQ(495, retryQuotaContainer.GetRetryQuota());

// Acquire 10 tokens, remains 485.
ASSERT_TRUE(retryQuotaContainer.AcquireRetryQuota(requestTimeoutError));
ASSERT_EQ(485, retryQuotaContainer.GetRetryQuota());

// Acquire 483 tokens, remains 2.
ASSERT_TRUE(retryQuotaContainer.AcquireRetryQuota(483));
ASSERT_EQ(2, retryQuotaContainer.GetRetryQuota());

// Not able to acquire more tokens.
ASSERT_FALSE(retryQuotaContainer.AcquireRetryQuota(retryableError));
ASSERT_FALSE(retryQuotaContainer.AcquireRetryQuota(requestTimeoutError));
ASSERT_FALSE(retryQuotaContainer.AcquireRetryQuota(3));
}

TEST(RetryStrategyTest, TestStandardRetryStrategy)
{
AWSError<CoreErrors> requestTimeoutError(CoreErrors::REQUEST_TIMEOUT, true);
AWSError<CoreErrors> retryableError(CoreErrors::NETWORK_CONNECTION, true);
AWSError<CoreErrors> nonRetryableError(CoreErrors::INCOMPLETE_SIGNATURE, false);

MockStandardRetryStrategy retryStrategy;
ASSERT_EQ(500, retryStrategy.GetRetryQuotaContainer()->GetRetryQuota());
ASSERT_EQ(3, retryStrategy.GetMaxAttempts());

std::shared_ptr<HttpRequest> httpRequest = CreateHttpRequest(URI("http://www.uri.com"), HttpMethod::HTTP_GET, Aws::Utils::Stream::DefaultResponseStreamFactoryMethod);
std::shared_ptr<HttpResponse> httpResponse = Aws::MakeShared<Standard::StandardHttpResponse>(ALLOCATION_TAG, httpRequest);
HttpResponseOutcome httpResponseOutcome(httpResponse);
retryStrategy.RequestBookkeeping(httpResponseOutcome);
ASSERT_EQ(500, retryStrategy.GetRetryQuotaContainer()->GetRetryQuota());

// Non-retryable error.
ASSERT_FALSE(retryStrategy.ShouldRetry(nonRetryableError, 0));
// Hit attempt limit.
ASSERT_FALSE(retryStrategy.ShouldRetry(retryableError, 2));

// Acquire 5 tokens, remains 495.
ASSERT_TRUE(retryStrategy.ShouldRetry(retryableError, 0));
ASSERT_EQ(495, retryStrategy.GetRetryQuotaContainer()->GetRetryQuota());

// Acquire 10 tokens, remains 485.
ASSERT_TRUE(retryStrategy.ShouldRetry(requestTimeoutError, 0));
ASSERT_EQ(485, retryStrategy.GetRetryQuotaContainer()->GetRetryQuota());

// Acquire 478 tokens, remains 7.
ASSERT_TRUE(retryStrategy.GetRetryQuotaContainer()->AcquireRetryQuota(478));
ASSERT_EQ(7, retryStrategy.GetRetryQuotaContainer()->GetRetryQuota());

// Not able to retry with request timeout error with insufficient tokens.
ASSERT_FALSE(retryStrategy.ShouldRetry(requestTimeoutError, 0));

// Still able to retry with other errors. Acquire 5 tokens, remains 2.
ASSERT_TRUE(retryStrategy.ShouldRetry(retryableError, 0));
ASSERT_EQ(2, retryStrategy.GetRetryQuotaContainer()->GetRetryQuota());

// Release 5 tokens, remains 7.
retryStrategy.RequestBookkeeping(httpResponseOutcome, retryableError);
ASSERT_EQ(7, retryStrategy.GetRetryQuotaContainer()->GetRetryQuota());

// Release 10 tokens, remains 17.
retryStrategy.RequestBookkeeping(httpResponseOutcome, requestTimeoutError);
ASSERT_EQ(17, retryStrategy.GetRetryQuotaContainer()->GetRetryQuota());

// Release 1 token, remains 18.
retryStrategy.RequestBookkeeping(httpResponseOutcome);
ASSERT_EQ(18, retryStrategy.GetRetryQuotaContainer()->GetRetryQuota());

// Release 480 tokens, remains 498
retryStrategy.GetRetryQuotaContainer()->ReleaseRetryQuota(480);
ASSERT_EQ(498, retryStrategy.GetRetryQuotaContainer()->GetRetryQuota());

// Hit the max token capicity, remains 500.
retryStrategy.RequestBookkeeping(httpResponse, retryableError);
ASSERT_EQ(500, retryStrategy.GetRetryQuotaContainer()->GetRetryQuota());

// Hit the max token capicity, not able to release more tokens.
retryStrategy.RequestBookkeeping(httpResponse, requestTimeoutError);
ASSERT_EQ(500, retryStrategy.GetRetryQuotaContainer()->GetRetryQuota());
}
2 changes: 2 additions & 0 deletions aws-cpp-sdk-core-tests/monitoring/MonitoringEndToEndTest.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,10 @@ class MonitoringEndToEndTestSuite : public ::testing::Test
mockHttpClient = nullptr;
mockHttpClientFactory = nullptr;

CleanupMonitoring();
CleanupHttp();
InitHttp();
InitMonitoring(std::vector<Aws::Monitoring::MonitoringFactoryCreateFunction>());
}

void SetServiceClient(const Aws::String& serviceName, const Aws::String& region)
Expand Down
2 changes: 2 additions & 0 deletions aws-cpp-sdk-core-tests/monitoring/MonitoringTest.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,10 @@ class MonitoringTestSuite : public ::testing::Test
mockHttpClient = nullptr;
mockHttpClientFactory = nullptr;

CleanupMonitoring();
CleanupHttp();
InitHttp();
InitMonitoring(std::vector<Aws::Monitoring::MonitoringFactoryCreateFunction>());
}

void QueueMockResponse(HttpResponseCode code, const HeaderValueCollection& headers)
Expand Down
Loading

0 comments on commit cac7d64

Please sign in to comment.