Skip to content

Move endpoint resolution from interceptors to pipeline stage #6820

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
S-Saranya1 wants to merge 4 commits into
base: feature/master/core-interceptors-migration
Choose a base branch
from
Open

Move endpoint resolution from interceptors to pipeline stage #6820

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7b09efe
Move endpoint resolution from interceptors to pipeline stage
S-Saranya1 Mar 27, 2026
77abd70
Merge branch 'feature/master/core-interceptors-migration' into somepa…
S-Saranya1 Mar 27, 2026
fdb9d51
Address PR feedback
S-Saranya1 Apr 8, 2026
cc4fcf8
preserve backward compatibility for customer interceptor URL modifica…
S-Saranya1 Apr 8, 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: 0 additions & 5 deletions ...src/main/java/software/amazon/awssdk/codegen/emitters/tasks/AuthSchemeGeneratorTasks.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
import software.amazon.awssdk.codegen.emitters.GeneratorTask;
import software.amazon.awssdk.codegen.emitters.GeneratorTaskParams;
import software.amazon.awssdk.codegen.emitters.PoetGeneratorTask;
import software.amazon.awssdk.codegen.poet.auth.scheme.AuthSchemeInterceptorSpec;
import software.amazon.awssdk.codegen.poet.auth.scheme.AuthSchemeParamsSpec;
import software.amazon.awssdk.codegen.poet.auth.scheme.AuthSchemeProviderSpec;
import software.amazon.awssdk.codegen.poet.auth.scheme.AuthSchemeSpecUtils;
Expand Down Expand Up @@ -85,10 +84,6 @@ private GeneratorTask generateEndpointAwareAuthSchemeParams() {

}

private GeneratorTask generateAuthSchemeInterceptor() {
return new PoetGeneratorTask(authSchemeInternalDir(), model.getFileHeader(), new AuthSchemeInterceptorSpec(model));
}

private String authSchemeDir() {
return generatorTaskParams.getPathProvider().getAuthSchemeDirectory();
}
Expand Down
6 changes: 2 additions & 4 deletions ...en/src/main/java/software/amazon/awssdk/codegen/emitters/tasks/EndpointProviderTasks.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,8 @@
import software.amazon.awssdk.codegen.poet.rules.EndpointProviderInterfaceSpec;
import software.amazon.awssdk.codegen.poet.rules.EndpointProviderSpec;
import software.amazon.awssdk.codegen.poet.rules.EndpointProviderTestSpec;
import software.amazon.awssdk.codegen.poet.rules.EndpointResolverInterceptorSpec;
import software.amazon.awssdk.codegen.poet.rules.EndpointResolverUtilsSpec;
import software.amazon.awssdk.codegen.poet.rules.EndpointRulesClientTestSpec;
import software.amazon.awssdk.codegen.poet.rules.RequestEndpointInterceptorSpec;
import software.amazon.awssdk.codegen.poet.rules2.EndpointProviderSpec2;

