Skip to content

paginator codegen UA #3727

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

Open
kai-ion wants to merge 3 commits into
base: main
Choose a base branch
from
+46 −4
Open

paginator codegen UA #3727

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
3952ee6
added UA to paginator codegen
kai-ion Feb 20, 2026
812ea02
update unit test to track C metric
kai-ion Feb 20, 2026
c2b81f1
white space change
kai-ion Feb 20, 2026
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 generated/src/aws-cpp-sdk-s3/include/aws/s3/S3PaginationBase.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

#pragma once

#include <aws/core/client/UserAgent.h>
#include <aws/core/utils/pagination/Paginator.h>
#include <aws/s3/model/ListBucketsPaginationTraits.h>
#include <aws/s3/model/ListDirectoryBucketsPaginationTraits.h>
Expand All @@ -26,6 +27,7 @@ class S3PaginationBase {
*/
Aws::Utils::Pagination::Paginator<DerivedClient, Model::ListBucketsRequest, Pagination::ListBucketsPaginationTraits<DerivedClient>>
ListBucketsPaginator(const Model::ListBucketsRequest& request) {
request.AddUserAgentFeature(Aws::Client::UserAgentFeature::PAGINATOR);
return Aws::Utils::Pagination::Paginator<DerivedClient, Model::ListBucketsRequest,
Pagination::ListBucketsPaginationTraits<DerivedClient>>{static_cast<DerivedClient*>(this),
request};
Expand All @@ -37,6 +39,7 @@ class S3PaginationBase {
Aws::Utils::Pagination::Paginator<DerivedClient, Model::ListDirectoryBucketsRequest,
Pagination::ListDirectoryBucketsPaginationTraits<DerivedClient>>
ListDirectoryBucketsPaginator(const Model::ListDirectoryBucketsRequest& request) {
request.AddUserAgentFeature(Aws::Client::UserAgentFeature::PAGINATOR);
return Aws::Utils::Pagination::Paginator<DerivedClient, Model::ListDirectoryBucketsRequest,
Pagination::ListDirectoryBucketsPaginationTraits<DerivedClient>>{
static_cast<DerivedClient*>(this), request};
Expand All @@ -47,6 +50,7 @@ class S3PaginationBase {
*/
Aws::Utils::Pagination::Paginator<DerivedClient, Model::ListObjectsV2Request, Pagination::ListObjectsV2PaginationTraits<DerivedClient>>
ListObjectsV2Paginator(const Model::ListObjectsV2Request& request) {
request.AddUserAgentFeature(Aws::Client::UserAgentFeature::PAGINATOR);
return Aws::Utils::Pagination::Paginator<DerivedClient, Model::ListObjectsV2Request,
Pagination::ListObjectsV2PaginationTraits<DerivedClient>>{static_cast<DerivedClient*>(this),
request};
Expand All @@ -57,6 +61,7 @@ class S3PaginationBase {
*/
Aws::Utils::Pagination::Paginator<DerivedClient, Model::ListPartsRequest, Pagination::ListPartsPaginationTraits<DerivedClient>>
ListPartsPaginator(const Model::ListPartsRequest& request) {
request.AddUserAgentFeature(Aws::Client::UserAgentFeature::PAGINATOR);
return Aws::Utils::Pagination::Paginator<DerivedClient, Model::ListPartsRequest, Pagination::ListPartsPaginationTraits<DerivedClient>>{
static_cast<DerivedClient*>(this), request};
}
Expand Down
3 changes: 2 additions & 1 deletion src/aws-cpp-sdk-core/include/aws/core/client/UserAgent.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ enum class UserAgentFeature {
FLEXIBLE_CHECKSUMS_REQ_SHA512,
FLEXIBLE_CHECKSUMS_REQ_XXHASH64,
FLEXIBLE_CHECKSUMS_REQ_XXHASH3,
FLEXIBLE_CHECKSUMS_REQ_XXHASH128
FLEXIBLE_CHECKSUMS_REQ_XXHASH128,
PAGINATOR
};

class AWS_CORE_API UserAgent {
Expand Down
3 changes: 2 additions & 1 deletion src/aws-cpp-sdk-core/source/client/UserAgent.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,8 @@ const std::pair<UserAgentFeature, const char*> BUSINESS_METRIC_MAPPING[] = {
{UserAgentFeature::FLEXIBLE_CHECKSUMS_REQ_SHA512, "AE"},
{UserAgentFeature::FLEXIBLE_CHECKSUMS_REQ_XXHASH64, "AG"},
{UserAgentFeature::FLEXIBLE_CHECKSUMS_REQ_XXHASH3, "AF"},
{UserAgentFeature::FLEXIBLE_CHECKSUMS_REQ_XXHASH128, "AH"}
{UserAgentFeature::FLEXIBLE_CHECKSUMS_REQ_XXHASH128, "AH"},
{UserAgentFeature::PAGINATOR, "C"},
};

const std::pair<const char*, UserAgentFeature> RETRY_FEATURE_MAPPING[] = {
Expand Down
35 changes: 34 additions & 1 deletion tests/aws-cpp-sdk-s3-unit-tests/S3UnitTests.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
#include <memory>
#include <aws/s3/S3ErrorMarshaller.h>
#include <aws/s3/model/HeadBucketRequest.h>
#include <aws/s3/model/ListObjectsV2Request.h>

using namespace Aws;
using namespace Aws::Client;
Expand Down Expand Up @@ -671,4 +672,36 @@ TEST_F(S3UnitTest, PartiallyConsumedStreamChecksumReuse) {
EXPECT_TRUE(seenChecksum.IsSuccess());
const auto seenChecksumBase64 = base64.Encode(seenChecksum.GetResult());
EXPECT_EQ(seenChecksumBase64, expectedChecksumBase64);
}
}

TEST_F(S3UnitTest, ListObjectsV2PaginatorShouldHaveCMetric) {
auto request = ListObjectsV2Request().WithBucket("test-bucket");

auto mockRequest = Aws::MakeShared<Standard::StandardHttpRequest>(ALLOCATION_TAG, "test-bucket.s3.amazonaws.com/", HttpMethod::HTTP_GET);
mockRequest->SetResponseStreamFactory([]() -> IOStream* {
return Aws::New<StringStream>(ALLOCATION_TAG, "", std::ios_base::in | std::ios_base::binary);
});
auto mockResponse = Aws::MakeShared<Standard::StandardHttpResponse>(ALLOCATION_TAG, mockRequest);
mockResponse->SetResponseCode(HttpResponseCode::OK);
mockResponse->GetResponseBody() <<
"<?xml version=\"1.0\" encoding=\"UTF-8\"?>"
"<ListBucketResult xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">"
"<Name>test-bucket</Name><KeyCount>0</KeyCount><MaxKeys>1000</MaxKeys><IsTruncated>false</IsTruncated>"
"</ListBucketResult>";
_mockHttpClient->AddResponseToReturn(mockResponse);

auto paginator = _s3Client->ListObjectsV2Paginator(request);
for (const auto& outcome : paginator) {
AWS_ASSERT_SUCCESS(outcome);
}

const auto requestSeen = _mockHttpClient->GetMostRecentHttpRequest();
EXPECT_TRUE(requestSeen.HasUserAgent());
const auto& userAgent = requestSeen.GetUserAgent();
EXPECT_FALSE(userAgent.empty());
const auto userAgentParsed = Utils::StringUtils::Split(userAgent, ' ');

auto businessMetrics = std::find_if(userAgentParsed.begin(), userAgentParsed.end(),
[](const Aws::String& value) { return value.find("m/") != Aws::String::npos && value.find("C") != Aws::String::npos; });
EXPECT_TRUE(businessMetrics != userAgentParsed.end());
}
4 changes: 3 additions & 1 deletion ...mazonaws/util/awsclientsmithygenerator/generators/pagination/PaginationBaseGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ public PaginationBaseGenerator(ServiceShape service, List<OperationData<Paginate
protected void writeSpecificIncludes(CppWriter writer, String serviceName, String smithyServiceName) {
writer.write("");
writer.writeInclude("aws/core/utils/pagination/Paginator.h");
writer.writeInclude("aws/core/client/UserAgent.h");

// Include paginator headers
for (OperationData<PaginatedTrait> data : operations) {
Expand Down Expand Up @@ -65,7 +66,8 @@ protected void writeSpecificContent(CppWriter writer, String serviceName) {
.write(opName + "Paginator(const Model::" + methodName + "Request& request)");

writer.openBlock("{", "}", () -> {
writer.write("return Aws::Utils::Pagination::Paginator<DerivedClient, Model::" + methodName + "Request, Pagination::" + opName + "PaginationTraits<DerivedClient>>{")
writer.write("request.AddUserAgentFeature(Aws::Client::UserAgentFeature::PAGINATOR);")
.write("return Aws::Utils::Pagination::Paginator<DerivedClient, Model::" + methodName + "Request, Pagination::" + opName + "PaginationTraits<DerivedClient>>{")
.write(" static_cast<DerivedClient*>(this), request};");
});
}
Expand Down
Loading