Replace builders with modifiable request/response

mtdowling · mtdowling · commit 03962e2a7e78 · 2026-03-31T22:08:03.000-05:00
diff --git a/aws/aws-sigv4/src/main/java/software/amazon/smithy/java/aws/client/auth/scheme/sigv4/SigV4Signer.java b/aws/aws-sigv4/src/main/java/software/amazon/smithy/java/aws/client/auth/scheme/sigv4/SigV4Signer.java
@@ -91,8 +91,9 @@ public SignResult<HttpRequest> sign(HttpRequest request, AwsCredentialsIdentity
                 identity.sessionToken(),
                 !request.body().hasKnownLength());
         var signedHeaders = signatureAndSignedHeaders.right;
-        return new SignResult<>(request.toBuilder().headers(HttpHeaders.of(signedHeaders)).build(),
-                signatureAndSignedHeaders.left);
+        var mod = request.toModifiableCopy();
+        mod.setHeaders(HttpHeaders.of(signedHeaders).toModifiable());
+        return new SignResult<>(mod, signatureAndSignedHeaders.left);
     }
 
     private String getPayloadHash(DataStream dataStream) {
diff --git a/aws/client/aws-client-http/src/main/java/software/amazon/smithy/java/aws/client/http/AmzSdkRequestPlugin.java b/aws/client/aws-client-http/src/main/java/software/amazon/smithy/java/aws/client/http/AmzSdkRequestPlugin.java
@@ -5,7 +5,6 @@
 
 package software.amazon.smithy.java.aws.client.http;
 
-import java.util.List;
 import software.amazon.smithy.java.client.core.CallContext;
 import software.amazon.smithy.java.client.core.ClientConfig;
 import software.amazon.smithy.java.client.core.ClientPlugin;
@@ -38,9 +37,7 @@ public <RequestT> RequestT modifyBeforeSigning(RequestHook<?, ?, RequestT> hook)
                         value.append("; max=").append(max);
                     }
                     return hook.asRequestType(
-                            req.toBuilder()
-                                    .withReplacedHeader("amz-sdk-request", List.of(value.toString()))
-                                    .build());
+                            req.toModifiableCopy().setHeader("amz-sdk-request", value.toString()));
                 }
             }
             return hook.request();