public final class EndpointProviderTasks extends BaseGeneratorTasks {
Expand Down Expand Up @@ -103,8 +102,7 @@ private boolean shouldGenerateCompiledEndpointRules() {

private Collection<GeneratorTask> generateInterceptors() {
return Arrays.asList(
new PoetGeneratorTask(endpointRulesInternalDir(), model.getFileHeader(), new EndpointResolverInterceptorSpec(model)),
new PoetGeneratorTask(endpointRulesInternalDir(), model.getFileHeader(), new RequestEndpointInterceptorSpec(model)));
new PoetGeneratorTask(endpointRulesInternalDir(), model.getFileHeader(), new EndpointResolverUtilsSpec(model)));
}

private GeneratorTask generateClientTests() {
Expand Down
524 changes: 0 additions & 524 deletions .../main/java/software/amazon/awssdk/codegen/poet/auth/scheme/AuthSchemeInterceptorSpec.java
View file
Open in desktop

This file was deleted.

3 changes: 0 additions & 3 deletions ...gen/src/main/java/software/amazon/awssdk/codegen/poet/builder/BaseClientBuilderClass.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,9 +370,6 @@ private MethodSpec finalizeServiceConfigurationMethod() {

List<ClassName> builtInInterceptors = new ArrayList<>();

builtInInterceptors.add(endpointRulesSpecUtils.resolverInterceptorName());
builtInInterceptors.add(endpointRulesSpecUtils.requestModifierInterceptorName());

for (String interceptor : model.getCustomizationConfig().getInterceptors()) {
builtInInterceptors.add(ClassName.bestGuess(interceptor));
}
Expand Down
3 changes: 2 additions & 1 deletion codegen/src/main/java/software/amazon/awssdk/codegen/poet/client/AsyncClientClass.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,8 @@ protected void addAdditionalMethods(TypeSpec.Builder type) {
.addMethods(protocolSpec.additionalMethods())
.addMethod(protocolSpec.initProtocolFactory(model))
.addMethod(resolveMetricPublishersMethod())
.addMethod(ClientClassUtils.resolveAuthSchemeOptionsMethod(authSchemeSpecUtils, endpointRulesSpecUtils));
.addMethod(ClientClassUtils.resolveAuthSchemeOptionsMethod(authSchemeSpecUtils, endpointRulesSpecUtils))
.addMethod(ClientClassUtils.resolveEndpointMethod(authSchemeSpecUtils, endpointRulesSpecUtils));

type.addMethod(ClientClassUtils.updateRetryStrategyClientConfigurationMethod());
type.addMethod(updateSdkClientConfigurationMethod(configurationUtils.serviceClientConfigurationBuilderClassName(),
Expand Down
107 changes: 102 additions & 5 deletions codegen/src/main/java/software/amazon/awssdk/codegen/poet/client/ClientClassUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,21 @@
import com.squareup.javapoet.ParameterizedTypeName;
import com.squareup.javapoet.TypeName;
import com.squareup.javapoet.TypeVariableName;
import com.squareup.javapoet.WildcardTypeName;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CompletionException;
import java.util.function.Consumer;
import java.util.stream.Collectors;
import javax.lang.model.element.Modifier;
import software.amazon.awssdk.arns.Arn;
import software.amazon.awssdk.auth.signer.EventStreamAws4Signer;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.awscore.endpoints.AwsEndpointAttribute;
import software.amazon.awssdk.awscore.endpoints.authscheme.EndpointAuthScheme;
import software.amazon.awssdk.awscore.retry.AwsRetryStrategy;
import software.amazon.awssdk.codegen.model.config.customization.S3ArnableFieldConfig;
import software.amazon.awssdk.codegen.model.intermediate.IntermediateModel;
Expand All @@ -51,11 +55,16 @@
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.core.SdkPlugin;
import software.amazon.awssdk.core.SdkRequest;
import software.amazon.awssdk.core.SelectedAuthScheme;
import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration;
import software.amazon.awssdk.core.client.config.SdkClientConfiguration;
import software.amazon.awssdk.core.client.config.SdkClientOption;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.core.interceptor.ExecutionAttributes;
import software.amazon.awssdk.core.interceptor.SdkInternalExecutionAttribute;
import software.amazon.awssdk.core.retry.RetryMode;
import software.amazon.awssdk.core.signer.Signer;
import software.amazon.awssdk.endpoints.Endpoint;
import software.amazon.awssdk.http.auth.spi.scheme.AuthSchemeOption;
import software.amazon.awssdk.retries.api.RetryStrategy;
import software.amazon.awssdk.utils.AttributeMap;
Expand Down Expand Up @@ -406,9 +415,6 @@ private static void addSimpleAuthSchemeResolution(MethodSpec.Builder builder,
ClassName.get(Set.class), awsClientOption);
builder.beginControlFlow("if (!$T.isNullOrEmpty(sigv4aRegionSet))", CollectionUtils.class);
builder.addStatement("paramsBuilder.regionSet($T.create(sigv4aRegionSet))", regionSet);
builder.nextControlFlow("else");
builder.addStatement("paramsBuilder.regionSet($T.create(clientConfiguration.option($T.AWS_REGION).id()))",
regionSet, awsClientOption);
builder.endControlFlow();
}

Expand All @@ -422,7 +428,7 @@ private static void addEndpointBasedAuthSchemeResolution(MethodSpec.Builder buil
ClassName paramsInterface = authSchemeSpecUtils.parametersInterfaceName();
ClassName awsClientOption = ClassName.get("software.amazon.awssdk.awscore.client.config", "AwsClientOption");
ClassName endpointParamsClass = endpointRulesSpecUtils.parametersClassName();
ClassName resolverInterceptor = endpointRulesSpecUtils.resolverInterceptorName();
ClassName endpointResolverUtils = endpointRulesSpecUtils.endpointResolverUtilsName();
ClassName executionAttributesClass = ClassName.get("software.amazon.awssdk.core.interceptor", "ExecutionAttributes");
ClassName awsExecutionAttribute = ClassName.get("software.amazon.awssdk.awscore", "AwsExecutionAttribute");
ClassName sdkExecutionAttribute = ClassName.get("software.amazon.awssdk.core.interceptor", "SdkExecutionAttribute");
Expand All @@ -447,7 +453,7 @@ private static void addEndpointBasedAuthSchemeResolution(MethodSpec.Builder buil
sdkInternalExecutionAttribute, SdkClientOption.class);

builder.addStatement("$T endpointParams = $T.ruleParams(request, executionAttributes)",
endpointParamsClass, resolverInterceptor);
endpointParamsClass, endpointResolverUtils);

builder.addStatement("$T.Builder paramsBuilder = $T.builder()", paramsInterface, paramsInterface);

Expand All @@ -467,6 +473,15 @@ private static void addEndpointBasedAuthSchemeResolution(MethodSpec.Builder buil
builder.addStatement("paramsBuilder.region(clientConfiguration.option($T.AWS_REGION))", awsClientOption);
}

if (authSchemeSpecUtils.hasSigV4aSupport()) {
ClassName regionSet = ClassName.get("software.amazon.awssdk.http.auth.aws.signer", "RegionSet");
builder.addStatement("$T<String> sigv4aRegionSet = clientConfiguration.option($T.AWS_SIGV4A_SIGNING_REGION_SET)",
ClassName.get(Set.class), awsClientOption);
builder.beginControlFlow("if (!$T.isNullOrEmpty(sigv4aRegionSet))", CollectionUtils.class);
builder.addStatement("paramsBuilder.regionSet($T.create(sigv4aRegionSet))", regionSet);
builder.endControlFlow();
}

ClassName paramsBuilderClass = authSchemeSpecUtils.parametersEndpointAwareDefaultImplName().nestedClass("Builder");
ClassName endpointProviderInterface = endpointRulesSpecUtils.providerInterfaceName();

Expand All @@ -482,4 +497,86 @@ private static void addEndpointBasedAuthSchemeResolution(MethodSpec.Builder buil
builder.addStatement("$T<$T> options = authSchemeProvider.resolveAuthScheme(paramsBuilder.build())",
List.class, AuthSchemeOption.class);
}

static MethodSpec resolveEndpointMethod(AuthSchemeSpecUtils authSchemeSpecUtils,
EndpointRulesSpecUtils endpointRulesSpecUtils) {
ClassName utilsClass = endpointRulesSpecUtils.endpointResolverUtilsName();
ClassName endpointParamsClass = endpointRulesSpecUtils.parametersClassName();
ClassName providerInterface = endpointRulesSpecUtils.providerInterfaceName();
ClassName awsEndpointProviderUtils = endpointRulesSpecUtils.sharedAwsEndpointProviderUtilsName();
ClassName awsEndpointAttribute = ClassName.get(AwsEndpointAttribute.class);
ClassName endpointAuthScheme = ClassName.get(EndpointAuthScheme.class);

MethodSpec.Builder b = MethodSpec.methodBuilder("resolveEndpoint")
.addModifiers(PRIVATE)
.returns(Endpoint.class)
.addParameter(SdkRequest.class, "request")
.addParameter(ExecutionAttributes.class, "executionAttributes")
.addParameter(String.class, "operationName");

b.addStatement("$1T provider = ($1T) executionAttributes.getAttribute($2T.ENDPOINT_PROVIDER)",
providerInterface, SdkInternalExecutionAttribute.class);

b.beginControlFlow("try");
b.addStatement("$T endpointParams = $T.ruleParams(request, executionAttributes)",
endpointParamsClass, utilsClass);
b.addStatement("$T endpoint = provider.resolveEndpoint(endpointParams).join()", Endpoint.class);

b.beginControlFlow("if (!$T.disableHostPrefixInjection(executionAttributes))", awsEndpointProviderUtils);
b.addStatement("$T hostPrefix = $T.hostPrefix(operationName, request)",
ParameterizedTypeName.get(Optional.class, String.class), utilsClass);
b.beginControlFlow("if (hostPrefix.isPresent())");
b.addStatement("endpoint = $T.addHostPrefix(endpoint, hostPrefix.get())", awsEndpointProviderUtils);
b.endControlFlow();
b.endControlFlow();

b.addStatement("$T endpointAuthSchemes = endpoint.attribute($T.AUTH_SCHEMES)",
ParameterizedTypeName.get(ClassName.get(List.class), endpointAuthScheme),
awsEndpointAttribute);
b.addStatement("$T selectedAuthScheme = executionAttributes.getAttribute($T.SELECTED_AUTH_SCHEME)",
ParameterizedTypeName.get(ClassName.get(SelectedAuthScheme.class),
WildcardTypeName.subtypeOf(Object.class)),
SdkInternalExecutionAttribute.class);
b.beginControlFlow("if (endpointAuthSchemes != null && selectedAuthScheme != null)");
b.addStatement("selectedAuthScheme = $T.authSchemeWithEndpointSignerProperties(endpointAuthSchemes, selectedAuthScheme)",
utilsClass);

if (authSchemeSpecUtils.usesSigV4a() || authSchemeSpecUtils.generateEndpointBasedParams()) {
ClassName awsV4aAuthScheme = ClassName.get("software.amazon.awssdk.http.auth.aws.scheme", "AwsV4aAuthScheme");
ClassName awsV4aHttpSigner = ClassName.get("software.amazon.awssdk.http.auth.aws.signer", "AwsV4aHttpSigner");
ClassName regionSet = ClassName.get("software.amazon.awssdk.http.auth.aws.signer", "RegionSet");
ClassName authSchemeOption = ClassName.get("software.amazon.awssdk.http.auth.spi.scheme", "AuthSchemeOption");

b.addComment("Precedence of SigV4a RegionSet is set according to multi-auth SigV4a specifications");
b.beginControlFlow("if (selectedAuthScheme.authSchemeOption().schemeId().equals($T.SCHEME_ID) "
+ "&& selectedAuthScheme.authSchemeOption().signerProperty($T.REGION_SET) == null)",
awsV4aAuthScheme, awsV4aHttpSigner);
b.addStatement("$T optionBuilder = selectedAuthScheme.authSchemeOption().toBuilder()",
authSchemeOption.nestedClass("Builder"));
b.addStatement("$1T rs = $1T.create(endpointParams.region().id())", regionSet);
b.addStatement("optionBuilder.putSignerProperty($T.REGION_SET, rs)", awsV4aHttpSigner);
b.addStatement("selectedAuthScheme = new $T(selectedAuthScheme.identity(), selectedAuthScheme.signer(), "
+ "optionBuilder.build())", SelectedAuthScheme.class);
b.endControlFlow();
}

b.addStatement("executionAttributes.putAttribute($T.SELECTED_AUTH_SCHEME, selectedAuthScheme)",
SdkInternalExecutionAttribute.class);
b.endControlFlow();

b.addStatement("$T.setMetricValues(endpoint, executionAttributes)", utilsClass);

b.addStatement("return endpoint");

b.nextControlFlow("catch ($T e)", CompletionException.class);
b.addStatement("$T cause = e.getCause()", Throwable.class);
b.beginControlFlow("if (cause instanceof $T)", SdkClientException.class);
b.addStatement("throw ($T) cause", SdkClientException.class);
b.endControlFlow();
b.addStatement("throw $T.create($S + cause.getMessage(), cause)",
SdkClientException.class, "Endpoint resolution failed: ");
b.endControlFlow();

return b.build();
}
}
3 changes: 2 additions & 1 deletion codegen/src/main/java/software/amazon/awssdk/codegen/poet/client/SyncClientClass.java
View file
Open in desktop
Copy link
Copy Markdown
Contributor

@dagnir dagnir Apr 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto here, we need codegen tests

Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,8 @@ protected void addAdditionalMethods(TypeSpec.Builder type) {
.addMethod(nameMethod())
.addMethods(protocolSpec.additionalMethods())
.addMethod(resolveMetricPublishersMethod())
.addMethod(ClientClassUtils.resolveAuthSchemeOptionsMethod(authSchemeSpecUtils, endpointRulesSpecUtils));
.addMethod(ClientClassUtils.resolveAuthSchemeOptionsMethod(authSchemeSpecUtils, endpointRulesSpecUtils))
.addMethod(ClientClassUtils.resolveEndpointMethod(authSchemeSpecUtils, endpointRulesSpecUtils));

protocolSpec.createErrorResponseHandler().ifPresent(type::addMethod);
type.addMethod(ClientClassUtils.updateRetryStrategyClientConfigurationMethod());
Expand Down
4 changes: 4 additions & 0 deletions codegen/src/main/java/software/amazon/awssdk/codegen/poet/client/specs/JsonProtocolSpec.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,8 @@ public CodeBlock executionHandler(OperationModel opModel) {
.add(".withMetricCollector(apiCallMetricCollector)\n")
.add(".withAuthSchemeOptionsResolver(r -> resolveAuthSchemeOptions(r, $S, clientConfiguration))\n",
opModel.getOperationName())
.add(".withEndpointResolver((r, a) -> resolveEndpoint(r, a, $S))\n",
opModel.getOperationName())
.add(HttpChecksumRequiredTrait.putHttpChecksumAttribute(opModel))
.add(HttpChecksumTrait.create(opModel));

Expand Down Expand Up @@ -299,6 +301,8 @@ public CodeBlock asyncExecutionHandler(IntermediateModel intermediateModel, Oper
.add(".withMetricCollector(apiCallMetricCollector)\n")
.add(".withAuthSchemeOptionsResolver(r -> resolveAuthSchemeOptions(r, $S, clientConfiguration))\n",
opModel.getOperationName())
.add(".withEndpointResolver((r, a) -> resolveEndpoint(r, a, $S))\n",
Copy link
Copy Markdown
Contributor

@alextwoods alextwoods Apr 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is beyond the scope of this PR, but it feels pretty weird that we need to specify the endpoint resolver (and auth scheme, metrics, ect) in protocol specific generation - these should be consistent across our protocols. (but again, this is beyond the scope of this PR, I don't think we need to refactor now....)

Copy link
Copy Markdown
Author

@S-Saranya1 S-Saranya1 Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree, the protocol specs have a lot of duplicated code. We can follow-up on this.

opModel.getOperationName())
.add(hostPrefixExpression(opModel))
.add(discoveredEndpoint(opModel))
.add(credentialType(opModel, model))
Expand Down
4 changes: 4 additions & 0 deletions ...gen/src/main/java/software/amazon/awssdk/codegen/poet/client/specs/QueryProtocolSpec.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,8 @@ public CodeBlock executionHandler(OperationModel opModel) {
.add(".withMetricCollector(apiCallMetricCollector)")
.add(".withAuthSchemeOptionsResolver(r -> resolveAuthSchemeOptions(r, $S, clientConfiguration))\n",
opModel.getOperationName())
.add(".withEndpointResolver((r, a) -> resolveEndpoint(r, a, $S))\n",
opModel.getOperationName())
.add(HttpChecksumRequiredTrait.putHttpChecksumAttribute(opModel))
.add(HttpChecksumTrait.create(opModel));

Expand Down Expand Up @@ -159,6 +161,8 @@ public CodeBlock asyncExecutionHandler(IntermediateModel intermediateModel, Oper
.add(".withMetricCollector(apiCallMetricCollector)\n")
.add(".withAuthSchemeOptionsResolver(r -> resolveAuthSchemeOptions(r, $S, clientConfiguration))\n",
opModel.getOperationName())
.add(".withEndpointResolver((r, a) -> resolveEndpoint(r, a, $S))\n",
opModel.getOperationName())
.add(HttpChecksumRequiredTrait.putHttpChecksumAttribute(opModel))
.add(HttpChecksumTrait.create(opModel));

Expand Down
4 changes: 4 additions & 0 deletions codegen/src/main/java/software/amazon/awssdk/codegen/poet/client/specs/XmlProtocolSpec.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,8 @@ public CodeBlock executionHandler(OperationModel opModel) {
.add(".withRequestConfiguration(clientConfiguration)")
.add(".withInput($L)", opModel.getInput().getVariableName())
.add(".withAuthSchemeOptionsResolver(r -> resolveAuthSchemeOptions(r, $S, clientConfiguration))\n",
opModel.getOperationName())
.add(".withEndpointResolver((r, a) -> resolveEndpoint(r, a, $S))\n",
opModel.getOperationName())
.add(HttpChecksumRequiredTrait.putHttpChecksumAttribute(opModel))
.add(HttpChecksumTrait.create(opModel));
Expand Down Expand Up @@ -217,6 +219,8 @@ public CodeBlock asyncExecutionHandler(IntermediateModel intermediateModel, Oper
.add(".withMetricCollector(apiCallMetricCollector)\n")
.add(".withAuthSchemeOptionsResolver(r -> resolveAuthSchemeOptions(r, $S, clientConfiguration))\n",
opModel.getOperationName())
.add(".withEndpointResolver((r, a) -> resolveEndpoint(r, a, $S))\n",
opModel.getOperationName())
.add(asyncRequestBody(opModel))
.add(HttpChecksumRequiredTrait.putHttpChecksumAttribute(opModel))
.add(HttpChecksumTrait.create(opModel));
Expand Down
Loading
Loading