Skip to content

Move ApplyUserAgentStage to later stage in request pipeline #6513

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
S-Saranya1 merged 4 commits into from
Oct 24, 2025
Merged

Move ApplyUserAgentStage to later stage in request pipeline #6513

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c9841b1
Move ApplyUserAgentStage to later position in request pipeline
S-Saranya1 Oct 23, 2025
576252a
Fixing gzip test
S-Saranya1 Oct 23, 2025
6f723b6
Add gzip sync test
S-Saranya1 Oct 23, 2025
fdaef73
Merge branch 'master' into somepal/move-applyUserAgent-later-stage
S-Saranya1 Oct 24, 2025
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 .changes/next-release/feature-AWSSDKforJavav2-5eb5d9f.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"type": "feature",
"category": "AWS SDK for Java v2",
"contributor": "",
"description": "Move `ApplyUserAgentStage` to later position in request pipeline to ensure all business metrics are properly recorded before finalizing user agent."
}
2 changes: 1 addition & 1 deletion ...k-core/src/main/java/software/amazon/awssdk/core/internal/http/AmazonAsyncHttpClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,12 +193,12 @@ public <OutputT> CompletableFuture<OutputT> execute(
.first(RequestPipelineBuilder
.first(MakeRequestMutableStage::new)
.then(ApplyTransactionIdStage::new)
.then(ApplyUserAgentStage::new)
.then(MergeCustomHeadersStage::new)
.then(MergeCustomQueryParamsStage::new)
.then(QueryParametersToBodyStage::new)
.then(() -> new CompressRequestStage(httpClientDependencies))
.then(() -> new HttpChecksumStage(ClientType.ASYNC))
.then(ApplyUserAgentStage::new)
.then(MakeRequestImmutableStage::new)
.then(RequestPipelineBuilder
.first(AsyncSigningStage::new)
Expand Down
2 changes: 1 addition & 1 deletion ...dk-core/src/main/java/software/amazon/awssdk/core/internal/http/AmazonSyncHttpClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,12 +181,12 @@ public <OutputT> OutputT execute(HttpResponseHandler<Response<OutputT>> response
.first(RequestPipelineBuilder
.first(MakeRequestMutableStage::new)
.then(ApplyTransactionIdStage::new)
.then(ApplyUserAgentStage::new)
.then(MergeCustomHeadersStage::new)
.then(MergeCustomQueryParamsStage::new)
.then(QueryParametersToBodyStage::new)
.then(() -> new CompressRequestStage(httpClientDependencies))
.then(() -> new HttpChecksumStage(ClientType.SYNC))
.then(ApplyUserAgentStage::new)
.then(MakeRequestImmutableStage::new)
// End of mutating request
.then(RequestPipelineBuilder
Expand Down
2 changes: 1 addition & 1 deletion ...sdk-core/src/main/java/software/amazon/awssdk/core/useragent/BusinessMetricFeatureId.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public enum BusinessMetricFeatureId {
RETRY_MODE_STANDARD("E"),
RETRY_MODE_ADAPTIVE("F"),
S3_TRANSFER("G"),
GZIP_REQUEST_COMPRESSION("L"), //TODO(metrics): Not working, compression happens after header
GZIP_REQUEST_COMPRESSION("L"),
PROTOCOL_RPC_V2_CBOR("M"),
ENDPOINT_OVERRIDE("N"),
ACCOUNT_ID_MODE_PREFERRED("P"),
Expand Down
4 changes: 2 additions & 2 deletions ...sses-test/src/test/java/software/amazon/awssdk/services/BusinessMetricsUserAgentTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ void when_paginatedOperationIsCalled_correctMetricIsAdded() throws Exception {
}

@Test
void when_compressedOperationIsCalled_metricIsRecordedButNotAddedToUserAgentString() throws Exception {
void when_compressedOperationIsCalled_metricIsRecordedAndAddedToUserAgentString() throws Exception {
ProtocolRestJsonAsyncClientBuilder clientBuilder = asyncClientBuilderForProtocolRestJson();

assertThatThrownBy(() -> clientBuilder.build().putOperationWithRequestCompression(r -> r.body(SdkBytes.fromUtf8String(
Expand All @@ -173,7 +173,7 @@ void when_compressedOperationIsCalled_metricIsRecordedButNotAddedToUserAgentStri
BusinessMetricCollection attribute = interceptor.executionAttributes().getAttribute(SdkInternalExecutionAttribute.BUSINESS_METRICS);
assertThat(attribute).isNotNull();
assertThat(attribute.recordedMetrics()).contains(BusinessMetricFeatureId.GZIP_REQUEST_COMPRESSION.value());
assertThat(userAgent).doesNotMatch(METRIC_SEARCH_PATTERN.apply(BusinessMetricFeatureId.GZIP_REQUEST_COMPRESSION.value()));
assertThat(userAgent).matches(METRIC_SEARCH_PATTERN.apply(BusinessMetricFeatureId.GZIP_REQUEST_COMPRESSION.value()));
}

private String assertAndGetUserAgentString() {
Expand Down
Loading