diff --git a/aws/client/aws-client-http/src/main/java/software/amazon/smithy/java/aws/client/http/RecursionDetectionPlugin.java b/aws/client/aws-client-http/src/main/java/software/amazon/smithy/java/aws/client/http/RecursionDetectionPlugin.java
@@ -48,8 +48,9 @@ private record Interceptor(List<String> traceIdHeader) implements ClientIntercep
         public <RequestT> RequestT modifyBeforeTransmit(RequestHook<?, ?, RequestT> hook) {
             if (hook.request() instanceof HttpRequest req) {
                 if (!req.headers().hasHeader("x-amzn-trace-id")) {
-                    return hook.asRequestType(
-                            req.toBuilder().withReplacedHeader("x-amzn-trace-id", traceIdHeader).build());
+                    var mod = req.toModifiableCopy();
+                    mod.headers().setHeader("x-amzn-trace-id", traceIdHeader);
+                    return hook.asRequestType(mod);
                 }
             }
             return hook.request();
diff --git a/aws/client/aws-client-http/src/test/java/software/amazon/smithy/java/aws/client/http/RecursionDetectionPluginTest.java b/aws/client/aws-client-http/src/test/java/software/amazon/smithy/java/aws/client/http/RecursionDetectionPluginTest.java
@@ -9,7 +9,6 @@
 import static org.hamcrest.Matchers.contains;
 import static org.hamcrest.Matchers.empty;
 
-import java.util.List;
 import org.junit.jupiter.api.Test;
 import software.amazon.smithy.java.aws.client.awsjson.AwsJson1Protocol;
 import software.amazon.smithy.java.client.core.ClientPlugin;
@@ -80,7 +79,7 @@ public void doesNotReplaceExistingValue() {
             public <RequestT> RequestT modifyBeforeSigning(RequestHook<?, ?, RequestT> hook) {
                 if (hook.request() instanceof HttpRequest req) {
                     return hook.asRequestType(
-                            req.toBuilder().withReplacedHeader("x-amzn-trace-id", List.of("hi")).build());
+                            req.toModifiableCopy().setHeader("x-amzn-trace-id", "hi"));
                 }
                 return hook.request();
             }
diff --git a/client/client-core/src/main/java/software/amazon/smithy/java/client/core/interceptors/RequestHook.java b/client/client-core/src/main/java/software/amazon/smithy/java/client/core/interceptors/RequestHook.java
@@ -53,7 +53,7 @@ public RequestHook<I, O, RequestT> withRequest(RequestT request) {
      * <p>This is useful when modifying the request using {@code instanceof} pattern matching:
      * {@snippet :
      * if (hook.request() instanceof HttpRequest req) {
-     *     return hook.asRequestType(req.toBuilder().withAddedHeader("X-Foo", "Bar").build());
+     *     return hook.asRequestType(req.toModifiableCopy().addHeader("X-Foo", "Bar"));
      * }
      * return hook.request();
      * }
diff --git a/client/client-http/src/main/java/software/amazon/smithy/java/client/http/HttpErrorDeserializer.java b/client/client-http/src/main/java/software/amazon/smithy/java/client/http/HttpErrorDeserializer.java
@@ -104,12 +104,9 @@ default ModeledException createErrorFromDocument(
                 Document parsedDocument,
                 ShapeBuilder<ModeledException> builder
         ) {
-            return createError(
-                    context,
-                    codec,
-                    // Make a new response that uses the previously read response payload.
-                    response.toBuilder().body(DataStream.ofByteBuffer(responsePayload)).build(),
-                    builder);
+            var modResponse = response.toModifiableCopy();
+            modResponse.setBody(DataStream.ofByteBuffer(responsePayload));
+            return createError(context, codec, modResponse, builder);
         }
     }
 
diff --git a/client/client-http/src/main/java/software/amazon/smithy/java/client/http/auth/HttpApiKeyAuthSigner.java b/client/client-http/src/main/java/software/amazon/smithy/java/client/http/auth/HttpApiKeyAuthSigner.java
@@ -5,13 +5,10 @@
 
 package software.amazon.smithy.java.client.http.auth;
 
-import java.util.LinkedHashMap;
-import java.util.List;
 import software.amazon.smithy.java.auth.api.SignResult;
 import software.amazon.smithy.java.auth.api.Signer;
 import software.amazon.smithy.java.auth.api.identity.ApiKeyIdentity;
 import software.amazon.smithy.java.context.Context;
-import software.amazon.smithy.java.http.api.HttpHeaders;
 import software.amazon.smithy.java.http.api.HttpRequest;
 import software.amazon.smithy.java.io.uri.QueryStringBuilder;
 import software.amazon.smithy.java.logging.InternalLogger;
@@ -29,16 +26,14 @@ public SignResult<HttpRequest> sign(HttpRequest request, ApiKeyIdentity identity
             case HEADER -> {
                 var schemeValue = properties.get(HttpApiKeyAuthScheme.SCHEME);
                 var value = identity.apiKey();
-                // If the scheme value is not null prefix with scheme
                 if (schemeValue != null) {
                     value = schemeValue + " " + value;
                 }
-                var updated = new LinkedHashMap<>(request.headers().map());
-                var existing = updated.put(name, List.of(value));
-                if (existing != null) {
+                var mod = request.toModifiableCopy();
+                if (mod.headers().hasHeader(name)) {
                     LOGGER.debug("Replaced header value for {}", name);
                 }
-                yield new SignResult<>(request.toBuilder().headers(HttpHeaders.of(updated)).build());
+                yield new SignResult<>(mod.setHeader(name, value));
             }
             case QUERY -> {
                 var queryBuilder = new QueryStringBuilder();
@@ -47,8 +42,9 @@ public SignResult<HttpRequest> sign(HttpRequest request, ApiKeyIdentity identity
                 var existingQuery = request.uri().getQuery();
                 addExistingQueryParams(stringBuilder, existingQuery, name);
                 queryBuilder.write(stringBuilder);
-                yield new SignResult<>(
-                        request.toBuilder().uri(request.uri().withQuery(stringBuilder.toString())).build());
+                var mod = request.toModifiableCopy();
+                mod.setUri(request.uri().withQuery(stringBuilder.toString()));
+                yield new SignResult<>(mod);
             }
         };
     }
diff --git a/client/client-http/src/main/java/software/amazon/smithy/java/client/http/auth/HttpBasicAuthSigner.java b/client/client-http/src/main/java/software/amazon/smithy/java/client/http/auth/HttpBasicAuthSigner.java
@@ -7,13 +7,10 @@
 
 import java.nio.charset.StandardCharsets;
 import java.util.Base64;
-import java.util.LinkedHashMap;
-import java.util.List;
 import software.amazon.smithy.java.auth.api.SignResult;
 import software.amazon.smithy.java.auth.api.Signer;
 import software.amazon.smithy.java.auth.api.identity.LoginIdentity;
 import software.amazon.smithy.java.context.Context;
-import software.amazon.smithy.java.http.api.HttpHeaders;
 import software.amazon.smithy.java.http.api.HttpRequest;
 import software.amazon.smithy.java.logging.InternalLogger;
 
@@ -29,11 +26,10 @@ private HttpBasicAuthSigner() {}
     public SignResult<HttpRequest> sign(HttpRequest request, LoginIdentity identity, Context properties) {
         var identityString = identity.username() + ":" + identity.password();
         var base64Value = Base64.getEncoder().encodeToString(identityString.getBytes(StandardCharsets.UTF_8));
-        var headers = new LinkedHashMap<>(request.headers().map());
-        var existing = headers.put(AUTHORIZATION_HEADER, List.of(SCHEME + " " + base64Value));
-        if (existing != null) {
+        var mod = request.toModifiableCopy();
+        if (mod.headers().hasHeader(AUTHORIZATION_HEADER)) {
             LOGGER.debug("Replaced existing Authorization header value.");
         }
-        return new SignResult<>(request.toBuilder().headers(HttpHeaders.of(headers)).build());
+        return new SignResult<>(mod.setHeader(AUTHORIZATION_HEADER, SCHEME + " " + base64Value));
     }
 }
diff --git a/client/client-http/src/main/java/software/amazon/smithy/java/client/http/auth/HttpBearerAuthSigner.java b/client/client-http/src/main/java/software/amazon/smithy/java/client/http/auth/HttpBearerAuthSigner.java
@@ -5,13 +5,10 @@
 
 package software.amazon.smithy.java.client.http.auth;
 
-import java.util.LinkedHashMap;
-import java.util.List;
 import software.amazon.smithy.java.auth.api.SignResult;
 import software.amazon.smithy.java.auth.api.Signer;
 import software.amazon.smithy.java.auth.api.identity.TokenIdentity;
 import software.amazon.smithy.java.context.Context;
-import software.amazon.smithy.java.http.api.HttpHeaders;
 import software.amazon.smithy.java.http.api.HttpRequest;
 import software.amazon.smithy.java.logging.InternalLogger;
 
@@ -25,11 +22,10 @@ private HttpBearerAuthSigner() {}
 
     @Override
     public SignResult<HttpRequest> sign(HttpRequest request, TokenIdentity identity, Context properties) {
-        var headers = new LinkedHashMap<>(request.headers().map());
-        var existing = headers.put(AUTHORIZATION_HEADER, List.of(SCHEME + " " + identity.token()));
-        if (existing != null) {
+        var mod = request.toModifiableCopy();
+        if (mod.headers().hasHeader(AUTHORIZATION_HEADER)) {
             LOGGER.debug("Replaced existing Authorization header value.");
         }
-        return new SignResult<>(request.toBuilder().headers(HttpHeaders.of(headers)).build());
+        return new SignResult<>(mod.setHeader(AUTHORIZATION_HEADER, SCHEME + " " + identity.token()));
     }
 }
diff --git a/client/client-http/src/main/java/software/amazon/smithy/java/client/http/plugins/HttpChecksumPlugin.java b/client/client-http/src/main/java/software/amazon/smithy/java/client/http/plugins/HttpChecksumPlugin.java
@@ -17,7 +17,6 @@
 import software.amazon.smithy.java.http.api.HttpRequest;
 import software.amazon.smithy.java.io.ByteBufferUtils;
 import software.amazon.smithy.model.traits.HttpChecksumRequiredTrait;
-import software.amazon.smithy.utils.ListUtils;
 import software.amazon.smithy.utils.SmithyInternalApi;
 
 /**
@@ -55,9 +54,9 @@ static HttpRequest addContentMd5Header(HttpRequest request) {
                 try {
                     byte[] hash = MessageDigest.getInstance("MD5").digest(bytes);
                     String base64Hash = Base64.getEncoder().encodeToString(hash);
-                    return request.toBuilder()
-                            .withReplacedHeader("Content-MD5", ListUtils.of(base64Hash))
-                            .build();
+                    var modifiable = request.toModifiable();
+                    modifiable.headers().setHeader("content-md5", base64Hash);
+                    return modifiable;
                 } catch (NoSuchAlgorithmException e) {
                     throw new IllegalStateException("Unable to fetch message digest instance for MD5", e);
                 }
diff --git a/client/client-http/src/main/java/software/amazon/smithy/java/client/http/plugins/RequestCompressionPlugin.java b/client/client-http/src/main/java/software/amazon/smithy/java/client/http/plugins/RequestCompressionPlugin.java
@@ -56,10 +56,9 @@ public <RequestT> RequestT modifyBeforeRetryLoop(RequestHook<?, ?, RequestT> hoo
                         if (algorithmId.equals(algorithm.algorithmId())) {
                             var compressed = algorithm.compress(req.body());
                             return hook.asRequestType(
-                                    req.toBuilder()
-                                            .body(compressed)
-                                            .withAddedHeader(CONTENT_ENCODING_HEADER, algorithmId)
-                                            .build());
+                                    req.toModifiableCopy()
+                                            .setBody(compressed)
+                                            .addHeader(CONTENT_ENCODING_HEADER, algorithmId));
                         }
                     }
                 }
diff --git a/client/client-http/src/test/java/software/amazon/smithy/java/client/http/auth/HttpApiKeyAuthSignerTest.java b/client/client-http/src/test/java/software/amazon/smithy/java/client/http/auth/HttpApiKeyAuthSignerTest.java
@@ -57,7 +57,8 @@ void testOverwritesExistingHeader() {
         authProperties.put(HttpApiKeyAuthScheme.NAME, "x-api-key");
         authProperties.put(HttpApiKeyAuthScheme.SCHEME, "SCHEME");
 
-        var updateRequest = TEST_REQUEST.toBuilder().withAddedHeader("x-api-key", "foo").build();
+        var updateRequest = TEST_REQUEST.toModifiableCopy();
+        updateRequest.headers().addHeader("x-api-key", "foo");
         var signedRequest =
                 HttpApiKeyAuthSigner.INSTANCE.sign(updateRequest, TEST_IDENTITY, authProperties).signedRequest();
         var authHeader = signedRequest.headers().firstValue("x-api-key");
@@ -97,7 +98,8 @@ void testApiKeyAuthSignerAddsQueryParamsAppendsToExisting() {
         authProperties.put(HttpApiKeyAuthScheme.IN, HttpApiKeyAuthTrait.Location.QUERY);
         authProperties.put(HttpApiKeyAuthScheme.NAME, "apiKey");
 
-        var updatedRequest = TEST_REQUEST.toBuilder().uri(SmithyUri.of("https://www.example.com?x=1")).build();
+        var updatedRequest = TEST_REQUEST.toModifiableCopy();
+        updatedRequest.setUri(SmithyUri.of("https://www.example.com?x=1"));
 
         var signedRequest =
                 HttpApiKeyAuthSigner.INSTANCE.sign(updatedRequest, TEST_IDENTITY, authProperties).signedRequest();
@@ -112,8 +114,8 @@ void testOverwritesExistingQuery() {
         authProperties.put(HttpApiKeyAuthScheme.IN, HttpApiKeyAuthTrait.Location.QUERY);
         authProperties.put(HttpApiKeyAuthScheme.NAME, "apiKey");
 
-        var updatedRequest =
-                TEST_REQUEST.toBuilder().uri(SmithyUri.of("https://www.example.com?x=1&apiKey=foo")).build();
+        var updatedRequest = TEST_REQUEST.toModifiableCopy();
+        updatedRequest.setUri(SmithyUri.of("https://www.example.com?x=1&apiKey=foo"));
 
         var signedRequest =
                 HttpApiKeyAuthSigner.INSTANCE.sign(updatedRequest, TEST_IDENTITY, authProperties).signedRequest();
diff --git a/codegen/codegen-plugin/src/it/java/software/amazon/smithy/java/codegen/client/GenericClientTest.java b/codegen/codegen-plugin/src/it/java/software/amazon/smithy/java/codegen/client/GenericClientTest.java
@@ -65,7 +65,7 @@ public void supportsInterceptors() {
             @Override
             public <RequestT> RequestT modifyBeforeTransmit(RequestHook<?, ?, RequestT> hook) {
                 if (hook.request() instanceof HttpRequest req) {
-                    return hook.asRequestType(req.toBuilder().withAddedHeader("X-Foo", "Bar").build());
+                    return hook.asRequestType(req.toModifiableCopy().addHeader("X-Foo", "Bar"));
                 }
                 return hook.request();
             }
diff --git a/codegen/codegen-plugin/src/test/java/software/amazon/smithy/java/codegen/client/TestAuthScheme.java b/codegen/codegen-plugin/src/test/java/software/amazon/smithy/java/codegen/client/TestAuthScheme.java
@@ -54,8 +54,8 @@ public Signer<HttpRequest, Identity> signer() {
     private static final class TestSigner implements Signer<HttpRequest, Identity> {
         @Override
         public SignResult<HttpRequest> sign(HttpRequest request, Identity identity, Context properties) {
-            return new SignResult<>(
-                    request.toBuilder().withAddedHeader(SIGNATURE_HEADER, "smithy-test-signature").build());
+            var mod = request.toModifiableCopy().addHeader(SIGNATURE_HEADER, "smithy-test-signature");
+            return new SignResult<>(mod);
         }
     }
 
diff --git a/examples/restjson-client/src/main/java/software/amazon/smithy/java/example/ClientExample.java b/examples/restjson-client/src/main/java/software/amazon/smithy/java/example/ClientExample.java
@@ -130,7 +130,9 @@ public void readBeforeTransmit(RequestHook<?, ?, ?> hook) {
             @Override
             public <RequestT> RequestT modifyBeforeTransmit(RequestHook<?, ?, RequestT> hook) {
                 if (hook.request() instanceof HttpRequest req) {
-                    return hook.asRequestType(req.toBuilder().withAddedHeader("X-Foo", "Bar").build());
+                    var r = req.toModifiable();
+                    r.headers().setHeader("x-foo", "Bar");
+                    return hook.asRequestType(r);
                 }
                 return hook.request();
             }
diff --git a/http/http-api/src/main/java/software/amazon/smithy/java/http/api/HttpRequest.java b/http/http-api/src/main/java/software/amazon/smithy/java/http/api/HttpRequest.java
@@ -47,20 +47,6 @@ public interface HttpRequest extends HttpMessage {
      */
     HttpRequest toUnmodifiable();
 
-    /**
-     * Create a builder configured with the values of the request.
-     *
-     * @return the created builder.
-     */
-    default Builder toBuilder() {
-        return builder()
-                .method(method())
-                .uri(uri())
-                .headers(headers())
-                .body(body())
-                .httpVersion(httpVersion());
-    }
-
     /**
      * Create a builder.
      *
diff --git a/http/http-api/src/main/java/software/amazon/smithy/java/http/api/HttpResponse.java b/http/http-api/src/main/java/software/amazon/smithy/java/http/api/HttpResponse.java
@@ -37,19 +37,6 @@ public interface HttpResponse extends HttpMessage {
      */
     HttpResponse toUnmodifiable();
 
-    /**
-     * Create a builder configured with the values of the response.
-     *
-     * @return the created builder.
-     */
-    default Builder toBuilder() {
-        return builder()
-                .httpVersion(httpVersion())
-                .statusCode(statusCode())
-                .headers(headers())
-                .body(body());
-    }
-
     /**
      * Create a builder.
      *
diff --git a/http/http-api/src/main/java/software/amazon/smithy/java/http/api/ModifiableHttpMessage.java b/http/http-api/src/main/java/software/amazon/smithy/java/http/api/ModifiableHttpMessage.java
diff --git a/http/http-api/src/main/java/software/amazon/smithy/java/http/api/ModifiableHttpRequest.java b/http/http-api/src/main/java/software/amazon/smithy/java/http/api/ModifiableHttpRequest.java
diff --git a/http/http-api/src/main/java/software/amazon/smithy/java/http/api/ModifiableHttpRequestImpl.java b/http/http-api/src/main/java/software/amazon/smithy/java/http/api/ModifiableHttpRequestImpl.java
diff --git a/http/http-api/src/main/java/software/amazon/smithy/java/http/api/ModifiableHttpResponse.java b/http/http-api/src/main/java/software/amazon/smithy/java/http/api/ModifiableHttpResponse.java
diff --git a/http/http-api/src/main/java/software/amazon/smithy/java/http/api/ModifiableHttpResponseImpl.java b/http/http-api/src/main/java/software/amazon/smithy/java/http/api/ModifiableHttpResponseImpl.java
diff --git a/http/http-api/src/test/java/software/amazon/smithy/java/http/api/SmithyHttpMessageTest.java b/http/http-api/src/test/java/software/amazon/smithy/java/http/api/SmithyHttpMessageTest.java

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,6 @@`
`5`	`5`
`6`	`6`	`package software.amazon.smithy.java.aws.client.http;`
`7`	`7`
`8`		`-import java.util.List;`
`9`	`8`	`import software.amazon.smithy.java.client.core.CallContext;`
`10`	`9`	`import software.amazon.smithy.java.client.core.ClientConfig;`
`11`	`10`	`import software.amazon.smithy.java.client.core.ClientPlugin;`
`@@ -38,9 +37,7 @@ public <RequestT> RequestT modifyBeforeSigning(RequestHook<?, ?, RequestT> hook)`
`38`	`37`	`value.append("; max=").append(max);`
`39`	`38`	`}`
`40`	`39`	`return hook.asRequestType(`
`41`		`- req.toBuilder()`
`42`		`- .withReplacedHeader("amz-sdk-request", List.of(value.toString()))`
`43`		`- .build());`
	`40`	`+ req.toModifiableCopy().setHeader("amz-sdk-request", value.toString()));`
`44`	`41`	`}`
`45`	`42`	`}`
`46`	`43`	`return hook.request();`
Original file line number	Diff line number	Diff line change
`@@ -48,8 +48,9 @@ private record Interceptor(List<String> traceIdHeader) implements ClientIntercep`
`48`	`48`	`public <RequestT> RequestT modifyBeforeTransmit(RequestHook<?, ?, RequestT> hook) {`
`49`	`49`	`if (hook.request() instanceof HttpRequest req) {`
`50`	`50`	`if (!req.headers().hasHeader("x-amzn-trace-id")) {`
`51`		`- return hook.asRequestType(`
`52`		`- req.toBuilder().withReplacedHeader("x-amzn-trace-id", traceIdHeader).build());`
	`51`	`+ var mod = req.toModifiableCopy();`
	`52`	`+ mod.headers().setHeader("x-amzn-trace-id", traceIdHeader);`
	`53`	`+ return hook.asRequestType(mod);`
`53`	`54`	`}`
`54`	`55`	`}`
`55`	`56`	`return hook.request();`